@@ -142,7 +142,7 @@ |
||
| 142 | 142 | |
| 143 | 143 | protected function getInfoKey(string $name) : string |
| 144 | 144 | { |
| 145 | - if(isset($this->info[$name])) { |
|
| 145 | + if (isset($this->info[$name])) { |
|
| 146 | 146 | return (string)$this->info[$name]; |
| 147 | 147 | } |
| 148 | 148 | |
@@ -19,51 +19,51 @@ discard block |
||
| 19 | 19 | */ |
| 20 | 20 | class RequestHelper_Response |
| 21 | 21 | { |
| 22 | - /** |
|
| 23 | - * @var RequestHelper |
|
| 24 | - */ |
|
| 22 | + /** |
|
| 23 | + * @var RequestHelper |
|
| 24 | + */ |
|
| 25 | 25 | protected $request; |
| 26 | 26 | |
| 27 | - /** |
|
| 28 | - * @var string |
|
| 29 | - */ |
|
| 27 | + /** |
|
| 28 | + * @var string |
|
| 29 | + */ |
|
| 30 | 30 | protected $body = ''; |
| 31 | 31 | |
| 32 | - /** |
|
| 33 | - * @var array |
|
| 34 | - */ |
|
| 32 | + /** |
|
| 33 | + * @var array |
|
| 34 | + */ |
|
| 35 | 35 | protected $info; |
| 36 | 36 | |
| 37 | - /** |
|
| 38 | - * @var bool |
|
| 39 | - */ |
|
| 37 | + /** |
|
| 38 | + * @var bool |
|
| 39 | + */ |
|
| 40 | 40 | protected $isError = false; |
| 41 | 41 | |
| 42 | - /** |
|
| 43 | - * @var string |
|
| 44 | - */ |
|
| 42 | + /** |
|
| 43 | + * @var string |
|
| 44 | + */ |
|
| 45 | 45 | protected $errorMessage = ''; |
| 46 | 46 | |
| 47 | - /** |
|
| 48 | - * @var integer |
|
| 49 | - */ |
|
| 47 | + /** |
|
| 48 | + * @var integer |
|
| 49 | + */ |
|
| 50 | 50 | protected $errorCode = 0; |
| 51 | 51 | |
| 52 | - /** |
|
| 53 | - * @param RequestHelper $helper |
|
| 54 | - * @param array $info The CURL info array from curl_getinfo(). |
|
| 55 | - */ |
|
| 52 | + /** |
|
| 53 | + * @param RequestHelper $helper |
|
| 54 | + * @param array $info The CURL info array from curl_getinfo(). |
|
| 55 | + */ |
|
| 56 | 56 | public function __construct(RequestHelper $helper, array $info) |
| 57 | 57 | { |
| 58 | 58 | $this->request = $helper; |
| 59 | 59 | $this->info = $info; |
| 60 | 60 | } |
| 61 | 61 | |
| 62 | - /** |
|
| 63 | - * Retrieves the request instance that initiated the request. |
|
| 64 | - * |
|
| 65 | - * @return RequestHelper |
|
| 66 | - */ |
|
| 62 | + /** |
|
| 63 | + * Retrieves the request instance that initiated the request. |
|
| 64 | + * |
|
| 65 | + * @return RequestHelper |
|
| 66 | + */ |
|
| 67 | 67 | public function getRequest() : RequestHelper |
| 68 | 68 | { |
| 69 | 69 | return $this->request; |
@@ -84,70 +84,70 @@ discard block |
||
| 84 | 84 | return $this; |
| 85 | 85 | } |
| 86 | 86 | |
| 87 | - /** |
|
| 88 | - * Whether an error occurred in the request. |
|
| 89 | - * @return bool |
|
| 90 | - */ |
|
| 87 | + /** |
|
| 88 | + * Whether an error occurred in the request. |
|
| 89 | + * @return bool |
|
| 90 | + */ |
|
| 91 | 91 | public function isError() : bool |
| 92 | 92 | { |
| 93 | 93 | return $this->isError; |
| 94 | 94 | } |
| 95 | 95 | |
| 96 | - /** |
|
| 97 | - * Retrieves the native error message, if an error occurred. |
|
| 98 | - * @return string |
|
| 99 | - */ |
|
| 96 | + /** |
|
| 97 | + * Retrieves the native error message, if an error occurred. |
|
| 98 | + * @return string |
|
| 99 | + */ |
|
| 100 | 100 | public function getErrorMessage() : string |
| 101 | 101 | { |
| 102 | 102 | return $this->errorMessage; |
| 103 | 103 | } |
| 104 | 104 | |
| 105 | - /** |
|
| 106 | - * Retrieves the native error code, if an error occurred. |
|
| 107 | - * @return int |
|
| 108 | - */ |
|
| 105 | + /** |
|
| 106 | + * Retrieves the native error code, if an error occurred. |
|
| 107 | + * @return int |
|
| 108 | + */ |
|
| 109 | 109 | public function getErrorCode() : int |
| 110 | 110 | { |
| 111 | 111 | return $this->errorCode; |
| 112 | 112 | } |
| 113 | 113 | |
| 114 | 114 | |
| 115 | - /** |
|
| 116 | - * Retrieves the full body of the request. |
|
| 117 | - * |
|
| 118 | - * @return string |
|
| 119 | - */ |
|
| 115 | + /** |
|
| 116 | + * Retrieves the full body of the request. |
|
| 117 | + * |
|
| 118 | + * @return string |
|
| 119 | + */ |
|
| 120 | 120 | public function getRequestBody() : string |
| 121 | 121 | { |
| 122 | 122 | return $this->request->getBody(); |
| 123 | 123 | } |
| 124 | 124 | |
| 125 | - /** |
|
| 126 | - * Retrieves the body of the response, if any. |
|
| 127 | - * |
|
| 128 | - * @return string |
|
| 129 | - */ |
|
| 125 | + /** |
|
| 126 | + * Retrieves the body of the response, if any. |
|
| 127 | + * |
|
| 128 | + * @return string |
|
| 129 | + */ |
|
| 130 | 130 | public function getResponseBody() : string |
| 131 | 131 | { |
| 132 | 132 | return $this->body; |
| 133 | 133 | } |
| 134 | 134 | |
| 135 | - /** |
|
| 136 | - * The response HTTP code. |
|
| 137 | - * |
|
| 138 | - * @return int The code, or 0 if none was sent (on error). |
|
| 139 | - */ |
|
| 135 | + /** |
|
| 136 | + * The response HTTP code. |
|
| 137 | + * |
|
| 138 | + * @return int The code, or 0 if none was sent (on error). |
|
| 139 | + */ |
|
| 140 | 140 | public function getCode() : int |
| 141 | 141 | { |
| 142 | 142 | return intval($this->getInfoKey('http_code')); |
| 143 | 143 | } |
| 144 | 144 | |
| 145 | - /** |
|
| 146 | - * Retrieves the actual headers that were sent in the request: |
|
| 147 | - * one header by entry in the indexed array. |
|
| 148 | - * |
|
| 149 | - * @return array |
|
| 150 | - */ |
|
| 145 | + /** |
|
| 146 | + * Retrieves the actual headers that were sent in the request: |
|
| 147 | + * one header by entry in the indexed array. |
|
| 148 | + * |
|
| 149 | + * @return array |
|
| 150 | + */ |
|
| 151 | 151 | public function getHeaders() : array |
| 152 | 152 | { |
| 153 | 153 | return ConvertHelper::explodeTrim("\n", $this->getInfoKey('request_header')); |
@@ -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; |
@@ -91,7 +91,7 @@ discard block |
||
| 91 | 91 | $lines[] = '--'.$this->boundaries->getMimeBoundary(); |
| 92 | 92 | $lines[] = $this->renderContentDisposition(); |
| 93 | 93 | |
| 94 | - if(!empty($this->contentType)) { |
|
| 94 | + if (!empty($this->contentType)) { |
|
| 95 | 95 | $lines[] = $this->renderContentType(); |
| 96 | 96 | } |
| 97 | 97 | |
@@ -105,9 +105,9 @@ discard block |
||
| 105 | 105 | { |
| 106 | 106 | $result = 'Content-Disposition: form-data'; |
| 107 | 107 | |
| 108 | - foreach($this->dispositionParams as $name => $value) |
|
| 108 | + foreach ($this->dispositionParams as $name => $value) |
|
| 109 | 109 | { |
| 110 | - $result .= '; '.$name.'="' . $value . '"'; |
|
| 110 | + $result .= '; '.$name.'="'.$value.'"'; |
|
| 111 | 111 | } |
| 112 | 112 | |
| 113 | 113 | return $result; |
@@ -115,11 +115,11 @@ discard block |
||
| 115 | 115 | |
| 116 | 116 | protected function renderContentType() : string |
| 117 | 117 | { |
| 118 | - $result = 'Content-Type: ' . $this->contentType; |
|
| 118 | + $result = 'Content-Type: '.$this->contentType; |
|
| 119 | 119 | |
| 120 | - if(!empty($this->contentEncoding)) |
|
| 120 | + if (!empty($this->contentEncoding)) |
|
| 121 | 121 | { |
| 122 | - $result .= '; charset=' . $this->contentEncoding; |
|
| 122 | + $result .= '; charset='.$this->contentEncoding; |
|
| 123 | 123 | } |
| 124 | 124 | |
| 125 | 125 | return $result; |
@@ -19,29 +19,29 @@ 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 | 47 | public function __construct(RequestHelper_Boundaries $boundaries, string $content) |
@@ -55,46 +55,46 @@ discard block |
||
| 55 | 55 | return strlen($this->content); |
| 56 | 56 | } |
| 57 | 57 | |
| 58 | - /** |
|
| 59 | - * Sets the name of the request parameter. |
|
| 60 | - * |
|
| 61 | - * @param string $name |
|
| 62 | - * @return RequestHelper_Boundaries_Boundary |
|
| 63 | - */ |
|
| 58 | + /** |
|
| 59 | + * Sets the name of the request parameter. |
|
| 60 | + * |
|
| 61 | + * @param string $name |
|
| 62 | + * @return RequestHelper_Boundaries_Boundary |
|
| 63 | + */ |
|
| 64 | 64 | public function setName(string $name) : RequestHelper_Boundaries_Boundary |
| 65 | 65 | { |
| 66 | 66 | return $this->setDispositionParam('name', $name); |
| 67 | 67 | } |
| 68 | 68 | |
| 69 | - /** |
|
| 70 | - * Sets the filename to use for the content, if applicable. |
|
| 71 | - * |
|
| 72 | - * @param string $fileName |
|
| 73 | - * @return RequestHelper_Boundaries_Boundary |
|
| 74 | - */ |
|
| 69 | + /** |
|
| 70 | + * Sets the filename to use for the content, if applicable. |
|
| 71 | + * |
|
| 72 | + * @param string $fileName |
|
| 73 | + * @return RequestHelper_Boundaries_Boundary |
|
| 74 | + */ |
|
| 75 | 75 | public function setFileName(string $fileName) : RequestHelper_Boundaries_Boundary |
| 76 | 76 | { |
| 77 | 77 | return $this->setDispositionParam('filename', $fileName); |
| 78 | 78 | } |
| 79 | 79 | |
| 80 | - /** |
|
| 81 | - * Sets the content type to use for the content. |
|
| 82 | - * |
|
| 83 | - * @param string $contentType |
|
| 84 | - * @return RequestHelper_Boundaries_Boundary |
|
| 85 | - */ |
|
| 80 | + /** |
|
| 81 | + * Sets the content type to use for the content. |
|
| 82 | + * |
|
| 83 | + * @param string $contentType |
|
| 84 | + * @return RequestHelper_Boundaries_Boundary |
|
| 85 | + */ |
|
| 86 | 86 | public function setContentType(string $contentType) : RequestHelper_Boundaries_Boundary |
| 87 | 87 | { |
| 88 | 88 | $this->contentType = $contentType; |
| 89 | 89 | return $this; |
| 90 | 90 | } |
| 91 | 91 | |
| 92 | - /** |
|
| 93 | - * Sets the encoding to specify for the content. |
|
| 94 | - * |
|
| 95 | - * @param string $encoding An encoding string, e.g. "UTF-8", "ASCII" |
|
| 96 | - * @return RequestHelper_Boundaries_Boundary |
|
| 97 | - */ |
|
| 92 | + /** |
|
| 93 | + * Sets the encoding to specify for the content. |
|
| 94 | + * |
|
| 95 | + * @param string $encoding An encoding string, e.g. "UTF-8", "ASCII" |
|
| 96 | + * @return RequestHelper_Boundaries_Boundary |
|
| 97 | + */ |
|
| 98 | 98 | public function setContentEncoding(string $encoding) : RequestHelper_Boundaries_Boundary |
| 99 | 99 | { |
| 100 | 100 | $this->contentEncoding = $encoding; |
@@ -107,11 +107,11 @@ discard block |
||
| 107 | 107 | return $this; |
| 108 | 108 | } |
| 109 | 109 | |
| 110 | - /** |
|
| 111 | - * Renders the mime boundary text. |
|
| 112 | - * |
|
| 113 | - * @return string |
|
| 114 | - */ |
|
| 110 | + /** |
|
| 111 | + * Renders the mime boundary text. |
|
| 112 | + * |
|
| 113 | + * @return string |
|
| 114 | + */ |
|
| 115 | 115 | public function render() |
| 116 | 116 | { |
| 117 | 117 | $eol = $this->boundaries->getEOL(); |
@@ -22,19 +22,19 @@ discard block |
||
| 22 | 22 | { |
| 23 | 23 | const ERROR_NO_BOUNDARIES_SPECIFIED = 44401; |
| 24 | 24 | |
| 25 | - /** |
|
| 26 | - * @var RequestHelper |
|
| 27 | - */ |
|
| 25 | + /** |
|
| 26 | + * @var RequestHelper |
|
| 27 | + */ |
|
| 28 | 28 | protected $helper; |
| 29 | 29 | |
| 30 | - /** |
|
| 31 | - * @var RequestHelper_Boundaries_Boundary[] |
|
| 32 | - */ |
|
| 30 | + /** |
|
| 31 | + * @var RequestHelper_Boundaries_Boundary[] |
|
| 32 | + */ |
|
| 33 | 33 | protected $boundaries = array(); |
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * @var integer |
|
| 37 | - */ |
|
| 35 | + /** |
|
| 36 | + * @var integer |
|
| 37 | + */ |
|
| 38 | 38 | protected $contentLength = 0; |
| 39 | 39 | |
| 40 | 40 | public function __construct(RequestHelper $helper) |
@@ -42,45 +42,45 @@ discard block |
||
| 42 | 42 | $this->helper = $helper; |
| 43 | 43 | } |
| 44 | 44 | |
| 45 | - /** |
|
| 46 | - * Retrieves the string that is used to separate mime boundaries in the body. |
|
| 47 | - * |
|
| 48 | - * @return string |
|
| 49 | - */ |
|
| 45 | + /** |
|
| 46 | + * Retrieves the string that is used to separate mime boundaries in the body. |
|
| 47 | + * |
|
| 48 | + * @return string |
|
| 49 | + */ |
|
| 50 | 50 | public function getMimeBoundary() : string |
| 51 | 51 | { |
| 52 | 52 | return $this->helper->getMimeBoundary(); |
| 53 | 53 | } |
| 54 | 54 | |
| 55 | - /** |
|
| 56 | - * Retrieves the end of line character(s) used in the body. |
|
| 57 | - * |
|
| 58 | - * @return string |
|
| 59 | - */ |
|
| 55 | + /** |
|
| 56 | + * Retrieves the end of line character(s) used in the body. |
|
| 57 | + * |
|
| 58 | + * @return string |
|
| 59 | + */ |
|
| 60 | 60 | public function getEOL() : string |
| 61 | 61 | { |
| 62 | 62 | return $this->helper->getEOL(); |
| 63 | 63 | } |
| 64 | 64 | |
| 65 | - /** |
|
| 66 | - * Retrieves the total content length of all boundary contents. |
|
| 67 | - * |
|
| 68 | - * @return int |
|
| 69 | - */ |
|
| 65 | + /** |
|
| 66 | + * Retrieves the total content length of all boundary contents. |
|
| 67 | + * |
|
| 68 | + * @return int |
|
| 69 | + */ |
|
| 70 | 70 | public function getContentLength() : int |
| 71 | 71 | { |
| 72 | 72 | return $this->contentLength; |
| 73 | 73 | } |
| 74 | 74 | |
| 75 | - /** |
|
| 76 | - * Adds a file to be sent with the request. |
|
| 77 | - * |
|
| 78 | - * @param string $varName The variable name to send the file in |
|
| 79 | - * @param string $fileName The name of the file as it should be received at the destination |
|
| 80 | - * @param string $content The raw content of the file |
|
| 81 | - * @param string $contentType The content type, use the constants to specify this |
|
| 82 | - * @param string $encoding The encoding of the file, use the constants to specify this |
|
| 83 | - */ |
|
| 75 | + /** |
|
| 76 | + * Adds a file to be sent with the request. |
|
| 77 | + * |
|
| 78 | + * @param string $varName The variable name to send the file in |
|
| 79 | + * @param string $fileName The name of the file as it should be received at the destination |
|
| 80 | + * @param string $content The raw content of the file |
|
| 81 | + * @param string $contentType The content type, use the constants to specify this |
|
| 82 | + * @param string $encoding The encoding of the file, use the constants to specify this |
|
| 83 | + */ |
|
| 84 | 84 | public function addFile(string $varName, string $fileName, string $content, string $contentType = RequestHelper::FILETYPE_TEXT, string $encoding = RequestHelper::ENCODING_UTF8) : RequestHelper_Boundaries |
| 85 | 85 | { |
| 86 | 86 | $boundary = $this->createBoundary(chunk_split(base64_encode($content))) |
@@ -92,13 +92,13 @@ discard block |
||
| 92 | 92 | return $this->addBoundary($boundary); |
| 93 | 93 | } |
| 94 | 94 | |
| 95 | - /** |
|
| 96 | - * Adds arbitrary content. |
|
| 97 | - * |
|
| 98 | - * @param string $varName |
|
| 99 | - * @param string $content |
|
| 100 | - * @param string $contentType |
|
| 101 | - */ |
|
| 95 | + /** |
|
| 96 | + * Adds arbitrary content. |
|
| 97 | + * |
|
| 98 | + * @param string $varName |
|
| 99 | + * @param string $content |
|
| 100 | + * @param string $contentType |
|
| 101 | + */ |
|
| 102 | 102 | public function addContent(string $varName, string $content, string $contentType) : RequestHelper_Boundaries |
| 103 | 103 | { |
| 104 | 104 | $boundary = $this->createBoundary($content) |
@@ -109,13 +109,13 @@ discard block |
||
| 109 | 109 | return $this->addBoundary($boundary); |
| 110 | 110 | } |
| 111 | 111 | |
| 112 | - /** |
|
| 113 | - * Adds a variable to be sent with the request. If it |
|
| 114 | - * already exists, its value is overwritten. |
|
| 115 | - * |
|
| 116 | - * @param string $name |
|
| 117 | - * @param string $value |
|
| 118 | - */ |
|
| 112 | + /** |
|
| 113 | + * Adds a variable to be sent with the request. If it |
|
| 114 | + * already exists, its value is overwritten. |
|
| 115 | + * |
|
| 116 | + * @param string $name |
|
| 117 | + * @param string $value |
|
| 118 | + */ |
|
| 119 | 119 | public function addVariable(string $name, string $value) : RequestHelper_Boundaries |
| 120 | 120 | { |
| 121 | 121 | $boundary = $this->createBoundary($value) |
@@ -132,11 +132,11 @@ discard block |
||
| 132 | 132 | return $this; |
| 133 | 133 | } |
| 134 | 134 | |
| 135 | - /** |
|
| 136 | - * Renders the response body with all mime boundaries. |
|
| 137 | - * |
|
| 138 | - * @return string |
|
| 139 | - */ |
|
| 135 | + /** |
|
| 136 | + * Renders the response body with all mime boundaries. |
|
| 137 | + * |
|
| 138 | + * @return string |
|
| 139 | + */ |
|
| 140 | 140 | public function render() : string |
| 141 | 141 | { |
| 142 | 142 | if(empty($this->boundaries)) |
@@ -139,7 +139,7 @@ discard block |
||
| 139 | 139 | */ |
| 140 | 140 | public function render() : string |
| 141 | 141 | { |
| 142 | - if(empty($this->boundaries)) |
|
| 142 | + if (empty($this->boundaries)) |
|
| 143 | 143 | { |
| 144 | 144 | throw new RequestHelper_Exception( |
| 145 | 145 | 'No mime boundaries added', |
@@ -150,13 +150,13 @@ discard block |
||
| 150 | 150 | |
| 151 | 151 | $result = ''; |
| 152 | 152 | |
| 153 | - foreach($this->boundaries as $boundary) |
|
| 153 | + foreach ($this->boundaries as $boundary) |
|
| 154 | 154 | { |
| 155 | 155 | $result .= $boundary->render(); |
| 156 | 156 | } |
| 157 | 157 | |
| 158 | - $result .= "--" . $this->getMimeBoundary() . "--" . |
|
| 159 | - $this->getEOL() . $this->getEOL(); // always finish with two eol's!! |
|
| 158 | + $result .= "--".$this->getMimeBoundary()."--". |
|
| 159 | + $this->getEOL().$this->getEOL(); // always finish with two eol's!! |
|
| 160 | 160 | |
| 161 | 161 | return $result; |
| 162 | 162 | } |
@@ -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(); |
@@ -39,7 +39,7 @@ discard block |
||
| 39 | 39 | * @param bool $enable Whether to turn it on or off. |
| 40 | 40 | * @return URLInfo_Normalizer |
| 41 | 41 | */ |
| 42 | - public function enableAuth(bool $enable=true) : URLInfo_Normalizer |
|
| 42 | + public function enableAuth(bool $enable = true) : URLInfo_Normalizer |
|
| 43 | 43 | { |
| 44 | 44 | $this->auth = $enable; |
| 45 | 45 | return $this; |
@@ -86,48 +86,48 @@ discard block |
||
| 86 | 86 | |
| 87 | 87 | protected function renderAuth(string $normalized) : string |
| 88 | 88 | { |
| 89 | - if(!$this->info->hasUsername() || !$this->auth) { |
|
| 89 | + if (!$this->info->hasUsername() || !$this->auth) { |
|
| 90 | 90 | return $normalized; |
| 91 | 91 | } |
| 92 | 92 | |
| 93 | - return $normalized . urlencode($this->info->getUsername()).':'.urlencode($this->info->getPassword()).'@'; |
|
| 93 | + return $normalized.urlencode($this->info->getUsername()).':'.urlencode($this->info->getPassword()).'@'; |
|
| 94 | 94 | } |
| 95 | 95 | |
| 96 | 96 | protected function renderPort(string $normalized) : string |
| 97 | 97 | { |
| 98 | - if(!$this->info->hasPort()) { |
|
| 98 | + if (!$this->info->hasPort()) { |
|
| 99 | 99 | return $normalized; |
| 100 | 100 | } |
| 101 | 101 | |
| 102 | - return $normalized . ':'.$this->info->getPort(); |
|
| 102 | + return $normalized.':'.$this->info->getPort(); |
|
| 103 | 103 | } |
| 104 | 104 | |
| 105 | 105 | protected function renderPath(string $normalized) : string |
| 106 | 106 | { |
| 107 | - if(!$this->info->hasPath()) { |
|
| 107 | + if (!$this->info->hasPath()) { |
|
| 108 | 108 | return $normalized; |
| 109 | 109 | } |
| 110 | 110 | |
| 111 | - return $normalized . $this->info->getPath(); |
|
| 111 | + return $normalized.$this->info->getPath(); |
|
| 112 | 112 | } |
| 113 | 113 | |
| 114 | 114 | protected function renderParams(string $normalized) : string |
| 115 | 115 | { |
| 116 | 116 | $params = $this->info->getParams(); |
| 117 | 117 | |
| 118 | - if(empty($params)) { |
|
| 118 | + if (empty($params)) { |
|
| 119 | 119 | return $normalized; |
| 120 | 120 | } |
| 121 | 121 | |
| 122 | - return $normalized . '?'.http_build_query($params); |
|
| 122 | + return $normalized.'?'.http_build_query($params); |
|
| 123 | 123 | } |
| 124 | 124 | |
| 125 | 125 | protected function renderFragment(string $normalized) : string |
| 126 | 126 | { |
| 127 | - if(!$this->info->hasFragment()) { |
|
| 127 | + if (!$this->info->hasFragment()) { |
|
| 128 | 128 | return $normalized; |
| 129 | 129 | } |
| 130 | 130 | |
| 131 | - return $normalized . '#'.$this->info->getFragment(); |
|
| 131 | + return $normalized.'#'.$this->info->getFragment(); |
|
| 132 | 132 | } |
| 133 | 133 | } |
@@ -39,42 +39,42 @@ discard block |
||
| 39 | 39 | const TYPE_PHONE = 'phone'; |
| 40 | 40 | const TYPE_URL = 'url'; |
| 41 | 41 | |
| 42 | - /** |
|
| 43 | - * The original URL that was passed to the constructor. |
|
| 44 | - * @var string |
|
| 45 | - */ |
|
| 42 | + /** |
|
| 43 | + * The original URL that was passed to the constructor. |
|
| 44 | + * @var string |
|
| 45 | + */ |
|
| 46 | 46 | protected $rawURL; |
| 47 | 47 | |
| 48 | - /** |
|
| 49 | - * @var array |
|
| 50 | - */ |
|
| 48 | + /** |
|
| 49 | + * @var array |
|
| 50 | + */ |
|
| 51 | 51 | protected $info; |
| 52 | 52 | |
| 53 | - /** |
|
| 54 | - * @var string[] |
|
| 55 | - */ |
|
| 53 | + /** |
|
| 54 | + * @var string[] |
|
| 55 | + */ |
|
| 56 | 56 | protected $excludedParams = array(); |
| 57 | 57 | |
| 58 | - /** |
|
| 59 | - * @var bool |
|
| 60 | - * @see URLInfo::setParamExclusion() |
|
| 61 | - */ |
|
| 58 | + /** |
|
| 59 | + * @var bool |
|
| 60 | + * @see URLInfo::setParamExclusion() |
|
| 61 | + */ |
|
| 62 | 62 | protected $paramExclusion = false; |
| 63 | 63 | |
| 64 | - /** |
|
| 65 | - * @var array |
|
| 66 | - * @see URLInfo::getTypeLabel() |
|
| 67 | - */ |
|
| 64 | + /** |
|
| 65 | + * @var array |
|
| 66 | + * @see URLInfo::getTypeLabel() |
|
| 67 | + */ |
|
| 68 | 68 | protected static $typeLabels; |
| 69 | 69 | |
| 70 | - /** |
|
| 71 | - * @var bool |
|
| 72 | - */ |
|
| 70 | + /** |
|
| 71 | + * @var bool |
|
| 72 | + */ |
|
| 73 | 73 | protected $highlightExcluded = false; |
| 74 | 74 | |
| 75 | - /** |
|
| 76 | - * @var array |
|
| 77 | - */ |
|
| 75 | + /** |
|
| 76 | + * @var array |
|
| 77 | + */ |
|
| 78 | 78 | protected $infoKeys = array( |
| 79 | 79 | 'scheme', |
| 80 | 80 | 'host', |
@@ -86,19 +86,19 @@ discard block |
||
| 86 | 86 | 'fragment' |
| 87 | 87 | ); |
| 88 | 88 | |
| 89 | - /** |
|
| 90 | - * @var string |
|
| 91 | - */ |
|
| 89 | + /** |
|
| 90 | + * @var string |
|
| 91 | + */ |
|
| 92 | 92 | protected $url; |
| 93 | 93 | |
| 94 | - /** |
|
| 95 | - * @var URLInfo_Parser |
|
| 96 | - */ |
|
| 94 | + /** |
|
| 95 | + * @var URLInfo_Parser |
|
| 96 | + */ |
|
| 97 | 97 | protected $parser; |
| 98 | 98 | |
| 99 | - /** |
|
| 100 | - * @var URLInfo_Normalizer |
|
| 101 | - */ |
|
| 99 | + /** |
|
| 100 | + * @var URLInfo_Normalizer |
|
| 101 | + */ |
|
| 102 | 102 | protected $normalizer; |
| 103 | 103 | |
| 104 | 104 | public function __construct(string $url) |
@@ -110,13 +110,13 @@ discard block |
||
| 110 | 110 | $this->info = $this->parser->getInfo(); |
| 111 | 111 | } |
| 112 | 112 | |
| 113 | - /** |
|
| 114 | - * Filters an URL: removes control characters and the |
|
| 115 | - * like to have a clean URL to work with. |
|
| 116 | - * |
|
| 117 | - * @param string $url |
|
| 118 | - * @return string |
|
| 119 | - */ |
|
| 113 | + /** |
|
| 114 | + * Filters an URL: removes control characters and the |
|
| 115 | + * like to have a clean URL to work with. |
|
| 116 | + * |
|
| 117 | + * @param string $url |
|
| 118 | + * @return string |
|
| 119 | + */ |
|
| 120 | 120 | public static function filterURL(string $url) |
| 121 | 121 | { |
| 122 | 122 | return URLInfo_Filter::filter($url); |
@@ -146,12 +146,12 @@ discard block |
||
| 146 | 146 | return $this->info['type'] === self::TYPE_PHONE; |
| 147 | 147 | } |
| 148 | 148 | |
| 149 | - /** |
|
| 150 | - * Whether the URL is a regular URL, not one of the |
|
| 151 | - * other types like a phone number or email address. |
|
| 152 | - * |
|
| 153 | - * @return bool |
|
| 154 | - */ |
|
| 149 | + /** |
|
| 150 | + * Whether the URL is a regular URL, not one of the |
|
| 151 | + * other types like a phone number or email address. |
|
| 152 | + * |
|
| 153 | + * @return bool |
|
| 154 | + */ |
|
| 155 | 155 | public function isURL() : bool |
| 156 | 156 | { |
| 157 | 157 | $host = $this->getHost(); |
@@ -163,20 +163,20 @@ discard block |
||
| 163 | 163 | return $this->parser->isValid(); |
| 164 | 164 | } |
| 165 | 165 | |
| 166 | - /** |
|
| 167 | - * Retrieves the host name, or an empty string if none is present. |
|
| 168 | - * |
|
| 169 | - * @return string |
|
| 170 | - */ |
|
| 166 | + /** |
|
| 167 | + * Retrieves the host name, or an empty string if none is present. |
|
| 168 | + * |
|
| 169 | + * @return string |
|
| 170 | + */ |
|
| 171 | 171 | public function getHost() : string |
| 172 | 172 | { |
| 173 | 173 | return $this->getInfoKey('host'); |
| 174 | 174 | } |
| 175 | 175 | |
| 176 | - /** |
|
| 177 | - * Retrieves the path, or an empty string if none is present. |
|
| 178 | - * @return string |
|
| 179 | - */ |
|
| 176 | + /** |
|
| 177 | + * Retrieves the path, or an empty string if none is present. |
|
| 178 | + * @return string |
|
| 179 | + */ |
|
| 180 | 180 | public function getPath() : string |
| 181 | 181 | { |
| 182 | 182 | return $this->getInfoKey('path'); |
@@ -192,10 +192,10 @@ discard block |
||
| 192 | 192 | return $this->getInfoKey('scheme'); |
| 193 | 193 | } |
| 194 | 194 | |
| 195 | - /** |
|
| 196 | - * Retrieves the port specified in the URL, or -1 if none is preseent. |
|
| 197 | - * @return int |
|
| 198 | - */ |
|
| 195 | + /** |
|
| 196 | + * Retrieves the port specified in the URL, or -1 if none is preseent. |
|
| 197 | + * @return int |
|
| 198 | + */ |
|
| 199 | 199 | public function getPort() : int |
| 200 | 200 | { |
| 201 | 201 | $port = $this->getInfoKey('port'); |
@@ -207,13 +207,13 @@ discard block |
||
| 207 | 207 | return -1; |
| 208 | 208 | } |
| 209 | 209 | |
| 210 | - /** |
|
| 211 | - * Retrieves the raw query string, or an empty string if none is present. |
|
| 212 | - * |
|
| 213 | - * @return string |
|
| 214 | - * |
|
| 215 | - * @see URLInfo::getParams() |
|
| 216 | - */ |
|
| 210 | + /** |
|
| 211 | + * Retrieves the raw query string, or an empty string if none is present. |
|
| 212 | + * |
|
| 213 | + * @return string |
|
| 214 | + * |
|
| 215 | + * @see URLInfo::getParams() |
|
| 216 | + */ |
|
| 217 | 217 | public function getQuery() : string |
| 218 | 218 | { |
| 219 | 219 | return $this->getInfoKey('query'); |
@@ -229,20 +229,20 @@ discard block |
||
| 229 | 229 | return $this->getInfoKey('pass'); |
| 230 | 230 | } |
| 231 | 231 | |
| 232 | - /** |
|
| 233 | - * Whether the URL contains a port number. |
|
| 234 | - * @return bool |
|
| 235 | - */ |
|
| 232 | + /** |
|
| 233 | + * Whether the URL contains a port number. |
|
| 234 | + * @return bool |
|
| 235 | + */ |
|
| 236 | 236 | public function hasPort() : bool |
| 237 | 237 | { |
| 238 | 238 | return $this->getPort() !== -1; |
| 239 | 239 | } |
| 240 | 240 | |
| 241 | - /** |
|
| 242 | - * Alias for the hasParams() method. |
|
| 243 | - * @return bool |
|
| 244 | - * @see URLInfo::hasParams() |
|
| 245 | - */ |
|
| 241 | + /** |
|
| 242 | + * Alias for the hasParams() method. |
|
| 243 | + * @return bool |
|
| 244 | + * @see URLInfo::hasParams() |
|
| 245 | + */ |
|
| 246 | 246 | public function hasQuery() : bool |
| 247 | 247 | { |
| 248 | 248 | return $this->hasParams(); |
@@ -287,23 +287,23 @@ discard block |
||
| 287 | 287 | return ''; |
| 288 | 288 | } |
| 289 | 289 | |
| 290 | - /** |
|
| 291 | - * Retrieves a normalized URL: this ensures that all parameters |
|
| 292 | - * in the URL are always in the same order. |
|
| 293 | - * |
|
| 294 | - * @return string |
|
| 295 | - */ |
|
| 290 | + /** |
|
| 291 | + * Retrieves a normalized URL: this ensures that all parameters |
|
| 292 | + * in the URL are always in the same order. |
|
| 293 | + * |
|
| 294 | + * @return string |
|
| 295 | + */ |
|
| 296 | 296 | public function getNormalized() : string |
| 297 | 297 | { |
| 298 | 298 | return $this->normalize(true); |
| 299 | 299 | } |
| 300 | 300 | |
| 301 | - /** |
|
| 302 | - * Like getNormalized(), but if a username and password are present |
|
| 303 | - * in the URL, returns the URL without them. |
|
| 304 | - * |
|
| 305 | - * @return string |
|
| 306 | - */ |
|
| 301 | + /** |
|
| 302 | + * Like getNormalized(), but if a username and password are present |
|
| 303 | + * in the URL, returns the URL without them. |
|
| 304 | + * |
|
| 305 | + * @return string |
|
| 306 | + */ |
|
| 307 | 307 | public function getNormalizedWithoutAuth() : string |
| 308 | 308 | { |
| 309 | 309 | return $this->normalize(false); |
@@ -324,25 +324,25 @@ discard block |
||
| 324 | 324 | return $this->normalizer->normalize(); |
| 325 | 325 | } |
| 326 | 326 | |
| 327 | - /** |
|
| 328 | - * Creates a hash of the URL, which can be used for comparisons. |
|
| 329 | - * Since any parameters in the URL's query are sorted alphabetically, |
|
| 330 | - * the same links with a different parameter order will have the |
|
| 331 | - * same hash. |
|
| 332 | - * |
|
| 333 | - * @return string |
|
| 334 | - */ |
|
| 327 | + /** |
|
| 328 | + * Creates a hash of the URL, which can be used for comparisons. |
|
| 329 | + * Since any parameters in the URL's query are sorted alphabetically, |
|
| 330 | + * the same links with a different parameter order will have the |
|
| 331 | + * same hash. |
|
| 332 | + * |
|
| 333 | + * @return string |
|
| 334 | + */ |
|
| 335 | 335 | public function getHash() |
| 336 | 336 | { |
| 337 | 337 | return \AppUtils\ConvertHelper::string2shortHash($this->getNormalized()); |
| 338 | 338 | } |
| 339 | 339 | |
| 340 | - /** |
|
| 341 | - * Highlights the URL using HTML tags with specific highlighting |
|
| 342 | - * class names. |
|
| 343 | - * |
|
| 344 | - * @return string Will return an empty string if the URL is not valid. |
|
| 345 | - */ |
|
| 340 | + /** |
|
| 341 | + * Highlights the URL using HTML tags with specific highlighting |
|
| 342 | + * class names. |
|
| 343 | + * |
|
| 344 | + * @return string Will return an empty string if the URL is not valid. |
|
| 345 | + */ |
|
| 346 | 346 | public function getHighlighted() : string |
| 347 | 347 | { |
| 348 | 348 | if(!$this->isValid()) { |
@@ -376,15 +376,15 @@ discard block |
||
| 376 | 376 | return count($params); |
| 377 | 377 | } |
| 378 | 378 | |
| 379 | - /** |
|
| 380 | - * Retrieves all parameters specified in the url, |
|
| 381 | - * if any, as an associative array. |
|
| 382 | - * |
|
| 383 | - * NOTE: Ignores parameters that have been added |
|
| 384 | - * to the excluded parameters list. |
|
| 385 | - * |
|
| 386 | - * @return array |
|
| 387 | - */ |
|
| 379 | + /** |
|
| 380 | + * Retrieves all parameters specified in the url, |
|
| 381 | + * if any, as an associative array. |
|
| 382 | + * |
|
| 383 | + * NOTE: Ignores parameters that have been added |
|
| 384 | + * to the excluded parameters list. |
|
| 385 | + * |
|
| 386 | + * @return array |
|
| 387 | + */ |
|
| 388 | 388 | public function getParams() : array |
| 389 | 389 | { |
| 390 | 390 | if(!$this->paramExclusion || empty($this->excludedParams)) { |
@@ -402,22 +402,22 @@ discard block |
||
| 402 | 402 | return $keep; |
| 403 | 403 | } |
| 404 | 404 | |
| 405 | - /** |
|
| 406 | - * Retrieves the names of all parameters present in the URL, if any. |
|
| 407 | - * @return string[] |
|
| 408 | - */ |
|
| 405 | + /** |
|
| 406 | + * Retrieves the names of all parameters present in the URL, if any. |
|
| 407 | + * @return string[] |
|
| 408 | + */ |
|
| 409 | 409 | public function getParamNames() : array |
| 410 | 410 | { |
| 411 | 411 | $params = $this->getParams(); |
| 412 | 412 | return array_keys($params); |
| 413 | 413 | } |
| 414 | 414 | |
| 415 | - /** |
|
| 416 | - * Retrieves a specific parameter value from the URL. |
|
| 417 | - * |
|
| 418 | - * @param string $name |
|
| 419 | - * @return string The parameter value, or an empty string if it does not exist. |
|
| 420 | - */ |
|
| 415 | + /** |
|
| 416 | + * Retrieves a specific parameter value from the URL. |
|
| 417 | + * |
|
| 418 | + * @param string $name |
|
| 419 | + * @return string The parameter value, or an empty string if it does not exist. |
|
| 420 | + */ |
|
| 421 | 421 | public function getParam(string $name) : string |
| 422 | 422 | { |
| 423 | 423 | if(isset($this->info['params'][$name])) { |
@@ -427,16 +427,16 @@ discard block |
||
| 427 | 427 | return ''; |
| 428 | 428 | } |
| 429 | 429 | |
| 430 | - /** |
|
| 431 | - * Excludes an URL parameter entirely if present: |
|
| 432 | - * the parser will act as if the parameter was not |
|
| 433 | - * even present in the source URL, effectively |
|
| 434 | - * stripping it. |
|
| 435 | - * |
|
| 436 | - * @param string $name |
|
| 437 | - * @param string $reason A human readable explanation why this is excluded - used when highlighting links. |
|
| 438 | - * @return URLInfo |
|
| 439 | - */ |
|
| 430 | + /** |
|
| 431 | + * Excludes an URL parameter entirely if present: |
|
| 432 | + * the parser will act as if the parameter was not |
|
| 433 | + * even present in the source URL, effectively |
|
| 434 | + * stripping it. |
|
| 435 | + * |
|
| 436 | + * @param string $name |
|
| 437 | + * @param string $reason A human readable explanation why this is excluded - used when highlighting links. |
|
| 438 | + * @return URLInfo |
|
| 439 | + */ |
|
| 440 | 440 | public function excludeParam(string $name, string $reason) : URLInfo |
| 441 | 441 | { |
| 442 | 442 | if(!isset($this->excludedParams[$name])) |
@@ -489,25 +489,25 @@ discard block |
||
| 489 | 489 | return self::$typeLabels[$this->getType()]; |
| 490 | 490 | } |
| 491 | 491 | |
| 492 | - /** |
|
| 493 | - * Whether excluded parameters should be highlighted in |
|
| 494 | - * a different color in the URL when using the |
|
| 495 | - * {@link URLInfo::getHighlighted()} method. |
|
| 496 | - * |
|
| 497 | - * @param bool $highlight |
|
| 498 | - * @return URLInfo |
|
| 499 | - */ |
|
| 492 | + /** |
|
| 493 | + * Whether excluded parameters should be highlighted in |
|
| 494 | + * a different color in the URL when using the |
|
| 495 | + * {@link URLInfo::getHighlighted()} method. |
|
| 496 | + * |
|
| 497 | + * @param bool $highlight |
|
| 498 | + * @return URLInfo |
|
| 499 | + */ |
|
| 500 | 500 | public function setHighlightExcluded(bool $highlight=true) : URLInfo |
| 501 | 501 | { |
| 502 | 502 | $this->highlightExcluded = $highlight; |
| 503 | 503 | return $this; |
| 504 | 504 | } |
| 505 | 505 | |
| 506 | - /** |
|
| 507 | - * Returns an array with all relevant URL information. |
|
| 508 | - * |
|
| 509 | - * @return array |
|
| 510 | - */ |
|
| 506 | + /** |
|
| 507 | + * Returns an array with all relevant URL information. |
|
| 508 | + * |
|
| 509 | + * @return array |
|
| 510 | + */ |
|
| 511 | 511 | public function toArray() : array |
| 512 | 512 | { |
| 513 | 513 | return array( |
@@ -551,24 +551,24 @@ discard block |
||
| 551 | 551 | return $this; |
| 552 | 552 | } |
| 553 | 553 | |
| 554 | - /** |
|
| 555 | - * Whether the parameter exclusion mode is enabled: |
|
| 556 | - * In this case, if any parameters have been added to the |
|
| 557 | - * exclusion list, all relevant methods will exclude these. |
|
| 558 | - * |
|
| 559 | - * @return bool |
|
| 560 | - */ |
|
| 554 | + /** |
|
| 555 | + * Whether the parameter exclusion mode is enabled: |
|
| 556 | + * In this case, if any parameters have been added to the |
|
| 557 | + * exclusion list, all relevant methods will exclude these. |
|
| 558 | + * |
|
| 559 | + * @return bool |
|
| 560 | + */ |
|
| 561 | 561 | public function isParamExclusionEnabled() : bool |
| 562 | 562 | { |
| 563 | 563 | return $this->paramExclusion; |
| 564 | 564 | } |
| 565 | 565 | |
| 566 | - /** |
|
| 567 | - * Checks whether the link contains any parameters that |
|
| 568 | - * are on the list of excluded parameters. |
|
| 569 | - * |
|
| 570 | - * @return bool |
|
| 571 | - */ |
|
| 566 | + /** |
|
| 567 | + * Checks whether the link contains any parameters that |
|
| 568 | + * are on the list of excluded parameters. |
|
| 569 | + * |
|
| 570 | + * @return bool |
|
| 571 | + */ |
|
| 572 | 572 | public function containsExcludedParams() : bool |
| 573 | 573 | { |
| 574 | 574 | if(empty($this->excludedParams)) { |
@@ -636,16 +636,16 @@ discard block |
||
| 636 | 636 | return $this->highlightExcluded; |
| 637 | 637 | } |
| 638 | 638 | |
| 639 | - /** |
|
| 640 | - * Checks if the URL exists, i.e. can be connected to. Will return |
|
| 641 | - * true if the returned HTTP status code is `200` or `302`. |
|
| 642 | - * |
|
| 643 | - * NOTE: If the target URL requires HTTP authentication, the username |
|
| 644 | - * and password should be integrated into the URL. |
|
| 645 | - * |
|
| 646 | - * @return bool |
|
| 647 | - * @throws BaseException |
|
| 648 | - */ |
|
| 639 | + /** |
|
| 640 | + * Checks if the URL exists, i.e. can be connected to. Will return |
|
| 641 | + * true if the returned HTTP status code is `200` or `302`. |
|
| 642 | + * |
|
| 643 | + * NOTE: If the target URL requires HTTP authentication, the username |
|
| 644 | + * and password should be integrated into the URL. |
|
| 645 | + * |
|
| 646 | + * @return bool |
|
| 647 | + * @throws BaseException |
|
| 648 | + */ |
|
| 649 | 649 | public function tryConnect(bool $verifySSL=true) : bool |
| 650 | 650 | { |
| 651 | 651 | requireCURL(); |
@@ -200,7 +200,7 @@ discard block |
||
| 200 | 200 | { |
| 201 | 201 | $port = $this->getInfoKey('port'); |
| 202 | 202 | |
| 203 | - if(!empty($port)) { |
|
| 203 | + if (!empty($port)) { |
|
| 204 | 204 | return (int)$port; |
| 205 | 205 | } |
| 206 | 206 | |
@@ -280,7 +280,7 @@ discard block |
||
| 280 | 280 | |
| 281 | 281 | protected function getInfoKey(string $name) : string |
| 282 | 282 | { |
| 283 | - if(isset($this->info[$name])) { |
|
| 283 | + if (isset($this->info[$name])) { |
|
| 284 | 284 | return (string)$this->info[$name]; |
| 285 | 285 | } |
| 286 | 286 | |
@@ -309,13 +309,13 @@ discard block |
||
| 309 | 309 | return $this->normalize(false); |
| 310 | 310 | } |
| 311 | 311 | |
| 312 | - protected function normalize(bool $auth=true) : string |
|
| 312 | + protected function normalize(bool $auth = true) : string |
|
| 313 | 313 | { |
| 314 | - if(!$this->isValid()) { |
|
| 314 | + if (!$this->isValid()) { |
|
| 315 | 315 | return ''; |
| 316 | 316 | } |
| 317 | 317 | |
| 318 | - if(!isset($this->normalizer)) { |
|
| 318 | + if (!isset($this->normalizer)) { |
|
| 319 | 319 | $this->normalizer = new URLInfo_Normalizer($this); |
| 320 | 320 | } |
| 321 | 321 | |
@@ -345,7 +345,7 @@ discard block |
||
| 345 | 345 | */ |
| 346 | 346 | public function getHighlighted() : string |
| 347 | 347 | { |
| 348 | - if(!$this->isValid()) { |
|
| 348 | + if (!$this->isValid()) { |
|
| 349 | 349 | return ''; |
| 350 | 350 | } |
| 351 | 351 | |
@@ -387,14 +387,14 @@ discard block |
||
| 387 | 387 | */ |
| 388 | 388 | public function getParams() : array |
| 389 | 389 | { |
| 390 | - if(!$this->paramExclusion || empty($this->excludedParams)) { |
|
| 390 | + if (!$this->paramExclusion || empty($this->excludedParams)) { |
|
| 391 | 391 | return $this->info['params']; |
| 392 | 392 | } |
| 393 | 393 | |
| 394 | 394 | $keep = array(); |
| 395 | - foreach($this->info['params'] as $name => $value) |
|
| 395 | + foreach ($this->info['params'] as $name => $value) |
|
| 396 | 396 | { |
| 397 | - if(!isset($this->excludedParams[$name])) { |
|
| 397 | + if (!isset($this->excludedParams[$name])) { |
|
| 398 | 398 | $keep[$name] = $value; |
| 399 | 399 | } |
| 400 | 400 | } |
@@ -420,7 +420,7 @@ discard block |
||
| 420 | 420 | */ |
| 421 | 421 | public function getParam(string $name) : string |
| 422 | 422 | { |
| 423 | - if(isset($this->info['params'][$name])) { |
|
| 423 | + if (isset($this->info['params'][$name])) { |
|
| 424 | 424 | return $this->info['params'][$name]; |
| 425 | 425 | } |
| 426 | 426 | |
@@ -439,7 +439,7 @@ discard block |
||
| 439 | 439 | */ |
| 440 | 440 | public function excludeParam(string $name, string $reason) : URLInfo |
| 441 | 441 | { |
| 442 | - if(!isset($this->excludedParams[$name])) |
|
| 442 | + if (!isset($this->excludedParams[$name])) |
|
| 443 | 443 | { |
| 444 | 444 | $this->excludedParams[$name] = $reason; |
| 445 | 445 | $this->setParamExclusion(); |
@@ -465,7 +465,7 @@ discard block |
||
| 465 | 465 | |
| 466 | 466 | public function getTypeLabel() : string |
| 467 | 467 | { |
| 468 | - if(!isset(self::$typeLabels)) |
|
| 468 | + if (!isset(self::$typeLabels)) |
|
| 469 | 469 | { |
| 470 | 470 | self::$typeLabels = array( |
| 471 | 471 | self::TYPE_EMAIL => t('Email'), |
@@ -477,7 +477,7 @@ discard block |
||
| 477 | 477 | |
| 478 | 478 | $type = $this->getType(); |
| 479 | 479 | |
| 480 | - if(!isset(self::$typeLabels[$type])) |
|
| 480 | + if (!isset(self::$typeLabels[$type])) |
|
| 481 | 481 | { |
| 482 | 482 | throw new BaseException( |
| 483 | 483 | sprintf('Unknown URL type label for type [%s].', $type), |
@@ -497,7 +497,7 @@ discard block |
||
| 497 | 497 | * @param bool $highlight |
| 498 | 498 | * @return URLInfo |
| 499 | 499 | */ |
| 500 | - public function setHighlightExcluded(bool $highlight=true) : URLInfo |
|
| 500 | + public function setHighlightExcluded(bool $highlight = true) : URLInfo |
|
| 501 | 501 | { |
| 502 | 502 | $this->highlightExcluded = $highlight; |
| 503 | 503 | return $this; |
@@ -545,7 +545,7 @@ discard block |
||
| 545 | 545 | * @see URLInfo::isParamExclusionEnabled() |
| 546 | 546 | * @see URLInfo::setHighlightExcluded() |
| 547 | 547 | */ |
| 548 | - public function setParamExclusion(bool $enabled=true) : URLInfo |
|
| 548 | + public function setParamExclusion(bool $enabled = true) : URLInfo |
|
| 549 | 549 | { |
| 550 | 550 | $this->paramExclusion = $enabled; |
| 551 | 551 | return $this; |
@@ -571,13 +571,13 @@ discard block |
||
| 571 | 571 | */ |
| 572 | 572 | public function containsExcludedParams() : bool |
| 573 | 573 | { |
| 574 | - if(empty($this->excludedParams)) { |
|
| 574 | + if (empty($this->excludedParams)) { |
|
| 575 | 575 | return false; |
| 576 | 576 | } |
| 577 | 577 | |
| 578 | 578 | $names = array_keys($this->info['params']); |
| 579 | - foreach($names as $name) { |
|
| 580 | - if(isset($this->excludedParams[$name])) { |
|
| 579 | + foreach ($names as $name) { |
|
| 580 | + if (isset($this->excludedParams[$name])) { |
|
| 581 | 581 | return true; |
| 582 | 582 | } |
| 583 | 583 | } |
@@ -593,7 +593,7 @@ discard block |
||
| 593 | 593 | |
| 594 | 594 | public function offsetSet($offset, $value) |
| 595 | 595 | { |
| 596 | - if(in_array($offset, $this->infoKeys)) { |
|
| 596 | + if (in_array($offset, $this->infoKeys)) { |
|
| 597 | 597 | $this->info[$offset] = $value; |
| 598 | 598 | } |
| 599 | 599 | } |
@@ -610,11 +610,11 @@ discard block |
||
| 610 | 610 | |
| 611 | 611 | public function offsetGet($offset) |
| 612 | 612 | { |
| 613 | - if($offset === 'port') { |
|
| 613 | + if ($offset === 'port') { |
|
| 614 | 614 | return $this->getPort(); |
| 615 | 615 | } |
| 616 | 616 | |
| 617 | - if(in_array($offset, $this->infoKeys)) { |
|
| 617 | + if (in_array($offset, $this->infoKeys)) { |
|
| 618 | 618 | return $this->getInfoKey($offset); |
| 619 | 619 | } |
| 620 | 620 | |
@@ -646,12 +646,12 @@ discard block |
||
| 646 | 646 | * @return bool |
| 647 | 647 | * @throws BaseException |
| 648 | 648 | */ |
| 649 | - public function tryConnect(bool $verifySSL=true) : bool |
|
| 649 | + public function tryConnect(bool $verifySSL = true) : bool |
|
| 650 | 650 | { |
| 651 | 651 | requireCURL(); |
| 652 | 652 | |
| 653 | 653 | $ch = curl_init(); |
| 654 | - if(!is_resource($ch)) |
|
| 654 | + if (!is_resource($ch)) |
|
| 655 | 655 | { |
| 656 | 656 | throw new BaseException( |
| 657 | 657 | 'Could not initialize a new cURL instance.', |
@@ -667,13 +667,13 @@ discard block |
||
| 667 | 667 | curl_setopt($ch, CURLOPT_TIMEOUT, 10); |
| 668 | 668 | curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true); |
| 669 | 669 | |
| 670 | - if(!$verifySSL) |
|
| 670 | + if (!$verifySSL) |
|
| 671 | 671 | { |
| 672 | 672 | curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false); |
| 673 | 673 | curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); |
| 674 | 674 | } |
| 675 | 675 | |
| 676 | - if($this->hasUsername()) |
|
| 676 | + if ($this->hasUsername()) |
|
| 677 | 677 | { |
| 678 | 678 | curl_setopt($ch, CURLOPT_USERNAME, $this->getUsername()); |
| 679 | 679 | curl_setopt($ch, CURLOPT_PASSWORD, $this->getPassword()); |
@@ -216,8 +216,7 @@ |
||
| 216 | 216 | curl_errno($ch), |
| 217 | 217 | curl_error($ch) |
| 218 | 218 | ); |
| 219 | - } |
|
| 220 | - else |
|
| 219 | + } else |
|
| 221 | 220 | { |
| 222 | 221 | $this->response->setBody((string)$output); |
| 223 | 222 | } |
@@ -29,56 +29,56 @@ discard block |
||
| 29 | 29 | |
| 30 | 30 | const ERROR_CURL_INIT_FAILED = 17903; |
| 31 | 31 | |
| 32 | - /** |
|
| 33 | - * @var string |
|
| 34 | - */ |
|
| 32 | + /** |
|
| 33 | + * @var string |
|
| 34 | + */ |
|
| 35 | 35 | protected $eol = "\r\n"; |
| 36 | 36 | |
| 37 | - /** |
|
| 38 | - * @var string |
|
| 39 | - */ |
|
| 37 | + /** |
|
| 38 | + * @var string |
|
| 39 | + */ |
|
| 40 | 40 | protected $mimeBoundary; |
| 41 | 41 | |
| 42 | - /** |
|
| 43 | - * @var string |
|
| 44 | - */ |
|
| 42 | + /** |
|
| 43 | + * @var string |
|
| 44 | + */ |
|
| 45 | 45 | protected $data = ''; |
| 46 | 46 | |
| 47 | - /** |
|
| 48 | - * @var string |
|
| 49 | - */ |
|
| 47 | + /** |
|
| 48 | + * @var string |
|
| 49 | + */ |
|
| 50 | 50 | protected $destination; |
| 51 | 51 | |
| 52 | - /** |
|
| 53 | - * @var array |
|
| 54 | - */ |
|
| 52 | + /** |
|
| 53 | + * @var array |
|
| 54 | + */ |
|
| 55 | 55 | protected $headers = array(); |
| 56 | 56 | |
| 57 | - /** |
|
| 58 | - * Whether to verify SSL certificates. |
|
| 59 | - * @var bool |
|
| 60 | - */ |
|
| 57 | + /** |
|
| 58 | + * Whether to verify SSL certificates. |
|
| 59 | + * @var bool |
|
| 60 | + */ |
|
| 61 | 61 | protected $verifySSL = true; |
| 62 | 62 | |
| 63 | - /** |
|
| 64 | - * @var RequestHelper_Boundaries |
|
| 65 | - */ |
|
| 63 | + /** |
|
| 64 | + * @var RequestHelper_Boundaries |
|
| 65 | + */ |
|
| 66 | 66 | protected $boundaries; |
| 67 | 67 | |
| 68 | - /** |
|
| 69 | - * @var RequestHelper_Response|NULL |
|
| 70 | - */ |
|
| 68 | + /** |
|
| 69 | + * @var RequestHelper_Response|NULL |
|
| 70 | + */ |
|
| 71 | 71 | protected $response; |
| 72 | 72 | |
| 73 | - /** |
|
| 74 | - * @var integer |
|
| 75 | - */ |
|
| 73 | + /** |
|
| 74 | + * @var integer |
|
| 75 | + */ |
|
| 76 | 76 | protected $timeout = 30; |
| 77 | 77 | |
| 78 | - /** |
|
| 79 | - * Creates a new request helper to send POST data to the specified destination URL. |
|
| 80 | - * @param string $destinationURL |
|
| 81 | - */ |
|
| 78 | + /** |
|
| 79 | + * Creates a new request helper to send POST data to the specified destination URL. |
|
| 80 | + * @param string $destinationURL |
|
| 81 | + */ |
|
| 82 | 82 | public function __construct(string $destinationURL) |
| 83 | 83 | { |
| 84 | 84 | $this->destination = $destinationURL; |
@@ -105,15 +105,15 @@ discard block |
||
| 105 | 105 | return $this; |
| 106 | 106 | } |
| 107 | 107 | |
| 108 | - /** |
|
| 109 | - * Adds a file to be sent with the request. |
|
| 110 | - * |
|
| 111 | - * @param string $varName The variable name to send the file in |
|
| 112 | - * @param string $fileName The name of the file as it should be received at the destination |
|
| 113 | - * @param string $content The raw content of the file |
|
| 114 | - * @param string $contentType The content type, use the constants to specify this |
|
| 115 | - * @param string $encoding The encoding of the file, use the constants to specify this |
|
| 116 | - */ |
|
| 108 | + /** |
|
| 109 | + * Adds a file to be sent with the request. |
|
| 110 | + * |
|
| 111 | + * @param string $varName The variable name to send the file in |
|
| 112 | + * @param string $fileName The name of the file as it should be received at the destination |
|
| 113 | + * @param string $content The raw content of the file |
|
| 114 | + * @param string $contentType The content type, use the constants to specify this |
|
| 115 | + * @param string $encoding The encoding of the file, use the constants to specify this |
|
| 116 | + */ |
|
| 117 | 117 | public function addFile(string $varName, string $fileName, string $content, string $contentType = self::FILETYPE_TEXT, string $encoding = self::ENCODING_UTF8) : RequestHelper |
| 118 | 118 | { |
| 119 | 119 | $this->boundaries->addFile($varName, $fileName, $content, $contentType, $encoding); |
@@ -121,13 +121,13 @@ discard block |
||
| 121 | 121 | return $this; |
| 122 | 122 | } |
| 123 | 123 | |
| 124 | - /** |
|
| 125 | - * Adds arbitrary content. |
|
| 126 | - * |
|
| 127 | - * @param string $varName The variable name to send the content in. |
|
| 128 | - * @param string $content |
|
| 129 | - * @param string $contentType |
|
| 130 | - */ |
|
| 124 | + /** |
|
| 125 | + * Adds arbitrary content. |
|
| 126 | + * |
|
| 127 | + * @param string $varName The variable name to send the content in. |
|
| 128 | + * @param string $content |
|
| 129 | + * @param string $contentType |
|
| 130 | + */ |
|
| 131 | 131 | public function addContent(string $varName, string $content, string $contentType) : RequestHelper |
| 132 | 132 | { |
| 133 | 133 | $this->boundaries->addContent($varName, $content, $contentType); |
@@ -149,13 +149,13 @@ discard block |
||
| 149 | 149 | return $this; |
| 150 | 150 | } |
| 151 | 151 | |
| 152 | - /** |
|
| 153 | - * Sets an HTTP header to include in the request. |
|
| 154 | - * |
|
| 155 | - * @param string $name |
|
| 156 | - * @param string $value |
|
| 157 | - * @return RequestHelper |
|
| 158 | - */ |
|
| 152 | + /** |
|
| 153 | + * Sets an HTTP header to include in the request. |
|
| 154 | + * |
|
| 155 | + * @param string $name |
|
| 156 | + * @param string $value |
|
| 157 | + * @return RequestHelper |
|
| 158 | + */ |
|
| 159 | 159 | public function setHeader(string $name, string $value) : RequestHelper |
| 160 | 160 | { |
| 161 | 161 | $this->headers[$name] = $value; |
@@ -163,36 +163,36 @@ discard block |
||
| 163 | 163 | return $this; |
| 164 | 164 | } |
| 165 | 165 | |
| 166 | - /** |
|
| 167 | - * Disables SSL certificate checking. |
|
| 168 | - * |
|
| 169 | - * @return RequestHelper |
|
| 170 | - */ |
|
| 166 | + /** |
|
| 167 | + * Disables SSL certificate checking. |
|
| 168 | + * |
|
| 169 | + * @return RequestHelper |
|
| 170 | + */ |
|
| 171 | 171 | public function disableSSLChecks() : RequestHelper |
| 172 | 172 | { |
| 173 | 173 | $this->verifySSL = false; |
| 174 | 174 | return $this; |
| 175 | 175 | } |
| 176 | 176 | |
| 177 | - /** |
|
| 178 | - * @var integer |
|
| 179 | - */ |
|
| 177 | + /** |
|
| 178 | + * @var integer |
|
| 179 | + */ |
|
| 180 | 180 | protected $contentLength = 0; |
| 181 | 181 | |
| 182 | - /** |
|
| 183 | - * Sends the POST request to the destination, and returns |
|
| 184 | - * the response text. |
|
| 185 | - * |
|
| 186 | - * The response object is stored internally, so after calling |
|
| 187 | - * this method it may be retrieved at any moment using the |
|
| 188 | - * {@link getResponse()} method. |
|
| 189 | - * |
|
| 190 | - * @return string |
|
| 191 | - * @see RequestHelper::getResponse() |
|
| 192 | - * @throws RequestHelper_Exception |
|
| 193 | - * |
|
| 194 | - * @see RequestHelper::ERROR_REQUEST_FAILED |
|
| 195 | - */ |
|
| 182 | + /** |
|
| 183 | + * Sends the POST request to the destination, and returns |
|
| 184 | + * the response text. |
|
| 185 | + * |
|
| 186 | + * The response object is stored internally, so after calling |
|
| 187 | + * this method it may be retrieved at any moment using the |
|
| 188 | + * {@link getResponse()} method. |
|
| 189 | + * |
|
| 190 | + * @return string |
|
| 191 | + * @see RequestHelper::getResponse() |
|
| 192 | + * @throws RequestHelper_Exception |
|
| 193 | + * |
|
| 194 | + * @see RequestHelper::ERROR_REQUEST_FAILED |
|
| 195 | + */ |
|
| 196 | 196 | public function send() : string |
| 197 | 197 | { |
| 198 | 198 | $this->data = $this->boundaries->render(); |
@@ -232,14 +232,14 @@ discard block |
||
| 232 | 232 | return $this->data; |
| 233 | 233 | } |
| 234 | 234 | |
| 235 | - /** |
|
| 236 | - * Creates a new CURL resource configured according to the |
|
| 237 | - * request's settings. |
|
| 238 | - * |
|
| 239 | - * @param URLInfo $url |
|
| 240 | - * @throws RequestHelper_Exception |
|
| 241 | - * @return resource |
|
| 242 | - */ |
|
| 235 | + /** |
|
| 236 | + * Creates a new CURL resource configured according to the |
|
| 237 | + * request's settings. |
|
| 238 | + * |
|
| 239 | + * @param URLInfo $url |
|
| 240 | + * @throws RequestHelper_Exception |
|
| 241 | + * @return resource |
|
| 242 | + */ |
|
| 243 | 243 | protected function createCURL(URLInfo $url) |
| 244 | 244 | { |
| 245 | 245 | $ch = curl_init(); |
@@ -279,13 +279,13 @@ discard block |
||
| 279 | 279 | return $ch; |
| 280 | 280 | } |
| 281 | 281 | |
| 282 | - /** |
|
| 283 | - * Compiles the associative headers array into |
|
| 284 | - * the format understood by CURL, namely an indexed |
|
| 285 | - * array with one header string per entry. |
|
| 286 | - * |
|
| 287 | - * @return array |
|
| 288 | - */ |
|
| 282 | + /** |
|
| 283 | + * Compiles the associative headers array into |
|
| 284 | + * the format understood by CURL, namely an indexed |
|
| 285 | + * array with one header string per entry. |
|
| 286 | + * |
|
| 287 | + * @return array |
|
| 288 | + */ |
|
| 289 | 289 | protected function renderHeaders() : array |
| 290 | 290 | { |
| 291 | 291 | $result = array(); |
@@ -297,12 +297,12 @@ discard block |
||
| 297 | 297 | return $result; |
| 298 | 298 | } |
| 299 | 299 | |
| 300 | - /** |
|
| 301 | - * Retrieves the raw response header, in the form of an indexed |
|
| 302 | - * array containing all response header lines. |
|
| 303 | - * |
|
| 304 | - * @return array |
|
| 305 | - */ |
|
| 300 | + /** |
|
| 301 | + * Retrieves the raw response header, in the form of an indexed |
|
| 302 | + * array containing all response header lines. |
|
| 303 | + * |
|
| 304 | + * @return array |
|
| 305 | + */ |
|
| 306 | 306 | public function getResponseHeader() : array |
| 307 | 307 | { |
| 308 | 308 | $response = $this->getResponse(); |
@@ -210,7 +210,7 @@ discard block |
||
| 210 | 210 | // CURL will complain about an empty response when the |
| 211 | 211 | // server sends a 100-continue code. That should not be |
| 212 | 212 | // regarded as an error. |
| 213 | - if($output === false && $this->response->getCode() !== 100) |
|
| 213 | + if ($output === false && $this->response->getCode() !== 100) |
|
| 214 | 214 | { |
| 215 | 215 | $this->response->setError( |
| 216 | 216 | curl_errno($ch), |
@@ -243,7 +243,7 @@ discard block |
||
| 243 | 243 | protected function createCURL(URLInfo $url) |
| 244 | 244 | { |
| 245 | 245 | $ch = curl_init(); |
| 246 | - if(!is_resource($ch)) |
|
| 246 | + if (!is_resource($ch)) |
|
| 247 | 247 | { |
| 248 | 248 | throw new RequestHelper_Exception( |
| 249 | 249 | 'Could not initialize a new cURL instance.', |
@@ -253,7 +253,7 @@ discard block |
||
| 253 | 253 | } |
| 254 | 254 | |
| 255 | 255 | $this->setHeader('Content-Length', (string)$this->boundaries->getContentLength()); |
| 256 | - $this->setHeader('Content-Type', 'multipart/form-data; charset=UTF-8; boundary=' . $this->mimeBoundary); |
|
| 256 | + $this->setHeader('Content-Type', 'multipart/form-data; charset=UTF-8; boundary='.$this->mimeBoundary); |
|
| 257 | 257 | |
| 258 | 258 | //curl_setopt($ch, CURLOPT_VERBOSE, true); |
| 259 | 259 | curl_setopt($ch, CURLOPT_POST, true); |
@@ -264,13 +264,13 @@ discard block |
||
| 264 | 264 | curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true); |
| 265 | 265 | curl_setopt($ch, CURLOPT_HTTPHEADER, $this->renderHeaders()); |
| 266 | 266 | |
| 267 | - if($this->verifySSL) |
|
| 267 | + if ($this->verifySSL) |
|
| 268 | 268 | { |
| 269 | 269 | curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false); |
| 270 | 270 | curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); |
| 271 | 271 | } |
| 272 | 272 | |
| 273 | - if($url->hasUsername()) |
|
| 273 | + if ($url->hasUsername()) |
|
| 274 | 274 | { |
| 275 | 275 | curl_setopt($ch, CURLOPT_USERNAME, $url->getUsername()); |
| 276 | 276 | curl_setopt($ch, CURLOPT_PASSWORD, $url->getPassword()); |
@@ -290,7 +290,7 @@ discard block |
||
| 290 | 290 | { |
| 291 | 291 | $result = array(); |
| 292 | 292 | |
| 293 | - foreach($this->headers as $name => $value) { |
|
| 293 | + foreach ($this->headers as $name => $value) { |
|
| 294 | 294 | $result[] = $name.': '.$value; |
| 295 | 295 | } |
| 296 | 296 | |
@@ -307,7 +307,7 @@ discard block |
||
| 307 | 307 | { |
| 308 | 308 | $response = $this->getResponse(); |
| 309 | 309 | |
| 310 | - if($response !== null) { |
|
| 310 | + if ($response !== null) { |
|
| 311 | 311 | return $response->getHeaders(); |
| 312 | 312 | } |
| 313 | 313 | |
@@ -87,37 +87,37 @@ |
||
| 87 | 87 | */ |
| 88 | 88 | interface Interface_Classable |
| 89 | 89 | { |
| 90 | - /** |
|
| 91 | - * @param string $name |
|
| 92 | - * @return Interface_Classable |
|
| 93 | - */ |
|
| 90 | + /** |
|
| 91 | + * @param string $name |
|
| 92 | + * @return Interface_Classable |
|
| 93 | + */ |
|
| 94 | 94 | public function addClass(string $name); |
| 95 | 95 | |
| 96 | - /** |
|
| 97 | - * @param array $names |
|
| 98 | - * @return Interface_Classable |
|
| 99 | - */ |
|
| 96 | + /** |
|
| 97 | + * @param array $names |
|
| 98 | + * @return Interface_Classable |
|
| 99 | + */ |
|
| 100 | 100 | public function addClasses(array $names); |
| 101 | 101 | |
| 102 | - /** |
|
| 103 | - * @param string $name |
|
| 104 | - * @return bool |
|
| 105 | - */ |
|
| 102 | + /** |
|
| 103 | + * @param string $name |
|
| 104 | + * @return bool |
|
| 105 | + */ |
|
| 106 | 106 | public function hasClass(string $name) : bool; |
| 107 | 107 | |
| 108 | - /** |
|
| 109 | - * @param string $name |
|
| 110 | - * @return Interface_Classable |
|
| 111 | - */ |
|
| 108 | + /** |
|
| 109 | + * @param string $name |
|
| 110 | + * @return Interface_Classable |
|
| 111 | + */ |
|
| 112 | 112 | public function removeClass(string $name); |
| 113 | 113 | |
| 114 | - /** |
|
| 115 | - * @return array |
|
| 116 | - */ |
|
| 114 | + /** |
|
| 115 | + * @return array |
|
| 116 | + */ |
|
| 117 | 117 | public function getClasses() : array; |
| 118 | 118 | |
| 119 | - /** |
|
| 120 | - * @return string |
|
| 121 | - */ |
|
| 119 | + /** |
|
| 120 | + * @return string |
|
| 121 | + */ |
|
| 122 | 122 | public function classesToString() : string; |
| 123 | 123 | } |
@@ -29,7 +29,7 @@ discard block |
||
| 29 | 29 | |
| 30 | 30 | public function addClass(string $name) |
| 31 | 31 | { |
| 32 | - if(!in_array($name, $this->classes)) { |
|
| 32 | + if (!in_array($name, $this->classes)) { |
|
| 33 | 33 | $this->classes[] = $name; |
| 34 | 34 | } |
| 35 | 35 | |
@@ -38,7 +38,7 @@ discard block |
||
| 38 | 38 | |
| 39 | 39 | public function addClasses(array $names) |
| 40 | 40 | { |
| 41 | - foreach($names as $name) { |
|
| 41 | + foreach ($names as $name) { |
|
| 42 | 42 | $this->addClass($name); |
| 43 | 43 | } |
| 44 | 44 | |
@@ -54,7 +54,7 @@ discard block |
||
| 54 | 54 | { |
| 55 | 55 | $idx = array_search($name, $this->classes); |
| 56 | 56 | |
| 57 | - if($idx !== false) { |
|
| 57 | + if ($idx !== false) { |
|
| 58 | 58 | unset($this->classes[$idx]); |
| 59 | 59 | sort($this->classes); |
| 60 | 60 | } |
@@ -31,17 +31,17 @@ discard block |
||
| 31 | 31 | |
| 32 | 32 | const BASE_2 = 1024; |
| 33 | 33 | |
| 34 | - /** |
|
| 35 | - * @var ConvertHelper_StorageSizeEnum_Size[] |
|
| 36 | - */ |
|
| 34 | + /** |
|
| 35 | + * @var ConvertHelper_StorageSizeEnum_Size[] |
|
| 36 | + */ |
|
| 37 | 37 | protected static $sizes = array(); |
| 38 | 38 | |
| 39 | - /** |
|
| 40 | - * Initializes the supported unit notations, and |
|
| 41 | - * how they are supposed to be calculated. |
|
| 42 | - * |
|
| 43 | - * @see ConvertHelper_SizeNotation::parseSize() |
|
| 44 | - */ |
|
| 39 | + /** |
|
| 40 | + * Initializes the supported unit notations, and |
|
| 41 | + * how they are supposed to be calculated. |
|
| 42 | + * |
|
| 43 | + * @see ConvertHelper_SizeNotation::parseSize() |
|
| 44 | + */ |
|
| 45 | 45 | protected static function init() : void |
| 46 | 46 | { |
| 47 | 47 | if(!empty(self::$sizes)) { |
@@ -68,30 +68,30 @@ discard block |
||
| 68 | 68 | } |
| 69 | 69 | } |
| 70 | 70 | |
| 71 | - /** |
|
| 72 | - * Called whenever the application locale is changed, |
|
| 73 | - * to reset the size definitions so the labels get |
|
| 74 | - * translated to the new locale. |
|
| 75 | - * |
|
| 76 | - * @param \AppLocalize\Localization_Event_LocaleChanged $event |
|
| 77 | - */ |
|
| 71 | + /** |
|
| 72 | + * Called whenever the application locale is changed, |
|
| 73 | + * to reset the size definitions so the labels get |
|
| 74 | + * translated to the new locale. |
|
| 75 | + * |
|
| 76 | + * @param \AppLocalize\Localization_Event_LocaleChanged $event |
|
| 77 | + */ |
|
| 78 | 78 | public static function handle_localeChanged(\AppLocalize\Localization_Event_LocaleChanged $event) : void |
| 79 | 79 | { |
| 80 | 80 | self::$sizes = array(); |
| 81 | 81 | } |
| 82 | 82 | |
| 83 | - /** |
|
| 84 | - * Adds a storage size to the internal collection. |
|
| 85 | - * |
|
| 86 | - * @param string $name The lowercase size name, e.g. "kb", "mib" |
|
| 87 | - * @param int $base This defines how many bytes there are in a kilobyte, to differentiate with the two common way to calculate sizes: base 10 or base 2. See the Wikipedia link for more details. |
|
| 88 | - * @param int $exponent The multiplier of the base to get the byte value |
|
| 89 | - * @param string $suffix The localized short suffix, e.g. "KB", "MiB" |
|
| 90 | - * @param string $singular The localized singular label of the size, e.g. "Kilobyte". |
|
| 91 | - * @param string $plural The localized plural label of the size, e.g. "Kilobytes". |
|
| 92 | - * |
|
| 93 | - * @see https://en.m.wikipedia.org/wiki/Megabyte#Definitions |
|
| 94 | - */ |
|
| 83 | + /** |
|
| 84 | + * Adds a storage size to the internal collection. |
|
| 85 | + * |
|
| 86 | + * @param string $name The lowercase size name, e.g. "kb", "mib" |
|
| 87 | + * @param int $base This defines how many bytes there are in a kilobyte, to differentiate with the two common way to calculate sizes: base 10 or base 2. See the Wikipedia link for more details. |
|
| 88 | + * @param int $exponent The multiplier of the base to get the byte value |
|
| 89 | + * @param string $suffix The localized short suffix, e.g. "KB", "MiB" |
|
| 90 | + * @param string $singular The localized singular label of the size, e.g. "Kilobyte". |
|
| 91 | + * @param string $plural The localized plural label of the size, e.g. "Kilobytes". |
|
| 92 | + * |
|
| 93 | + * @see https://en.m.wikipedia.org/wiki/Megabyte#Definitions |
|
| 94 | + */ |
|
| 95 | 95 | protected static function addSize(string $name, int $base, int $exponent, string $suffix, string $singular, string $plural) : void |
| 96 | 96 | { |
| 97 | 97 | self::$sizes[$name] = new ConvertHelper_StorageSizeEnum_Size( |
@@ -104,11 +104,11 @@ discard block |
||
| 104 | 104 | ); |
| 105 | 105 | } |
| 106 | 106 | |
| 107 | - /** |
|
| 108 | - * Retrieves all known sizes. |
|
| 109 | - * |
|
| 110 | - * @return \AppUtils\ConvertHelper_StorageSizeEnum_Size[] |
|
| 111 | - */ |
|
| 107 | + /** |
|
| 108 | + * Retrieves all known sizes. |
|
| 109 | + * |
|
| 110 | + * @return \AppUtils\ConvertHelper_StorageSizeEnum_Size[] |
|
| 111 | + */ |
|
| 112 | 112 | public static function getSizes() : array |
| 113 | 113 | { |
| 114 | 114 | self::init(); |
@@ -116,15 +116,15 @@ discard block |
||
| 116 | 116 | return self::$sizes; |
| 117 | 117 | } |
| 118 | 118 | |
| 119 | - /** |
|
| 120 | - * Retrieves a size definition instance by its name. |
|
| 121 | - * |
|
| 122 | - * @param string $name Case insensitive. For example "kb", "MiB"... |
|
| 123 | - * @throws ConvertHelper_Exception |
|
| 124 | - * @return ConvertHelper_StorageSizeEnum_Size |
|
| 125 | - * |
|
| 126 | - * @see ConvertHelper_StorageSizeEnum::ERROR_UNKNOWN_UNIT_NAME |
|
| 127 | - */ |
|
| 119 | + /** |
|
| 120 | + * Retrieves a size definition instance by its name. |
|
| 121 | + * |
|
| 122 | + * @param string $name Case insensitive. For example "kb", "MiB"... |
|
| 123 | + * @throws ConvertHelper_Exception |
|
| 124 | + * @return ConvertHelper_StorageSizeEnum_Size |
|
| 125 | + * |
|
| 126 | + * @see ConvertHelper_StorageSizeEnum::ERROR_UNKNOWN_UNIT_NAME |
|
| 127 | + */ |
|
| 128 | 128 | public static function getSizeByName(string $name) : ConvertHelper_StorageSizeEnum_Size |
| 129 | 129 | { |
| 130 | 130 | self::init(); |
@@ -146,10 +146,10 @@ discard block |
||
| 146 | 146 | ); |
| 147 | 147 | } |
| 148 | 148 | |
| 149 | - /** |
|
| 150 | - * Retrieves a list of all size names, e.g. "mb", "kib" (lowercase). |
|
| 151 | - * @return array |
|
| 152 | - */ |
|
| 149 | + /** |
|
| 150 | + * Retrieves a list of all size names, e.g. "mb", "kib" (lowercase). |
|
| 151 | + * @return array |
|
| 152 | + */ |
|
| 153 | 153 | public static function getSizeNames() : array |
| 154 | 154 | { |
| 155 | 155 | self::init(); |
@@ -157,16 +157,16 @@ discard block |
||
| 157 | 157 | return array_keys(self::$sizes); |
| 158 | 158 | } |
| 159 | 159 | |
| 160 | - /** |
|
| 161 | - * Retrieves all available storage sizes for the specified |
|
| 162 | - * base value. |
|
| 163 | - * |
|
| 164 | - * @param int $base |
|
| 165 | - * @return \AppUtils\ConvertHelper_StorageSizeEnum_Size[] |
|
| 166 | - * |
|
| 167 | - * @see ConvertHelper_StorageSizeEnum::BASE_10 |
|
| 168 | - * @see ConvertHelper_StorageSizeEnum::BASE_2 |
|
| 169 | - */ |
|
| 160 | + /** |
|
| 161 | + * Retrieves all available storage sizes for the specified |
|
| 162 | + * base value. |
|
| 163 | + * |
|
| 164 | + * @param int $base |
|
| 165 | + * @return \AppUtils\ConvertHelper_StorageSizeEnum_Size[] |
|
| 166 | + * |
|
| 167 | + * @see ConvertHelper_StorageSizeEnum::BASE_10 |
|
| 168 | + * @see ConvertHelper_StorageSizeEnum::BASE_2 |
|
| 169 | + */ |
|
| 170 | 170 | public static function getSizesByBase(int $base) : array |
| 171 | 171 | { |
| 172 | 172 | self::init(); |
@@ -44,7 +44,7 @@ discard block |
||
| 44 | 44 | */ |
| 45 | 45 | protected static function init() : void |
| 46 | 46 | { |
| 47 | - if(!empty(self::$sizes)) { |
|
| 47 | + if (!empty(self::$sizes)) { |
|
| 48 | 48 | return; |
| 49 | 49 | } |
| 50 | 50 | |
@@ -62,7 +62,7 @@ discard block |
||
| 62 | 62 | |
| 63 | 63 | self::addSize('b', 1, 1, t('B'), t('Byte'), t('Bytes')); |
| 64 | 64 | |
| 65 | - if(class_exists('AppLocalize\Localization')) |
|
| 65 | + if (class_exists('AppLocalize\Localization')) |
|
| 66 | 66 | { |
| 67 | 67 | \AppLocalize\Localization::onLocaleChanged(array(self::class, 'handle_localeChanged')); |
| 68 | 68 | } |
@@ -131,7 +131,7 @@ discard block |
||
| 131 | 131 | |
| 132 | 132 | $name = strtolower($name); |
| 133 | 133 | |
| 134 | - if(isset(self::$sizes[$name])) { |
|
| 134 | + if (isset(self::$sizes[$name])) { |
|
| 135 | 135 | return self::$sizes[$name]; |
| 136 | 136 | } |
| 137 | 137 | |
@@ -173,9 +173,9 @@ discard block |
||
| 173 | 173 | |
| 174 | 174 | $result = array(); |
| 175 | 175 | |
| 176 | - foreach(self::$sizes as $size) |
|
| 176 | + foreach (self::$sizes as $size) |
|
| 177 | 177 | { |
| 178 | - if($size->getBase() === $base) { |
|
| 178 | + if ($size->getBase() === $base) { |
|
| 179 | 179 | $result[] = $size; |
| 180 | 180 | } |
| 181 | 181 | } |