jaxon-php / jaxon-core

src/Features/App.php

Doc Comments +4 added lines, -4 removed lines

@@ -17,7 +17,7 @@ 
     /**
      * Get the Jaxon response.
      *
-     * @return Response
+     * @return \Jaxon\Response\Response
      */
     public function ajaxResponse()
     {
@@ -39,7 +39,7 @@ 
     /**
      * Get a request to a registered class
      *
-     * @param string        $sClass             The class name
+     * @param string        $sClassName             The class name
      *
      * @return \Jaxon\Request\Factory\CallableClass\Request
      */
@@ -108,7 +108,7 @@ 
     /**
      * Get the view renderer
      *
-     * @return Jaxon\Utils\View\Renderer
+     * @return \Jaxon\Utils\View\Renderer
      */
     public function view()
     {
@@ -118,7 +118,7 @@ 
     /**
      * Get the session manager
      *
-     * @return Jaxon\Contracts\Session
+     * @return \Jaxon\Contracts\Session
      */
     public function session()
     {

src/Response/Response.php

Doc Comments +48 added lines, -48 removed lines

@@ -197,7 +197,7 @@ 
     /**
      * Clear all the commands already added to the response
      *
-     * @return \Jaxon\Plugin\Response
+     * @return Response
      */
     public function clearCommands()
     {
@@ -211,9 +211,9 @@ 
      *
      * @param \Jaxon\Plugin\Plugin  $xPlugin            The plugin object
      * @param array                 $aAttributes        The attributes for this response command
-     * @param mixed                 $mData              The data to be sent with this command
+     * @param string                 $mData              The data to be sent with this command
      *
-     * @return \Jaxon\Plugin\Response
+     * @return ResponseContract
      */
     public function addPluginCommand($xPlugin, $aAttributes, $mData)
     {
@@ -272,7 +272,7 @@ 
      * @param integer        $iCmdNumber            The number of commands to skip upon cancel
      * @param string        $sMessage            The message to display to the user
      *
-     * @return \Jaxon\Plugin\Response
+     * @return ResponseContract
      */
     public function confirmCommands($iCmdNumber, $sMessage)
     {
@@ -292,7 +292,7 @@ 
      * @param string        $sAttribute           The attribute to be assigned
      * @param string        $sData                The value to be assigned to the attribute
      *
-     * @return \Jaxon\Plugin\Response
+     * @return ResponseContract
      */
     public function assign($sTarget, $sAttribute, $sData)
     {
@@ -314,7 +314,7 @@ 
      * @param string        $sTarget              The id of the html element on the browser
      * @param string        $sData                The value to be assigned to the attribute
      *
-     * @return \Jaxon\Plugin\Response
+     * @return ResponseContract
      */
     public function html($sTarget, $sData)
     {
@@ -328,7 +328,7 @@ 
      * @param string        $sAttribute            The name of the attribute to be appended to
      * @param string        $sData                The data to be appended to the attribute
      *
-     * @return \Jaxon\Plugin\Response
+     * @return ResponseContract
      */
     public function append($sTarget, $sAttribute, $sData)
     {
@@ -349,7 +349,7 @@ 
      * @param string        $sAttribute            The name of the attribute to be prepended to
      * @param string        $sData                The value to be prepended to the attribute
      *
-     * @return \Jaxon\Plugin\Response
+     * @return ResponseContract
      */
     public function prepend($sTarget, $sAttribute, $sData)
     {
@@ -371,7 +371,7 @@ 
      * @param string        $sSearch            The needle to search for
      * @param string        $sData                The data to use in place of the needle
      *
-     * @return \Jaxon\Plugin\Response
+     * @return ResponseContract
      */
     public function replace($sTarget, $sAttribute, $sSearch, $sData)
     {
@@ -394,7 +394,7 @@ 
      * @param string        $sTarget            The id of the element to be updated.
      * @param string        $sAttribute            The attribute to be cleared
      *
-     * @return \Jaxon\Plugin\Response
+     * @return ResponseContract
      */
     public function clear($sTarget, $sAttribute)
     {
@@ -410,7 +410,7 @@ 
      * @param string        $sAttribute            The attribute to be updated
      * @param string        $sData                The value to assign
      *
-     * @return \Jaxon\Plugin\Response
+     * @return ResponseContract
      */
     public function contextAssign($sAttribute, $sData)
     {
@@ -432,7 +432,7 @@ 
      * @param string        $sAttribute            The attribute to be appended to
      * @param string        $sData                The value to append
      *
-     * @return \Jaxon\Plugin\Response
+     * @return ResponseContract
      */
     public function contextAppend($sAttribute, $sData)
     {
@@ -454,7 +454,7 @@ 
      * @param string        $sAttribute            The attribute to be updated
      * @param string        $sData                The value to be prepended
      *
-     * @return \Jaxon\Plugin\Response
+     * @return ResponseContract
      */
     public function contextPrepend($sAttribute, $sData)
     {
@@ -475,7 +475,7 @@ 
      *
      * @param string        $sAttribute            The attribute to be cleared
      *
-     * @return \Jaxon\Plugin\Response
+     * @return ResponseContract
      */
     public function contextClear($sAttribute)
     {
@@ -487,7 +487,7 @@ 
      *
      * @param string        $sMessage            The message to be displayed
      *
-     * @return \Jaxon\Plugin\Response
+     * @return ResponseContract
      */
     public function alert($sMessage)
     {
@@ -504,7 +504,7 @@ 
      *
      * @param string        $sMessage            The message to be displayed
      *
-     * @return \Jaxon\Plugin\Response
+     * @return ResponseContract
      */
     public function debug($sMessage)
     {
@@ -522,7 +522,7 @@ 
      * @param string        $sURL                The relative or fully qualified URL
      * @param integer        $iDelay                Number of seconds to delay before the redirect occurs
      *
-     * @return \Jaxon\Plugin\Response
+     * @return Response
      */
     public function redirect($sURL, $iDelay=0)
     {
@@ -575,7 +575,7 @@ 
      *
      * @param string        $sJS                The script to execute
      *
-     * @return \Jaxon\Plugin\Response
+     * @return ResponseContract
      */
     public function script($sJS)
     {
@@ -592,7 +592,7 @@ 
      *
      * @param string        $sFunc                The name of the function to call
      *
-     * @return \Jaxon\Plugin\Response
+     * @return ResponseContract
      */
     public function call($sFunc)
     {
@@ -612,7 +612,7 @@ 
      *
      * @param string        $sTarget            The id of the element to be removed
      *
-     * @return \Jaxon\Plugin\Response
+     * @return ResponseContract
      */
     public function remove($sTarget)
     {
@@ -632,7 +632,7 @@ 
      * @param string        $sTag                The tag name to be used for the new element
      * @param string        $sId                The id to assign to the new element
      *
-     * @return \Jaxon\Plugin\Response
+     * @return ResponseContract
      */
     public function create($sParent, $sTag, $sId)
     {
@@ -653,7 +653,7 @@ 
      * @param string        $sTag               The tag name to be used for the new element
      * @param string        $sId                The id to assign to the new element
      *
-     * @return \Jaxon\Plugin\Response
+     * @return ResponseContract
      */
     public function insert($sBefore, $sTag, $sId)
     {
@@ -674,7 +674,7 @@ 
      * @param string        $sTag               The tag name to be used for the new element
      * @param string        $sId                The id to assign to the new element
      *
-     * @return \Jaxon\Plugin\Response
+     * @return ResponseContract
      */
     public function insertAfter($sAfter, $sTag, $sId)
     {
@@ -696,7 +696,7 @@ 
      * @param string        $sName                The name of the new input element
      * @param string        $sId                The id of the new element
      *
-     * @return \Jaxon\Plugin\Response
+     * @return ResponseContract
      */
     public function createInput($sParent, $sType, $sName, $sId)
     {
@@ -719,7 +719,7 @@ 
      * @param string        $sName                The name of the new input element
      * @param string        $sId                The id of the new element
      *
-     * @return \Jaxon\Plugin\Response
+     * @return ResponseContract
      */
     public function insertInput($sBefore, $sType, $sName, $sId)
     {
@@ -742,7 +742,7 @@ 
      * @param string        $sName                The name of the new input element
      * @param string        $sId                The id of the new element
      *
-     * @return \Jaxon\Plugin\Response
+     * @return ResponseContract
      */
     public function insertInputAfter($sAfter, $sType, $sName, $sId)
     {
@@ -764,7 +764,7 @@ 
      * @param string        $sEvent                The name of the event
      * @param string        $sScript            The javascript to execute when the event is fired
      *
-     * @return \Jaxon\Plugin\Response
+     * @return ResponseContract
      */
     public function setEvent($sTarget, $sEvent, $sScript)
     {
@@ -784,7 +784,7 @@ 
      * @param string        $sTarget            The id of the element that contains the event
      * @param string        $sScript            The javascript to execute when the event is fired
      *
-     * @return \Jaxon\Plugin\Response
+     * @return ResponseContract
      */
     public function onClick($sTarget, $sScript)
     {
@@ -800,7 +800,7 @@ 
      * @param string        $sEvent              The name of the event
      * @param string        $sHandler            The name of the javascript function to call when the event is fired
      *
-     * @return \Jaxon\Plugin\Response
+     * @return ResponseContract
      */
     public function addHandler($sTarget, $sEvent, $sHandler)
     {
@@ -821,7 +821,7 @@ 
      * @param string        $sEvent              The name of the event
      * @param string        $sHandler            The name of the javascript function called when the event is fired
      *
-     * @return \Jaxon\Plugin\Response
+     * @return ResponseContract
      */
     public function removeHandler($sTarget, $sEvent, $sHandler)
     {
@@ -842,7 +842,7 @@ 
      * @param string        $sArgs                Comma separated list of parameter names
      * @param string        $sScript            The javascript code that will become the body of the function
      *
-     * @return \Jaxon\Plugin\Response
+     * @return ResponseContract
      */
     public function setFunction($sFunction, $sArgs, $sScript)
     {
@@ -869,7 +869,7 @@ 
      * @param string        $sReturnValueVar    The name of the variable that will retain the return value
      *                                             from the call to the original function
      *
-     * @return \Jaxon\Plugin\Response
+     * @return ResponseContract
      */
     public function wrapFunction($sFunction, $sArgs, $aScripts, $sReturnValueVar)
     {
@@ -890,7 +890,7 @@ 
      * @param string        $sFileName            The relative or fully qualified URI of the javascript file
      * @param string        $sType                Determines the script type. Defaults to 'text/javascript'
      *
-     * @return \Jaxon\Plugin\Response
+     * @return ResponseContract
      */
     public function includeScript($sFileName, $sType = null, $sId = null)
     {
@@ -911,7 +911,7 @@ 
      * @param string        $sFileName            The relative or fully qualified URI of the javascript file
      * @param string        $sType                Determines the script type. Defaults to 'text/javascript'
      *
-     * @return \Jaxon\Plugin\Response
+     * @return ResponseContract
      */
     public function includeScriptOnce($sFileName, $sType = null, $sId = null)
     {
@@ -934,7 +934,7 @@ 
      * @param string        $sFileName            The relative or fully qualified URI of the javascript file
      * @param string        $sUnload            Name of a javascript function to call prior to unlaoding the file
      *
-     * @return \Jaxon\Plugin\Response
+     * @return ResponseContract
      */
     public function removeScript($sFileName, $sUnload = '')
     {
@@ -955,7 +955,7 @@ 
      * @param string        $sFileName            The relative or fully qualified URI of the css file
      * @param string        $sMedia                The media type of the CSS file. Defaults to 'screen'
      *
-     * @return \Jaxon\Plugin\Response
+     * @return ResponseContract
      */
     public function includeCSS($sFileName, $sMedia = null)
     {
@@ -974,7 +974,7 @@ 
      *
      * @param string        $sFileName            The relative or fully qualified URI of the css file
      *
-     * @return \Jaxon\Plugin\Response
+     * @return ResponseContract
      */
     public function removeCSS($sFileName, $sMedia = null)
     {
@@ -999,7 +999,7 @@ 
      * @param integer        $iTimeout            The number of 1/10ths of a second to pause before timing out
      *                                             and continuing with the execution of the response commands
      *
-     * @return \Jaxon\Plugin\Response
+     * @return ResponseContract
      */
     public function waitForCSS($iTimeout = 600)
     {
@@ -1024,7 +1024,7 @@ 
      * @param integer        $tenths                The number of 1/10ths of a second to wait before timing out
      *                                             and continuing with the execution of the response commands.
      *
-     * @return \Jaxon\Plugin\Response
+     * @return ResponseContract
      */
     public function waitFor($script, $tenths)
     {
@@ -1045,7 +1045,7 @@ 
      *
      * @param integer        $tenths                The number of 1/10ths of a second to sleep
      *
-     * @return \Jaxon\Plugin\Response
+     * @return ResponseContract
      */
     public function sleep($tenths)
     {
@@ -1074,7 +1074,7 @@ 
      * @param string        $variable            The DOM element name (id or class)
      * @param string        $tag                The HTML tag of the new DOM element
      *
-     * @return \Jaxon\Plugin\Response
+     * @return ResponseContract
      */
     public function domCreateElement($variable, $tag)
     {
@@ -1094,7 +1094,7 @@ 
      * @param string        $key                The name of the attribute
      * @param string        $value                The value of the attribute
      *
-     * @return \Jaxon\Plugin\Response
+     * @return ResponseContract
      */
     public function domSetAttribute($variable, $key, $value)
     {
@@ -1115,7 +1115,7 @@ 
      * @param string        $skip                The ??
      * @param string        $remove                The ??
      *
-     * @return \Jaxon\Plugin\Response
+     * @return ResponseContract
      */
     public function domRemoveChildren($parent, $skip = null, $remove = null)
     {
@@ -1136,7 +1136,7 @@ 
      * @param string        $parent                The DOM parent element
      * @param string        $variable            The DOM element name (id or class)
      *
-     * @return \Jaxon\Plugin\Response
+     * @return ResponseContract
      */
     public function domAppendChild($parent, $variable)
     {
@@ -1155,7 +1155,7 @@ 
      * @param string        $target                The DOM target element
      * @param string        $variable            The DOM element name (id or class)
      *
-     * @return \Jaxon\Plugin\Response
+     * @return ResponseContract
      */
     public function domInsertBefore($target, $variable)
     {
@@ -1174,7 +1174,7 @@ 
      * @param string        $target                The DOM target element
      * @param string        $variable            The DOM element name (id or class)
      *
-     * @return \Jaxon\Plugin\Response
+     * @return ResponseContract
      */
     public function domInsertAfter($target, $variable)
     {
@@ -1193,7 +1193,7 @@ 
      * @param string        $parent                The DOM parent element
      * @param string        $text                The HTML text to append
      *
-     * @return \Jaxon\Plugin\Response
+     * @return ResponseContract
      */
     public function domAppendText($parent, $text)
     {
@@ -1234,7 +1234,7 @@ 
      *
      * @param mixed        $value                Any value
      *
-     * @return \Jaxon\Plugin\Response
+     * @return Response
      */
     public function setReturnValue($value)
     {

Spacing +36 added lines, -36 removed lines

@@ -96,7 +96,7 @@ 
     public function plugin($sName)
     {
         $xPlugin = $this->getPluginManager()->getResponsePlugin($sName);
-        if(!$xPlugin)
+        if (!$xPlugin)
         {
             return null;
         }
@@ -159,23 +159,23 @@ 
     public function addCommand($aAttributes, $mData)
     {
         /* merge commands if possible */
-        if(in_array($aAttributes['cmd'], ['js', 'ap']))
+        if (in_array($aAttributes['cmd'], ['js', 'ap']))
         {
-            if(($aLastCommand = array_pop($this->aCommands)))
+            if (($aLastCommand = array_pop($this->aCommands)))
             {
-                if($aLastCommand['cmd'] == $aAttributes['cmd'])
+                if ($aLastCommand['cmd'] == $aAttributes['cmd'])
                 {
-                    if($this->getOption('core.response.merge.js') &&
+                    if ($this->getOption('core.response.merge.js') &&
                             $aLastCommand['cmd'] == 'js')
                     {
-                        $mData = $aLastCommand['data'].'; '.$mData;
+                        $mData = $aLastCommand['data'] . '; ' . $mData;
                     }
-                    elseif($this->getOption('core.response.merge.ap') &&
+                    elseif ($this->getOption('core.response.merge.ap') &&
                             $aLastCommand['cmd'] == 'ap' &&
                             $aLastCommand['id'] == $aAttributes['id'] &&
                             $aLastCommand['prop'] == $aAttributes['prop'])
                     {
-                        $mData = $aLastCommand['data'].' '.$mData;
+                        $mData = $aLastCommand['data'] . ' ' . $mData;
                     }
                     else
                     {
@@ -233,26 +233,26 @@ 
     public function appendResponse(ResponseContract $mCommands, $bBefore = false)
     {
         $aCommands = [];
-        if($mCommands instanceof Response)
+        if ($mCommands instanceof Response)
         {
             $this->returnValue = $mCommands->returnValue;
             $aCommands = $mCommands->aCommands;
         }
-        elseif(is_array($mCommands))
+        elseif (is_array($mCommands))
         {
             $aCommands = $mCommands;
         }
         else
         {
-            if(!empty($mCommands))
+            if (!empty($mCommands))
             {
                 throw new \Jaxon\Exception\Error($this->trans('errors.response.data.invalid'));
             }
         }
 
-        if(count($aCommands) > 0)
+        if (count($aCommands) > 0)
         {
-            if($bBefore)
+            if ($bBefore)
             {
                 $this->aCommands = array_merge($aCommands, $this->aCommands);
             }
@@ -524,33 +524,33 @@ 
      *
      * @return \Jaxon\Plugin\Response
      */
-    public function redirect($sURL, $iDelay=0)
+    public function redirect($sURL, $iDelay = 0)
     {
         // we need to parse the query part so that the values are rawurlencode()'ed
         // can't just use parse_url() cos we could be dealing with a relative URL which
         // parse_url() can't deal with.
         $queryStart = strpos($sURL, '?', strrpos($sURL, '/'));
-        if($queryStart !== false)
+        if ($queryStart !== false)
         {
             $queryStart++;
             $queryEnd = strpos($sURL, '#', $queryStart);
-            if($queryEnd === false)
+            if ($queryEnd === false)
                 $queryEnd = strlen($sURL);
-            $queryPart = substr($sURL, $queryStart, $queryEnd-$queryStart);
+            $queryPart = substr($sURL, $queryStart, $queryEnd - $queryStart);
             parse_str($queryPart, $queryParts);
             $newQueryPart = "";
-            if($queryParts)
+            if ($queryParts)
             {
                 $first = true;
-                foreach($queryParts as $key => $value)
+                foreach ($queryParts as $key => $value)
                 {
-                    if($first)
+                    if ($first)
                         $first = false;
                     else
                         $newQueryPart .= '&';
-                    $newQueryPart .= rawurlencode($key).'='.rawurlencode($value);
+                    $newQueryPart .= rawurlencode($key) . '=' . rawurlencode($value);
                 }
-            } elseif($_SERVER['QUERY_STRING']) {
+            } elseif ($_SERVER['QUERY_STRING']) {
                     //couldn't break up the query, but there's one there
                     //possibly "http://url/page.html?query1234" type of query?
                     //just encode it and hope it works
@@ -558,8 +558,8 @@ 
                 }
             $sURL = str_replace($queryPart, $newQueryPart, $sURL);
         }
-        if($iDelay)
-            $this->script('window.setTimeout("window.location = \'' . $sURL . '\';",' . ($iDelay*1000) . ');');
+        if ($iDelay)
+            $this->script('window.setTimeout("window.location = \'' . $sURL . '\';",' . ($iDelay * 1000) . ');');
         else
             $this->script('window.location = "' . $sURL . '";');
         return $this;
@@ -896,10 +896,10 @@ 
     {
         $command = ['cmd'  =>  'in'];
 
-        if(($sType))
+        if (($sType))
             $command['type'] = trim((string)$sType, " \t");
 
-        if(($sId))
+        if (($sId))
             $command['elm_id'] = trim((string)$sId, " \t");
 
         return $this->addCommand($command, trim((string)$sFileName, " \t"));
@@ -917,10 +917,10 @@ 
     {
         $command = ['cmd' => 'ino'];
 
-        if(($sType))
+        if (($sType))
             $command['type'] = trim((string)$sType, " \t");
 
-        if(($sId))
+        if (($sId))
             $command['elm_id'] = trim((string)$sId, " \t");
 
         return $this->addCommand($command, trim((string)$sFileName, " \t"));
@@ -961,7 +961,7 @@ 
     {
         $command = ['cmd' => 'css'];
 
-        if(($sMedia))
+        if (($sMedia))
             $command['media'] = trim((string)$sMedia, " \t");
 
         return $this->addCommand($command, trim((string)$sFileName, " \t"));
@@ -980,7 +980,7 @@ 
     {
         $command = ['cmd' => 'rcss'];
 
-        if(($sMedia))
+        if (($sMedia))
             $command['media'] = trim((string)$sMedia, " \t");
 
         return $this->addCommand($command, trim((string)$sFileName, " \t"));
@@ -1121,10 +1121,10 @@ 
     {
         $command = ['cmd' => 'DRC'];
 
-        if(($skip))
+        if (($skip))
             $command['skip'] = $skip;
 
-        if(($remove))
+        if (($remove))
             $command['remove'] = $remove;
 
         return $this->addCommand($command, $parent);
@@ -1249,7 +1249,7 @@ 
      */
     public function sendHeaders()
     {
-        if($this->getRequesthandler()->requestMethodIsGet())
+        if ($this->getRequesthandler()->requestMethodIsGet())
         {
             header("Expires: Mon, 26 Jul 1997 05:00:00 GMT");
             header("Last-Modified: " . gmdate("D, d M Y H:i:s") . " GMT");
@@ -1259,7 +1259,7 @@ 
 
         $sCharacterSet = '';
         $sCharacterEncoding = trim($this->getOption('core.encoding'));
-        if(($sCharacterEncoding) && strlen($sCharacterEncoding) > 0)
+        if (($sCharacterEncoding) && strlen($sCharacterEncoding) > 0)
         {
             $sCharacterSet = '; charset="' . trim($sCharacterEncoding) . '"';
         }
@@ -1276,13 +1276,13 @@ 
     {
         $response = [];
 
-        if(($this->returnValue))
+        if (($this->returnValue))
         {
             $response['jxnrv'] = $this->returnValue;
         }
         $response['jxnobj'] = [];
 
-        foreach($this->aCommands as $xCommand)
+        foreach ($this->aCommands as $xCommand)
         {
             $response['jxnobj'][] = $xCommand;
         }

src/Utils/Template/Engine.php

Spacing +4 added lines, -4 removed lines

@@ -55,7 +55,7 @@ 
     public function addNamespace($sNamespace, $sDirectory, $sExtension = '')
     {
         // The 'jaxon' key cannot be overriden
-        if($sNamespace == 'jaxon')
+        if ($sNamespace == 'jaxon')
         {
             return;
         }
@@ -92,18 +92,18 @@ 
         // Get the namespace name
         $sNamespace = '';
         $iSeparatorPosition = strrpos($sTemplate, '::');
-        if($iSeparatorPosition !== false)
+        if ($iSeparatorPosition !== false)
         {
             $sNamespace = substr($sTemplate, 0, $iSeparatorPosition);
             $sTemplate = substr($sTemplate, $iSeparatorPosition + 2);
         }
         // The default namespace is 'jaxon'
-        if(!($sNamespace = trim($sNamespace)))
+        if (!($sNamespace = trim($sNamespace)))
         {
             $sNamespace = 'jaxon';
         }
         // Check if the namespace is defined
-        if(!key_exists($sNamespace, $this->aNamespaces))
+        if (!key_exists($sNamespace, $this->aNamespaces))
         {
             return '';
         }