dereuromark/cakephp-ide-helper-extra

Tasks/Addons for CakePHP IdeHelper plugin

0.2.0 2023-09-28 18:02 UTC

Requires

• php: >=8.1
• cakephp/cakephp: ^5.0.0
• dereuromark/cakephp-ide-helper: ^2.0.0

Requires (Dev)

• dereuromark/cakephp-tools: dev-cake5
• fig-r/psr2r-sniffer: dev-next
• phpunit/phpunit: ^10.2

MIT

• Mark Scherer
• Other contributors

• annotations
• phpdoc
• plugin
• autocomplete
• cakephp
• ide
• phpstorm

README

IdeHelperExtra plugin for CakePHP applications.

• Provides useful Tasks/Addons for IdeHelper

This branch is for use with CakePHP 5.0+. For details see version map.

Features

Supports IDE autocomplete/typehinting of (magic)strings as well as return types/values for:

• Tools plugin
  • IconHelper::render() and FontAwesome v4/v5/v6 or Bootstrap icons
• Authentication plugin
  • AuthenticationService::loadIdentifier()
• ... and more (using PHPStorm meta file)

See IdeHelper Wiki for details and tips/settings.

You can submit your own tasks either inside your plugin or here as extra.

Plugins with already included tasks and more

See https://github.com/dereuromark/cakephp-ide-helper/#plugins-with-meta-file-generator-tasks

When to put addons in this plugin

The addons in this plugin aim to decouple the IdeHelper and other plugins. The dependency even as require-dev can sometimes not be desired. So whenever you want to have the dependency not part of it, you can ask to put things here or make your own addon plugin of sorts.

Install, Setup, Usage, Contribution

See the Docs for details.