Development

Changeset 19411

You must first sign up to be able to contribute.

Changeset 19411

Show
Ignore:
Timestamp:
06/20/09 13:54:04 (4 years ago)
Author:
fabien
Message:

[1.2, 1.3] fixed PHPDoc return values (closes #6667)

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • branches/1.2/lib/test/sfTestFunctional.class.php

    r14485 r19411  
    4242   * @param  mixed  $position    The position in the action stack (default to the last entry) 
    4343   * 
    44    * @return sfTestBrowser The current sfTestBrowser instance 
     44   * @return sfTestFunctional The current sfTestFunctional instance 
    4545   */ 
    4646  public function isForwardedTo($moduleName, $actionName, $position = 'last') 
    …… 
    7474   * @param  boolean $with_layout  If have or not layout 
    7575   * 
    76    * @return sfTestBrowser The current sfTestBrowser instance 
     76   * @return sfTestFunctional The current sfTestFunctional instance 
    7777   */ 
    7878  public function isCached($boolean, $with_layout = false) 
    …… 
    9090   * @param  boolean $with_layout  If have or not layout 
    9191   * 
    92    * @return sfTestBrowser The current sfTestBrowser instance 
     92   * @return sfTestFunctional The current sfTestFunctional instance 
    9393   */ 
    9494  public function isUriCached($uri, $boolean, $with_layout = false) 

  • branches/1.2/lib/test/sfTestFunctionalBase.class.php

    r16170 r19411  
    177177   * @param bool   $changeStack  Change the browser history stack? 
    178178   * 
    179    * @return sfBrowser 
     179   * @return sfTestFunctionalBase 
    180180   */ 
    181181  public function get($uri, $parameters = array(), $changeStack = true) 
    …… 
    192192   * @param  string $code    The expected return status code 
    193193   * 
    194    * @return sfTestBrowser The current sfTestBrowser instance 
     194   * @return sfTestFunctionalBase The current sfTestFunctionalBase instance 
    195195   */ 
    196196  public function getAndCheck($module, $action, $url = null, $code = 200) 
    …… 
    213213   * @param bool   $changeStack  Change the browser history stack? 
    214214   * 
    215    * @return sfBrowser 
     215   * @return sfTestFunctionalBase 
    216216   */ 
    217217  public function post($uri, $parameters = array(), $changeStack = true) 
    …… 
    228228   * @param  bool   $changeStack  If set to false ActionStack is not changed 
    229229   * 
    230    * @return sfTestBrowser The current sfTestBrowser instance 
     230   * @return sfTestFunctionalBase The current sfTestFunctionalBase instance 
    231231   */ 
    232232  public function call($uri, $method = 'get', $parameters = array(), $changeStack = true) 
    …… 
    253253   * @param string  $name       The checkbox or radiobutton id, name or text 
    254254   * 
    255    * @return sfBrowser 
     255   * @return sfTestFunctionalBase 
    256256   */ 
    257257  public function deselect($name) 
    …… 
    267267   * @param string  $name       The checkbox or radiobutton id, name or text 
    268268   * 
    269    * @return sfBrowser 
     269   * @return sfTestFunctionalBase 
    270270   */ 
    271271  public function select($name) 
    …… 
    283283   * @param array   $options    An array of options 
    284284   * 
    285    * @return sfBrowser 
     285   * @return sfTestFunctionalBase 
    286286   */ 
    287287  public function click($name, $arguments = array(), $options = array()) 
    …… 
    295295   * Simulates the browser back button. 
    296296   * 
    297    * @return sfTestBrowser The current sfTestBrowser instance 
     297   * @return sfTestFunctionalBase The current sfTestFunctionalBase instance 
    298298   */ 
    299299  public function back() 
    …… 
    309309   * Simulates the browser forward button. 
    310310   * 
    311    * @return sfTestBrowser The current sfTestBrowser instance 
     311   * @return sfTestFunctionalBase The current sfTestFunctionalBase instance 
    312312   */ 
    313313  public function forward() 
    …… 
    325325   * @param string $message A message 
    326326   * 
    327    * @return sfTestBrowser The current sfTestBrowser instance 
     327   * @return sfTestFunctionalBase The current sfTestFunctionalBase instance 
    328328   */ 
    329329  public function info($message) 
    …… 
    341341   * @param  bool $boolean  Flag for redirection mode 
    342342   * 
    343    * @return sfTestBrowser The current sfTestBrowser instance 
     343   * @return sfTestFunctionalBase The current sfTestFunctionalBase instance 
    344344   */ 
    345345  public function isRedirected($boolean = true) 
    …… 
    354354   * @param  string $text  Text in the response 
    355355   * 
    356    * @return sfTestBrowser The current sfTestBrowser instance 
     356   * @return sfTestFunctionalBase The current sfTestFunctionalBase instance 
    357357   */ 
    358358  public function check($uri, $text = null) 
    …… 
    375375   * @param string Status code to check, default 200 
    376376   * 
    377    * @return sfTestBrowser The current sfTestBrowser instance 
     377   * @return sfTestFunctionalBase The current sfTestFunctionalBase instance 
    378378   */ 
    379379  public function isStatusCode($statusCode = 200) 
    …… 
    389389   * @param string Text to check 
    390390   * 
    391    * @return sfTestBrowser The current sfTestBrowser instance 
     391   * @return sfTestFunctionalBase The current sfTestFunctionalBase instance 
    392392   */ 
    393393  public function responseContains($text) 
    …… 
    404404   * @param string $value 
    405405   * 
    406    * @return sfTestBrowser The current sfTestBrowser instance 
     406   * @return sfTestFunctionalBase The current sfTestFunctionalBase instance 
    407407   */ 
    408408  public function isRequestParameter($key, $value) 
    …… 
    419419   * @param  string $value 
    420420   * 
    421    * @return sfTestBrowser The current sfTestBrowser instance 
     421   * @return sfTestFunctionalBase The current sfTestFunctionalBase instance 
    422422   */ 
    423423  public function isResponseHeader($key, $value) 
    …… 
    433433   * @param  string $culture  The user culture 
    434434   * 
    435    * @return sfTestBrowser The current sfTestBrowser instance 
     435   * @return sfTestFunctionalBase The current sfTestFunctionalBase instance 
    436436   */ 
    437437  public function isUserCulture($culture) 
    …… 
    447447   * @param  string $format  The request format 
    448448   * 
    449    * @return sfTestBrowser The current sfTestBrowser instance 
     449   * @return sfTestFunctionalBase The current sfTestFunctionalBase instance 
    450450   */ 
    451451  public function isRequestFormat($format) 
    …… 
    463463   * @param  array  $options   Options for the current test 
    464464   * 
    465    * @return sfTestBrowser The current sfTestBrowser instance 
     465   * @return sfTestFunctionalBase The current sfTestFunctionalBase instance 
    466466   */ 
    467467  public function checkResponseElement($selector, $value = true, $options = array()) 
    …… 
    476476   * @param  string $message  Message name 
    477477   * 
    478    * @return sfTestBrowser The current sfTestBrowser instance 
     478   * @return sfTestFunctionalBase The current sfTestFunctionalBase instance 
    479479   */ 
    480480  public function throwsException($class = null, $message = null) 

  • branches/1.2/lib/util/sfBrowserBase.class.php

    r18669 r19411  
    8383   * @param mixed  $value  The value 
    8484   * 
    85    * @return sfBrowser 
     85   * @return sfBrowserBase 
    8686   */ 
    8787  public function setVar($name, $value) 
    …… 
    116116   * @param  bool    $httpOnly If uses only HTTP 
    117117   *  
    118    * @return sfBrowser         This sfBrowser instance 
     118   * @return sfBrowserBase     This sfBrowserBase instance 
    119119   */ 
    120120  public function setCookie($name, $value, $expire = null, $path = '/', $domain = '', $secure = false, $httpOnly = false) 
    …… 
    136136   * Removes a cookie by name. 
    137137   * 
    138    * @param string $name The cookie name 
    139    * 
    140    * @return sfBrowser    This sfBrowser instance 
     138   * @param string $name   The cookie name 
     139   * 
     140   * @return sfBrowserBase This sfBrowserBase instance 
    141141   */ 
    142142  public function removeCookie($name) 
    …… 
    150150   * Clears all cookies. 
    151151   * 
    152    * @return sfBrowser    This sfBrowser instance 
     152   * @return sfBrowserBase This sfBrowserBase instance 
    153153   */ 
    154154  public function clearCookies() 
    …… 
    165165   * @param string $password  The password 
    166166   * 
    167    * @return sfBrowser 
     167   * @return sfBrowserBase 
    168168   */ 
    169169  public function setAuth($username, $password) 
    …… 
    182182   * @param bool   $changeStack  Change the browser history stack? 
    183183   * 
    184    * @return sfBrowser 
     184   * @return sfBrowserBase 
    185185   */ 
    186186  public function get($uri, $parameters = array(), $changeStack = true) 
    …… 
    196196   * @param bool   $changeStack  Change the browser history stack? 
    197197   * 
    198    * @return sfBrowser 
     198   * @return sfBrowserBase 
    199199   */ 
    200200  public function post($uri, $parameters = array(), $changeStack = true) 
    …… 
    211211   * @param bool   $changeStack  Change the browser history stack? 
    212212   * 
    213    * @return sfBrowser 
     213   * @return sfBrowserBase 
    214214   */ 
    215215  public function call($uri, $method = 'get', $parameters = array(), $changeStack = true) 
    …… 
    380380   * Go back in the browser history stack. 
    381381   * 
    382    * @return sfBrowser 
     382   * @return sfBrowserBase 
    383383   */ 
    384384  public function back() 
    …… 
    396396   * Go forward in the browser history stack. 
    397397   * 
    398    * @return sfBrowser 
     398   * @return sfBrowserBase 
    399399   */ 
    400400  public function forward() 
    …… 
    412412   * Reload the current browser. 
    413413   * 
    414    * @return sfBrowser 
     414   * @return sfBrowserBase 
    415415   */ 
    416416  public function reload() 
    …… 
    518518   * @throws sfException If request was not a redirect 
    519519   * 
    520    * @return sfBrowser 
     520   * @return sfBrowserBase 
    521521   */ 
    522522  public function followRedirect() 
    …… 
    536536   * @param string $value  The field value 
    537537   * 
    538    * @return sfBrowser 
     538   * @return sfBrowserBase 
    539539   */ 
    540540  public function setField($name, $value) 
    …… 
    551551   * @param string  $name       The checkbox or radiobutton id, name or text 
    552552   * 
    553    * @return sfBrowser 
     553   * @return sfBrowserBase 
    554554   * 
    555555   * @see    doSelect() 
    …… 
    567567   * @param string  $name       The checkbox or radiobutton id, name or text 
    568568   * 
    569    * @return sfBrowser 
     569   * @return sfBrowserBase 
    570570   * 
    571571   * @see    doSelect() 
    …… 
    635635   * @param array   $options    An array of options 
    636636   * 
    637    * @return sfBrowser 
     637   * @return sfBrowserBase 
    638638   * 
    639639   * @see    doClick() 
    …… 
    866866   * Reset browser to original state 
    867867   * 
    868    * @return sfBrowser 
     868   * @return sfBrowserBase 
    869869   */ 
    870870  public function restart() 

  • branches/1.3/lib/test/sfTestFunctional.class.php

    r14485 r19411  
    4242   * @param  mixed  $position    The position in the action stack (default to the last entry) 
    4343   * 
    44    * @return sfTestBrowser The current sfTestBrowser instance 
     44   * @return sfTestFunctional The current sfTestFunctional instance 
    4545   */ 
    4646  public function isForwardedTo($moduleName, $actionName, $position = 'last') 
    …… 
    7474   * @param  boolean $with_layout  If have or not layout 
    7575   * 
    76    * @return sfTestBrowser The current sfTestBrowser instance 
     76   * @return sfTestFunctional The current sfTestFunctional instance 
    7777   */ 
    7878  public function isCached($boolean, $with_layout = false) 
    …… 
    9090   * @param  boolean $with_layout  If have or not layout 
    9191   * 
    92    * @return sfTestBrowser The current sfTestBrowser instance 
     92   * @return sfTestFunctional The current sfTestFunctional instance 
    9393   */ 
    9494  public function isUriCached($uri, $boolean, $with_layout = false) 

  • branches/1.3/lib/test/sfTestFunctionalBase.class.php

    r16170 r19411  
    177177   * @param bool   $changeStack  Change the browser history stack? 
    178178   * 
    179    * @return sfBrowser 
     179   * @return sfTestFunctionalBase 
    180180   */ 
    181181  public function get($uri, $parameters = array(), $changeStack = true) 
    …… 
    192192   * @param  string $code    The expected return status code 
    193193   * 
    194    * @return sfTestBrowser The current sfTestBrowser instance 
     194   * @return sfTestFunctionalBase The current sfTestFunctionalBase instance 
    195195   */ 
    196196  public function getAndCheck($module, $action, $url = null, $code = 200) 
    …… 
    213213   * @param bool   $changeStack  Change the browser history stack? 
    214214   * 
    215    * @return sfBrowser 
     215   * @return sfTestFunctionalBase 
    216216   */ 
    217217  public function post($uri, $parameters = array(), $changeStack = true) 
    …… 
    228228   * @param  bool   $changeStack  If set to false ActionStack is not changed 
    229229   * 
    230    * @return sfTestBrowser The current sfTestBrowser instance 
     230   * @return sfTestFunctionalBase The current sfTestFunctionalBase instance 
    231231   */ 
    232232  public function call($uri, $method = 'get', $parameters = array(), $changeStack = true) 
    …… 
    253253   * @param string  $name       The checkbox or radiobutton id, name or text 
    254254   * 
    255    * @return sfBrowser 
     255   * @return sfTestFunctionalBase 
    256256   */ 
    257257  public function deselect($name) 
    …… 
    267267   * @param string  $name       The checkbox or radiobutton id, name or text 
    268268   * 
    269    * @return sfBrowser 
     269   * @return sfTestFunctionalBase 
    270270   */ 
    271271  public function select($name) 
    …… 
    283283   * @param array   $options    An array of options 
    284284   * 
    285    * @return sfBrowser 
     285   * @return sfTestFunctionalBase 
    286286   */ 
    287287  public function click($name, $arguments = array(), $options = array()) 
    …… 
    295295   * Simulates the browser back button. 
    296296   * 
    297    * @return sfTestBrowser The current sfTestBrowser instance 
     297   * @return sfTestFunctionalBase The current sfTestFunctionalBase instance 
    298298   */ 
    299299  public function back() 
    …… 
    309309   * Simulates the browser forward button. 
    310310   * 
    311    * @return sfTestBrowser The current sfTestBrowser instance 
     311   * @return sfTestFunctionalBase The current sfTestFunctionalBase instance 
    312312   */ 
    313313  public function forward() 
    …… 
    325325   * @param string $message A message 
    326326   * 
    327    * @return sfTestBrowser The current sfTestBrowser instance 
     327   * @return sfTestFunctionalBase The current sfTestFunctionalBase instance 
    328328   */ 
    329329  public function info($message) 
    …… 
    341341   * @param  bool $boolean  Flag for redirection mode 
    342342   * 
    343    * @return sfTestBrowser The current sfTestBrowser instance 
     343   * @return sfTestFunctionalBase The current sfTestFunctionalBase instance 
    344344   */ 
    345345  public function isRedirected($boolean = true) 
    …… 
    354354   * @param  string $text  Text in the response 
    355355   * 
    356    * @return sfTestBrowser The current sfTestBrowser instance 
     356   * @return sfTestFunctionalBase The current sfTestFunctionalBase instance 
    357357   */ 
    358358  public function check($uri, $text = null) 
    …… 
    375375   * @param string Status code to check, default 200 
    376376   * 
    377    * @return sfTestBrowser The current sfTestBrowser instance 
     377   * @return sfTestFunctionalBase The current sfTestFunctionalBase instance 
    378378   */ 
    379379  public function isStatusCode($statusCode = 200) 
    …… 
    389389   * @param string Text to check 
    390390   * 
    391    * @return sfTestBrowser The current sfTestBrowser instance 
     391   * @return sfTestFunctionalBase The current sfTestFunctionalBase instance 
    392392   */ 
    393393  public function responseContains($text) 
    …… 
    404404   * @param string $value 
    405405   * 
    406    * @return sfTestBrowser The current sfTestBrowser instance 
     406   * @return sfTestFunctionalBase The current sfTestFunctionalBase instance 
    407407   */ 
    408408  public function isRequestParameter($key, $value) 
    …… 
    419419   * @param  string $value 
    420420   * 
    421    * @return sfTestBrowser The current sfTestBrowser instance 
     421   * @return sfTestFunctionalBase The current sfTestFunctionalBase instance 
    422422   */ 
    423423  public function isResponseHeader($key, $value) 
    …… 
    433433   * @param  string $culture  The user culture 
    434434   * 
    435    * @return sfTestBrowser The current sfTestBrowser instance 
     435   * @return sfTestFunctionalBase The current sfTestFunctionalBase instance 
    436436   */ 
    437437  public function isUserCulture($culture) 
    …… 
    447447   * @param  string $format  The request format 
    448448   * 
    449    * @return sfTestBrowser The current sfTestBrowser instance 
     449   * @return sfTestFunctionalBase The current sfTestFunctionalBase instance 
    450450   */ 
    451451  public function isRequestFormat($format) 
    …… 
    463463   * @param  array  $options   Options for the current test 
    464464   * 
    465    * @return sfTestBrowser The current sfTestBrowser instance 
     465   * @return sfTestFunctionalBase The current sfTestFunctionalBase instance 
    466466   */ 
    467467  public function checkResponseElement($selector, $value = true, $options = array()) 
    …… 
    476476   * @param  string $message  Message name 
    477477   * 
    478    * @return sfTestBrowser The current sfTestBrowser instance 
     478   * @return sfTestFunctionalBase The current sfTestFunctionalBase instance 
    479479   */ 
    480480  public function throwsException($class = null, $message = null) 

  • branches/1.3/lib/util/sfBrowserBase.class.php

    r18669 r19411  
    8383   * @param mixed  $value  The value 
    8484   * 
    85    * @return sfBrowser 
     85   * @return sfBrowserBase 
    8686   */ 
    8787  public function setVar($name, $value) 
    …… 
    116116   * @param  bool    $httpOnly If uses only HTTP 
    117117   *  
    118    * @return sfBrowser         This sfBrowser instance 
     118   * @return sfBrowserBase     This sfBrowserBase instance 
    119119   */ 
    120120  public function setCookie($name, $value, $expire = null, $path = '/', $domain = '', $secure = false, $httpOnly = false) 
    …… 
    136136   * Removes a cookie by name. 
    137137   * 
    138    * @param string $name The cookie name 
    139    * 
    140    * @return sfBrowser    This sfBrowser instance 
     138   * @param string $name   The cookie name 
     139   * 
     140   * @return sfBrowserBase This sfBrowserBase instance 
    141141   */ 
    142142  public function removeCookie($name) 
    …… 
    150150   * Clears all cookies. 
    151151   * 
    152    * @return sfBrowser    This sfBrowser instance 
     152   * @return sfBrowserBase This sfBrowserBase instance 
    153153   */ 
    154154  public function clearCookies() 
    …… 
    165165   * @param string $password  The password 
    166166   * 
    167    * @return sfBrowser 
     167   * @return sfBrowserBase 
    168168   */ 
    169169  public function setAuth($username, $password) 
    …… 
    182182   * @param bool   $changeStack  Change the browser history stack? 
    183183   * 
    184    * @return sfBrowser 
     184   * @return sfBrowserBase 
    185185   */ 
    186186  public function get($uri, $parameters = array(), $changeStack = true) 
    …… 
    196196   * @param bool   $changeStack  Change the browser history stack? 
    197197   * 
    198    * @return sfBrowser 
     198   * @return sfBrowserBase 
    199199   */ 
    200200  public function post($uri, $parameters = array(), $changeStack = true) 
    …… 
    211211   * @param bool   $changeStack  Change the browser history stack? 
    212212   * 
    213    * @return sfBrowser 
     213   * @return sfBrowserBase 
    214214   */ 
    215215  public function call($uri, $method = 'get', $parameters = array(), $changeStack = true) 
    …… 
    380380   * Go back in the browser history stack. 
    381381   * 
    382    * @return sfBrowser 
     382   * @return sfBrowserBase 
    383383   */ 
    384384  public function back() 
    …… 
    396396   * Go forward in the browser history stack. 
    397397   * 
    398    * @return sfBrowser 
     398   * @return sfBrowserBase 
    399399   */ 
    400400  public function forward() 
    …… 
    412412   * Reload the current browser. 
    413413   * 
    414    * @return sfBrowser 
     414   * @return sfBrowserBase 
    415415   */ 
    416416  public function reload() 
    …… 
    518518   * @throws sfException If request was not a redirect 
    519519   * 
    520    * @return sfBrowser 
     520   * @return sfBrowserBase 
    521521   */ 
    522522  public function followRedirect() 
    …… 
    536536   * @param string $value  The field value 
    537537   * 
    538    * @return sfBrowser 
     538   * @return sfBrowserBase 
    539539   */ 
    540540  public function setField($name, $value) 
    …… 
    551551   * @param string  $name       The checkbox or radiobutton id, name or text 
    552552   * 
    553    * @return sfBrowser 
     553   * @return sfBrowserBase 
    554554   * 
    555555   * @see    doSelect() 
    …… 
    567567   * @param string  $name       The checkbox or radiobutton id, name or text 
    568568   * 
    569    * @return sfBrowser 
     569   * @return sfBrowserBase 
    570570   * 
    571571   * @see    doSelect() 
    …… 
    635635   * @param array   $options    An array of options 
    636636   * 
    637    * @return sfBrowser 
     637   * @return sfBrowserBase 
    638638   * 
    639639   * @see    doClick() 
    …… 
    866866   * Reset browser to original state 
    867867   * 
    868    * @return sfBrowser 
     868   * @return sfBrowserBase 
    869869   */ 
    870870  public function restart()