Skip to content
This repository has been archived by the owner on Jan 8, 2020. It is now read-only.

added phpdoc to Zend\Stdlib #2677

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions library/Zend/Stdlib/Exception/BadMethodCallException.php
Expand Up @@ -15,6 +15,7 @@
* *
* @category Zend * @category Zend
* @package Zend_Stdlib * @package Zend_Stdlib
* @subpackage Exception
*/ */
class BadMethodCallException extends \BadMethodCallException implements ExceptionInterface class BadMethodCallException extends \BadMethodCallException implements ExceptionInterface
{ {
Expand Down
7 changes: 7 additions & 0 deletions library/Zend/Stdlib/Exception/DomainException.php
Expand Up @@ -10,6 +10,13 @@


namespace Zend\Stdlib\Exception; namespace Zend\Stdlib\Exception;


/**
* Domain exception
*
* @category Zend
* @package Zend_Stdlib
* @subpackage Exception
*/
class DomainException extends \DomainException implements ExceptionInterface class DomainException extends \DomainException implements ExceptionInterface
{ {
} }
7 changes: 7 additions & 0 deletions library/Zend/Stdlib/Exception/ExceptionInterface.php
Expand Up @@ -10,6 +10,13 @@


namespace Zend\Stdlib\Exception; namespace Zend\Stdlib\Exception;


/**
* Exception marker interface
*
* @category Zend
* @package Zend_Stdlib
* @subpackage Exception
*/
interface ExceptionInterface interface ExceptionInterface
{ {
} }
7 changes: 7 additions & 0 deletions library/Zend/Stdlib/Exception/InvalidArgumentException.php
Expand Up @@ -10,6 +10,13 @@


namespace Zend\Stdlib\Exception; namespace Zend\Stdlib\Exception;


/**
* Invalid Argument Exception
*
* @category Zend
* @package Zend_Stdlib
* @subpackage Exception
*/
class InvalidArgumentException extends \InvalidArgumentException implements ExceptionInterface class InvalidArgumentException extends \InvalidArgumentException implements ExceptionInterface
{ {
} }
1 change: 1 addition & 0 deletions library/Zend/Stdlib/Exception/InvalidCallbackException.php
Expand Up @@ -15,6 +15,7 @@
* *
* @category Zend * @category Zend
* @package Zend_Stdlib * @package Zend_Stdlib
* @subpackage Exception
*/ */
class InvalidCallbackException extends DomainException implements ExceptionInterface class InvalidCallbackException extends DomainException implements ExceptionInterface
{ {
Expand Down
3 changes: 2 additions & 1 deletion library/Zend/Stdlib/Exception/LogicException.php
Expand Up @@ -11,10 +11,11 @@
namespace Zend\Stdlib\Exception; namespace Zend\Stdlib\Exception;


/** /**
* logic exception * Logic exception
* *
* @category Zend * @category Zend
* @package Zend_Stdlib * @package Zend_Stdlib
* @subpackage Exception
*/ */
class LogicException extends \LogicException implements ExceptionInterface class LogicException extends \LogicException implements ExceptionInterface
{ {
Expand Down
5 changes: 5 additions & 0 deletions library/Zend/Stdlib/Hydrator/Reflection.php
Expand Up @@ -13,6 +13,11 @@
use ReflectionClass; use ReflectionClass;
use Zend\Stdlib\Exception; use Zend\Stdlib\Exception;


/**
* @category Zend
* @package Zend_Stdlib
* @subpackage Hydrator
*/
class Reflection extends AbstractHydrator class Reflection extends AbstractHydrator
{ {
/** /**
Expand Down
4 changes: 4 additions & 0 deletions library/Zend/Stdlib/Message.php
Expand Up @@ -12,6 +12,10 @@


use Traversable; use Traversable;


/**
* @category Zend
* @package Zend_Stdlib
*/
class Message implements MessageInterface class Message implements MessageInterface
{ {
/** /**
Expand Down
29 changes: 29 additions & 0 deletions library/Zend/Stdlib/MessageInterface.php
Expand Up @@ -10,12 +10,41 @@


namespace Zend\Stdlib; namespace Zend\Stdlib;


/**
* @category Zend
* @package Zend_Stdlib
*/
interface MessageInterface interface MessageInterface
{ {
/**
* Set metadata
*
* @param string|int|array|\Traversable $spec
* @param mixed $value
*/
public function setMetadata($spec, $value = null); public function setMetadata($spec, $value = null);

/**
* Get metadata
*
* @param null|string|int $key
* @return mixed
*/
public function getMetadata($key = null); public function getMetadata($key = null);


/**
* Set content
*
* @param mixed $content
* @return mixed
*/
public function setContent($content); public function setContent($content);

/**
* Get content
*
* @return mixed
*/
public function getContent(); public function getContent();


} }
6 changes: 5 additions & 1 deletion library/Zend/Stdlib/Parameters.php
Expand Up @@ -12,6 +12,10 @@


use ArrayObject; use ArrayObject;


/**
* @category Zend
* @package Zend_Stdlib
*/
class Parameters extends ArrayObject implements ParametersInterface class Parameters extends ArrayObject implements ParametersInterface
{ {
/** /**
Expand Down Expand Up @@ -106,7 +110,7 @@ public function get($name, $default = null)
/** /**
* @param string $name * @param string $name
* @param mixed $value * @param mixed $value
* @return $this * @return Parameters
*/ */
public function set($name, $value) public function set($name, $value)
{ {
Expand Down
56 changes: 52 additions & 4 deletions library/Zend/Stdlib/ParametersInterface.php
Expand Up @@ -19,24 +19,72 @@
* Basically, an ArrayObject. You could simply define something like: * Basically, an ArrayObject. You could simply define something like:
* class QueryParams extends ArrayObject implements Parameters {} * class QueryParams extends ArrayObject implements Parameters {}
* and have 90% of the functionality * and have 90% of the functionality
*
* @category Zend
* @package Zend_Stdlib
*/ */
interface ParametersInterface extends ArrayAccess, Countable, Serializable, Traversable interface ParametersInterface extends ArrayAccess, Countable, Serializable, Traversable
{ {
/**
* Constructor
*
* @param array $values
*/
public function __construct(array $values = null); 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); 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); public function fromString($string);


/* Allow serialization back to standard array */ /**
* To array
*
* Allow serialization back to standard array
*
* @return mixed
*/
public function toArray(); 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(); public function toString();


/**
* Get
*
* @param string $name
* @param mixed|null $default
* @return mixed
*/
public function get($name, $default = null); public function get($name, $default = null);


/**
* Set
*
* @param string $name
* @param mixed $value
* @return ParametersInterface
*/
public function set($name, $value); public function set($name, $value);
} }
4 changes: 4 additions & 0 deletions library/Zend/Stdlib/Request.php
Expand Up @@ -10,6 +10,10 @@


namespace Zend\Stdlib; namespace Zend\Stdlib;


/**
* @category Zend
* @package Zend_Stdlib
*/
class Request extends Message implements RequestInterface class Request extends Message implements RequestInterface
{ {
// generic request implementation // generic request implementation
Expand Down
4 changes: 4 additions & 0 deletions library/Zend/Stdlib/RequestInterface.php
Expand Up @@ -10,6 +10,10 @@


namespace Zend\Stdlib; namespace Zend\Stdlib;


/**
* @category Zend
* @package Zend_Stdlib
*/
interface RequestInterface extends MessageInterface interface RequestInterface extends MessageInterface
{ {
} }
4 changes: 4 additions & 0 deletions library/Zend/Stdlib/Response.php
Expand Up @@ -10,6 +10,10 @@


namespace Zend\Stdlib; namespace Zend\Stdlib;


/**
* @category Zend
* @package Zend_Stdlib
*/
class Response extends Message implements ResponseInterface class Response extends Message implements ResponseInterface
{ {
// generic response implementation // generic response implementation
Expand Down
4 changes: 4 additions & 0 deletions library/Zend/Stdlib/ResponseInterface.php
Expand Up @@ -10,6 +10,10 @@


namespace Zend\Stdlib; namespace Zend\Stdlib;


/**
* @category Zend
* @package Zend_Stdlib
*/
interface ResponseInterface extends MessageInterface interface ResponseInterface extends MessageInterface
{ {


Expand Down