From ac86f057974385aab16a788a5e8be7fadb90a384 Mon Sep 17 00:00:00 2001 From: Cody Lundquist Date: Thu, 25 Jul 2013 14:14:55 +1000 Subject: [PATCH] Fixing PhpDoc errors. --- src/Munee/Asset/Filter.php | 4 ++++ src/Munee/Asset/Filter/Css/Minify.php | 2 ++ src/Munee/Asset/Filter/Image/Colorize.php | 2 ++ src/Munee/Asset/Filter/Image/Grayscale.php | 2 ++ src/Munee/Asset/Filter/Image/Negative.php | 2 ++ src/Munee/Asset/Filter/Image/Resize.php | 2 ++ src/Munee/Asset/Filter/JavaScript/Minify.php | 2 ++ src/Munee/Asset/Filter/JavaScript/Packer.php | 8 ++++++-- src/Munee/Asset/NotFoundException.php | 5 +++++ src/Munee/Asset/Type.php | 19 ++++++++++++++----- src/Munee/Asset/Type/Css.php | 2 ++ src/Munee/Asset/Type/Image.php | 10 ++++++++++ src/Munee/ErrorException.php | 5 +++++ src/Munee/Request.php | 16 ++++++++++++++++ src/Munee/Response.php | 10 ++++++++-- 15 files changed, 82 insertions(+), 9 deletions(-) diff --git a/src/Munee/Asset/Filter.php b/src/Munee/Asset/Filter.php index 2f0f38d..ebcfb56 100644 --- a/src/Munee/Asset/Filter.php +++ b/src/Munee/Asset/Filter.php @@ -16,11 +16,15 @@ abstract class Filter { /** + * List of allowed params for a particular filter + * * @var array */ protected $allowedParams = array(); /** + * Getter for $allowedParams + * * @return array */ public function getAllowedParams() diff --git a/src/Munee/Asset/Filter/Css/Minify.php b/src/Munee/Asset/Filter/Css/Minify.php index 9e3aaad..72c6225 100644 --- a/src/Munee/Asset/Filter/Css/Minify.php +++ b/src/Munee/Asset/Filter/Css/Minify.php @@ -19,6 +19,8 @@ class Minify extends Filter { /** + * List of allowed params for this particular filter + * * @var array */ protected $allowedParams = array( diff --git a/src/Munee/Asset/Filter/Image/Colorize.php b/src/Munee/Asset/Filter/Image/Colorize.php index f4e6580..a88ee08 100644 --- a/src/Munee/Asset/Filter/Image/Colorize.php +++ b/src/Munee/Asset/Filter/Image/Colorize.php @@ -20,6 +20,8 @@ class Colorize extends Filter { /** + * List of allowed params for this particular filter + * * @var array */ protected $allowedParams = array( diff --git a/src/Munee/Asset/Filter/Image/Grayscale.php b/src/Munee/Asset/Filter/Image/Grayscale.php index 6299df6..aa100eb 100644 --- a/src/Munee/Asset/Filter/Image/Grayscale.php +++ b/src/Munee/Asset/Filter/Image/Grayscale.php @@ -19,6 +19,8 @@ class Grayscale extends Filter { /** + * List of allowed params for this particular filter + * * @var array */ protected $allowedParams = array( diff --git a/src/Munee/Asset/Filter/Image/Negative.php b/src/Munee/Asset/Filter/Image/Negative.php index bee6fae..fad2163 100644 --- a/src/Munee/Asset/Filter/Image/Negative.php +++ b/src/Munee/Asset/Filter/Image/Negative.php @@ -19,6 +19,8 @@ class Negative extends Filter { /** + * List of allowed params for this particular filter + * * @var array */ protected $allowedParams = array( diff --git a/src/Munee/Asset/Filter/Image/Resize.php b/src/Munee/Asset/Filter/Image/Resize.php index d209ebb..6c78bbc 100644 --- a/src/Munee/Asset/Filter/Image/Resize.php +++ b/src/Munee/Asset/Filter/Image/Resize.php @@ -23,6 +23,8 @@ class Resize extends Filter { /** + * List of allowed params for this particular filter + * * @var array */ protected $allowedParams = array( diff --git a/src/Munee/Asset/Filter/JavaScript/Minify.php b/src/Munee/Asset/Filter/JavaScript/Minify.php index 98078de..6e6ef3a 100644 --- a/src/Munee/Asset/Filter/JavaScript/Minify.php +++ b/src/Munee/Asset/Filter/JavaScript/Minify.php @@ -19,6 +19,8 @@ class Minify extends Filter { /** + * List of allowed params for this particular filter + * * @var array */ protected $allowedParams = array( diff --git a/src/Munee/Asset/Filter/JavaScript/Packer.php b/src/Munee/Asset/Filter/JavaScript/Packer.php index c9254d8..4be62eb 100644 --- a/src/Munee/Asset/Filter/JavaScript/Packer.php +++ b/src/Munee/Asset/Filter/JavaScript/Packer.php @@ -19,6 +19,8 @@ class Packer extends Filter { /** + * List of allowed params for this particular filter + * * @var array */ protected $allowedParams = array( @@ -30,9 +32,11 @@ class Packer extends Filter ); /** + * Default options for the Packer library + * * @var array */ - protected $_defaultOptions = array( + protected $_defaultPackerOptions = array( 'encoding' => 62, 'fastDecode' => true, 'specialChars' => false @@ -50,7 +54,7 @@ class Packer extends Filter public function doFilter($file, $arguments, $javaScriptOptions) { $userOptions = isset($javaScriptOptions['packer']) ? $javaScriptOptions['packer'] : array(); - $options = array_merge($this->_defaultOptions, $userOptions); + $options = array_merge($this->_defaultPackerOptions, $userOptions); if (! $arguments['packer']) { return; diff --git a/src/Munee/Asset/NotFoundException.php b/src/Munee/Asset/NotFoundException.php index e22a2f7..955ebdd 100644 --- a/src/Munee/Asset/NotFoundException.php +++ b/src/Munee/Asset/NotFoundException.php @@ -10,4 +10,9 @@ use Munee\ErrorException; +/** + * Class NotFoundException + * + * @author Cody Lundquist + */ class NotFoundException extends ErrorException {} \ No newline at end of file diff --git a/src/Munee/Asset/Type.php b/src/Munee/Asset/Type.php index fcfc66d..35f97f2 100644 --- a/src/Munee/Asset/Type.php +++ b/src/Munee/Asset/Type.php @@ -23,41 +23,50 @@ abstract class Type { /** + * Stores the Request Options for the Asset Type + * * @var array */ protected $options = array(); /** - * @var array - */ - protected $params = array(); - - /** + * Stores the list of filters that will be applied to the requested asset. + * * @var array */ protected $filters = array(); /** + * Stores the path to the cache directory + * * @var string */ protected $cacheDir; /** + * Stores the last modified date (Epoch) for the requested asset + * * @var integer */ protected $lastModifiedDate = 0; /** + * Stores the content of the asset + * * @var string */ protected $content; /** + * Reference to the \Munee\Request class + * * @var \Munee\Request */ protected $request; /** + * Reference to the \Munee\Response class + * * @var \Munee\Response */ protected $response; diff --git a/src/Munee/Asset/Type/Css.php b/src/Munee/Asset/Type/Css.php index 0503cbd..eafd5e8 100644 --- a/src/Munee/Asset/Type/Css.php +++ b/src/Munee/Asset/Type/Css.php @@ -22,6 +22,8 @@ class Css extends Type { /** + * Stores the Request options for this Asset Type + * * @var array */ protected $options = array( diff --git a/src/Munee/Asset/Type/Image.php b/src/Munee/Asset/Type/Image.php index e9257f6..75a6fed 100644 --- a/src/Munee/Asset/Type/Image.php +++ b/src/Munee/Asset/Type/Image.php @@ -20,6 +20,8 @@ class Image extends Type { /** + * Stores the Request options for this Asset Type + * * @var array */ protected $options = array( @@ -42,6 +44,11 @@ class Image extends Type 'imageProcessor' => 'GD' ); + /** + * Stores the specific placeholder that will be used for this requested asset, if any. + * + * @var bool + */ protected $placeholder = false; /** @@ -165,6 +172,9 @@ protected function checkNumberOfAllowedFilters($checkImage) } /** + * Checks the 'placeholders' Request Option to see if placeholders should be used for missing images + * It uses a wildcard syntax (*) to see which placeholder should be used for a particular set of images. + * * @param string $file * * @return boolean|string diff --git a/src/Munee/ErrorException.php b/src/Munee/ErrorException.php index 85bcc4f..cc38ceb 100644 --- a/src/Munee/ErrorException.php +++ b/src/Munee/ErrorException.php @@ -8,4 +8,9 @@ namespace Munee; +/** + * Class ErrorException + * + * @author Cody Lundquist + */ class ErrorException extends \Exception {} \ No newline at end of file diff --git a/src/Munee/Request.php b/src/Munee/Request.php index e9201f2..546e34f 100644 --- a/src/Munee/Request.php +++ b/src/Munee/Request.php @@ -19,41 +19,57 @@ class Request { /** + * Stores the path to Webroot + * * @var string */ public $webroot = WEBROOT; /** + * Stores the file extension of the current request + * * @var string */ public $ext; /** + * Stores the array of passed in parameters + * * @var array */ public $params = array(); /** + * Stores the array of files passed in + * * @var array */ public $files = array(); /** + * Stores the array of Request Options + * * @var array */ public $options = array(); /** + * Stores the array of Raw $_GET parameters + * * @var array */ protected $rawParams = array(); /** + * Stores the array of allowed parameters for the particular asset being processed + * * @var array */ protected $allowedParams = array(); /** + * Stores the string of raw files passed in from $_GET + * * @var string */ protected $rawFiles; diff --git a/src/Munee/Response.php b/src/Munee/Response.php index 97e6bd1..244a162 100644 --- a/src/Munee/Response.php +++ b/src/Munee/Response.php @@ -16,17 +16,23 @@ class Response { /** + * Used to check if the request is Not Modified so Munee can return 304 if that is the case + * * @var boolean */ public $notModified = false; /** - * @var object + * Instance of a Asset\HeaderSetter class + * + * @var Asset\HeaderSetter */ public $headerController; /** - * @var Object + * Instance of a Asset\Type dynamically instantiated in the Constructor + * + * @var Asset\Type */ protected $assetType;