@@ -36,19 +36,19 @@ discard block |
||
| 36 | 36 | { |
| 37 | 37 | public const ERROR_STRING_ALREADY_HAS_BODY_TAG = 57001; |
| 38 | 38 | |
| 39 | - /** |
|
| 40 | - * @var \DOMElement |
|
| 41 | - */ |
|
| 39 | + /** |
|
| 40 | + * @var \DOMElement |
|
| 41 | + */ |
|
| 42 | 42 | private $bodyNode; |
| 43 | 43 | |
| 44 | - /** |
|
| 45 | - * @var XMLHelper_DOMErrors |
|
| 46 | - */ |
|
| 44 | + /** |
|
| 45 | + * @var XMLHelper_DOMErrors |
|
| 46 | + */ |
|
| 47 | 47 | private $errors; |
| 48 | 48 | |
| 49 | - /** |
|
| 50 | - * @var string |
|
| 51 | - */ |
|
| 49 | + /** |
|
| 50 | + * @var string |
|
| 51 | + */ |
|
| 52 | 52 | private static $htmlTemplate = |
| 53 | 53 | '<!DOCTYPE html>'. |
| 54 | 54 | '<html>'. |
@@ -60,9 +60,9 @@ discard block |
||
| 60 | 60 | '</body>'. |
| 61 | 61 | '</html>'; |
| 62 | 62 | |
| 63 | - /** |
|
| 64 | - * @var \DOMDocument |
|
| 65 | - */ |
|
| 63 | + /** |
|
| 64 | + * @var \DOMDocument |
|
| 65 | + */ |
|
| 66 | 66 | private $dom; |
| 67 | 67 | |
| 68 | 68 | private function __construct(string $html) |
@@ -70,13 +70,13 @@ discard block |
||
| 70 | 70 | $this->load($html); |
| 71 | 71 | } |
| 72 | 72 | |
| 73 | - /** |
|
| 74 | - * Creates an HTML loader from an HTML fragment (without |
|
| 75 | - * doctype, head and body elements). |
|
| 76 | - * |
|
| 77 | - * @param string $fragment |
|
| 78 | - * @return XMLHelper_HTMLLoader |
|
| 79 | - */ |
|
| 73 | + /** |
|
| 74 | + * Creates an HTML loader from an HTML fragment (without |
|
| 75 | + * doctype, head and body elements). |
|
| 76 | + * |
|
| 77 | + * @param string $fragment |
|
| 78 | + * @return XMLHelper_HTMLLoader |
|
| 79 | + */ |
|
| 80 | 80 | public static function loadFragment(string $fragment) : XMLHelper_HTMLLoader |
| 81 | 81 | { |
| 82 | 82 | self::checkFragment($fragment); |
@@ -87,24 +87,24 @@ discard block |
||
| 87 | 87 | return new XMLHelper_HTMLLoader($pseudoHTML); |
| 88 | 88 | } |
| 89 | 89 | |
| 90 | - /** |
|
| 91 | - * Creates an HTML loader from a full HTML document (including |
|
| 92 | - * doctype, head and body elements). |
|
| 93 | - * |
|
| 94 | - * @param string $html |
|
| 95 | - * @return XMLHelper_HTMLLoader |
|
| 96 | - */ |
|
| 90 | + /** |
|
| 91 | + * Creates an HTML loader from a full HTML document (including |
|
| 92 | + * doctype, head and body elements). |
|
| 93 | + * |
|
| 94 | + * @param string $html |
|
| 95 | + * @return XMLHelper_HTMLLoader |
|
| 96 | + */ |
|
| 97 | 97 | public static function loadHTML(string $html) : XMLHelper_HTMLLoader |
| 98 | 98 | { |
| 99 | 99 | return new XMLHelper_HTMLLoader($html); |
| 100 | 100 | } |
| 101 | 101 | |
| 102 | - /** |
|
| 103 | - * Verifies that the fragment does not already contain a body element or doctype. |
|
| 104 | - * |
|
| 105 | - * @param string $fragment |
|
| 106 | - * @throws XMLHelper_Exception |
|
| 107 | - */ |
|
| 102 | + /** |
|
| 103 | + * Verifies that the fragment does not already contain a body element or doctype. |
|
| 104 | + * |
|
| 105 | + * @param string $fragment |
|
| 106 | + * @throws XMLHelper_Exception |
|
| 107 | + */ |
|
| 108 | 108 | private static function checkFragment(string $fragment) : void |
| 109 | 109 | { |
| 110 | 110 | if(!stristr($fragment, '<body') && !stristr($fragment, 'doctype')) |
@@ -142,65 +142,65 @@ discard block |
||
| 142 | 142 | return $this->bodyNode; |
| 143 | 143 | } |
| 144 | 144 | |
| 145 | - /** |
|
| 146 | - * Retrieves the document's `<body>` tag node. |
|
| 147 | - * |
|
| 148 | - * @return \DOMDocument |
|
| 149 | - */ |
|
| 145 | + /** |
|
| 146 | + * Retrieves the document's `<body>` tag node. |
|
| 147 | + * |
|
| 148 | + * @return \DOMDocument |
|
| 149 | + */ |
|
| 150 | 150 | public function getDOM() : \DOMDocument |
| 151 | 151 | { |
| 152 | 152 | return $this->dom; |
| 153 | 153 | } |
| 154 | 154 | |
| 155 | - /** |
|
| 156 | - * Retrieves all nodes from the HTML fragment (= child nodes |
|
| 157 | - * of the `<body>` element). |
|
| 158 | - * |
|
| 159 | - * @return \DOMNodeList |
|
| 160 | - */ |
|
| 155 | + /** |
|
| 156 | + * Retrieves all nodes from the HTML fragment (= child nodes |
|
| 157 | + * of the `<body>` element). |
|
| 158 | + * |
|
| 159 | + * @return \DOMNodeList |
|
| 160 | + */ |
|
| 161 | 161 | public function getFragmentNodes() : \DOMNodeList |
| 162 | 162 | { |
| 163 | 163 | return $this->bodyNode->childNodes; |
| 164 | 164 | } |
| 165 | 165 | |
| 166 | - /** |
|
| 167 | - * Retrieves the LibXML HTML parsing errors collection, which |
|
| 168 | - * can be used to review any errors that occurred while loading |
|
| 169 | - * the HTML document. |
|
| 170 | - * |
|
| 171 | - * @return XMLHelper_DOMErrors |
|
| 172 | - */ |
|
| 166 | + /** |
|
| 167 | + * Retrieves the LibXML HTML parsing errors collection, which |
|
| 168 | + * can be used to review any errors that occurred while loading |
|
| 169 | + * the HTML document. |
|
| 170 | + * |
|
| 171 | + * @return XMLHelper_DOMErrors |
|
| 172 | + */ |
|
| 173 | 173 | public function getErrors() : XMLHelper_DOMErrors |
| 174 | 174 | { |
| 175 | 175 | return $this->errors; |
| 176 | 176 | } |
| 177 | 177 | |
| 178 | - /** |
|
| 179 | - * Returns a valid HTML string. |
|
| 180 | - * |
|
| 181 | - * @return string |
|
| 182 | - */ |
|
| 178 | + /** |
|
| 179 | + * Returns a valid HTML string. |
|
| 180 | + * |
|
| 181 | + * @return string |
|
| 182 | + */ |
|
| 183 | 183 | public function toHTML() : string |
| 184 | 184 | { |
| 185 | 185 | return $this->dom->saveHTML(); |
| 186 | 186 | } |
| 187 | 187 | |
| 188 | - /** |
|
| 189 | - * Returns a valid XML string. |
|
| 190 | - * |
|
| 191 | - * @return string |
|
| 192 | - */ |
|
| 188 | + /** |
|
| 189 | + * Returns a valid XML string. |
|
| 190 | + * |
|
| 191 | + * @return string |
|
| 192 | + */ |
|
| 193 | 193 | public function toXML() : string |
| 194 | 194 | { |
| 195 | 195 | return $this->dom->saveXML(); |
| 196 | 196 | } |
| 197 | 197 | |
| 198 | - /** |
|
| 199 | - * Converts the HTML fragment to valid XML (= all |
|
| 200 | - * child nodes of the `<body>` element). |
|
| 201 | - * |
|
| 202 | - * @return string |
|
| 203 | - */ |
|
| 198 | + /** |
|
| 199 | + * Converts the HTML fragment to valid XML (= all |
|
| 200 | + * child nodes of the `<body>` element). |
|
| 201 | + * |
|
| 202 | + * @return string |
|
| 203 | + */ |
|
| 204 | 204 | public function fragmentToXML() : string |
| 205 | 205 | { |
| 206 | 206 | $nodes = $this->getFragmentNodes(); |
@@ -23,37 +23,37 @@ |
||
| 23 | 23 | { |
| 24 | 24 | public const ERROR_NOT_LOADED_YET = 56501; |
| 25 | 25 | |
| 26 | - /** |
|
| 27 | - * @var \SimpleXMLElement|NULL |
|
| 28 | - */ |
|
| 26 | + /** |
|
| 27 | + * @var \SimpleXMLElement|NULL |
|
| 28 | + */ |
|
| 29 | 29 | private $element = null; |
| 30 | 30 | |
| 31 | - /** |
|
| 32 | - * @var XMLHelper_SimpleXML_Error[] |
|
| 33 | - */ |
|
| 31 | + /** |
|
| 32 | + * @var XMLHelper_SimpleXML_Error[] |
|
| 33 | + */ |
|
| 34 | 34 | private $errors = array(); |
| 35 | 35 | |
| 36 | - /** |
|
| 37 | - * Creates a simplexml instance from an XML string. |
|
| 38 | - * |
|
| 39 | - * NOTE: returns false in case of a fatal error. |
|
| 40 | - * |
|
| 41 | - * @param string $string |
|
| 42 | - * @return \SimpleXMLElement|NULL |
|
| 43 | - */ |
|
| 36 | + /** |
|
| 37 | + * Creates a simplexml instance from an XML string. |
|
| 38 | + * |
|
| 39 | + * NOTE: returns false in case of a fatal error. |
|
| 40 | + * |
|
| 41 | + * @param string $string |
|
| 42 | + * @return \SimpleXMLElement|NULL |
|
| 43 | + */ |
|
| 44 | 44 | public function loadString(string $string) : ?\SimpleXMLElement |
| 45 | 45 | { |
| 46 | 46 | return $this->load('string', $string); |
| 47 | 47 | } |
| 48 | 48 | |
| 49 | - /** |
|
| 50 | - * Creates a simplexml instance from an XML file. |
|
| 51 | - * |
|
| 52 | - * NOTE: returns false in case of a fatal error. |
|
| 53 | - * |
|
| 54 | - * @param string $file |
|
| 55 | - * @return \SimpleXMLElement|NULL |
|
| 56 | - */ |
|
| 49 | + /** |
|
| 50 | + * Creates a simplexml instance from an XML file. |
|
| 51 | + * |
|
| 52 | + * NOTE: returns false in case of a fatal error. |
|
| 53 | + * |
|
| 54 | + * @param string $file |
|
| 55 | + * @return \SimpleXMLElement|NULL |
|
| 56 | + */ |
|
| 57 | 57 | public function loadFile(string $file) : ?\SimpleXMLElement |
| 58 | 58 | { |
| 59 | 59 | return $this->load('file', $file); |
@@ -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 | public 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); |
@@ -42,10 +42,10 @@ discard block |
||
| 42 | 42 | |
| 43 | 43 | public const REGEX_MD5 = '/^[a-f0-9]{32}$/i'; |
| 44 | 44 | |
| 45 | - /** |
|
| 46 | - * @var string |
|
| 47 | - * @see https://en.wikipedia.org/wiki/Email_address#Local-part |
|
| 48 | - */ |
|
| 45 | + /** |
|
| 46 | + * @var string |
|
| 47 | + * @see https://en.wikipedia.org/wiki/Email_address#Local-part |
|
| 48 | + */ |
|
| 49 | 49 | public const REGEX_EMAIL = '/[a-z0-9!#$%&\'*+\/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&\'*+\/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?/i'; |
| 50 | 50 | |
| 51 | 51 | public const REGEX_PHONE = '/\A[+0-9][0-9 +\-()]+\z/m'; |
@@ -97,14 +97,14 @@ discard block |
||
| 97 | 97 | */ |
| 98 | 98 | public const REGEX_IS_HTML = '%<{0,1}[a-z\/][\s\S]*>|<[a-z\/][\s\S]*>{0,1}%i'; |
| 99 | 99 | |
| 100 | - /** |
|
| 101 | - * Hexadecimal color codes. Allows the following formats: |
|
| 102 | - * |
|
| 103 | - * FFFFFF |
|
| 104 | - * FFF |
|
| 105 | - * |
|
| 106 | - * @var string |
|
| 107 | - */ |
|
| 100 | + /** |
|
| 101 | + * Hexadecimal color codes. Allows the following formats: |
|
| 102 | + * |
|
| 103 | + * FFFFFF |
|
| 104 | + * FFF |
|
| 105 | + * |
|
| 106 | + * @var string |
|
| 107 | + */ |
|
| 108 | 108 | public const REGEX_HEX_COLOR_CODE = '/\A(?:[0-9a-fA-F]{6}|[0-9a-fA-F]{3})\z/iU'; |
| 109 | 109 | |
| 110 | 110 | /** |
@@ -37,19 +37,19 @@ discard block |
||
| 37 | 37 | |
| 38 | 38 | public const ERROR_INVALID_SERIALIZED_DATA = 56301; |
| 39 | 39 | |
| 40 | - /** |
|
| 41 | - * @var string |
|
| 42 | - */ |
|
| 40 | + /** |
|
| 41 | + * @var string |
|
| 42 | + */ |
|
| 43 | 43 | protected $string; |
| 44 | 44 | |
| 45 | - /** |
|
| 46 | - * @var mixed |
|
| 47 | - */ |
|
| 45 | + /** |
|
| 46 | + * @var mixed |
|
| 47 | + */ |
|
| 48 | 48 | protected $value; |
| 49 | 49 | |
| 50 | - /** |
|
| 51 | - * @var string |
|
| 52 | - */ |
|
| 50 | + /** |
|
| 51 | + * @var string |
|
| 52 | + */ |
|
| 53 | 53 | protected $type; |
| 54 | 54 | |
| 55 | 55 | /** |
@@ -106,15 +106,15 @@ discard block |
||
| 106 | 106 | return new VariableInfo(null, $serialized); |
| 107 | 107 | } |
| 108 | 108 | |
| 109 | - /** |
|
| 110 | - * Parses a previously serialized data set to restore the |
|
| 111 | - * variable information from it. |
|
| 112 | - * |
|
| 113 | - * @param array $serialized |
|
| 114 | - * @throws BaseException |
|
| 115 | - * |
|
| 116 | - * @see VariableInfo::ERROR_INVALID_SERIALIZED_DATA |
|
| 117 | - */ |
|
| 109 | + /** |
|
| 110 | + * Parses a previously serialized data set to restore the |
|
| 111 | + * variable information from it. |
|
| 112 | + * |
|
| 113 | + * @param array $serialized |
|
| 114 | + * @throws BaseException |
|
| 115 | + * |
|
| 116 | + * @see VariableInfo::ERROR_INVALID_SERIALIZED_DATA |
|
| 117 | + */ |
|
| 118 | 118 | protected function parseSerialized(array $serialized) : void |
| 119 | 119 | { |
| 120 | 120 | if(!isset($serialized['string']) || !isset($serialized['type']) || !isset($serialized['options'])) |
@@ -156,12 +156,12 @@ discard block |
||
| 156 | 156 | return $this->value; |
| 157 | 157 | } |
| 158 | 158 | |
| 159 | - /** |
|
| 160 | - * The variable type - this is the same string that |
|
| 161 | - * is returned by the PHP function `gettype`. |
|
| 162 | - * |
|
| 163 | - * @return string |
|
| 164 | - */ |
|
| 159 | + /** |
|
| 160 | + * The variable type - this is the same string that |
|
| 161 | + * is returned by the PHP function `gettype`. |
|
| 162 | + * |
|
| 163 | + * @return string |
|
| 164 | + */ |
|
| 165 | 165 | public function getType() : string |
| 166 | 166 | { |
| 167 | 167 | return $this->type; |
@@ -175,13 +175,13 @@ discard block |
||
| 175 | 175 | ); |
| 176 | 176 | } |
| 177 | 177 | |
| 178 | - /** |
|
| 179 | - * Whether to prepend the variable type before the value, |
|
| 180 | - * like the var_dump function. Example: <code>string "Some text"</code>. |
|
| 181 | - * |
|
| 182 | - * @param bool $enable |
|
| 183 | - * @return VariableInfo |
|
| 184 | - */ |
|
| 178 | + /** |
|
| 179 | + * Whether to prepend the variable type before the value, |
|
| 180 | + * like the var_dump function. Example: <code>string "Some text"</code>. |
|
| 181 | + * |
|
| 182 | + * @param bool $enable |
|
| 183 | + * @return VariableInfo |
|
| 184 | + */ |
|
| 185 | 185 | public function enableType(bool $enable=true) : VariableInfo |
| 186 | 186 | { |
| 187 | 187 | return $this->setOption('prepend-type', $enable); |
@@ -22,9 +22,9 @@ |
||
| 22 | 22 | { |
| 23 | 23 | public const ERROR_INVALID_CALLBACK = 62101; |
| 24 | 24 | |
| 25 | - /** |
|
| 26 | - * @var callable |
|
| 27 | - */ |
|
| 25 | + /** |
|
| 26 | + * @var callable |
|
| 27 | + */ |
|
| 28 | 28 | private $callback; |
| 29 | 29 | |
| 30 | 30 | public function __construct($callback) |
@@ -22,44 +22,44 @@ discard block |
||
| 22 | 22 | */ |
| 23 | 23 | class FileHelper_PHPClassInfo_Class |
| 24 | 24 | { |
| 25 | - /** |
|
| 26 | - * @var FileHelper_PHPClassInfo |
|
| 27 | - */ |
|
| 25 | + /** |
|
| 26 | + * @var FileHelper_PHPClassInfo |
|
| 27 | + */ |
|
| 28 | 28 | protected $info; |
| 29 | 29 | |
| 30 | - /** |
|
| 31 | - * @var bool |
|
| 32 | - */ |
|
| 30 | + /** |
|
| 31 | + * @var bool |
|
| 32 | + */ |
|
| 33 | 33 | protected $abstract = false; |
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * @var bool |
|
| 37 | - */ |
|
| 35 | + /** |
|
| 36 | + * @var bool |
|
| 37 | + */ |
|
| 38 | 38 | protected $final = false; |
| 39 | 39 | |
| 40 | - /** |
|
| 41 | - * @var string |
|
| 42 | - */ |
|
| 40 | + /** |
|
| 41 | + * @var string |
|
| 42 | + */ |
|
| 43 | 43 | protected $extends = ''; |
| 44 | 44 | |
| 45 | - /** |
|
| 46 | - * @var string[] |
|
| 47 | - */ |
|
| 45 | + /** |
|
| 46 | + * @var string[] |
|
| 47 | + */ |
|
| 48 | 48 | protected $implements = array(); |
| 49 | 49 | |
| 50 | - /** |
|
| 51 | - * @var string |
|
| 52 | - */ |
|
| 50 | + /** |
|
| 51 | + * @var string |
|
| 52 | + */ |
|
| 53 | 53 | protected $name; |
| 54 | 54 | |
| 55 | - /** |
|
| 56 | - * @var string |
|
| 57 | - */ |
|
| 55 | + /** |
|
| 56 | + * @var string |
|
| 57 | + */ |
|
| 58 | 58 | protected $declaration; |
| 59 | 59 | |
| 60 | - /** |
|
| 61 | - * @var string |
|
| 62 | - */ |
|
| 60 | + /** |
|
| 61 | + * @var string |
|
| 62 | + */ |
|
| 63 | 63 | protected $keyword; |
| 64 | 64 | |
| 65 | 65 | /** |
@@ -68,10 +68,10 @@ discard block |
||
| 68 | 68 | private $type; |
| 69 | 69 | |
| 70 | 70 | /** |
| 71 | - * @param FileHelper_PHPClassInfo $info The class info instance. |
|
| 72 | - * @param string $declaration The full class declaration, e.g. "class SomeName extends SomeOtherClass". |
|
| 73 | - * @param string $keyword The class keyword, if any, i.e. "abstract" or "final". |
|
| 74 | - */ |
|
| 71 | + * @param FileHelper_PHPClassInfo $info The class info instance. |
|
| 72 | + * @param string $declaration The full class declaration, e.g. "class SomeName extends SomeOtherClass". |
|
| 73 | + * @param string $keyword The class keyword, if any, i.e. "abstract" or "final". |
|
| 74 | + */ |
|
| 75 | 75 | public function __construct(FileHelper_PHPClassInfo $info, string $declaration, string $keyword, string $type) |
| 76 | 76 | { |
| 77 | 77 | $this->info = $info; |
@@ -82,31 +82,31 @@ discard block |
||
| 82 | 82 | $this->analyzeCode(); |
| 83 | 83 | } |
| 84 | 84 | |
| 85 | - /** |
|
| 86 | - * Check if this class is a subclass of the specified |
|
| 87 | - * class name. |
|
| 88 | - * |
|
| 89 | - * @param string $className |
|
| 90 | - * @return bool |
|
| 91 | - */ |
|
| 85 | + /** |
|
| 86 | + * Check if this class is a subclass of the specified |
|
| 87 | + * class name. |
|
| 88 | + * |
|
| 89 | + * @param string $className |
|
| 90 | + * @return bool |
|
| 91 | + */ |
|
| 92 | 92 | public function isSublassOf(string $className) : bool |
| 93 | 93 | { |
| 94 | 94 | return is_subclass_of($this->getNameNS(), $className); |
| 95 | 95 | } |
| 96 | 96 | |
| 97 | - /** |
|
| 98 | - * The class name without namespace. |
|
| 99 | - * @return string |
|
| 100 | - */ |
|
| 97 | + /** |
|
| 98 | + * The class name without namespace. |
|
| 99 | + * @return string |
|
| 100 | + */ |
|
| 101 | 101 | public function getName() : string |
| 102 | 102 | { |
| 103 | 103 | return $this->name; |
| 104 | 104 | } |
| 105 | 105 | |
| 106 | - /** |
|
| 107 | - * The absolute class name with namespace (if any). |
|
| 108 | - * @return string |
|
| 109 | - */ |
|
| 106 | + /** |
|
| 107 | + * The absolute class name with namespace (if any). |
|
| 108 | + * @return string |
|
| 109 | + */ |
|
| 110 | 110 | public function getNameNS() : string |
| 111 | 111 | { |
| 112 | 112 | $name = $this->getName(); |
@@ -118,48 +118,48 @@ discard block |
||
| 118 | 118 | return $name; |
| 119 | 119 | } |
| 120 | 120 | |
| 121 | - /** |
|
| 122 | - * Whether it is an abstract class. |
|
| 123 | - * @return bool |
|
| 124 | - */ |
|
| 121 | + /** |
|
| 122 | + * Whether it is an abstract class. |
|
| 123 | + * @return bool |
|
| 124 | + */ |
|
| 125 | 125 | public function isAbstract() : bool |
| 126 | 126 | { |
| 127 | 127 | return $this->abstract; |
| 128 | 128 | } |
| 129 | 129 | |
| 130 | - /** |
|
| 131 | - * Whether it is a final class. |
|
| 132 | - * @return bool |
|
| 133 | - */ |
|
| 130 | + /** |
|
| 131 | + * Whether it is a final class. |
|
| 132 | + * @return bool |
|
| 133 | + */ |
|
| 134 | 134 | public function isFinal() : bool |
| 135 | 135 | { |
| 136 | 136 | return $this->final; |
| 137 | 137 | } |
| 138 | 138 | |
| 139 | - /** |
|
| 140 | - * The name of the class that this class extends (with namespace, if specified). |
|
| 141 | - * @return string |
|
| 142 | - */ |
|
| 139 | + /** |
|
| 140 | + * The name of the class that this class extends (with namespace, if specified). |
|
| 141 | + * @return string |
|
| 142 | + */ |
|
| 143 | 143 | public function getExtends() : string |
| 144 | 144 | { |
| 145 | 145 | return $this->extends; |
| 146 | 146 | } |
| 147 | 147 | |
| 148 | - /** |
|
| 149 | - * A list of interfaces the class implements, if any. |
|
| 150 | - * @return string[] |
|
| 151 | - */ |
|
| 148 | + /** |
|
| 149 | + * A list of interfaces the class implements, if any. |
|
| 150 | + * @return string[] |
|
| 151 | + */ |
|
| 152 | 152 | public function getImplements() : array |
| 153 | 153 | { |
| 154 | 154 | return $this->implements; |
| 155 | 155 | } |
| 156 | 156 | |
| 157 | - /** |
|
| 158 | - * The class declaration string, with normalized spaces and sorted interface names. |
|
| 159 | - * NOTE: does not include the keyword "abstract" or "final". |
|
| 160 | - * |
|
| 161 | - * @return string |
|
| 162 | - */ |
|
| 157 | + /** |
|
| 158 | + * The class declaration string, with normalized spaces and sorted interface names. |
|
| 159 | + * NOTE: does not include the keyword "abstract" or "final". |
|
| 160 | + * |
|
| 161 | + * @return string |
|
| 162 | + */ |
|
| 163 | 163 | public function getDeclaration() : string |
| 164 | 164 | { |
| 165 | 165 | $parts = array(); |
@@ -179,10 +179,10 @@ discard block |
||
| 179 | 179 | return implode(' ', $parts); |
| 180 | 180 | } |
| 181 | 181 | |
| 182 | - /** |
|
| 183 | - * The keyword before "class", e.g. "abstract". |
|
| 184 | - * @return string |
|
| 185 | - */ |
|
| 182 | + /** |
|
| 183 | + * The keyword before "class", e.g. "abstract". |
|
| 184 | + * @return string |
|
| 185 | + */ |
|
| 186 | 186 | public function getKeyword() : string |
| 187 | 187 | { |
| 188 | 188 | return $this->keyword; |
@@ -60,23 +60,23 @@ discard block |
||
| 60 | 60 | } |
| 61 | 61 | } |
| 62 | 62 | |
| 63 | - /** |
|
| 64 | - * The end of line character used in the INI source string. |
|
| 65 | - * @return string |
|
| 66 | - */ |
|
| 63 | + /** |
|
| 64 | + * The end of line character used in the INI source string. |
|
| 65 | + * @return string |
|
| 66 | + */ |
|
| 67 | 67 | public function getEOLChar() : string |
| 68 | 68 | { |
| 69 | 69 | return $this->eol; |
| 70 | 70 | } |
| 71 | 71 | |
| 72 | - /** |
|
| 73 | - * Factory method: creates a new helper instance loading the |
|
| 74 | - * ini content from the specified file. |
|
| 75 | - * |
|
| 76 | - * @param string $iniPath |
|
| 77 | - * @return \AppUtils\IniHelper |
|
| 78 | - * @throws IniHelper_Exception |
|
| 79 | - */ |
|
| 72 | + /** |
|
| 73 | + * Factory method: creates a new helper instance loading the |
|
| 74 | + * ini content from the specified file. |
|
| 75 | + * |
|
| 76 | + * @param string $iniPath |
|
| 77 | + * @return \AppUtils\IniHelper |
|
| 78 | + * @throws IniHelper_Exception |
|
| 79 | + */ |
|
| 80 | 80 | public static function createFromFile(string $iniPath) |
| 81 | 81 | { |
| 82 | 82 | $iniPath = FileHelper::requireFileExists($iniPath); |
@@ -96,35 +96,35 @@ discard block |
||
| 96 | 96 | ); |
| 97 | 97 | } |
| 98 | 98 | |
| 99 | - /** |
|
| 100 | - * Factory method: Creates a new ini helper instance from an ini string. |
|
| 101 | - * |
|
| 102 | - * @param string $iniContent |
|
| 103 | - * @return \AppUtils\IniHelper |
|
| 104 | - */ |
|
| 99 | + /** |
|
| 100 | + * Factory method: Creates a new ini helper instance from an ini string. |
|
| 101 | + * |
|
| 102 | + * @param string $iniContent |
|
| 103 | + * @return \AppUtils\IniHelper |
|
| 104 | + */ |
|
| 105 | 105 | public static function createFromString(string $iniContent) |
| 106 | 106 | { |
| 107 | 107 | return new IniHelper($iniContent); |
| 108 | 108 | } |
| 109 | 109 | |
| 110 | - /** |
|
| 111 | - * Factory method: Creates a new empty ini helper. |
|
| 112 | - * |
|
| 113 | - * @return \AppUtils\IniHelper |
|
| 114 | - */ |
|
| 110 | + /** |
|
| 111 | + * Factory method: Creates a new empty ini helper. |
|
| 112 | + * |
|
| 113 | + * @return \AppUtils\IniHelper |
|
| 114 | + */ |
|
| 115 | 115 | public static function createNew() |
| 116 | 116 | { |
| 117 | 117 | return self::createFromString(''); |
| 118 | 118 | } |
| 119 | 119 | |
| 120 | - /** |
|
| 121 | - * Adds a new data section, and returns the section instance. |
|
| 122 | - * If a section with the name already exists, returns that |
|
| 123 | - * section instead of creating a new one. |
|
| 124 | - * |
|
| 125 | - * @param string $name |
|
| 126 | - * @return IniHelper_Section |
|
| 127 | - */ |
|
| 120 | + /** |
|
| 121 | + * Adds a new data section, and returns the section instance. |
|
| 122 | + * If a section with the name already exists, returns that |
|
| 123 | + * section instead of creating a new one. |
|
| 124 | + * |
|
| 125 | + * @param string $name |
|
| 126 | + * @return IniHelper_Section |
|
| 127 | + */ |
|
| 128 | 128 | public function addSection(string $name) : IniHelper_Section |
| 129 | 129 | { |
| 130 | 130 | if(!isset($this->sections[$name])) { |
@@ -134,12 +134,12 @@ discard block |
||
| 134 | 134 | return $this->sections[$name]; |
| 135 | 135 | } |
| 136 | 136 | |
| 137 | - /** |
|
| 138 | - * Retrieves a section by its name, if it exists. |
|
| 139 | - * |
|
| 140 | - * @param string $name |
|
| 141 | - * @return IniHelper_Section|NULL |
|
| 142 | - */ |
|
| 137 | + /** |
|
| 138 | + * Retrieves a section by its name, if it exists. |
|
| 139 | + * |
|
| 140 | + * @param string $name |
|
| 141 | + * @return IniHelper_Section|NULL |
|
| 142 | + */ |
|
| 143 | 143 | public function getSection(string $name) : ?IniHelper_Section |
| 144 | 144 | { |
| 145 | 145 | if(isset($this->sections[$name])) { |
@@ -149,11 +149,11 @@ discard block |
||
| 149 | 149 | return null; |
| 150 | 150 | } |
| 151 | 151 | |
| 152 | - /** |
|
| 153 | - * Gets the data from the INI file as an associative array. |
|
| 154 | - * |
|
| 155 | - * @return array |
|
| 156 | - */ |
|
| 152 | + /** |
|
| 153 | + * Gets the data from the INI file as an associative array. |
|
| 154 | + * |
|
| 155 | + * @return array |
|
| 156 | + */ |
|
| 157 | 157 | public function toArray() : array |
| 158 | 158 | { |
| 159 | 159 | $result = array(); |
@@ -173,17 +173,17 @@ discard block |
||
| 173 | 173 | return $result; |
| 174 | 174 | } |
| 175 | 175 | |
| 176 | - /** |
|
| 177 | - * Saves the INI content to the target file. |
|
| 178 | - * |
|
| 179 | - * @param string $filePath |
|
| 180 | - * @return IniHelper |
|
| 181 | - * @throws FileHelper_Exception |
|
| 182 | - * |
|
| 183 | - * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE |
|
| 184 | - * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
|
| 185 | - * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
|
| 186 | - */ |
|
| 176 | + /** |
|
| 177 | + * Saves the INI content to the target file. |
|
| 178 | + * |
|
| 179 | + * @param string $filePath |
|
| 180 | + * @return IniHelper |
|
| 181 | + * @throws FileHelper_Exception |
|
| 182 | + * |
|
| 183 | + * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE |
|
| 184 | + * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
|
| 185 | + * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
|
| 186 | + */ |
|
| 187 | 187 | public function saveToFile(string $filePath) : IniHelper |
| 188 | 188 | { |
| 189 | 189 | FileHelper::saveFile($filePath, $this->saveToString()); |
@@ -191,11 +191,11 @@ discard block |
||
| 191 | 191 | return $this; |
| 192 | 192 | } |
| 193 | 193 | |
| 194 | - /** |
|
| 195 | - * Returns the INI content as string. |
|
| 196 | - * |
|
| 197 | - * @return string |
|
| 198 | - */ |
|
| 194 | + /** |
|
| 195 | + * Returns the INI content as string. |
|
| 196 | + * |
|
| 197 | + * @return string |
|
| 198 | + */ |
|
| 199 | 199 | public function saveToString() : string |
| 200 | 200 | { |
| 201 | 201 | $parts = array(); |
@@ -208,15 +208,15 @@ discard block |
||
| 208 | 208 | return implode($this->eol, $parts); |
| 209 | 209 | } |
| 210 | 210 | |
| 211 | - /** |
|
| 212 | - * Sets or adds the value of a setting in the INI content. |
|
| 213 | - * If the setting does not exist, it is added. Otherwise, |
|
| 214 | - * the existing value is overwritten. |
|
| 215 | - * |
|
| 216 | - * @param string $path A variable path, either <code>varname</code> or <code>section.varname</code>. |
|
| 217 | - * @param mixed $value |
|
| 218 | - * @return IniHelper |
|
| 219 | - */ |
|
| 211 | + /** |
|
| 212 | + * Sets or adds the value of a setting in the INI content. |
|
| 213 | + * If the setting does not exist, it is added. Otherwise, |
|
| 214 | + * the existing value is overwritten. |
|
| 215 | + * |
|
| 216 | + * @param string $path A variable path, either <code>varname</code> or <code>section.varname</code>. |
|
| 217 | + * @param mixed $value |
|
| 218 | + * @return IniHelper |
|
| 219 | + */ |
|
| 220 | 220 | public function setValue(string $path, $value) : IniHelper |
| 221 | 221 | { |
| 222 | 222 | $path = $this->parsePath($path); |
@@ -235,12 +235,12 @@ discard block |
||
| 235 | 235 | return $this; |
| 236 | 236 | } |
| 237 | 237 | |
| 238 | - /** |
|
| 239 | - * Checks whether a section with the specified name exists. |
|
| 240 | - * |
|
| 241 | - * @param string $name |
|
| 242 | - * @return bool |
|
| 243 | - */ |
|
| 238 | + /** |
|
| 239 | + * Checks whether a section with the specified name exists. |
|
| 240 | + * |
|
| 241 | + * @param string $name |
|
| 242 | + * @return bool |
|
| 243 | + */ |
|
| 244 | 244 | public function sectionExists(string $name) : bool |
| 245 | 245 | { |
| 246 | 246 | foreach($this->sections as $section) { |
@@ -252,23 +252,23 @@ discard block |
||
| 252 | 252 | return false; |
| 253 | 253 | } |
| 254 | 254 | |
| 255 | - /** |
|
| 256 | - * Retrieves the default section, which is used to add |
|
| 257 | - * values in the root of the document. |
|
| 258 | - * |
|
| 259 | - * @return IniHelper_Section |
|
| 260 | - */ |
|
| 255 | + /** |
|
| 256 | + * Retrieves the default section, which is used to add |
|
| 257 | + * values in the root of the document. |
|
| 258 | + * |
|
| 259 | + * @return IniHelper_Section |
|
| 260 | + */ |
|
| 261 | 261 | public function getDefaultSection() : IniHelper_Section |
| 262 | 262 | { |
| 263 | 263 | return $this->addSection(self::SECTION_DEFAULT); |
| 264 | 264 | } |
| 265 | 265 | |
| 266 | - /** |
|
| 267 | - * Retrieves all variable lines for the specified path. |
|
| 268 | - * |
|
| 269 | - * @param string $path A variable path. Either <code>varname</code> or <code>section.varname</code>. |
|
| 270 | - * @return array|\AppUtils\IniHelper_Line[] |
|
| 271 | - */ |
|
| 266 | + /** |
|
| 267 | + * Retrieves all variable lines for the specified path. |
|
| 268 | + * |
|
| 269 | + * @param string $path A variable path. Either <code>varname</code> or <code>section.varname</code>. |
|
| 270 | + * @return array|\AppUtils\IniHelper_Line[] |
|
| 271 | + */ |
|
| 272 | 272 | public function getLinesByVariable(string $path) |
| 273 | 273 | { |
| 274 | 274 | $path = $this->parsePath($path); |
@@ -20,9 +20,9 @@ discard block |
||
| 20 | 20 | */ |
| 21 | 21 | class URLInfo_Highlighter |
| 22 | 22 | { |
| 23 | - /** |
|
| 24 | - * @var URLInfo |
|
| 25 | - */ |
|
| 23 | + /** |
|
| 24 | + * @var URLInfo |
|
| 25 | + */ |
|
| 26 | 26 | protected $info; |
| 27 | 27 | |
| 28 | 28 | public function __construct(URLInfo $info) |
@@ -158,13 +158,13 @@ discard block |
||
| 158 | 158 | ); |
| 159 | 159 | } |
| 160 | 160 | |
| 161 | - /** |
|
| 162 | - * Fetches all parameters in the URL, regardless of |
|
| 163 | - * whether parameter exclusion is enabled, so they |
|
| 164 | - * can be highlighted is need be. |
|
| 165 | - * |
|
| 166 | - * @return array<string,string> |
|
| 167 | - */ |
|
| 161 | + /** |
|
| 162 | + * Fetches all parameters in the URL, regardless of |
|
| 163 | + * whether parameter exclusion is enabled, so they |
|
| 164 | + * can be highlighted is need be. |
|
| 165 | + * |
|
| 166 | + * @return array<string,string> |
|
| 167 | + */ |
|
| 168 | 168 | protected function resolveParams() : array |
| 169 | 169 | { |
| 170 | 170 | $previous = $this->info->isParamExclusionEnabled(); |