PHP Annotations: They exist! - JetBrains Webinar

1. Rafael

2. Dohms Annotations

4. PHP @rdohms on

5. twitter They

6. Exist!

7. photocredit:EliWhite Evangelist, Speaker and Contributor. ! Enabler at AmsterdamPHP. Rafael Dohms @rdohms drop

10. you

11. are

12. in

13. Amsterdam!

14. What? Why? Where? How? a

15. little

16. history show

17. me

18. the

19. code! existing

20. uses Implementing

21. custom

22. annotations based

23. on

24. DMSFilter

25. what? What

26. are

27. annotations? http://ecdesignrebels.blogspot.com

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

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

30. that

31. describes

32. an

33. aspect

34. of

35. the

36. subject

37. “Annotations do not directly affect program semantics” -- In Code Speak -- “An annotation is metadata attached to your code, that can be read at runtime.”

38. “Annotations do not directly affect program semantics” -- In Code Speak -- “An annotation is metadata attached to your code, that can be read at runtime.” effects

39. are

40. only

41. observed

42. at

43. “Annotations do not directly affect program semantics” -- In Code Speak -- just

44. like

45. your

46. notes “An annotation is metadata attached to your code, that can be read at runtime.” effects

47. are

48. only

49. observed

50. at

51. Annotations in the wild C#

52. Annotations in the wild annotations C#attributes

53. Annotations in the wild annotations C#attributes @Entity! @Table(name = people)! class Person implements Serializable {! @Id ! @GeneratedValue(strategy = GenerationType.AUTO) ! private Integer id;

54. Annotations in the wild annotations C#attributes @Entity! @Table(name = people)! class Person implements Serializable {! @Id ! @GeneratedValue(strategy = GenerationType.AUTO) ! private Integer id; public class Customer! {! [Required]! [StringLength(50)]! public string Prename { get; set; }! ! [Column(TypeName = image)]! public byte[] Image { get; set; }

55. Annotations in the wild annotations C#attributes after

