Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated DocBlocks to return $this for fluent interface #390

Merged
merged 3 commits into from
Jan 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion library/Zend/Cache/Backend/Static.php
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ class Zend_Cache_Backend_Static
*
* @param string $name
* @param mixed $value
* @return Zend_Cache_Backend_Static
* @return $this
*/
public function setOption($name, $value)
{
Expand Down
2 changes: 1 addition & 1 deletion library/Zend/Cache/Core.php
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ public function __construct($options = [])
* Set options using an instance of type Zend_Config
*
* @param Zend_Config $config
* @return Zend_Cache_Core
* @return $this
*/
public function setConfig(Zend_Config $config)
{
Expand Down
6 changes: 3 additions & 3 deletions library/Zend/Cache/Manager.php
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ class Zend_Cache_Manager
*
* @param string $name
* @param Zend_Cache_Core $cache
* @return Zend_Cache_Manager
* @return $this
*/
public function setCache($name, Zend_Cache_Core $cache)
{
Expand Down Expand Up @@ -198,7 +198,7 @@ public function getCaches()
*
* @param string $name
* @param array $options
* @return Zend_Cache_Manager
* @return $this
* @throws Zend_Cache_Exception
*/
public function setCacheTemplate($name, $options)
Expand Down Expand Up @@ -248,7 +248,7 @@ public function getCacheTemplate($name)
*
* @param string $name
* @param array $options
* @return Zend_Cache_Manager
* @return $this
* @throws Zend_Cache_Exception for invalid options format or if option templates do not have $name
*/
public function setTemplateOptions($name, $options)
Expand Down
14 changes: 7 additions & 7 deletions library/Zend/Controller/Action.php
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ abstract class Zend_Controller_Action implements Zend_Controller_Action_Interfac
public $view;

/**
* compataibility for php 8.2 to stop error Deprecated: Creation of dynamic property
* Compatibility for php 8.2 to stop error Deprecated: Creation of dynamic property
* @var object
*/
public $contexts = null;
Expand Down Expand Up @@ -317,7 +317,7 @@ public function getRequest()
* Set the Request object
*
* @param Zend_Controller_Request_Abstract $request
* @return Zend_Controller_Action
* @return $this
*/
public function setRequest(Zend_Controller_Request_Abstract $request)
{
Expand All @@ -339,7 +339,7 @@ public function getResponse()
* Set the Response object
*
* @param Zend_Controller_Response_Abstract $response
* @return Zend_Controller_Action
* @return $this
*/
public function setResponse(Zend_Controller_Response_Abstract $response)
{
Expand All @@ -351,7 +351,7 @@ public function setResponse(Zend_Controller_Response_Abstract $response)
* Set invocation arguments
*
* @param array $args
* @return Zend_Controller_Action
* @return $this
*/
protected function _setInvokeArgs(array $args = [])
{
Expand Down Expand Up @@ -410,7 +410,7 @@ public function getHelperCopy($helperName)
* Set the front controller instance
*
* @param Zend_Controller_Front $front
* @return Zend_Controller_Action
* @return $this
*/
public function setFrontController(Zend_Controller_Front $front)
{
Expand Down Expand Up @@ -618,7 +618,7 @@ public function getParam($paramName, $default = null)
*
* @param string $paramName
* @param mixed $value
* @return Zend_Controller_Action
* @return $this
* @deprecated Deprecated as of Zend Framework 1.7. Use
* setParam() instead.
*/
Expand All @@ -632,7 +632,7 @@ protected function _setParam($paramName, $value)
*
* @param string $paramName
* @param mixed $value
* @return Zend_Controller_Action
* @return $this
*/
public function setParam($paramName, $value)
{
Expand Down
4 changes: 2 additions & 2 deletions library/Zend/Controller/Action/Helper/ActionStack.php
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ public function pushStack(Zend_Controller_Request_Abstract $next)
* @param string $module
* @param array $params
* @throws Zend_Controller_Action_Exception
* @return Zend_Controller_Action_Helper_ActionStack
* @return $this
*/
public function actionToStack($action, $controller = null, $module = null, array $params = [])
{
Expand Down Expand Up @@ -129,7 +129,7 @@ public function actionToStack($action, $controller = null, $module = null, array
* @param string $controller
* @param string $module
* @param array $params
* @return Zend_Controller_Action_Helper_ActionStack
* @return $this
*/
public function direct($action, $controller = null, $module = null, array $params = [])
{
Expand Down
2 changes: 1 addition & 1 deletion library/Zend/Controller/Action/Helper/Cache.php
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ protected function _encodeCacheId($requestUri)
* Set an instance of the Cache Manager for this helper
*
* @param Zend_Cache_Manager $manager
* @return Zend_Controller_Action_Helper_Cache
* @return $this
*/
public function setManager(Zend_Cache_Manager $manager)
{
Expand Down
2 changes: 1 addition & 1 deletion library/Zend/Controller/Action/Helper/FlashMessenger.php
Original file line number Diff line number Diff line change
Expand Up @@ -305,7 +305,7 @@ public function count($namespace = null): int
* Strategy pattern: proxy to addMessage()
*
* @param string|string[] $message
* @return Zend_Controller_Action_Helper_FlashMessenger
* @return $this
*/
public function direct($message, $namespace=NULL)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ public function __unset($helperName)
* push helper onto the stack
*
* @param Zend_Controller_Action_Helper_Abstract $helper
* @return Zend_Controller_Action_HelperBroker_PriorityStack
* @return $this
*/
public function push(Zend_Controller_Action_Helper_Abstract $helper)
{
Expand Down
20 changes: 10 additions & 10 deletions library/Zend/Controller/Dispatcher/Abstract.php
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ public function getWordDelimiter()
* single string or an array of strings.
*
* @param string|array $spec
* @return Zend_Controller_Dispatcher_Abstract
* @return $this
*/
public function setWordDelimiter($spec)
{
Expand Down Expand Up @@ -201,7 +201,7 @@ public function getPathDelimiter()
* an array of strings.
*
* @param string $spec
* @return Zend_Controller_Dispatcher_Abstract
* @return $this
*/
public function setPathDelimiter($spec)
{
Expand Down Expand Up @@ -264,7 +264,7 @@ public function getFrontController()
* Set front controller instance
*
* @param Zend_Controller_Front $controller
* @return Zend_Controller_Dispatcher_Abstract
* @return $this
*/
public function setFrontController(Zend_Controller_Front $controller)
{
Expand All @@ -277,7 +277,7 @@ public function setFrontController(Zend_Controller_Front $controller)
*
* @param string $name
* @param mixed $value
* @return Zend_Controller_Dispatcher_Abstract
* @return $this
*/
public function setParam($name, $value)
{
Expand All @@ -290,7 +290,7 @@ public function setParam($name, $value)
* Set parameters to pass to action controller constructors
*
* @param array $params
* @return Zend_Controller_Dispatcher_Abstract
* @return $this
*/
public function setParams(array $params)
{
Expand Down Expand Up @@ -331,7 +331,7 @@ public function getParams()
* each.
*
* @param null|string|array $name single key or array of keys for params to clear
* @return Zend_Controller_Dispatcher_Abstract
* @return $this
*/
public function clearParams($name = null)
{
Expand All @@ -354,7 +354,7 @@ public function clearParams($name = null)
* Set response object to pass to action controllers
*
* @param Zend_Controller_Response_Abstract|null $response
* @return Zend_Controller_Dispatcher_Abstract
* @return $this
*/
public function setResponse(Zend_Controller_Response_Abstract $response = null)
{
Expand All @@ -376,7 +376,7 @@ public function getResponse()
* Set the default controller (minus any formatting)
*
* @param string $controller
* @return Zend_Controller_Dispatcher_Abstract
* @return $this
*/
public function setDefaultControllerName($controller)
{
Expand All @@ -398,7 +398,7 @@ public function getDefaultControllerName()
* Set the default action (minus any formatting)
*
* @param string $action
* @return Zend_Controller_Dispatcher_Abstract
* @return $this
*/
public function setDefaultAction($action)
{
Expand All @@ -420,7 +420,7 @@ public function getDefaultAction()
* Set the default module
*
* @param string $module
* @return Zend_Controller_Dispatcher_Abstract
* @return $this
*/
public function setDefaultModule($module)
{
Expand Down
4 changes: 2 additions & 2 deletions library/Zend/Controller/Dispatcher/Standard.php
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ public function __construct(array $params = [])
*
* @param string $path
* @param string $module
* @return Zend_Controller_Dispatcher_Standard
* @return $this
*/
public function addControllerDirectory($path, $module = null)
{
Expand All @@ -89,7 +89,7 @@ public function addControllerDirectory($path, $module = null)
* Set controller directory
*
* @param array|string $directory
* @return Zend_Controller_Dispatcher_Standard
* @return $this
*/
public function setControllerDirectory($directory, $module = null)
{
Expand Down
Loading
Loading