vendi-advertising / vendi-shared-utils

src/utils.php

Doc Comments +2 added lines, -1 removed lines

@@ -186,7 +186,8 @@
     /**

      * Get the current request array or mock array if set.

      *

-     * @param  string    The server method to use, one of GET, POST, SERVER or COOKIE.

+     * @param  string    The server method to use, one of GET, POST, SERVER or COOKIE.
+     * @param string $request_method

      * @return arra|null The requested array or null.

      */

     public static function get_request_object( $request_method )

Braces +58 added lines, -56 removed lines

@@ -8,8 +8,8 @@ 
 

 namespace Vendi\Shared;

 

-class utils

-{

+class utils
+{
     public static $CUSTOM_POST = null;

 

     public static $CUSTOM_GET = null;

@@ -21,8 +21,8 @@ 
     /**

      * Reset the internal arrays to default values.

      */

-    public static function reset_all_custom_arrays()

-    {

+    public static function reset_all_custom_arrays()
+    {
         self::$CUSTOM_POST = null;

         self::$CUSTOM_GET = null;

         self::$CUSTOM_COOKIE = null;

@@ -35,8 +35,8 @@ 
      * @param  mixed         $default_value Optional. If the $key cannot be found the value to return. Default null.

      * @return mixed                        The value of the HTTP POST for the given $key or the $default.

      */

-    public static function get_post_value( $key, $default_value = '' )

-    {

+    public static function get_post_value( $key, $default_value = '' )
+    {
         return self::get_request_value( 'POST', $key, $default_value );

     }

 

@@ -46,8 +46,8 @@ 
      * @param  mixed         $default_value Optional. If the $key cannot be found the value to return. Default null.

      * @return mixed                        The value of the HTTP GET for the given $key or the $default.

      */

-    public static function get_get_value( $key, $default_value = '' )

-    {

+    public static function get_get_value( $key, $default_value = '' )
+    {
         return self::get_request_value( 'GET', $key, $default_value );

     }

 

@@ -57,8 +57,8 @@ 
      * @param  mixed         $default_value Optional. If the $key cannot be found the value to return. Default null.

      * @return mixed                        The value of the HTTP COOKIE for the given $key or the $default.

      */

-    public static function get_cookie_value( $key, $default_value = '' )

-    {

+    public static function get_cookie_value( $key, $default_value = '' )
+    {
         return self::get_request_value( 'COOKIE', $key, $default_value );

     }

 

@@ -68,8 +68,8 @@ 
      * @param  mixed         $default_value Optional. If the $key cannot be found the value to return. Default null.

      * @return mixed                        The value of the HTTP SERVER for the given $key or the $default.

      */

-    public static function get_server_value( $key, $default_value = '' )

-    {

+    public static function get_server_value( $key, $default_value = '' )
+    {
         return self::get_request_value( 'SERVER', $key, $default_value );

     }

 

@@ -81,13 +81,13 @@ 
      * @param  mixed         $default_value Optional. If the $key cannot be found the value to return. Default null.

      * @return mixed                        The value of the source for the given $key or the $default.

      */

-    public static function get_value_multiple_sources( $key, array $sources, $default_value = null )

-    {

-        foreach( $sources as $source )

-        {

+    public static function get_value_multiple_sources( $key, array $sources, $default_value = null )
+    {
+        foreach( $sources as $source )
+        {
             $value = self::get_request_value( $source, $key, null );

-            if( null !== $value )

-            {

+            if( null !== $value )
+            {
                 return $value;

             }

         }

@@ -101,8 +101,8 @@ 
      * @param  integer|mixed $default_value Optional. If the $key cannot be found the value to return. Default null.

      * @return integer|mixed                The value of the HTTP POST for the given $key or the $default.

      */

-    public static function get_post_value_int( $key, $default_value = null )

-    {

+    public static function get_post_value_int( $key, $default_value = null )
+    {
         return self::get_request_value_int( 'POST', $key, $default_value );

     }

 

@@ -112,8 +112,8 @@ 
      * @param  integer|mixed $default_value Optional. If the $key cannot be found the value to return. Default null.

      * @return integer|mixed                The value of the HTTP GET for the given $key or the $default.

      */

-    public static function get_get_value_int( $key, $default_value = null )

-    {

+    public static function get_get_value_int( $key, $default_value = null )
+    {
         return self::get_request_value_int( 'GET', $key, $default_value );

     }

 

@@ -123,8 +123,8 @@ 
      * @param  integer|mixed $default_value Optional. If the $key cannot be found the value to return. Default null.

      * @return integer|mixed                The value of the HTTP COOKIE for the given $key or the $default.

      */

-    public static function get_cookie_value_int( $key, $default_value = null )

-    {

+    public static function get_cookie_value_int( $key, $default_value = null )
+    {
         return self::get_request_value_int( 'COOKIE', $key, $default_value );

     }

 

@@ -134,8 +134,8 @@ 
      * @param  integer|mixed $default_value Optional. If the $key cannot be found the value to return. Default null.

      * @return integer|mixed                The value of the HTTP SERVER for the given $key or the $default.

      */

-    public static function get_server_value_int( $key, $default_value = null )

-    {

+    public static function get_server_value_int( $key, $default_value = null )
+    {
         return self::get_request_value_int( 'SERVER', $key, $default_value );

     }

 

@@ -146,11 +146,11 @@ 
      * @param  integer|mixed $default_value Optional. If the $key cannot be found the value to return. Default null.

      * @return integer|mixed                The value of the request method for the given $key or the $default.

      */

-    public static function get_request_value_int( $request_method, $key, $default_value = null )

-    {

+    public static function get_request_value_int( $request_method, $key, $default_value = null )
+    {
         $value = self::get_request_value( $request_method, $key, null );

-        if( self::is_integer_like( $value ) )

-        {

+        if( self::is_integer_like( $value ) )
+        {
             return (int)$value;

         }

 

@@ -164,19 +164,19 @@ 
      * @param  integer|mixed $default_value Optional. If the $key cannot be found the value to return. Default null.

      * @return integer|mixed                The value of the request method for the given $key or the $default.

      */

-    public static function get_request_value( $request_method, $key, $default_value = null )

-    {

+    public static function get_request_value( $request_method, $key, $default_value = null )
+    {
         $request_obj = self::get_request_object( $request_method );

 

-        if( null === $request_obj || ! is_array( $request_obj ) || ! array_key_exists( $key, $request_obj ) )

-        {

+        if( null === $request_obj || ! is_array( $request_obj ) || ! array_key_exists( $key, $request_obj ) )
+        {
             return $default_value;

         }

 

         $ret = $request_obj[ $key ];

 

-        if( is_string( $ret ) )

-        {

+        if( is_string( $ret ) )
+        {
             $ret = trim( $ret );

         }

 

@@ -189,35 +189,35 @@ 
      * @param  string    The server method to use, one of GET, POST, SERVER or COOKIE.

      * @return arra|null The requested array or null.

      */

-    public static function get_request_object( $request_method )

-    {

+    public static function get_request_object( $request_method )
+    {
         $obj = null;

-        switch( $request_method )

-        {

+        switch( $request_method )
+        {
             case 'GET':

-                if( is_array( self::$CUSTOM_GET ) )

-                {

+                if( is_array( self::$CUSTOM_GET ) )
+                {
                     return self::$CUSTOM_GET;

                 }

                 return ( isset( $_GET ) && is_array( $_GET ) && count( $_GET ) > 0 ? $_GET : null );

 

             case 'POST':

-                if( is_array( self::$CUSTOM_POST ) )

-                {

+                if( is_array( self::$CUSTOM_POST ) )
+                {
                     return self::$CUSTOM_POST;

                 }

                 return ( isset( $_POST ) && is_array( $_POST ) && count( $_POST ) > 0 ? $_POST : null );

 

             case 'COOKIE':

-                if( is_array( self::$CUSTOM_COOKIE ) )

-                {

+                if( is_array( self::$CUSTOM_COOKIE ) )
+                {
                     return self::$CUSTOM_COOKIE;

                 }

                 return ( isset( $_COOKIE ) && is_array( $_COOKIE ) && count( $_COOKIE ) > 0 ? $_COOKIE : null );

 

             case 'SERVER':

-                if( is_array( self::$CUSTOM_SERVER ) )

-                {

+                if( is_array( self::$CUSTOM_SERVER ) )
+                {
                     return self::$CUSTOM_SERVER;

                 }

                 return ( isset( $_SERVER ) && is_array( $_SERVER ) && count( $_SERVER ) > 0 ? $_SERVER : null );

@@ -233,8 +233,8 @@ 
      * @param  string  $method The server method to test for. Generally one of GET, POST, HEAD, PUT, DELETE.

      * @return boolean         Returns true if the REQUEST_METHOD server variable is set to the supplied $method, otherwise false.

      */

-    public static function is_request_method( $method )

-    {

+    public static function is_request_method( $method )
+    {
         return $method === self::get_server_value( 'REQUEST_METHOD' );

     }

 

@@ -248,8 +248,8 @@ 
      *

      * @return boolean Returns true if the REQUEST_METHOD server variable is set to POST, otherwise false.

      */

-    public static function is_post( )

-    {

+    public static function is_post( )
+    {
         return self::is_request_method( 'POST' );

     }

 

@@ -261,8 +261,8 @@ 
      * @param  mixed  $input The value to test.

      * @return boolean       True if $input is an integer or a string that contains only digits possibly starting with a dash.

      */

-    public static function is_integer_like( $input )

-    {

+    public static function is_integer_like( $input )
+    {
         return

                 is_int( $input )

                 ||

@@ -281,9 +281,11 @@ 
      * @param  array $parsed_url An array created by urlpieces.

      * @return string            A URL string.

      */

-    public static function unparse_url( $parsed_url ) {

+    public static function unparse_url( $parsed_url )
+    {
         //I don't know what you gave me so you can just have it back

-        if( ! is_array( $parsed_url ) ) {

+        if( ! is_array( $parsed_url ) )
+        {
             return $parsed_url;

         }

         $scheme   = isset( $parsed_url['scheme'])    ?       $parsed_url['scheme'] . '://' : '';