Code Monkey home page Code Monkey logo

cakephp-ide-helper's Introduction

CakePHP IdeHelper Plugin

Build Status Coverage Status Latest Stable Version Minimum PHP Version License Total Downloads

IdeHelper plugin for CakePHP applications.

Boost your productivity. Avoid mistakes.

This branch is for CakePHP 3.4+

Features

The main idea is to improve IDE compatibility and use annotations to make the IDE understand the "magic" of CakePHP, so you can click through the class methods and object chains as well as spot obvious issues and mistakes easier. The IDE will usually mark problematic code yellow (missing, wrong method etc).

  • Add annotations to existing code (e.g. when upgrading an application) just like baking would to new code.
  • Can run multiple times without adding the annotations again.
  • It can also replace or remove outdated annotations.
  • Works with your application as well as any loaded plugin.
  • CI check support, hook it up just like the coding standards check.

Supports annotations for:

  • Models (Tables and Entities)
  • Controllers (including prefixes like Admin)
  • View (AppView)
  • Templates (.ctp files including elements)
  • Shells (and Tasks)
  • Components
  • Helpers

Screenshot

Supports code completion help for:

  • Behaviors (property access on the BehaviorRegistry)

IDE support

This plugin is supposed to work with ANY IDE that supports annotations and code completion. IDEs tested so far for 100% compatibility:

  • PHPStorm (incl. meta file generator)
  • IntelliJ
  • Atom
  • ... [Report or PR your IDE of choice here to confirm its full compatibility]

See Wiki for details and tips/settings.

Plugins with meta file generator tasks

The following plugins use this plugin to improve IDE compatibility around factory and magic string usage:

  • Queue for QueuedJobsTable::createJob() usage.
  • ... (add yours here)

Install, Setup, Usage

See the Docs for details.

cakephp-ide-helper's People

Contributors

dereuromark avatar admad avatar kareylo avatar nickbusey avatar theaxiom avatar skie avatar saeideng avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.