@@ -21,25 +21,25 @@ discard block |
||
| 21 | 21 | */ |
| 22 | 22 | class XMLHelper_Converter_Decorator implements \JsonSerializable |
| 23 | 23 | { |
| 24 | - /** |
|
| 25 | - * @var \SimpleXMLElement |
|
| 26 | - */ |
|
| 24 | + /** |
|
| 25 | + * @var \SimpleXMLElement |
|
| 26 | + */ |
|
| 27 | 27 | private $subject; |
| 28 | 28 | |
| 29 | 29 | const DEF_DEPTH = 512; |
| 30 | 30 | |
| 31 | - /** |
|
| 32 | - * @var array |
|
| 33 | - */ |
|
| 31 | + /** |
|
| 32 | + * @var array |
|
| 33 | + */ |
|
| 34 | 34 | private $options = array( |
| 35 | 35 | '@attributes' => true, |
| 36 | 36 | '@text' => true, |
| 37 | 37 | 'depth' => self::DEF_DEPTH |
| 38 | 38 | ); |
| 39 | 39 | |
| 40 | - /** |
|
| 41 | - * @var array|string|null |
|
| 42 | - */ |
|
| 40 | + /** |
|
| 41 | + * @var array|string|null |
|
| 42 | + */ |
|
| 43 | 43 | protected $result = array(); |
| 44 | 44 | |
| 45 | 45 | public function __construct(\SimpleXMLElement $element) |
@@ -47,36 +47,36 @@ discard block |
||
| 47 | 47 | $this->subject = $element; |
| 48 | 48 | } |
| 49 | 49 | |
| 50 | - /** |
|
| 51 | - * Whether to use the `@attributes` key to store element attributes. |
|
| 52 | - * |
|
| 53 | - * @param bool $bool |
|
| 54 | - * @return XMLHelper_Converter_Decorator |
|
| 55 | - */ |
|
| 50 | + /** |
|
| 51 | + * Whether to use the `@attributes` key to store element attributes. |
|
| 52 | + * |
|
| 53 | + * @param bool $bool |
|
| 54 | + * @return XMLHelper_Converter_Decorator |
|
| 55 | + */ |
|
| 56 | 56 | public function useAttributes(bool $bool) : XMLHelper_Converter_Decorator |
| 57 | 57 | { |
| 58 | 58 | $this->options['@attributes'] = (bool)$bool; |
| 59 | 59 | return $this; |
| 60 | 60 | } |
| 61 | 61 | |
| 62 | - /** |
|
| 63 | - * Whether to use the `@text` key to store the node text. |
|
| 64 | - * |
|
| 65 | - * @param bool $bool |
|
| 66 | - * @return XMLHelper_Converter_Decorator |
|
| 67 | - */ |
|
| 62 | + /** |
|
| 63 | + * Whether to use the `@text` key to store the node text. |
|
| 64 | + * |
|
| 65 | + * @param bool $bool |
|
| 66 | + * @return XMLHelper_Converter_Decorator |
|
| 67 | + */ |
|
| 68 | 68 | public function useText(bool $bool) : XMLHelper_Converter_Decorator |
| 69 | 69 | { |
| 70 | 70 | $this->options['@text'] = (bool)$bool; |
| 71 | 71 | return $this; |
| 72 | 72 | } |
| 73 | 73 | |
| 74 | - /** |
|
| 75 | - * Set the maximum depth to parse in the document. |
|
| 76 | - * |
|
| 77 | - * @param int $depth |
|
| 78 | - * @return XMLHelper_Converter_Decorator |
|
| 79 | - */ |
|
| 74 | + /** |
|
| 75 | + * Set the maximum depth to parse in the document. |
|
| 76 | + * |
|
| 77 | + * @param int $depth |
|
| 78 | + * @return XMLHelper_Converter_Decorator |
|
| 79 | + */ |
|
| 80 | 80 | public function setDepth(int $depth) : XMLHelper_Converter_Decorator |
| 81 | 81 | { |
| 82 | 82 | $this->options['depth'] = (int)max(0, $depth); |
@@ -23,44 +23,44 @@ |
||
| 23 | 23 | */ |
| 24 | 24 | class Request_URLComparer |
| 25 | 25 | { |
| 26 | - /** |
|
| 27 | - * @var Request |
|
| 28 | - */ |
|
| 26 | + /** |
|
| 27 | + * @var Request |
|
| 28 | + */ |
|
| 29 | 29 | protected $request; |
| 30 | 30 | |
| 31 | - /** |
|
| 32 | - * @var string |
|
| 33 | - */ |
|
| 31 | + /** |
|
| 32 | + * @var string |
|
| 33 | + */ |
|
| 34 | 34 | protected $sourceURL; |
| 35 | 35 | |
| 36 | - /** |
|
| 37 | - * @var string |
|
| 38 | - */ |
|
| 36 | + /** |
|
| 37 | + * @var string |
|
| 38 | + */ |
|
| 39 | 39 | protected $targetURL; |
| 40 | 40 | |
| 41 | - /** |
|
| 42 | - * @var array |
|
| 43 | - */ |
|
| 41 | + /** |
|
| 42 | + * @var array |
|
| 43 | + */ |
|
| 44 | 44 | protected $limitParams = array(); |
| 45 | 45 | |
| 46 | - /** |
|
| 47 | - * @var bool |
|
| 48 | - */ |
|
| 46 | + /** |
|
| 47 | + * @var bool |
|
| 48 | + */ |
|
| 49 | 49 | protected $isMatch = false; |
| 50 | 50 | |
| 51 | - /** |
|
| 52 | - * @var bool |
|
| 53 | - */ |
|
| 51 | + /** |
|
| 52 | + * @var bool |
|
| 53 | + */ |
|
| 54 | 54 | protected $ignoreFragment = true; |
| 55 | 55 | |
| 56 | - /** |
|
| 57 | - * @var URLInfo |
|
| 58 | - */ |
|
| 56 | + /** |
|
| 57 | + * @var URLInfo |
|
| 58 | + */ |
|
| 59 | 59 | protected $sourceInfo; |
| 60 | 60 | |
| 61 | - /** |
|
| 62 | - * @var URLInfo |
|
| 63 | - */ |
|
| 61 | + /** |
|
| 62 | + * @var URLInfo |
|
| 63 | + */ |
|
| 64 | 64 | protected $targetInfo; |
| 65 | 65 | |
| 66 | 66 | public function __construct(Request $request, string $sourceURL, string $targetURL) |
@@ -22,9 +22,9 @@ discard block |
||
| 22 | 22 | */ |
| 23 | 23 | class RequestHelper_Exception extends BaseException |
| 24 | 24 | { |
| 25 | - /** |
|
| 26 | - * @var RequestHelper_Response|NULL |
|
| 27 | - */ |
|
| 25 | + /** |
|
| 26 | + * @var RequestHelper_Response|NULL |
|
| 27 | + */ |
|
| 28 | 28 | protected $response = null; |
| 29 | 29 | |
| 30 | 30 | public function setResponse(RequestHelper_Response $response) |
@@ -32,11 +32,11 @@ discard block |
||
| 32 | 32 | $this->response = $response; |
| 33 | 33 | } |
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * Retrieves the related response instance, if available. |
|
| 37 | - * |
|
| 38 | - * @return RequestHelper_Response|NULL |
|
| 39 | - */ |
|
| 35 | + /** |
|
| 36 | + * Retrieves the related response instance, if available. |
|
| 37 | + * |
|
| 38 | + * @return RequestHelper_Response|NULL |
|
| 39 | + */ |
|
| 40 | 40 | public function getResponse() : ?RequestHelper_Response |
| 41 | 41 | { |
| 42 | 42 | return $this->response; |
@@ -32,23 +32,23 @@ |
||
| 32 | 32 | $this->info = $info; |
| 33 | 33 | } |
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * Enables the authentication information in the URL, |
|
| 37 | - * if a username and password are present. |
|
| 38 | - * |
|
| 39 | - * @param bool $enable Whether to turn it on or off. |
|
| 40 | - * @return URLInfo_Normalizer |
|
| 41 | - */ |
|
| 35 | + /** |
|
| 36 | + * Enables the authentication information in the URL, |
|
| 37 | + * if a username and password are present. |
|
| 38 | + * |
|
| 39 | + * @param bool $enable Whether to turn it on or off. |
|
| 40 | + * @return URLInfo_Normalizer |
|
| 41 | + */ |
|
| 42 | 42 | public function enableAuth(bool $enable=true) : URLInfo_Normalizer |
| 43 | 43 | { |
| 44 | 44 | $this->auth = $enable; |
| 45 | 45 | return $this; |
| 46 | 46 | } |
| 47 | 47 | |
| 48 | - /** |
|
| 49 | - * Retrieves the normalized URL. |
|
| 50 | - * @return string |
|
| 51 | - */ |
|
| 48 | + /** |
|
| 49 | + * Retrieves the normalized URL. |
|
| 50 | + * @return string |
|
| 51 | + */ |
|
| 52 | 52 | public function normalize() : string |
| 53 | 53 | { |
| 54 | 54 | $method = 'normalize_'.$this->info->getType(); |
@@ -20,43 +20,43 @@ discard block |
||
| 20 | 20 | */ |
| 21 | 21 | class ConvertHelper_TabsNormalizer |
| 22 | 22 | { |
| 23 | - /** |
|
| 24 | - * @var integer |
|
| 25 | - */ |
|
| 23 | + /** |
|
| 24 | + * @var integer |
|
| 25 | + */ |
|
| 26 | 26 | protected $max = 0; |
| 27 | 27 | |
| 28 | - /** |
|
| 29 | - * @var integer |
|
| 30 | - */ |
|
| 28 | + /** |
|
| 29 | + * @var integer |
|
| 30 | + */ |
|
| 31 | 31 | protected $min = PHP_INT_MAX; |
| 32 | 32 | |
| 33 | - /** |
|
| 34 | - * @var bool |
|
| 35 | - */ |
|
| 33 | + /** |
|
| 34 | + * @var bool |
|
| 35 | + */ |
|
| 36 | 36 | protected $tabs2spaces = false; |
| 37 | 37 | |
| 38 | - /** |
|
| 39 | - * @var array |
|
| 40 | - */ |
|
| 38 | + /** |
|
| 39 | + * @var array |
|
| 40 | + */ |
|
| 41 | 41 | protected $lines = array(); |
| 42 | 42 | |
| 43 | - /** |
|
| 44 | - * @var string |
|
| 45 | - */ |
|
| 43 | + /** |
|
| 44 | + * @var string |
|
| 45 | + */ |
|
| 46 | 46 | protected $eol = ''; |
| 47 | 47 | |
| 48 | - /** |
|
| 49 | - * @var integer |
|
| 50 | - */ |
|
| 48 | + /** |
|
| 49 | + * @var integer |
|
| 50 | + */ |
|
| 51 | 51 | protected $tabSize = 4; |
| 52 | 52 | |
| 53 | - /** |
|
| 54 | - * Whether to enable or disable the conversion |
|
| 55 | - * of tabs to spaces. |
|
| 56 | - * |
|
| 57 | - * @param bool $enable |
|
| 58 | - * @return ConvertHelper_TabsNormalizer |
|
| 59 | - */ |
|
| 53 | + /** |
|
| 54 | + * Whether to enable or disable the conversion |
|
| 55 | + * of tabs to spaces. |
|
| 56 | + * |
|
| 57 | + * @param bool $enable |
|
| 58 | + * @return ConvertHelper_TabsNormalizer |
|
| 59 | + */ |
|
| 60 | 60 | public function convertTabsToSpaces(bool $enable=true) : ConvertHelper_TabsNormalizer |
| 61 | 61 | { |
| 62 | 62 | $this->tabs2spaces = $enable; |
@@ -64,13 +64,13 @@ discard block |
||
| 64 | 64 | return $this; |
| 65 | 65 | } |
| 66 | 66 | |
| 67 | - /** |
|
| 68 | - * Sets the size of a tab, in spaces. Used to convert tabs |
|
| 69 | - * from spaces and the other way around. Defaults to 4. |
|
| 70 | - * |
|
| 71 | - * @param int $amountSpaces |
|
| 72 | - * @return ConvertHelper_TabsNormalizer |
|
| 73 | - */ |
|
| 67 | + /** |
|
| 68 | + * Sets the size of a tab, in spaces. Used to convert tabs |
|
| 69 | + * from spaces and the other way around. Defaults to 4. |
|
| 70 | + * |
|
| 71 | + * @param int $amountSpaces |
|
| 72 | + * @return ConvertHelper_TabsNormalizer |
|
| 73 | + */ |
|
| 74 | 74 | public function setTabSize(int $amountSpaces) : ConvertHelper_TabsNormalizer |
| 75 | 75 | { |
| 76 | 76 | $this->tabSize = $amountSpaces; |
@@ -78,15 +78,15 @@ discard block |
||
| 78 | 78 | return $this; |
| 79 | 79 | } |
| 80 | 80 | |
| 81 | - /** |
|
| 82 | - * Normalizes tabs in the specified string by indenting everything |
|
| 83 | - * back to the minimum tab distance. With the second parameter, |
|
| 84 | - * tabs can optionally be converted to spaces as well (recommended |
|
| 85 | - * for HTML output). |
|
| 86 | - * |
|
| 87 | - * @param string $string |
|
| 88 | - * @return string |
|
| 89 | - */ |
|
| 81 | + /** |
|
| 82 | + * Normalizes tabs in the specified string by indenting everything |
|
| 83 | + * back to the minimum tab distance. With the second parameter, |
|
| 84 | + * tabs can optionally be converted to spaces as well (recommended |
|
| 85 | + * for HTML output). |
|
| 86 | + * |
|
| 87 | + * @param string $string |
|
| 88 | + * @return string |
|
| 89 | + */ |
|
| 90 | 90 | public function normalize(string $string) : string |
| 91 | 91 | { |
| 92 | 92 | $this->splitLines($string); |
@@ -143,10 +143,10 @@ discard block |
||
| 143 | 143 | return implode($this->eol, $converted); |
| 144 | 144 | } |
| 145 | 145 | |
| 146 | - /** |
|
| 147 | - * Finds out the minimum and maximum amount of |
|
| 148 | - * tabs in the string. |
|
| 149 | - */ |
|
| 146 | + /** |
|
| 147 | + * Finds out the minimum and maximum amount of |
|
| 148 | + * tabs in the string. |
|
| 149 | + */ |
|
| 150 | 150 | protected function countOccurrences() : void |
| 151 | 151 | { |
| 152 | 152 | foreach($this->lines as $line) |
@@ -69,9 +69,9 @@ discard block |
||
| 69 | 69 | ) |
| 70 | 70 | ); |
| 71 | 71 | |
| 72 | - /** |
|
| 73 | - * @var array |
|
| 74 | - */ |
|
| 72 | + /** |
|
| 73 | + * @var array |
|
| 74 | + */ |
|
| 75 | 75 | protected $selected = array(); |
| 76 | 76 | |
| 77 | 77 | public function convert(string $string) : string |
@@ -81,16 +81,16 @@ discard block |
||
| 81 | 81 | return str_replace(array_keys($chars), array_values($chars), $string); |
| 82 | 82 | } |
| 83 | 83 | |
| 84 | - /** |
|
| 85 | - * Selects a character set to replace. Can be called |
|
| 86 | - * several times to add additional sets to the collection. |
|
| 87 | - * |
|
| 88 | - * @param string $type See the <code>CHAR_XXX</code> constants. |
|
| 89 | - * @return ConvertHelper_HiddenConverter |
|
| 90 | - * |
|
| 91 | - * @see ConvertHelper_HiddenConverter::CHARS_CONTROL |
|
| 92 | - * @see ConvertHelper_HiddenConverter::CHARS_WHITESPACE |
|
| 93 | - */ |
|
| 84 | + /** |
|
| 85 | + * Selects a character set to replace. Can be called |
|
| 86 | + * several times to add additional sets to the collection. |
|
| 87 | + * |
|
| 88 | + * @param string $type See the <code>CHAR_XXX</code> constants. |
|
| 89 | + * @return ConvertHelper_HiddenConverter |
|
| 90 | + * |
|
| 91 | + * @see ConvertHelper_HiddenConverter::CHARS_CONTROL |
|
| 92 | + * @see ConvertHelper_HiddenConverter::CHARS_WHITESPACE |
|
| 93 | + */ |
|
| 94 | 94 | public function selectCharacters(string $type) : ConvertHelper_HiddenConverter |
| 95 | 95 | { |
| 96 | 96 | if(!in_array($type, $this->selected)) { |
@@ -100,11 +100,11 @@ discard block |
||
| 100 | 100 | return $this; |
| 101 | 101 | } |
| 102 | 102 | |
| 103 | - /** |
|
| 104 | - * Resolves the list of characters to make visible. |
|
| 105 | - * |
|
| 106 | - * @return array |
|
| 107 | - */ |
|
| 103 | + /** |
|
| 104 | + * Resolves the list of characters to make visible. |
|
| 105 | + * |
|
| 106 | + * @return array |
|
| 107 | + */ |
|
| 108 | 108 | protected function resolveSelection() : array |
| 109 | 109 | { |
| 110 | 110 | $selected = $this->selected; |
@@ -27,14 +27,14 @@ |
||
| 27 | 27 | */ |
| 28 | 28 | protected $param; |
| 29 | 29 | |
| 30 | - /** |
|
| 31 | - * @var mixed |
|
| 32 | - */ |
|
| 30 | + /** |
|
| 31 | + * @var mixed |
|
| 32 | + */ |
|
| 33 | 33 | protected $value; |
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * @var bool |
|
| 37 | - */ |
|
| 35 | + /** |
|
| 36 | + * @var bool |
|
| 37 | + */ |
|
| 38 | 38 | protected $isSubvalue = false; |
| 39 | 39 | |
| 40 | 40 | public function __construct(Request_Param $param, bool $subval) |
@@ -114,18 +114,18 @@ discard block |
||
| 114 | 114 | } |
| 115 | 115 | } |
| 116 | 116 | |
| 117 | - /** |
|
| 118 | - * Adds a callback as a validation method. The callback gets the |
|
| 119 | - * value to validate as first parameter, and any additional |
|
| 120 | - * parameters passed here get appended to that. |
|
| 121 | - * |
|
| 122 | - * The callback must return boolean true or false depending on |
|
| 123 | - * whether the value is valid. |
|
| 124 | - * |
|
| 125 | - * @param callable $callback |
|
| 126 | - * @param array $args |
|
| 127 | - * @return Request_Param |
|
| 128 | - */ |
|
| 117 | + /** |
|
| 118 | + * Adds a callback as a validation method. The callback gets the |
|
| 119 | + * value to validate as first parameter, and any additional |
|
| 120 | + * parameters passed here get appended to that. |
|
| 121 | + * |
|
| 122 | + * The callback must return boolean true or false depending on |
|
| 123 | + * whether the value is valid. |
|
| 124 | + * |
|
| 125 | + * @param callable $callback |
|
| 126 | + * @param array $args |
|
| 127 | + * @return Request_Param |
|
| 128 | + */ |
|
| 129 | 129 | public function setCallback($callback, array $args=array()) : Request_Param |
| 130 | 130 | { |
| 131 | 131 | if(!is_callable($callback)) { |
@@ -189,12 +189,12 @@ discard block |
||
| 189 | 189 | return $value; |
| 190 | 190 | } |
| 191 | 191 | |
| 192 | - /** |
|
| 193 | - * Runs the value through all validations that were added. |
|
| 194 | - * |
|
| 195 | - * @param mixed $value |
|
| 196 | - * @return mixed |
|
| 197 | - */ |
|
| 192 | + /** |
|
| 193 | + * Runs the value through all validations that were added. |
|
| 194 | + * |
|
| 195 | + * @param mixed $value |
|
| 196 | + * @return mixed |
|
| 197 | + */ |
|
| 198 | 198 | protected function applyValidations($value, bool $subval=false) |
| 199 | 199 | { |
| 200 | 200 | // go through all enqueued validations in turn, each time |
@@ -207,17 +207,17 @@ discard block |
||
| 207 | 207 | return $value; |
| 208 | 208 | } |
| 209 | 209 | |
| 210 | - /** |
|
| 211 | - * Validates the specified value using the validation type. Returns |
|
| 212 | - * the validated value. |
|
| 213 | - * |
|
| 214 | - * @param mixed $value |
|
| 215 | - * @param string $type |
|
| 216 | - * @param array $params |
|
| 217 | - * @param bool $subval Whether this is a subvalue in a list |
|
| 218 | - * @throws Request_Exception |
|
| 219 | - * @return mixed |
|
| 220 | - */ |
|
| 210 | + /** |
|
| 211 | + * Validates the specified value using the validation type. Returns |
|
| 212 | + * the validated value. |
|
| 213 | + * |
|
| 214 | + * @param mixed $value |
|
| 215 | + * @param string $type |
|
| 216 | + * @param array $params |
|
| 217 | + * @param bool $subval Whether this is a subvalue in a list |
|
| 218 | + * @throws Request_Exception |
|
| 219 | + * @return mixed |
|
| 220 | + */ |
|
| 221 | 221 | protected function validateType($value, string $type, array $params, bool $subval) |
| 222 | 222 | { |
| 223 | 223 | $class = '\AppUtils\Request_Param_Validator_'.ucfirst($type); |
@@ -286,13 +286,13 @@ discard block |
||
| 286 | 286 | |
| 287 | 287 | protected $valueType = self::VALUE_TYPE_STRING; |
| 288 | 288 | |
| 289 | - /** |
|
| 290 | - * Sets the variable to contain a comma-separated list of integer IDs. |
|
| 291 | - * Example: <code>145,248,4556</code>. A single ID is also allowed, e.g. |
|
| 292 | - * <code>145</code>. |
|
| 293 | - * |
|
| 294 | - * @return Request_Param |
|
| 295 | - */ |
|
| 289 | + /** |
|
| 290 | + * Sets the variable to contain a comma-separated list of integer IDs. |
|
| 291 | + * Example: <code>145,248,4556</code>. A single ID is also allowed, e.g. |
|
| 292 | + * <code>145</code>. |
|
| 293 | + * |
|
| 294 | + * @return Request_Param |
|
| 295 | + */ |
|
| 296 | 296 | public function setIDList() |
| 297 | 297 | { |
| 298 | 298 | $this->valueType = self::VALUE_TYPE_LIST; |
@@ -302,13 +302,13 @@ discard block |
||
| 302 | 302 | return $this; |
| 303 | 303 | } |
| 304 | 304 | |
| 305 | - /** |
|
| 306 | - * Sets the variable to be an alias, as defined by the |
|
| 307 | - * {@link RegexHelper::REGEX_ALIAS} regular expression. |
|
| 308 | - * |
|
| 309 | - * @return Request_Param |
|
| 310 | - * @see RegexHelper::REGEX_ALIAS |
|
| 311 | - */ |
|
| 305 | + /** |
|
| 306 | + * Sets the variable to be an alias, as defined by the |
|
| 307 | + * {@link RegexHelper::REGEX_ALIAS} regular expression. |
|
| 308 | + * |
|
| 309 | + * @return Request_Param |
|
| 310 | + * @see RegexHelper::REGEX_ALIAS |
|
| 311 | + */ |
|
| 312 | 312 | public function setAlias() |
| 313 | 313 | { |
| 314 | 314 | return $this->setRegex(RegexHelper::REGEX_ALIAS); |
@@ -349,12 +349,12 @@ discard block |
||
| 349 | 349 | return $this->setValidation(self::VALIDATION_TYPE_ALPHA); |
| 350 | 350 | } |
| 351 | 351 | |
| 352 | - /** |
|
| 353 | - * Sets the parameter value as a string containing lowercase |
|
| 354 | - * and/or uppercase letters, as well as numbers. |
|
| 355 | - * |
|
| 356 | - * @return Request_Param |
|
| 357 | - */ |
|
| 352 | + /** |
|
| 353 | + * Sets the parameter value as a string containing lowercase |
|
| 354 | + * and/or uppercase letters, as well as numbers. |
|
| 355 | + * |
|
| 356 | + * @return Request_Param |
|
| 357 | + */ |
|
| 358 | 358 | public function setAlnum() |
| 359 | 359 | { |
| 360 | 360 | return $this->setValidation(self::VALIDATION_TYPE_ALNUM); |
@@ -387,17 +387,17 @@ discard block |
||
| 387 | 387 | ); |
| 388 | 388 | } |
| 389 | 389 | |
| 390 | - /** |
|
| 391 | - * Only available for array values: the parameter must be |
|
| 392 | - * an array value, and the array may only contain values |
|
| 393 | - * specified in the values array. |
|
| 394 | - * |
|
| 395 | - * Submitted values that are not in the allowed list of |
|
| 396 | - * values are stripped from the value. |
|
| 397 | - * |
|
| 398 | - * @param array $values List of allowed values |
|
| 399 | - * @return \AppUtils\Request_Param |
|
| 400 | - */ |
|
| 390 | + /** |
|
| 391 | + * Only available for array values: the parameter must be |
|
| 392 | + * an array value, and the array may only contain values |
|
| 393 | + * specified in the values array. |
|
| 394 | + * |
|
| 395 | + * Submitted values that are not in the allowed list of |
|
| 396 | + * values are stripped from the value. |
|
| 397 | + * |
|
| 398 | + * @param array $values List of allowed values |
|
| 399 | + * @return \AppUtils\Request_Param |
|
| 400 | + */ |
|
| 401 | 401 | public function setValuesList(array $values) |
| 402 | 402 | { |
| 403 | 403 | $this->setArray(); |
@@ -410,11 +410,11 @@ discard block |
||
| 410 | 410 | ); |
| 411 | 411 | } |
| 412 | 412 | |
| 413 | - /** |
|
| 414 | - * Whether the parameter is a list of values. |
|
| 415 | - * |
|
| 416 | - * @return bool |
|
| 417 | - */ |
|
| 413 | + /** |
|
| 414 | + * Whether the parameter is a list of values. |
|
| 415 | + * |
|
| 416 | + * @return bool |
|
| 417 | + */ |
|
| 418 | 418 | public function isList() : bool |
| 419 | 419 | { |
| 420 | 420 | return $this->valueType === self::VALUE_TYPE_LIST; |
@@ -425,53 +425,53 @@ discard block |
||
| 425 | 425 | return $this->setValidation(self::VALIDATION_TYPE_ARRAY); |
| 426 | 426 | } |
| 427 | 427 | |
| 428 | - /** |
|
| 429 | - * Specifies that a JSON-encoded string is expected. |
|
| 430 | - * |
|
| 431 | - * NOTE: Numbers or quoted strings are technically valid |
|
| 432 | - * JSON, but are not accepted, because it is assumed |
|
| 433 | - * at least an array or object are expected. |
|
| 434 | - * |
|
| 435 | - * @return \AppUtils\Request_Param |
|
| 436 | - */ |
|
| 428 | + /** |
|
| 429 | + * Specifies that a JSON-encoded string is expected. |
|
| 430 | + * |
|
| 431 | + * NOTE: Numbers or quoted strings are technically valid |
|
| 432 | + * JSON, but are not accepted, because it is assumed |
|
| 433 | + * at least an array or object are expected. |
|
| 434 | + * |
|
| 435 | + * @return \AppUtils\Request_Param |
|
| 436 | + */ |
|
| 437 | 437 | public function setJSON() : Request_Param |
| 438 | 438 | { |
| 439 | 439 | return $this->setValidation(self::VALIDATION_TYPE_JSON, array('arrays' => true)); |
| 440 | 440 | } |
| 441 | 441 | |
| 442 | - /** |
|
| 443 | - * Like {@link Request_Param::setJSON()}, but accepts |
|
| 444 | - * only JSON objects. Arrays will not be accepted. |
|
| 445 | - * |
|
| 446 | - * @return \AppUtils\Request_Param |
|
| 447 | - */ |
|
| 442 | + /** |
|
| 443 | + * Like {@link Request_Param::setJSON()}, but accepts |
|
| 444 | + * only JSON objects. Arrays will not be accepted. |
|
| 445 | + * |
|
| 446 | + * @return \AppUtils\Request_Param |
|
| 447 | + */ |
|
| 448 | 448 | public function setJSONObject() : Request_Param |
| 449 | 449 | { |
| 450 | 450 | return $this->setValidation(self::VALIDATION_TYPE_JSON, array('arrays' => false)); |
| 451 | 451 | } |
| 452 | 452 | |
| 453 | - /** |
|
| 454 | - * The parameter is a string boolean representation. This means |
|
| 455 | - * it can be any of the following: "yes", "true", "no", "false". |
|
| 456 | - * The value is automatically converted to a boolean when retrieving |
|
| 457 | - * the parameter. |
|
| 458 | - * |
|
| 459 | - * @return Request_Param |
|
| 460 | - */ |
|
| 453 | + /** |
|
| 454 | + * The parameter is a string boolean representation. This means |
|
| 455 | + * it can be any of the following: "yes", "true", "no", "false". |
|
| 456 | + * The value is automatically converted to a boolean when retrieving |
|
| 457 | + * the parameter. |
|
| 458 | + * |
|
| 459 | + * @return Request_Param |
|
| 460 | + */ |
|
| 461 | 461 | public function setBoolean() : Request_Param |
| 462 | 462 | { |
| 463 | 463 | return $this->addClassFilter('Boolean'); |
| 464 | 464 | } |
| 465 | 465 | |
| 466 | - /** |
|
| 467 | - * Validates the request parameter as an MD5 string, |
|
| 468 | - * so that only values resembling md5 values are accepted. |
|
| 469 | - * |
|
| 470 | - * NOTE: This can only guarantee the format, not whether |
|
| 471 | - * it is an actual valid hash of something. |
|
| 472 | - * |
|
| 473 | - * @return \AppUtils\Request_Param |
|
| 474 | - */ |
|
| 466 | + /** |
|
| 467 | + * Validates the request parameter as an MD5 string, |
|
| 468 | + * so that only values resembling md5 values are accepted. |
|
| 469 | + * |
|
| 470 | + * NOTE: This can only guarantee the format, not whether |
|
| 471 | + * it is an actual valid hash of something. |
|
| 472 | + * |
|
| 473 | + * @return \AppUtils\Request_Param |
|
| 474 | + */ |
|
| 475 | 475 | public function setMD5() : Request_Param |
| 476 | 476 | { |
| 477 | 477 | return $this->setRegex(RegexHelper::REGEX_MD5); |
@@ -513,14 +513,14 @@ discard block |
||
| 513 | 513 | return $this; |
| 514 | 514 | } |
| 515 | 515 | |
| 516 | - /** |
|
| 517 | - * Retrieves the value of the request parameter, |
|
| 518 | - * applying all filters (if any) and validation |
|
| 519 | - * (if any). |
|
| 520 | - * |
|
| 521 | - * @param mixed $default |
|
| 522 | - * @return mixed |
|
| 523 | - */ |
|
| 516 | + /** |
|
| 517 | + * Retrieves the value of the request parameter, |
|
| 518 | + * applying all filters (if any) and validation |
|
| 519 | + * (if any). |
|
| 520 | + * |
|
| 521 | + * @param mixed $default |
|
| 522 | + * @return mixed |
|
| 523 | + */ |
|
| 524 | 524 | public function get($default=null) |
| 525 | 525 | { |
| 526 | 526 | $value = $this->request->getParam($this->paramName); |
@@ -531,14 +531,14 @@ discard block |
||
| 531 | 531 | return $this->validate($default); |
| 532 | 532 | } |
| 533 | 533 | |
| 534 | - /** |
|
| 535 | - * Filters the specified value by going through all available |
|
| 536 | - * filters, if any. If none have been set, the value is simply |
|
| 537 | - * passed through. |
|
| 538 | - * |
|
| 539 | - * @param mixed $value |
|
| 540 | - * @return mixed |
|
| 541 | - */ |
|
| 534 | + /** |
|
| 535 | + * Filters the specified value by going through all available |
|
| 536 | + * filters, if any. If none have been set, the value is simply |
|
| 537 | + * passed through. |
|
| 538 | + * |
|
| 539 | + * @param mixed $value |
|
| 540 | + * @return mixed |
|
| 541 | + */ |
|
| 542 | 542 | protected function filter($value) |
| 543 | 543 | { |
| 544 | 544 | $total = count($this->filters); |
@@ -608,12 +608,12 @@ discard block |
||
| 608 | 608 | return $this; |
| 609 | 609 | } |
| 610 | 610 | |
| 611 | - /** |
|
| 612 | - * Adds a filter that trims whitespace from the request |
|
| 613 | - * parameter using the PHP <code>trim</code> function. |
|
| 614 | - * |
|
| 615 | - * @return \AppUtils\Request_Param |
|
| 616 | - */ |
|
| 611 | + /** |
|
| 612 | + * Adds a filter that trims whitespace from the request |
|
| 613 | + * parameter using the PHP <code>trim</code> function. |
|
| 614 | + * |
|
| 615 | + * @return \AppUtils\Request_Param |
|
| 616 | + */ |
|
| 617 | 617 | public function addFilterTrim() : Request_Param |
| 618 | 618 | { |
| 619 | 619 | // to guarantee we only work with strings |
@@ -622,13 +622,13 @@ discard block |
||
| 622 | 622 | return $this->addCallbackFilter('trim'); |
| 623 | 623 | } |
| 624 | 624 | |
| 625 | - /** |
|
| 626 | - * Converts the value to a string, even if it is not |
|
| 627 | - * a string value. Complex types like arrays and objects |
|
| 628 | - * are converted to an empty string. |
|
| 629 | - * |
|
| 630 | - * @return \AppUtils\Request_Param |
|
| 631 | - */ |
|
| 625 | + /** |
|
| 626 | + * Converts the value to a string, even if it is not |
|
| 627 | + * a string value. Complex types like arrays and objects |
|
| 628 | + * are converted to an empty string. |
|
| 629 | + * |
|
| 630 | + * @return \AppUtils\Request_Param |
|
| 631 | + */ |
|
| 632 | 632 | public function addStringFilter() : Request_Param |
| 633 | 633 | { |
| 634 | 634 | return $this->addClassFilter('String'); |
@@ -678,12 +678,12 @@ discard block |
||
| 678 | 678 | return $this->addCallbackFilter('strip_tags', array($allowedTags)); |
| 679 | 679 | } |
| 680 | 680 | |
| 681 | - /** |
|
| 682 | - * Adds a filter that strips all whitespace from the |
|
| 683 | - * request parameter, from spaces to tabs and newlines. |
|
| 684 | - * |
|
| 685 | - * @return \AppUtils\Request_Param |
|
| 686 | - */ |
|
| 681 | + /** |
|
| 682 | + * Adds a filter that strips all whitespace from the |
|
| 683 | + * request parameter, from spaces to tabs and newlines. |
|
| 684 | + * |
|
| 685 | + * @return \AppUtils\Request_Param |
|
| 686 | + */ |
|
| 687 | 687 | public function addStripWhitespaceFilter() : Request_Param |
| 688 | 688 | { |
| 689 | 689 | // to ensure we only work with strings. |
@@ -692,14 +692,14 @@ discard block |
||
| 692 | 692 | return $this->addClassFilter('StripWhitespace'); |
| 693 | 693 | } |
| 694 | 694 | |
| 695 | - /** |
|
| 696 | - * Adds a filter that transforms comma separated values |
|
| 697 | - * into an array of values. |
|
| 698 | - * |
|
| 699 | - * @param bool $trimEntries Trim whitespace from each entry? |
|
| 700 | - * @param bool $stripEmptyEntries Remove empty entries from the array? |
|
| 701 | - * @return \AppUtils\Request_Param |
|
| 702 | - */ |
|
| 695 | + /** |
|
| 696 | + * Adds a filter that transforms comma separated values |
|
| 697 | + * into an array of values. |
|
| 698 | + * |
|
| 699 | + * @param bool $trimEntries Trim whitespace from each entry? |
|
| 700 | + * @param bool $stripEmptyEntries Remove empty entries from the array? |
|
| 701 | + * @return \AppUtils\Request_Param |
|
| 702 | + */ |
|
| 703 | 703 | public function addCommaSeparatedFilter(bool $trimEntries=true, bool $stripEmptyEntries=true) : Request_Param |
| 704 | 704 | { |
| 705 | 705 | $this->setArray(); |
@@ -724,12 +724,12 @@ discard block |
||
| 724 | 724 | ); |
| 725 | 725 | } |
| 726 | 726 | |
| 727 | - /** |
|
| 728 | - * Adds a filter that encodes all HTML special characters |
|
| 729 | - * using the PHP <code>htmlspecialchars</code> function. |
|
| 730 | - * |
|
| 731 | - * @return \AppUtils\Request_Param |
|
| 732 | - */ |
|
| 727 | + /** |
|
| 728 | + * Adds a filter that encodes all HTML special characters |
|
| 729 | + * using the PHP <code>htmlspecialchars</code> function. |
|
| 730 | + * |
|
| 731 | + * @return \AppUtils\Request_Param |
|
| 732 | + */ |
|
| 733 | 733 | public function addHTMLSpecialcharsFilter() : Request_Param |
| 734 | 734 | { |
| 735 | 735 | return $this->addCallbackFilter('htmlspecialchars', array(ENT_QUOTES, 'UTF-8')); |
@@ -742,14 +742,14 @@ discard block |
||
| 742 | 742 | |
| 743 | 743 | protected $required = false; |
| 744 | 744 | |
| 745 | - /** |
|
| 746 | - * Marks this request parameter as required. To use this feature, |
|
| 747 | - * you have to call the request's {@link Request::validate()} |
|
| 748 | - * method. |
|
| 749 | - * |
|
| 750 | - * @return Request_Param |
|
| 751 | - * @see Request::validate() |
|
| 752 | - */ |
|
| 745 | + /** |
|
| 746 | + * Marks this request parameter as required. To use this feature, |
|
| 747 | + * you have to call the request's {@link Request::validate()} |
|
| 748 | + * method. |
|
| 749 | + * |
|
| 750 | + * @return Request_Param |
|
| 751 | + * @see Request::validate() |
|
| 752 | + */ |
|
| 753 | 753 | public function makeRequired() : Request_Param |
| 754 | 754 | { |
| 755 | 755 | $this->required = true; |
@@ -19,34 +19,34 @@ discard block |
||
| 19 | 19 | */ |
| 20 | 20 | class RequestHelper_Boundaries_Boundary |
| 21 | 21 | { |
| 22 | - /** |
|
| 23 | - * @var string |
|
| 24 | - */ |
|
| 22 | + /** |
|
| 23 | + * @var string |
|
| 24 | + */ |
|
| 25 | 25 | protected $content; |
| 26 | 26 | |
| 27 | - /** |
|
| 28 | - * @var array |
|
| 29 | - */ |
|
| 27 | + /** |
|
| 28 | + * @var array |
|
| 29 | + */ |
|
| 30 | 30 | protected $dispositionParams = array(); |
| 31 | 31 | |
| 32 | - /** |
|
| 33 | - * @var string |
|
| 34 | - */ |
|
| 32 | + /** |
|
| 33 | + * @var string |
|
| 34 | + */ |
|
| 35 | 35 | protected $contentType = ''; |
| 36 | 36 | |
| 37 | - /** |
|
| 38 | - * @var string |
|
| 39 | - */ |
|
| 37 | + /** |
|
| 38 | + * @var string |
|
| 39 | + */ |
|
| 40 | 40 | protected $contentEncoding = ''; |
| 41 | 41 | |
| 42 | - /** |
|
| 43 | - * @var RequestHelper_Boundaries |
|
| 44 | - */ |
|
| 42 | + /** |
|
| 43 | + * @var RequestHelper_Boundaries |
|
| 44 | + */ |
|
| 45 | 45 | protected $boundaries; |
| 46 | 46 | |
| 47 | - /** |
|
| 48 | - * @var string |
|
| 49 | - */ |
|
| 47 | + /** |
|
| 48 | + * @var string |
|
| 49 | + */ |
|
| 50 | 50 | protected $transferEncoding = ''; |
| 51 | 51 | |
| 52 | 52 | public function __construct(RequestHelper_Boundaries $boundaries, string $content) |
@@ -60,46 +60,46 @@ discard block |
||
| 60 | 60 | return strlen($this->content); |
| 61 | 61 | } |
| 62 | 62 | |
| 63 | - /** |
|
| 64 | - * Sets the name of the request parameter. |
|
| 65 | - * |
|
| 66 | - * @param string $name |
|
| 67 | - * @return RequestHelper_Boundaries_Boundary |
|
| 68 | - */ |
|
| 63 | + /** |
|
| 64 | + * Sets the name of the request parameter. |
|
| 65 | + * |
|
| 66 | + * @param string $name |
|
| 67 | + * @return RequestHelper_Boundaries_Boundary |
|
| 68 | + */ |
|
| 69 | 69 | public function setName(string $name) : RequestHelper_Boundaries_Boundary |
| 70 | 70 | { |
| 71 | 71 | return $this->setDispositionParam('name', $name); |
| 72 | 72 | } |
| 73 | 73 | |
| 74 | - /** |
|
| 75 | - * Sets the filename to use for the content, if applicable. |
|
| 76 | - * |
|
| 77 | - * @param string $fileName |
|
| 78 | - * @return RequestHelper_Boundaries_Boundary |
|
| 79 | - */ |
|
| 74 | + /** |
|
| 75 | + * Sets the filename to use for the content, if applicable. |
|
| 76 | + * |
|
| 77 | + * @param string $fileName |
|
| 78 | + * @return RequestHelper_Boundaries_Boundary |
|
| 79 | + */ |
|
| 80 | 80 | public function setFileName(string $fileName) : RequestHelper_Boundaries_Boundary |
| 81 | 81 | { |
| 82 | 82 | return $this->setDispositionParam('filename', $fileName); |
| 83 | 83 | } |
| 84 | 84 | |
| 85 | - /** |
|
| 86 | - * Sets the content type to use for the content. |
|
| 87 | - * |
|
| 88 | - * @param string $contentType |
|
| 89 | - * @return RequestHelper_Boundaries_Boundary |
|
| 90 | - */ |
|
| 85 | + /** |
|
| 86 | + * Sets the content type to use for the content. |
|
| 87 | + * |
|
| 88 | + * @param string $contentType |
|
| 89 | + * @return RequestHelper_Boundaries_Boundary |
|
| 90 | + */ |
|
| 91 | 91 | public function setContentType(string $contentType) : RequestHelper_Boundaries_Boundary |
| 92 | 92 | { |
| 93 | 93 | $this->contentType = $contentType; |
| 94 | 94 | return $this; |
| 95 | 95 | } |
| 96 | 96 | |
| 97 | - /** |
|
| 98 | - * Sets the encoding to specify for the content. |
|
| 99 | - * |
|
| 100 | - * @param string $encoding An encoding string, e.g. "UTF-8", "ASCII" |
|
| 101 | - * @return RequestHelper_Boundaries_Boundary |
|
| 102 | - */ |
|
| 97 | + /** |
|
| 98 | + * Sets the encoding to specify for the content. |
|
| 99 | + * |
|
| 100 | + * @param string $encoding An encoding string, e.g. "UTF-8", "ASCII" |
|
| 101 | + * @return RequestHelper_Boundaries_Boundary |
|
| 102 | + */ |
|
| 103 | 103 | public function setContentEncoding(string $encoding) : RequestHelper_Boundaries_Boundary |
| 104 | 104 | { |
| 105 | 105 | $this->contentEncoding = $encoding; |
@@ -119,11 +119,11 @@ discard block |
||
| 119 | 119 | return $this; |
| 120 | 120 | } |
| 121 | 121 | |
| 122 | - /** |
|
| 123 | - * Renders the mime boundary text. |
|
| 124 | - * |
|
| 125 | - * @return string |
|
| 126 | - */ |
|
| 122 | + /** |
|
| 123 | + * Renders the mime boundary text. |
|
| 124 | + * |
|
| 125 | + * @return string |
|
| 126 | + */ |
|
| 127 | 127 | public function render() |
| 128 | 128 | { |
| 129 | 129 | $eol = $this->boundaries->getEOL(); |