Changeset 6298

Timestamp:

02/21/2017 10:14:20 PM (8 years ago)

Author:

johnjamesjacoby

Message:

Common: Move formatting functions into formatting.php.

Location:

trunk/src/includes/common

Files:

• formatting.php (modified) (1 diff)
• functions.php (modified) (2 diffs)

trunk/src/includes/common/formatting.php

@@ -459 +459 @@
     return $matches[1] . $link;
 }
+
+/** Numbers *******************************************************************/
+
+/**
+ * A bbPress specific method of formatting numeric values
+ *
+ * @since 2.0.0 bbPress (r2486)
+ *
+ * @param string $number Number to format
+ * @param string $decimals Optional. Display decimals
+ * @uses apply_filters() Calls 'bbp_number_format' with the formatted values,
+ *                        number and display decimals bool
+ * @return string Formatted string
+ */
+function bbp_number_format( $number = 0, $decimals = false, $dec_point = '.', $thousands_sep = ',' ) {
+
+    // If empty, set $number to (int) 0
+    if ( ! is_numeric( $number ) ) {
+        $number = 0;
+    }
+
+    return apply_filters( 'bbp_number_format', number_format( $number, $decimals, $dec_point, $thousands_sep ), $number, $decimals, $dec_point, $thousands_sep );
+}
+
+/**
+ * A bbPress specific method of formatting numeric values
+ *
+ * @since 2.1.0 bbPress (r3857)
+ *
+ * @param string $number Number to format
+ * @param string $decimals Optional. Display decimals
+ * @uses apply_filters() Calls 'bbp_number_format' with the formatted values,
+ *                        number and display decimals bool
+ * @return string Formatted string
+ */
+function bbp_number_format_i18n( $number = 0, $decimals = false ) {
+
+    // If empty, set $number to (int) 0
+    if ( ! is_numeric( $number ) ) {
+        $number = 0;
+    }
+
+    return apply_filters( 'bbp_number_format_i18n', number_format_i18n( $number, $decimals ), $number, $decimals );
+}
+
+/** Dates *********************************************************************/
+
+/**
+ * Convert time supplied from database query into specified date format.
+ *
+ * @since 2.0.0 bbPress (r2544)
+ *
+ * @param string $time Time to convert
+ * @param string $d Optional. Default is 'U'. Either 'G', 'U', or php date
+ *                             format
+ * @param bool $translate Optional. Default is false. Whether to translate the
+ *                                   result
+ * @uses mysql2date() To convert the format
+ * @uses apply_filters() Calls 'bbp_convert_date' with the time, date format
+ *                        and translate bool
+ * @return string Returns timestamp
+ */
+function bbp_convert_date( $time, $d = 'U', $translate = false ) {
+    $new_time = mysql2date( $d, $time, $translate );
+
+    return apply_filters( 'bbp_convert_date', $new_time, $d, $translate, $time );
+}
+
+/**
+ * Output formatted time to display human readable time difference.
+ *
+ * @since 2.0.0 bbPress (r2544)
+ *
+ * @param string $older_date Unix timestamp from which the difference begins.
+ * @param string $newer_date Optional. Unix timestamp from which the
+ *                            difference ends. False for current time.
+ * @param int $gmt Optional. Whether to use GMT timezone. Default is false.
+ * @uses bbp_get_time_since() To get the formatted time
+ */
+function bbp_time_since( $older_date, $newer_date = false, $gmt = false ) {
+    echo bbp_get_time_since( $older_date, $newer_date, $gmt );
+}
+    /**
+     * Return formatted time to display human readable time difference.
+     *
+     * @since 2.0.0 bbPress (r2544)
+     *
+     * @param string $older_date Unix timestamp from which the difference begins.
+     * @param string $newer_date Optional. Unix timestamp from which the
+     *                            difference ends. False for current time.
+     * @param int $gmt Optional. Whether to use GMT timezone. Default is false.
+     * @uses current_time() To get the current time in mysql format
+     * @uses human_time_diff() To get the time differene in since format
+     * @uses apply_filters() Calls 'bbp_get_time_since' with the time
+     *                        difference and time
+     * @return string Formatted time
+     */
+    function bbp_get_time_since( $older_date, $newer_date = false, $gmt = false ) {
+
+        // Setup the strings
+        $unknown_text   = apply_filters( 'bbp_core_time_since_unknown_text',   __( 'sometime',  'bbpress' ) );
+        $right_now_text = apply_filters( 'bbp_core_time_since_right_now_text', __( 'right now', 'bbpress' ) );
+        $ago_text       = apply_filters( 'bbp_core_time_since_ago_text',       __( '%s ago',    'bbpress' ) );
+
+        // array of time period chunks
+        $chunks = array(
+            array( 60 * 60 * 24 * 365 , __( 'year',   'bbpress' ), __( 'years',   'bbpress' ) ),
+            array( 60 * 60 * 24 * 30 ,  __( 'month',  'bbpress' ), __( 'months',  'bbpress' ) ),
+            array( 60 * 60 * 24 * 7,    __( 'week',   'bbpress' ), __( 'weeks',   'bbpress' ) ),
+            array( 60 * 60 * 24 ,       __( 'day',    'bbpress' ), __( 'days',    'bbpress' ) ),
+            array( 60 * 60 ,            __( 'hour',   'bbpress' ), __( 'hours',   'bbpress' ) ),
+            array( 60 ,                 __( 'minute', 'bbpress' ), __( 'minutes', 'bbpress' ) ),
+            array( 1,                   __( 'second', 'bbpress' ), __( 'seconds', 'bbpress' ) )
+        );
+
+        if ( ! empty( $older_date ) && ! is_numeric( $older_date ) ) {
+            $time_chunks = explode( ':', str_replace( ' ', ':', $older_date ) );
+            $date_chunks = explode( '-', str_replace( ' ', '-', $older_date ) );
+            $older_date  = gmmktime( (int) $time_chunks[1], (int) $time_chunks[2], (int) $time_chunks[3], (int) $date_chunks[1], (int) $date_chunks[2], (int) $date_chunks[0] );
+        }
+
+        // $newer_date will equal false if we want to know the time elapsed
+        // between a date and the current time. $newer_date will have a value if
+        // we want to work out time elapsed between two known dates.
+        $newer_date = ( ! $newer_date ) ? strtotime( current_time( 'mysql', $gmt ) ) : $newer_date;
+
+        // Difference in seconds
+        $since = $newer_date - $older_date;
+
+        // Something went wrong with date calculation and we ended up with a negative date.
+        if ( 0 > $since ) {
+            $output = $unknown_text;
+
+        // We only want to output two chunks of time here, eg:
+        //     x years, xx months
+        //     x days, xx hours
+        // so there's only two bits of calculation below:
+        } else {
+
+            // Step one: the first chunk
+            for ( $i = 0, $j = count( $chunks ); $i < $j; ++$i ) {
+                $seconds = $chunks[ $i ][0];
+
+                // Finding the biggest chunk (if the chunk fits, break)
+                $count = floor( $since / $seconds );
+                if ( 0 != $count ) {
+                    break;
+                }
+            }
+
+            // If $i iterates all the way to $j, then the event happened 0 seconds ago
+            if ( ! isset( $chunks[ $i ] ) ) {
+                $output = $right_now_text;
+
+            } else {
+
+                // Set output var
+                $output = ( 1 == $count ) ? '1 '. $chunks[ $i ][1] : $count . ' ' . $chunks[ $i ][2];
+
+                // Step two: the second chunk
+                if ( $i + 2 < $j ) {
+                    $seconds2 = $chunks[ $i + 1 ][0];
+                    $name2    = $chunks[ $i + 1 ][1];
+                    $count2   = floor( ( $since - ( $seconds * $count ) ) / $seconds2 );
+
+                    // Add to output var
+                    if ( 0 != $count2 ) {
+                        $output .= ( 1 == $count2 ) ? _x( ',', 'Separator in time since', 'bbpress' ) . ' 1 '. $name2 : _x( ',', 'Separator in time since', 'bbpress' ) . ' ' . $count2 . ' ' . $chunks[ $i + 1 ][2];
+                    }
+                }
+
+                // No output, so happened right now
+                if ( ! (int) trim( $output ) ) {
+                    $output = $right_now_text;
+                }
+            }
+        }
+
+        // Append 'ago' to the end of time-since if not 'right now'
+        if ( $output != $right_now_text ) {
+            $output = sprintf( $ago_text, $output );
+        }
+
+        return apply_filters( 'bbp_get_time_since', $output, $older_date, $newer_date );
+    }
+
+/** Revisions *****************************************************************/
+
+/**
+ * Formats the reason for editing the topic/reply.
+ *
+ * Does these things:
+ *  - Trimming
+ *  - Removing periods from the end of the string
+ *  - Trimming again
+ *
+ * @since 2.0.0 bbPress (r2782)
+ *
+ * @param string $reason Optional. User submitted reason for editing.
+ * @return string Status of topic
+ */
+function bbp_format_revision_reason( $reason = '' ) {
+    $reason = (string) $reason;
+
+    // Format reason for proper display
+    if ( empty( $reason ) ) {
+        return $reason;
+    }
+
+    // Trimming
+    $reason = trim( $reason );
+
+    // We add our own full stop.
+    while ( substr( $reason, -1 ) === '.' ) {
+        $reason = substr( $reason, 0, -1 );
+    }
+
+    // Trim again
+    $reason = trim( $reason );
+
+    return $reason;
+}
+

