Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

added phpdoc to Zend\Stdlib

  • Loading branch information...
commit 55609ef7711a5a66d5c58f7cc272cf0c746b06e6 1 parent 1d12f86
@prolic authored
View
1  library/Zend/Stdlib/Exception/BadMethodCallException.php
@@ -15,6 +15,7 @@
*
* @category Zend
* @package Zend_Stdlib
+ * @subpackage Exception
*/
class BadMethodCallException extends \BadMethodCallException implements ExceptionInterface
{
View
7 library/Zend/Stdlib/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
{
}
View
7 library/Zend/Stdlib/Exception/ExceptionInterface.php
@@ -10,6 +10,13 @@
namespace Zend\Stdlib\Exception;
+/**
+ * Exception marker interface
+ *
+ * @category Zend
+ * @package Zend_Stdlib
+ * @subpackage Exception
+ */
interface ExceptionInterface
{
}
View
7 library/Zend/Stdlib/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
{
}
View
1  library/Zend/Stdlib/Exception/InvalidCallbackException.php
@@ -15,6 +15,7 @@
*
* @category Zend
* @package Zend_Stdlib
+ * @subpackage Exception
*/
class InvalidCallbackException extends DomainException implements ExceptionInterface
{
View
3  library/Zend/Stdlib/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
{
View
5 library/Zend/Stdlib/Hydrator/Reflection.php
@@ -13,6 +13,11 @@
use ReflectionClass;
use Zend\Stdlib\Exception;
+/**
+ * @category Zend
+ * @package Zend_Stdlib
+ * @subpackage Hydrator
+ */
class Reflection extends AbstractHydrator
{
/**
View
4 library/Zend/Stdlib/Message.php
@@ -12,6 +12,10 @@
use Traversable;
+/**
+ * @category Zend
+ * @package Zend_Stdlib
+ */
class Message implements MessageInterface
{
/**
View
29 library/Zend/Stdlib/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();
}
View
6 library/Zend/Stdlib/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)
{
View
56 library/Zend/Stdlib/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);
}
View
4 library/Zend/Stdlib/Request.php
@@ -10,6 +10,10 @@
namespace Zend\Stdlib;
+/**
+ * @category Zend
+ * @package Zend_Stdlib
+ */
class Request extends Message implements RequestInterface
{
// generic request implementation
View
4 library/Zend/Stdlib/RequestInterface.php
@@ -10,6 +10,10 @@
namespace Zend\Stdlib;
+/**
+ * @category Zend
+ * @package Zend_Stdlib
+ */
interface RequestInterface extends MessageInterface
{
}
View
4 library/Zend/Stdlib/Response.php
@@ -10,6 +10,10 @@
namespace Zend\Stdlib;
+/**
+ * @category Zend
+ * @package Zend_Stdlib
+ */
class Response extends Message implements ResponseInterface
{
// generic response implementation
View
4 library/Zend/Stdlib/ResponseInterface.php
@@ -10,6 +10,10 @@
namespace Zend\Stdlib;
+/**
+ * @category Zend
+ * @package Zend_Stdlib
+ */
interface ResponseInterface extends MessageInterface
{
Please sign in to comment.
Something went wrong with that request. Please try again.