@@ -4,37 +4,37 @@ discard block |
||
| 4 | 4 | |
| 5 | 5 | class SVNHelper_CommandResult |
| 6 | 6 | { |
| 7 | - /** |
|
| 8 | - * @var SVNHelper_Command |
|
| 9 | - */ |
|
| 7 | + /** |
|
| 8 | + * @var SVNHelper_Command |
|
| 9 | + */ |
|
| 10 | 10 | protected $command; |
| 11 | 11 | |
| 12 | - /** |
|
| 13 | - * @var string[] |
|
| 14 | - */ |
|
| 12 | + /** |
|
| 13 | + * @var string[] |
|
| 14 | + */ |
|
| 15 | 15 | protected $output; |
| 16 | 16 | |
| 17 | - /** |
|
| 18 | - * @var SVNHelper_CommandError[] |
|
| 19 | - */ |
|
| 17 | + /** |
|
| 18 | + * @var SVNHelper_CommandError[] |
|
| 19 | + */ |
|
| 20 | 20 | protected $errors = array(); |
| 21 | 21 | |
| 22 | - /** |
|
| 23 | - * @var SVNHelper_CommandError[] |
|
| 24 | - */ |
|
| 22 | + /** |
|
| 23 | + * @var SVNHelper_CommandError[] |
|
| 24 | + */ |
|
| 25 | 25 | protected $warnings = array(); |
| 26 | 26 | |
| 27 | - /** |
|
| 28 | - * The actual command that has been executed |
|
| 29 | - * @var string |
|
| 30 | - */ |
|
| 27 | + /** |
|
| 28 | + * The actual command that has been executed |
|
| 29 | + * @var string |
|
| 30 | + */ |
|
| 31 | 31 | protected $commandLine; |
| 32 | 32 | |
| 33 | - /** |
|
| 34 | - * @param SVNHelper_Command $command |
|
| 35 | - * @param string[] $output |
|
| 36 | - * @param SVNHelper_CommandError[] $errors |
|
| 37 | - */ |
|
| 33 | + /** |
|
| 34 | + * @param SVNHelper_Command $command |
|
| 35 | + * @param string[] $output |
|
| 36 | + * @param SVNHelper_CommandError[] $errors |
|
| 37 | + */ |
|
| 38 | 38 | public function __construct(SVNHelper_Command $command, $commandLine, $output, $errors) |
| 39 | 39 | { |
| 40 | 40 | $this->command = $command; |
@@ -86,12 +86,12 @@ discard block |
||
| 86 | 86 | return $this->command; |
| 87 | 87 | } |
| 88 | 88 | |
| 89 | - /** |
|
| 90 | - * Retrieves all error messages. |
|
| 91 | - * |
|
| 92 | - * @param string $asString |
|
| 93 | - * @return string|string[] |
|
| 94 | - */ |
|
| 89 | + /** |
|
| 90 | + * Retrieves all error messages. |
|
| 91 | + * |
|
| 92 | + * @param string $asString |
|
| 93 | + * @return string|string[] |
|
| 94 | + */ |
|
| 95 | 95 | public function getErrorMessages($asString=false) |
| 96 | 96 | { |
| 97 | 97 | if($asString) { |
@@ -44,12 +44,12 @@ |
||
| 44 | 44 | return $result; |
| 45 | 45 | } |
| 46 | 46 | |
| 47 | - /** |
|
| 48 | - * Whether the file or folder has already been committed |
|
| 49 | - * and has no pending changes. |
|
| 50 | - * |
|
| 51 | - * @return boolean |
|
| 52 | - */ |
|
| 47 | + /** |
|
| 48 | + * Whether the file or folder has already been committed |
|
| 49 | + * and has no pending changes. |
|
| 50 | + * |
|
| 51 | + * @return boolean |
|
| 52 | + */ |
|
| 53 | 53 | public function isCommitted() |
| 54 | 54 | { |
| 55 | 55 | $status = $this->target->getStatus(); |
@@ -28,17 +28,17 @@ discard block |
||
| 28 | 28 | return $result; |
| 29 | 29 | } |
| 30 | 30 | |
| 31 | - /** |
|
| 32 | - * @var SVNHelper_Command_Update_Status[] |
|
| 33 | - */ |
|
| 31 | + /** |
|
| 32 | + * @var SVNHelper_Command_Update_Status[] |
|
| 33 | + */ |
|
| 34 | 34 | protected $stati; |
| 35 | 35 | |
| 36 | 36 | protected $revision; |
| 37 | 37 | |
| 38 | - /** |
|
| 39 | - * Parses the command output to find out which files have been modified, and how. |
|
| 40 | - * @param SVNHelper_CommandResult $result |
|
| 41 | - */ |
|
| 38 | + /** |
|
| 39 | + * Parses the command output to find out which files have been modified, and how. |
|
| 40 | + * @param SVNHelper_CommandResult $result |
|
| 41 | + */ |
|
| 42 | 42 | protected function parseResult(SVNHelper_CommandResult $result) |
| 43 | 43 | { |
| 44 | 44 | $this->stati = array(); |
@@ -119,11 +119,11 @@ discard block |
||
| 119 | 119 | return $this->getByStatus('a'); |
| 120 | 120 | } |
| 121 | 121 | |
| 122 | - /** |
|
| 123 | - * Whether there were files with the specified status code. |
|
| 124 | - * @param string $status |
|
| 125 | - * @return boolean |
|
| 126 | - */ |
|
| 122 | + /** |
|
| 123 | + * Whether there were files with the specified status code. |
|
| 124 | + * @param string $status |
|
| 125 | + * @return boolean |
|
| 126 | + */ |
|
| 127 | 127 | protected function hasStatus($status) |
| 128 | 128 | { |
| 129 | 129 | $this->execute(); |
@@ -24,10 +24,10 @@ discard block |
||
| 24 | 24 | |
| 25 | 25 | const STATUS_FILETYPE_CHANGE = 'filetype-change'; |
| 26 | 26 | |
| 27 | - /** |
|
| 28 | - * @var array |
|
| 29 | - * @see http://svnbook.red-bean.com/en/1.7/svn.ref.svn.c.status.html |
|
| 30 | - */ |
|
| 27 | + /** |
|
| 28 | + * @var array |
|
| 29 | + * @see http://svnbook.red-bean.com/en/1.7/svn.ref.svn.c.status.html |
|
| 30 | + */ |
|
| 31 | 31 | protected static $knownStati = array( |
| 32 | 32 | 'a' => self::STATUS_ADD, |
| 33 | 33 | 'd' => self::STATUS_DELETE, |
@@ -40,9 +40,9 @@ discard block |
||
| 40 | 40 | '~' => self::STATUS_FILETYPE_CHANGE, |
| 41 | 41 | ); |
| 42 | 42 | |
| 43 | - /** |
|
| 44 | - * @var string |
|
| 45 | - */ |
|
| 43 | + /** |
|
| 44 | + * @var string |
|
| 45 | + */ |
|
| 46 | 46 | protected $status; |
| 47 | 47 | |
| 48 | 48 | protected function _execute() |
@@ -65,7 +65,7 @@ discard block |
||
| 65 | 65 | |
| 66 | 66 | $svnStatusCode = strtolower(substr($lines[0], 0, 1)); |
| 67 | 67 | if(isset(self::$knownStati[$svnStatusCode])) { |
| 68 | - $this->status = self::$knownStati[$svnStatusCode]; |
|
| 68 | + $this->status = self::$knownStati[$svnStatusCode]; |
|
| 69 | 69 | } |
| 70 | 70 | } |
| 71 | 71 | |
@@ -14,49 +14,49 @@ discard block |
||
| 14 | 14 | const CONTEXT_COMMAND_LINE = 'cli'; |
| 15 | 15 | const CONTEXT_WEB = 'web'; |
| 16 | 16 | |
| 17 | - /** |
|
| 18 | - * @var \Throwable |
|
| 19 | - */ |
|
| 17 | + /** |
|
| 18 | + * @var \Throwable |
|
| 19 | + */ |
|
| 20 | 20 | protected $exception; |
| 21 | 21 | |
| 22 | - /** |
|
| 23 | - * @var ConvertHelper_ThrowableInfo_Call[] |
|
| 24 | - */ |
|
| 22 | + /** |
|
| 23 | + * @var ConvertHelper_ThrowableInfo_Call[] |
|
| 24 | + */ |
|
| 25 | 25 | protected $calls = array(); |
| 26 | 26 | |
| 27 | - /** |
|
| 28 | - * @var integer |
|
| 29 | - */ |
|
| 27 | + /** |
|
| 28 | + * @var integer |
|
| 29 | + */ |
|
| 30 | 30 | protected $code; |
| 31 | 31 | |
| 32 | - /** |
|
| 33 | - * @var string |
|
| 34 | - */ |
|
| 32 | + /** |
|
| 33 | + * @var string |
|
| 34 | + */ |
|
| 35 | 35 | protected $message; |
| 36 | 36 | |
| 37 | - /** |
|
| 38 | - * @var integer |
|
| 39 | - */ |
|
| 37 | + /** |
|
| 38 | + * @var integer |
|
| 39 | + */ |
|
| 40 | 40 | protected $callsCount = 0; |
| 41 | 41 | |
| 42 | - /** |
|
| 43 | - * @var ConvertHelper_ThrowableInfo |
|
| 44 | - */ |
|
| 42 | + /** |
|
| 43 | + * @var ConvertHelper_ThrowableInfo |
|
| 44 | + */ |
|
| 45 | 45 | protected $previous; |
| 46 | 46 | |
| 47 | - /** |
|
| 48 | - * @var string |
|
| 49 | - */ |
|
| 47 | + /** |
|
| 48 | + * @var string |
|
| 49 | + */ |
|
| 50 | 50 | protected $referer = ''; |
| 51 | 51 | |
| 52 | - /** |
|
| 53 | - * @var \DateTime |
|
| 54 | - */ |
|
| 52 | + /** |
|
| 53 | + * @var \DateTime |
|
| 54 | + */ |
|
| 55 | 55 | protected $date; |
| 56 | 56 | |
| 57 | - /** |
|
| 58 | - * @var string |
|
| 59 | - */ |
|
| 57 | + /** |
|
| 58 | + * @var string |
|
| 59 | + */ |
|
| 60 | 60 | protected $context = self::CONTEXT_WEB; |
| 61 | 61 | |
| 62 | 62 | protected function __construct($subject) |
@@ -103,16 +103,16 @@ discard block |
||
| 103 | 103 | return isset($this->previous); |
| 104 | 104 | } |
| 105 | 105 | |
| 106 | - /** |
|
| 107 | - * Retrieves the information on the previous exception. |
|
| 108 | - * |
|
| 109 | - * NOTE: Throws an exception if there is no previous |
|
| 110 | - * exception. Use hasPrevious() first to avoid this. |
|
| 111 | - * |
|
| 112 | - * @throws ConvertHelper_Exception |
|
| 113 | - * @return ConvertHelper_ThrowableInfo |
|
| 114 | - * @see ConvertHelper_ThrowableInfo::ERROR_NO_PREVIOUS_EXCEPTION |
|
| 115 | - */ |
|
| 106 | + /** |
|
| 107 | + * Retrieves the information on the previous exception. |
|
| 108 | + * |
|
| 109 | + * NOTE: Throws an exception if there is no previous |
|
| 110 | + * exception. Use hasPrevious() first to avoid this. |
|
| 111 | + * |
|
| 112 | + * @throws ConvertHelper_Exception |
|
| 113 | + * @return ConvertHelper_ThrowableInfo |
|
| 114 | + * @see ConvertHelper_ThrowableInfo::ERROR_NO_PREVIOUS_EXCEPTION |
|
| 115 | + */ |
|
| 116 | 116 | public function getPrevious() : ConvertHelper_ThrowableInfo |
| 117 | 117 | { |
| 118 | 118 | if(isset($this->previous)) { |
@@ -131,9 +131,9 @@ discard block |
||
| 131 | 131 | return !empty($this->code); |
| 132 | 132 | } |
| 133 | 133 | |
| 134 | - /** |
|
| 135 | - * Improved textonly exception trace. |
|
| 136 | - */ |
|
| 134 | + /** |
|
| 135 | + * Improved textonly exception trace. |
|
| 136 | + */ |
|
| 137 | 137 | public function toString() : string |
| 138 | 138 | { |
| 139 | 139 | $calls = $this->getCalls(); |
@@ -161,59 +161,59 @@ discard block |
||
| 161 | 161 | return $string; |
| 162 | 162 | } |
| 163 | 163 | |
| 164 | - /** |
|
| 165 | - * Retrieves the URL of the page in which the exception |
|
| 166 | - * was thrown, if applicable: in CLI context, this will |
|
| 167 | - * return an empty string. |
|
| 168 | - * |
|
| 169 | - * @return string |
|
| 170 | - */ |
|
| 164 | + /** |
|
| 165 | + * Retrieves the URL of the page in which the exception |
|
| 166 | + * was thrown, if applicable: in CLI context, this will |
|
| 167 | + * return an empty string. |
|
| 168 | + * |
|
| 169 | + * @return string |
|
| 170 | + */ |
|
| 171 | 171 | public function getReferer() : string |
| 172 | 172 | { |
| 173 | 173 | return $this->referer; |
| 174 | 174 | } |
| 175 | 175 | |
| 176 | - /** |
|
| 177 | - * Whether the exception occurred in a command line context. |
|
| 178 | - * @return bool |
|
| 179 | - */ |
|
| 176 | + /** |
|
| 177 | + * Whether the exception occurred in a command line context. |
|
| 178 | + * @return bool |
|
| 179 | + */ |
|
| 180 | 180 | public function isCommandLine() : bool |
| 181 | 181 | { |
| 182 | 182 | return $this->getContext() === self::CONTEXT_COMMAND_LINE; |
| 183 | 183 | } |
| 184 | 184 | |
| 185 | - /** |
|
| 186 | - * Whether the exception occurred during an http request. |
|
| 187 | - * @return bool |
|
| 188 | - */ |
|
| 185 | + /** |
|
| 186 | + * Whether the exception occurred during an http request. |
|
| 187 | + * @return bool |
|
| 188 | + */ |
|
| 189 | 189 | public function isWebRequest() : bool |
| 190 | 190 | { |
| 191 | 191 | return $this->getContext() === self::CONTEXT_WEB; |
| 192 | 192 | } |
| 193 | 193 | |
| 194 | - /** |
|
| 195 | - * Retrieves the context identifier, i.e. if the exception |
|
| 196 | - * occurred in a command line context or regular web request. |
|
| 197 | - * |
|
| 198 | - * @return string |
|
| 199 | - * |
|
| 200 | - * @see ConvertHelper_ThrowableInfo::isCommandLine() |
|
| 201 | - * @see ConvertHelper_ThrowableInfo::isWebRequest() |
|
| 202 | - * @see ConvertHelper_ThrowableInfo::CONTEXT_COMMAND_LINE |
|
| 203 | - * @see ConvertHelper_ThrowableInfo::CONTEXT_WEB |
|
| 204 | - */ |
|
| 194 | + /** |
|
| 195 | + * Retrieves the context identifier, i.e. if the exception |
|
| 196 | + * occurred in a command line context or regular web request. |
|
| 197 | + * |
|
| 198 | + * @return string |
|
| 199 | + * |
|
| 200 | + * @see ConvertHelper_ThrowableInfo::isCommandLine() |
|
| 201 | + * @see ConvertHelper_ThrowableInfo::isWebRequest() |
|
| 202 | + * @see ConvertHelper_ThrowableInfo::CONTEXT_COMMAND_LINE |
|
| 203 | + * @see ConvertHelper_ThrowableInfo::CONTEXT_WEB |
|
| 204 | + */ |
|
| 205 | 205 | public function getContext() : string |
| 206 | 206 | { |
| 207 | 207 | return $this->context; |
| 208 | 208 | } |
| 209 | 209 | |
| 210 | - /** |
|
| 211 | - * Retrieves the date of the exception, and approximate time: |
|
| 212 | - * since exceptions do not store time, this is captured the |
|
| 213 | - * moment the ThrowableInfo is created. |
|
| 214 | - * |
|
| 215 | - * @return \DateTime |
|
| 216 | - */ |
|
| 210 | + /** |
|
| 211 | + * Retrieves the date of the exception, and approximate time: |
|
| 212 | + * since exceptions do not store time, this is captured the |
|
| 213 | + * moment the ThrowableInfo is created. |
|
| 214 | + * |
|
| 215 | + * @return \DateTime |
|
| 216 | + */ |
|
| 217 | 217 | public function getDate() : \DateTime |
| 218 | 218 | { |
| 219 | 219 | return $this->date; |
@@ -245,13 +245,13 @@ discard block |
||
| 245 | 245 | return $result; |
| 246 | 246 | } |
| 247 | 247 | |
| 248 | - /** |
|
| 249 | - * Sets the maximum folder depth to show in the |
|
| 250 | - * file paths, to avoid them being too long. |
|
| 251 | - * |
|
| 252 | - * @param int $depth |
|
| 253 | - * @return ConvertHelper_ThrowableInfo |
|
| 254 | - */ |
|
| 248 | + /** |
|
| 249 | + * Sets the maximum folder depth to show in the |
|
| 250 | + * file paths, to avoid them being too long. |
|
| 251 | + * |
|
| 252 | + * @param int $depth |
|
| 253 | + * @return ConvertHelper_ThrowableInfo |
|
| 254 | + */ |
|
| 255 | 255 | public function setFolderDepth(int $depth) : ConvertHelper_ThrowableInfo |
| 256 | 256 | { |
| 257 | 257 | return $this->setOption('folder-depth', $depth); |
@@ -262,10 +262,10 @@ discard block |
||
| 262 | 262 | return $this->getOption('folder-depth'); |
| 263 | 263 | } |
| 264 | 264 | |
| 265 | - /** |
|
| 266 | - * Retrieves all function calls that led to the error. |
|
| 267 | - * @return ConvertHelper_ThrowableInfo_Call[] |
|
| 268 | - */ |
|
| 265 | + /** |
|
| 266 | + * Retrieves all function calls that led to the error. |
|
| 267 | + * @return ConvertHelper_ThrowableInfo_Call[] |
|
| 268 | + */ |
|
| 269 | 269 | public function getCalls() |
| 270 | 270 | { |
| 271 | 271 | return $this->calls; |
@@ -12,50 +12,50 @@ discard block |
||
| 12 | 12 | |
| 13 | 13 | const TYPE_SCRIPT_START = 'start'; |
| 14 | 14 | |
| 15 | - /** |
|
| 16 | - * @var ConvertHelper_ThrowableInfo |
|
| 17 | - */ |
|
| 15 | + /** |
|
| 16 | + * @var ConvertHelper_ThrowableInfo |
|
| 17 | + */ |
|
| 18 | 18 | protected $info; |
| 19 | 19 | |
| 20 | - /** |
|
| 21 | - * @var array |
|
| 22 | - */ |
|
| 20 | + /** |
|
| 21 | + * @var array |
|
| 22 | + */ |
|
| 23 | 23 | protected $trace; |
| 24 | 24 | |
| 25 | - /** |
|
| 26 | - * @var VariableInfo[] |
|
| 27 | - */ |
|
| 25 | + /** |
|
| 26 | + * @var VariableInfo[] |
|
| 27 | + */ |
|
| 28 | 28 | protected $args = array(); |
| 29 | 29 | |
| 30 | - /** |
|
| 31 | - * The source file, if any |
|
| 32 | - * @var string |
|
| 33 | - */ |
|
| 30 | + /** |
|
| 31 | + * The source file, if any |
|
| 32 | + * @var string |
|
| 33 | + */ |
|
| 34 | 34 | protected $file = ''; |
| 35 | 35 | |
| 36 | - /** |
|
| 37 | - * @var string |
|
| 38 | - */ |
|
| 36 | + /** |
|
| 37 | + * @var string |
|
| 38 | + */ |
|
| 39 | 39 | protected $class = ''; |
| 40 | 40 | |
| 41 | - /** |
|
| 42 | - * @var integer |
|
| 43 | - */ |
|
| 41 | + /** |
|
| 42 | + * @var integer |
|
| 43 | + */ |
|
| 44 | 44 | protected $line = 0; |
| 45 | 45 | |
| 46 | - /** |
|
| 47 | - * @var int |
|
| 48 | - */ |
|
| 46 | + /** |
|
| 47 | + * @var int |
|
| 48 | + */ |
|
| 49 | 49 | protected $position = 1; |
| 50 | 50 | |
| 51 | - /** |
|
| 52 | - * @var string |
|
| 53 | - */ |
|
| 51 | + /** |
|
| 52 | + * @var string |
|
| 53 | + */ |
|
| 54 | 54 | protected $function = ''; |
| 55 | 55 | |
| 56 | - /** |
|
| 57 | - * @var string |
|
| 58 | - */ |
|
| 56 | + /** |
|
| 57 | + * @var string |
|
| 58 | + */ |
|
| 59 | 59 | protected $type = self::TYPE_SCRIPT_START; |
| 60 | 60 | |
| 61 | 61 | protected function __construct(ConvertHelper_ThrowableInfo $info, array $data) |
@@ -82,10 +82,10 @@ discard block |
||
| 82 | 82 | } |
| 83 | 83 | } |
| 84 | 84 | |
| 85 | - /** |
|
| 86 | - * 1-based position of the call in the calls list. |
|
| 87 | - * @return int |
|
| 88 | - */ |
|
| 85 | + /** |
|
| 86 | + * 1-based position of the call in the calls list. |
|
| 87 | + * @return int |
|
| 88 | + */ |
|
| 89 | 89 | public function getPosition() : int |
| 90 | 90 | { |
| 91 | 91 | return $this->position; |
@@ -96,18 +96,18 @@ discard block |
||
| 96 | 96 | return $this->line; |
| 97 | 97 | } |
| 98 | 98 | |
| 99 | - /** |
|
| 100 | - * Whether the call had any arguments. |
|
| 101 | - * @return bool |
|
| 102 | - */ |
|
| 99 | + /** |
|
| 100 | + * Whether the call had any arguments. |
|
| 101 | + * @return bool |
|
| 102 | + */ |
|
| 103 | 103 | public function hasArguments() : bool |
| 104 | 104 | { |
| 105 | 105 | return !empty($this->args); |
| 106 | 106 | } |
| 107 | 107 | |
| 108 | - /** |
|
| 109 | - * @return VariableInfo[] |
|
| 110 | - */ |
|
| 108 | + /** |
|
| 109 | + * @return VariableInfo[] |
|
| 110 | + */ |
|
| 111 | 111 | public function getArguments() |
| 112 | 112 | { |
| 113 | 113 | return $this->args; |
@@ -240,31 +240,31 @@ discard block |
||
| 240 | 240 | return implode(', ', $tokens); |
| 241 | 241 | } |
| 242 | 242 | |
| 243 | - /** |
|
| 244 | - * Retrieves the type of call: typcially a function |
|
| 245 | - * call, or a method call of an object. Note that the |
|
| 246 | - * first call in a script does not have either. |
|
| 247 | - * |
|
| 248 | - * @return string |
|
| 249 | - * |
|
| 250 | - * @see ConvertHelper_ThrowableInfo_Call::TYPE_FUNCTION_CALL |
|
| 251 | - * @see ConvertHelper_ThrowableInfo_Call::TYPE_METHOD_CALL |
|
| 252 | - * @see ConvertHelper_ThrowableInfo_Call::TYPE_SCRIPT_START |
|
| 253 | - * @see ConvertHelper_ThrowableInfo_Call::hasFunction() |
|
| 254 | - * @see ConvertHelper_ThrowableInfo_Call::hasClass() |
|
| 255 | - */ |
|
| 243 | + /** |
|
| 244 | + * Retrieves the type of call: typcially a function |
|
| 245 | + * call, or a method call of an object. Note that the |
|
| 246 | + * first call in a script does not have either. |
|
| 247 | + * |
|
| 248 | + * @return string |
|
| 249 | + * |
|
| 250 | + * @see ConvertHelper_ThrowableInfo_Call::TYPE_FUNCTION_CALL |
|
| 251 | + * @see ConvertHelper_ThrowableInfo_Call::TYPE_METHOD_CALL |
|
| 252 | + * @see ConvertHelper_ThrowableInfo_Call::TYPE_SCRIPT_START |
|
| 253 | + * @see ConvertHelper_ThrowableInfo_Call::hasFunction() |
|
| 254 | + * @see ConvertHelper_ThrowableInfo_Call::hasClass() |
|
| 255 | + */ |
|
| 256 | 256 | public function getType() : string |
| 257 | 257 | { |
| 258 | 258 | return $this->type; |
| 259 | 259 | } |
| 260 | 260 | |
| 261 | - /** |
|
| 262 | - * Serializes the call to an array, with all |
|
| 263 | - * necessary information. Can be used to restore |
|
| 264 | - * the call later using {@link ConvertHelper_ThrowableInfo_Call::fromSerialized()}. |
|
| 265 | - * |
|
| 266 | - * @return array |
|
| 267 | - */ |
|
| 261 | + /** |
|
| 262 | + * Serializes the call to an array, with all |
|
| 263 | + * necessary information. Can be used to restore |
|
| 264 | + * the call later using {@link ConvertHelper_ThrowableInfo_Call::fromSerialized()}. |
|
| 265 | + * |
|
| 266 | + * @return array |
|
| 267 | + */ |
|
| 268 | 268 | public function serialize() : array |
| 269 | 269 | { |
| 270 | 270 | $result = array( |
@@ -33,19 +33,19 @@ |
||
| 33 | 33 | $this->match = $matchedString; |
| 34 | 34 | } |
| 35 | 35 | |
| 36 | - /** |
|
| 37 | - * The zero-based start position of the string in the haystack. |
|
| 38 | - * @return int |
|
| 39 | - */ |
|
| 36 | + /** |
|
| 37 | + * The zero-based start position of the string in the haystack. |
|
| 38 | + * @return int |
|
| 39 | + */ |
|
| 40 | 40 | public function getPosition() : int |
| 41 | 41 | { |
| 42 | 42 | return $this->position; |
| 43 | 43 | } |
| 44 | 44 | |
| 45 | - /** |
|
| 46 | - * The exact string that was matched, respecting the case as found in needle. |
|
| 47 | - * @return string |
|
| 48 | - */ |
|
| 45 | + /** |
|
| 46 | + * The exact string that was matched, respecting the case as found in needle. |
|
| 47 | + * @return string |
|
| 48 | + */ |
|
| 49 | 49 | public function getMatchedString() : string |
| 50 | 50 | { |
| 51 | 51 | return $this->match; |
@@ -25,19 +25,19 @@ discard block |
||
| 25 | 25 | const TYPE_LF = 'LF'; |
| 26 | 26 | const TYPE_CR = 'CR'; |
| 27 | 27 | |
| 28 | - /** |
|
| 29 | - * @var string |
|
| 30 | - */ |
|
| 28 | + /** |
|
| 29 | + * @var string |
|
| 30 | + */ |
|
| 31 | 31 | protected $char; |
| 32 | 32 | |
| 33 | - /** |
|
| 34 | - * @var string |
|
| 35 | - */ |
|
| 33 | + /** |
|
| 34 | + * @var string |
|
| 35 | + */ |
|
| 36 | 36 | protected $type; |
| 37 | 37 | |
| 38 | - /** |
|
| 39 | - * @var string |
|
| 40 | - */ |
|
| 38 | + /** |
|
| 39 | + * @var string |
|
| 40 | + */ |
|
| 41 | 41 | protected $description; |
| 42 | 42 | |
| 43 | 43 | public function __construct(string $char, string $type, string $description) |
@@ -47,44 +47,44 @@ discard block |
||
| 47 | 47 | $this->description = $description; |
| 48 | 48 | } |
| 49 | 49 | |
| 50 | - /** |
|
| 51 | - * The actual EOL character. |
|
| 52 | - * @return string |
|
| 53 | - */ |
|
| 50 | + /** |
|
| 51 | + * The actual EOL character. |
|
| 52 | + * @return string |
|
| 53 | + */ |
|
| 54 | 54 | public function getCharacter() : string |
| 55 | 55 | { |
| 56 | 56 | return $this->char; |
| 57 | 57 | } |
| 58 | 58 | |
| 59 | - /** |
|
| 60 | - * Checks if the encoding matches the specified encoding string. |
|
| 61 | - * |
|
| 62 | - * @param string $encoding |
|
| 63 | - * @return bool |
|
| 64 | - */ |
|
| 59 | + /** |
|
| 60 | + * Checks if the encoding matches the specified encoding string. |
|
| 61 | + * |
|
| 62 | + * @param string $encoding |
|
| 63 | + * @return bool |
|
| 64 | + */ |
|
| 65 | 65 | public function isEncoding(string $encoding) : bool |
| 66 | 66 | { |
| 67 | 67 | return $this->encoding === $encoding; |
| 68 | 68 | } |
| 69 | 69 | |
| 70 | - /** |
|
| 71 | - * A more detailed, human readable description of the character. |
|
| 72 | - * @return string |
|
| 73 | - */ |
|
| 70 | + /** |
|
| 71 | + * A more detailed, human readable description of the character. |
|
| 72 | + * @return string |
|
| 73 | + */ |
|
| 74 | 74 | public function getDescription() : string |
| 75 | 75 | { |
| 76 | 76 | return $this->description; |
| 77 | 77 | } |
| 78 | 78 | |
| 79 | - /** |
|
| 80 | - * The EOL character type, e.g. "CR+LF", "CR"... |
|
| 81 | - * @return string |
|
| 82 | - * |
|
| 83 | - * @see ConvertHelper_EOL::TYPE_CR |
|
| 84 | - * @see ConvertHelper_EOL::TYPE_CRLF |
|
| 85 | - * @see ConvertHelper_EOL::TYPE_LF |
|
| 86 | - * @see ConvertHelper_EOL::TYPE_LFCR |
|
| 87 | - */ |
|
| 79 | + /** |
|
| 80 | + * The EOL character type, e.g. "CR+LF", "CR"... |
|
| 81 | + * @return string |
|
| 82 | + * |
|
| 83 | + * @see ConvertHelper_EOL::TYPE_CR |
|
| 84 | + * @see ConvertHelper_EOL::TYPE_CRLF |
|
| 85 | + * @see ConvertHelper_EOL::TYPE_LF |
|
| 86 | + * @see ConvertHelper_EOL::TYPE_LFCR |
|
| 87 | + */ |
|
| 88 | 88 | public function getType() : string |
| 89 | 89 | { |
| 90 | 90 | return $this->type; |
@@ -194,13 +194,13 @@ discard block |
||
| 194 | 194 | return $this->knownParams[$name]; |
| 195 | 195 | } |
| 196 | 196 | |
| 197 | - /** |
|
| 198 | - * Retrieves a previously registered parameter instance. |
|
| 199 | - * |
|
| 200 | - * @param string $name |
|
| 201 | - * @throws Request_Exception |
|
| 202 | - * @return Request_Param |
|
| 203 | - */ |
|
| 197 | + /** |
|
| 198 | + * Retrieves a previously registered parameter instance. |
|
| 199 | + * |
|
| 200 | + * @param string $name |
|
| 201 | + * @throws Request_Exception |
|
| 202 | + * @return Request_Param |
|
| 203 | + */ |
|
| 204 | 204 | public function getRegisteredParam(string $name) : Request_Param |
| 205 | 205 | { |
| 206 | 206 | if(isset($this->knownParams[$name])) { |
@@ -217,13 +217,13 @@ discard block |
||
| 217 | 217 | ); |
| 218 | 218 | } |
| 219 | 219 | |
| 220 | - /** |
|
| 221 | - * Checks whether a parameter with the specified name |
|
| 222 | - * has been registered. |
|
| 223 | - * |
|
| 224 | - * @param string $name |
|
| 225 | - * @return bool |
|
| 226 | - */ |
|
| 220 | + /** |
|
| 221 | + * Checks whether a parameter with the specified name |
|
| 222 | + * has been registered. |
|
| 223 | + * |
|
| 224 | + * @param string $name |
|
| 225 | + * @return bool |
|
| 226 | + */ |
|
| 227 | 227 | public function hasRegisteredParam(string $name) : bool |
| 228 | 228 | { |
| 229 | 229 | return isset($this->knownParams[$name]); |
@@ -352,14 +352,14 @@ discard block |
||
| 352 | 352 | return false; |
| 353 | 353 | } |
| 354 | 354 | |
| 355 | - /** |
|
| 356 | - * Removes a single parameter from the request. |
|
| 357 | - * If the parameter has been registered, also |
|
| 358 | - * removes the registration info. |
|
| 359 | - * |
|
| 360 | - * @param string $name |
|
| 361 | - * @return Request |
|
| 362 | - */ |
|
| 355 | + /** |
|
| 356 | + * Removes a single parameter from the request. |
|
| 357 | + * If the parameter has been registered, also |
|
| 358 | + * removes the registration info. |
|
| 359 | + * |
|
| 360 | + * @param string $name |
|
| 361 | + * @return Request |
|
| 362 | + */ |
|
| 363 | 363 | public function removeParam(string $name) : Request |
| 364 | 364 | { |
| 365 | 365 | if(isset($_REQUEST[$name])) { |
@@ -373,12 +373,12 @@ discard block |
||
| 373 | 373 | return $this; |
| 374 | 374 | } |
| 375 | 375 | |
| 376 | - /** |
|
| 377 | - * Removes several parameters from the request. |
|
| 378 | - * |
|
| 379 | - * @param string[] $names |
|
| 380 | - * @return Request |
|
| 381 | - */ |
|
| 376 | + /** |
|
| 377 | + * Removes several parameters from the request. |
|
| 378 | + * |
|
| 379 | + * @param string[] $names |
|
| 380 | + * @return Request |
|
| 381 | + */ |
|
| 382 | 382 | public function removeParams(array $names) : Request |
| 383 | 383 | { |
| 384 | 384 | foreach($names as $name) { |
@@ -443,18 +443,18 @@ discard block |
||
| 443 | 443 | return $val; |
| 444 | 444 | } |
| 445 | 445 | |
| 446 | - /** |
|
| 447 | - * Treats the request parameter as a JSON string, and |
|
| 448 | - * if it exists and contains valid JSON, returns the |
|
| 449 | - * decoded JSON value as an array (default). |
|
| 450 | - * |
|
| 451 | - * @param string $name |
|
| 452 | - * @param bool $assoc |
|
| 453 | - * @return array|object |
|
| 454 | - * |
|
| 455 | - * @see Request::getJSONAssoc() |
|
| 456 | - * @see Request::getJSONObject() |
|
| 457 | - */ |
|
| 446 | + /** |
|
| 447 | + * Treats the request parameter as a JSON string, and |
|
| 448 | + * if it exists and contains valid JSON, returns the |
|
| 449 | + * decoded JSON value as an array (default). |
|
| 450 | + * |
|
| 451 | + * @param string $name |
|
| 452 | + * @param bool $assoc |
|
| 453 | + * @return array|object |
|
| 454 | + * |
|
| 455 | + * @see Request::getJSONAssoc() |
|
| 456 | + * @see Request::getJSONObject() |
|
| 457 | + */ |
|
| 458 | 458 | public function getJSON(string $name, bool $assoc=true) |
| 459 | 459 | { |
| 460 | 460 | $value = $this->getParam($name); |
@@ -479,25 +479,25 @@ discard block |
||
| 479 | 479 | return new \stdClass(); |
| 480 | 480 | } |
| 481 | 481 | |
| 482 | - /** |
|
| 483 | - * Like {@link Request::getJSON()}, but omitting the second |
|
| 484 | - * parameter. Use this for more readable code. |
|
| 485 | - * |
|
| 486 | - * @param string $name |
|
| 487 | - * @return array |
|
| 488 | - */ |
|
| 482 | + /** |
|
| 483 | + * Like {@link Request::getJSON()}, but omitting the second |
|
| 484 | + * parameter. Use this for more readable code. |
|
| 485 | + * |
|
| 486 | + * @param string $name |
|
| 487 | + * @return array |
|
| 488 | + */ |
|
| 489 | 489 | public function getJSONAssoc(string $name) : array |
| 490 | 490 | { |
| 491 | 491 | return $this->getJSON($name); |
| 492 | 492 | } |
| 493 | 493 | |
| 494 | - /** |
|
| 495 | - * Like {@link Request::getJSON()}, but omitting the second |
|
| 496 | - * parameter. Use this for more readable code. |
|
| 497 | - * |
|
| 498 | - * @param string $name |
|
| 499 | - * @return array |
|
| 500 | - */ |
|
| 494 | + /** |
|
| 495 | + * Like {@link Request::getJSON()}, but omitting the second |
|
| 496 | + * parameter. Use this for more readable code. |
|
| 497 | + * |
|
| 498 | + * @param string $name |
|
| 499 | + * @return array |
|
| 500 | + */ |
|
| 501 | 501 | public function getJSONObject(string $name) : object |
| 502 | 502 | { |
| 503 | 503 | return $this->getJSON($name, false); |
@@ -531,16 +531,16 @@ discard block |
||
| 531 | 531 | exit; |
| 532 | 532 | } |
| 533 | 533 | |
| 534 | - /** |
|
| 535 | - * Creates a new instance of the URL comparer, which can check |
|
| 536 | - * whether the specified URLs match, regardless of the order in |
|
| 537 | - * which the query parameters are, if any. |
|
| 538 | - * |
|
| 539 | - * @param string $sourceURL |
|
| 540 | - * @param string $targetURL |
|
| 541 | - * @param array $limitParams Whether to limit the comparison to these specific parameter names (if present) |
|
| 542 | - * @return Request_URLComparer |
|
| 543 | - */ |
|
| 534 | + /** |
|
| 535 | + * Creates a new instance of the URL comparer, which can check |
|
| 536 | + * whether the specified URLs match, regardless of the order in |
|
| 537 | + * which the query parameters are, if any. |
|
| 538 | + * |
|
| 539 | + * @param string $sourceURL |
|
| 540 | + * @param string $targetURL |
|
| 541 | + * @param array $limitParams Whether to limit the comparison to these specific parameter names (if present) |
|
| 542 | + * @return Request_URLComparer |
|
| 543 | + */ |
|
| 544 | 544 | public function createURLComparer(string $sourceURL, string $targetURL, array $limitParams=array()) : Request_URLComparer |
| 545 | 545 | { |
| 546 | 546 | $comparer = new Request_URLComparer($this, $sourceURL, $targetURL); |
@@ -549,10 +549,10 @@ discard block |
||
| 549 | 549 | return $comparer; |
| 550 | 550 | } |
| 551 | 551 | |
| 552 | - /** |
|
| 553 | - * Retrieves the full URL that was used to access the current page. |
|
| 554 | - * @return string |
|
| 555 | - */ |
|
| 552 | + /** |
|
| 553 | + * Retrieves the full URL that was used to access the current page. |
|
| 554 | + * @return string |
|
| 555 | + */ |
|
| 556 | 556 | public function getCurrentURL() : string |
| 557 | 557 | { |
| 558 | 558 | return $_SERVER['HTTP_HOST'].$_SERVER['REQUEST_URI']; |