trunk/src/includes/common/functions.php

@@ -14 +14 @@
 defined( 'ABSPATH' ) || exit;
 
-/** Formatting ****************************************************************/
-
-/**
- * A bbPress specific method of formatting numeric values
- *
- * @since 2.0.0 bbPress (r2486)
- *
- * @param string $number Number to format
- * @param string $decimals Optional. Display decimals
- * @uses apply_filters() Calls 'bbp_number_format' with the formatted values,
- *                        number and display decimals bool
- * @return string Formatted string
- */
-function bbp_number_format( $number = 0, $decimals = false, $dec_point = '.', $thousands_sep = ',' ) {
-
-    // If empty, set $number to (int) 0
-    if ( ! is_numeric( $number ) ) {
-        $number = 0;
-    }
-
-    return apply_filters( 'bbp_number_format', number_format( $number, $decimals, $dec_point, $thousands_sep ), $number, $decimals, $dec_point, $thousands_sep );
-}
-
-/**
- * A bbPress specific method of formatting numeric values
- *
- * @since 2.1.0 bbPress (r3857)
- *
- * @param string $number Number to format
- * @param string $decimals Optional. Display decimals
- * @uses apply_filters() Calls 'bbp_number_format' with the formatted values,
- *                        number and display decimals bool
- * @return string Formatted string
- */
-function bbp_number_format_i18n( $number = 0, $decimals = false ) {
-
-    // If empty, set $number to (int) 0
-    if ( ! is_numeric( $number ) ) {
-        $number = 0;
-    }
-
-    return apply_filters( 'bbp_number_format_i18n', number_format_i18n( $number, $decimals ), $number, $decimals );
-}
-
-/**
- * Convert time supplied from database query into specified date format.
- *
- * @since 2.0.0 bbPress (r2544)
- *
- * @param string $time Time to convert
- * @param string $d Optional. Default is 'U'. Either 'G', 'U', or php date
- *                             format
- * @param bool $translate Optional. Default is false. Whether to translate the
- *                                   result
- * @uses mysql2date() To convert the format
- * @uses apply_filters() Calls 'bbp_convert_date' with the time, date format
- *                        and translate bool
- * @return string Returns timestamp
- */
-function bbp_convert_date( $time, $d = 'U', $translate = false ) {
-    $new_time = mysql2date( $d, $time, $translate );
-
-    return apply_filters( 'bbp_convert_date', $new_time, $d, $translate, $time );
-}
-
-/**
- * Output formatted time to display human readable time difference.
- *
- * @since 2.0.0 bbPress (r2544)
- *
- * @param string $older_date Unix timestamp from which the difference begins.
- * @param string $newer_date Optional. Unix timestamp from which the
- *                            difference ends. False for current time.
- * @param int $gmt Optional. Whether to use GMT timezone. Default is false.
- * @uses bbp_get_time_since() To get the formatted time
- */
-function bbp_time_since( $older_date, $newer_date = false, $gmt = false ) {
-    echo bbp_get_time_since( $older_date, $newer_date, $gmt );
-}
-    /**
-     * Return formatted time to display human readable time difference.
-     *
-     * @since 2.0.0 bbPress (r2544)
-     *
-     * @param string $older_date Unix timestamp from which the difference begins.
-     * @param string $newer_date Optional. Unix timestamp from which the
-     *                            difference ends. False for current time.
-     * @param int $gmt Optional. Whether to use GMT timezone. Default is false.
-     * @uses current_time() To get the current time in mysql format
-     * @uses human_time_diff() To get the time differene in since format
-     * @uses apply_filters() Calls 'bbp_get_time_since' with the time
-     *                        difference and time
-     * @return string Formatted time
-     */
-    function bbp_get_time_since( $older_date, $newer_date = false, $gmt = false ) {
-
-        // Setup the strings
-        $unknown_text   = apply_filters( 'bbp_core_time_since_unknown_text',   __( 'sometime',  'bbpress' ) );
-        $right_now_text = apply_filters( 'bbp_core_time_since_right_now_text', __( 'right now', 'bbpress' ) );
-        $ago_text       = apply_filters( 'bbp_core_time_since_ago_text',       __( '%s ago',    'bbpress' ) );
-
-        // array of time period chunks
-        $chunks = array(
-            array( 60 * 60 * 24 * 365 , __( 'year',   'bbpress' ), __( 'years',   'bbpress' ) ),
-            array( 60 * 60 * 24 * 30 ,  __( 'month',  'bbpress' ), __( 'months',  'bbpress' ) ),
-            array( 60 * 60 * 24 * 7,    __( 'week',   'bbpress' ), __( 'weeks',   'bbpress' ) ),
-            array( 60 * 60 * 24 ,       __( 'day',    'bbpress' ), __( 'days',    'bbpress' ) ),
-            array( 60 * 60 ,            __( 'hour',   'bbpress' ), __( 'hours',   'bbpress' ) ),
-            array( 60 ,                 __( 'minute', 'bbpress' ), __( 'minutes', 'bbpress' ) ),
-            array( 1,                   __( 'second', 'bbpress' ), __( 'seconds', 'bbpress' ) )
-        );
-
-        if ( ! empty( $older_date ) && ! is_numeric( $older_date ) ) {
-            $time_chunks = explode( ':', str_replace( ' ', ':', $older_date ) );
-            $date_chunks = explode( '-', str_replace( ' ', '-', $older_date ) );
-            $older_date  = gmmktime( (int) $time_chunks[1], (int) $time_chunks[2], (int) $time_chunks[3], (int) $date_chunks[1], (int) $date_chunks[2], (int) $date_chunks[0] );
-        }
-
-        // $newer_date will equal false if we want to know the time elapsed
-        // between a date and the current time. $newer_date will have a value if
-        // we want to work out time elapsed between two known dates.
-        $newer_date = ( ! $newer_date ) ? strtotime( current_time( 'mysql', $gmt ) ) : $newer_date;
-
-        // Difference in seconds
-        $since = $newer_date - $older_date;
-
-        // Something went wrong with date calculation and we ended up with a negative date.
-        if ( 0 > $since ) {
-            $output = $unknown_text;
-
-        // We only want to output two chunks of time here, eg:
-        //     x years, xx months
-        //     x days, xx hours
-        // so there's only two bits of calculation below:
-        } else {
-
-            // Step one: the first chunk
-            for ( $i = 0, $j = count( $chunks ); $i < $j; ++$i ) {
-                $seconds = $chunks[ $i ][0];
-
-                // Finding the biggest chunk (if the chunk fits, break)
-                $count = floor( $since / $seconds );
-                if ( 0 != $count ) {
-                    break;
-                }
-            }
-
-            // If $i iterates all the way to $j, then the event happened 0 seconds ago
-            if ( ! isset( $chunks[ $i ] ) ) {
-                $output = $right_now_text;
-
-            } else {
-
-                // Set output var
-                $output = ( 1 == $count ) ? '1 '. $chunks[ $i ][1] : $count . ' ' . $chunks[ $i ][2];
-
-                // Step two: the second chunk
-                if ( $i + 2 < $j ) {
-                    $seconds2 = $chunks[ $i + 1 ][0];
-                    $name2    = $chunks[ $i + 1 ][1];
-                    $count2   = floor( ( $since - ( $seconds * $count ) ) / $seconds2 );
-
-                    // Add to output var
-                    if ( 0 != $count2 ) {
-                        $output .= ( 1 == $count2 ) ? _x( ',', 'Separator in time since', 'bbpress' ) . ' 1 '. $name2 : _x( ',', 'Separator in time since', 'bbpress' ) . ' ' . $count2 . ' ' . $chunks[ $i + 1 ][2];
-                    }
-                }
-
-                // No output, so happened right now
-                if ( ! (int) trim( $output ) ) {
-                    $output = $right_now_text;
-                }
-            }
-        }
-
-        // Append 'ago' to the end of time-since if not 'right now'
-        if ( $output != $right_now_text ) {
-            $output = sprintf( $ago_text, $output );
-        }
-
-        return apply_filters( 'bbp_get_time_since', $output, $older_date, $newer_date );
-    }
-
-/**
- * Formats the reason for editing the topic/reply.
- *
- * Does these things:
- *  - Trimming
- *  - Removing periods from the end of the string
- *  - Trimming again
- *
- * @since 2.0.0 bbPress (r2782)
- *
- * @param string $reason Optional. User submitted reason for editing.
- * @return string Status of topic
- */
-function bbp_format_revision_reason( $reason = '' ) {
-    $reason = (string) $reason;
-
-    // Format reason for proper display
-    if ( empty( $reason ) ) {
-        return $reason;
-    }
-
-    // Trimming
-    $reason = trim( $reason );
-
-    // We add our own full stop.
-    while ( substr( $reason, -1 ) === '.' ) {
-        $reason = substr( $reason, 0, -1 );
-    }
-
-    // Trim again
-    $reason = trim( $reason );
-
-    return $reason;
-}
-
-/** Misc **********************************************************************/
+/** URLs **********************************************************************/
 
 /**
@@ -328 +110 @@
     return 1;
 }
+
+/** Misc **********************************************************************/
 
 /**