├── CHANGELOG.md ├── LICENSE ├── README.md ├── composer.json └── src ├── Digits.php ├── E123.php ├── E164.php ├── NANP.php └── Phone.php /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | 3 | All notable changes to `laravel-validation-rules/us-phone` will be documented in this file. 4 | 5 | ### 1.1.0 6 | - Added E123 7 | 8 | ### 1.0.1 9 | - Improved test coverage. 10 | - Fixed README instructions 11 | 12 | ### 1.0.0 13 | - Initial release and connected with packagist 14 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright 2017 Scott Wilcox 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Phone 2 | 3 | Validates phone number format. 4 | 5 |

6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 |

22 | 23 | ## Installation 24 | 25 | ```bash 26 | composer require laravel-validation-rules/phone 27 | ``` 28 | 29 | ## Usage 30 | 31 | ```php 32 | use LVR\Phone\Phone; 33 | use LVR\Phone\E123; 34 | use LVR\Phone\E164; 35 | use LVR\Phone\NANP; 36 | use LVR\Phone\Digits; 37 | 38 | // Test any phone number 39 | $request->validate(['test' => '15556667777'], ['test' => new Phone]); // Pass! 40 | $request->validate(['test' => '+15556667777'], ['test' => new Phone]); // Pass! 41 | $request->validate(['test' => '+1 (555) 666-7777'], ['test' => new Phone]); // Pass! 42 | 43 | // Test for E123 44 | $request->validate(['test' => '+22 555 666 7777'], ['test' => new E123]); // Pass! 45 | 46 | // Test for E164 47 | $request->validate(['test' => '+15556667777'], ['test' => new E164]); // Pass! 48 | 49 | // Test for NANP (North American Numbering Plan) 50 | $request->validate(['test' => '+1 (555) 666-7777'], ['test' => new NANP); // Pass! 51 | 52 | // Test for digits only 53 | $request->validate(['test' => '15556667777'], ['test' => new Digits]); // Pass! 54 | ``` 55 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "laravel-validation-rules/phone", 3 | "description": "Validate that a phone number is in the correct format", 4 | "keywords": [ 5 | "laravel", 6 | "validator", 7 | "phone", 8 | "tylercd100" 9 | ], 10 | "homepage": "https://github.com/laravel-validation-rules/phone", 11 | "license": "Apache-2.0", 12 | "authors": [ 13 | { 14 | "name": "Tyler Arbon", 15 | "email": "tylercd100@gmail.com" 16 | }, 17 | { 18 | "name": "Scott Robinson", 19 | "email": "scott@dor.ky", 20 | "homepage": "http://dor.ky" 21 | } 22 | ], 23 | "autoload": { 24 | "psr-4": { 25 | "LVR\\Phone\\": "src/" 26 | } 27 | }, 28 | "autoload-dev": { 29 | "psr-4": { 30 | "LVR\\Phone\\Tests\\": "tests/" 31 | } 32 | }, 33 | "minimum-stability": "stable", 34 | "require": { 35 | "illuminate/contracts": "^5.5|^6.0|^7.0|^8.0|^9.0|^10.0|^11.0|^12.0", 36 | "illuminate/support": "^5.5|^6.0|^7.0|^8.0|^9.0|^10.0|^11.0|^12.0", 37 | "php": "^7.0|^8.0" 38 | }, 39 | "require-dev": { 40 | "phpunit/phpunit": "^6.3|^9.0|^10.5|^11.5.3", 41 | "orchestra/testbench": "^3.5|^5.0|^7.0|^9.0|^10.0" 42 | }, 43 | "suggest": [] 44 | } 45 | -------------------------------------------------------------------------------- /src/Digits.php: -------------------------------------------------------------------------------- 1 | isDigits($value); 19 | } 20 | 21 | /** 22 | * Get the validation error message. 23 | * 24 | * @return string 25 | */ 26 | public function message() 27 | { 28 | return ':attribute must be in digits only phone format'; 29 | } 30 | } 31 | -------------------------------------------------------------------------------- /src/E123.php: -------------------------------------------------------------------------------- 1 | isE123($value); 19 | } 20 | 21 | /** 22 | * Get the validation error message. 23 | * 24 | * @return string 25 | */ 26 | public function message() 27 | { 28 | return ':attribute must be in E.123 phone format'; 29 | } 30 | } -------------------------------------------------------------------------------- /src/E164.php: -------------------------------------------------------------------------------- 1 | isE164($value); 19 | } 20 | 21 | /** 22 | * Get the validation error message. 23 | * 24 | * @return string 25 | */ 26 | public function message() 27 | { 28 | return ':attribute must be in E.164 phone format'; 29 | } 30 | } -------------------------------------------------------------------------------- /src/NANP.php: -------------------------------------------------------------------------------- 1 | isNANP($value); 19 | } 20 | 21 | /** 22 | * Get the validation error message. 23 | * 24 | * @return string 25 | */ 26 | public function message() 27 | { 28 | return ':attribute must be in the NANP phone format'; 29 | } 30 | } -------------------------------------------------------------------------------- /src/Phone.php: -------------------------------------------------------------------------------- 1 | isPhone($value); 19 | } 20 | 21 | /** 22 | * Get the validation error message. 23 | * 24 | * @return string 25 | */ 26 | public function message() 27 | { 28 | return 'Incorrect phone format for :attribute.'; 29 | } 30 | 31 | /** 32 | * Checks through all validation methods to verify it is in a 33 | * phone number format of some type 34 | * @param string $value The phone number to check 35 | * @return boolean is it correct format? 36 | */ 37 | protected function isPhone($value) 38 | { 39 | return $this->isE123($value) || $this->isE164($value) || $this->isNANP($value) || $this->isDigits($value); 40 | } 41 | 42 | /** 43 | * Format example 5555555555, 15555555555 44 | * @param [type] $value [description] 45 | * @return boolean [description] 46 | */ 47 | protected function isDigits($value) 48 | { 49 | $conditions = []; 50 | $conditions[] = strlen($value) >= 10; 51 | $conditions[] = strlen($value) <= 16; 52 | $conditions[] = preg_match("/[^\d]/i", $value) === 0; 53 | return (bool) array_product($conditions); 54 | } 55 | 56 | /** 57 | * Format example +22 555 555 1234, (607) 555 1234, (022607) 555 1234 58 | * @param $value 59 | * @return bool 60 | */ 61 | protected function isE123($value) 62 | { 63 | return preg_match('/^(?:\((\+?\d+)?\)|\+?\d+) ?\d*(-?\d{2,3} ?){0,4}$/', $value) === 1; 64 | } 65 | 66 | /** 67 | * Format example +15555555555 68 | * @param string $value The phone number to check 69 | * @return boolean is it correct format? 70 | */ 71 | protected function isE164($value) 72 | { 73 | $conditions = []; 74 | $conditions[] = strpos($value, "+") === 0; 75 | $conditions[] = strlen($value) >= 9; 76 | $conditions[] = strlen($value) <= 16; 77 | $conditions[] = preg_match("/[^\d+]/i", $value) === 0; 78 | return (bool) array_product($conditions); 79 | } 80 | 81 | /** 82 | * Format examples: (555) 555-5555, 1 (555) 555-5555, 1-555-555-5555, 555-555-5555, 1 555 555-5555 83 | * https://en.wikipedia.org/wiki/National_conventions_for_writing_telephone_numbers#United_States.2C_Canada.2C_and_other_NANP_countries 84 | * @param string $value The phone number to check 85 | * @return boolean is it correct format? 86 | */ 87 | protected function isNANP($value) 88 | { 89 | $conditions = []; 90 | $conditions[] = preg_match("/^(?:\+1|1)?\s?-?\(?\d{3}\)?(\s|-)?\d{3}-\d{4}$/i", $value) > 0; 91 | return (bool) array_product($conditions); 92 | } 93 | } --------------------------------------------------------------------------------