@@ -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 mb_strlen($this->render()); |
| 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 = '', string $encoding = '') : RequestHelper_Boundaries |
| 85 | 85 | { |
| 86 | 86 | if(empty($contentType)) |
@@ -104,13 +104,13 @@ discard block |
||
| 104 | 104 | return $this->addBoundary($boundary); |
| 105 | 105 | } |
| 106 | 106 | |
| 107 | - /** |
|
| 108 | - * Adds arbitrary content. |
|
| 109 | - * |
|
| 110 | - * @param string $varName |
|
| 111 | - * @param string $content |
|
| 112 | - * @param string $contentType |
|
| 113 | - */ |
|
| 107 | + /** |
|
| 108 | + * Adds arbitrary content. |
|
| 109 | + * |
|
| 110 | + * @param string $varName |
|
| 111 | + * @param string $content |
|
| 112 | + * @param string $contentType |
|
| 113 | + */ |
|
| 114 | 114 | public function addContent(string $varName, string $content, string $contentType) : RequestHelper_Boundaries |
| 115 | 115 | { |
| 116 | 116 | $content = ConvertHelper::string2utf8($content); |
@@ -124,13 +124,13 @@ discard block |
||
| 124 | 124 | return $this->addBoundary($boundary); |
| 125 | 125 | } |
| 126 | 126 | |
| 127 | - /** |
|
| 128 | - * Adds a variable to be sent with the request. If it |
|
| 129 | - * already exists, its value is overwritten. |
|
| 130 | - * |
|
| 131 | - * @param string $name |
|
| 132 | - * @param string $value |
|
| 133 | - */ |
|
| 127 | + /** |
|
| 128 | + * Adds a variable to be sent with the request. If it |
|
| 129 | + * already exists, its value is overwritten. |
|
| 130 | + * |
|
| 131 | + * @param string $name |
|
| 132 | + * @param string $value |
|
| 133 | + */ |
|
| 134 | 134 | public function addVariable(string $name, string $value) : RequestHelper_Boundaries |
| 135 | 135 | { |
| 136 | 136 | $boundary = $this->createBoundary($value) |
@@ -146,11 +146,11 @@ discard block |
||
| 146 | 146 | return $this; |
| 147 | 147 | } |
| 148 | 148 | |
| 149 | - /** |
|
| 150 | - * Renders the response body with all mime boundaries. |
|
| 151 | - * |
|
| 152 | - * @return string |
|
| 153 | - */ |
|
| 149 | + /** |
|
| 150 | + * Renders the response body with all mime boundaries. |
|
| 151 | + * |
|
| 152 | + * @return string |
|
| 153 | + */ |
|
| 154 | 154 | public function render() : string |
| 155 | 155 | { |
| 156 | 156 | if(empty($this->boundaries)) |
@@ -83,12 +83,12 @@ discard block |
||
| 83 | 83 | */ |
| 84 | 84 | public function addFile(string $varName, string $fileName, string $content, string $contentType = '', string $encoding = '') : RequestHelper_Boundaries |
| 85 | 85 | { |
| 86 | - if(empty($contentType)) |
|
| 86 | + if (empty($contentType)) |
|
| 87 | 87 | { |
| 88 | 88 | $contentType = FileHelper::detectMimeType($fileName); |
| 89 | 89 | } |
| 90 | 90 | |
| 91 | - if(empty($encoding)) |
|
| 91 | + if (empty($encoding)) |
|
| 92 | 92 | { |
| 93 | 93 | $encoding = RequestHelper::ENCODING_UTF8; |
| 94 | 94 | $content = ConvertHelper::string2utf8($content); |
@@ -153,7 +153,7 @@ discard block |
||
| 153 | 153 | */ |
| 154 | 154 | public function render() : string |
| 155 | 155 | { |
| 156 | - if(empty($this->boundaries)) |
|
| 156 | + if (empty($this->boundaries)) |
|
| 157 | 157 | { |
| 158 | 158 | throw new RequestHelper_Exception( |
| 159 | 159 | 'No mime boundaries added', |
@@ -164,13 +164,13 @@ discard block |
||
| 164 | 164 | |
| 165 | 165 | $result = ''; |
| 166 | 166 | |
| 167 | - foreach($this->boundaries as $boundary) |
|
| 167 | + foreach ($this->boundaries as $boundary) |
|
| 168 | 168 | { |
| 169 | 169 | $result .= $boundary->render(); |
| 170 | 170 | } |
| 171 | 171 | |
| 172 | - $result .= "--" . $this->getMimeBoundary() . "--" . |
|
| 173 | - $this->getEOL() . $this->getEOL(); // always finish with two eol's!! |
|
| 172 | + $result .= "--".$this->getMimeBoundary()."--". |
|
| 173 | + $this->getEOL().$this->getEOL(); // always finish with two eol's!! |
|
| 174 | 174 | |
| 175 | 175 | return $result; |
| 176 | 176 | } |
@@ -19,34 +19,34 @@ discard block |
||
| 19 | 19 | */ |
| 20 | 20 | class RequestHelper_Boundaries_Boundary |
| 21 | 21 | { |
| 22 | - /** |
|
| 23 | - * @var string |
|
| 24 | - */ |
|
| 22 | + /** |
|
| 23 | + * @var string |
|
| 24 | + */ |
|
| 25 | 25 | protected $content; |
| 26 | 26 | |
| 27 | - /** |
|
| 28 | - * @var array |
|
| 29 | - */ |
|
| 27 | + /** |
|
| 28 | + * @var array |
|
| 29 | + */ |
|
| 30 | 30 | protected $dispositionParams = array(); |
| 31 | 31 | |
| 32 | - /** |
|
| 33 | - * @var string |
|
| 34 | - */ |
|
| 32 | + /** |
|
| 33 | + * @var string |
|
| 34 | + */ |
|
| 35 | 35 | protected $contentType = ''; |
| 36 | 36 | |
| 37 | - /** |
|
| 38 | - * @var string |
|
| 39 | - */ |
|
| 37 | + /** |
|
| 38 | + * @var string |
|
| 39 | + */ |
|
| 40 | 40 | protected $contentEncoding = ''; |
| 41 | 41 | |
| 42 | - /** |
|
| 43 | - * @var RequestHelper_Boundaries |
|
| 44 | - */ |
|
| 42 | + /** |
|
| 43 | + * @var RequestHelper_Boundaries |
|
| 44 | + */ |
|
| 45 | 45 | protected $boundaries; |
| 46 | 46 | |
| 47 | - /** |
|
| 48 | - * @var string |
|
| 49 | - */ |
|
| 47 | + /** |
|
| 48 | + * @var string |
|
| 49 | + */ |
|
| 50 | 50 | protected $transferEncoding = ''; |
| 51 | 51 | |
| 52 | 52 | public function __construct(RequestHelper_Boundaries $boundaries, string $content) |
@@ -60,46 +60,46 @@ discard block |
||
| 60 | 60 | return strlen($this->content); |
| 61 | 61 | } |
| 62 | 62 | |
| 63 | - /** |
|
| 64 | - * Sets the name of the request parameter. |
|
| 65 | - * |
|
| 66 | - * @param string $name |
|
| 67 | - * @return RequestHelper_Boundaries_Boundary |
|
| 68 | - */ |
|
| 63 | + /** |
|
| 64 | + * Sets the name of the request parameter. |
|
| 65 | + * |
|
| 66 | + * @param string $name |
|
| 67 | + * @return RequestHelper_Boundaries_Boundary |
|
| 68 | + */ |
|
| 69 | 69 | public function setName(string $name) : RequestHelper_Boundaries_Boundary |
| 70 | 70 | { |
| 71 | 71 | return $this->setDispositionParam('name', $name); |
| 72 | 72 | } |
| 73 | 73 | |
| 74 | - /** |
|
| 75 | - * Sets the filename to use for the content, if applicable. |
|
| 76 | - * |
|
| 77 | - * @param string $fileName |
|
| 78 | - * @return RequestHelper_Boundaries_Boundary |
|
| 79 | - */ |
|
| 74 | + /** |
|
| 75 | + * Sets the filename to use for the content, if applicable. |
|
| 76 | + * |
|
| 77 | + * @param string $fileName |
|
| 78 | + * @return RequestHelper_Boundaries_Boundary |
|
| 79 | + */ |
|
| 80 | 80 | public function setFileName(string $fileName) : RequestHelper_Boundaries_Boundary |
| 81 | 81 | { |
| 82 | 82 | return $this->setDispositionParam('filename', $fileName); |
| 83 | 83 | } |
| 84 | 84 | |
| 85 | - /** |
|
| 86 | - * Sets the content type to use for the content. |
|
| 87 | - * |
|
| 88 | - * @param string $contentType |
|
| 89 | - * @return RequestHelper_Boundaries_Boundary |
|
| 90 | - */ |
|
| 85 | + /** |
|
| 86 | + * Sets the content type to use for the content. |
|
| 87 | + * |
|
| 88 | + * @param string $contentType |
|
| 89 | + * @return RequestHelper_Boundaries_Boundary |
|
| 90 | + */ |
|
| 91 | 91 | public function setContentType(string $contentType) : RequestHelper_Boundaries_Boundary |
| 92 | 92 | { |
| 93 | 93 | $this->contentType = $contentType; |
| 94 | 94 | return $this; |
| 95 | 95 | } |
| 96 | 96 | |
| 97 | - /** |
|
| 98 | - * Sets the encoding to specify for the content. |
|
| 99 | - * |
|
| 100 | - * @param string $encoding An encoding string, e.g. "UTF-8", "ASCII" |
|
| 101 | - * @return RequestHelper_Boundaries_Boundary |
|
| 102 | - */ |
|
| 97 | + /** |
|
| 98 | + * Sets the encoding to specify for the content. |
|
| 99 | + * |
|
| 100 | + * @param string $encoding An encoding string, e.g. "UTF-8", "ASCII" |
|
| 101 | + * @return RequestHelper_Boundaries_Boundary |
|
| 102 | + */ |
|
| 103 | 103 | public function setContentEncoding(string $encoding) : RequestHelper_Boundaries_Boundary |
| 104 | 104 | { |
| 105 | 105 | $this->contentEncoding = $encoding; |
@@ -119,11 +119,11 @@ discard block |
||
| 119 | 119 | return $this; |
| 120 | 120 | } |
| 121 | 121 | |
| 122 | - /** |
|
| 123 | - * Renders the mime boundary text. |
|
| 124 | - * |
|
| 125 | - * @return string |
|
| 126 | - */ |
|
| 122 | + /** |
|
| 123 | + * Renders the mime boundary text. |
|
| 124 | + * |
|
| 125 | + * @return string |
|
| 126 | + */ |
|
| 127 | 127 | public function render() |
| 128 | 128 | { |
| 129 | 129 | $eol = $this->boundaries->getEOL(); |
@@ -132,12 +132,12 @@ discard block |
||
| 132 | 132 | $lines[] = '--'.$this->boundaries->getMimeBoundary(); |
| 133 | 133 | $lines[] = $this->renderContentDisposition(); |
| 134 | 134 | |
| 135 | - if(!empty($this->contentType)) |
|
| 135 | + if (!empty($this->contentType)) |
|
| 136 | 136 | { |
| 137 | 137 | $lines[] = $this->renderContentType(); |
| 138 | 138 | } |
| 139 | 139 | |
| 140 | - if(!empty($this->transferEncoding)) |
|
| 140 | + if (!empty($this->transferEncoding)) |
|
| 141 | 141 | { |
| 142 | 142 | $lines[] = $this->renderTransferEncoding(); |
| 143 | 143 | } |
@@ -152,9 +152,9 @@ discard block |
||
| 152 | 152 | { |
| 153 | 153 | $result = 'Content-Disposition: form-data'; |
| 154 | 154 | |
| 155 | - foreach($this->dispositionParams as $name => $value) |
|
| 155 | + foreach ($this->dispositionParams as $name => $value) |
|
| 156 | 156 | { |
| 157 | - $result .= '; '.$name.'="' . $value . '"'; |
|
| 157 | + $result .= '; '.$name.'="'.$value.'"'; |
|
| 158 | 158 | } |
| 159 | 159 | |
| 160 | 160 | return $result; |
@@ -162,11 +162,11 @@ discard block |
||
| 162 | 162 | |
| 163 | 163 | protected function renderContentType() : string |
| 164 | 164 | { |
| 165 | - $result = 'Content-Type: ' . $this->contentType; |
|
| 165 | + $result = 'Content-Type: '.$this->contentType; |
|
| 166 | 166 | |
| 167 | - if(!empty($this->contentEncoding)) |
|
| 167 | + if (!empty($this->contentEncoding)) |
|
| 168 | 168 | { |
| 169 | - $result .= '; charset="' . $this->contentEncoding.'"'; |
|
| 169 | + $result .= '; charset="'.$this->contentEncoding.'"'; |
|
| 170 | 170 | } |
| 171 | 171 | |
| 172 | 172 | return $result; |
@@ -174,7 +174,7 @@ discard block |
||
| 174 | 174 | |
| 175 | 175 | protected function renderTransferEncoding() : string |
| 176 | 176 | { |
| 177 | - $result = 'Content-Transfer-Encoding: ' . $this->transferEncoding; |
|
| 177 | + $result = 'Content-Transfer-Encoding: '.$this->transferEncoding; |
|
| 178 | 178 | |
| 179 | 179 | return $result; |
| 180 | 180 | } |
@@ -27,73 +27,73 @@ discard block |
||
| 27 | 27 | */ |
| 28 | 28 | class OperationResult |
| 29 | 29 | { |
| 30 | - /** |
|
| 31 | - * @var string |
|
| 32 | - */ |
|
| 30 | + /** |
|
| 31 | + * @var string |
|
| 32 | + */ |
|
| 33 | 33 | protected $message = ''; |
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * @var bool |
|
| 37 | - */ |
|
| 35 | + /** |
|
| 36 | + * @var bool |
|
| 37 | + */ |
|
| 38 | 38 | protected $valid = true; |
| 39 | 39 | |
| 40 | - /** |
|
| 41 | - * @var object |
|
| 42 | - */ |
|
| 40 | + /** |
|
| 41 | + * @var object |
|
| 42 | + */ |
|
| 43 | 43 | protected $subject; |
| 44 | 44 | |
| 45 | - /** |
|
| 46 | - * @var integer |
|
| 47 | - */ |
|
| 45 | + /** |
|
| 46 | + * @var integer |
|
| 47 | + */ |
|
| 48 | 48 | protected $code = 0; |
| 49 | 49 | |
| 50 | - /** |
|
| 51 | - * The subject being validated. |
|
| 52 | - * |
|
| 53 | - * @param object $subject |
|
| 54 | - */ |
|
| 50 | + /** |
|
| 51 | + * The subject being validated. |
|
| 52 | + * |
|
| 53 | + * @param object $subject |
|
| 54 | + */ |
|
| 55 | 55 | public function __construct(object $subject) |
| 56 | 56 | { |
| 57 | 57 | $this->subject = $subject; |
| 58 | 58 | } |
| 59 | 59 | |
| 60 | - /** |
|
| 61 | - * Whether the validation was successful. |
|
| 62 | - * |
|
| 63 | - * @return bool |
|
| 64 | - */ |
|
| 60 | + /** |
|
| 61 | + * Whether the validation was successful. |
|
| 62 | + * |
|
| 63 | + * @return bool |
|
| 64 | + */ |
|
| 65 | 65 | public function isValid() : bool |
| 66 | 66 | { |
| 67 | 67 | return $this->valid; |
| 68 | 68 | } |
| 69 | 69 | |
| 70 | - /** |
|
| 71 | - * Retrieves the subject that was validated. |
|
| 72 | - * |
|
| 73 | - * @return object |
|
| 74 | - */ |
|
| 70 | + /** |
|
| 71 | + * Retrieves the subject that was validated. |
|
| 72 | + * |
|
| 73 | + * @return object |
|
| 74 | + */ |
|
| 75 | 75 | public function getSubject() : object |
| 76 | 76 | { |
| 77 | 77 | return $this->subject; |
| 78 | 78 | } |
| 79 | 79 | |
| 80 | - /** |
|
| 81 | - * Makes the result a succes, with the specified message. |
|
| 82 | - * |
|
| 83 | - * @param string $message Should not contain a date, just the system specific info. |
|
| 84 | - * @return OperationResult |
|
| 85 | - */ |
|
| 80 | + /** |
|
| 81 | + * Makes the result a succes, with the specified message. |
|
| 82 | + * |
|
| 83 | + * @param string $message Should not contain a date, just the system specific info. |
|
| 84 | + * @return OperationResult |
|
| 85 | + */ |
|
| 86 | 86 | public function makeSuccess(string $message, int $code=0) : OperationResult |
| 87 | 87 | { |
| 88 | 88 | return $this->setMessage($message, $code, true); |
| 89 | 89 | } |
| 90 | 90 | |
| 91 | - /** |
|
| 92 | - * Sets the result as an error. |
|
| 93 | - * |
|
| 94 | - * @param string $message Should be as detailed as possible. |
|
| 95 | - * @return OperationResult |
|
| 96 | - */ |
|
| 91 | + /** |
|
| 92 | + * Sets the result as an error. |
|
| 93 | + * |
|
| 94 | + * @param string $message Should be as detailed as possible. |
|
| 95 | + * @return OperationResult |
|
| 96 | + */ |
|
| 97 | 97 | public function makeError(string $message, int $code=0) : OperationResult |
| 98 | 98 | { |
| 99 | 99 | return $this->setMessage($message, $code, false); |
@@ -108,21 +108,21 @@ discard block |
||
| 108 | 108 | return $this; |
| 109 | 109 | } |
| 110 | 110 | |
| 111 | - /** |
|
| 112 | - * Retrieves the error message, if an error occurred. |
|
| 113 | - * |
|
| 114 | - * @return string The error message, or an empty string if no error occurred. |
|
| 115 | - */ |
|
| 111 | + /** |
|
| 112 | + * Retrieves the error message, if an error occurred. |
|
| 113 | + * |
|
| 114 | + * @return string The error message, or an empty string if no error occurred. |
|
| 115 | + */ |
|
| 116 | 116 | public function getErrorMessage() : string |
| 117 | 117 | { |
| 118 | 118 | return $this->getMessage(false); |
| 119 | 119 | } |
| 120 | 120 | |
| 121 | - /** |
|
| 122 | - * Retrieves the success message, if one has been provided. |
|
| 123 | - * |
|
| 124 | - * @return string |
|
| 125 | - */ |
|
| 121 | + /** |
|
| 122 | + * Retrieves the success message, if one has been provided. |
|
| 123 | + * |
|
| 124 | + * @return string |
|
| 125 | + */ |
|
| 126 | 126 | public function getSuccessMessage() : string |
| 127 | 127 | { |
| 128 | 128 | return $this->getMessage(true); |
@@ -83,7 +83,7 @@ discard block |
||
| 83 | 83 | * @param string $message Should not contain a date, just the system specific info. |
| 84 | 84 | * @return OperationResult |
| 85 | 85 | */ |
| 86 | - public function makeSuccess(string $message, int $code=0) : OperationResult |
|
| 86 | + public function makeSuccess(string $message, int $code = 0) : OperationResult |
|
| 87 | 87 | { |
| 88 | 88 | return $this->setMessage($message, $code, true); |
| 89 | 89 | } |
@@ -94,7 +94,7 @@ discard block |
||
| 94 | 94 | * @param string $message Should be as detailed as possible. |
| 95 | 95 | * @return OperationResult |
| 96 | 96 | */ |
| 97 | - public function makeError(string $message, int $code=0) : OperationResult |
|
| 97 | + public function makeError(string $message, int $code = 0) : OperationResult |
|
| 98 | 98 | { |
| 99 | 99 | return $this->setMessage($message, $code, false); |
| 100 | 100 | } |
@@ -140,7 +140,7 @@ discard block |
||
| 140 | 140 | |
| 141 | 141 | protected function getMessage(bool $valid) : string |
| 142 | 142 | { |
| 143 | - if($this->valid === $valid) |
|
| 143 | + if ($this->valid === $valid) |
|
| 144 | 144 | { |
| 145 | 145 | return $this->message; |
| 146 | 146 | } |