https://github.com/dereuromark/cakephp-ide-helper-extra

IdeHelper task and addon collection
https://github.com/dereuromark/cakephp-ide-helper-extra

Last synced: about 1 month ago
JSON representation

IdeHelper task and addon collection

• Host: GitHub
• URL: https://github.com/dereuromark/cakephp-ide-helper-extra
• Owner: dereuromark
• License: mit
• Created: 2020-04-19T14:45:17.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-09-15T17:24:14.000Z (3 months ago)
• Last Synced: 2024-10-11T06:32:52.145Z (2 months ago)
• Language: SCSS
• Homepage: https://github.com/dereuromark/cakephp-ide-helper
• Size: 1.04 MB
• Stars: 2
• Watchers: 3
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: docs/readme.md
  • License: license

Awesome Lists containing this project

• awesome-cakephp - IdeHelperExtra plugin - Useful IdeHelper addons for other plugins or custom use cases. (Code Analysis)

README

        
## CakePHP IdeHelper Extras

IDE auto-complete for your custom code elements.

### Existing tasks

Follow the main documentation on how to add them.

#### Tools.IconHelper::render()

![render() Example](icon-render.png)

Uses the configured task sets:

- IconRenderTask

Fontawesome v4/v5/v6m, Bootstrap or other icon types are all possible.

It will use the configured `Icon.map` config depending on the FA version you are using.

#### Authentication.AuthenticationService::loadIdentifier()

- AuthServiceLoadIdentifierTask

To enable, add it to the task stack in your app config:

```php

use IdeHelperExtra\Authentication\Generator\Task\AuthServiceLoadIdentifierTask;

...

'IdeHelper' => [

    'generatorTasks' => [

        AuthServiceLoadIdentifierTask::class => AuthServiceLoadIdentifierTask::class,

    ],

],

```

### Add your own task

The idea of this repository is to provide a way to collect useful tasks and addons where adding them into the main

plugin is not feasible. Always first check, and then add it here.

The downside of adding it here is a missing constraint towards your plugin version, and that it can lead

to accidental BC breaks.

#### Contributing guidelines

If you want to add your Task here for example:

- src/[PluginName]/[Type]/Task/[ClassNameDetails]Task.php

- test case along with it

- test should also have smoke test of the functionality if possible (to be alerted about BC breaks)

- PR with green checks

You are accepting to be responsible to keep the API of your specific plugin intact.

Fails/Regressions should be handled by you if possible.

A TravisCI cronjob on the repo will check daily status here.