antares/accessible

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

Accessible

, _(*1)

Accessible is a PHP library that allows you to define your class behavior in an elegant and powerful way using docblock annotations., _(*2)

This way, you can define your class' getters, setters and constructor, and automate collections and association management., _(*3)

Here is a (very) basic example with getters and setters:, _(*4)

class Customer
{
  use AutomatedBehaviorTrait;

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


$bob = new Customer();

$bob->setEmail('bob@example.com');
$bob->getEmail(); // bob@example.com
$bob->setEmail('not an email address'); // throws an InvalidArgumentException

Another example using collections related annotations:, _(*5)

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., _(*6)

What this library can manage in your classes:, _(*7)

• 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!, _(*8)

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., _(*9)

You can add this library as a dependency using composer this way:, _(*10)

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:, _(*11)

$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., _(*12)

Compatibility

This library is compatible with PHP 5.4+, PHP 7 and HHVM., _(*13)