├── CHANGELOG.md ├── LICENSE ├── composer.json └── src ├── Check ├── CheckedException.php └── UncheckedException.php ├── ConfigurableException.php ├── DomainException.php ├── Logic ├── Deprecated.php ├── InvalidArgument.php ├── InvalidState.php ├── MemberInaccessible.php ├── NotImplemented.php └── ShouldNotHappen.php ├── LogicalException.php └── Message.php /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | 3 | All notable changes to this project will be documented in this file. 4 | 5 | The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) 6 | and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). 7 | 8 | ## [Unreleased](https://github.com/orisai/exceptions/compare/1.1.5...v1.x) 9 | 10 | ## [1.1.5](https://github.com/orisai/exceptions/compare/1.1.4...1.1.5) - 2024-12-29 11 | 12 | ### Changed 13 | 14 | - Composer 15 | - allows PHP 8.4 16 | 17 | ## [1.1.4](https://github.com/orisai/exceptions/compare/1.1.3...1.1.4) - 2024-06-20 18 | 19 | ### Changed 20 | 21 | - Composer 22 | - allows PHP 8.3 23 | 24 | ## [1.1.3](https://github.com/orisai/exceptions/compare/1.1.2...1.1.3) - 2023-04-08 25 | 26 | ### Changed 27 | 28 | - Composer 29 | - allows PHP 8.2 (now for real) 30 | 31 | ## [1.1.2](https://github.com/orisai/exceptions/compare/1.1.1...1.1.2) - 2022-12-09 32 | 33 | ### Changed 34 | 35 | - Composer 36 | - allows PHP 8.2 37 | 38 | ## [1.1.1](https://github.com/orisai/exceptions/compare/1.1.0...1.1.1) - 2022-11-03 39 | 40 | ### Fixed 41 | 42 | - `Message` 43 | - `with()` parameter `$title` expects non-empty-string 44 | 45 | ## [1.1.0](https://github.com/orisai/exceptions/compare/1.0.0...1.1.0) - 2021-07-22 46 | 47 | ### Added 48 | 49 | - `Message` 50 | - Configurable line length via `Message::$lineLength` 51 | - `with('title', 'content')` for custom fields 52 | - `ConfigurableException` 53 | - Suppressed exceptions 54 | - `withSuppressed()`, `getSuppressed()` 55 | - Suppressed exceptions messages are appended to main exception message 56 | - Can be disabled by `ConfigurableException::$addSuppressedToMessage = false;` 57 | 58 | ### Removed 59 | 60 | - `Message` 61 | - Public properties `$context`, `$problem`, `$solution` 62 | (technically a BC break, but in a never documented and impractical to use feature) 63 | 64 | ## [1.0.0](https://github.com/orisai/exceptions/releases/tag/1.0.0) - 2020-11-10 65 | 66 | ### Added 67 | 68 | - `CheckedException` interface 69 | - base `DomainException` 70 | - `UncheckedException` interface 71 | - base `LogicalException` 72 | - `Deprecated` 73 | - `InvalidArgument` 74 | - `InvalidState` 75 | - `MemberInaccessible` 76 | - `NotImplemented` 77 | - `ShouldNotHappen` 78 | - `ConfigurableException` trait 79 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Mozilla Public License Version 2.0 2 | ================================== 3 | 4 | 1. Definitions 5 | -------------- 6 | 7 | 1.1. "Contributor" 8 | means each individual or legal entity that creates, contributes to 9 | the creation of, or owns Covered Software. 10 | 11 | 1.2. "Contributor Version" 12 | means the combination of the Contributions of others (if any) used 13 | by a Contributor and that particular Contributor's Contribution. 14 | 15 | 1.3. "Contribution" 16 | means Covered Software of a particular Contributor. 17 | 18 | 1.4. "Covered Software" 19 | means Source Code Form to which the initial Contributor has attached 20 | the notice in Exhibit A, the Executable Form of such Source Code 21 | Form, and Modifications of such Source Code Form, in each case 22 | including portions thereof. 23 | 24 | 1.5. "Incompatible With Secondary Licenses" 25 | means 26 | 27 | (a) that the initial Contributor has attached the notice described 28 | in Exhibit B to the Covered Software; or 29 | 30 | (b) that the Covered Software was made available under the terms of 31 | version 1.1 or earlier of the License, but not also under the 32 | terms of a Secondary License. 33 | 34 | 1.6. "Executable Form" 35 | means any form of the work other than Source Code Form. 36 | 37 | 1.7. "Larger Work" 38 | means a work that combines Covered Software with other material, in 39 | a separate file or files, that is not Covered Software. 40 | 41 | 1.8. "License" 42 | means this document. 43 | 44 | 1.9. "Licensable" 45 | means having the right to grant, to the maximum extent possible, 46 | whether at the time of the initial grant or subsequently, any and 47 | all of the rights conveyed by this License. 48 | 49 | 1.10. "Modifications" 50 | means any of the following: 51 | 52 | (a) any file in Source Code Form that results from an addition to, 53 | deletion from, or modification of the contents of Covered 54 | Software; or 55 | 56 | (b) any new file in Source Code Form that contains any Covered 57 | Software. 58 | 59 | 1.11. "Patent Claims" of a Contributor 60 | means any patent claim(s), including without limitation, method, 61 | process, and apparatus claims, in any patent Licensable by such 62 | Contributor that would be infringed, but for the grant of the 63 | License, by the making, using, selling, offering for sale, having 64 | made, import, or transfer of either its Contributions or its 65 | Contributor Version. 66 | 67 | 1.12. "Secondary License" 68 | means either the GNU General Public License, Version 2.0, the GNU 69 | Lesser General Public License, Version 2.1, the GNU Affero General 70 | Public License, Version 3.0, or any later versions of those 71 | licenses. 72 | 73 | 1.13. "Source Code Form" 74 | means the form of the work preferred for making modifications. 75 | 76 | 1.14. "You" (or "Your") 77 | means an individual or a legal entity exercising rights under this 78 | License. For legal entities, "You" includes any entity that 79 | controls, is controlled by, or is under common control with You. For 80 | purposes of this definition, "control" means (a) the power, direct 81 | or indirect, to cause the direction or management of such entity, 82 | whether by contract or otherwise, or (b) ownership of more than 83 | fifty percent (50%) of the outstanding shares or beneficial 84 | ownership of such entity. 85 | 86 | 2. License Grants and Conditions 87 | -------------------------------- 88 | 89 | 2.1. Grants 90 | 91 | Each Contributor hereby grants You a world-wide, royalty-free, 92 | non-exclusive license: 93 | 94 | (a) under intellectual property rights (other than patent or trademark) 95 | Licensable by such Contributor to use, reproduce, make available, 96 | modify, display, perform, distribute, and otherwise exploit its 97 | Contributions, either on an unmodified basis, with Modifications, or 98 | as part of a Larger Work; and 99 | 100 | (b) under Patent Claims of such Contributor to make, use, sell, offer 101 | for sale, have made, import, and otherwise transfer either its 102 | Contributions or its Contributor Version. 103 | 104 | 2.2. Effective Date 105 | 106 | The licenses granted in Section 2.1 with respect to any Contribution 107 | become effective for each Contribution on the date the Contributor first 108 | distributes such Contribution. 109 | 110 | 2.3. Limitations on Grant Scope 111 | 112 | The licenses granted in this Section 2 are the only rights granted under 113 | this License. No additional rights or licenses will be implied from the 114 | distribution or licensing of Covered Software under this License. 115 | Notwithstanding Section 2.1(b) above, no patent license is granted by a 116 | Contributor: 117 | 118 | (a) for any code that a Contributor has removed from Covered Software; 119 | or 120 | 121 | (b) for infringements caused by: (i) Your and any other third party's 122 | modifications of Covered Software, or (ii) the combination of its 123 | Contributions with other software (except as part of its Contributor 124 | Version); or 125 | 126 | (c) under Patent Claims infringed by Covered Software in the absence of 127 | its Contributions. 128 | 129 | This License does not grant any rights in the trademarks, service marks, 130 | or logos of any Contributor (except as may be necessary to comply with 131 | the notice requirements in Section 3.4). 132 | 133 | 2.4. Subsequent Licenses 134 | 135 | No Contributor makes additional grants as a result of Your choice to 136 | distribute the Covered Software under a subsequent version of this 137 | License (see Section 10.2) or under the terms of a Secondary License (if 138 | permitted under the terms of Section 3.3). 139 | 140 | 2.5. Representation 141 | 142 | Each Contributor represents that the Contributor believes its 143 | Contributions are its original creation(s) or it has sufficient rights 144 | to grant the rights to its Contributions conveyed by this License. 145 | 146 | 2.6. Fair Use 147 | 148 | This License is not intended to limit any rights You have under 149 | applicable copyright doctrines of fair use, fair dealing, or other 150 | equivalents. 151 | 152 | 2.7. Conditions 153 | 154 | Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted 155 | in Section 2.1. 156 | 157 | 3. Responsibilities 158 | ------------------- 159 | 160 | 3.1. Distribution of Source Form 161 | 162 | All distribution of Covered Software in Source Code Form, including any 163 | Modifications that You create or to which You contribute, must be under 164 | the terms of this License. You must inform recipients that the Source 165 | Code Form of the Covered Software is governed by the terms of this 166 | License, and how they can obtain a copy of this License. You may not 167 | attempt to alter or restrict the recipients' rights in the Source Code 168 | Form. 169 | 170 | 3.2. Distribution of Executable Form 171 | 172 | If You distribute Covered Software in Executable Form then: 173 | 174 | (a) such Covered Software must also be made available in Source Code 175 | Form, as described in Section 3.1, and You must inform recipients of 176 | the Executable Form how they can obtain a copy of such Source Code 177 | Form by reasonable means in a timely manner, at a charge no more 178 | than the cost of distribution to the recipient; and 179 | 180 | (b) You may distribute such Executable Form under the terms of this 181 | License, or sublicense it under different terms, provided that the 182 | license for the Executable Form does not attempt to limit or alter 183 | the recipients' rights in the Source Code Form under this License. 184 | 185 | 3.3. Distribution of a Larger Work 186 | 187 | You may create and distribute a Larger Work under terms of Your choice, 188 | provided that You also comply with the requirements of this License for 189 | the Covered Software. If the Larger Work is a combination of Covered 190 | Software with a work governed by one or more Secondary Licenses, and the 191 | Covered Software is not Incompatible With Secondary Licenses, this 192 | License permits You to additionally distribute such Covered Software 193 | under the terms of such Secondary License(s), so that the recipient of 194 | the Larger Work may, at their option, further distribute the Covered 195 | Software under the terms of either this License or such Secondary 196 | License(s). 197 | 198 | 3.4. Notices 199 | 200 | You may not remove or alter the substance of any license notices 201 | (including copyright notices, patent notices, disclaimers of warranty, 202 | or limitations of liability) contained within the Source Code Form of 203 | the Covered Software, except that You may alter any license notices to 204 | the extent required to remedy known factual inaccuracies. 205 | 206 | 3.5. Application of Additional Terms 207 | 208 | You may choose to offer, and to charge a fee for, warranty, support, 209 | indemnity or liability obligations to one or more recipients of Covered 210 | Software. However, You may do so only on Your own behalf, and not on 211 | behalf of any Contributor. You must make it absolutely clear that any 212 | such warranty, support, indemnity, or liability obligation is offered by 213 | You alone, and You hereby agree to indemnify every Contributor for any 214 | liability incurred by such Contributor as a result of warranty, support, 215 | indemnity or liability terms You offer. You may include additional 216 | disclaimers of warranty and limitations of liability specific to any 217 | jurisdiction. 218 | 219 | 4. Inability to Comply Due to Statute or Regulation 220 | --------------------------------------------------- 221 | 222 | If it is impossible for You to comply with any of the terms of this 223 | License with respect to some or all of the Covered Software due to 224 | statute, judicial order, or regulation then You must: (a) comply with 225 | the terms of this License to the maximum extent possible; and (b) 226 | describe the limitations and the code they affect. Such description must 227 | be placed in a text file included with all distributions of the Covered 228 | Software under this License. Except to the extent prohibited by statute 229 | or regulation, such description must be sufficiently detailed for a 230 | recipient of ordinary skill to be able to understand it. 231 | 232 | 5. Termination 233 | -------------- 234 | 235 | 5.1. The rights granted under this License will terminate automatically 236 | if You fail to comply with any of its terms. However, if You become 237 | compliant, then the rights granted under this License from a particular 238 | Contributor are reinstated (a) provisionally, unless and until such 239 | Contributor explicitly and finally terminates Your grants, and (b) on an 240 | ongoing basis, if such Contributor fails to notify You of the 241 | non-compliance by some reasonable means prior to 60 days after You have 242 | come back into compliance. Moreover, Your grants from a particular 243 | Contributor are reinstated on an ongoing basis if such Contributor 244 | notifies You of the non-compliance by some reasonable means, this is the 245 | first time You have received notice of non-compliance with this License 246 | from such Contributor, and You become compliant prior to 30 days after 247 | Your receipt of the notice. 248 | 249 | 5.2. If You initiate litigation against any entity by asserting a patent 250 | infringement claim (excluding declaratory judgment actions, 251 | counter-claims, and cross-claims) alleging that a Contributor Version 252 | directly or indirectly infringes any patent, then the rights granted to 253 | You by any and all Contributors for the Covered Software under Section 254 | 2.1 of this License shall terminate. 255 | 256 | 5.3. In the event of termination under Sections 5.1 or 5.2 above, all 257 | end user license agreements (excluding distributors and resellers) which 258 | have been validly granted by You or Your distributors under this License 259 | prior to termination shall survive termination. 260 | 261 | ************************************************************************ 262 | * * 263 | * 6. Disclaimer of Warranty * 264 | * ------------------------- * 265 | * * 266 | * Covered Software is provided under this License on an "as is" * 267 | * basis, without warranty of any kind, either expressed, implied, or * 268 | * statutory, including, without limitation, warranties that the * 269 | * Covered Software is free of defects, merchantable, fit for a * 270 | * particular purpose or non-infringing. The entire risk as to the * 271 | * quality and performance of the Covered Software is with You. * 272 | * Should any Covered Software prove defective in any respect, You * 273 | * (not any Contributor) assume the cost of any necessary servicing, * 274 | * repair, or correction. This disclaimer of warranty constitutes an * 275 | * essential part of this License. No use of any Covered Software is * 276 | * authorized under this License except under this disclaimer. * 277 | * * 278 | ************************************************************************ 279 | 280 | ************************************************************************ 281 | * * 282 | * 7. Limitation of Liability * 283 | * -------------------------- * 284 | * * 285 | * Under no circumstances and under no legal theory, whether tort * 286 | * (including negligence), contract, or otherwise, shall any * 287 | * Contributor, or anyone who distributes Covered Software as * 288 | * permitted above, be liable to You for any direct, indirect, * 289 | * special, incidental, or consequential damages of any character * 290 | * including, without limitation, damages for lost profits, loss of * 291 | * goodwill, work stoppage, computer failure or malfunction, or any * 292 | * and all other commercial damages or losses, even if such party * 293 | * shall have been informed of the possibility of such damages. This * 294 | * limitation of liability shall not apply to liability for death or * 295 | * personal injury resulting from such party's negligence to the * 296 | * extent applicable law prohibits such limitation. Some * 297 | * jurisdictions do not allow the exclusion or limitation of * 298 | * incidental or consequential damages, so this exclusion and * 299 | * limitation may not apply to You. * 300 | * * 301 | ************************************************************************ 302 | 303 | 8. Litigation 304 | ------------- 305 | 306 | Any litigation relating to this License may be brought only in the 307 | courts of a jurisdiction where the defendant maintains its principal 308 | place of business and such litigation shall be governed by laws of that 309 | jurisdiction, without reference to its conflict-of-law provisions. 310 | Nothing in this Section shall prevent a party's ability to bring 311 | cross-claims or counter-claims. 312 | 313 | 9. Miscellaneous 314 | ---------------- 315 | 316 | This License represents the complete agreement concerning the subject 317 | matter hereof. If any provision of this License is held to be 318 | unenforceable, such provision shall be reformed only to the extent 319 | necessary to make it enforceable. Any law or regulation which provides 320 | that the language of a contract shall be construed against the drafter 321 | shall not be used to construe this License against a Contributor. 322 | 323 | 10. Versions of the License 324 | --------------------------- 325 | 326 | 10.1. New Versions 327 | 328 | Mozilla Foundation is the license steward. Except as provided in Section 329 | 10.3, no one other than the license steward has the right to modify or 330 | publish new versions of this License. Each version will be given a 331 | distinguishing version number. 332 | 333 | 10.2. Effect of New Versions 334 | 335 | You may distribute the Covered Software under the terms of the version 336 | of the License under which You originally received the Covered Software, 337 | or under the terms of any subsequent version published by the license 338 | steward. 339 | 340 | 10.3. Modified Versions 341 | 342 | If you create software not governed by this License, and you want to 343 | create a new license for such software, you may create and use a 344 | modified version of this License if you rename the license and remove 345 | any references to the name of the license steward (except to note that 346 | such modified license differs from this License). 347 | 348 | 10.4. Distributing Source Code Form that is Incompatible With Secondary 349 | Licenses 350 | 351 | If You choose to distribute Source Code Form that is Incompatible With 352 | Secondary Licenses under the terms of this version of the License, the 353 | notice described in Exhibit B of this License must be attached. 354 | 355 | Exhibit A - Source Code Form License Notice 356 | ------------------------------------------- 357 | 358 | This Source Code Form is subject to the terms of the Mozilla Public 359 | License, v. 2.0. If a copy of the MPL was not distributed with this 360 | file, You can obtain one at http://mozilla.org/MPL/2.0/. 361 | 362 | If it is not possible or desirable to put the notice in a particular 363 | file, then You may include the notice in a location (such as a LICENSE 364 | file in a relevant directory) where a recipient would be likely to look 365 | for such a notice. 366 | 367 | You may add additional accurate notices of copyright ownership. 368 | 369 | Exhibit B - "Incompatible With Secondary Licenses" Notice 370 | --------------------------------------------------------- 371 | 372 | This Source Code Form is "Incompatible With Secondary Licenses", as 373 | defined by the Mozilla Public License, v. 2.0. 374 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "orisai/exceptions", 3 | "description": "Exceptions designed for static analysis and easy usage", 4 | "keywords": [ 5 | "exceptions", 6 | "orisai", 7 | "phpstan" 8 | ], 9 | "type": "library", 10 | "license": "MPL-2.0", 11 | "homepage": "https://github.com/orisai/exceptions", 12 | "authors": [ 13 | { 14 | "name": "Marek Bartoš", 15 | "homepage": "https://github.com/mabar" 16 | } 17 | ], 18 | "require": { 19 | "php": "7.4 - 8.4", 20 | "ext-mbstring": "*", 21 | "symfony/polyfill-php80": "^1.18.1" 22 | }, 23 | "require-dev": { 24 | "brianium/paratest": "^6.3.0", 25 | "infection/infection": "^0.26.0|^0.27.0|^0.28.0|^0.29.0", 26 | "orisai/coding-standard": "^3.0.0", 27 | "phpstan/extension-installer": "^1.0.0", 28 | "phpstan/phpstan": "^2.0.0", 29 | "phpstan/phpstan-deprecation-rules": "^2.0.0", 30 | "phpstan/phpstan-phpunit": "^2.0.0", 31 | "phpstan/phpstan-strict-rules": "^2.0.0", 32 | "phpunit/phpunit": "^9.5.0", 33 | "staabm/annotate-pull-request-from-checkstyle": "^1.7.0" 34 | }, 35 | "autoload": { 36 | "psr-4": { 37 | "Orisai\\Exceptions\\": "src" 38 | } 39 | }, 40 | "autoload-dev": { 41 | "psr-4": { 42 | "Tests\\Orisai\\Exceptions\\": "tests" 43 | } 44 | }, 45 | "minimum-stability": "dev", 46 | "prefer-stable": true, 47 | "config": { 48 | "sort-packages": true, 49 | "allow-plugins": { 50 | "dealerdirect/phpcodesniffer-composer-installer": true, 51 | "infection/extension-installer": true, 52 | "phpstan/extension-installer": true 53 | } 54 | } 55 | } 56 | -------------------------------------------------------------------------------- /src/Check/CheckedException.php: -------------------------------------------------------------------------------- 1 | */ 22 | private array $suppressed = []; 23 | 24 | private bool $isAnySuppressedInMessage = false; 25 | 26 | public static bool $addSuppressedToMessage = true; 27 | 28 | /** 29 | * @return $this 30 | */ 31 | public function withCode(int $code): self 32 | { 33 | $this->code = $code; 34 | 35 | return $this; 36 | } 37 | 38 | /** 39 | * @param string|Stringable $message 40 | * @return $this 41 | */ 42 | public function withMessage($message): self 43 | { 44 | $this->message = (string) $message; 45 | 46 | if (static::$addSuppressedToMessage) { 47 | $this->isAnySuppressedInMessage = false; 48 | foreach ($this->suppressed as $key => $item) { 49 | $this->addSuppressedToMessage($item, array_key_first($this->suppressed) === $key); 50 | } 51 | } 52 | 53 | return $this; 54 | } 55 | 56 | /** 57 | * @return $this 58 | */ 59 | public function withPrevious(Throwable $throwable): self 60 | { 61 | // phpcs:disable SlevomatCodingStandard.Exceptions.ReferenceThrowableOnly.ReferencedGeneralException 62 | $reflection = new ReflectionClass(Exception::class); 63 | // phpcs:enable 64 | $property = $reflection->getProperty('previous'); 65 | $property->setAccessible(true); 66 | $property->setValue($this, $throwable); 67 | 68 | return $this; 69 | } 70 | 71 | /** 72 | * @param array $suppressed 73 | * @return $this 74 | */ 75 | public function withSuppressed(array $suppressed): self 76 | { 77 | foreach ($suppressed as $item) { 78 | $this->suppressed[] = $item; 79 | if (static::$addSuppressedToMessage) { 80 | $this->addSuppressedToMessage($item, count($this->suppressed) === 1); 81 | } 82 | } 83 | 84 | return $this; 85 | } 86 | 87 | /** 88 | * @return array 89 | */ 90 | public function getSuppressed(): array 91 | { 92 | return $this->suppressed; 93 | } 94 | 95 | private function addSuppressedToMessage(Throwable $throwable, bool $isFirst): void 96 | { 97 | if (!$this->isAnySuppressedInMessage) { 98 | $this->message .= ($this->message === '' ? '' : PHP_EOL) 99 | . 'Suppressed errors:'; 100 | } 101 | 102 | $this->isAnySuppressedInMessage = true; 103 | $this->message .= $this->formatSuppressedExceptionMessage($throwable, $isFirst); 104 | } 105 | 106 | private function formatSuppressedExceptionMessage(Throwable $throwable, bool $isFirst): string 107 | { 108 | return ($isFirst ? '' : PHP_EOL) 109 | . $this->indentMessage( 110 | $this->formatSuppressedExceptionMessageInner($throwable), 111 | 2, 112 | 0, 113 | ); 114 | } 115 | 116 | private function formatSuppressedExceptionMessageInner(Throwable $throwable): string 117 | { 118 | $message = preg_replace('~\R~u', PHP_EOL, $throwable->getMessage()); 119 | $class = get_class($throwable); 120 | $file = $throwable->getFile(); 121 | $line = $throwable->getLine(); 122 | $code = $throwable->getCode(); 123 | 124 | // Track exception source in case exception is created by static ctor 125 | $traceStart = $throwable->getTrace()[0]; 126 | if ( 127 | isset($traceStart['class'], $traceStart['file'], $traceStart['line']) 128 | && $traceStart['class'] === $class 129 | ) { 130 | $file = $traceStart['file']; 131 | $line = $traceStart['line']; 132 | } 133 | 134 | $newMessage = "- $class created at $file:$line with code $code" . PHP_EOL; 135 | $newMessage .= $message === '' ? '' : $message; 136 | 137 | $previous = $throwable->getPrevious(); 138 | if ($previous !== null) { 139 | $newMessage .= $this->indentMessage( 140 | $this->formatSuppressedExceptionMessageInner($previous), 141 | 6, 142 | 4, 143 | ); 144 | } 145 | 146 | return $newMessage; 147 | } 148 | 149 | /** 150 | * @param positive-int $size 151 | */ 152 | private function indentMessage(string $originalMessage, int $size, int $firstLineSize): string 153 | { 154 | $lines = explode(PHP_EOL, $originalMessage); 155 | $firstLine = array_key_first($lines); 156 | $lastLine = array_key_last($lines); 157 | 158 | $spaces = str_repeat(' ', $size); 159 | $firstSpaces = str_repeat(' ', $firstLineSize); 160 | 161 | $message = PHP_EOL; 162 | foreach ($lines as $key => $line) { 163 | $message .= 164 | ($key === $firstLine ? $firstSpaces : $spaces) 165 | . $line 166 | . ($key === $lastLine ? '' : PHP_EOL); 167 | } 168 | 169 | return $message; 170 | } 171 | 172 | } 173 | -------------------------------------------------------------------------------- /src/DomainException.php: -------------------------------------------------------------------------------- 1 | */ 25 | private array $fields = []; 26 | 27 | public static function create(): self 28 | { 29 | return new self(); 30 | } 31 | 32 | /** 33 | * @return $this 34 | */ 35 | public function withContext(string $context): self 36 | { 37 | return $this->with('Context', $context); 38 | } 39 | 40 | /** 41 | * @return $this 42 | */ 43 | public function withProblem(string $problem): self 44 | { 45 | return $this->with('Problem', $problem); 46 | } 47 | 48 | /** 49 | * @return $this 50 | */ 51 | public function withSolution(string $solution): self 52 | { 53 | return $this->with('Solution', $solution); 54 | } 55 | 56 | /** 57 | * @param non-empty-string $title 58 | * @return $this 59 | */ 60 | public function with(string $title, string $content): self 61 | { 62 | $this->fields[$title] = $content; 63 | 64 | return $this; 65 | } 66 | 67 | private function addPart(string $title, string $content, ?string $message): string 68 | { 69 | if ($message === null) { 70 | return $this->formatPart($title, $content); 71 | } 72 | 73 | $message .= PHP_EOL . $this->formatPart($title, $content); 74 | 75 | return $message; 76 | } 77 | 78 | private function formatPart(string $title, string $content): string 79 | { 80 | $titleLength = mb_strlen($title); 81 | 82 | $content = preg_replace('~\R~u', PHP_EOL, $content); 83 | assert(is_string($content)); 84 | if (strpos($content, PHP_EOL) === false) { 85 | $content = wordwrap($content, self::$lineLength - $titleLength, PHP_EOL); 86 | } 87 | 88 | $formatted = ''; 89 | $i = 0; 90 | $lines = explode(PHP_EOL, $content); 91 | foreach ($lines as $line) { 92 | $formatted .= $i === 0 93 | ? $title 94 | : str_repeat(' ', $titleLength); 95 | $formatted .= $line; 96 | 97 | $i++; 98 | 99 | if (count($lines) !== $i) { 100 | $formatted .= PHP_EOL; 101 | } 102 | } 103 | 104 | return $formatted; 105 | } 106 | 107 | public function toString(): string 108 | { 109 | return (string) $this; 110 | } 111 | 112 | /** 113 | * @internal 114 | */ 115 | public function __toString(): string 116 | { 117 | $message = null; 118 | $fields = $this->fields; 119 | 120 | foreach (['Context', 'Problem', 'Solution'] as $title) { 121 | if (isset($fields[$title])) { 122 | $message = $this->addPart("$title: ", $fields[$title], $message); 123 | unset($fields[$title]); 124 | } 125 | } 126 | 127 | foreach ($fields as $title => $content) { 128 | $message = $this->addPart("$title: ", $content, $message); 129 | } 130 | 131 | if ($message !== null) { 132 | return $message; 133 | } 134 | 135 | throw InvalidState::create() 136 | ->withMessage('Error message must specify at least one of context, problem or solution.'); 137 | } 138 | 139 | } 140 | --------------------------------------------------------------------------------