jaxon-php / jaxon-core

src/Factory/Request.php

Doc Comments +4 added lines, -7 removed lines

@@ -34,7 +34,7 @@ 
      *
      * @param string|null            $sClass              The callable class
      *
-     * @return Factory
+     * @return Request
      */
     public function setClassName($sClass)
     {
@@ -57,7 +57,7 @@ 
      *
      * @param CallableObject          $xCallable              The callable object
      *
-     * @return Factory
+     * @return Request
      */
     public function setCallable(CallableObject $xCallable)
     {
@@ -70,9 +70,8 @@ 
      * Return the javascript call to a Jaxon function or object method
      *
      * @param string            $sFunction          The function or method (without class) name
-     * @param ...               $xParams            The parameters of the function or method
      *
-     * @return \Jaxon\Request\Request
+     * @return Request
      */
     public function call($sFunction)
     {
@@ -99,9 +98,8 @@ 
      * Return the javascript call to a generic function
      *
      * @param string            $sFunction          The function or method (with class) name
-     * @param ...               $xParams            The parameters of the function or method
      *
-     * @return \Jaxon\Request\Request
+     * @return Request
      */
     public function func($sFunction)
     {
@@ -123,7 +121,6 @@ 
      * @param integer       $nItemsPerPage          The number of items per page page
      * @param integer       $nCurrentPage           The current page
      * @param string        $sMethod                The name of function or a method prepended with its class name
-     * @param ...           $xParams                The parameters of the function or method
      *
      * @return string the pagination links
      */

src/DI/Container.php

Spacing +21 added lines, -21 removed lines

@@ -30,7 +30,7 @@ 
 
     public static function getInstance()
     {
-        if(!self::$xInstance)
+        if (!self::$xInstance)
         {
             self::$xInstance = new Container();
         }
@@ -90,19 +90,19 @@ 
          * Managers
          */
         // Plugin Manager
-        $this->coreContainer['jaxon.core.plugin_manager'] = function ($c) {
+        $this->coreContainer['jaxon.core.plugin_manager'] = function($c) {
             return new \Jaxon\Plugin\Manager();
         };
         // Request Manager
-        $this->coreContainer['jaxon.core.request_manager'] = function ($c) {
+        $this->coreContainer['jaxon.core.request_manager'] = function($c) {
             return new \Jaxon\Request\Manager();
         };
         // Request Factory
-        $this->coreContainer['jaxon.core.request_factory'] = function ($c) {
+        $this->coreContainer['jaxon.core.request_factory'] = function($c) {
             return new \Jaxon\Factory\Request();
         };
         // Response Manager
-        $this->coreContainer['jaxon.core.response_manager'] = function ($c) {
+        $this->coreContainer['jaxon.core.response_manager'] = function($c) {
             return new \Jaxon\Response\Manager();
         };
 
@@ -110,35 +110,35 @@ 
          * Services
          */
         // Config manager
-        $this->coreContainer['jaxon.core.config'] = function ($c) {
+        $this->coreContainer['jaxon.core.config'] = function($c) {
             return new \Jaxon\Utils\Config\Config();
         };
         // Minifier
-        $this->coreContainer['jaxon.core.minifier'] = function ($c) {
+        $this->coreContainer['jaxon.core.minifier'] = function($c) {
             return new \Jaxon\Utils\Template\Minifier();
         };
         // Translator
-        $this->coreContainer['jaxon.core.translator'] = function ($c) {
+        $this->coreContainer['jaxon.core.translator'] = function($c) {
             return new \Jaxon\Utils\Translation\Translator($c['jaxon.core.translation_dir'], $c['jaxon.core.config']);
         };
         // Template engine
-        $this->coreContainer['jaxon.core.template'] = function ($c) {
+        $this->coreContainer['jaxon.core.template'] = function($c) {
             return new \Jaxon\Utils\Template\Template($c['jaxon.core.template_dir']);
         };
         // Validator
-        $this->coreContainer['jaxon.core.validator'] = function ($c) {
+        $this->coreContainer['jaxon.core.validator'] = function($c) {
             return new \Jaxon\Utils\Validation\Validator($c['jaxon.core.translator'], $c['jaxon.core.config']);
         };
         // Pagination Renderer
-        $this->coreContainer['jaxon.pagination.renderer'] = function ($c) {
+        $this->coreContainer['jaxon.pagination.renderer'] = function($c) {
             return new \Jaxon\Utils\Pagination\Renderer();
         };
         // Pagination Paginator
-        $this->coreContainer['jaxon.pagination.paginator'] = function ($c) {
+        $this->coreContainer['jaxon.pagination.paginator'] = function($c) {
             return new \Jaxon\Utils\Pagination\Paginator($c['jaxon.pagination.renderer']);
         };
         // Event Dispatcher
-        $this->coreContainer['jaxon.core.events'] = function ($c) {
+        $this->coreContainer['jaxon.core.events'] = function($c) {
             return new EventDispatcher();
         };
 
@@ -146,15 +146,15 @@ 
          * Core library objects
          */
         // Global Response
-        $this->coreContainer['jaxon.core.response'] = function ($c) {
+        $this->coreContainer['jaxon.core.response'] = function($c) {
             return new \Jaxon\Response\Response();
         };
         // Jaxon Core
-        $this->coreContainer['jaxon.core.jaxon'] = function ($c) {
+        $this->coreContainer['jaxon.core.jaxon'] = function($c) {
             return new \Jaxon\Jaxon();
         };
         // View Renderer Facade
-        $this->coreContainer['jaxon.sentry.view.renderer'] = function ($c) {
+        $this->coreContainer['jaxon.sentry.view.renderer'] = function($c) {
             $aRenderers = $c['jaxon.view.data.renderers'];
             $sDefaultNamespace = $c['jaxon.view.data.namespace.default'];
             return new \Jaxon\Sentry\View\Facade($aRenderers, $sDefaultNamespace);
@@ -168,7 +168,7 @@ 
      */
     public function get($sClass)
     {
-        if($this->sentryContainer != null && $this->sentryContainer->has($sClass))
+        if ($this->sentryContainer != null && $this->sentryContainer->has($sClass))
         {
             return $this->sentryContainer->get($sClass);
         }
@@ -443,14 +443,14 @@ 
         $this->coreContainer['jaxon.sentry.view.base.' . $sId] = $xClosure;
 
         // Return the initialized view renderer
-        $this->coreContainer['jaxon.sentry.view.' . $sId] = function ($c) use ($sId) {
+        $this->coreContainer['jaxon.sentry.view.' . $sId] = function($c) use ($sId) {
             // Get the defined renderer
             $renderer = $c['jaxon.sentry.view.base.' . $sId];
             // Init the renderer with the template namespaces
             $aNamespaces = $this->coreContainer['jaxon.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']);
                 }
@@ -468,7 +468,7 @@ 
      */
     public function getViewRenderer($sId = '')
     {
-        if(!$sId)
+        if (!$sId)
         {
             // Return the view renderer facade
             return $this->coreContainer['jaxon.sentry.view.renderer'];

src/Request/Plugin/CallableObject.php

Spacing +56 added lines, -56 removed lines

@@ -91,19 +91,19 @@ 
         $this->sRequestedClass = null;
         $this->sRequestedMethod = null;
 
-        if(!empty($_GET['jxncls']))
+        if (!empty($_GET['jxncls']))
         {
             $this->sRequestedClass = $_GET['jxncls'];
         }
-        if(!empty($_GET['jxnmthd']))
+        if (!empty($_GET['jxnmthd']))
         {
             $this->sRequestedMethod = $_GET['jxnmthd'];
         }
-        if(!empty($_POST['jxncls']))
+        if (!empty($_POST['jxncls']))
         {
             $this->sRequestedClass = $_POST['jxncls'];
         }
-        if(!empty($_POST['jxnmthd']))
+        if (!empty($_POST['jxnmthd']))
         {
             $this->sRequestedMethod = $_POST['jxnmthd'];
         }
@@ -152,19 +152,19 @@ 
      */
     public function register($aArgs)
     {
-        if(count($aArgs) < 2)
+        if (count($aArgs) < 2)
         {
             return false;
         }
 
         $sType = $aArgs[0];
-        if($sType != Jaxon::CALLABLE_OBJECT)
+        if ($sType != Jaxon::CALLABLE_OBJECT)
         {
             return false;
         }
 
         $sCallableObject = $aArgs[1];
-        if(!is_string($sCallableObject) || !class_exists($sCallableObject))
+        if (!is_string($sCallableObject) || !class_exists($sCallableObject))
         {
             throw new \Jaxon\Exception\Error($this->trans('errors.objects.invalid-declaration'));
         }
@@ -172,31 +172,31 @@ 
         $this->aCallableObjects[] = $sCallableObject;
 
         $aOptions = count($aArgs) > 2 ? $aArgs[2] : [];
-        if(is_string($aOptions))
+        if (is_string($aOptions))
         {
             $aOptions = ['namespace' => $aOptions];
         }
-        if(!is_array($aOptions))
+        if (!is_array($aOptions))
         {
             throw new \Jaxon\Exception\Error($this->trans('errors.objects.invalid-declaration'));
         }
 
         // Save the classpath and the separator in this class
-        if(key_exists('*', $aOptions) && is_array($aOptions['*']))
+        if (key_exists('*', $aOptions) && is_array($aOptions['*']))
         {
             $_aOptions = $aOptions['*'];
             $sSeparator = '.';
-            if(key_exists('separator', $_aOptions))
+            if (key_exists('separator', $_aOptions))
             {
                 $sSeparator = trim($_aOptions['separator']);
             }
-            if(!in_array($sSeparator, ['.', '_']))
+            if (!in_array($sSeparator, ['.', '_']))
             {
                 $sSeparator = '.';
             }
             $_aOptions['separator'] = $sSeparator;
 
-            if(array_key_exists('classpath', $_aOptions))
+            if (array_key_exists('classpath', $_aOptions))
             {
                 $_aOptions['classpath'] = trim($_aOptions['classpath'], ' \\._');
                 // Save classpath with "\" in the parameters
@@ -207,12 +207,12 @@ 
         }
 
         // Register the callable object
-        jaxon()->di()->set($sCallableObject, function () use ($sCallableObject, $aOptions) {
+        jaxon()->di()->set($sCallableObject, function() use ($sCallableObject, $aOptions) {
             $xCallableObject = new \Jaxon\Request\Support\CallableObject($sCallableObject);
 
-            foreach($aOptions as $sMethod => $aValue)
+            foreach ($aOptions as $sMethod => $aValue)
             {
-                foreach($aValue as $sName => $sValue)
+                foreach ($aValue as $sName => $sValue)
                 {
                     $xCallableObject->configure($sMethod, $sName, $sValue);
                 }
@@ -222,13 +222,13 @@ 
         });
 
         // Register the request factory for this callable object
-        jaxon()->di()->set($sCallableObject . '\Factory\Rq', function ($di) use ($sCallableObject) {
+        jaxon()->di()->set($sCallableObject . '\Factory\Rq', function($di) use ($sCallableObject) {
             $xCallableObject = $di->get($sCallableObject);
             return new \Jaxon\Factory\Request\Portable($xCallableObject);
         });
 
         // Register the paginator factory for this callable object
-        jaxon()->di()->set($sCallableObject . '\Factory\Pg', function ($di) use ($sCallableObject) {
+        jaxon()->di()->set($sCallableObject . '\Factory\Pg', function($di) use ($sCallableObject) {
             $xCallableObject = $di->get($sCallableObject);
             return new \Jaxon\Factory\Request\Paginator($xCallableObject);
         });
@@ -248,37 +248,37 @@ 
      */
     public function addClassDir($sDirectory, $sNamespace = '', $sSeparator = '.', array $aProtected = [])
     {
-        if(!is_dir(($sDirectory = trim($sDirectory))))
+        if (!is_dir(($sDirectory = trim($sDirectory))))
         {
             return false;
         }
         // Only '.' and '_' are allowed to be used as separator. Any other value is ignored and '.' is used instead.
-        if(($sSeparator = trim($sSeparator)) != '_')
+        if (($sSeparator = trim($sSeparator)) != '_')
         {
             $sSeparator = '.';
         }
-        if(!($sNamespace = trim($sNamespace, ' \\')))
+        if (!($sNamespace = trim($sNamespace, ' \\')))
         {
             $sNamespace = '';
         }
-        if(($sNamespace))
+        if (($sNamespace))
         {
             // If there is an autoloader, register the dir with PSR4 autoloading
-            if(($this->xAutoloader))
+            if (($this->xAutoloader))
             {
                 $this->xAutoloader->setPsr4($sNamespace . '\\', $sDirectory);
             }
         }
-        elseif(($this->xAutoloader))
+        elseif (($this->xAutoloader))
         {
             // If there is an autoloader, register the dir with classmap autoloading
             $itDir = new RecursiveDirectoryIterator($sDirectory);
             $itFile = new RecursiveIteratorIterator($itDir);
             // Iterate on dir content
-            foreach($itFile as $xFile)
+            foreach ($itFile as $xFile)
             {
                 // skip everything except PHP files
-                if(!$xFile->isFile() || $xFile->getExtension() != 'php')
+                if (!$xFile->isFile() || $xFile->getExtension() != 'php')
                 {
                     continue;
                 }
@@ -314,33 +314,33 @@ 
         $sClassPath = substr($xFile->getPath(), strlen($sDirectory));
         $sClassPath = str_replace($sDS, '\\', trim($sClassPath, $sDS));
         $sClassName = $xFile->getBasename('.php');
-        if(($sNamespace))
+        if (($sNamespace))
         {
             $sClassPath = ($sClassPath) ? $sNamespace . '\\' . $sClassPath : $sNamespace;
             $sClassName = '\\' . $sClassPath . '\\' . $sClassName;
         }
         // Require the file only if autoload is enabled but there is no autoloader
-        if(($this->bAutoloadEnabled) && !($this->xAutoloader))
+        if (($this->bAutoloadEnabled) && !($this->xAutoloader))
         {
             require_once($xFile->getPathname());
         }
         // Create and register an instance of the class
-        if(!array_key_exists('*', $aOptions) || !is_array($aOptions['*']))
+        if (!array_key_exists('*', $aOptions) || !is_array($aOptions['*']))
         {
             $aOptions['*'] = [];
         }
         $aOptions['*']['separator'] = $sSeparator;
-        if(($sNamespace))
+        if (($sNamespace))
         {
             $aOptions['*']['namespace'] = $sNamespace;
         }
-        if(($sClassPath))
+        if (($sClassPath))
         {
             $aOptions['*']['classpath'] = $sClassPath;
         }
         // Filter excluded methods
-        $aProtected = array_filter($aProtected, function ($sName) {return is_string($sName);});
-        if(count($aProtected) > 0)
+        $aProtected = array_filter($aProtected, function($sName) {return is_string($sName); });
+        if (count($aProtected) > 0)
         {
             $aOptions['*']['protected'] = $aProtected;
         }
@@ -359,13 +359,13 @@ 
         $sDS = DIRECTORY_SEPARATOR;
         // Change the keys in $aOptions to have "\" as separator
         $aNewOptions = [];
-        foreach($aOptions as $key => $aOption)
+        foreach ($aOptions as $key => $aOption)
         {
             $key = trim(str_replace(['.', '_'], ['\\', '\\'], $key), ' \\');
             $aNewOptions[$key] = $aOption;
         }
 
-        foreach($this->aClassDirs as $aClassDir)
+        foreach ($this->aClassDirs as $aClassDir)
         {
             // Get the directory
             $sDirectory = $aClassDir['directory'];
@@ -375,10 +375,10 @@ 
             $itDir = new RecursiveDirectoryIterator($sDirectory);
             $itFile = new RecursiveIteratorIterator($itDir);
             // Iterate on dir content
-            foreach($itFile as $xFile)
+            foreach ($itFile as $xFile)
             {
                 // skip everything except PHP files
-                if(!$xFile->isFile() || $xFile->getExtension() != 'php')
+                if (!$xFile->isFile() || $xFile->getExtension() != 'php')
                 {
                     continue;
                 }
@@ -387,17 +387,17 @@ 
                 $sClassPath = substr($xFile->getPath(), strlen($sDirectory));
                 $sClassPath = trim(str_replace($sDS, '\\', $sClassPath), '\\');
                 $sClassName = $xFile->getBasename('.php');
-                if(($sClassPath))
+                if (($sClassPath))
                 {
                     $sClassName = $sClassPath . '\\' . $sClassName;
                 }
-                if(($sNamespace))
+                if (($sNamespace))
                 {
                     $sClassName = $sNamespace . '\\' . $sClassName;
                 }
                 // Get the class options
                 $aClassOptions = [];
-                if(array_key_exists($sClassName, $aNewOptions))
+                if (array_key_exists($sClassName, $aNewOptions))
                 {
                     $aClassOptions = $aNewOptions[$sClassName];
                 }
@@ -418,7 +418,7 @@ 
      */
     public function registerClass($sClassName, array $aOptions = [])
     {
-        if(!($sClassName = trim($sClassName, ' \\._')))
+        if (!($sClassName = trim($sClassName, ' \\._')))
         {
             return false;
         }
@@ -427,7 +427,7 @@ 
         // Replace "." and "_" with antislashes, and set the class path.
         $sClassName = str_replace(['.', '_'], ['\\', '\\'], $sClassName);
         $sClassPath = '';
-        if(($nLastSlashPosition = strrpos($sClassName, '\\')) !== false)
+        if (($nLastSlashPosition = strrpos($sClassName, '\\')) !== false)
         {
             $sClassPath = substr($sClassName, 0, $nLastSlashPosition);
             $sClassName = substr($sClassName, $nLastSlashPosition + 1);
@@ -436,7 +436,7 @@ 
         $sPartPath = str_replace('\\', $sDS, $sClassPath) . $sDS . $sClassName . '.php';
 
         // Search for the class file in all directories.
-        foreach($this->aClassDirs as $aClassDir)
+        foreach ($this->aClassDirs as $aClassDir)
         {
             // Get the separator
             $sSeparator = $aClassDir['separator'];
@@ -445,15 +445,15 @@ 
             $nLen = strlen($sNamespace);
             $sFullPath = '';
             // Check if the class belongs to the namespace
-            if(($sNamespace) && substr($sClassPath, 0, $nLen) == $sNamespace)
+            if (($sNamespace) && substr($sClassPath, 0, $nLen) == $sNamespace)
             {
                 $sFullPath = $aClassDir['directory'] . $sDS . substr($sPartPath, $nLen + 1);
             }
-            elseif(!($sNamespace))
+            elseif (!($sNamespace))
             {
                 $sFullPath = $aClassDir['directory'] . $sDS . $sPartPath;
             }
-            if(($sFullPath) && is_file($sFullPath))
+            if (($sFullPath) && is_file($sFullPath))
             {
                 // Found the file in this directory
                 $xFileInfo = new \SplFileInfo($sFullPath);
@@ -475,7 +475,7 @@ 
     {
         $di = jaxon()->di();
         $sHash = '';
-        foreach($this->aCallableObjects as $sName)
+        foreach ($this->aCallableObjects as $sName)
         {
             $xCallableObject = $di->get($sName);
             $sHash .= $sName . implode('|', $xCallableObject->getMethods());
@@ -494,15 +494,15 @@ 
         // Generate code for javascript objects declaration
         $code = '';
         $classes = [];
-        foreach($this->aClassPaths as $sClassPath)
+        foreach ($this->aClassPaths as $sClassPath)
         {
             $offset = 0;
             $sClassPath .= '.Null'; // This is a sentinel. The last token is not processed in the while loop.
-            while(($dotPosition = strpos($sClassPath, '.', $offset)) !== false)
+            while (($dotPosition = strpos($sClassPath, '.', $offset)) !== false)
             {
                 $class = substr($sClassPath, 0, $dotPosition);
                 // Generate code for this object
-                if(!array_key_exists($class, $classes))
+                if (!array_key_exists($class, $classes))
                 {
                     $code .= "$sJaxonPrefix$class = {};\n";
                     $classes[$class] = $class;
@@ -512,7 +512,7 @@ 
         }
         // Generate code for javascript methods
         $di = jaxon()->di();
-        foreach($this->aCallableObjects as $sName)
+        foreach ($this->aCallableObjects as $sName)
         {
             $xCallableObject = $di->get($sName);
             $code .= $xCallableObject->getScript();
@@ -528,13 +528,13 @@ 
     public function canProcessRequest()
     {
         // Check the validity of the class name
-        if(($this->sRequestedClass) && !$this->validateClass($this->sRequestedClass))
+        if (($this->sRequestedClass) && !$this->validateClass($this->sRequestedClass))
         {
             $this->sRequestedClass = null;
             $this->sRequestedMethod = null;
         }
         // Check the validity of the method name
-        if(($this->sRequestedMethod) && !$this->validateMethod($this->sRequestedMethod))
+        if (($this->sRequestedMethod) && !$this->validateMethod($this->sRequestedMethod))
         {
             $this->sRequestedClass = null;
             $this->sRequestedMethod = null;
@@ -549,7 +549,7 @@ 
      */
     public function processRequest()
     {
-        if(!$this->canProcessRequest())
+        if (!$this->canProcessRequest())
         {
             return false;
         }
@@ -558,7 +558,7 @@ 
 
         // Find the requested method
         $xCallableObject = $this->getCallableObject($this->sRequestedClass);
-        if(!$xCallableObject || !$xCallableObject->hasMethod($this->sRequestedMethod))
+        if (!$xCallableObject || !$xCallableObject->hasMethod($this->sRequestedMethod))
         {
             // Unable to find the requested object or method
             throw new \Jaxon\Exception\Error($this->trans('errors.objects.invalid',
@@ -583,7 +583,7 @@ 
         // at the beginning and the end of the class name.
         $sClassName = trim(str_replace(['.', '_'], ['\\', '\\'], (string)$sClassName), '\\');
         // Register an instance of the requested class, if it isn't yet
-        if(!key_exists($sClassName, $this->aCallableObjects))
+        if (!key_exists($sClassName, $this->aCallableObjects))
         {
             $this->getPluginManager()->registerClass($sClassName);
         }