Annotating with Annotations - PHPBenelux June/2012

PHPBenelux

MeetingAnnotating

Annotations A

Annotations

PHP on

twitter Rafael

Dohms @rdohms

PHPBenelux

MeetingAnnotating

Annotations A

Annotations

PHP on

twitter Rafael

Dohms @rdohms

Rafael Dohms photo credit: Eli White @rdohms Evangelist, Speaker and Contributor.Developer at WEBclusive.Enabler at AmsterdamPHP.

little

history existing

uses What? Why? Where? How? ustom

ann otations Impl ementing

c DMSFilter based

http://ecdesignrebels.blogspot.com w h a t? ta tio ns? re

an noW ha t

-- In English --"An annotation is a note that is made while reading any form of text."

something

describes

aspect

subject -- In English --"An annotation is a note that is made while reading any form of text."

-- In Code Speak --“An annotation describes behavior of code and affects your application in runtime.” “Annotations do not directly affect program semantics”

-- In Code Speak --“An annotation describes behavior of code and affects your application in runtime.” “Annotations do not directly affect program semantics” just

Metadata

“General

purpose

Annotations”

Metadata

“General

purpose

Annotations” available

Runtime

Reflection

Metadata

“General

purpose

Annotations” @Entity @Table(name = "people") class Person implements Serializable { @Id @GeneratedValue(strategy = GenerationType.AUTO) private Integer id; @Column(length = 32) private String name; available

Runtime

Reflection

Metadata

“General

purpose

Annotations” specific

syntax @Entity @Table(name = "people") class Person implements Serializable { @Id @GeneratedValue(strategy = GenerationType.AUTO) private Integer id; @Column(length = 32) private String name; available

Runtime

Reflection

annotation

support

Questions?

Questions?I’m

kidding!

phpDoc~2000

5.1 Reflection

supports

getDocComments()phpDoc~2000 2005

5.1 Reflection

supports

getDocComments()phpDoc~2000 2005 First

Annotation

Engines

5.1 Reflection

supports

getDocComments()phpDoc~2000 2005 2008 First

Annotation

Engines

5.1 Reflection

supports

getDocComments()phpDoc~2000 2005 2008 First

Doctrine

Annotation Annotation

Engine

Engines

5.1 Reflection

supports

getDocComments() RFC:

Annotations

custom

phpDoc syntax~2000 2005 2008 2010 First

Doctrine

Engine

Engines

5.1 Reflection

supports

getDocComments() RFC:

Annotations

ED CTustom

c wphpDoc E Rsyntax~2000 2005 2008 2010 First

Doctrine

Engine

Engines

5.1 RFC:

DocBlock

Reflection

supports

Annotations getDocComments() “in

discussion” RFC:

Annotations

ED CTustom

c wphpDoc E Rsyntax~2000 2005 2008 2010 2011 First

Doctrine

Engine

Engines

5.1 RFC:

DocBlock

Reflection

supports

Annotations getDocComments() “in

discussion” RFC:

Annotations

ED CTustom

c wphpDoc E Rsyntax~2000 2005 2008 2010 2011 ? First

Doctrine

Engine

Engines

5.1 RFC:

DocBlock

Reflection

supports

Annotations getDocComments() /** * CaasBundleFundingBundleEntityReward “in

discussion” * RFC:

Annotations

ED * @ORMTable("reward") CTustom

* @ORMEntity(repositoryClass="CaasBundleFundingBundleEntityRewardRepository") */ class Reward in

c w E {phpDoc /** Rsyntax ? * @var integer $id * * @ORMColumn(name="id", type="integer") * @ORMId * @ORMGeneratedValue(strategy="AUTO")~2000 */ protected $id; 2005 2008 2010 2011 /** * @var string $title * * @ORMColumn(name="title", type="string", length=150, nullable=true) * First

* @AssertMaxLength(150) */ protected $title; Doctrine

Engine

Engines

Note://

comment T_COMMENT/*

multiline

comment

Note://

comment T_COMMENT/*

multiline

comment

block T_DOC_COMMENT

/** * @deprecated * * @ORMColumn(‘string’, length=255) */public function method()

marker/** * @deprecated * * @ORMColumn(‘string’, length=255) */public function method()

marker parameterized/** * @deprecated * * @ORMColumn(‘string’, length=255) */public function method()

http://ecdesignrebels.blogspot.com Wh y ?

an no tatio ns? uld

use /co ns? hy

p rosW t

th w ha

Harder

(dynamic

code)-

Harder

(dynamic

code)- Performance

(non-native

Harder

(dynamic

code)- Performance

(non-native

code) Its

implemented

comments

docblocks!

Easier

inject

behavior

without

extending+

Easier

inject

behavior

without

extending Doctrine

Doctrine

Easier

inject

behavior

without

extending Doctrine

Doctrine

2 Contextualizes

behavior/config

object+

Easier

inject

behavior

without

extending Doctrine

Doctrine

2 Contextualizes

behavior/config

object+ In

object

external

configuration

Easier

inject

behavior

without

extending Doctrine

Doctrine

2 Contextualizes

behavior/config

object+ In

object

external

configuration

file Its

documented/stored

phpDocumentor

Easier

inject

behavior

without

extending Doctrine

Doctrine

2 Contextualizes

behavior/config

object+ In

object

external

configuration

file Its

documented/stored

phpDocumentor Its

docblocks,

parsed

<?phpclass User{ protected $name ...}

<?php -

persist

varchar length

should

class User{ -

should

blank -

letters protected $name ...}

persistence DoctrineTestsORMMappingUser: type: entity table: cms_users<?php id: id: -

persist

varchar type: integer length

should

class User generator:{ -

strategy: AUTO more

255 fields: name: -

should

blank type: string -

letters length: 255 protected $name Validation AcmeBlogBundleEntityAuthor: properties: name: ... - NotBlank: ~ - MaxLength: 255 filter AcmeBlogBundleEntityAuthor:} filters: name: - alpha

persistence Validation<?phpclass User filter{ /** * @ORMColumn(‘string’, length=255) * @AssertNotBlank() * @AssertMaxLength(255) * @FilterAlpha() */ protected $name ...}

? http://ecdesignrebels.blogspot.comW h e r e tions

ann ota er e

class DataTest extends PHPUnit_Framework_TestCase{ /** * @dataProvider provider repetition * * @expectedException InvalidArgumentException * @expectedExceptionMessage Right Message */ public function testAdd($a, $b, $c) expectations { /* Test code */ } public function provider() { return array( array(0, 0, 0), ); }}

/** * @ORMTable("myentity") * @ORMEntity(repositoryClass="MyEntityRepository") */class MyEntity{ /** * @var integer $id * * @ORMColumn(name="id", type="integer") * @ORMId * @ORMGeneratedValue(strategy="AUTO") persistance */ protected $id; /** * @var string $title * * @ORMColumn(name="title", type="string", length=255) association * @AssertMaxLength(255) * @AssertNotBlank() */ protected $title; /** * @var DoctrineCommonCollectionsArrayCollection $users * * @ORMOneToMany(targetEntity="OtherEntity", mappedBy="myEntity", cascade={"persist","remove"}) */ protected $otherEntities;}

/** * @Route("/myaction/{id}", name="myaction") * @Method("POST") * * @Template("MyBundle:MyController:my.html.twig") * * @param int $id * @return array routing */public function myAction($id){ /* Controller Logic */ templating return array(data => $data);}class MyEntity{ /** * @var string $title * * @ORMColumn(name="title", type="string", length=255) * @AssertMaxLength(255) * @AssertNotBlank() */ protected $title;} Validation

/** Dependency

Injection * @FLOW3Aspect */class LoggingAspect { /** * @FLOW3Inject * @var ExamplesForumLoggerApplicationLoggerInterface AOP */ protected $applicationLogger; /** * Log a message if a post is deleted * * @param TYPO3FLOW3AOPJoinPointInterface $joinPoint * @FLOW3Before("method(ExamplesForumDomainModelForum->deletePost())") * @return void */ public function logDeletePost(TYPO3FLOW3AOPJoinPointInterface $joinPoint) { $post = $joinPoint->getMethodArgument(post); $this->applicationLogger->log(Removing post . $post->getTitle(), LOG_INFO); }}

http://ecdesignrebels.blogspot.comH o w ? e

w ns?How

can tio a nno ta

ProjectAnnotations

Annotation

Engine My

ProjectAnnotations

/** * @tag parameters */public function method() Code

/**ReflectionClass->getDocComment() * @tag parameters */ public function method() Code

/** ReflectionClass->getDocComment() * @tag parameters */ public function method() Code/** * @tag parameters */DOCBlock

/** ReflectionClass->getDocComment() * @tag parameters */ public function method() Code/** * @tag parameters */DOCBlock Tag() + parameters Annotation

Instances

Annotation EnginesDoctrine

CommonsZF2

AnnotationsphpDocumentor

2 abandoned?Notoj php-annotations addendum Stubble

Annotation Engines Notoj 2.3 2.0

alpha ?Parameterized marker parameterizedvery

mature maturing new

Annotation Engines Notoj 2.3 2.0

alpha ?Parameterized marker parameterizedvery

mature maturing new

Works <?php use DoctrineORMMapping as ORM; use SymfonyComponentValidator Constraints as Assert; /** * @ORMColumn(‘string’) * @AssertNotBlank() */

Works Declare

Annotations

use <?php use DoctrineORMMapping as ORM; use SymfonyComponentValidator Constraints as Assert; /** * @ORMColumn(‘string’) * @AssertNotBlank() */

Works Declare

Annotations

useAnnotationReader <?php use DoctrineORMMapping as ORM; use SymfonyComponentValidator Constraints as Assert; /** * @ORMColumn(‘string’) * @AssertNotBlank() */

Works Declare

Annotations

useAnnotationReader <?php use DoctrineORMMapping as ORM; use SymfonyComponentValidator Constraints as Assert; /** * @ORMColumn(‘string’) * @AssertNotBlank() “metadata” */new ORMColumn(‘string’)new AssertNotBlank()

Works Declare

Annotations

useAnnotationReader <?php use DoctrineORMMapping as ORM; use SymfonyComponentValidator Constraints as Assert; /** * @ORMColumn(‘string’) * @AssertNotBlank() “metadata” */new ORMColumn(‘string’)new AssertNotBlank() Walker

code Cache

DMSFilterhttps://github.com/rdohms/DMS

Gears YourApp DoctrineCommons

Gears Reader YourApp DoctrineCommons

Gears Parsing Reader YourApp DoctrineCommons

Gears Parsing Filter Reader YourApp DoctrineCommons

Gears “Enforcing” Parsing Filter Reader YourApp DoctrineCommons

Gears “Enforcing” Parsing Filter ReaderAnnotatedObject YourApp DoctrineCommons

Gears “Enforcing” Parsing Filter ReaderAnnotatedObject MyAnnotation YourApp DoctrineCommons

Gears “Enforcing” Parsing Filter ReaderAnnotatedObject ﬁlter() MyAnnotation YourApp DoctrineCommons

Gears “Enforcing” Parsing Filter ReaderAnnotatedObject ﬁlter() getMethodAnnotation() MyAnnotation YourApp DoctrineCommons

Gears “Enforcing” Parsing Filter ReaderAnnotatedObject ﬁlter() getMethodAnnotation() ﬁltered value MyAnnotation YourApp DoctrineCommons

Usage:

@FilterNoDogs()namespace FilterRule;/** * @Annotation */class NoDogs{ public function __construct($options) { /* no options */ } public function filter($value) { return str_replace("dogs", "", (string) $value); }}

Usage:

@FilterNoDogs()namespace FilterRule;/** * @Annotation tell

doctrine

*/class NoDogs is

annotation{ public function __construct($options) { /* no options */ } public function filter($value) { return str_replace("dogs", "", (string) $value); }}

Usage:

doctrine

*/class NoDogs is

annotation{ public function __construct($options) { /* no options */ } array

parameters public function filter($value) { return str_replace("dogs", "", (string) $value); }}

Usage:

doctrine

*/class NoDogs is

annotation{ public function __construct($options) { /* no options */ } array

parameters public function filter($value) { return str_replace("dogs", "", (string) $value); }} this

effect

annotation

namespace Filter;class Filter{ private $reader; public function __construct(DoctrineCommonAnnotationsReader $reader) { $this->reader = $reader; } public function filter($object) { $reflectionObject = new ReflectionObject($object); foreach ($reflectionObject->getProperties() as $reflectionProperty) { $this->filterProperty($object, $reflectionProperty); } } public function filterProperty($object, $reflectionProperty) { // fetch the @NoDog annotation from the annotation reader $annotation = $this->reader->getMethodAnnotation( $reflectionProperty, FilterRuleNoDog); if (null !== $annotation) { return; } $reflectionProperty->setAccessible(true); $value = $reflectionProperty->getValue($object); $filteredValue = $annotation->filter($value); $reflectionProperty->setValue( $filteredValue ); }}

namespace Filter;class Filter{ private $reader; public function __construct(DoctrineCommonAnnotationsReader $reader) { $this->reader = $reader; } public function filter($object) { $reflectionObject = new ReflectionObject($object); foreach ($reflectionObject->getProperties() as $reflectionProperty) { $this->filterProperty($object, $reflectionProperty); } } Get

annotation public function filterProperty($object, $reflectionProperty) { // fetch the @NoDog annotation from the annotation reader $annotation = $this->reader->getMethodAnnotation( $reflectionProperty, FilterRuleNoDog); if (null !== $annotation) { return; } $reflectionProperty->setAccessible(true); $value = $reflectionProperty->getValue($object); $filteredValue = $annotation->filter($value); $reflectionProperty->setValue( $filteredValue ); }}

namespace Filter;class Filter{ private $reader; public function __construct(DoctrineCommonAnnotationsReader $reader) { $this->reader = $reader; } public function filter($object) { $reflectionObject = new ReflectionObject($object); foreach ($reflectionObject->getProperties() as $reflectionProperty) { $this->filterProperty($object, $reflectionProperty); } } Get

annotation public function filterProperty($object, $reflectionProperty) { // fetch the @NoDog annotation from the annotation reader $annotation = $this->reader->getMethodAnnotation( $reflectionProperty, FilterRuleNoDog); if (null !== $annotation) { return; } $reflectionProperty->setAccessible(true); $value = $reflectionProperty->getValue($object); Make

Annotation

$filteredValue = $annotation->filter($value); $reflectionProperty->setValue( $filteredValue );} } affect

application

Taking

notch Filter Reader

Taking

notch Filter Reader Walker Loader

Taking

notch Filter Parsing Using/Walking Reader Walker Loading Loader

Taking

notch Filter Parsing Using/Walking Reader Walker Loading Loader Filters

Annotations

Taking

notch Filter Parsing Using/Walking Reader Walker Loading Loader navigates

object,

Filters

Annotations reflects

filters

Taking

notch Filter Parsing Using/Walking Reader Walker Loading Loader navigates

object,

Filters

filters

Taking

notch Filter Parsing Using/Walking Reader Walker Loading Loader annotations navigates

object,

Filters

filters

Taking

notch Filter Parsing Using/Walking Reader Walker Loading Loader annotations metadata navigates

object,

Filters

filters

/** * @MyAnnotation(“name”, nullable=true) */

defaultProperty/** * @MyAnnotation(“name”, nullable=true) */

defaultProperty/** * @MyAnnotation(“name”, nullable=true) */new MyAnnotation($options);

defaultProperty/** * @MyAnnotation(“name”, nullable=true) */ array:

value or string:

valuenew MyAnnotation($options);

value or string:

valuenew MyAnnotation($options); or

value or string:

valuenew MyAnnotation($options); or$a = new MyAnnotation();$a->nullable = true;$a->{$a->getDefaultProperty()} = “name”;

//Get Doctrine Reader$reader = new AnnotationsAnnotationReader();$reader->setEnableParsePhpImports(true);//Load AnnotationLoader$loader = new MappingLoaderAnnotationLoader($reader);$this->loader = $loader;//Get a MetadataFactory$metadataFactory = new MappingClassMetadataFactory($loader);//Get a Filter$filter = new DMSFilterFilter($metadataFactory);//Get your Entity$user = new AppEntityUser();$user->name = "My name";$user->email = " email@mail.com";//Filter you entity$filter->filter($user);echo $user->name; //"My name"echo $user->email; //"email@mail.com"

//Get Doctrine Reader$reader = new AnnotationsAnnotationReader();$reader->setEnableParsePhpImports(true); put

DIC//Load AnnotationLoader$loader = new MappingLoaderAnnotationLoader($reader);$this->loader = $loader;//Get a MetadataFactory$metadataFactory = new MappingClassMetadataFactory($loader);//Get a Filter$filter = new DMSFilterFilter($metadataFactory);//Get your Entity$user = new AppEntityUser();$user->name = "My name";$user->email = " email@mail.com";//Filter you entity$filter->filter($user);echo $user->name; //"My name"echo $user->email; //"email@mail.com"

//Get Doctrine Reader$reader = new AnnotationsAnnotationReader();$reader->setEnableParsePhpImports(true); put

DIC//Load AnnotationLoader$loader = new MappingLoaderAnnotationLoader($reader);$this->loader = $loader;//Get a MetadataFactory$metadataFactory = new MappingClassMetadataFactory($loader);//Get a Filter$filter = new DMSFilterFilter($metadataFactory);//Get your Entity$user = new AppEntityUser(); Calling

Enforcer$user->name = "My name";$user->email = " email@mail.com";//Filter you entity$filter->filter($user);echo $user->name; //"My name"echo $user->email; //"email@mail.com"

What? Why? Where? How?

Questions? please! Rate

Joind.in! https://joind.in/6696on

twitter @rdohms these

slides

here http://doh.ms http://slides.doh.ms

Annotating with Annotations - PHPBenelux June/2012

by Rafael Dohms on Jun 20, 2012

Accessibility

Categories

Upload Details

Usage Rights

Statistics

Annotating with Annotations - PHPBenelux June/2012 Presentation Transcript