permafrost-dev/php-code-search

Search PHP code for function & method calls, variable assignments, and more

1.12.0 2024-09-03 04:33 UTC

Requires

• php: ^7.4|^8.0
• nikic/php-parser: ^5.0
• permafrost-dev/code-snippets: ^1.2.0

Requires (Dev)

• phpunit/phpunit: ^9.5
• spatie/phpunit-snapshot-assertions: ^4.2

MIT

• Patrick Organ

• php
• search
• code
• permafrost
• sourcecode

README

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 found
  • node->name(): string
• location - the location in the file that the item was found
  • location->startLine(): int
  • location->endLine(): int
• snippet - a snippet of code lines from the file with the result line in the middle
  • snippet->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('<?php $oneA = "1a";');

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('<?php '.
    '    $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('<?php '.
      '    $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

• Patrick Organ
• All Contributors

License

The MIT License (MIT). Please see License File for more information.