documentation (commiting now from Guadeloupe)

Trismegiste · Trismegiste · commit 67bdb9fede89 · 2013-08-17T19:41:18.000-04:00
diff --git a/Visitor/Role.php b/Visitor/Role.php
@@ -9,13 +9,14 @@
  * The Visitor Pattern lets you outsource operations on objects to other objects. The main reason to do this is to keep
  * a seperation of concerns. But classes have to define an contract to allow visitors (the "accept" method in the example below).
  * 
- * The contract is an abstract class but you can have also a clean interface
+ * The contract is an abstract class but you can have also a clean interface. 
+ * In that case, each Visitee has to choose itself which method to invoke on the visitor.
  */
 abstract class Role
 {
 
     /**
-     * This method handle a double dispatch based on the shortname of the Visitee
+     * This method handles a double dispatch based on the shortname of the Visitee
      * 
      * Feel free to override it if your object must call another visiting behavior
      * 
diff --git a/Visitor/RolePrintVisitor.php b/Visitor/RolePrintVisitor.php
@@ -5,16 +5,22 @@
 /**
  * Visitor Pattern
  *
- * An implementation of a Visitor
+ * An implementation of a concrete Visitor
  */
 class RolePrintVisitor implements RoleVisitor
 {
 
+    /**
+     * @inheritdoc
+     */
     public function visitGroup(Group $role)
     {
         echo "Role: " . $role->getName();
     }
 
+    /**
+     * @inheritdoc
+     */
     public function visitUser(User $role)
     {
         echo "Role: " . $role->getName();
diff --git a/Visitor/RoleVisitor.php b/Visitor/RoleVisitor.php
@@ -5,13 +5,19 @@
 /**
  * Visitor Pattern
  *
- * The contract for the visitor
+ * The contract for the visitor.
+ * 
+ * Note 1 : in C++ or java, with method polymorphism based on type-hint, there are many
+ * methods visit() with different type for the 'role' parameter.
+ * 
+ * Note 2 : the visitor must not choose itself which method to
+ * invoke, it is the Visitee that make this decision.
  */
 interface RoleVisitor
 {
 
     /**
-     * Visit a user object
+     * Visit a User object
      * 
      * @param \DesignPatterns\Visitor\User $role
      */

Original file line number	Diff line number	Diff line change
`@@ -9,13 +9,14 @@`
`9`	`9`	`* The Visitor Pattern lets you outsource operations on objects to other objects. The main reason to do this is to keep`
`10`	`10`	`* a seperation of concerns. But classes have to define an contract to allow visitors (the "accept" method in the example below).`
`11`	`11`	`*`
`12`		`- * The contract is an abstract class but you can have also a clean interface`
	`12`	`+ * The contract is an abstract class but you can have also a clean interface.`
	`13`	`+ * In that case, each Visitee has to choose itself which method to invoke on the visitor.`
`13`	`14`	`*/`
`14`	`15`	`abstract class Role`
`15`	`16`	`{`
`16`	`17`
`17`	`18`	`/**`
`18`		`- * This method handle a double dispatch based on the shortname of the Visitee`
	`19`	`+ * This method handles a double dispatch based on the shortname of the Visitee`
`19`	`20`	`*`
`20`	`21`	`* Feel free to override it if your object must call another visiting behavior`
`21`	`22`	`*`
Original file line number	Diff line number	Diff line change
`@@ -5,16 +5,22 @@`
`5`	`5`	`/**`
`6`	`6`	`* Visitor Pattern`
`7`	`7`	`*`
`8`		`- * An implementation of a Visitor`
	`8`	`+ * An implementation of a concrete Visitor`
`9`	`9`	`*/`
`10`	`10`	`class RolePrintVisitor implements RoleVisitor`
`11`	`11`	`{`
`12`	`12`
	`13`	`+ /**`
	`14`	`+ * @inheritdoc`
	`15`	`+ */`
`13`	`16`	`public function visitGroup(Group $role)`
`14`	`17`	`{`
`15`	`18`	`echo "Role: " . $role->getName();`
`16`	`19`	`}`
`17`	`20`
	`21`	`+ /**`
	`22`	`+ * @inheritdoc`
	`23`	`+ */`
`18`	`24`	`public function visitUser(User $role)`
`19`	`25`	`{`
`20`	`26`	`echo "Role: " . $role->getName();`