antares/accessible

PHP library that allows you to define your class' getters, setters and constructor with docblock annotations.

v3.1 2016-04-26 21:37 UTC

Requires

• php: >=5.4.0
• doctrine/annotations: >=1.2.0
• doctrine/cache: >=1.0
• doctrine/inflector: >=1.0
• symfony/validator: >=2.6

Requires (Dev)

• doctrine/collections: >=1.0
• phpunit/phpunit: >=4.0

MIT

• Antarès Tupin

• annotation
• access
• set
• class
• properties
• get
• popo
• getter
• setter
• pojo

README

Accessible is a PHP library that allows you to define your class behavior in an elegant and powerful way using docblock annotations.

This way, you can define your class' getters, setters and constructor, and automate collections and association management.

Here is a (very) basic example with getters and setters:

class Customer
{
  use AutomatedBehaviorTrait;

  /**
   * @Access({Access::GET, Access::SET})
   * @Assert\Email
   */
  private $email;
}


$bob = new Customer();

$bob->setEmail('[e-mail]');
$bob->getEmail(); // [e-mail]
$bob->setEmail('not an email address'); // throws an InvalidArgumentException

Another example using collections related annotations:

class Server
{
  use AutomatedBehaviorTrait;

  /**
   * @Access({Access::GET})
   * @InitializeObject(ArrayCollection::class)
   * @ListBehavior
   */
  private $processes;
}

$server = new Server();

$server->getProcesses(); // Instance of ArrayCollection
$process = new Process();
$server->addProcess($process);
$server->removeProcess($process);

More complex examples are available in the doc.

What this library can manage in your classes:

• Getters and setters
• Validation on setters parameters using Symfony's Assertion annotations
• Constructor and properties initialization
• Collections
• Associations between classes

Suggestions and contributions are welcome!

Documentation

• How to define getters and setters
• How to define the class constructor and the properties initialization
• How to enable / disable the constraints validation
• How to manage collections
• How to manage associations
• How to modify the default configuration
• Compatibility issues (and how to solve them)

Install

If you want to use this library in your Symfony project, take a look at AccessibleBundle.

You can add this library as a dependency using composer this way:

composer require antares/accessible

This library uses the Doctrine annotations library, so if it is not already done you must register the Composer loader in the annotation registry:

$loader = require __DIR__ . '/vendor/autoload.php';
Doctrine\Common\Annotations\AnnotationRegistry::registerLoader(array($loader, 'loadClass'));

You may want to change the default configuration, to do this see the Configuration dedicated page.

Compatibility

This library is compatible with PHP 5.4+, PHP 7 and HHVM.