saxulum/saxulum-annotation-manager

Saxulum Annotation Manager

saxulum-annotation-manager

works with plain silex-php, _(*1)

, _(*2)

Features

• An annotation manager

Requirements

• php >=5.3
• Doctrine Annotations >=1.1
• Saxulum ClassFinder >=1.0
• Symfony Finder Component >=2.3

Installation

Through Composer as [saxulum/saxulum-annotation-manager][1]., _(*3)

AnnotationRegistry

Add this line after you added the autoload.php from composer, _(*4)

```{.php} \Doctrine\Common\Annotations\AnnotationRegistry::registerLoader( array($loader, 'loadClass') );, <sub>(*5)</sub>

Usage
-----

### Prepare the annotation Manager

```{.php}
use Doctrine\Common\Annotations\AnnotationReader;
use Saxulum\AnnotationManager\Manager\AnnotationManager;

$annotationReader = new AnnotationReader();
$annotationManager = new AnnotationManager($annotationReader);

ClassInfo based on paths

This will search each instantiable class within the given paths and return em as an array of Saxulum\AnnotationManager\Helper\ClassInfo instances., <sub>(*6)</sub>

```{.php} $classInfos = $annotationManager->buildClassInfosBasedOnPaths(array( dirname(DIR) . '/Classes1', dirname(DIR) . '/Classes2' ));, <sub>(*7)</sub>

### ClassInfo based on path
This will search each instantiable class within the given path
and return em as an array of `Saxulum\AnnotationManager\Helper\ClassInfo`
instances.

```{.php}
$classInfos = $annotationManager->buildClassInfosBasedOnPath(
    dirname(__DIR__) . '/Classes1'
);

ClassInfo based on reflection classes

This will return an array of Saxulum\AnnotationManager\Helper\ClassInfo instances based on the given ReflectionClasses., <sub>(*8)</sub>

```{.php} $classInfos = $annotationManager->buildClassInfos(array( new \ReflectionClass(new TestClass1()), new \ReflectionClass(new TestClass2()) ));, <sub>(*9)</sub>

### ClassInfo based on reflection class
This will return an instance of `Saxulum\AnnotationManager\Helper\ClassInfo`
based on the given ReflectionClass.

```{.php}
$classInfo = $annotationManager->buildClassInfo(
    new \ReflectionClass(new TestClass1())
);

ReflectionClasses based on path

This will search each instantiable class within the given path and return em as an array of \ReflectionClass instances., <sub>(*10)</sub>

```{.php} $reflectionClasses = AnnotationManager::getReflectionClasses( dirname(DIR) . '/Classes1' );, <sub>(*11)</sub>

### Classes based on SplFileInfo
This will search each class within the given file and return em
as an array of class names.

```{.php}
$classes = AnnotationManager::findClassesWithinAFile(
    new SplFileInfo(
        dirname(__DIR__) . '/Classes1/TestClass1.php',
        '',
        'TestClass1.php'
    )
);