File indexing completed on 2025-01-19 05:21:36

0001 <?php
0002 /**
0003  * Zend Framework
0004  *
0005  * LICENSE
0006  *
0007  * This source file is subject to the new BSD license that is bundled
0008  * with this package in the file LICENSE.txt.
0009  * It is also available through the world-wide-web at this URL:
0010  * http://framework.zend.com/license/new-bsd
0011  * If you did not receive a copy of the license and are unable to
0012  * obtain it through the world-wide-web, please send an email
0013  * to license@zend.com so we can send you a copy immediately.
0014  *
0015  * @category   Zend
0016  * @package    Zend_Tool
0017  * @subpackage Framework
0018  * @copyright  Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
0019  * @license    http://framework.zend.com/license/new-bsd     New BSD License
0020  * @version    $Id$
0021  */
0022 
0023 /**
0024  * @see Zend_Tool_Framework_Metadata_Basic
0025  */
0026 // require_once 'Zend/Tool/Framework/Metadata/Basic.php';
0027 
0028 /**
0029  * @category   Zend
0030  * @package    Zend_Tool
0031  * @copyright  Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
0032  * @license    http://framework.zend.com/license/new-bsd     New BSD License
0033  */
0034 class Zend_Tool_Framework_Metadata_Tool extends Zend_Tool_Framework_Metadata_Basic
0035 {
0036 
0037     /**
0038      * @var string
0039      */
0040     protected $_type = 'Tool';
0041 
0042     /**#@+
0043      * @var string
0044      */
0045     protected $_clientName    = null;
0046     protected $_actionName    = null;
0047     protected $_providerName  = null;
0048     protected $_specialtyName = null;
0049     /**#@-*/
0050 
0051     /**#@+
0052      * @var string
0053      */
0054     protected $_clientReference = null;
0055     protected $_actionReference = null;
0056     protected $_providerReference = null;
0057     /**#@-*/
0058 
0059     public function setClientName($clientName)
0060     {
0061         $this->_clientName = $clientName;
0062         return $this;
0063     }
0064 
0065     public function getClientName()
0066     {
0067         return $this->_clientName;
0068     }
0069 
0070     /**
0071      * setActionName()
0072      *
0073      * @param string $actionName
0074      * @return Zend_Tool_Framework_Metadata_Tool
0075      */
0076     public function setActionName($actionName)
0077     {
0078         $this->_actionName = $actionName;
0079         return $this;
0080     }
0081 
0082     /**
0083      * getActionName()
0084      *
0085      * @return string
0086      */
0087     public function getActionName()
0088     {
0089         return $this->_actionName;
0090     }
0091 
0092     /**
0093      * setProviderName()
0094      *
0095      * @param string $providerName
0096      * @return Zend_Tool_Framework_Metadata_Tool
0097      */
0098     public function setProviderName($providerName)
0099     {
0100         $this->_providerName = $providerName;
0101         return $this;
0102     }
0103 
0104     /**
0105      * getProviderName()
0106      *
0107      * @return string
0108      */
0109     public function getProviderName()
0110     {
0111         return $this->_providerName;
0112     }
0113 
0114     /**
0115      * setSpecialtyName()
0116      *
0117      * @param string $specialtyName
0118      * @return Zend_Tool_Framework_Metadata_Tool
0119      */
0120     public function setSpecialtyName($specialtyName)
0121     {
0122         $this->_specialtyName = $specialtyName;
0123         return $this;
0124     }
0125 
0126     /**
0127      * getSpecialtyName()
0128      *
0129      * @return string
0130      */
0131     public function getSpecialtyName()
0132     {
0133         return $this->_specialtyName;
0134     }
0135 
0136     /**
0137      * setClientReference()
0138      *
0139      * @param Zend_Tool_Framework_Client_Abstract $client
0140      * @return Zend_Tool_Framework_Metadata_Tool
0141      */
0142     public function setClientReference(Zend_Tool_Framework_Client_Abstract $client)
0143     {
0144         $this->_clientReference = $client;
0145         return $this;
0146     }
0147 
0148     /**
0149      * getClientReference()
0150      *
0151      * @return Zend_Tool_Framework_Client_Abstract
0152      */
0153     public function getClientReference()
0154     {
0155         return $this->_clientReference;
0156     }
0157 
0158     /**
0159      * setActionReference()
0160      *
0161      * @param Zend_Tool_Framework_Action_Interface $action
0162      * @return Zend_Tool_Framework_Metadata_Tool
0163      */
0164     public function setActionReference(Zend_Tool_Framework_Action_Interface $action)
0165     {
0166         $this->_actionReference = $action;
0167         return $this;
0168     }
0169 
0170     /**
0171      * getActionReference()
0172      *
0173      * @return Zend_Tool_Framework_Action_Interface
0174      */
0175     public function getActionReference()
0176     {
0177         return $this->_actionReference;
0178     }
0179 
0180     /**
0181      * setProviderReference()
0182      *
0183      * @param Zend_Tool_Framework_Provider_Interface $provider
0184      * @return Zend_Tool_Framework_Metadata_Tool
0185      */
0186     public function setProviderReference(Zend_Tool_Framework_Provider_Interface $provider)
0187     {
0188         $this->_providerReference = $provider;
0189         return $this;
0190     }
0191 
0192     /**
0193      * getProviderReference()
0194      *
0195      * @return Zend_Tool_Framework_Provider_Interface
0196      */
0197     public function getProviderReference()
0198     {
0199         return $this->_providerReference;
0200     }
0201 
0202     /**
0203      * __toString() cast to string
0204      *
0205      * @return string
0206      */
0207     public function __toString()
0208     {
0209         $string = parent::__toString();
0210         $string .= ' (ProviderName: ' . $this->_providerName
0211              . ', ActionName: '     . $this->_actionName
0212              . ', SpecialtyName: '  . $this->_specialtyName
0213              . ')';
0214 
0215         return $string;
0216     }
0217 
0218 }