ukko / phpredis-phpdoc
@phpdoc extension phpredis for IDE autocomplete
Installs: 376 116
Dependents: 10
Suggesters: 1
Security: 0
Stars: 218
Watchers: 14
Forks: 120
Open Issues: 8
Requires
- php: >=7.0
This package is auto-updated.
Last update: 2024-10-09 00:39:46 UTC
README
You need to add the path to a class of global include path.
After that, your IDE, when you declare a class Redis will display a hint which methods of this object can be used.
For example:
$redis = new Redis();
$redis->con<press Tab or press Ctrl+Space>
Warning:
Do not forget to declare a variable type $ redis
/**
* Please do not forget to specify the variable type
* @var Redis
*/
public $redis = null;
Install
-
Install redis-server
-
Install phpredis extension
-
The simpliest way to install and use phpredis-phpdoc is to use Composer, as there is a package on Packagist. Just add this to your project composer.json file :
{ "require": { "ukko/phpredis-phpdoc": "*" }, "minimum-stability": "dev" }
-
Or direct download phpredis-phpdoc
Setup in IDE PhpStorm
Menu "File" -> "Settings" -> "PHP" -> Select path to folder "phpredis-phpdoc"
Setup in IDE NetBeans
- Save the file to netbeans stubs folder. For example:
~/netbeans-8.2/php/phpstubs/phpruntime/redis.php
Setup in Zend Studio IDE (Eclipse PDT)
- Open "Window" -> "Preferences"
- In preferences dialog open "PHP" -> "PHP Libriaries"
- Click "New" button, in "User library name" enter "Redis", click "OK"
- Select newly created "Redis", library Click "Add external folder", select path to the folder which contains your checkout of phpredis-phpdoc or you can download single "Redis.php" file https://raw.github.com/ukko/phpredis-phpdoc/master/src/Redis.php
- Include your custom library in your project: open "Project" -> "Properties" -> "PHP Include Path", click add library, select "User library", click "Next", check "Redis", click "Finish"