Changeset 10355 for trunk/src/bp-core/classes/class-bp-media-extractor.php

Timestamp:

11/15/2015 07:13:42 PM (11 years ago)

Author:

tw2113

Message:

More documentation cleanup for part of BP-Core component.

See #6398.

File:

• trunk/src/bp-core/classes/class-bp-media-extractor.php (modified) (18 diffs)

trunk/src/bp-core/classes/class-bp-media-extractor.php

@@ -63 +63 @@
      * @param int            $what_to_extract Media type to extract (optional).
      * @param array          $extra_args      Bespoke data for a particular extractor (optional).
-     *
      * @return array {
      *     @type array $has Extracted media counts. {
@@ -197 +196 @@
      * @param string $plaintext  Sanitized version of the content.
      * @param array  $extra_args Bespoke data for a particular extractor (optional).
-     *
      * @return array {
      *     @type array $has Extracted media counts. {
@@ -212 +210 @@
         $data = array( 'has' => array( 'links' => 0 ), 'links' => array() );
 
-        // Matches: href="text" and href='text'
+        // Matches: href="text" and href='text'.
         if ( stripos( $richtext, 'href=' ) !== false ) {
             preg_match_all( '#href=(["\'])([^"\']+)\1#i', $richtext, $matches );
@@ -257 +255 @@
      * @param string $plaintext  Sanitized version of the content.
      * @param array  $extra_args Bespoke data for a particular extractor.
-     *
      * @return array {
      *     @type array $has Extracted media counts. {
@@ -292 +289 @@
         }
 
-        // Build results
+        // Build results.
         foreach ( $mentions as $user_id => $mention_name ) {
             $mention = array( 'name' => strtolower( $mention_name ) );
@@ -329 +326 @@
      * @param string $plaintext  Sanitized version of the content.
      * @param array  $extra_args Bespoke data for a particular extractor (optional).
-     *
      * @return array {
      *     @type array $has Extracted media counts. {
@@ -354 +350 @@
         // `<img src>` tags.
         if ( stripos( $richtext, 'src=' ) !== false ) {
-            preg_match_all( '#src=(["\'])([^"\']+)\1#i', $richtext, $img_srcs );  // matches src="text" and src='text'
+            preg_match_all( '#src=(["\'])([^"\']+)\1#i', $richtext, $img_srcs );  // Matches src="text" and src='text'.
 
             // <img>.
@@ -449 +445 @@
      * @param string $plaintext  Sanitized version of the content.
      * @param array  $extra_args Bespoke data for a particular extractor (optional).
-     *
      * @return array {
      *     @type array $has Extracted media counts. {
@@ -477 +472 @@
 
                     $shortcode               = array();
-                    $shortcode['attributes'] = $attrs;             // Attributes
-                    $shortcode['content']    = $matches[5][ $i ];  // Content
-                    $shortcode['type']       = $shortcode_name;    // Shortcode
-                    $shortcode['original']   = $matches[0][ $i ];  // Entire shortcode
+                    $shortcode['attributes'] = $attrs;             // Attributes.
+                    $shortcode['content']    = $matches[5][ $i ];  // Content.
+                    $shortcode['type']       = $shortcode_name;    // Shortcode.
+                    $shortcode['original']   = $matches[0][ $i ];  // Entire shortcode.
 
                     $data['shortcodes'][] = $shortcode;
@@ -511 +506 @@
      * @param string $plaintext  Sanitized version of the content.
      * @param array  $extra_args Bespoke data for a particular extractor (optional).
-     *
      * @return array {
      *     @type array $has Extracted media counts. {
@@ -591 +585 @@
      * @param string $plaintext  Sanitized version of the content.
      * @param array  $extra_args Bespoke data for a particular extractor (optional).
-     *
      * @return array {
      *     @type array $has Extracted media counts. {
@@ -644 +637 @@
         }
 
-        // <a href="*.mp3"> tags
+        // <a href="*.mp3"> tags.
         foreach ( $audio_types as $extension ) {
             $extension = '.' . $extension;
@@ -689 +682 @@
      * @param string $plaintext  Sanitized version of the content.
      * @param array  $extra_args Bespoke data for a particular extractor (optional).
-     *
      * @return array {
      *     @type array $has Extracted media counts. {
@@ -768 +760 @@
      * @param string $plaintext  Sanitized version of the content.
      * @param array  $extra_args Bespoke data for a particular extractor (optional).
-     *
      * @return array
      */
@@ -794 +785 @@
                     $image_size = array( $extra_args['width'], $extra_args['height'] );
                 } else {
-                    $image_size = $extra_args['width'];  // e.g. "thumb", "medium".
+                    $image_size = $extra_args['width'];  // E.g. "thumb", "medium".
                 }
 
@@ -868 +859 @@
      * @param string $plaintext  Sanitized version of the content.
      * @param array  $extra_args Contains data that an implementation might need beyond the defaults.
-     *
      * @return array
      */
@@ -890 +880 @@
                     $image_size = array( $extra_args['width'], $extra_args['height'] );
                 } else {
-                    $image_size = $extra_args['width'];  // e.g. "thumb", "medium".
+                    $image_size = $extra_args['width'];  // E.g. "thumb", "medium".
                 }
             } else {
@@ -919 +909 @@
      * @since 2.3.0
      *
-     * @param string $richtext
-     *
+     * @param string $richtext Content to sanitize.
      * @return string
      */