diff --git a/src/Klein/AbstractResponse.php b/src/Klein/AbstractResponse.php index d30d2f8a..60452f79 100644 --- a/src/Klein/AbstractResponse.php +++ b/src/Klein/AbstractResponse.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -19,9 +19,6 @@ /** * AbstractResponse - * - * @abstract - * @package Klein */ abstract class AbstractResponse { @@ -33,49 +30,42 @@ abstract class AbstractResponse /** * The default response HTTP status code * - * @static - * @var int - * @access protected + * @type int */ protected static $default_status_code = 200; /** * The HTTP version of the response * - * @var string - * @access protected + * @type string */ protected $protocol_version = '1.1'; /** * The response body * - * @var string - * @access protected + * @type string */ protected $body; /** * HTTP response status * - * @var \Klein\HttpStatus - * @access protected + * @type HttpStatus */ protected $status; /** * HTTP response headers * - * @var \Klein\DataCollection\HeaderDataCollection - * @access protected + * @type HeaderDataCollection */ protected $headers; /** * HTTP response cookies * - * @var \Klein\DataCollection\ResponseCookieDataCollection - * @access protected + * @type ResponseCookieDataCollection */ protected $cookies; @@ -83,24 +73,21 @@ abstract class AbstractResponse * Whether or not the response is "locked" from * any further modification * - * @var boolean - * @access protected + * @type boolean */ protected $locked = false; /** * Whether or not the response has been sent * - * @var boolean - * @access protected + * @type boolean */ protected $sent = false; /** * Whether the response has been chunked or not * - * @var boolean - * @access public + * @type boolean */ public $chunked = false; @@ -117,7 +104,6 @@ abstract class AbstractResponse * @param string $body The response body's content * @param int $status_code The status code * @param array $headers The response header "hash" - * @access public */ public function __construct($body = '', $status_code = null, array $headers = array()) { @@ -139,7 +125,6 @@ public function __construct($body = '', $status_code = null, array $headers = ar * was provided by the argument. * * @param string $protocol_version - * @access public * @return string|AbstractResponse */ public function protocolVersion($protocol_version = null) @@ -163,7 +148,6 @@ public function protocolVersion($protocol_version = null) * Calling with an argument, however, sets the response body to what was provided by the argument. * * @param string $body The body content string - * @access public * @return string|AbstractResponse */ public function body($body = null) @@ -183,7 +167,6 @@ public function body($body = null) /** * Returns the status object * - * @access public * @return \Klein\HttpStatus */ public function status() @@ -194,8 +177,7 @@ public function status() /** * Returns the headers collection * - * @access public - * @return \Klein\DataCollection\HeaderDataCollection + * @return HeaderDataCollection */ public function headers() { @@ -205,8 +187,7 @@ public function headers() /** * Returns the cookies collection * - * @access public - * @return \Klein\DataCollection\ResponseCookieDataCollection + * @return ResponseCookieDataCollection */ public function cookies() { @@ -221,7 +202,6 @@ public function cookies() * was provided by the argument. * * @param int $code The HTTP status code to send - * @access public * @return int|AbstractResponse */ public function code($code = null) @@ -242,7 +222,6 @@ public function code($code = null) * Prepend a string to the response's content body * * @param string $content The string to prepend - * @access public * @return AbstractResponse */ public function prepend($content) @@ -259,7 +238,6 @@ public function prepend($content) * Append a string to the response's content body * * @param string $content The string to append - * @access public * @return AbstractResponse */ public function append($content) @@ -275,7 +253,6 @@ public function append($content) /** * Check if the response is locked * - * @access public * @return boolean */ public function isLocked() @@ -291,7 +268,6 @@ public function isLocked() * when its locked * * @throws LockedResponseException If the response is locked - * @access public * @return AbstractResponse */ public function requireUnlocked() @@ -306,7 +282,6 @@ public function requireUnlocked() /** * Lock the response from further modification * - * @access public * @return AbstractResponse */ public function lock() @@ -319,7 +294,6 @@ public function lock() /** * Unlock the response from further modification * - * @access public * @return AbstractResponse */ public function unlock() @@ -334,7 +308,6 @@ public function unlock() * * Creates the string based off of the response's properties * - * @access protected * @return string */ protected function httpStatusLine() @@ -347,7 +320,6 @@ protected function httpStatusLine() * * @param boolean $cookies_also Whether or not to also send the cookies after sending the normal headers * @param boolean $override Whether or not to override the check if headers have already been sent - * @access public * @return AbstractResponse */ public function sendHeaders($cookies_also = true, $override = false) @@ -375,7 +347,6 @@ public function sendHeaders($cookies_also = true, $override = false) * Send our HTTP response cookies * * @param boolean $override Whether or not to override the check if headers have already been sent - * @access public * @return AbstractResponse */ public function sendCookies($override = false) @@ -404,7 +375,6 @@ public function sendCookies($override = false) /** * Send our body's contents * - * @access public * @return AbstractResponse */ public function sendBody() @@ -419,7 +389,6 @@ public function sendBody() * * @param boolean $override Whether or not to override the check if the response has already been sent * @throws ResponseAlreadySentException If the response has already been sent - * @access public * @return AbstractResponse */ public function send($override = false) @@ -449,7 +418,6 @@ public function send($override = false) /** * Check if the response has been sent * - * @access public * @return boolean */ public function isSent() @@ -462,7 +430,6 @@ public function isSent() * * @link https://github.com/chriso/klein.php/wiki/Response-Chunking * @link http://bit.ly/hg3gHb - * @access public * @return AbstractResponse */ public function chunk() @@ -489,7 +456,6 @@ public function chunk() * * @param string $key The name of the HTTP response header * @param mixed $value The value to set the header with - * @access public * @return AbstractResponse */ public function header($key, $value) @@ -509,7 +475,6 @@ public function header($key, $value) * @param string $domain The domain of which to restrict the cookie * @param boolean $secure Flag of whether the cookie should only be sent over a HTTPS connection * @param boolean $httponly Flag of whether the cookie should only be accessible over the HTTP protocol - * @access public * @return AbstractResponse */ public function cookie( @@ -536,7 +501,6 @@ public function cookie( /** * Tell the browser not to cache the response * - * @access public * @return AbstractResponse */ public function noCache() @@ -552,7 +516,6 @@ public function noCache() * * @param string $url The URL to redirect to * @param int $code The HTTP status code to use for redirection - * @access public * @return AbstractResponse */ public function redirect($url, $code = 302) diff --git a/src/Klein/AbstractRouteFactory.php b/src/Klein/AbstractRouteFactory.php index a82836a6..2ddb5515 100644 --- a/src/Klein/AbstractRouteFactory.php +++ b/src/Klein/AbstractRouteFactory.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -15,9 +15,6 @@ * AbstractRouteFactory * * Abstract class for a factory for building new Route instances - * - * @abstract - * @package Klein */ abstract class AbstractRouteFactory { @@ -31,8 +28,7 @@ abstract class AbstractRouteFactory * when matching, so you can define routes under a * common endpoint * - * @var string - * @access protected + * @type string */ protected $namespace; @@ -45,7 +41,6 @@ abstract class AbstractRouteFactory * Constructor * * @param string $namespace The initial namespace to set - * @access public */ public function __construct($namespace = null) { @@ -55,7 +50,6 @@ public function __construct($namespace = null) /** * Gets the value of namespace * - * @access public * @return string */ public function getNamespace() @@ -67,7 +61,6 @@ public function getNamespace() * Sets the value of namespace * * @param string $namespace The namespace from which to collect the Routes under - * @access public * @return AbstractRouteFactory */ public function setNamespace($namespace) @@ -81,7 +74,6 @@ public function setNamespace($namespace) * Append a namespace to the current namespace * * @param string $namespace The namespace from which to collect the Routes under - * @access public * @return AbstractRouteFactory */ public function appendNamespace($namespace) @@ -101,8 +93,6 @@ public function appendNamespace($namespace) * @param string|array $method HTTP Method to match * @param boolean $count_match Whether or not to count the route as a match when counting total matches * @param string $name The name of the route - * @abstract - * @access public * @return Route */ abstract public function build($callback, $path = null, $method = null, $count_match = true, $name = null); diff --git a/src/Klein/App.php b/src/Klein/App.php index 3d6ce361..71dbca91 100644 --- a/src/Klein/App.php +++ b/src/Klein/App.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -17,8 +17,6 @@ /** * App - * - * @package Klein */ class App { @@ -30,8 +28,7 @@ class App /** * The array of app services * - * @var array - * @access protected + * @type array */ protected $services = array(); @@ -46,7 +43,6 @@ class App * * @param string $name The name of the service * @throws UnknownServiceException If a non-registered service is attempted to fetched - * @access public * @return mixed */ public function __get($name) @@ -68,7 +64,6 @@ public function __get($name) * @param callable $method The callable method to execute * @param array $args The argument array to pass to our callback * @throws BadMethodCallException If a non-registered method is attempted to be called - * @access public * @return void */ public function __call($method, $args) @@ -86,7 +81,6 @@ public function __call($method, $args) * @param string $name The name of the service * @param callable $closure The callable function to execute when requesting our service * @throws DuplicateServiceException If an attempt is made to register two services with the same name - * @access public * @return mixed */ public function register($name, $closure) diff --git a/src/Klein/DataCollection/DataCollection.php b/src/Klein/DataCollection/DataCollection.php index 30d73035..5d2b110a 100644 --- a/src/Klein/DataCollection/DataCollection.php +++ b/src/Klein/DataCollection/DataCollection.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -24,11 +24,6 @@ * * Inspired by @fabpot's Symfony 2's HttpFoundation * @link https://github.com/symfony/HttpFoundation/blob/master/ParameterBag.php - * - * @uses IteratorAggregate - * @uses ArrayAccess - * @uses Countable - * @package Klein\DataCollection */ class DataCollection implements IteratorAggregate, ArrayAccess, Countable { @@ -40,8 +35,7 @@ class DataCollection implements IteratorAggregate, ArrayAccess, Countable /** * Collection of data attributes * - * @var array - * @access protected + * @type array */ protected $attributes = array(); @@ -54,7 +48,6 @@ class DataCollection implements IteratorAggregate, ArrayAccess, Countable * Constructor * * @param array $attributes The data attributes of this collection - * @access public */ public function __construct(array $attributes = array()) { @@ -70,7 +63,6 @@ public function __construct(array $attributes = array()) * @param array $mask The parameter mask array * @param boolean $fill_with_nulls Whether or not to fill the returned array with * values to match the given mask, even if they don't exist in the collection - * @access public * @return array */ public function keys($mask = null, $fill_with_nulls = true) @@ -113,7 +105,6 @@ public function keys($mask = null, $fill_with_nulls = true) * @param array $mask The parameter mask array * @param boolean $fill_with_nulls Whether or not to fill the returned array with * values to match the given mask, even if they don't exist in the collection - * @access public * @return array */ public function all($mask = null, $fill_with_nulls = true) @@ -154,7 +145,6 @@ public function all($mask = null, $fill_with_nulls = true) * * @param string $key The name of the parameter to return * @param mixed $default_val The default value of the parameter if it contains no value - * @access public * @return mixed */ public function get($key, $default_val = null) @@ -171,7 +161,6 @@ public function get($key, $default_val = null) * * @param string $key The name of the parameter to set * @param mixed $value The value of the parameter to set - * @access public * @return DataCollection */ public function set($key, $value) @@ -185,7 +174,6 @@ public function set($key, $value) * Replace the collection's attributes * * @param array $attributes The attributes to replace the collection's with - * @access public * @return DataCollection */ public function replace(array $attributes = array()) @@ -204,7 +192,6 @@ public function replace(array $attributes = array()) * * @param array $attributes The attributes to merge into the collection * @param boolean $hard Whether or not to make the merge "hard" - * @access public * @return DataCollection */ public function merge(array $attributes = array(), $hard = false) @@ -232,7 +219,6 @@ public function merge(array $attributes = array(), $hard = false) * See if an attribute exists in the collection * * @param string $key The name of the parameter - * @access public * @return boolean */ public function exists($key) @@ -245,7 +231,6 @@ public function exists($key) * Remove an attribute from the collection * * @param string $key The name of the parameter - * @access public * @return void */ public function remove($key) @@ -258,7 +243,6 @@ public function remove($key) * * Semantic alias of a no-argument `$this->replace` call * - * @access public * @return DataCollection */ public function clear() @@ -269,7 +253,6 @@ public function clear() /** * Check if the collection is empty * - * @access public * @return boolean */ public function isEmpty() @@ -281,7 +264,6 @@ public function isEmpty() * A quick convenience method to get an empty clone of the * collection. Great for dependency injection. :) * - * @access public * @return DataCollection */ public function cloneEmpty() @@ -305,7 +287,6 @@ public function cloneEmpty() * * @see get() * @param string $key The name of the parameter to return - * @access public * @return mixed */ public function __get($key) @@ -322,7 +303,6 @@ public function __get($key) * @see set() * @param string $key The name of the parameter to set * @param mixed $value The value of the parameter to set - * @access public * @return void */ public function __set($key, $value) @@ -338,7 +318,6 @@ public function __set($key, $value) * * @see exists() * @param string $key The name of the parameter - * @access public * @return boolean */ public function __isset($key) @@ -354,7 +333,6 @@ public function __isset($key) * * @see remove() * @param string $key The name of the parameter - * @access public * @return void */ public function __unset($key) @@ -373,7 +351,6 @@ public function __unset($key) * IteratorAggregate interface required method * * @see \IteratorAggregate::getIterator() - * @access public * @return ArrayIterator */ public function getIterator() @@ -389,7 +366,6 @@ public function getIterator() * @see \ArrayAccess::offsetGet() * @see get() * @param string $key The name of the parameter to return - * @access public * @return mixed */ public function offsetGet($key) @@ -406,7 +382,6 @@ public function offsetGet($key) * @see set() * @param string $key The name of the parameter to set * @param mixed $value The value of the parameter to set - * @access public * @return void */ public function offsetSet($key, $value) @@ -422,7 +397,6 @@ public function offsetSet($key, $value) * @see \ArrayAccess::offsetExists() * @see exists() * @param string $key The name of the parameter - * @access public * @return boolean */ public function offsetExists($key) @@ -438,7 +412,6 @@ public function offsetExists($key) * @see \ArrayAccess::offsetUnset() * @see remove() * @param string $key The name of the parameter - * @access public * @return void */ public function offsetUnset($key) @@ -453,7 +426,6 @@ public function offsetUnset($key) * to simply count the number of attributes in the collection. * * @see \Countable::count() - * @access public * @return int */ public function count() diff --git a/src/Klein/DataCollection/HeaderDataCollection.php b/src/Klein/DataCollection/HeaderDataCollection.php index 9677e988..5d18502d 100644 --- a/src/Klein/DataCollection/HeaderDataCollection.php +++ b/src/Klein/DataCollection/HeaderDataCollection.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -15,9 +15,6 @@ * HeaderDataCollection * * A DataCollection for HTTP headers - * - * @uses DataCollection - * @package Klein\DataCollection */ class HeaderDataCollection extends DataCollection { @@ -31,7 +28,6 @@ class HeaderDataCollection extends DataCollection * * @override (doesn't call our parent) * @param array $headers The headers of this collection - * @access public */ public function __construct(array $headers = array()) { @@ -48,7 +44,6 @@ public function __construct(array $headers = array()) * @see DataCollection::get() * @param string $key The name of the header to return * @param mixed $default_val The default value of the header if it contains no value - * @access public * @return mixed */ public function get($key, $default_val = null) @@ -66,7 +61,6 @@ public function get($key, $default_val = null) * @see DataCollection::set() * @param string $key The name of the header to set * @param mixed $value The value of the header to set - * @access public * @return HeaderDataCollection */ public function set($key, $value) @@ -83,7 +77,6 @@ public function set($key, $value) * * @see DataCollection::exists() * @param string $key The name of the header - * @access public * @return boolean */ public function exists($key) @@ -100,7 +93,6 @@ public function exists($key) * * @see DataCollection::remove() * @param string $key The name of the header - * @access public * @return void */ public function remove($key) @@ -119,8 +111,6 @@ public function remove($key) * @link http://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.2 * @param string $name The name ("field") of the header * @param boolean $make_lowercase Whether or not to lowercase the name - * @static - * @access public * @return string */ public static function normalizeName($name, $make_lowercase = true) diff --git a/src/Klein/DataCollection/ResponseCookieDataCollection.php b/src/Klein/DataCollection/ResponseCookieDataCollection.php index f678e654..f454a1ac 100644 --- a/src/Klein/DataCollection/ResponseCookieDataCollection.php +++ b/src/Klein/DataCollection/ResponseCookieDataCollection.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -17,9 +17,6 @@ * ResponseCookieDataCollection * * A DataCollection for HTTP response cookies - * - * @uses DataCollection - * @package Klein\DataCollection */ class ResponseCookieDataCollection extends DataCollection { @@ -33,7 +30,6 @@ class ResponseCookieDataCollection extends DataCollection * * @override (doesn't call our parent) * @param array $cookies The cookies of this collection - * @access public */ public function __construct(array $cookies = array()) { @@ -59,7 +55,6 @@ public function __construct(array $cookies = array()) * @see DataCollection::set() * @param string $key The name of the cookie to set * @param ResponseCookie|string $value The value of the cookie to set - * @access public * @return ResponseCookieDataCollection */ public function set($key, $value) diff --git a/src/Klein/DataCollection/RouteCollection.php b/src/Klein/DataCollection/RouteCollection.php index 64eda9e8..fe182347 100644 --- a/src/Klein/DataCollection/RouteCollection.php +++ b/src/Klein/DataCollection/RouteCollection.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -17,9 +17,6 @@ * RouteCollection * * A DataCollection for Routes - * - * @uses DataCollection - * @package Klein\DataCollection */ class RouteCollection extends DataCollection { @@ -33,7 +30,6 @@ class RouteCollection extends DataCollection * * @override (doesn't call our parent) * @param array $routes The routes of this collection - * @access public */ public function __construct(array $routes = array()) { @@ -58,7 +54,6 @@ public function __construct(array $routes = array()) * @see DataCollection::set() * @param string $key The name of the route to set * @param Route|callable $value The value of the route to set - * @access public * @return RouteCollection */ public function set($key, $value) @@ -76,7 +71,6 @@ public function set($key, $value) * This will auto-generate a name * * @param Route $route - * @access public * @return RouteCollection */ public function addRoute(Route $route) @@ -99,7 +93,6 @@ public function addRoute(Route $route) * or any other Route class compatible callback * * @param Route|callable $route - * @access public * @return RouteCollection */ public function add($route) @@ -121,7 +114,6 @@ public function add($route) * Thankfully, because routes are all objects, this doesn't * take much memory as its simply moving references around * - * @access public * @return RouteCollection */ public function prepareNamed() diff --git a/src/Klein/DataCollection/ServerDataCollection.php b/src/Klein/DataCollection/ServerDataCollection.php index 4938a0c4..5a9ea5bd 100644 --- a/src/Klein/DataCollection/ServerDataCollection.php +++ b/src/Klein/DataCollection/ServerDataCollection.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -20,9 +20,6 @@ * * Inspired by @fabpot's Symfony 2's HttpFoundation * @link https://github.com/symfony/HttpFoundation/blob/master/ServerBag.php - * - * @uses DataCollection - * @package Klein\DataCollection */ class ServerDataCollection extends DataCollection { @@ -35,9 +32,7 @@ class ServerDataCollection extends DataCollection * The prefix of HTTP headers normally * stored in the Server data * - * @static - * @var string - * @access protected + * @type string */ protected static $http_header_prefix = 'HTTP_'; @@ -45,9 +40,7 @@ class ServerDataCollection extends DataCollection * The list of HTTP headers that for some * reason aren't prefixed in PHP... * - * @static - * @var array - * @access protected + * @type array */ protected static $http_nonprefixed_headers = array( 'CONTENT_LENGTH', @@ -65,8 +58,6 @@ class ServerDataCollection extends DataCollection * * @param string $string The string to check * @param string $prefix The prefix to test - * @static - * @access public * @return boolean */ public static function hasPrefix($string, $prefix) @@ -84,7 +75,6 @@ public static function hasPrefix($string, $prefix) * PHP is weird... it puts all of the HTTP request * headers in the $_SERVER array. This handles that * - * @access public * @return array */ public function getHeaders() diff --git a/src/Klein/Exceptions/DispatchHaltedException.php b/src/Klein/Exceptions/DispatchHaltedException.php index 678d29cd..a00def77 100644 --- a/src/Klein/Exceptions/DispatchHaltedException.php +++ b/src/Klein/Exceptions/DispatchHaltedException.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -17,9 +17,6 @@ * DispatchHaltedException * * Exception used to halt a route callback from executing in a dispatch loop - * - * @uses RuntimeException - * @package Klein\Exceptions */ class DispatchHaltedException extends RuntimeException implements KleinExceptionInterface { @@ -31,21 +28,21 @@ class DispatchHaltedException extends RuntimeException implements KleinException /** * Skip this current match/callback * - * @const int + * @type int */ const SKIP_THIS = 1; /** * Skip the next match/callback * - * @const int + * @type int */ const SKIP_NEXT = 2; /** * Skip the rest of the matches * - * @const int + * @type int */ const SKIP_REMAINING = 0; @@ -57,8 +54,7 @@ class DispatchHaltedException extends RuntimeException implements KleinException /** * The number of next matches to skip on a "next" skip * - * @var int - * @access protected + * @type int */ protected $number_of_skips = 1; @@ -81,7 +77,6 @@ public function getNumberOfSkips() * Sets the number of matches to skip on a "next" skip * * @param int $number_of_skips - * @access public * @return DispatchHaltedException */ public function setNumberOfSkips($number_of_skips) diff --git a/src/Klein/Exceptions/DuplicateServiceException.php b/src/Klein/Exceptions/DuplicateServiceException.php index 1cb86c22..69173993 100644 --- a/src/Klein/Exceptions/DuplicateServiceException.php +++ b/src/Klein/Exceptions/DuplicateServiceException.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -17,9 +17,6 @@ * DuplicateServiceException * * Exception used for when a service is attempted to be registered that already exists - * - * @uses Exception - * @package Klein\Exceptions */ class DuplicateServiceException extends OverflowException implements KleinExceptionInterface { diff --git a/src/Klein/Exceptions/HttpException.php b/src/Klein/Exceptions/HttpException.php index 12d48a7f..ba170937 100644 --- a/src/Klein/Exceptions/HttpException.php +++ b/src/Klein/Exceptions/HttpException.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -17,9 +17,6 @@ * HttpException * * An HTTP error exception - * - * @uses RuntimeException - * @package Klein\Exceptions */ class HttpException extends RuntimeException implements HttpExceptionInterface { @@ -32,8 +29,6 @@ class HttpException extends RuntimeException implements HttpExceptionInterface * Create an HTTP exception from nothing but an HTTP code * * @param int $code - * @static - * @access public * @return HttpException */ public static function createFromCode($code) diff --git a/src/Klein/Exceptions/HttpExceptionInterface.php b/src/Klein/Exceptions/HttpExceptionInterface.php index 8b0ba5a0..e26b06b7 100644 --- a/src/Klein/Exceptions/HttpExceptionInterface.php +++ b/src/Klein/Exceptions/HttpExceptionInterface.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -15,8 +15,6 @@ * HttpExceptionInterface * * An interface for type-hinting generic HTTP errors - * - * @package Klein\Exceptions */ interface HttpExceptionInterface extends KleinExceptionInterface { diff --git a/src/Klein/Exceptions/KleinExceptionInterface.php b/src/Klein/Exceptions/KleinExceptionInterface.php index bd139436..3813372c 100644 --- a/src/Klein/Exceptions/KleinExceptionInterface.php +++ b/src/Klein/Exceptions/KleinExceptionInterface.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -20,8 +20,6 @@ * that can be type-hinted/instance-checked against, therefore making it * easier to handle Klein exceptions while still allowing the different * exception classes to properly extend the corresponding SPL Exception type - * - * @package Klein\Exceptions */ interface KleinExceptionInterface { diff --git a/src/Klein/Exceptions/LockedResponseException.php b/src/Klein/Exceptions/LockedResponseException.php index af0fbc9d..9c8f34cd 100644 --- a/src/Klein/Exceptions/LockedResponseException.php +++ b/src/Klein/Exceptions/LockedResponseException.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -17,9 +17,6 @@ * LockedResponseException * * Exception used for when a response is attempted to be modified while its locked - * - * @uses RuntimeException - * @package Klein\Exceptions */ class LockedResponseException extends RuntimeException implements KleinExceptionInterface { diff --git a/src/Klein/Exceptions/RegularExpressionCompilationException.php b/src/Klein/Exceptions/RegularExpressionCompilationException.php index 5ac9e6c7..7fec7214 100644 --- a/src/Klein/Exceptions/RegularExpressionCompilationException.php +++ b/src/Klein/Exceptions/RegularExpressionCompilationException.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -17,9 +17,6 @@ * RegularExpressionCompilationException * * Exception used for when a regular expression fails to compile - * - * @uses Exception - * @package Klein\Exceptions */ class RegularExpressionCompilationException extends RuntimeException implements KleinExceptionInterface { diff --git a/src/Klein/Exceptions/ResponseAlreadySentException.php b/src/Klein/Exceptions/ResponseAlreadySentException.php index f6aad743..563ba00f 100644 --- a/src/Klein/Exceptions/ResponseAlreadySentException.php +++ b/src/Klein/Exceptions/ResponseAlreadySentException.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -17,9 +17,6 @@ * ResponseAlreadySentException * * Exception used for when a response is attempted to be sent after its already been sent - * - * @uses RuntimeException - * @package Klein\Exceptions */ class ResponseAlreadySentException extends RuntimeException implements KleinExceptionInterface { diff --git a/src/Klein/Exceptions/RoutePathCompilationException.php b/src/Klein/Exceptions/RoutePathCompilationException.php index 3e3cb005..e43874cc 100644 --- a/src/Klein/Exceptions/RoutePathCompilationException.php +++ b/src/Klein/Exceptions/RoutePathCompilationException.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -19,9 +19,6 @@ * RoutePathCompilationException * * Exception used for when a route's path fails to compile - * - * @uses Exception - * @package Klein\Exceptions */ class RoutePathCompilationException extends RuntimeException implements KleinExceptionInterface { @@ -33,14 +30,14 @@ class RoutePathCompilationException extends RuntimeException implements KleinExc /** * The exception message format * - * @const string + * @type string */ const MESSAGE_FORMAT = 'Route failed to compile with path "%s".'; /** * The extra failure message format * - * @const string + * @type string */ const FAILURE_MESSAGE_TITLE_FORMAT = 'Failed with message: "%s"'; @@ -52,8 +49,7 @@ class RoutePathCompilationException extends RuntimeException implements KleinExc /** * The route that failed to compile * - * @var Route - * @access protected + * @type Route */ protected $route; @@ -68,8 +64,6 @@ class RoutePathCompilationException extends RuntimeException implements KleinExc * * @param Route $route The route that failed to compile * @param Exception $previous The previous exception - * @static - * @access public * @return RoutePathCompilationException */ public static function createFromRoute(Route $route, Exception $previous = null) diff --git a/src/Klein/Exceptions/UnhandledException.php b/src/Klein/Exceptions/UnhandledException.php index f5345633..61617582 100644 --- a/src/Klein/Exceptions/UnhandledException.php +++ b/src/Klein/Exceptions/UnhandledException.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -17,9 +17,6 @@ * UnhandledException * * Exception used for when a exception isn't correctly handled by the Klein error callbacks - * - * @uses Exception - * @package Klein\Exceptions */ class UnhandledException extends RuntimeException implements KleinExceptionInterface { diff --git a/src/Klein/Exceptions/UnknownServiceException.php b/src/Klein/Exceptions/UnknownServiceException.php index e121ef5a..a989f492 100644 --- a/src/Klein/Exceptions/UnknownServiceException.php +++ b/src/Klein/Exceptions/UnknownServiceException.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -17,9 +17,6 @@ * UnknownServiceException * * Exception used for when a service was called that doesn't exist - * - * @uses Exception - * @package Klein\Exceptions */ class UnknownServiceException extends OutOfBoundsException implements KleinExceptionInterface { diff --git a/src/Klein/Exceptions/ValidationException.php b/src/Klein/Exceptions/ValidationException.php index 8705286a..0111a79c 100644 --- a/src/Klein/Exceptions/ValidationException.php +++ b/src/Klein/Exceptions/ValidationException.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -17,9 +17,6 @@ * ValidationException * * Exception used for Validation errors - * - * @uses Exception - * @package Klein\Exceptions */ class ValidationException extends UnexpectedValueException implements KleinExceptionInterface { diff --git a/src/Klein/HttpStatus.php b/src/Klein/HttpStatus.php index 1f255531..537fc163 100644 --- a/src/Klein/HttpStatus.php +++ b/src/Klein/HttpStatus.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -15,8 +15,6 @@ * HttpStatus * * HTTP status code and message translator - * - * @package Klein */ class HttpStatus { @@ -24,16 +22,14 @@ class HttpStatus /** * The HTTP status code * - * @var int - * @access protected + * @type int */ protected $code; /** * The HTTP status message * - * @var string - * @access protected + * @type string */ protected $message; @@ -41,9 +37,7 @@ class HttpStatus * HTTP 1.1 status messages based on code * * @link http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html - * @static - * @var array - * @access protected + * @type array */ protected static $http_messages = array( // Informational 1xx @@ -104,7 +98,6 @@ class HttpStatus * * @param int $code The HTTP code * @param string $message (optional) HTTP message for the corresponding code - * @access public */ public function __construct($code, $message = null) { @@ -120,7 +113,6 @@ public function __construct($code, $message = null) /** * Get the HTTP status code * - * @access public * @return int */ public function getCode() @@ -131,7 +123,6 @@ public function getCode() /** * Get the HTTP status message * - * @access public * @return string */ public function getMessage() @@ -143,7 +134,6 @@ public function getMessage() * Set the HTTP status code * * @param int $code - * @access public * @return HttpStatus */ public function setCode($code) @@ -156,7 +146,6 @@ public function setCode($code) * Set the HTTP status message * * @param string $message - * @access public * @return HttpStatus */ public function setMessage($message) @@ -168,7 +157,6 @@ public function setMessage($message) /** * Get a string representation of our HTTP status * - * @access public * @return string */ public function getFormattedString() @@ -189,7 +177,6 @@ public function getFormattedString() * This method will be automatically called, returning a string representation * of this instance * - * @access public * @return string */ public function __toString() @@ -204,8 +191,6 @@ public function __toString() * found for the passed in code * * @param int $int - * @static - * @access public * @return string|null */ public static function getMessageFromCode($int) diff --git a/src/Klein/Klein.php b/src/Klein/Klein.php index 79d784ce..1953ed77 100644 --- a/src/Klein/Klein.php +++ b/src/Klein/Klein.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -26,8 +26,6 @@ * Klein * * Main Klein router class - * - * @package Klein */ class Klein { @@ -39,14 +37,14 @@ class Klein /** * The regular expression used to compile and match URL's * - * @const string + * @type string */ const ROUTE_COMPILE_REGEX = '`(\\\?(?:/|\.|))(?:\[([^:\]]*)(?::([^:\]]*))?\])(\?|)`'; /** * The regular expression used to escape the non-named param section of a route URL * - * @const string + * @type string */ const ROUTE_ESCAPE_REGEX = '`(?<=^|\])[^\]\[\?]+?(?=\[|$)`'; @@ -55,7 +53,7 @@ class Klein * * Don't capture anything. Behave as normal. * - * @const int + * @type int */ const DISPATCH_NO_CAPTURE = 0; @@ -64,7 +62,7 @@ class Klein * * Capture all output and return it from dispatch * - * @const int + * @type int */ const DISPATCH_CAPTURE_AND_RETURN = 1; @@ -73,7 +71,7 @@ class Klein * * Capture all output and replace the response body with it * - * @const int + * @type int */ const DISPATCH_CAPTURE_AND_REPLACE = 2; @@ -82,7 +80,7 @@ class Klein * * Capture all output and prepend it to the response body * - * @const int + * @type int */ const DISPATCH_CAPTURE_AND_PREPEND = 3; @@ -91,7 +89,7 @@ class Klein * * Capture all output and append it to the response body * - * @const int + * @type int */ const DISPATCH_CAPTURE_AND_APPEND = 4; @@ -110,8 +108,7 @@ class Klein * - hexadecimal: '[h:color]' * - slug: '[s:article]' * - * @var array - * @access protected + * @type array */ protected $match_types = array( 'i' => '[0-9]++', @@ -126,32 +123,28 @@ class Klein /** * Collection of the routes to match on dispatch * - * @var RouteCollection - * @access protected + * @type RouteCollection */ protected $routes; /** * The Route factory object responsible for creating Route instances * - * @var AbstractRouteFactory - * @access protected + * @type AbstractRouteFactory */ protected $route_factory; /** * An array of error callback callables * - * @var array[callable] - * @access protected + * @type array[callable] */ protected $errorCallbacks = array(); /** * An array of HTTP error callback callables * - * @var array[callable] - * @access protected + * @type array[callable] */ protected $httpErrorCallbacks = array(); @@ -159,8 +152,7 @@ class Klein * An array of callbacks to call after processing the dispatch loop * and before the response is sent * - * @var array[callable] - * @access protected + * @type array[callable] */ protected $afterFilterCallbacks = array(); @@ -172,32 +164,28 @@ class Klein /** * The Request object passed to each matched route * - * @var Request - * @access protected + * @type Request */ protected $request; /** * The Response object passed to each matched route * - * @var AbstractResponse - * @access protected + * @type AbstractResponse */ protected $response; /** * The service provider object passed to each matched route * - * @var ServiceProvider - * @access protected + * @type ServiceProvider */ protected $service; /** * A generic variable passed to each matched route * - * @var mixed - * @access protected + * @type mixed */ protected $app; @@ -216,7 +204,6 @@ class Klein * @param mixed $app An object passed to each route callback, defaults to an App instance * @param RouteCollection $routes Collection object responsible for containing all route instances * @param AbstractRouteFactory $route_factory A factory class responsible for creating Route instances - * @access public */ public function __construct( ServiceProvider $service = null, @@ -234,7 +221,6 @@ public function __construct( /** * Returns the routes object * - * @access public * @return RouteCollection */ public function routes() @@ -245,7 +231,6 @@ public function routes() /** * Returns the request object * - * @access public * @return Request */ public function request() @@ -256,7 +241,6 @@ public function request() /** * Returns the response object * - * @access public * @return Response */ public function response() @@ -267,7 +251,6 @@ public function response() /** * Returns the service object * - * @access public * @return ServiceProvider */ public function service() @@ -278,7 +261,6 @@ public function service() /** * Returns the app object * - * @access public * @return mixed */ public function app() @@ -298,7 +280,6 @@ public function app() * @named string | array $method HTTP Method to match * @named string $path Route URI path to match * @named callable $callback Callable callback method to execute on route match - * @access protected * @return array A named parameter array containing the keys: 'method', 'path', and 'callback' */ protected function parseLooseArgumentOrder(array $args) @@ -343,7 +324,6 @@ protected function parseLooseArgumentOrder(array $args) * @param string|array $method HTTP Method to match * @param string $path Route URI path to match * @param callable $callback Callable callback method to execute on route match - * @access public * @return Route */ public function respond($method, $path = '*', $callback = null) @@ -384,7 +364,6 @@ public function respond($method, $path = '*', $callback = null) * * @param string $namespace The namespace under which to collect the routes * @param callable|string $routes The defined routes callable or filename to collect under the namespace - * @access public * @return void */ public function with($namespace, $routes) @@ -416,7 +395,6 @@ public function with($namespace, $routes) * @param AbstractResponse $response The response object to give to each callback * @param boolean $send_response Whether or not to "send" the response after the last route has been matched * @param int $capture Specify a DISPATCH_* constant to change the output capturing behavior - * @access public * @return void|string */ public function dispatch( @@ -713,7 +691,6 @@ public function dispatch( * Compiles a route string to a regular expression * * @param string $route The route string to compile - * @access protected * @return string */ protected function compileRoute($route) @@ -770,7 +747,6 @@ function ($match) use ($match_types) { * * @param string $regex The regular expression to validate * @throws RegularExpressionCompilationException If the expression can't be compiled - * @access private * @return boolean */ private function validateRegularExpression($regex) @@ -823,7 +799,6 @@ function ($errno, $errstr) use (&$error_string) { * @param array $params The array of placeholder fillers * @param boolean $flatten_regex Optionally flatten custom regular expressions to "/" * @throws OutOfBoundsException If the route requested doesn't exist - * @access public * @return string */ public function getPathFor($route_name, array $params = null, $flatten_regex = true) @@ -875,7 +850,6 @@ function ($match) use ($params) { * @param Route $route * @param RouteCollection $matched * @param array $methods_matched - * @access protected * @return void */ protected function handleRouteCallback(Route $route, RouteCollection $matched, array $methods_matched) @@ -908,7 +882,6 @@ protected function handleRouteCallback(Route $route, RouteCollection $matched, a * Adds an error callback to the stack of error handlers * * @param callable $callback The callable function to execute in the error handling chain - * @access public * @return boolean|void */ public function onError($callback) @@ -921,7 +894,6 @@ public function onError($callback) * * @param Exception $err The exception that occurred * @throws UnhandledException If the error/exception isn't handled by an error callback - * @access protected * @return void */ protected function error(Exception $err) @@ -962,7 +934,6 @@ protected function error(Exception $err) * Adds an HTTP error callback to the stack of HTTP error handlers * * @param callable $callback The callable function to execute in the error handling chain - * @access public * @return void */ public function onHttpError($callback) @@ -976,7 +947,6 @@ public function onHttpError($callback) * @param HttpExceptionInterface $http_exception The exception that occurred * @param RouteCollection $matched The collection of routes that were matched in dispatch * @param array $methods_matched The HTTP methods that were matched in dispatch - * @access protected * @return void */ protected function httpError(HttpExceptionInterface $http_exception, RouteCollection $matched, $methods_matched) @@ -1023,7 +993,6 @@ protected function httpError(HttpExceptionInterface $http_exception, RouteCollec * is sent * * @param callable $callback The callable function to execute in the after route chain - * @access public * @return void */ public function afterDispatch($callback) @@ -1034,7 +1003,6 @@ public function afterDispatch($callback) /** * Runs through and executes the after dispatch callbacks * - * @access protected * @return void */ protected function callAfterDispatchCallbacks() @@ -1065,7 +1033,6 @@ protected function callAfterDispatchCallbacks() * Quick alias to skip the current callback/route method from executing * * @throws DispatchHaltedException To halt/skip the current dispatch loop - * @access public * @return void */ public function skipThis() @@ -1078,7 +1045,6 @@ public function skipThis() * * @param int $num The number of next matches to skip * @throws DispatchHaltedException To halt/skip the current dispatch loop - * @access public * @return void */ public function skipNext($num = 1) @@ -1093,7 +1059,6 @@ public function skipNext($num = 1) * Quick alias to stop the remaining callbacks/route methods from executing * * @throws DispatchHaltedException To halt/skip the current dispatch loop - * @access public * @return void */ public function skipRemaining() @@ -1106,7 +1071,6 @@ public function skipRemaining() * * @param int $code Optional HTTP status code to send * @throws DispatchHaltedException To halt/skip the current dispatch loop - * @access public * @return void */ public function abort($code = null) @@ -1124,7 +1088,6 @@ public function abort($code = null) * @see Klein::respond() * @param string $path * @param callable $callback - * @access public * @return Route */ public function options($path = '*', $callback = null) @@ -1144,7 +1107,6 @@ public function options($path = '*', $callback = null) * @see Klein::respond() * @param string $path * @param callable $callback - * @access public * @return Route */ public function head($path = '*', $callback = null) @@ -1164,7 +1126,6 @@ public function head($path = '*', $callback = null) * @see Klein::respond() * @param string $path * @param callable $callback - * @access public * @return Route */ public function get($path = '*', $callback = null) @@ -1184,7 +1145,6 @@ public function get($path = '*', $callback = null) * @see Klein::respond() * @param string $path * @param callable $callback - * @access public * @return Route */ public function post($path = '*', $callback = null) @@ -1204,7 +1164,6 @@ public function post($path = '*', $callback = null) * @see Klein::respond() * @param string $path * @param callable $callback - * @access public * @return Route */ public function put($path = '*', $callback = null) @@ -1224,7 +1183,6 @@ public function put($path = '*', $callback = null) * @see Klein::respond() * @param string $path * @param callable $callback - * @access public * @return Route */ public function delete($path = '*', $callback = null) @@ -1247,7 +1205,6 @@ public function delete($path = '*', $callback = null) * @see Klein::respond() * @param string $path * @param callable $callback - * @access public * @return Route */ public function patch($path = '*', $callback = null) diff --git a/src/Klein/Request.php b/src/Klein/Request.php index c19acdbd..3747911d 100644 --- a/src/Klein/Request.php +++ b/src/Klein/Request.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -17,8 +17,6 @@ /** * Request - * - * @package Klein */ class Request { @@ -30,72 +28,63 @@ class Request /** * Unique identifier for the request * - * @var string - * @access protected + * @type string */ protected $id; /** * GET (query) parameters * - * @var \Klein\DataCollection\DataCollection - * @access protected + * @type DataCollection */ protected $params_get; /** * POST parameters * - * @var \Klein\DataCollection\DataCollection - * @access protected + * @type DataCollection */ protected $params_post; /** * Named parameters * - * @var \Klein\DataCollection\DataCollection - * @access protected + * @type DataCollection */ protected $params_named; /** * Client cookie data * - * @var \Klein\DataCollection\DataCollection - * @access protected + * @type DataCollection */ protected $cookies; /** * Server created attributes * - * @var \Klein\DataCollection\ServerDataCollection - * @access protected + * @type ServerDataCollection */ protected $server; /** * HTTP request headers * - * @var \Klein\DataCollection\HeaderDataCollection - * @access protected + * @type HeaderDataCollection */ protected $headers; /** * Uploaded temporary files * - * @var \Klein\DataCollection\DataCollection - * @access protected + * @type DataCollection */ protected $files; /** * The request body * - * @var string - * @access protected + * @type string */ protected $body; @@ -115,7 +104,6 @@ class Request * @param array $server * @param array $files * @param string $body - * @access public */ public function __construct( array $params_get = array(), @@ -142,8 +130,6 @@ public function __construct( * Create a new request object using the built-in "superglobals" * * @link http://php.net/manual/en/language.variables.superglobals.php - * @static - * @access public * @return Request */ public static function createFromGlobals() @@ -165,7 +151,6 @@ public static function createFromGlobals() * Generates one on the first call * * @param boolean $hash Whether or not to hash the ID on creation - * @access public * @return string */ public function id($hash = true) @@ -184,7 +169,6 @@ public function id($hash = true) /** * Returns the GET parameters collection * - * @access public * @return \Klein\DataCollection\DataCollection */ public function paramsGet() @@ -195,7 +179,6 @@ public function paramsGet() /** * Returns the POST parameters collection * - * @access public * @return \Klein\DataCollection\DataCollection */ public function paramsPost() @@ -206,7 +189,6 @@ public function paramsPost() /** * Returns the named parameters collection * - * @access public * @return \Klein\DataCollection\DataCollection */ public function paramsNamed() @@ -217,7 +199,6 @@ public function paramsNamed() /** * Returns the cookies collection * - * @access public * @return \Klein\DataCollection\DataCollection */ public function cookies() @@ -228,7 +209,6 @@ public function cookies() /** * Returns the server collection * - * @access public * @return \Klein\DataCollection\DataCollection */ public function server() @@ -239,7 +219,6 @@ public function server() /** * Returns the headers collection * - * @access public * @return \Klein\DataCollection\HeaderDataCollection */ public function headers() @@ -250,7 +229,6 @@ public function headers() /** * Returns the files collection * - * @access public * @return \Klein\DataCollection\DataCollection */ public function files() @@ -261,7 +239,6 @@ public function files() /** * Gets the request body * - * @access public * @return string */ public function body() @@ -284,7 +261,6 @@ public function body() * @param array $mask The parameter mask array * @param boolean $fill_with_nulls Whether or not to fill the returned array * with null values to match the given mask - * @access public * @return array */ public function params($mask = null, $fill_with_nulls = true) @@ -314,7 +290,6 @@ public function params($mask = null, $fill_with_nulls = true) * * @param string $key The name of the parameter to return * @param mixed $default The default value of the parameter if it contains no value - * @access public * @return string */ public function param($key, $default = null) @@ -332,7 +307,6 @@ public function param($key, $default = null) * from this instance while treating it as an instance property * * @param string $param The name of the parameter - * @access public * @return boolean */ public function __isset($param) @@ -350,7 +324,6 @@ public function __isset($param) * while treating it as an instance property * * @param string $param The name of the parameter - * @access public * @return string */ public function __get($param) @@ -369,7 +342,6 @@ public function __get($param) * * @param string $param The name of the parameter * @param mixed $value The value of the parameter - * @access public * @return void */ public function __set($param, $value) @@ -384,7 +356,6 @@ public function __set($param, $value) * while treating it as an instance property * * @param string $param The name of the parameter - * @access public * @return void */ public function __unset($param) @@ -395,7 +366,6 @@ public function __unset($param) /** * Is the request secure? * - * @access public * @return boolean */ public function isSecure() @@ -406,7 +376,6 @@ public function isSecure() /** * Gets the request IP address * - * @access public * @return string */ public function ip() @@ -417,7 +386,6 @@ public function ip() /** * Gets the request user agent * - * @access public * @return string */ public function userAgent() @@ -428,7 +396,6 @@ public function userAgent() /** * Gets the request URI * - * @access public * @return string */ public function uri() @@ -439,7 +406,6 @@ public function uri() /** * Get the request's pathname * - * @access public * @return string */ public function pathname() @@ -464,7 +430,6 @@ public function pathname() * * @param string $is The method to check the current request method against * @param boolean $allow_override Whether or not to allow HTTP method overriding via header or params - * @access public * @return string|boolean */ public function method($is = null, $allow_override = true) @@ -496,7 +461,6 @@ public function method($is = null, $allow_override = true) * * @param string $key The name of the query param * @param mixed $value The value of the query param - * @access public * @return string */ public function query($key, $value = null) diff --git a/src/Klein/Response.php b/src/Klein/Response.php index adf8bd27..c8446b5d 100644 --- a/src/Klein/Response.php +++ b/src/Klein/Response.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -13,9 +13,6 @@ /** * Response - * - * @uses AbstractResponse - * @package Klein */ class Response extends AbstractResponse { @@ -30,7 +27,6 @@ class Response extends AbstractResponse * @link https://github.com/chriso/klein.php/wiki/Response-Chunking * @link http://bit.ly/hg3gHb * @param string $str An optional string to send as a response "chunk" - * @access public * @return Response */ public function chunk($str = null) @@ -50,7 +46,6 @@ public function chunk($str = null) * Dump a variable * * @param mixed $obj The variable to dump - * @access public * @return Response */ public function dump($obj) @@ -79,7 +74,6 @@ public function dump($obj) * @param string $path The path of the file to send * @param string $filename The file's name * @param string $mimetype The MIME type of the file - * @access public * @return Response */ public function file($path, $filename = null, $mimetype = null) @@ -118,7 +112,6 @@ public function file($path, $filename = null, $mimetype = null) * * @param mixed $object The data to encode as JSON * @param string $jsonp_prefix The name of the JSON-P function prefix - * @access public * @return Response */ public function json($object, $jsonp_prefix = null) diff --git a/src/Klein/ResponseCookie.php b/src/Klein/ResponseCookie.php index 47937e04..5e6c5bf8 100644 --- a/src/Klein/ResponseCookie.php +++ b/src/Klein/ResponseCookie.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -15,8 +15,6 @@ * ResponseCookie * * Class to represent an HTTP response cookie - * - * @package Klein */ class ResponseCookie { @@ -28,16 +26,14 @@ class ResponseCookie /** * The name of the cookie * - * @var string - * @access protected + * @type string */ protected $name; /** * The string "value" of the cookie * - * @var string - * @access protected + * @type string */ protected $value; @@ -46,8 +42,7 @@ class ResponseCookie * * Represented by a Unix "Timestamp" * - * @var int - * @access protected + * @type int */ protected $expire; @@ -55,16 +50,14 @@ class ResponseCookie * The path on the server that the cookie will * be available on * - * @var string - * @access protected + * @type string */ protected $path; /** * The domain that the cookie is available to * - * @var string - * @access protected + * @type string */ protected $domain; @@ -72,8 +65,7 @@ class ResponseCookie * Whether the cookie should only be transferred * over an HTTPS connection or not * - * @var boolean - * @access protected + * @type boolean */ protected $secure; @@ -82,8 +74,7 @@ class ResponseCookie * only (not available to be accessed through * client-side scripting languages like JavaScript) * - * @var boolean - * @access protected + * @type boolean */ protected $http_only; @@ -102,7 +93,6 @@ class ResponseCookie * @param string $domain The domain of which to restrict the cookie * @param boolean $secure Flag of whether the cookie should only be sent over a HTTPS connection * @param boolean $http_only Flag of whether the cookie should only be accessible over the HTTP protocol - * @access public */ public function __construct( $name, @@ -126,7 +116,6 @@ public function __construct( /** * Gets the cookie's name * - * @access public * @return string */ public function getName() @@ -138,7 +127,6 @@ public function getName() * Sets the cookie's name * * @param string $name - * @access public * @return ResponseCookie */ public function setName($name) @@ -151,7 +139,6 @@ public function setName($name) /** * Gets the cookie's value * - * @access public * @return string */ public function getValue() @@ -163,7 +150,6 @@ public function getValue() * Sets the cookie's value * * @param string $value - * @access public * @return ResponseCookie */ public function setValue($value) @@ -180,7 +166,6 @@ public function setValue($value) /** * Gets the cookie's expire time * - * @access public * @return int */ public function getExpire() @@ -195,7 +180,6 @@ public function getExpire() * representing a Unix timestamp * * @param int $expire - * @access public * @return ResponseCookie */ public function setExpire($expire) @@ -212,7 +196,6 @@ public function setExpire($expire) /** * Gets the cookie's path * - * @access public * @return string */ public function getPath() @@ -224,7 +207,6 @@ public function getPath() * Sets the cookie's path * * @param string $path - * @access public * @return ResponseCookie */ public function setPath($path) @@ -241,7 +223,6 @@ public function setPath($path) /** * Gets the cookie's domain * - * @access public * @return string */ public function getDomain() @@ -253,7 +234,6 @@ public function getDomain() * Sets the cookie's domain * * @param string $domain - * @access public * @return ResponseCookie */ public function setDomain($domain) @@ -270,7 +250,6 @@ public function setDomain($domain) /** * Gets the cookie's secure only flag * - * @access public * @return boolean */ public function getSecure() @@ -282,7 +261,6 @@ public function getSecure() * Sets the cookie's secure only flag * * @param boolean $secure - * @access public * @return ResponseCookie */ public function setSecure($secure) @@ -295,7 +273,6 @@ public function setSecure($secure) /** * Gets the cookie's HTTP only flag * - * @access public * @return boolean */ public function getHttpOnly() @@ -307,7 +284,6 @@ public function getHttpOnly() * Sets the cookie's HTTP only flag * * @param boolean $http_only - * @access public * @return ResponseCookie */ public function setHttpOnly($http_only) diff --git a/src/Klein/Route.php b/src/Klein/Route.php index 669836cb..6b4cd118 100644 --- a/src/Klein/Route.php +++ b/src/Klein/Route.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -17,8 +17,6 @@ * Route * * Class to represent a route definition - * - * @package Klein */ class Route { @@ -33,8 +31,7 @@ class Route * Any valid "callable" type is allowed * * @link http://php.net/manual/en/language.types.callable.php - * @var callable - * @access protected + * @type callable */ protected $callback; @@ -48,8 +45,7 @@ class Route * - '/posts/[:post_slug]' * - '/posts/[i:id]' * - * @var string - * @access protected + * @type string */ protected $path; @@ -62,16 +58,14 @@ class Route * - 'POST' * - array('GET', 'POST') * - * @var string|array - * @access protected + * @type string|array */ protected $method; /** * Whether or not to count this route as a match when counting total matches * - * @var boolean - * @access protected + * @type boolean */ protected $count_match; @@ -80,8 +74,7 @@ class Route * * Mostly used for reverse routing * - * @var string - * @access protected + * @type string */ protected $name; @@ -97,7 +90,6 @@ class Route * @param string $path * @param string|array $method * @param boolean $count_match - * @access public */ public function __construct($callback, $path = null, $method = null, $count_match = true, $name = null) { @@ -112,7 +104,6 @@ public function __construct($callback, $path = null, $method = null, $count_matc /** * Get the callback * - * @access public * @return callable */ public function getCallback() @@ -125,7 +116,6 @@ public function getCallback() * * @param callable $callback * @throws InvalidArgumentException If the callback isn't a callable - * @access public * @return Route */ public function setCallback($callback) @@ -142,7 +132,6 @@ public function setCallback($callback) /** * Get the path * - * @access public * @return string */ public function getPath() @@ -154,7 +143,6 @@ public function getPath() * Set the path * * @param string $path - * @access public * @return Route */ public function setPath($path) @@ -167,7 +155,6 @@ public function setPath($path) /** * Get the method * - * @access public * @return string|array */ public function getMethod() @@ -180,7 +167,6 @@ public function getMethod() * * @param string|array|null $method * @throws InvalidArgumentException If a non-string or non-array type is passed - * @access public * @return Route */ public function setMethod($method) @@ -198,7 +184,6 @@ public function setMethod($method) /** * Get the count_match * - * @access public * @return boolean */ public function getCountMatch() @@ -210,7 +195,6 @@ public function getCountMatch() * Set the count_match * * @param boolean $count_match - * @access public * @return Route */ public function setCountMatch($count_match) @@ -223,7 +207,6 @@ public function setCountMatch($count_match) /** * Get the name * - * @access public * @return string */ public function getName() @@ -235,7 +218,6 @@ public function getName() * Set the name * * @param string $name - * @access public * @return Route */ public function setName($name) @@ -256,7 +238,6 @@ public function setName($name) * Allows the ability to arbitrarily call this instance like a function * * @param mixed $args Generic arguments, magically accepted - * @access public * @return mixed */ public function __invoke($args = null) diff --git a/src/Klein/RouteFactory.php b/src/Klein/RouteFactory.php index 1e76d3fe..8c218bf4 100644 --- a/src/Klein/RouteFactory.php +++ b/src/Klein/RouteFactory.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -15,9 +15,6 @@ * RouteFactory * * The default implementation of the AbstractRouteFactory - * - * @uses AbstractRouteFactory - * @package Klein */ class RouteFactory extends AbstractRouteFactory { @@ -29,7 +26,7 @@ class RouteFactory extends AbstractRouteFactory /** * The value given to path's when they are entered as null values * - * @const string + * @type string */ const NULL_PATH_VALUE = '*'; @@ -42,7 +39,6 @@ class RouteFactory extends AbstractRouteFactory * Check if the path is null or equal to our match-all, null-like value * * @param mixed $path - * @access protected * @return boolean */ protected function pathIsNull($path) @@ -55,7 +51,6 @@ protected function pathIsNull($path) * as a match when counting total matches * * @param string $path - * @access protected * @return boolean */ protected function shouldPathStringCauseRouteMatch($path) @@ -72,7 +67,6 @@ protected function shouldPathStringCauseRouteMatch($path) * It also adds the namespace in a specific part, based on the style of expression * * @param string $path - * @access protected * @return string */ protected function preprocessPathString($path) @@ -126,8 +120,6 @@ protected function preprocessPathString($path) * @param string|array $method HTTP Method to match * @param boolean $count_match Whether or not to count the route as a match when counting total matches * @param string $name The name of the route - * @static - * @access public * @return Route */ public function build($callback, $path = null, $method = null, $count_match = true, $name = null) diff --git a/src/Klein/ServiceProvider.php b/src/Klein/ServiceProvider.php index 272aa0b0..0f77ff50 100644 --- a/src/Klein/ServiceProvider.php +++ b/src/Klein/ServiceProvider.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -18,8 +18,6 @@ * * Service provider class for handling logic extending between * a request's data and a response's behavior - * - * @package Klein */ class ServiceProvider { @@ -31,48 +29,42 @@ class ServiceProvider /** * The Request instance containing HTTP request data and behaviors * - * @var Request - * @access protected + * @type Request */ protected $request; /** * The Response instance containing HTTP response data and behaviors * - * @var AbstractResponse - * @access protected + * @type AbstractResponse */ protected $response; /** * The id of the current PHP session * - * @var string|boolean - * @access protected + * @type string|boolean */ protected $session_id; /** * The view layout * - * @var string - * @access protected + * @type string */ protected $layout; /** * The view to render * - * @var string - * @access protected + * @type string */ protected $view; /** * Shared data collection * - * @var \Klein\DataCollection\DataCollection - * @access protected + * @type DataCollection */ protected $shared_data; @@ -86,7 +78,6 @@ class ServiceProvider * * @param Request $request Object containing all HTTP request data and behaviors * @param AbstractResponse $response Object containing all HTTP response data and behaviors - * @access public */ public function __construct(Request $request = null, AbstractResponse $response = null) { @@ -102,7 +93,6 @@ public function __construct(Request $request = null, AbstractResponse $response * * @param Request $request Object containing all HTTP request data and behaviors * @param AbstractResponse $response Object containing all HTTP response data and behaviors - * @access public * @return ServiceProvider */ public function bind(Request $request = null, AbstractResponse $response = null) @@ -117,7 +107,6 @@ public function bind(Request $request = null, AbstractResponse $response = null) /** * Returns the shared data collection object * - * @access public * @return \Klein\DataCollection\DataCollection */ public function sharedData() @@ -130,7 +119,6 @@ public function sharedData() * * This will start a session if the current session id is null * - * @access public * @return string|false */ public function startSession() @@ -151,7 +139,6 @@ public function startSession() * @param string $msg The message to flash * @param string $type The flash message type * @param array $params Optional params to be parsed by markdown - * @access public * @return void */ public function flash($msg, $type = 'info', $params = null) @@ -173,7 +160,6 @@ public function flash($msg, $type = 'info', $params = null) * Returns and clears all flashes of optional $type * * @param string $type The name of the flash message type - * @access public * @return array */ public function flashes($type = null) @@ -208,8 +194,6 @@ public function flashes($type = null) * * @param string $str The text string to parse * @param array $args Optional arguments to be parsed by markdown - * @static - * @access public * @return string */ public static function markdown($str, $args = null) @@ -250,8 +234,6 @@ public static function markdown($str, $args = null) * * @param string $str The string to escape * @param int $flags A bitmask of `htmlentities()` compatible flags - * @static - * @access public * @return string */ public static function escape($str, $flags = ENT_QUOTES) @@ -262,7 +244,6 @@ public static function escape($str, $flags = ENT_QUOTES) /** * Redirects the request to the current URL * - * @access public * @return ServiceProvider */ public function refresh() @@ -277,7 +258,6 @@ public function refresh() /** * Redirects the request back to the referrer * - * @access public * @return ServiceProvider */ public function back() @@ -300,7 +280,6 @@ public function back() * Calling with an argument, however, sets the layout to what was provided by the argument. * * @param string $layout The layout of the view - * @access public * @return string|ServiceProvider */ public function layout($layout = null) @@ -317,7 +296,6 @@ public function layout($layout = null) /** * Renders the current view * - * @access public * @return void */ public function yieldView() @@ -330,7 +308,6 @@ public function yieldView() * * @param string $view The view to render * @param array $data The data to render in the view - * @access public * @return void */ public function render($view, array $data = array()) @@ -362,7 +339,6 @@ public function render($view, array $data = array()) * * @param string $view The view to render * @param array $data The data to render in the view - * @access public * @return void */ public function partial($view, array $data = array()) @@ -378,7 +354,6 @@ public function partial($view, array $data = array()) * * @param string $method The name of the validator method * @param callable $callback The callback to perform on validation - * @access public * @return void */ public function addValidator($method, $callback) @@ -391,7 +366,6 @@ public function addValidator($method, $callback) * * @param string $string The string to validate * @param string $err The custom exception message to throw - * @access public * @return Validator */ public function validate($string, $err = null) @@ -404,7 +378,6 @@ public function validate($string, $err = null) * * @param string $param The name of the parameter to validate * @param string $err The custom exception message to throw - * @access public * @return Validator */ public function validateParam($param, $err = null) @@ -420,7 +393,6 @@ public function validateParam($param, $err = null) * from this instance while treating it as an instance property * * @param string $key The name of the shared data - * @access public * @return boolean */ public function __isset($key) @@ -435,7 +407,6 @@ public function __isset($key) * while treating it as an instance property * * @param string $key The name of the shared data - * @access public * @return string */ public function __get($key) @@ -451,7 +422,6 @@ public function __get($key) * * @param string $key The name of the shared data * @param mixed $value The value of the shared data - * @access public * @return void */ public function __set($key, $value) @@ -466,7 +436,6 @@ public function __set($key, $value) * while treating it as an instance property * * @param string $key The name of the shared data - * @access public * @return void */ public function __unset($key) diff --git a/src/Klein/Validator.php b/src/Klein/Validator.php index dabe8a1f..58c1641c 100644 --- a/src/Klein/Validator.php +++ b/src/Klein/Validator.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -16,8 +16,6 @@ /** * Validator - * - * @package Klein */ class Validator { @@ -29,34 +27,28 @@ class Validator /** * The available validator methods * - * @static - * @var array - * @access protected + * @type array */ public static $methods = array(); /** * The string to validate * - * @var string - * @access protected + * @type string */ protected $str; /** * The custom exception message to throw on validation failure * - * @var string - * @access protected + * @type string */ protected $err; /** * Flag for whether the default validation methods have been added or not * - * @static - * @var boolean - * @access protected + * @type boolean */ protected static $defaultAdded = false; @@ -70,7 +62,6 @@ class Validator * * @param string $str The string to validate * @param string $err The optional custom exception message to throw on validation failure - * @access public */ public function __construct($str, $err = null) { @@ -85,8 +76,6 @@ public function __construct($str, $err = null) /** * Adds default validators on first use * - * @static - * @access public * @return void */ public static function addDefault() @@ -140,8 +129,6 @@ public static function addDefault() * * @param string $method The name of the validator method * @param callable $callback The callback to perform on validation - * @static - * @access public * @return void */ public static function addValidator($method, $callback) @@ -159,7 +146,6 @@ public static function addValidator($method, $callback) * @param array $args The argument array to pass to our callback * @throws BadMethodCallException If an attempt was made to call a validator modifier that doesn't exist * @throws ValidationException If the validation check returns false - * @access public * @return Validator|boolean */ public function __call($method, $args) diff --git a/tests/Klein/Tests/AbstractKleinTest.php b/tests/Klein/Tests/AbstractKleinTest.php index a2d6be8b..40cbbe2c 100644 --- a/tests/Klein/Tests/AbstractKleinTest.php +++ b/tests/Klein/Tests/AbstractKleinTest.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -21,10 +21,6 @@ * AbstractKleinTest * * Base test class for PHP Unit testing - * - * @uses PHPUnit_Framework_TestCase - * @abstract - * @package Klein\Tests */ abstract class AbstractKleinTest extends PHPUnit_Framework_TestCase { @@ -33,8 +29,7 @@ abstract class AbstractKleinTest extends PHPUnit_Framework_TestCase * The automatically created test Klein instance * (for easy testing and less boilerplate) * - * @var \Klein\Klein; - * @access protected + * @type Klein */ protected $klein_app; @@ -43,7 +38,6 @@ abstract class AbstractKleinTest extends PHPUnit_Framework_TestCase * Setup our test * (runs before each test) * - * @access protected * @return void */ protected function setUp() @@ -61,7 +55,6 @@ protected function setUp() * * @param Request $request Custom Klein "Request" object * @param Response $response Custom Klein "Response" object - * @access protected * @return mixed The output of the dispatch call */ protected function dispatchAndReturnOutput($request = null, $response = null) @@ -81,7 +74,6 @@ protected function dispatchAndReturnOutput($request = null, $response = null) * @param mixed $expected The expected output * @param callable $callback The callable function * @param string $message (optional) A message to display if the assertion fails - * @access protected * @return void */ protected function assertOutputSame($expected, $callback, $message = '') @@ -105,7 +97,6 @@ protected function assertOutputSame($expected, $callback, $message = '') * Loads externally defined routes under the filename's namespace * * @param Klein $app_context The application context to attach the routes to - * @access protected * @return array */ protected function loadExternalRoutes(Klein $app_context = null) diff --git a/tests/Klein/Tests/AbstractRouteFactoryTest.php b/tests/Klein/Tests/AbstractRouteFactoryTest.php index 64f68f77..96dafd4b 100644 --- a/tests/Klein/Tests/AbstractRouteFactoryTest.php +++ b/tests/Klein/Tests/AbstractRouteFactoryTest.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -16,9 +16,6 @@ /** * AbstractRouteFactoryTest - * - * @uses AbstractKleinTest - * @package Klein\Tests */ class AbstractRouteFactoryTest extends AbstractKleinTest { diff --git a/tests/Klein/Tests/AppTest.php b/tests/Klein/Tests/AppTest.php index 1e3ac243..8acf1a75 100644 --- a/tests/Klein/Tests/AppTest.php +++ b/tests/Klein/Tests/AppTest.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -15,9 +15,6 @@ /** * AppTest - * - * @uses AbstractKleinTest - * @package Klein\Tests */ class AppTest extends AbstractKleinTest { diff --git a/tests/Klein/Tests/DataCollection/DataCollectionTest.php b/tests/Klein/Tests/DataCollection/DataCollectionTest.php index 1a97714f..cce6498e 100644 --- a/tests/Klein/Tests/DataCollection/DataCollectionTest.php +++ b/tests/Klein/Tests/DataCollection/DataCollectionTest.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -17,9 +17,6 @@ /** * DataCollectionTest - * - * @uses AbstractKleinTest - * @package Klein\Tests\DataCollection */ class DataCollectionTest extends AbstractKleinTest { @@ -27,9 +24,7 @@ class DataCollectionTest extends AbstractKleinTest /** * Non existent key in the sample data * - * @static - * @var string - * @access protected + * @type string */ protected static $nonexistent_key = 'key-name-doesnt-exist'; @@ -43,7 +38,6 @@ class DataCollectionTest extends AbstractKleinTest * have any keys that match the "nonexistent_key" * * @param array $sample_data - * @access protected * @return void */ protected function prepareSampleData(&$sample_data) @@ -62,7 +56,6 @@ protected function prepareSampleData(&$sample_data) /** * Sample data provider * - * @access public * @return array */ public function sampleDataProvider() @@ -90,7 +83,6 @@ public function sampleDataProvider() /** * Totally different sample data provider * - * @access public * @return array */ public function totallyDifferentSampleDataProvider() diff --git a/tests/Klein/Tests/DataCollection/HeaderDataCollectionTest.php b/tests/Klein/Tests/DataCollection/HeaderDataCollectionTest.php index 63c6bbe8..4d784919 100644 --- a/tests/Klein/Tests/DataCollection/HeaderDataCollectionTest.php +++ b/tests/Klein/Tests/DataCollection/HeaderDataCollectionTest.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -16,9 +16,6 @@ /** * HeaderDataCollectionTest - * - * @uses AbstractKleinTest - * @package Klein\Tests\DataCollection */ class HeaderDataCollectionTest extends AbstractKleinTest { @@ -26,9 +23,7 @@ class HeaderDataCollectionTest extends AbstractKleinTest /** * Non existent key in the sample data * - * @static - * @var string - * @access protected + * @type string */ protected static $nonexistent_key = 'non-standard-header'; @@ -42,7 +37,6 @@ class HeaderDataCollectionTest extends AbstractKleinTest * have any keys that match the "nonexistent_key" * * @param array $sample_data - * @access protected * @return void */ protected function prepareSampleData(&$sample_data) @@ -61,7 +55,6 @@ protected function prepareSampleData(&$sample_data) /** * Sample data provider * - * @access public * @return array */ public function sampleDataProvider() diff --git a/tests/Klein/Tests/DataCollection/ResponseCookieDataCollectionTest.php b/tests/Klein/Tests/DataCollection/ResponseCookieDataCollectionTest.php index 099d5513..41bad67f 100644 --- a/tests/Klein/Tests/DataCollection/ResponseCookieDataCollectionTest.php +++ b/tests/Klein/Tests/DataCollection/ResponseCookieDataCollectionTest.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -17,9 +17,6 @@ /** * ResponseCookieDataCollectionTest - * - * @uses AbstractKleinTest - * @package Klein\Tests\DataCollection */ class ResponseCookieDataCollectionTest extends AbstractKleinTest { @@ -31,7 +28,6 @@ class ResponseCookieDataCollectionTest extends AbstractKleinTest /** * Sample data provider * - * @access public * @return array */ public function sampleDataProvider() diff --git a/tests/Klein/Tests/DataCollection/RouteCollectionTest.php b/tests/Klein/Tests/DataCollection/RouteCollectionTest.php index e97460ba..83135516 100644 --- a/tests/Klein/Tests/DataCollection/RouteCollectionTest.php +++ b/tests/Klein/Tests/DataCollection/RouteCollectionTest.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -17,9 +17,6 @@ /** * RouteCollectionTest - * - * @uses AbstractKleinTest - * @package Klein\Tests\DataCollection */ class RouteCollectionTest extends AbstractKleinTest { @@ -31,7 +28,6 @@ class RouteCollectionTest extends AbstractKleinTest /** * Sample data provider * - * @access public * @return array */ public function sampleDataProvider() diff --git a/tests/Klein/Tests/DataCollection/ServerDataCollectionTest.php b/tests/Klein/Tests/DataCollection/ServerDataCollectionTest.php index 97a278fc..d058333b 100644 --- a/tests/Klein/Tests/DataCollection/ServerDataCollectionTest.php +++ b/tests/Klein/Tests/DataCollection/ServerDataCollectionTest.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -16,9 +16,6 @@ /** * ServerDataCollectionTest - * - * @uses AbstractKleinTest - * @package Klein\Tests\DataCollection */ class ServerDataCollectionTest extends AbstractKleinTest { @@ -30,7 +27,6 @@ class ServerDataCollectionTest extends AbstractKleinTest /** * Sample data provider * - * @access public * @return array */ public function sampleDataProvider() diff --git a/tests/Klein/Tests/HttpStatusTest.php b/tests/Klein/Tests/HttpStatusTest.php index 4847f946..985232f0 100644 --- a/tests/Klein/Tests/HttpStatusTest.php +++ b/tests/Klein/Tests/HttpStatusTest.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -15,9 +15,6 @@ /** * HttpStatusTests - * - * @uses AbstractKleinTest - * @package Klein\Tests */ class HttpStatusTests extends AbstractKleinTest { diff --git a/tests/Klein/Tests/KleinTest.php b/tests/Klein/Tests/KleinTest.php index 837d8896..5a27c63e 100644 --- a/tests/Klein/Tests/KleinTest.php +++ b/tests/Klein/Tests/KleinTest.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -26,9 +26,6 @@ /** * KleinTest - * - * @uses AbstractKleinTest - * @package Klein\Tests */ class KleinTest extends AbstractKleinTest { diff --git a/tests/Klein/Tests/Mocks/MockRequestFactory.php b/tests/Klein/Tests/Mocks/MockRequestFactory.php index 49a8aaaa..0845c983 100644 --- a/tests/Klein/Tests/Mocks/MockRequestFactory.php +++ b/tests/Klein/Tests/Mocks/MockRequestFactory.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -18,8 +18,6 @@ * * Allow for the simple creation of mock requests * (great for testing... ;)) - * - * @package Klein\Tests\Mocks */ class MockRequestFactory { @@ -34,8 +32,6 @@ class MockRequestFactory * @param array $server * @param array $files * @param string $body - * @static - * @access public * @return void */ public static function create( diff --git a/tests/Klein/Tests/Mocks/TestClass.php b/tests/Klein/Tests/Mocks/TestClass.php index 3f8c8c15..dd880552 100644 --- a/tests/Klein/Tests/Mocks/TestClass.php +++ b/tests/Klein/Tests/Mocks/TestClass.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) diff --git a/tests/Klein/Tests/RequestTest.php b/tests/Klein/Tests/RequestTest.php index 0e1fab6c..125c7444 100644 --- a/tests/Klein/Tests/RequestTest.php +++ b/tests/Klein/Tests/RequestTest.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -16,9 +16,6 @@ /** * RequestTest - * - * @uses AbstractKleinTest - * @package Klein\Tests */ class RequestTest extends AbstractKleinTest { diff --git a/tests/Klein/Tests/ResponseCookieTest.php b/tests/Klein/Tests/ResponseCookieTest.php index 35995aca..2eef31b5 100644 --- a/tests/Klein/Tests/ResponseCookieTest.php +++ b/tests/Klein/Tests/ResponseCookieTest.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -15,9 +15,6 @@ /** * ResponseCookieTest - * - * @uses AbstractKleinTest - * @package Klein\Tests */ class ResponseCookieTest extends AbstractKleinTest { @@ -29,7 +26,6 @@ class ResponseCookieTest extends AbstractKleinTest /** * Sample data provider * - * @access public * @return array */ public function sampleDataProvider() diff --git a/tests/Klein/Tests/ResponseTest.php b/tests/Klein/Tests/ResponseTest.php index f46f89e5..9301260c 100644 --- a/tests/Klein/Tests/ResponseTest.php +++ b/tests/Klein/Tests/ResponseTest.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -22,9 +22,6 @@ /** * ResponsesTest - * - * @uses AbstractKleinTest - * @package Klein\Tests */ class ResponsesTest extends AbstractKleinTest { diff --git a/tests/Klein/Tests/RouteFactoryTest.php b/tests/Klein/Tests/RouteFactoryTest.php index 48cb46d9..dbf419e1 100644 --- a/tests/Klein/Tests/RouteFactoryTest.php +++ b/tests/Klein/Tests/RouteFactoryTest.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -16,9 +16,6 @@ /** * RouteFactoryTest - * - * @uses AbstractKleinTest - * @package Klein\Tests */ class RouteFactoryTest extends AbstractKleinTest { diff --git a/tests/Klein/Tests/RouteTest.php b/tests/Klein/Tests/RouteTest.php index 1b61985e..2165ded9 100644 --- a/tests/Klein/Tests/RouteTest.php +++ b/tests/Klein/Tests/RouteTest.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -17,9 +17,6 @@ /** * RouteTest - * - * @uses AbstractKleinTest - * @package Klein\Tests */ class RouteTest extends AbstractKleinTest { diff --git a/tests/Klein/Tests/RoutingTest.php b/tests/Klein/Tests/RoutingTest.php index 0e288d95..5445ba78 100644 --- a/tests/Klein/Tests/RoutingTest.php +++ b/tests/Klein/Tests/RoutingTest.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -27,9 +27,6 @@ /** * RoutingTest - * - * @uses AbstractKleinTest - * @package Klein\Tests */ class RoutingTest extends AbstractKleinTest { diff --git a/tests/Klein/Tests/ServiceProviderTest.php b/tests/Klein/Tests/ServiceProviderTest.php index cc40cdf6..bbf895d4 100644 --- a/tests/Klein/Tests/ServiceProviderTest.php +++ b/tests/Klein/Tests/ServiceProviderTest.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -20,9 +20,6 @@ /** * ServiceProviderTest - * - * @uses AbstractKleinTest - * @package Klein\Tests */ class ServiceProviderTest extends AbstractKleinTest { diff --git a/tests/Klein/Tests/ValidationsTest.php b/tests/Klein/Tests/ValidationsTest.php index 311d5666..b64cfc9e 100644 --- a/tests/Klein/Tests/ValidationsTest.php +++ b/tests/Klein/Tests/ValidationsTest.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) @@ -20,9 +20,6 @@ /** * ValidationsTest - * - * @uses AbstractKleinTest - * @package Klein\Tests */ class ValidationsTest extends AbstractKleinTest { diff --git a/tests/bootstrap.php b/tests/bootstrap.php index 6aa65da3..1ca70e71 100644 --- a/tests/bootstrap.php +++ b/tests/bootstrap.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer) diff --git a/tests/functions-bootstrap.php b/tests/functions-bootstrap.php index 45c04859..a5fa65c1 100644 --- a/tests/functions-bootstrap.php +++ b/tests/functions-bootstrap.php @@ -1,6 +1,6 @@ * @author Trevor Suarez (Rican7) (contributor and v2 refactorer)