56. v1.5 @Entity! @Table(name = people)! class Person implements Serializable {! @Id ! @GeneratedValue(strategy = GenerationType.AUTO) ! private Integer id; public class Customer! {! [Required]! [StringLength(50)]! public string Prename { get; set; }! ! [Column(TypeName = image)]! public byte[] Image { get; set; }

57. Annotations in the wild annotations C#attributes after

58. v1.5 since

59. first

60. release @Entity! @Table(name = people)! class Person implements Serializable {! @Id ! @GeneratedValue(strategy = GenerationType.AUTO) ! private Integer id; public class Customer! {! [Required]! [StringLength(50)]! public string Prename { get; set; }! ! [Column(TypeName = image)]! public byte[] Image { get; set; }

62. No

63. core

65. annotation

66. support

67. Questions?

68. Questions? I’m

69. kidding!

72. phpDoc ~2000

73. phpDoc PHP

74. 5.1  Reflection

75. supports

76.   getDocComments() ~2000 2005

77. First

78. Annotation

80. Engines

81. in

82. PHP phpDoc PHP

84. supports

85.   getDocComments() ~2000 2005

86. First

87. Annotation

89. Engines

90. in

91. PHP phpDoc PHP

93. supports

94.   getDocComments() ~2000 2005 2008

95. First

96. Annotation

98. Engines

99. in

100. PHP phpDoc PHP

102. supports

103.   getDocComments() ~2000 2005 2008 Doctrine

104. 2

105.   Annotation

106. Engine

107. First

108. Annotation

110. Engines

111. in

112. PHP phpDoc PHP

114. supports

116. 2

117.   Annotation

118. Engine 2010 RFC:

119. Annotations

120. in

121. core

122. w/

123. custom

124. syntax

125. First

126. Annotation

128. Engines

129. in

130. PHP phpDoc PHP

132. supports

134. 2

135.   Annotation

137. Annotations

138. in

139. core

140. w/

141. custom

142. syntaxREJECTED

143. First

144. Annotation

146. Engines

147. in

148. PHP phpDoc PHP

150. supports

152. 2

153.   Annotation

155. Annotations

156. in

157. core

158. w/

159. custom

160. syntax 2011 RFC:

161. DocBlock

162. Annotations

163. “in

164. discussion” REJECTED

165. First

166. Annotation

168. Engines

169. in

170. PHP phpDoc PHP

172. supports

174. 2

175.   Annotation

177. Annotations

178. in

179. core

180. w/

181. custom

183. DocBlock

184. Annotations

185. “in

186. discussion” REJECTED 2013 discussion

187. sparks

188. up

189. again

190. First

191. Annotation

193. Engines

194. in

195. PHP phpDoc PHP

197. supports

199. 2

200.   Annotation

202. Annotations

203. in

204. core

205. w/

206. custom

208. DocBlock

209. Annotations

210. “in

211. discussion” REJECTED ?2013 discussion

212. sparks

213. up

214. again

215. Current situation in php-internals

216. Current situation in php-internals

218. annotations

219. annotations /** ! * EntityReward ! * ! * @ORMTable(reward) ! * @ORMEntity(repositoryClass=RewardRepository) ! */ ! class Reward ! { ! /** ! * @var integer $id ! * ! * @ORMColumn(name=id, type=integer) ! * @ORMId ! * @ORMGeneratedValue(strategy=AUTO) ! */ ! protected $id; ! ! /** ! * @var string $title ! * ! * @ORMColumn(name=title, type=string, length=150, nullable=true) ! * ! * @AssertMaxLength(150) ! */ ! protected $title;

220. annotations /** ! * EntityReward ! * ! * @ORMTable(reward) ! * @ORMEntity(repositoryClass=RewardRepository) ! */ ! class Reward ! { ! /** ! * @var integer $id ! * ! * @ORMColumn(name=id, type=integer) ! * @ORMId ! * @ORMGeneratedValue(strategy=AUTO) ! */ ! protected $id; ! ! /** ! * @var string $title ! * ! * @ORMColumn(name=title, type=string, length=150, nullable=true) ! * ! * @AssertMaxLength(150) ! */ ! protected $title; re-use

221. of

222. docblocks

223. On docblocks vs. comments

224. On docblocks vs. comments T_COMMENT // this is a comment  /* This is a multiline comment */

225. On docblocks vs. comments T_COMMENT T_DOC_COMMENT // this is a comment  /* This is a multiline comment */ /** ! * this is a docblock! */

226. On docblocks vs. comments T_COMMENT T_DOC_COMMENT // this is a comment  /* This is a multiline comment */ /** ! * this is a docblock! */ ignored

227. by

228. opcode

229. cache

230. On docblocks vs. comments T_COMMENT T_DOC_COMMENT // this is a comment  /* This is a multiline comment */ /** ! * this is a docblock! */ ignored

231. by

232. opcode

233. cache cached

234. by

235. opcode

236. cache

238. public class Customer! {! [Required]! [StringLength(50)]! public string Prename { get; set; }! ! [Column(TypeName = image)]! public byte[] Image { get; set; } @Entity! @Table(name = people)! class Person implements Serializable {! @Id ! @GeneratedValue(strategy = GenerationType.AUTO) ! private Integer id; class Reward ! { ! /** ! * @var integer $id ! * @deprecated! * @ORMColumn(name=id, type=integer) ! * @ORMId ! */ ! protected $id;

239. public class Customer! {! [Required]! [StringLength(50)]! public string Prename { get; set; }! ! [Column(TypeName = image)]! public byte[] Image { get; set; } @Entity! @Table(name = people)! class Person implements Serializable {! @Id ! @GeneratedValue(strategy = GenerationType.AUTO) ! private Integer id; class Reward ! { ! /** ! * @var integer $id ! * @deprecated! * @ORMColumn(name=id, type=integer) ! * @ORMId ! */ ! protected $id; marker

240. public class Customer! {! [Required]! [StringLength(50)]! public string Prename { get; set; }! ! [Column(TypeName = image)]! public byte[] Image { get; set; } @Entity! @Table(name = people)! class Person implements Serializable {! @Id ! @GeneratedValue(strategy = GenerationType.AUTO) ! private Integer id; class Reward ! { ! /** ! * @var integer $id ! * @deprecated! * @ORMColumn(name=id, type=integer) ! * @ORMId ! */ ! protected $id; marker parameterized

241. Why? Why

242. should

243. I

244. use

245. annotations? http://ecdesignrebels.blogspot.com Are

246. annotations

247. for

248. you?

249. I don’t know.

251. hate

252. annotations

253. hate

254. annotations love

255. annotations

256. hate

257. annotations love

258. annotations never

259. used

260. annotations

261. but

262. its

263. code,

264. in

265. comments! docblocks harder The downside or why not

266. but

267. its

268. code,

269. in

270. comments! docblocks harder The downside or why not docblocks

271. are

272. first

273. class

274. citizens.

275. Its

276. impossible

277. to

278. debug/test! harder The downside or why not

279. Its

280. impossible

281. to

282. debug/test! harder The downside or why not Test/debug

283. annotation

284. “executor”

285. The downside or why not It

286. does

287. not

288. perform!

289. The downside or why not It

290. does

291. not

292. perform! Caching

293. FTW!

294. Why I love Annotations

295. Easier

296. to

297. inject

298. behavior

299. without

300. extending Why I love Annotations

301. Easier

302. to

303. inject

304. behavior

305. without

306. extending Doctrine

307. 1

308. vs

309. Doctrine

310. 2 Why I love Annotations

311. Easier

312. to

313. inject

314. behavior

315. without

316. extending Contextualizes

317. behavior/config

318. in

319. the

320. object Doctrine

321. 1

322. vs

323. Doctrine

324. 2 Why I love Annotations

325. Easier

326. to

327. inject

328. behavior

329. without

332. in

333. the

335. 1

336. vs

337. Doctrine

338. 2 In

339. object

340. vs.

341. external

342. configuration

343. file Why I love Annotations

344. Easier

345. to

346. inject

347. behavior

348. without

351. in

352. the

354. 1

355. vs

356. Doctrine

357. 2 In

358. object

359. vs.

360. external

361. configuration

362. file Its

363. documented/stored

364. by

365. phpDocumentor Why I love Annotations

366. Easier

367. to

368. inject

369. behavior

370. without

373. in

374. the

376. 1

377. vs

378. Doctrine

379. 2 In

380. object

381. vs.

382. external

383. configuration

384. file Its

385. documented/stored

386. by

387. phpDocumentor Its

388. in

389. docblocks,

390. so

391. its

392. parsed Why I love Annotations

395. ?php class User! {! ! ! ! ! ! ! ! protected $name! ! ! ...! ! ! ! ! ! ! }

396. ?php class User! {! ! ! ! ! ! ! ! protected $name! ! ! ...! ! ! ! ! ! ! } -

397. persist

398. as

399. varchar

400. -

401. length

402. should

403. not

404. be

406. more

407. then

408. 255

409. -

410. should

411. not

412. be

413. blank

414. -

415. only

416. letters

417. ?php class User! {! ! ! ! ! ! ! ! protected $name! ! ! ...! ! ! ! ! ! ! } -

418. persist

419. as

420. varchar

421. -

422. length

423. should

424. not

425. be

427. more

428. then

429. 255

430. -

431. should

432. not

433. be

434. blank

435. -

436. only

437. letters MyProjectUser:! properties:! name:! - NotBlank: ~! - MaxLength: 255 Validation MyProjectUser:! filters:! name:! - alpha filter MyProjectUser:! type: entity! table: users! fields:! name:! type: string! length: 255 persistence

438. ?php class User! {! ! ! ! ! ! ! ! protected $name! ! ! ...! ! ! ! ! ! ! } MyProjectUser:! properties:! name:! - NotBlank: ~! - MaxLength: 255 Validation MyProjectUser:! filters:! name:! - alpha filter MyProjectUser:! type: entity! table: users! fields:! name:! type: string! length: 255 persistence /**! * @ORMColumn(‘string’, length=255)! * @AssertNotBlank()! * @AssertMaxLength(255)! * @FilterAlpha()! */

439. ?php class User! {! ! ! ! ! ! ! ! protected $name! ! ! ...! ! ! ! ! ! ! } /**! * @ORMColumn(‘string’, length=255)! * @AssertNotBlank()! * @AssertMaxLength(255)! * @FilterAlpha()! */

440. Where? Where

441. are

442. annotations

443. used? http://ecdesignrebels.blogspot.com

444. Where? Where

445. are

446. annotations

447. used? http://ecdesignrebels.blogspot.com

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

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

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

451. /** ! * @FLOW3Aspect ! */ ! class LoggingAspect { ! ! /** ! * @FLOW3Inject ! * @var ExamplesForumLoggerApplicationLoggerInterface ! */ ! 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); ! } ! ! }! Dependency

452. Injection AOP

453. How? How

454. can

455. i

456. write

457. my

458. own

459. annotations? http://ecdesignrebels.blogspot.com

460. Annotations My

461. Project

462. Annotations My

463. Project Annotation

465. Engine

467. /**! * @tag(parameters)! */! public function method() Code

468. /**! * @tag(parameters)! */! public function method() Code ReflectionClass-getDocComment()

469. DOCBlock /**! * @tag(parameters)! */ /**! * @tag(parameters)! */! public function method() Code ReflectionClass-getDocComment()

470. DOCBlock /**! * @tag(parameters)! */ Tag() + parameters Annotation

471. Instances /**! * @tag(parameters)! */! public function method() Code ReflectionClass-getDocComment()

472. Doctrine

473. Annotations phpDocumentor

474. 2 Notoj Annotation Engines php-annotations https://github.com/doctrine/annotations https://github.com/phpDocumentor/phpDocumentor2 https://github.com/mindplay-dk/php-annotations https://github.com/crodas/Notoj

475. Doctrine

477. 2 Notoj Annotation Engines php-annotations

478. Doctrine

480. 2 Notoj Annotation Engines php-annotations 1.1.2 2.0.2 1.1 0.16.1

481. Doctrine

483. 2 Notoj Annotation Engines php-annotations 1.1.2 2.0.2 1.1 0.16.1

484. Doctrine

486. 2 Notoj Annotation Engines php-annotations 1.1.2 2.0.2 1.1 0.16.1 doctrine/annotations phpdocumentor/reﬂection-docblock mindplay/annotations crodas/notoj

487. Doctrine

489. 2 Notoj Annotation Engines php-annotations 1.1.2 2.0.2 1.1 0.16.1 doctrine/annotations phpdocumentor/reﬂection-docblock mindplay/annotations crodas/notoj

490. Doctrine

492. 2 Notoj Annotation Engines php-annotations 1.1.2 2.0.2 1.1 0.16.1 full

493. support only

494. string

495. full

496. support full

497. support doctrine/annotations phpdocumentor/reﬂection-docblock mindplay/annotations crodas/notoj

498. Doctrine

501. support only

502. string

503. full

504. support full

506. Doctrine

509. support only

510. string

511. full

512. support full

514. How

515. it

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

517. How

518. it

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

520. which

521. Annotations

522. you

523. will

524. use

525. How

526. it

527. Works AnnotationReader ?php /**! * @ORMColumn(‘string’)! * @AssertNotBlank()! */ use DoctrineORMMapping as ORM;! use SymfonyComponentValidator! Constraints as Assert; Declare

528. which

529. Annotations

530. you

531. will

532. use

533. How

534. it

535. Works AnnotationReader ?php /**! * @ORMColumn(‘string’)! * @AssertNotBlank()! */ new ORMColumn(‘string’)! new AssertNotBlank() “metadata” use DoctrineORMMapping as ORM;! use SymfonyComponentValidator! Constraints as Assert; Declare

536. which

537. Annotations

538. you

539. will

540. use

541. How

542. it

543. Works AnnotationReader ?php /**! * @ORMColumn(‘string’)! * @AssertNotBlank()! */ new ORMColumn(‘string’)! new AssertNotBlank() Cache “metadata” Walker

544. /

545. code use DoctrineORMMapping as ORM;! use SymfonyComponentValidator! Constraints as Assert; Declare

546. which

547. Annotations

548. you

549. will

550. use

551. Input Filtering DMSFilter: https://github.com/rdohms/DMS

552. Input Filtering DMSFilter: https://github.com/rdohms/DMS With

553. Annotation

554. Support!

555. Ingredients: -

556. Filter

557. Rules  -

558. Filter

559. Executioners

560. -

561. Filter

562. Service

563. -

564. Annotation

565. Engine

566. -

567. Annotated

568. Objects the

569. annotation

570. /

571. metadata,

572. configuration applies

573. the

574. rules the

575. middle-man gets

576. the

577. rules

578. out

579. of

580. the

581. docblocks defines

582. the

583. rules

584. Filter

585. Service Filter

586. EnforcerFiltered

587. values annotated

588. object @FilterStripTags(‘bi’) $executioner = new FilterStripTags();! $executioner-filter($metadata, $value); pHello

589. bWorld/b/p Hello

590. bWorld/b “Configured”

591. Rules new RulesStripTags(‘bi’); Annotation

592. Engine

593. The “rule”

594. ?php ! ! namespace DMSFilterRules; ! ! /** ! * StripTags Rule ! * ! * @Annotation ! */ ! class StripTags extends Rule ! { ! /** ! * String of allowed tags. Ex: bia ! * ! * @var string ! */ ! public $allowed = null; ! ! /** ! * {@inheritDoc} ! */ ! public function getDefaultOption() ! { ! return 'allowed'; ! } ! } Usage:

596. use DMSFilterRules as Filter;! ! @FilterStripTags(‘bi’)

597. ?php ! ! namespace DMSFilterRules; ! ! /** ! * StripTags Rule ! * ! * @Annotation ! */ ! class StripTags extends Rule ! { ! /** ! * String of allowed tags. Ex: bia ! * ! * @var string ! */ ! public $allowed = null; ! ! /** ! * {@inheritDoc} ! */ ! public function getDefaultOption() ! { ! return 'allowed'; ! } ! } tell

598. doctrine

599. this

601. is

602. an

603. annotation Usage:

605. use DMSFilterRules as Filter;! ! @FilterStripTags(‘bi’)

606. ?php ! ! namespace DMSFilterRules; ! ! /** ! * StripTags Rule ! * ! * @Annotation ! */ ! class StripTags extends Rule ! { ! /** ! * String of allowed tags. Ex: bia ! * ! * @var string ! */ ! public $allowed = null; ! ! /** ! * {@inheritDoc} ! */ ! public function getDefaultOption() ! { ! return 'allowed'; ! } ! } tell

607. doctrine

608. this

610. is

611. an

612. annotation Usage:

614. use DMSFilterRules as Filter;! ! @FilterStripTags(‘bi’) DMSFilterRulesRule:  ! public function __construct($options = null)

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

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

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

618. /**! * @MyAnnotation(“name”, nullable=true)! */ new MyAnnotation($options); array:

619. key

620. =

PHP Annotations: They exist! - JetBrains Webinar

PHP Annotations: They exist! - JetBrains Webinar

Recommended

More Related Content

What's hot

What's hot(20)

Similar to PHP Annotations: They exist! - JetBrains Webinar

Similar to PHP Annotations: They exist! - JetBrains Webinar(20)

More from Rafael Dohms

More from Rafael Dohms(20)

Recently uploaded

Recently uploaded(20)

PHP Annotations: They exist! - JetBrains Webinar