jaxon-php / jaxon-core

src/Response/Response.php

Doc Comments +49 added lines, -49 removed lines

@@ -159,7 +159,7 @@ 
      * @param array         $aAttributes        Associative array of attributes that will describe the command
      * @param mixed            $mData                The data to be associated with this command
      *
-     * @return \Jaxon\Plugin\Response
+     * @return Response
      */
     public function addCommand($aAttributes, $mData)
     {
@@ -200,7 +200,7 @@ 
     /**
      * Clear all the commands already added to the response
      *
-     * @return \Jaxon\Plugin\Response
+     * @return Response
      */
     public function clearCommands()
     {
@@ -214,9 +214,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 Response
      */
     public function addPluginCommand($xPlugin, $aAttributes, $mData)
     {
@@ -277,7 +277,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 Response
      */
     public function confirmCommands($iCmdNumber, $sMessage)
     {
@@ -297,7 +297,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 Response
      */
     public function assign($sTarget, $sAttribute, $sData)
     {
@@ -319,7 +319,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 Response
      */
     public function html($sTarget, $sData)
     {
@@ -333,7 +333,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 Response
      */
     public function append($sTarget, $sAttribute, $sData)
     {    
@@ -354,7 +354,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 Response
      */
     public function prepend($sTarget, $sAttribute, $sData)
     {
@@ -376,7 +376,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 Response
      */
     public function replace($sTarget, $sAttribute, $sSearch, $sData)
     {
@@ -399,7 +399,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 Response
      */
     public function clear($sTarget, $sAttribute)
     {
@@ -415,7 +415,7 @@ 
      * @param string        $sAttribute            The attribute to be updated
      * @param string        $sData                The value to assign
      *
-     * @return \Jaxon\Plugin\Response
+     * @return Response
      */
     public function contextAssign($sAttribute, $sData)
     {
@@ -437,7 +437,7 @@ 
      * @param string        $sAttribute            The attribute to be appended to
      * @param string        $sData                The value to append
      *
-     * @return \Jaxon\Plugin\Response
+     * @return Response
      */
     public function contextAppend($sAttribute, $sData)
     {
@@ -459,7 +459,7 @@ 
      * @param string        $sAttribute            The attribute to be updated
      * @param string        $sData                The value to be prepended
      *
-     * @return \Jaxon\Plugin\Response
+     * @return Response
      */
     public function contextPrepend($sAttribute, $sData)
     {
@@ -480,7 +480,7 @@ 
      *
      * @param string        $sAttribute            The attribute to be cleared
      *
-     * @return \Jaxon\Plugin\Response
+     * @return Response
      */
     public function contextClear($sAttribute)
     {
@@ -492,7 +492,7 @@ 
      *
      * @param string        $sMessage            The message to be displayed
      *
-     * @return \Jaxon\Plugin\Response
+     * @return Response
      */
     public function alert($sMessage)
     {
@@ -509,7 +509,7 @@ 
      *
      * @param string        $sMessage            The message to be displayed
      *
-     * @return \Jaxon\Plugin\Response
+     * @return Response
      */
     public function debug($sMessage)
     {
@@ -527,7 +527,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)
     {
@@ -580,7 +580,7 @@ 
      *
      * @param string        $sJS                The script to execute
      *
-     * @return \Jaxon\Plugin\Response
+     * @return Response
      */
     public function script($sJS)
     {
@@ -597,7 +597,7 @@ 
      *
      * @param string        $sFunc                The name of the function to call
      *
-     * @return \Jaxon\Plugin\Response
+     * @return Response
      */
     public function call($sFunc)
     {
@@ -617,7 +617,7 @@ 
      *
      * @param string        $sTarget            The id of the element to be removed
      *
-     * @return \Jaxon\Plugin\Response
+     * @return Response
      */
     public function remove($sTarget)
     {
@@ -637,7 +637,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 Response
      */
     public function create($sParent, $sTag, $sId)
     {
@@ -658,7 +658,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 Response
      */
     public function insert($sBefore, $sTag, $sId)
     {
@@ -679,7 +679,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 Response
      */
     public function insertAfter($sAfter, $sTag, $sId)
     {
@@ -701,7 +701,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 Response
      */
     public function createInput($sParent, $sType, $sName, $sId)
     {
@@ -724,7 +724,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 Response
      */
     public function insertInput($sBefore, $sType, $sName, $sId)
     {
@@ -747,7 +747,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 Response
      */
     public function insertInputAfter($sAfter, $sType, $sName, $sId)
     {
@@ -769,7 +769,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 Response
      */
     public function setEvent($sTarget, $sEvent, $sScript)
     {
@@ -789,7 +789,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 Response
      */
     public function onClick($sTarget, $sScript)
     {
@@ -805,7 +805,7 @@ 
      * @param string        $sEvent                The name of the event
      * @param string        $sHandler            The javascript function to call when the event is fired
      *
-     * @return \Jaxon\Plugin\Response
+     * @return Response
      */
     public function addHandler($sTarget, $sEvent, $sHandler)
     {
@@ -826,7 +826,7 @@ 
      * @param string        $sEvent                The name of the event
      * @param string        $sHandler            The javascript function called when the event is fired
      *
-     * @return \Jaxon\Plugin\Response
+     * @return Response
      */
     public function removeHandler($sTarget, $sEvent, $sHandler)
     {
@@ -847,7 +847,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 Response
      */
     public function setFunction($sFunction, $sArgs, $sScript)
     {
@@ -874,7 +874,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 Response
      */
     public function wrapFunction($sFunction, $sArgs, $aScripts, $sReturnValueVar)
     {
@@ -895,7 +895,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 Response
      */
     public function includeScript($sFileName, $sType = null, $sId = null)
     {
@@ -916,7 +916,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 Response
      */
     public function includeScriptOnce($sFileName, $sType = null, $sId = null)
     {
@@ -939,7 +939,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 Response
      */
     public function removeScript($sFileName, $sUnload = '')
     {
@@ -960,7 +960,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 Response
      */
     public function includeCSS($sFileName, $sMedia = null)
     {
@@ -979,7 +979,7 @@ 
      *
      * @param string        $sFileName            The relative or fully qualified URI of the css file
      *
-     * @return \Jaxon\Plugin\Response
+     * @return Response
      */
     public function removeCSS($sFileName, $sMedia = null)
     {
@@ -1004,7 +1004,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 Response
      */
     public function waitForCSS($iTimeout = 600)
     {
@@ -1029,7 +1029,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 Response
      */
     public function waitFor($script, $tenths)
     {
@@ -1050,7 +1050,7 @@ 
      *
      * @param integer        $tenths                The number of 1/10ths of a second to sleep
      *
-     * @return \Jaxon\Plugin\Response
+     * @return Response
      */
     public function sleep($tenths)
     {
@@ -1079,7 +1079,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 Response
      */
     public function domCreateElement($variable, $tag)
     {
@@ -1099,7 +1099,7 @@ 
      * @param string        $key                The name of the attribute
      * @param string        $value                The value of the attribute
      *
-     * @return \Jaxon\Plugin\Response
+     * @return Response
      */
     public function domSetAttribute($variable, $key, $value)
     {
@@ -1120,7 +1120,7 @@ 
      * @param string        $skip                The ??
      * @param string        $remove                The ??
      *
-     * @return \Jaxon\Plugin\Response
+     * @return Response
      */
     public function domRemoveChildren($parent, $skip = null, $remove = null)
     {
@@ -1141,7 +1141,7 @@ 
      * @param string        $parent                The DOM parent element
      * @param string        $variable            The DOM element name (id or class)
      *
-     * @return \Jaxon\Plugin\Response
+     * @return Response
      */
     public function domAppendChild($parent, $variable)
     {
@@ -1160,7 +1160,7 @@ 
      * @param string        $target                The DOM target element
      * @param string        $variable            The DOM element name (id or class)
      *
-     * @return \Jaxon\Plugin\Response
+     * @return Response
      */
     public function domInsertBefore($target, $variable)
     {
@@ -1179,7 +1179,7 @@ 
      * @param string        $target                The DOM target element
      * @param string        $variable            The DOM element name (id or class)
      *
-     * @return \Jaxon\Plugin\Response
+     * @return Response
      */
     public function domInsertAfter($target, $variable)
     {
@@ -1198,7 +1198,7 @@ 
      * @param string        $parent                The DOM parent element
      * @param string        $text                The HTML text to append
      *
-     * @return \Jaxon\Plugin\Response
+     * @return Response
      */
     public function domAppendText($parent, $text)
     {
@@ -1239,7 +1239,7 @@ 
      *
      * @param mixed        $value                Any value
      *
-     * @return \Jaxon\Plugin\Response
+     * @return Response
      */
     public function setReturnValue($value)
     {

Spacing +40 added lines, -40 removed lines

@@ -101,7 +101,7 @@ 
     public function plugin($sName)
     {
         $xPlugin = $this->getPluginManager()->getResponsePlugin($sName);
-        if(!$xPlugin)
+        if (!$xPlugin)
         {
             return null;
         }
@@ -164,21 +164,21 @@ 
     public function addCommand($aAttributes, $mData)
     {
         /* merge commands if possible */
-        if(in_array($aAttributes['cmd'], array('js', 'ap')))
+        if (in_array($aAttributes['cmd'], array('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($aLastCommand['cmd'] == 'js') 
+                    if ($aLastCommand['cmd'] == 'js') 
                     {
-                        $mData = $aLastCommand['data'].'; '.$mData;
+                        $mData = $aLastCommand['data'] . '; ' . $mData;
                     } 
-                    else if($aLastCommand['cmd'] == 'ap' &&
+                    else if ($aLastCommand['cmd'] == 'ap' &&
                             $aLastCommand['id'] == $aAttributes['id'] &&
                             $aLastCommand['prop'] == $aAttributes['prop'])
                     {
-                        $mData = $aLastCommand['data'].' '.$mData;
+                        $mData = $aLastCommand['data'] . ' ' . $mData;
                     }
                     else
                     {
@@ -235,11 +235,11 @@ 
      */
     public function appendResponse($mCommands, $bBefore = false)
     {
-        if( $mCommands instanceof Response )
+        if ($mCommands instanceof Response)
         {
             $this->returnValue = $mCommands->returnValue;
             
-            if($bBefore)
+            if ($bBefore)
             {
                 $this->aCommands = array_merge($mCommands->aCommands, $this->aCommands);
             }
@@ -248,9 +248,9 @@ 
                 $this->aCommands = array_merge($this->aCommands, $mCommands->aCommands);
             }
         }
-        else if(is_array($mCommands))
+        else if (is_array($mCommands))
         {
-            if($bBefore)
+            if ($bBefore)
             {
                 $this->aCommands = array_merge($mCommands, $this->aCommands);
             }
@@ -261,7 +261,7 @@ 
         }
         else
         {
-            if(!empty($mCommands))
+            if (!empty($mCommands))
             {
                 throw new \Jaxon\Exception\Error($this->trans('errors.response.data.invalid'));
             }
@@ -529,33 +529,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);
                 }
-            } else if($_SERVER['QUERY_STRING']) {
+            } else if ($_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
@@ -563,8 +563,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;
@@ -901,10 +901,10 @@ 
     {
         $command = array('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"));
@@ -922,10 +922,10 @@ 
     {
         $command = array('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"));
@@ -966,7 +966,7 @@ 
     {
         $command = array('cmd' => 'css');
         
-        if(($sMedia))
+        if (($sMedia))
             $command['media'] = trim((string)$sMedia, " \t");
         
         return $this->addCommand($command, trim((string)$sFileName, " \t"));
@@ -985,7 +985,7 @@ 
     {
         $command = array('cmd' => 'rcss');
         
-        if(($sMedia))
+        if (($sMedia))
             $command['media'] = trim((string)$sMedia, " \t");
         
         return $this->addCommand($command, trim((string)$sFileName, " \t"));
@@ -1126,10 +1126,10 @@ 
     {
         $command = array('cmd' => 'DRC');
 
-        if(($skip))
+        if (($skip))
             $command['skip'] = $skip;
 
-        if(($remove))
+        if (($remove))
             $command['remove'] = $remove;
 
         return $this->addCommand($command, $parent);
@@ -1255,17 +1255,17 @@ 
     public function sendHeaders()
     {
         $xRequestManager = $this->getRequestManager();
-        if($xRequestManager->getRequestMethod() == Jaxon::METHOD_GET)
+        if ($xRequestManager->getRequestMethod() == Jaxon::METHOD_GET)
         {
-            header ("Expires: Mon, 26 Jul 1997 05:00:00 GMT");
-            header ("Last-Modified: " . gmdate("D, d M Y H:i:s") . " GMT");
-            header ("Cache-Control: no-cache, must-revalidate");
-            header ("Pragma: no-cache");
+            header("Expires: Mon, 26 Jul 1997 05:00:00 GMT");
+            header("Last-Modified: " . gmdate("D, d M Y H:i:s") . " GMT");
+            header("Cache-Control: no-cache, must-revalidate");
+            header("Pragma: no-cache");
         }
         
         $sCharacterSet = '';
         $sCharacterEncoding = trim($this->getOption('core.encoding'));
-        if(($sCharacterEncoding) && strlen($sCharacterEncoding) > 0)
+        if (($sCharacterEncoding) && strlen($sCharacterEncoding) > 0)
         {
             $sCharacterSet = '; charset="' . trim($sCharacterEncoding) . '"';
         }
@@ -1282,13 +1282,13 @@ 
     {
         $response = array();
         
-        if(($this->returnValue))
+        if (($this->returnValue))
         {
             $response['jxnrv'] = $this->returnValue;
         }
         $response['jxnobj'] = array();
 
-        foreach($this->aCommands as $xCommand)
+        foreach ($this->aCommands as $xCommand)
         {
             $response['jxnobj'][] = $xCommand;
         }