├── test
├── bootstrap.php
├── DetectorWindowsTest.php
├── DetectorUnixTest.php
├── DetectorUnixOnWindowsTest.php
├── DetectorLinuxTest.php
└── DetectorBase.php
├── .gitignore
├── .travis.yml
├── phpunit.xml
├── composer.json
├── README.md
├── src
├── DetectorInterface.php
└── Detector.php
└── LICENSE
/test/bootstrap.php:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | test/DetectorLinuxTest.php
5 |
6 |
7 | test/DetectorUnixTest.php
8 |
9 |
10 | test/DetectorWindowsTest.php
11 |
12 |
13 | test/DetectorUnixOnWindowsTest.php
14 |
15 |
16 |
17 |
18 | src
19 |
20 |
21 |
22 |
--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "tivie/php-os-detector",
3 | "description": "A small utility library that detects the OS the server is running on",
4 | "keywords": ["OS", "os detection", "operating system", "detection", "detector", "identification"],
5 | "minimum-stability": "stable",
6 | "homepage": "http://tivie.github.com/php-os-detector/",
7 | "type": "library",
8 | "license": "Apache-2.0",
9 | "authors": [
10 | {
11 | "name": "Estevão Soares dos Santos",
12 | "email": "estevao@soares-dos-santos.com"
13 | }
14 | ],
15 | "require": {
16 | "php": ">=7.1.0"
17 | },
18 | "require-dev": {
19 | "phpunit/phpunit": "^7.0"
20 | },
21 | "autoload": {
22 | "psr-4": {
23 | "Tivie\\OS\\": "src/"
24 | }
25 | },
26 | "autoload-dev": {
27 | "psr-4": {
28 | "Tivie\\OS\\": "test"
29 | }
30 | }
31 | }
32 |
--------------------------------------------------------------------------------
/test/DetectorWindowsTest.php:
--------------------------------------------------------------------------------
1 | os->getFamily());
37 | self::assertEquals(WINDOWS, $this->os->getType());
38 | $haystack = array('WINDOWS', 'WINNT', 'WIN32');
39 | self::assertContains($this->os->getKernelName(), $haystack, "", true);
40 | }
41 | }
42 |
--------------------------------------------------------------------------------
/test/DetectorUnixTest.php:
--------------------------------------------------------------------------------
1 | os->getFamily());
41 | self::assertEquals(LINUX, $this->os->getType());
42 | self::assertEquals('LINUX', strtoupper($this->os->getKernelName()));
43 | }
44 |
45 | }
46 |
--------------------------------------------------------------------------------
/test/DetectorUnixOnWindowsTest.php:
--------------------------------------------------------------------------------
1 | getFamily());
44 |
45 | $haystack = array(MSYS, CYGWIN);
46 | self::assertContains($os->getType(), $haystack);
47 |
48 | self::assertContains($os->getKernelName(), $haystack, "", true);
49 | }
50 | }
51 |
--------------------------------------------------------------------------------
/test/DetectorLinuxTest.php:
--------------------------------------------------------------------------------
1 | os->getFamily());
41 | self::assertEquals(LINUX, $this->os->getType());
42 | self::assertEquals('LINUX', strtoupper($this->os->getKernelName()));
43 | self::assertTrue($this->os->isUnixLike());
44 | self::assertFalse($this->os->isOSX());
45 | self::assertFalse($this->os->isWindowsLike());
46 | }
47 |
48 | }
49 |
--------------------------------------------------------------------------------
/test/DetectorBase.php:
--------------------------------------------------------------------------------
1 | os = new Detector();
35 | }
36 |
37 | /**
38 | * @covers \Tivie\OS\Detector::getFamily
39 | * @covers \Tivie\OS\Detector::getType
40 | * @covers \Tivie\OS\Detector::getKernelName
41 | */
42 | public function testGetters()
43 | {
44 | self::assertIsInt($this->os->getFamily(), "getFamily() is not returning an integer (and it should)");
45 | self::assertIsInt($this->os->getType(), "getType() is not returning an integer (and it should)");
46 | self::assertIsString($this->os->getKernelName(), "getKernelName() is not returning a string (and it should)");
47 |
48 | return $this->os;
49 | }
50 | }
51 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | PHP OS Detector
2 | ===============
3 | [](https://packagist.org/packages/tivie/php-os-detector)
4 | [](https://packagist.org/packages/tivie/php-os-detector)
5 | [](https://packagist.org/packages/tivie/php-os-detector)
6 |
7 | A small PHP utility library that detects the OS the server is running on.
8 |
9 | ## Compatibility
10 |
11 | Although only tested in PHP 7, PHP OS Detector should be compatible with PHP 5.3 or greater
12 |
13 | ## Installation
14 | You can install it by cloning the git repository or using composer.
15 |
16 | ### Git clone
17 |
18 | git clone https://github.com/tivie/php-os-detector.git
19 |
20 | ### Composer
21 | Add these lines to your composer.json:
22 | ```json
23 | {
24 | "require": {
25 | "tivie/php-os-detector": "*"
26 | }
27 | }
28 | ```
29 | or run the following command:
30 |
31 | php composer.phar require tivie/php-os-detector
32 |
33 |
34 | ## Usage Example
35 |
36 | ```php
37 | $os = new \Tivie\OS\Detector();
38 | $kernelName = $os->getKernelName();
39 | if ($os->isUnixLike()) {
40 | echo "I'm using a Unix like system with kernel $kernelName";
41 | } else if ($os->isWindowsLike()) {
42 | echo "I'm using a Windows like system with kernel $kernelName";
43 | } else {
44 | echo "I'm using a non-Unix non-Windows system";
45 | }
46 | ```
47 |
48 | ## Contribute
49 | Feel free to contribute by forking or making suggestions.
50 |
51 | Issue tracker: https://github.com/tivie/php-os-detector/issues
52 |
53 | Source code: https://github.com/tivie/php-os-detector
54 |
55 |
56 | ## License
57 | Command Library is released under Apache 2.0 license. For more information, please consult
58 | the [LICENSE file in this repository](https://github.com/tivie/php-os-detector/blob/master/LICENSE) or
59 | http://www.apache.org/licenses/LICENSE-2.0.txt.
60 |
--------------------------------------------------------------------------------
/src/DetectorInterface.php:
--------------------------------------------------------------------------------
1 | kernel = strtoupper(PHP_OS);
55 | $this->parsePHPOS($this->kernel);
56 | }
57 |
58 | /**
59 | * If the Operating System is Unix Like
60 | * @return bool
61 | */
62 | public function isUnixLike()
63 | {
64 | return ($this->family === UNIX_FAMILY);
65 | }
66 |
67 | /**
68 | * If the Operating System is OSX
69 | * @return bool
70 | */
71 | public function isOSX()
72 | {
73 | return ($this->getType() === MACOSX);
74 | }
75 |
76 | /**
77 | * If the Operating System is Windows Like
78 | *
79 | * @return int
80 | */
81 | public function isWindowsLike()
82 | {
83 | return ($this->family === WINDOWS_FAMILY);
84 | }
85 |
86 | /**
87 | * Get the Family constant
88 | *
89 | * @return int
90 | */
91 | public function getFamily()
92 | {
93 | return $this->family;
94 | }
95 |
96 | /**
97 | * Get the Kernel's name as specified in uname
98 | *
99 | * @return string
100 | */
101 | public function getKernelName()
102 | {
103 | return $this->kernel;
104 | }
105 |
106 | /**
107 | * Get the Kernel type
108 | *
109 | * @return int
110 | */
111 | public function getType()
112 | {
113 | return $this->osConst;
114 | }
115 |
116 | protected function parsePHPOS(string $name, $repeat = true)
117 | {
118 | switch ($name) {
119 |
120 | case "WINDOWS":
121 | case "WINNT":
122 | case "WIN32":
123 | case "INTERIX":
124 | case "UWIN":
125 | case "UWIN-W7":
126 | $family = WINDOWS_FAMILY;
127 | $osConst = WINDOWS;
128 | break;
129 |
130 | case "CYGWIN":
131 | case "CYGWIN_NT-5.1":
132 | case "CYGWIN_NT-6.1":
133 | case "CYGWIN_NT-6.1-WOW64":
134 | $family = UNIX_ON_WINDOWS_FAMILY;
135 | $osConst = CYGWIN;
136 | break;
137 |
138 | case "MINGW":
139 | case "MINGW32_NT-6.1":
140 | case "MSYS_NT-6.1":
141 | $family = UNIX_ON_WINDOWS_FAMILY;
142 | $osConst = MSYS;
143 | break;
144 |
145 | case "DARWIN":
146 | $family = UNIX_FAMILY;
147 | $osConst = MACOSX;
148 | break;
149 |
150 | case "LINUX":
151 | case "GNU":
152 | case "GNU/LINUX":
153 | $family = UNIX_FAMILY;
154 | $osConst = LINUX;
155 | break;
156 |
157 | //HP UNIX systems
158 | case "AIX":
159 | $family = UNIX_FAMILY;
160 | $osConst = AIX;
161 | break;
162 |
163 | case "OS390":
164 | case "OS/390":
165 | case "OS400":
166 | case "OS/400":
167 | case "ZOS":
168 | case "Z/OS":
169 | $family = UNIX_FAMILY;
170 | $osConst = ZOS;
171 | break;
172 |
173 | case "HP-UX":
174 | $family = UNIX_FAMILY;
175 | $osConst = HP_UX;
176 | break;
177 |
178 | // SUN's UNIX systems
179 | case "SOLARIS":
180 | case "SUNOS":
181 | $family = UNIX_FAMILY;
182 | $osConst = SUN_OS;
183 | break;
184 |
185 | // UNIX BSD Systems
186 | case "DRAGONFLY":
187 | case "OPENBSD":
188 | case "FREEBSD":
189 | case "NETBSD":
190 | case "GNU/KFREEBSD":
191 | case "GNU/FREEBSD":
192 | case "DEBIAN/FREEBSD":
193 | $family = UNIX_FAMILY;
194 | $osConst = BSD;
195 | break;
196 |
197 | //Other UNIX systems
198 | case "MINIX":
199 | case "IRIX":
200 | case "IRIX64":
201 | case "OSF1":
202 | case "SCO_SV":
203 | case "ULTRIX":
204 | case "RELIANTUNIX-Y":
205 | case "SINIX-Y":
206 | case "UNIXWARE":
207 | case "SN5176":
208 | case "K-OS":
209 | case "KOS":
210 | $family = UNIX_FAMILY;
211 | $osConst = GEN_UNIX;
212 | break;
213 |
214 | //Blackberry's Unix System
215 | case "QNX":
216 | $family = UNIX_FAMILY;
217 | $osConst = QNX;
218 | break;
219 |
220 | // HAIKU
221 | case "BEOS":
222 | case "BE_OS":
223 | case "HAIKU":
224 | $family = OTHER_FAMILY;
225 | $osConst = BE_OS;
226 | break;
227 |
228 | // NONSTOP
229 | case "NONSTOP KERNEL":
230 | case "NONSTOP":
231 | $family = OTHER_FAMILY;
232 | $osConst = NONSTOP;
233 | break;
234 |
235 | default:
236 | $family = 0;
237 | $osConst = 0;
238 | }
239 |
240 | if ($repeat && $osConst === 0) {
241 | $name = $this->normalizePHPOS($name);
242 | $this->parsePHPOS($name, false);
243 | }
244 |
245 | $this->family = $family;
246 | $this->osConst = $osConst;
247 | }
248 |
249 | /**
250 | * This method normalizes some names for future compliance
251 | *
252 | * @param string $name
253 | * @return string
254 | */
255 | protected function normalizePHPOS(string $name)
256 | {
257 | //Cygwin
258 | if (stripos($name, 'CYGWIN') !== false) {
259 | return 'CYGWIN';
260 | }
261 |
262 | //MinGW
263 | if (stripos($name, 'MSYS') !== false || stripos($name, 'MINGW') !== false) {
264 | return 'MINGW';
265 | }
266 |
267 | return $name;
268 | }
269 | }
270 |
--------------------------------------------------------------------------------
/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 2014-2017 Estevão Soares dos Santos
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.
202 |
--------------------------------------------------------------------------------