https://github.com/soderlind/coding-standard
A PHP CodeSniffer sniff that checks if the global PHP functions are missing a backslash.
https://github.com/soderlind/coding-standard
Last synced: about 1 month ago
JSON representation
A PHP CodeSniffer sniff that checks if the global PHP functions are missing a backslash.
- Host: GitHub
- URL: https://github.com/soderlind/coding-standard
- Owner: soderlind
- License: mit
- Archived: true
- Created: 2020-01-02T23:30:51.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-01-09T18:11:15.000Z (about 6 years ago)
- Last Synced: 2026-01-11T13:00:39.370Z (about 1 month ago)
- Language: PHP
- Homepage:
- Size: 39.1 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# My PHP CodeSniffer sniff
## Sniff
`FullyQualifiedGlobalFunctions`, a PHP CodeSniffer sniff that checks if the global PHP functions are missing a backslash.
### Why?:
Function resolution without the backslash forces the PHP globals to verify for each function call if function belongs to current namespace or the global namespace. With the backslash PHP does not check the current namespace and therefore execution is faster.
## Install
Install it with `composer require --dev soderlind/coding-standard`
## Use
Create a `phpcs.xml.dist` in the project root folder. Something like this:
```xml
/vendor/*
Checks if global PHP functions are fully qualified.
```
If you set `onlyOptimizedFunctions` to true, backslash will only be added to [optimized functions](https://github.com/soderlind/coding-standard/blob/master/FullyQualifiedGlobalFunctions/Sniffs/FullyQualifiedGlobalFunctionsSniff.php#L21-L61).
 **NOTE**, `` doesn't work atm. If you want to add backslash only to the optimized functions, [use the command line](#command-line)
### Check
`./vendor/bin/phpcs -p test.php`
```
FILE: test.php
--------------------------------------------------------------------------------
FOUND 2 ERRORS AFFECTING 2 LINES
--------------------------------------------------------------------------------
5 | ERROR | [x] Function array_diff() should be referenced via a fully
| | qualified name, e.g.: \array_diff()
7 | ERROR | [x] Function in_array() should be referenced via a fully qualified
| | name, e.g.: \in_array()
--------------------------------------------------------------------------------
PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------
```
### Fix
`./vendor/bin/phpcbf -p test.php`
```
PHPCBF RESULT SUMMARY
----------------------------------------------------------------------
FILE FIXED REMAINING
----------------------------------------------------------------------
test.php 2 0
----------------------------------------------------------------------
A TOTAL OF 2 ERRORS WERE FIXED IN 1 FILE
----------------------------------------------------------------------
```
### Command line
Instead of adding the rule to your `phpcs.xml.dist` file, you can run it from the command line, e.g.:
`./vendor/bin/phpcbf -p test.php --standard=FullyQualifiedGlobalFunctions --runtime-set onlyOptimizedFunctions true`
## License
MIT License
Copyright (c) 2020 Per Søderlind
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.