Download as PDF, PPTX
Uploaded byRafael Dohms
Annotating with Annotations - PHPBenelux June/2012
The document discusses the concept of annotations in PHP, highlighting their historical development, uses, and effects on application behavior. It explains how annotations serve as metadata to describe elements of code without affecting program semantics, and provides examples of syntax used in PHP. Additionally, it references the PHPReflection feature that supports the retrieval of annotations and metadata through reflection.
More Related Content
Similar to Annotating with Annotations - PHPBenelux June/2012
![UiPath Automation Suite Installation (Hands-On) [2/3]](https://cdn.slidesharecdn.com/ss_thumbnails/automationsuitecommunitysession2-251015095633-a6d862f1-thumbnail.jpg?width=600ounds&width=560&fit=bounds)
Annotating with Annotations - PHPBenelux June/2012
- 1.
- 2.
- 3.
- 4.
- 5.
- 6.
- 7.
- 8.
- 9.
- 10.
- 11.
- 12. PHP on
- 13. twitter Rafael
- 14. Dohms @rdohms
- 15.
- 16.
- 17.
- 18.
- 19.
- 20.
- 21.
- 22.
- 23.
- 24.
- 25.
- 26. PHP on
- 27. twitter Rafael
- 28. Dohms @rdohms
- 29. Rafael Dohms photo credit: Eli White @rdohms Evangelist, Speaker and Contributor. Developer at WEBclusive. Enabler at AmsterdamPHP.
- 30.
- 31.
- 32. history existing
- 33. uses What? Why? Where? How? ustom
- 34. ann otations Impl ementing
- 35. c DMSFilter based
- 36.
- 37.
- 38.
- 39.
- 40.
- 41. http://ecdesignrebels.blogspot.com w h a t? ta tio ns? re
- 42.
- 43.
- 44. -- In English-- An annotation is a note that is made while reading any form of text.
- 45.
- 46.
- 47.
- 48.
- 49.
- 50.
- 51.
- 52. subject -- In English -- An annotation is a note that is made while reading any form of text.
- 53. -- In CodeSpeak -- “An annotation describes behavior of code and affects your application in runtime.” “Annotations do not directly affect program semantics”
- 54. -- In CodeSpeak -- “An annotation describes behavior of code and affects your application in runtime.” “Annotations do not directly affect program semantics” just
- 55.
- 56.
- 57.
- 59.
- 60.
- 61.
- 62.
- 63.
- 64.
- 65.
- 66.
- 67.
- 68.
- 69.
- 70.
- 71.
- 72. Annotations” available
- 73.
- 74.
- 75.
- 76.
- 77.
- 78.
- 79.
- 80.
- 81.
- 82.
- 83. Annotations” @Entity @Table(name = people) class Person implements Serializable { @Id @GeneratedValue(strategy = GenerationType.AUTO) private Integer id; @Column(length = 32) private String name; available
- 84.
- 85.
- 86.
- 87.
- 88.
- 89.
- 90.
- 91.
- 92.
- 93.
- 94. Annotations” specific
- 95. syntax @Entity @Table(name = people) class Person implements Serializable { @Id @GeneratedValue(strategy = GenerationType.AUTO) private Integer id; @Column(length = 32) private String name; available
- 96.
- 97.
- 98.
- 99.
- 101.
- 102.
- 103.
- 104.
- 105.
- 106.
- 107.
- 110.
- 111.
- 112.
- 113.
- 114.
- 115.
- 116. 5.1 Reflection
- 117.
- 118.
- 119.
- 120.
- 121.
- 122.
- 123.
- 124. 5.1 Reflection
- 125.
- 126.
- 127.
- 128.
- 129.
- 130.
- 131.
- 132. 5.1 Reflection
- 133.
- 134.
- 135.
- 136.
- 137.
- 138.
- 139.
- 140.
- 141.
- 142.
- 143. 5.1 Reflection
- 144.
- 145.
- 146.
- 147.
- 148.
- 149.
- 150.
- 151. phpDoc syntax ~2000 2005 2008 2010 First
- 152.
- 153.
- 154.
- 155.
- 156.
- 157.
- 158.
- 159.
- 160. 5.1 Reflection
- 161.
- 162.
- 163.
- 164.
- 165.
- 166.
- 167.
- 168. c w phpDoc E Rsyntax ~2000 2005 2008 2010 First
- 169.
- 170.
- 171.
- 172.
- 173.
- 174.
- 175.
- 176.
- 177. 5.1 RFC:
- 178.
- 179.
- 180.
- 181.
- 182. discussion” RFC:
- 183.
- 184.
- 185.
- 186.
- 187.
- 188. c w phpDoc E Rsyntax ~2000 2005 2008 2010 2011 First
- 189.
- 190.
- 191.
- 192.
- 193.
- 194.
- 195.
- 196.
- 197. 5.1 RFC:
- 198.
- 199.
- 200.
- 201.
- 202. discussion” RFC:
- 203.
- 204.
- 205.
- 206.
- 207.
- 208. c w phpDoc E Rsyntax ~2000 2005 2008 2010 2011 ? First
- 209.
- 210.
- 211.
- 212.
- 213.
- 214.
- 215.
- 216.
- 217. 5.1 RFC:
- 218.
- 219.
- 220.
- 221.
- 222. discussion” * RFC:
- 223.
- 224.
- 225.
- 226.
- 227.
- 228. 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
- 229.
- 230.
- 231.
- 232.
- 233.
- 234.
- 235.
- 236.
- 237.
- 238.
- 239.
- 240.
- 241. comment T_COMMENT /*
- 242.
- 243.
- 244.
- 245.
- 246.
- 247.
- 248.
- 249.
- 250.
- 251.
- 252. comment T_COMMENT /*
- 253.
- 254.
- 255.
- 256.
- 257.
- 258.
- 259.
- 260.
- 261.
- 262.
- 263.
- 264.
- 265. block T_DOC_COMMENT
- 266.
- 267. /** * @deprecated * * @ORMColumn(‘string’, length=255) */ public function method()
- 268. marker /** * @deprecated * * @ORMColumn(‘string’, length=255) */ public function method()
- 269. marker parameterized /** * @deprecated * * @ORMColumn(‘string’, length=255) */ public function method()
- 270.
- 271. an no tations? uld
- 272.
- 273. use /co ns? hy
- 274. sho e
- 275. p ros W t
- 276.
- 277. th w ha
- 278.
- 279.
- 280.
- 281.
- 282.
- 283.
- 284.
- 285.
- 286.
- 287.
- 288. code) - Performance
- 289.
- 290.
- 291.
- 292.
- 293.
- 294.
- 295.
- 296. code) - Performance
- 297.
- 298.
- 299. code) Its
- 300.
- 301.
- 302.
- 303.
- 304.
- 305.
- 306.
- 307.
- 308.
- 309.
- 310.
- 311.
- 312.
- 313.
- 314.
- 315.
- 316. extending Doctrine
- 317.
- 318.
- 319.
- 320.
- 321.
- 322.
- 323.
- 324.
- 325.
- 326. extending Doctrine
- 327.
- 328.
- 329.
- 330. 2 Contextualizes
- 331.
- 332.
- 333.
- 334.
- 335.
- 336.
- 337.
- 338.
- 339.
- 340. extending Doctrine
- 341.
- 342.
- 343.
- 344. 2 Contextualizes
- 345.
- 346.
- 347.
- 348. object + In
- 349.
- 350.
- 351.
- 352.
- 353.
- 354.
- 355.
- 356.
- 357.
- 358.
- 359. extending Doctrine
- 360.
- 361.
- 362.
- 363. 2 Contextualizes
- 364.
- 365.
- 366.
- 367. object + In
- 368.
- 369.
- 370.
- 371.
- 372. file Its
- 373.
- 374.
- 375.
- 376.
- 377.
- 378.
- 379.
- 380.
- 381. extending Doctrine
- 382.
- 383.
- 384.
- 385. 2 Contextualizes
- 386.
- 387.
- 388.
- 389. object + In
- 390.
- 391.
- 392.
- 393.
- 394. file Its
- 395.
- 396.
- 397. phpDocumentor Its
- 398.
- 399.
- 400.
- 401.
- 402.
- 405. ?php class User { protected $name ... }
- 406. ?php -
- 407.
- 408.
- 409. varchar length
- 410.
- 411.
- 412.
- 413.
- 414.
- 415.
- 416. 255 -
- 417.
- 418.
- 419.
- 420. blank -
- 421.
- 422. letters protected $name ... }
- 423. persistence DoctrineTestsORMMappingUser: type: entity table: cms_users ?php id: id: -
- 424.
- 425.
- 426. varchar type: integer length
- 427.
- 428.
- 429.
- 430. class User generator: { -
- 431.
- 432.
- 433. 255 fields: name: -
- 434.
- 435.
- 436.
- 437. blank type: string -
- 438.
- 439. letters length: 255 protected $name Validation AcmeBlogBundleEntityAuthor: properties: name: ... - NotBlank: ~ - MaxLength: 255 filter AcmeBlogBundleEntityAuthor: } filters: name: - alpha
- 440. persistence Validation ?php class User filter { /** * @ORMColumn(‘string’, length=255) * @AssertNotBlank() * @AssertMaxLength(255) * @FilterAlpha() */ protected $name ... }
- 441. ? http://ecdesignrebels.blogspot.com W h e r e tions
- 442.
- 443. ann ota er e
- 444.
- 446. class DataTest extendsPHPUnit_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), ); } }
- 447. /** *@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; }
- 448. /** *@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
- 449. /** Dependency
- 450. 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); } }
- 451.
- 452.
- 453.
- 454.
- 455.
- 456.
- 457. can tio a nno ta
- 458.
- 459.
- 460.
- 461.
- 462.
- 464. /** * @tagparameters */ public function method() Code
- 465. /** ReflectionClass-getDocComment() * @tag parameters */ public function method() Code
- 466. /** ReflectionClass-getDocComment() * @tag parameters */ public function method() Code /** * @tag parameters */ DOCBlock
- 467. /** ReflectionClass-getDocComment() * @tag parameters */ public function method() Code /** * @tag parameters */ DOCBlock
- 468. /** ReflectionClass-getDocComment() * @tag parameters */ public function method() Code /** * @tag parameters */ DOCBlock Tag() + parameters Annotation
- 469.
- 470.
- 471.
- 472.
- 473. 2 abandoned? Notoj php-annotations addendum Stubble
- 474. Annotation Engines Notoj 2.3 2.0
- 475.
- 476. alpha ? Parameterized marker parameterized very
- 477. mature maturing new
- 478. Annotation Engines Notoj 2.3 2.0
- 479.
- 480. alpha ? Parameterized marker parameterized very
- 481. mature maturing new
- 482.
- 483.
- 484. Works ?php use DoctrineORMMapping as ORM; use SymfonyComponentValidator Constraints as Assert; /** * @ORMColumn(‘string’) * @AssertNotBlank() */
- 485.
- 486.
- 487. Works Declare
- 488.
- 489.
- 490.
- 491.
- 492. use ?php use DoctrineORMMapping as ORM; use SymfonyComponentValidator Constraints as Assert; /** * @ORMColumn(‘string’) * @AssertNotBlank() */
- 493.
- 494.
- 495. Works Declare
- 496.
- 497.
- 498.
- 499.
- 500. use AnnotationReader ?php use DoctrineORMMapping as ORM; use SymfonyComponentValidator Constraints as Assert; /** * @ORMColumn(‘string’) * @AssertNotBlank() */
- 501.
- 502.
- 503. Works Declare
- 504.
- 505.
- 506.
- 507.
- 508. use AnnotationReader ?php use DoctrineORMMapping as ORM; use SymfonyComponentValidator Constraints as Assert; /** * @ORMColumn(‘string’) * @AssertNotBlank() “metadata” */ new ORMColumn(‘string’) new AssertNotBlank()
- 509.
- 510.
- 511. Works Declare
- 512.
- 513.
- 514.
- 515.
- 516. use AnnotationReader ?php use DoctrineORMMapping as ORM; use SymfonyComponentValidator Constraints as Assert; /** * @ORMColumn(‘string’) * @AssertNotBlank() “metadata” */ new ORMColumn(‘string’) new AssertNotBlank() Walker
- 517.
- 518. code Cache
- 519.
- 520.
- 521.
- 522.
- 523. Gears YourApp DoctrineCommons
- 524.
- 525. Gears Reader YourApp DoctrineCommons
- 526.
- 527. Gears Parsing Reader YourApp DoctrineCommons
- 528.
- 529. Gears Parsing Filter Reader YourApp DoctrineCommons
- 530.
- 531. Gears “Enforcing” Parsing Filter Reader YourApp DoctrineCommons
- 532.
- 533. Gears “Enforcing” Parsing Filter Reader AnnotatedObject YourApp DoctrineCommons
- 534.
- 535. Gears “Enforcing” Parsing Filter Reader AnnotatedObject MyAnnotation YourApp DoctrineCommons
- 536.
- 537. Gears “Enforcing” Parsing Filter Reader AnnotatedObject filter() MyAnnotation YourApp DoctrineCommons
- 538.
- 539. Gears “Enforcing” Parsing Filter Reader AnnotatedObject filter() getMethodAnnotation() MyAnnotation YourApp DoctrineCommons
- 540.
- 541. Gears “Enforcing” Parsing Filter Reader AnnotatedObject filter() getMethodAnnotation() MyAnnotation YourApp DoctrineCommons
- 542.
- 543. Gears “Enforcing” Parsing Filter Reader AnnotatedObject filter() getMethodAnnotation() filtered value MyAnnotation YourApp DoctrineCommons
- 544.
- 545. @FilterNoDogs() namespace FilterRule; /** * @Annotation */ class NoDogs { public function __construct($options) { /* no options */ } public function filter($value) { return str_replace(dogs, , (string) $value); } }
- 546.
- 547. @FilterNoDogs() namespace FilterRule; /** * @Annotation tell
- 548.
- 549.
- 550. */ classNoDogs is
- 551.
- 552. annotation { public function __construct($options) { /* no options */ } public function filter($value) { return str_replace(dogs, , (string) $value); } }
- 553.
- 554. @FilterNoDogs() namespace FilterRule; /** * @Annotation tell
- 555.
- 556.
- 557. */ classNoDogs is
- 558.
- 559. annotation { public function __construct($options) { /* no options */ } array
- 560.
- 561.
- 562. parameters public function filter($value) { return str_replace(dogs, , (string) $value); } }
- 563.
- 564. @FilterNoDogs() namespace FilterRule; /** * @Annotation tell
- 565.
- 566.
- 567. */ classNoDogs is
- 568.
- 569. annotation { public function __construct($options) { /* no options */ } array
- 570.
- 571.
- 572. parameters public function filter($value) { return str_replace(dogs, , (string) $value); } } this
- 573.
- 574.
- 575.
- 576.
- 577.
- 578.
- 579. 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 ); } }
- 580. 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
- 581.
- 582.
- 583. 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 ); } }
- 584. 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
- 585.
- 586.
- 587. 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
- 588.
- 589.
- 590.
- 591.
- 592.
- 593.
- 594.
- 595.
- 596.
- 597.
- 598.
- 599.
- 600. notch Filter Reader
- 601.
- 602.
- 603.
- 604.
- 605. notch Filter Reader Walker Loader
- 606.
- 607.
- 608.
- 609.
- 610. notch Filter Parsing Using/Walking Reader Walker Loading Loader
- 611.
- 612.
- 613.
- 614.
- 615. notch Filter Parsing Using/Walking Reader Walker Loading Loader Filters
- 616.
- 617.
- 618.
- 619.
- 620.
- 621. notch Filter Parsing Using/Walking Reader Walker Loading Loader navigates
- 622.
- 623.
- 624. Annotations reflects
- 625.
- 626.
- 627.
- 628.
- 629.
- 630.
- 631. notch Filter Parsing Using/Walking Reader Walker Loading Loader navigates
- 632.
- 633.
- 634. Annotations reflects
- 635.
- 636.
- 637.
- 638.
- 639.
- 640.
- 641. notch Filter Parsing Using/Walking Reader Walker Loading Loader annotations navigates
- 642.
- 643.
- 644. Annotations reflects
- 645.
- 646.
- 647.
- 648.
- 649.
- 650.
- 651. notch Filter Parsing Using/Walking Reader Walker Loading Loader annotations metadata navigates
- 652.
- 653.
- 654. Annotations reflects
- 655.
- 656.
- 657. /** * @MyAnnotation(“name”,nullable=true) */
- 658. defaultProperty /** * @MyAnnotation(“name”,nullable=true) */
- 659. defaultProperty /** * @MyAnnotation(“name”,nullable=true) */ new MyAnnotation($options);
- 660. defaultProperty /** * @MyAnnotation(“name”,nullable=true) */ array:
- 661.
- 662.
- 663. value or string:
- 664.
- 665. defaultProperty /** * @MyAnnotation(“name”,nullable=true) */ array:
- 666.
- 667.
- 668. value or string:
- 669.
- 670. defaultProperty /** * @MyAnnotation(“name”,nullable=true) */ array:
- 671.
- 672.
- 673. value or string:
- 674. value new MyAnnotation($options); or $a = new MyAnnotation(); $a-nullable = true; $a-{$a-getDefaultProperty()} = “name”;
- 675. //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 bname/b; $user-email = email@mail.com; //Filter you entity $filter-filter($user); echo $user-name; //My name echo $user-email; //email@mail.com
- 676. //Get Doctrine Reader $reader= new AnnotationsAnnotationReader(); $reader-setEnableParsePhpImports(true); put
- 677.
- 678.
- 679.
- 680. 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 bname/b; $user-email = email@mail.com; //Filter you entity $filter-filter($user); echo $user-name; //My name echo $user-email; //email@mail.com
- 681. //Get Doctrine Reader $reader= new AnnotationsAnnotationReader(); $reader-setEnableParsePhpImports(true); put
- 682.
- 683.
- 684.
- 685. 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
- 686.
- 687. Enforcer $user-name = Mybname/b; $user-email = email@mail.com; //Filter you entity $filter-filter($user); echo $user-name; //My name echo $user-email; //email@mail.com
- 688. What? Why? Where? How?
- 689. Questions? please! Rate
- 690.
- 691.
- 692.
- 693. Joind.in! https://joind.in/6696 on
- 694. twitter @rdohms these
- 695.
- 696.
- 697.
- 698. here http://doh.ms http://slides.doh.ms