dipyalov / php-integrator-base

Atom base package for php-integrator that exposes services for querying PHP sources.

php-integrator-base

PHP Integrator analyzes PHP projects and exposes a service that other packages can use to provide additional functionality, such as autocompletion, code navigation and tooltips. In itself it does not provide any user-visible functionality. This is instead covered by various other packages which 'plug in' to the service:

• php-integrator-autocomplete-plus - Provides intelligent PHP autocompletion in combination with autocomplete-plus.
• php-integrator-navigation - Provides code navigation and go to functionality.
• php-integrator-tooltips - Shows tooltips with documentation for your code.
• php-integrator-annotations - Shows annotations in your code, such as for overridden methods and interface implementations.

The source code was originally based on the php-autocomplete-plus code base and provides various improvements as well as separation of the various components into separate packages.

What do I need to do to make it work?

Currently the following is required in order to get the package up and running:

• PHP - To run this package properly, you need at least PHP 5.4. The code you're actually writing can be anything ranging from PHP 5.2 up to (and including) PHP 7.0.
  • php-sqlite - Required as back end for the indexing database.
• PSR-compliant code - Write code that follows the PSR standards, especially regarding namespacing.
• Documentation and type hinting - Write proper docblocks that follow the draft PSR-5 standard (inspired by phpDocumentor's implementation) or use type hinting as much as possible:
  • Docblocks with a @var tag for properties.
  • Docblocks with @param tags for functions and methods. Parameter type hints will also work.
  • Docblocks with a @return tag for functions and methods. Return types in PHP 7 will also work.
  • IntellJ-style variable annotations /** @var MyType $var */ as well as /** @var $var MyType */ to override automatically deduced types or specify types in cases where it can't be automatically deduced.

Note that folders that aren't readable (no permission) will be silently ignored!

Some features may or may not work outside these restrictions. Don't forget to open the settings page after installing to set up the package!

I'm a package developer - How do I use this?

You can very easily start using the service by simply consuming the service in your package (see also the package.json and Main.coffee files of the packages listed above for an example). The service is a single exposed class, which is located in the Service.coffee file, along with docblocks explaining what they do and what they accept as parameters.

As the service allows fetching information about the code base, other packages can do all kinds of interesting things with it that brings Atom closer to an IDE for PHP, yet completely open-source. Here are some idea's of things that could be done with the service (besides what the existing packages listed above already do):

• A symbol viewer that lists all the members of the classes in the current file.
• A class diagram builder that creates a visual representation of the relations between all classes in a code base (i.e. their implemented interfaces, base classes and traits).
• A refactoring package that allows:
  • ... automatically adding methods that are present in an interface of the current class but aren't present yet in the current file.
  • ... automatically generating getters and setters for properties that don't have one yet.
  • ... automatically creating methods and/or properties when they don't exist yet (e.g. on alt-enter).
  • ... generating constructors.
  • ... generating, updating and linting docblocks.

What does not work?

Most of the issue reports indicate things that are missing, but indexing should be working fairly well in general. There are also some things that won't be supported because they are fairly complex to implement (usually for fairly little benefit). These limitations may also affect other packages using the provided service:

• static and self behave mostly like $this in non-static contexts, i.e. they can also access non-static members.

Regarding donations

Donations were not my primary intention when releasing this project as open source, but I do accept them and am very grateful for any donation you may give. As such, a link to the (PayPal) donation screen is located here, at the bottom of the readme, hidden from initial sight and not even in the form of a fancy button ;-).