diff --git a/src/Exception/BadMethodCallException.php b/src/Exception/BadMethodCallException.php index dbe419fa3..b2c90a933 100644 --- a/src/Exception/BadMethodCallException.php +++ b/src/Exception/BadMethodCallException.php @@ -15,6 +15,7 @@ * * @category Zend * @package Zend_Stdlib + * @subpackage Exception */ class BadMethodCallException extends \BadMethodCallException implements ExceptionInterface { diff --git a/src/Exception/DomainException.php b/src/Exception/DomainException.php index 8e85e4d2f..c735fda31 100644 --- a/src/Exception/DomainException.php +++ b/src/Exception/DomainException.php @@ -10,6 +10,13 @@ namespace Zend\Stdlib\Exception; +/** + * Domain exception + * + * @category Zend + * @package Zend_Stdlib + * @subpackage Exception + */ class DomainException extends \DomainException implements ExceptionInterface { } diff --git a/src/Exception/ExceptionInterface.php b/src/Exception/ExceptionInterface.php index a45dd92a4..c09b03763 100644 --- a/src/Exception/ExceptionInterface.php +++ b/src/Exception/ExceptionInterface.php @@ -10,6 +10,13 @@ namespace Zend\Stdlib\Exception; +/** + * Exception marker interface + * + * @category Zend + * @package Zend_Stdlib + * @subpackage Exception + */ interface ExceptionInterface { } diff --git a/src/Exception/InvalidArgumentException.php b/src/Exception/InvalidArgumentException.php index 87d8eaac2..2cdfd38be 100644 --- a/src/Exception/InvalidArgumentException.php +++ b/src/Exception/InvalidArgumentException.php @@ -10,6 +10,13 @@ namespace Zend\Stdlib\Exception; +/** + * Invalid Argument Exception + * + * @category Zend + * @package Zend_Stdlib + * @subpackage Exception + */ class InvalidArgumentException extends \InvalidArgumentException implements ExceptionInterface { } diff --git a/src/Exception/InvalidCallbackException.php b/src/Exception/InvalidCallbackException.php index ab97b5ddb..cd08a315d 100644 --- a/src/Exception/InvalidCallbackException.php +++ b/src/Exception/InvalidCallbackException.php @@ -15,6 +15,7 @@ * * @category Zend * @package Zend_Stdlib + * @subpackage Exception */ class InvalidCallbackException extends DomainException implements ExceptionInterface { diff --git a/src/Exception/LogicException.php b/src/Exception/LogicException.php index b39a4432f..5a23e3ff1 100644 --- a/src/Exception/LogicException.php +++ b/src/Exception/LogicException.php @@ -11,10 +11,11 @@ namespace Zend\Stdlib\Exception; /** - * logic exception + * Logic exception * * @category Zend * @package Zend_Stdlib + * @subpackage Exception */ class LogicException extends \LogicException implements ExceptionInterface { diff --git a/src/Hydrator/Reflection.php b/src/Hydrator/Reflection.php index ecb74fe42..e9d1d66fc 100644 --- a/src/Hydrator/Reflection.php +++ b/src/Hydrator/Reflection.php @@ -13,6 +13,11 @@ use ReflectionClass; use Zend\Stdlib\Exception; +/** + * @category Zend + * @package Zend_Stdlib + * @subpackage Hydrator + */ class Reflection extends AbstractHydrator { /** diff --git a/src/Message.php b/src/Message.php index f8ec758ab..0ac4e992b 100644 --- a/src/Message.php +++ b/src/Message.php @@ -12,6 +12,10 @@ use Traversable; +/** + * @category Zend + * @package Zend_Stdlib + */ class Message implements MessageInterface { /** diff --git a/src/MessageInterface.php b/src/MessageInterface.php index 067ce262f..d947c7769 100644 --- a/src/MessageInterface.php +++ b/src/MessageInterface.php @@ -10,12 +10,41 @@ namespace Zend\Stdlib; +/** + * @category Zend + * @package Zend_Stdlib + */ interface MessageInterface { + /** + * Set metadata + * + * @param string|int|array|\Traversable $spec + * @param mixed $value + */ public function setMetadata($spec, $value = null); + + /** + * Get metadata + * + * @param null|string|int $key + * @return mixed + */ public function getMetadata($key = null); + /** + * Set content + * + * @param mixed $content + * @return mixed + */ public function setContent($content); + + /** + * Get content + * + * @return mixed + */ public function getContent(); } diff --git a/src/Parameters.php b/src/Parameters.php index 30f1c6d58..c88ac159a 100644 --- a/src/Parameters.php +++ b/src/Parameters.php @@ -12,6 +12,10 @@ use ArrayObject; +/** + * @category Zend + * @package Zend_Stdlib + */ class Parameters extends ArrayObject implements ParametersInterface { /** @@ -106,7 +110,7 @@ public function get($name, $default = null) /** * @param string $name * @param mixed $value - * @return $this + * @return Parameters */ public function set($name, $value) { diff --git a/src/ParametersInterface.php b/src/ParametersInterface.php index 42d309540..3c3889c78 100644 --- a/src/ParametersInterface.php +++ b/src/ParametersInterface.php @@ -19,24 +19,72 @@ * Basically, an ArrayObject. You could simply define something like: * class QueryParams extends ArrayObject implements Parameters {} * and have 90% of the functionality + * + * @category Zend + * @package Zend_Stdlib */ interface ParametersInterface extends ArrayAccess, Countable, Serializable, Traversable { + /** + * Constructor + * + * @param array $values + */ public function __construct(array $values = null); - /* Allow deserialization from standard array */ + /** + * From array + * + * Allow deserialization from standard array + * + * @param array $values + * @return mixed + */ public function fromArray(array $values); - /* Allow deserialization from raw body; e.g., for PUT requests */ + /** + * From string + * + * Allow deserialization from raw body; e.g., for PUT requests + * + * @param $string + * @return mixed + */ public function fromString($string); - /* Allow serialization back to standard array */ + /** + * To array + * + * Allow serialization back to standard array + * + * @return mixed + */ public function toArray(); - /* Allow serialization to query format; e.g., for PUT or POST requests */ + /** + * To string + * + * Allow serialization to query format; e.g., for PUT or POST requests + * + * @return mixed + */ public function toString(); + /** + * Get + * + * @param string $name + * @param mixed|null $default + * @return mixed + */ public function get($name, $default = null); + /** + * Set + * + * @param string $name + * @param mixed $value + * @return ParametersInterface + */ public function set($name, $value); } diff --git a/src/Request.php b/src/Request.php index b445e8a54..d230069e6 100644 --- a/src/Request.php +++ b/src/Request.php @@ -10,6 +10,10 @@ namespace Zend\Stdlib; +/** + * @category Zend + * @package Zend_Stdlib + */ class Request extends Message implements RequestInterface { // generic request implementation diff --git a/src/RequestInterface.php b/src/RequestInterface.php index 0f72de7f1..1dd0748a6 100644 --- a/src/RequestInterface.php +++ b/src/RequestInterface.php @@ -10,6 +10,10 @@ namespace Zend\Stdlib; +/** + * @category Zend + * @package Zend_Stdlib + */ interface RequestInterface extends MessageInterface { } diff --git a/src/Response.php b/src/Response.php index 316b00325..b15dfd084 100644 --- a/src/Response.php +++ b/src/Response.php @@ -10,6 +10,10 @@ namespace Zend\Stdlib; +/** + * @category Zend + * @package Zend_Stdlib + */ class Response extends Message implements ResponseInterface { // generic response implementation diff --git a/src/ResponseInterface.php b/src/ResponseInterface.php index 5476f6a7f..6ad4002ba 100644 --- a/src/ResponseInterface.php +++ b/src/ResponseInterface.php @@ -10,6 +10,10 @@ namespace Zend\Stdlib; +/** + * @category Zend + * @package Zend_Stdlib + */ interface ResponseInterface extends MessageInterface {