jaxon-php / jaxon-core

src/Jaxon.php

Doc Comments -10 removed lines

@@ -142,16 +142,6 @@
      *        - Jaxon::CALLABLE_OBJECT: an object who's methods are to be registered

      *        - Jaxon::BROWSER_EVENT: an event which will cause zero or more event handlers to be called

      *        - Jaxon::EVENT_HANDLER: register an event handler function.

-     * @param mixed        $sFunction | $objObject | $sEvent

-     *        When registering a function, this is the name of the function

-     *        When registering a callable object, this is the object being registered

-     *        When registering an event or event handler, this is the name of the event

-     * @param mixed        $sIncludeFile | $aCallOptions | $sEventHandler

-     *        When registering a function, this is the (optional) include file

-     *        When registering a callable object, this is an (optional) array

-     *             of call options for the functions being registered

-     *        When registering an event handler, this is the name of the function

-     *

      * @return mixed

      */

     public function register($sType, $xArgs)

Unused Use Statements +2 added lines, -7 removed lines

@@ -25,14 +25,9 @@
 

 namespace Jaxon;

 

-use Jaxon\Plugin\Manager as PluginManager;

-use Jaxon\Request\Manager as RequestManager;

-use Jaxon\Response\Manager as ResponseManager;

-

-use Jaxon\Utils\URI;

-use Jaxon\Utils\Container;

+use Jaxon\Utils\URI;
+use Jaxon\Utils\Container;
 use Exception;

