PhpExt : Config [ class tree ] [ index ] [ all elements ]

Source for file AutoLoadConfigObject.php

Documentation is available at AutoLoadConfigObject.php

  1. <?php
  2. /**
  3.  * PHP-Ext Library
  4.  * http://php-ext.googlecode.com
  5.  * @author Sergei Walter <sergeiw[at]gmail[dot]com>
  6.  * @copyright 2008 Sergei Walter
  7.  * @license http://www.gnu.org/licenses/lgpl.html
  8.  * @link http://php-ext.googlecode.com
  9.  * 
  10.  *  Reference for Ext JS: http://extjs.com
  11.  * 
  12.  */
  13.  
  14. /**
  15.  * @see PhpExt_Config_ConfigObject
  16.  */
  17. include_once 'PhpExt/Config/ConfigObject.php';
  18.  
  19.  
  20. /**
  21.  * @package PhpExt
  22.  */
  23. {
  24.     const AUTO_LOAD_METHOD_GET = 'GET';
  25.     const AUTO_LOAD_METHOD_POST = 'POST';
  26.  
  27.     // Url
  28.     /**
  29.      * The URL to request.
  30.      * @param string $value 
  31.      * @return PhpExt_AutoLoadConfigObject 
  32.      */
  33.     public function setUrl($value{
  34.         $this->setExtConfigProperty("url"$value);
  35.         return $this;
  36.     }    
  37.     /**
  38.      * The URL to request or a function which returns the URL.
  39.      * @return string 
  40.      */
  41.     public function getUrl({
  42.         return $this->getExtConfigProperty("url");
  43.     }
  44.     
  45.     // Method
  46.     /**
  47.      * The HTTP method to use. Defaults to AUTO_LOAD_METHOD_POST if params are present, or AUTO_LOAD_METHOD_GET if not.
  48.      * @uses PhpExt_AutoLoadConfigObject::AUTO_LOAD_METHOD_GET
  49.      * @uses PhpExt_AutoLoadConfigObject::AUTO_LOAD_METHOD_POST
  50.      * @param boolean $value 
  51.      * @return PhpExt_AutoLoadConfigObject 
  52.      */
  53.     public function setMethod($value{
  54.         $this->setExtConfigProperty("method"$value);
  55.         return $this;
  56.     }    
  57.     /**
  58.      * The HTTP method to use. Defaults to AUTO_LOAD_METHOD_POST if params are present, or AUTO_LOAD_METHOD_GET if not.
  59.      * @uses PhpExt_AutoLoadConfigObject::AUTO_LOAD_METHOD_GET
  60.      * @uses PhpExt_AutoLoadConfigObject::AUTO_LOAD_METHOD_POST
  61.      * @return boolean 
  62.      */
  63.     public function getMethod({
  64.         return $this->getExtConfigProperty("method");
  65.     }
  66.     
  67.     // Params
  68.     /**
  69.      * The parameters to pass to the server. These may be specified as a urlencoded string, or as an array containing properties which represent parameters.
  70.      * Format:
  71.      * <code>array('param1'=>10,'param2'=>'some value')</code>
  72.      * @param array $value 
  73.      * @return PhpExt_AutoLoadConfigObject 
  74.      */
  75.     public function setParams($value{
  76.         $this->setExtConfigProperty("params"$value);
  77.         return $this;
  78.     }    
  79.     /**
  80.      * The parameters to pass to the server. These may be specified as a urlencoded string, or as an array containing properties which represent parameters.
  81.      * Format:
  82.      * <code>array('param1'=>10,'param2'=>'some value')</code>
  83.      * @return array 
  84.      */
  85.     public function getParams({
  86.         return $this->getExtConfigProperty("params");
  87.     }
  88.     
  89.     // Scripts
  90.     /**
  91.      * If true any <script> tags embedded in the response text will be extracted and executed. If this option is specified, the callback will be called after the execution of the scripts.
  92.      * @param boolean $value 
  93.      * @return PhpExt_AutoLoadConfigObject 
  94.      */
  95.     public function setScripts($value{
  96.         $this->setExtConfigProperty("scripts"$value);
  97.         return $this;
  98.     }    
  99.     /**
  100.      * If true any <script> tags embedded in the response text will be extracted and executed. If this option is specified, the callback will be called after the execution of the scripts.
  101.      * @return boolean 
  102.      */
  103.     public function getScripts({
  104.         return $this->getExtConfigProperty("scripts");
  105.     }
  106.     
  107.     // Callback
  108.     /**
  109.      * A function to be called when the response from the server arrives. The following parameters are passed:
  110.      *  - el : Ext.Element  - The Element being updated.
  111.      *  - success : Boolean - True for success, false for failure.
  112.      *  - response : XMLHttpRequest - The XMLHttpRequest which processed the update.
  113.      * options : Object - The config object passed to the update call.
  114.      * @param PhpExt_Handler $value 
  115.      * @return PhpExt_AutoLoadConfigObject 
  116.      */
  117.     public function setCallback($value{
  118.         $this->setExtConfigProperty("callback"$value);
  119.         return $this;
  120.     }    
  121.     /**
  122.      * A function to be called when the response from the server arrives. The following parameters are passed:
  123.      *  - el : Ext.Element  - The Element being updated.
  124.      *  - success : Boolean - True for success, false for failure.
  125.      *  - response : XMLHttpRequest - The XMLHttpRequest which processed the update.
  126.      * options : Object - The config object passed to the update call.
  127.      * @return PhpExt_Handler 
  128.      */
  129.     public function getCallback({
  130.         return $this->getExtConfigProperty("callback");
  131.     }
  132.     
  133.     // Scope
  134.     /**
  135.      * The scope in which to execute the callback (The callback's this reference.) If the params option is a function, this scope is used for that function also.
  136.      * @param PhpExt_JavascriptStm $value 
  137.      * @return PhpExt_AutoLoadConfigObject 
  138.      */
  139.     public function setScope($value{
  140.         $this->setExtConfigProperty("scope"$value);
  141.         return $this;
  142.     }    
  143.     /**
  144.      * The scope in which to execute the callback (The callback's this reference.) If the params option is a function, this scope is used for that function also.
  145.      * @return PhpExt_JavascriptStm 
  146.      */
  147.     public function getScope({
  148.         return $this->getExtConfigProperty("scope");
  149.     }
  150.     
  151.     // DiscardUrl
  152.     /**
  153.      * If not passed as false the URL of this request becomes the default URL for this Updater object, and will be subsequently used in refresh calls.
  154.      * @param boolean $value 
  155.      * @return PhpExt_AutoLoadConfigObject 
  156.      */
  157.     public function setDiscardUrl($value{
  158.         $this->setExtConfigProperty("discardUrl"$value);
  159.         return $this;
  160.     }    
  161.     /**
  162.      * If not passed as false the URL of this request becomes the default URL for this Updater object, and will be subsequently used in refresh calls.
  163.      * @return boolean 
  164.      */
  165.     public function getDiscardUrl({
  166.         return $this->getExtConfigProperty("discardUrl");
  167.     }
  168.     
  169.     // Timeout
  170.     /**
  171.      * The timeout to use when waiting for a response.
  172.      * @param integer $value 
  173.      * @return PhpExt_AutoLoadConfigObject 
  174.      */
  175.     public function setTimeout($value{
  176.         $this->setExtConfigProperty("timeout"$value);
  177.         return $this;
  178.     }    
  179.     /**
  180.      * The timeout to use when waiting for a response.
  181.      * @return integer 
  182.      */
  183.     public function getTimeout({
  184.         return $this->getExtConfigProperty("timeout");
  185.     }
  186.     
  187.     // NoCache
  188.     /**
  189.      * Only needed for GET requests, this option causes an extra, generated parameter to be passed to defeat caching.
  190.      * @param boolean $value 
  191.      * @return PhpExt_AutoLoadConfigObject 
  192.      */
  193.     public function setNoCache($value{
  194.         $this->setExtConfigProperty("noCache"$value);
  195.         return $this;
  196.     }    
  197.     /**
  198.      * Only needed for GET requests, this option causes an extra, generated parameter to be passed to defeat caching.
  199.      * @return boolean 
  200.      */
  201.     public function getNoCache({
  202.         return $this->getExtConfigProperty("noCache");
  203.     }
  204.     
  205.     // Text
  206.     /**
  207.      * The loading text displayed during request.
  208.      * @param string $value 
  209.      * @return PhpExt_AutoLoadConfigObject 
  210.      */
  211.     public function setText($value{
  212.         $this->setExtConfigProperty("text"$value);
  213.         return $this;
  214.     }    
  215.     /**
  216.      * The loading text displayed during request.
  217.      * @return string 
  218.      */
  219.     public function getText({
  220.         return $this->getExtConfigProperty("text");
  221.     }        
  222.     
  223.     /**
  224.      * @param string $url The URL to request.
  225.      * @param array $params The parameters to pass to the server. These may be specified as a urlencoded string, or as an array containing properties which represent parameters.
  226.      * @param boolean $scripts If true any <script> tags embedded in the response text will be extracted and executed. If this option is specified, the callback will be called after the execution of the scripts.
  227.      * @param string $method The HTTP method to use. Defaults to AUTO_LOAD_METHOD_POST if params are present, or AUTO_LOAD_METHOD_GET if not.
  228.      */
  229.     public function __construct($url$params array()$scripts null$method null{
  230.         parent::__construct();
  231.  
  232.         $validProps array(
  233.             "url",
  234.             "method",
  235.             "params",
  236.             "scripts",
  237.             "callback",
  238.             "scope",
  239.             "discardUrl",
  240.             "timeout",
  241.             "noCache",
  242.             "text"
  243.         );
  244.         $this->addValidConfigProperties($validProps);
  245.         
  246.         $this->setUrl($url);
  247.         if (count($params0)
  248.             $this->setParams($params);
  249.         if ($scripts !== null)
  250.             $this->setScripts($scripts);
  251.         if ($method !== null)
  252.             $this->setMethod($method);
  253.     }        
  254.      
  255.     
  256. }

Documentation generated on Fri, 08 Aug 2008 15:50:07 -0500 by phpDocumentor 1.4.0