MockEntityList does now accept values to add

Author: sweiguny

PPA.php

@@ -107,8 +107,7 @@ public function getConnection() {
 }
 
 /**
- * This function is provided by PPA to show variables in a more human readable
- * way.
+ * This function is provided by PPA to show variables in a more human readable way.
  * 
  * @param mixed $param
  */

README.md

@@ -7,20 +7,20 @@ The PHP Persistence API (`PPA`) is an Interface for PHP-Applications to access O
 
 ***
 
-## [v1.0.0 released!](https://github.com/sweiguny/PHP-Persistence-API/releases/tag/v1.0.0)
+### [v1.0.0 released!](https://github.com/sweiguny/PHP-Persistence-API/releases/tag/v1.0.0)
 
 ***
 
-**Features:**
-- Easy to embed in your project
+#### Features:
+- [Easy to embed in your project](https://github.com/sweiguny/PHP-Persistence-API/wiki/Embedding-PPA)
 - Configure entities via [annotations](https://github.com/sweiguny/PHP-Persistence-API/wiki/Annotations-&-Parameters) (no xml!)
   - Relations
     - OneToOne
     - OneToMany
     - ManyToMany
 - [TypedQueries](https://github.com/sweiguny/PHP-Persistence-API/wiki/TypedQuery) and PreparedQueries.
-- Transactions
 - CRUD
+  - Transactions
 - Good performance
   - Eager- & Lazy-loading
 - A neat [WIKI](https://github.com/sweiguny/PHP-Persistence-API/wiki)
@@ -30,52 +30,41 @@ The PHP Persistence API (`PPA`) is an Interface for PHP-Applications to access O
 
 ***
 
-## Examples:
+### Examples:
 
 **Configuring your entities:**
 
+    namespace PPA\examples\entity;
     use PPA\core\Entity;
 
     /**
-     * @table(name="user")
+     * @table(name="role")
      */
-    class User extends Entity {
+    class Role extends Entity {
 
         /**
          * @id
          * @column(name="id")
          */
         private $id;
 
-        /**
-         * @Column(name="username")
-         */
-        private $username;
-
-        /**
-         * @Column(name="password")
-         */
-        private $password;
+        /** @column(name="name") */
+        private $name;
 
         /**
-         * @Column(name="role_id");
-         * @oneToOne(fetch="lazy", mappedBy = "_PPA_examples_entity_Role")
+         * @manyToMany(fetch = "eager", mappedBy = "_PPA_examples_entity_Right")
+         * @joinTable(name = "role2right", column = "role_id", x_column = "right_id")
          */
-        private $role;
-
-        public function getRole() {
-            return $this->role;
-        }
+        private $rights = array();
     }
 
 ***
 
 **Retrieving data:**
 
-    use PPA\core\query\TypedQuery;
-    
-    // A TypedQuery can automatically resolve all the relations and give an appropriate output.
-    $query = new TypedQuery("SELECT * FROM `role` WHERE id = 2", "\\PPA\\examples\\entity\\Role");
+A TypedQuery can automatically resolve all the relations and give an appropriate output.
+
+    $query = new \PPA\core\query\TypedQuery("SELECT * FROM `role` WHERE id = 2", "\\PPA\\examples\\entity\\Role");
     $query->getSingleResult();
 
     Returns:
@@ -95,24 +84,5 @@ The PHP Persistence API (`PPA`) is an Interface for PHP-Applications to access O
                         [id:PPA\examples\entity\Right:private] => 1
                         [desc:PPA\examples\entity\Right:private] => login
                     )
-                [2] => PPA\examples\entity\Right Object
-                    (
-                        [id:PPA\examples\entity\Right:private] => 2
-                        [desc:PPA\examples\entity\Right:private] => logout
-                    )
-                [3] => PPA\examples\entity\Right Object
-                    (
-                        [id:PPA\examples\entity\Right:private] => 5
-                        [desc:PPA\examples\entity\Right:private] => create_order
-                    )
-                [4] => PPA\examples\entity\Right Object
-                    (
-                        [id:PPA\examples\entity\Right:private] => 4
-                        [desc:PPA\examples\entity\Right:private] => delete_order
-                    )
             )
     )
-
-***
-
-For more examples, please see the [WIKI](https://github.com/sweiguny/PHP-Persistence-API/wiki).

core/EntityAnalyzer.php

@@ -31,10 +31,39 @@ class EntityAnalyzer {
      */
     private $analyzed = false;
 
+    /**
+     * The property that represents the primary key in the table.
+     * 
+     * @var EntityProperty
+     */
     private $primaryProperty;
+    
+    /**
+     * The name of the table to which the entity is mapped.
+     * 
+     * @var string
+     */
     private $tableName;
+    
+    /**
+     * An array filled with properties indexed by the property name.
+     * 
+     * @var array
+     */
     private $propertiesByName;
+    
+    /**
+     * An array filled with properties indexed by the column name.
+     * 
+     * @var array
+     */
     private $propertiesByColumn;
+    
+    /**
+     * An array filled with all relations of the entity.
+     * 
+     * @var array
+     */
     private $relations;
 
     /**
@@ -80,8 +109,12 @@ public function doAnalysis() {
         if ($this->analyzed) {
             # TODO: trigger error and/or log message
         } else {
-            
-            $annotations = $this->extractAnnotations($this->reflector->getDocComment());
+            $primaryProperty    = null;
+            $propertiesByName   = array();
+            $propertiesByColumn = array();
+            $relations          = array();
+            $properties         = $this->reflector->getProperties();
+            $annotations        = $this->extractAnnotations($this->reflector->getDocComment());
 
             if (isset($annotations["@table"]) && isset($annotations["@table"]["name"])) {
                 $this->tableName = $annotations["@table"]["name"];
@@ -90,15 +123,6 @@ public function doAnalysis() {
             }
 
 
-            # --------------------
-            
-            
-            $primaryProperty    = null;
-            $propertiesByName   = array();
-            $propertiesByColumn = array();
-            $relations          = array();
-            $properties         = $this->reflector->getProperties();
-            
             foreach ($properties as $property) {
                 $annotations = $this->extractAnnotations($property->getDocComment());
 
@@ -145,6 +169,7 @@ public function doAnalysis() {
             if ($primaryProperty == null) {
                 throw new AnnotationException("Entity '{$this->classname}' does not have an @id annotation.");
             }
+            
             $this->primaryProperty    = $primaryProperty;
             $this->propertiesByName   = $propertiesByName;
             $this->propertiesByColumn = $propertiesByColumn;
@@ -154,8 +179,10 @@ public function doAnalysis() {
     }
 
     /**
-     * @param array $annotations
-     * @throws AnnotationException when some annotations are not compliant.
+     * Gives an appropriate output of which combination is not proper.
+     * 
+     * @param array $annotations The annotations of the properties.
+     * @throws AnnotationException
      */
     private function handleUncombinables(array $annotations) {
         if (isset($annotations["@joinTable"])) {

core/EntityFactory.php

@@ -9,11 +9,11 @@ class EntityFactory {
 
     /**
      * Instantiates an instance of the given classname, but without calling the
-     * constructor. It is necessary, that the class is a subclass of \PPA\Entity.
+     * constructor. It is necessary, that the class is a subclass of \PPA\core\Entity.
      * 
      * @param string $classname
      * @return Entity An instance of the classname.
-     * @throws NoEntityException If the classname is not a subclass of \PPA\Entity.
+     * @throws NoEntityException
      */
     public static function create($classname) {
         $reflection = new ReflectionClass($classname);

core/EntityManager.php

@@ -36,6 +36,7 @@ public static function getInstance() {
      */
     private $emdm;
 
+    private function __clone() { }
     private function __construct() {
         $this->conn = PPA::getInstance()->getConnection();
         $this->emdm = EntityMetaDataMap::getInstance();
@@ -159,6 +160,12 @@ public function persist(Entity $entity) {
         }
     }
 
+    /**
+     * Removes an entity from the database.
+     * 
+     * @param Entity $entity The entity to remove from database.
+     * @return int The number of affected rows.
+     */
     public function remove(Entity $entity) {
         $classname       = get_class($entity);
         $tablename       = $this->emdm->getTableName($classname);
@@ -170,6 +177,8 @@ public function remove(Entity $entity) {
         return $q->getSingleResult(array($primaryProperty->getValue($entity)));
     }
 
+    # TODO: outsource the following methods.
+    
     public function begin() {
         if ($this->inTransaction()) {
             throw new TransactionException("Already in an transaction.");

core/EntityProperty.php

@@ -23,19 +23,22 @@ public function setColumn($column) {
         $this->column = $column;
     }
 
+    /**
+     * @param Relation $relation
+     */
     public function setRelation(Relation $relation) {
         $this->relation = $relation;
     }
 
     /**
-     * 
      * @return Relation
      */
     public function getRelation() {
         return $this->relation;
     }
 
     /**
+     * Checks if the property represents a relation to another entity.
      * 
      * @return bool
      */
@@ -44,17 +47,22 @@ public function hasRelation() {
     }
 
     /**
+     * Checks if the property is the primary.
      * 
      * @return bool
      */
     public function isPrimary() {
         return $this->isPrimary;
     }
 
+    /**
+     * Defines the property as primary.
+     * 
+     * @param bool $primary 
+     */
     public function makePrimary($primary = true) {
         $this->isPrimary = (bool)$primary;
     }
-    
 
 }
 

core/mock/MockEntity.php

@@ -53,6 +53,9 @@ public function __call($name, $arguments) {
         }
     }
 
+    /**
+     * @return Entity The true entity instead of the mock.
+     */
     protected function exchange() {
         $entity = $this->query->getSingleResult($this->values);
         $this->property->setValue($this->owner, $entity);

core/mock/MockEntityList.php

@@ -47,6 +47,9 @@ public function __call($name, $arguments) {
         }
     }
 
+    /**
+     * Exchanges the mock list with an array that contains true entities.
+     */
     protected function exchange() {
         if ($this->entities == null) {
             $this->entities = $this->query->getResultList($this->values);
@@ -65,11 +68,13 @@ public function offsetGet($offset) {
     }
 
     public function offsetSet($offset, $value) {
-        throw new BadMethodCallException("Not possible.");
+        $this->exchange();
+        return $this->entities[$offset] = $value;
     }
 
     public function offsetUnset($offset) {
-        throw new BadMethodCallException("Not possible.");
+        $this->exchange();
+        unset($this->entities[$offset]);
     }
 
     public function count() {

examples/em.php

@@ -13,11 +13,8 @@
 
 //$em->persist(new PPA\examples\entity\User());
 
-//$query = new PPA\core\query\TypedQuery("select * from `role` where id=1", "\\PPA\\examples\\entity\\Role");
-//$role = $query->getSingleResult();
-
-
-$role = new PPA\examples\entity\Role("neu");
+$query = new PPA\core\query\TypedQuery("select * from `role` where id=1", "\\PPA\\examples\\entity\\Role");
+$role = $query->getSingleResult();
 
 $role->addRight(new \PPA\examples\entity\Right("test"));
 $role->addRight(new \PPA\examples\entity\Right("test"));

examples/entity/Role.php

@@ -21,7 +21,7 @@ class Role extends Entity {
     private $name;
 
     /**
-     * @manyToMany(fetch = "eager", mappedBy = "_PPA_examples_entity_Right")
+     * @manyToMany(fetch = "lazy", mappedBy = "_PPA_examples_entity_Right")
      * @joinTable(name = "role2right", column = "role_id", x_column = "right_id")
      */
     private $rights = array();