Searching PHP source code made easy
Search PHP source code for function & method calls, variable assignments, classes and more directly from PHP.
Installation
composer require permafrost-dev/php-code-search
Searching
To search a file, use the search method. Its only parameter may be either a string containing a valid filename or an instance of \Permafrost\PhpCodeSearch\Support\File.
To search a string instead, use the searchCode method.
The search methods return an instance of Permafrost\PhpCodeSearch\Results\FileSearchResults, which has a results property.
Each result is an instance of Permafrost\PhpCodeSearch\Results\SearchResult with the following properties:
node- the specific item that was foundnode->name(): string
location- the location in the file that the item was foundlocation->startLine(): intlocation->endLine(): int
snippet- a snippet of code lines from the file with the result line in the middlesnippet->toString(): string
file()(method) - provides access to the file that was searched
Searching
To search through the code in a string or file, use the Searcher class:
use Permafrost\PhpCodeSearch\Searcher;
$searcher = new Searcher();
To search a file, use the search method, and the searchCode method to search a string of code.
$searcher
->functions(['strtolower', 'strtoupper'])
->search('./file1.php');
$searcher
->variables(['/^one[A-Z]$/'])
->searchCode(');
When searching using any of the available methods, regular expressions can be used by surrounding the name with slashes /, i.e. /test\d+/.
Variable names
To search for variables by name, use the variables method.
$results = $searcher
->variables(['twoA', '/^one.$/'])
->searchCode('.
' $oneA = "1a";'.
' $oneB = "1b";'.
' $twoA = "2a";'.
' $twoB = "2b";'.
'');
foreach($results->results as $result) {
echo "Found '{$result->node->name()}' on line {$result->location->startLine}" . PHP_EOL;
}
Functions
To search for function calls or definitions, use the functions method.
// search for references AND definitions for 'strtolower' and/or 'myfunc'
$searcher
->functions(['strtolower', 'myfunc'])
->search('file1.php');
Method calls
To search for a method call by name, use the methods method.
Method call nodes have an args property that can be looped through to retrieve the arguments for the method call.
$results = $searcher
->methods(['/test(One|Two)/'])
->searchCode('.
' $obj->testOne("hello world 1"); '.
' $obj->testTwo("hello world", 2); '.
''
);
foreach($results->results as $result) {
echo "Found '{$result->node->name()}' on line {$result->location->startLine}" . PHP_EOL;
foreach($result->node->args as $arg) {
echo " argument: '{$arg->value}'" . PHP_EOL;
}
}
Static calls
To search for static method or property calls, use the static method.
Valid search terms are either a class name like Cache, or a class name and a method name like Cache::remember.
$searcher
->static(['Ray', 'Cache::has', 'Request::$myProperty'])
->search('./app/Http/Controllers/MyController.php');
Classes
To search for either a class definition or a class created by the new keyword, use the classes method.
$searcher
->classes(['MyController'])
->search('./app/Http/Controllers/MyController.php');
Variable assignments
To search for a variable assignment by variable name, use the assignments method. Note: The $ should be omitted.
$searcher
->assignments(['myVar'])
->search('./app/Http/Controllers/MyController.php');
Results without code snippets
To return search results without associated code snippets, use the withoutSnippets method:
$searcher
->withoutSnippets()
->functions(['strtolower'])
->search('file1.php');
Testing
./vendor/bin/phpunit
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
License
The MIT License (MIT). Please see License File for more information.
7.2k Dec 30, 2022
192 Dec 10, 2022
219 Sep 2, 2022
1.1k Dec 15, 2022
418 Dec 30, 2022
6.5k Jan 8, 2023
2.2k Dec 30, 2022
655 Jan 3, 2023
157 Dec 5, 2022
6.5k Jan 3, 2023
11.6k Dec 30, 2022
3.9k Jan 1, 2023
542 Dec 24, 2022
443 Sep 23, 2022
391 Nov 30, 2022
24 Aug 27, 2022
12 Nov 11, 2022
2.4k Dec 26, 2022