-use Closure;

 

 class Jaxon

 {

Spacing +17 added lines, -17 removed lines

@@ -159,13 +159,13 @@ 
         $aArgs = func_get_args();

         $nArgs = func_num_args();

 

-        if(self::PROCESSING_EVENT == $sType)

+        if (self::PROCESSING_EVENT == $sType)

         {

-            if($nArgs > 2)

+            if ($nArgs > 2)

             {

                 $sEvent = $xArgs;

                 $xUserFunction = $aArgs[2];

-                if(!is_a($xUserFunction, 'Request\\Support\\UserFunction'))

+                if (!is_a($xUserFunction, 'Request\\Support\\UserFunction'))

                     $xUserFunction = new Request\Support\UserFunction($xUserFunction);

                 $this->aProcessingEvents[$sEvent] = $xUserFunction;

             }

@@ -237,16 +237,16 @@ 
      */

     public function getScript($bIncludeJs = false, $bIncludeCss = false)

     {

-        if(!$this->getOption('core.request.uri'))

+        if (!$this->getOption('core.request.uri'))

         {

             $this->setOption('core.request.uri', URI::detect());

         }

         $sCode = '';

-        if(($bIncludeCss))

+        if (($bIncludeCss))

         {

             $sCode .= $this->getPluginManager()->getCss() . "\n";

         }

-        if(($bIncludeJs))

+        if (($bIncludeJs))

         {

             $sCode .= $this->getPluginManager()->getJs() . "\n";

         }

@@ -317,7 +317,7 @@ 
     public function processRequest()

     {

         // Check to see if headers have already been sent out, in which case we can't do our job

-        if(headers_sent($filename, $linenumber))

+        if (headers_sent($filename, $linenumber))

         {

             echo $this->trans('errors.output.already-sent', array(

                 'location' => $filename . ':' . $linenumber

@@ -326,7 +326,7 @@ 
         }

 

         // Check if there is a plugin to process this request

-        if(!$this->canProcessRequest())

+        if (!$this->canProcessRequest())

         {

             return;

         }

@@ -335,18 +335,18 @@ 
         $mResult = true;

 

         // Handle before processing event

-        if(isset($this->aProcessingEvents[self::PROCESSING_EVENT_BEFORE]))

+        if (isset($this->aProcessingEvents[self::PROCESSING_EVENT_BEFORE]))

         {

             $this->aProcessingEvents[self::PROCESSING_EVENT_BEFORE]->call(array(&$bEndRequest));

         }

 

-        if(!$bEndRequest)

+        if (!$bEndRequest)

         {

             try

             {

                 $mResult = $this->getPluginManager()->processRequest();

             }

-            catch(Exception $e)

+            catch (Exception $e)

             {

                 // An exception was thrown while processing the request.

                 // The request missed the corresponding handler function,

@@ -359,7 +359,7 @@ 
                 $xResponseManager->debug($e->getMessage());

                 $mResult = false;

 

-                if($e instanceof \Jaxon\Exception\Error)

+                if ($e instanceof \Jaxon\Exception\Error)

                 {

                     $sEvent = self::PROCESSING_EVENT_INVALID;

                     $aParams = array($e->getMessage());

@@ -370,7 +370,7 @@ 
                     $aParams = array($e);

                 }

 

-                if(isset($this->aProcessingEvents[$sEvent]))

+                if (isset($this->aProcessingEvents[$sEvent]))

                 {

                     // Call the processing event

                     $this->aProcessingEvents[$sEvent]->call($aParams);

@@ -383,7 +383,7 @@ 
             }

         }

         // Clean the processing buffer

-        if(($this->getOption('core.process.clean')))

+        if (($this->getOption('core.process.clean')))

         {

             $er = error_reporting(0);

             while (ob_get_level() > 0)

@@ -393,10 +393,10 @@ 
             error_reporting($er);

         }

 

-        if($mResult === true)

+        if ($mResult === true)

         {

             // Handle after processing event

-            if(isset($this->aProcessingEvents[self::PROCESSING_EVENT_AFTER]))

+            if (isset($this->aProcessingEvents[self::PROCESSING_EVENT_AFTER]))

             {

                 $bEndRequest = false;

                 $this->aProcessingEvents[self::PROCESSING_EVENT_AFTER]->call(array($bEndRequest));

@@ -405,7 +405,7 @@ 
 

         $this->getResponseManager()->printDebug();

 

-        if(($this->getOption('core.process.exit')))

+        if (($this->getOption('core.process.exit')))

         {

             $this->getResponseManager()->sendOutput();

             exit();

Braces +6 added lines, -8 removed lines

@@ -165,8 +165,9 @@ 
             {

                 $sEvent = $xArgs;

                 $xUserFunction = $aArgs[2];

-                if(!is_a($xUserFunction, 'Request\\Support\\UserFunction'))

-                    $xUserFunction = new Request\Support\UserFunction($xUserFunction);

+                if(!is_a($xUserFunction, 'Request\\Support\\UserFunction')) {
+                                    $xUserFunction = new Request\Support\UserFunction($xUserFunction);
+                }
                 $this->aProcessingEvents[$sEvent] = $xUserFunction;

             }

             /*else

@@ -345,8 +346,7 @@ 
             try

             {

                 $mResult = $this->getPluginManager()->processRequest();

-            }

-            catch(Exception $e)

+            } catch(Exception $e)

             {

                 // An exception was thrown while processing the request.

                 // The request missed the corresponding handler function,

@@ -363,8 +363,7 @@ 
                 {

                     $sEvent = self::PROCESSING_EVENT_INVALID;

                     $aParams = array($e->getMessage());

-                }

-                else

+                } else

                 {

                     $sEvent = self::PROCESSING_EVENT_ERROR;

                     $aParams = array($e);

@@ -374,8 +373,7 @@ 
                 {

                     // Call the processing event

                     $this->aProcessingEvents[$sEvent]->call($aParams);

-                }

-                else

+                } else

                 {

                     // The exception is not to be processed here.

                     throw $e;

src/Traits/Config.php

Doc Comments +4 added lines, -4 removed lines

@@ -69,7 +69,7 @@ 
      * @param string        $sLibKey            The key of the library options in the file

      * @param string|null   $sAppKey            The key of the application options in the file

      *

-     * @return array

+     * @return null|\Jaxon\Utils\Config\Config

      */

     public function readPhpConfigFile($sConfigFile, $sLibKey = '', $sAppKey = null)

     {

@@ -83,7 +83,7 @@ 
      * @param string        $sLibKey            The key of the library options in the file

      * @param string|null   $sAppKey            The key of the application options in the file

      *

-     * @return array

+     * @return null|\Jaxon\Utils\Config\Config

      */

     public function readYamlConfigFile($sConfigFile, $sLibKey = '', $sAppKey = null)

     {

@@ -97,7 +97,7 @@ 
      * @param string        $sLibKey            The key of the library options in the file

      * @param string|null   $sAppKey            The key of the application options in the file

      *

-     * @return array

+     * @return \Jaxon\Utils\Config\Config|null

      */

     public function readJsonConfigFile($sConfigFile, $sLibKey = '', $sAppKey = null)

     {

@@ -111,7 +111,7 @@ 
      * @param string        $sLibKey            The key of the library options in the file

      * @param string|null   $sAppKey            The key of the application options in the file

      *

-     * @return array

+     * @return null|\Jaxon\Utils\Config\Config

      */

     public function readConfigFile($sConfigFile, $sLibKey = '', $sAppKey = null)

     {

Unused Use Statements +2 added lines, -2 removed lines

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

 namespace Jaxon\Traits;

 

-use Jaxon\Utils\Config\Php;

-use Jaxon\Utils\Config\Yaml;

+use Jaxon\Utils\Config\Php;
+use Jaxon\Utils\Config\Yaml;
 use Jaxon\Utils\Config\Json;

 

 trait Config

Spacing +2 added lines, -2 removed lines

@@ -43,7 +43,7 @@ 
             'core.prefix.event'                 => 'jaxon_event_',

             // 'core.request.uri'               => '',

             'core.request.mode'                 => 'asynchronous',

-            'core.request.method'               => 'POST',    // W3C: Method is case sensitive

+            'core.request.method'               => 'POST', // W3C: Method is case sensitive

             'core.debug.on'                     => false,

             'core.debug.verbose'                => false,

             'core.process.exit'                 => true,

@@ -116,7 +116,7 @@ 
     public function readConfigFile($sConfigFile, $sLibKey = '', $sAppKey = null)

     {

         $sExt = pathinfo($sConfigFile, PATHINFO_EXTENSION);

-        switch($sExt)

+        switch ($sExt)

         {

         case 'php':

             return $this->readPhpConfigFile($sConfigFile, $sLibKey, $sAppKey);

src/Utils/Container.php

Doc Comments +1 added lines, -1 removed lines

@@ -212,7 +212,7 @@
     /**

      * Create a new the config manager

      *

-     * @return Jaxon\Utils\Config\Config            The config manager

+     * @return Config\Config            The config manager

      */

     public function newConfig()

     {

Unused Use Statements +1 added lines, -1 removed lines

@@ -14,7 +14,7 @@
 

 namespace Jaxon\Utils;

 

-use Lemon\Event\EventDispatcher;

+use Lemon\Event\EventDispatcher;
 use Jaxon\Sentry\View\Renderer;

 

 class Container

Spacing +20 added lines, -20 removed lines

@@ -27,7 +27,7 @@ 
 

     public static function getInstance()

     {

-        if(!self::$xInstance)

+        if (!self::$xInstance)

         {

             self::$xInstance = new Container();

         }

@@ -65,19 +65,19 @@ 
          * Managers

          */

         // Plugin Manager

-        $this->di['plugin_manager'] = function ($c) {

+        $this->di['plugin_manager'] = function($c) {

             return new \Jaxon\Plugin\Manager();

         };

         // Request Manager

-        $this->di['request_manager'] = function ($c) {

+        $this->di['request_manager'] = function($c) {

             return new \Jaxon\Request\Manager();

         };

         // Request Factory

-        $this->di['request_factory'] = function ($c) {

+        $this->di['request_factory'] = function($c) {

             return new \Jaxon\Request\Factory();

         };

         // Response Manager

-        $this->di['response_manager'] = function ($c) {

+        $this->di['response_manager'] = function($c) {

             return new \Jaxon\Response\Manager();

         };

 

@@ -85,35 +85,35 @@ 
          * Services

          */

         // Config manager

-        $this->di['config'] = function ($c) {

+        $this->di['config'] = function($c) {

             return new Config\Config();

         };

         // Minifier

-        $this->di['minifier'] = function ($c) {

+        $this->di['minifier'] = function($c) {

             return new Template\Minifier();

         };

         // Translator

-        $this->di['translator'] = function ($c) {

+        $this->di['translator'] = function($c) {

             return new Translation\Translator($c['translation_dir'], $c['config']);

         };

         // Template engine

-        $this->di['template'] = function ($c) {

+        $this->di['template'] = function($c) {

             return new Template\Template($c['template_dir']);

         };

         // Validator

-        $this->di['validator'] = function ($c) {

+        $this->di['validator'] = function($c) {

             return new Validation\Validator($c['translator'], $c['config']);

         };

         // Pagination Renderer

-        $this->di['pagination.renderer'] = function ($c) {

+        $this->di['pagination.renderer'] = function($c) {

             return new Pagination\Renderer();

         };

         // Pagination Paginator

-        $this->di['pagination.paginator'] = function ($c) {

+        $this->di['pagination.paginator'] = function($c) {

             return new Pagination\Paginator($c['pagination.renderer']);

         };

         // Event Dispatcher

-        $this->di['events'] = function ($c) {

+        $this->di['events'] = function($c) {

             return new EventDispatcher();

         };

 

@@ -121,15 +121,15 @@ 
          * Core library objects

          */

         // Global Response

-        $this->di['response'] = function ($c) {

+        $this->di['response'] = function($c) {

             return new \Jaxon\Response\Response();

         };

         // Jaxon Core

-        $this->di['jaxon'] = function ($c) {

+        $this->di['jaxon'] = function($c) {

             return new \Jaxon\Jaxon();

         };

         // View Renderer Facade

-        $this->di['sentry.view.renderer'] = function ($c) {

+        $this->di['sentry.view.renderer'] = function($c) {

             $aRenderers = $c['view.data.renderers'];

             $sDefaultNamespace = $c['view.data.namespace.default'];

             return new \Jaxon\Sentry\View\Facade($aRenderers, $sDefaultNamespace);

@@ -414,14 +414,14 @@ 
         $this->di['sentry.view.base.' . $sId] = $xClosure;

 

         // Return the initialized view renderer

-        $this->di['sentry.view.' . $sId] = function ($c) use ($sId) {

+        $this->di['sentry.view.' . $sId] = function($c) use ($sId) {

             // Get the defined renderer

             $renderer = $c['sentry.view.base.' . $sId];

             // Init the renderer with the template namespaces

             $aNamespaces = $this->di['view.data.namespaces'];

-            if(key_exists($sId, $aNamespaces))

+            if (key_exists($sId, $aNamespaces))

             {

-                foreach($aNamespaces[$sId] as $ns)

+                foreach ($aNamespaces[$sId] as $ns)

                 {

                     $renderer->addNamespace($ns['namespace'], $ns['directory'], $ns['extension']);

                 }

@@ -439,7 +439,7 @@ 
      */

     public function getViewRenderer($sId = '')

     {

-        if(!$sId)

+        if (!$sId)

         {

             // Return the view renderer facade

             return $this->di['sentry.view.renderer'];

src/Request/Support/CallableObject.php

Spacing +24 added lines, -24 removed lines

@@ -93,7 +93,7 @@ 
      */

     public function __construct($xCallable)

     {

-        if(is_string($xCallable)) // Received a class name

+        if (is_string($xCallable)) // Received a class name

         {

             $this->reflectionClass = new \ReflectionClass($xCallable);

             $this->callableObject = null;

@@ -119,14 +119,14 @@ 
      */

     private function setCallable($xCallable = null)

     {

-        if($xCallable == null)

+        if ($xCallable == null)

         {

             // Use the Reflection class to get the parameters of the constructor

-            if(($constructor = $this->reflectionClass->getConstructor()) != null)

+            if (($constructor = $this->reflectionClass->getConstructor()) != null)

             {

                 $parameters = $constructor->getParameters();

                 $parameterInstances = [];

-                foreach($parameters as $parameter)

+                foreach ($parameters as $parameter)

                 {

                     // Get the parameter instance from the DI

                     $parameterInstance[] = $this->diGet($parameter->getClass()->getName());

@@ -139,7 +139,7 @@ 
             }

         }

         // Save the Jaxon callable object into the user callable object

-        if($this->reflectionClass->hasMethod('setJaxonCallable'))

+        if ($this->reflectionClass->hasMethod('setJaxonCallable'))

         {

             $xCallable->setJaxonCallable($this);

         }

@@ -153,7 +153,7 @@ 
      */

     public function getRegisteredObject()

     {

-        if($this->callableObject == null)

+        if ($this->callableObject == null)

         {

             $this->setCallable();

         }

@@ -181,7 +181,7 @@ 
         // The class name without the namespace.

         $name = $this->reflectionClass->getShortName();

         // Append the classpath to the name

-        if(($this->classpath))

+        if (($this->classpath))

         {

             $name = $this->classpath . '\\' . $name;

         }

@@ -228,16 +228,16 @@ 
     public function getMethods()

     {

         $aReturn = [];

-        foreach($this->reflectionClass->getMethods(\ReflectionMethod::IS_PUBLIC) as $xMethod)

+        foreach ($this->reflectionClass->getMethods(\ReflectionMethod::IS_PUBLIC) as $xMethod)

         {

             $sMethodName = $xMethod->getShortName();

             // Don't take magic __call, __construct, __destruct methods

-            if(strlen($sMethodName) > 2 && substr($sMethodName, 0, 2) == '__')

+            if (strlen($sMethodName) > 2 && substr($sMethodName, 0, 2) == '__')

             {

                 continue;

             }

             // Don't take excluded methods

-            if(in_array($sMethodName, $this->aProtectedMethods))

+            if (in_array($sMethodName, $this->aProtectedMethods))

             {

                 continue;

             }

@@ -258,37 +258,37 @@ 
     public function configure($sMethod, $sName, $sValue)

     {

         // Set the namespace

-        if($sName == 'namespace')

+        if ($sName == 'namespace')

         {

-            if($sValue != '')

+            if ($sValue != '')

                 $this->namespace = $sValue;

             return;

         }

         // Set the classpath

-        if($sName == 'classpath')

+        if ($sName == 'classpath')

         {

-            if($sValue != '')

+            if ($sValue != '')

                 $this->classpath = trim($sValue, '\\');

             return;

         }

         // Set the separator

-        if($sName == 'separator')

+        if ($sName == 'separator')

         {

-            if($sValue == '_' || $sValue == '.')

+            if ($sValue == '_' || $sValue == '.')

                 $this->separator = $sValue;

             return;

         }

         // Set the excluded methods

-        if($sName == 'protected')

+        if ($sName == 'protected')

         {

-            if(is_array($sValue))

+            if (is_array($sValue))

                 $this->aProtectedMethods = array_merge($this->aProtectedMethods, $sValue);

-            elseif(is_string($sValue))

+            elseif (is_string($sValue))

                 $this->aProtectedMethods[] = $sValue;

             return;

         }

         

-        if(!isset($this->aConfiguration[$sMethod]))

+        if (!isset($this->aConfiguration[$sMethod]))

         {

             $this->aConfiguration[$sMethod] = [];

         }

@@ -309,16 +309,16 @@ 
 

         // Common options to be set on all methods

         $aCommonConfig = array_key_exists('*', $this->aConfiguration) ? $this->aConfiguration['*'] : [];

-        foreach($this->reflectionClass->getMethods(\ReflectionMethod::IS_PUBLIC) as $xMethod)

+        foreach ($this->reflectionClass->getMethods(\ReflectionMethod::IS_PUBLIC) as $xMethod)

         {

             $sMethodName = $xMethod->getShortName();

             // Don't export magic __call, __construct, __destruct methods

-            if(strlen($sMethodName) > 0 && substr($sMethodName, 0, 2) == '__')

+            if (strlen($sMethodName) > 0 && substr($sMethodName, 0, 2) == '__')

             {

                 continue;

             }

             // Don't export "protected" methods

-            if(in_array($sMethodName, $this->aProtectedMethods))

+            if (in_array($sMethodName, $this->aProtectedMethods))

             {

                 continue;

             }

@@ -368,7 +368,7 @@ 
      */

     public function call($sMethod, $aArgs)

     {

-        if(!$this->hasMethod($sMethod))

+        if (!$this->hasMethod($sMethod))

             return;

         $reflectionMethod = $this->reflectionClass->getMethod($sMethod);

         $callableObject = $this->getRegisteredObject();

Braces +23 added lines, -18 removed lines

@@ -93,12 +93,13 @@ 
      */

     public function __construct($xCallable)

     {

-        if(is_string($xCallable)) // Received a class name

+        if(is_string($xCallable)) {
+            // Received a class name

         {

-            $this->reflectionClass = new \ReflectionClass($xCallable);

+            $this->reflectionClass = new \ReflectionClass($xCallable);
+        }
             $this->callableObject = null;

-        }

-        else // if(is_object($xCallable)) // Received a class instance

+        } else // if(is_object($xCallable)) // Received a class instance

         {

             $this->reflectionClass = new \ReflectionClass(get_class($xCallable));

             $this->setCallable($xCallable);

@@ -132,8 +133,7 @@ 
                     $parameterInstance[] = $this->diGet($parameter->getClass()->getName());

                 }

                 $xCallable = $this->reflectionClass->newInstanceArgs($parameterInstance);

-            }

-            else

+            } else

             {

                 $xCallable = $this->reflectionClass->newInstance();

             }

@@ -260,31 +260,35 @@ 
         // Set the namespace

         if($sName == 'namespace')

         {

-            if($sValue != '')

-                $this->namespace = $sValue;

+            if($sValue != '') {
+                            $this->namespace = $sValue;
+            }
             return;

         }

         // Set the classpath

         if($sName == 'classpath')

         {

-            if($sValue != '')

-                $this->classpath = trim($sValue, '\\');

+            if($sValue != '') {
+                            $this->classpath = trim($sValue, '\\');
+            }
             return;

         }

         // Set the separator

         if($sName == 'separator')

         {

-            if($sValue == '_' || $sValue == '.')

-                $this->separator = $sValue;

+            if($sValue == '_' || $sValue == '.') {
+                            $this->separator = $sValue;
+            }
             return;

         }

         // Set the excluded methods

         if($sName == 'protected')

         {

-            if(is_array($sValue))

-                $this->aProtectedMethods = array_merge($this->aProtectedMethods, $sValue);

-            elseif(is_string($sValue))

-                $this->aProtectedMethods[] = $sValue;

+            if(is_array($sValue)) {
+                            $this->aProtectedMethods = array_merge($this->aProtectedMethods, $sValue);
+            } elseif(is_string($sValue)) {
+                            $this->aProtectedMethods[] = $sValue;
+            }
             return;

         }

         

@@ -368,8 +372,9 @@ 
      */

     public function call($sMethod, $aArgs)

     {

-        if(!$this->hasMethod($sMethod))

-            return;

+        if(!$this->hasMethod($sMethod)) {
+                    return;
+        }
         $reflectionMethod = $this->reflectionClass->getMethod($sMethod);

         $callableObject = $this->getRegisteredObject();

         $this->getResponseManager()->append($reflectionMethod->invokeArgs($callableObject, $aArgs));