Merge pull request #12 from Linfuby/master

PHPDoc

Author: dracony

src/PHPixie/ORM.php

@@ -4,6 +4,9 @@
 
 class ORM
 {
+    /**
+     * @type ORM\Builder
+     */
     protected $builder;
 
     public function __construct($database, $configSlice, $wrappers = null)

src/PHPixie/ORM/Builder.php

@@ -4,6 +4,9 @@
 
 class Builder
 {
+    /**
+     * @type \PHPixie\Database
+     */
     protected $database;
     protected $configSlice;
     protected $wrappers;
@@ -16,76 +19,121 @@ public function __construct($database, $configSlice, $wrappers = null)
         $this->configSlice = $configSlice;
         $this->wrappers    = $wrappers;
     }
-    
+
+    /**
+     * @return Conditions
+     */
     public function conditions()
     {
         return $this->instance('conditions');
     }
-    
+
+    /**
+     * @return Configs
+     */
     public function configs()
     {
         return $this->instance('configs');
     }
-    
+
+    /**
+     * @return Data
+     */
     public function data()
     {
         return $this->instance('data');
     }
-    
+
+    /**
+     * @return Database
+     */
     public function database()
     {
         return $this->instance('database');
     }
-    
+
+    /**
+     * @return Drivers
+     */
     public function drivers()
     {
         return $this->instance('drivers');
     }
-    
+
+    /**
+     * @return Loaders
+     */
     public function loaders()
     {
         return $this->instance('loaders');
     }
-    
+
+    /**
+     * @return Mappers
+     */
     public function mappers()
     {
         return $this->instance('mappers');
     }
-    
+
+    /**
+     * @return Maps
+     */
     public function maps() {
         return $this->instance('maps');
     }
-    
+
+    /**
+     * @return Models
+     */
     public function models()
     {
         return $this->instance('models');
     }
-    
+
+    /**
+     * @return Planners
+     */
     public function planners()
     {
         return $this->instance('planners');
     }
-    
+
+    /**
+     * @return Plans
+     */
     public function plans()
     {
         return $this->instance('plans');
     }
-    
+
+    /**
+     * @return Relationships
+     */
     public function relationships()
     {
         return $this->instance('relationships');
     }
-    
+
+    /**
+     * @return Repositories
+     */
     public function repositories()
     {
         return $this->instance('repositories');
     }
-        
+
+    /**
+     * @return Steps
+     */
     public function steps()
     {
         return $this->instance('steps');
     }
-    
+
+    /**
+     * @return Values
+     */
     public function values()
     {
         return $this->instance('values');

src/PHPixie/ORM/Conditions.php

@@ -4,6 +4,9 @@
 
 class Conditions
 {
+    /**
+     * @type \PHPixie\ORM\Builder
+     */
     protected $ormBuilder;
 
     public function __construct($ormBuilder)

src/PHPixie/ORM/Data.php

@@ -3,7 +3,9 @@
 namespace PHPixie\ORM;
 
 class Data {
-    
+    /**
+     * @type \PHPixie\ORM\Data\Types\Document\Builder
+     */
     protected $documentBuilder;
 
     public function diff($set)

src/PHPixie/ORM/Database.php

@@ -4,13 +4,20 @@
 
 class Database
 {
+    /**
+     * @type \PHPixie\Database
+     */
     protected $database;
 
     public function __construct($database)
     {
         $this->database = $database;
     }
-    
+
+    /**
+     * @param $name
+     * @return \PHPixie\Database\Driver\PDO\Connection|\PHPixie\Database\Driver\Mongo\Connection
+     */
     public function connection($name)
     {
         return $this->database->get($name);

src/PHPixie/ORM/Drivers.php

@@ -4,6 +4,9 @@
 
 class Drivers
 {
+    /**
+     * @type \PHPixie\ORM\Builder
+     */
     protected $ormBuilder;
     protected $drivers = array();
 
@@ -16,7 +19,12 @@ public function __construct($ormBuilder)
     {
         $this->ormBuilder = $ormBuilder;
     }
-    
+
+    /**
+     * @param $name
+     * @return \PHPixie\ORM\Drivers\Driver\PDO|\PHPixie\ORM\Drivers\Driver\Mongo
+     *
+     */
     public function get($name)
     {
         if (!array_key_exists($name, $this->drivers))

src/PHPixie/ORM/Drivers/Driver.php

@@ -4,13 +4,37 @@
 
 abstract class Driver
 {
+    /**
+     * @type \PHPixie\ORM\Configs
+     */
     protected $configs;
+    /**
+     * @type \PHPixie\ORM\Conditions
+     */
     protected $conditions;
+    /**
+     * @type \PHPixie\ORM\Data
+     */
     protected $data;
+    /**
+     * @type \PHPixie\ORM\Database
+     */
     protected $database;
+    /**
+     * @type \PHPixie\ORM\Models
+     */
     protected $models;
+    /**
+     * @type \PHPixie\ORM\Maps
+     */
     protected $maps;
+    /**
+     * @type \PHPixie\ORM\Mappers
+     */
     protected $mappers;
+    /**
+     * @type \PHPixie\ORM\Values
+     */
     protected $values;
 
     public function __construct($configs, $conditions, $data, $database, $models, $maps, $mappers, $values)

src/PHPixie/ORM/Loaders.php

@@ -4,6 +4,9 @@
 
 class Loaders
 {
+    /**
+     * @type \PHPixie\ORM\Builder
+     */
     protected $ormBuilder;
 
     public function __construct($ormBuilder)

src/PHPixie/ORM/Mappers.php

@@ -4,49 +4,76 @@
 
 class Mappers
 {
+    /**
+     * @type \PHPixie\ORM\Builder
+     */
     protected $ormBuilder;
     protected $instances = array();
 
     public function __construct($ormBuilder)
     {
         $this->ormBuilder = $ormBuilder;
     }
-    
+
+    /**
+     * @return \PHPixie\ORM\Mappers\Query
+     */
     public function query()
     {
         return $this->instance('query');
     }
-    
+
+    /**
+     * @return \PHPixie\ORM\Mappers\Conditions
+     */
     public function conditions()
     {
         return $this->instance('conditions');
     }
-    
+
+    /**
+     * @return \PHPixie\ORM\Mappers\Conditions\Normalizer
+     */
     public function conditionsNormalizer()
     {
         return $this->instance('conditionsNormalizer');
     }
-    
+
+    /**
+     * @return \PHPixie\ORM\Mappers\Conditions\Optimizer
+     */
     public function conditionsOptimizer()
     {
         return $this->instance('conditionsOptimizer');
     }
-    
+
+    /**
+     * @return \PHPixie\ORM\Mappers\Preload
+     */
     public function preload()
     {
         return $this->instance('preload');
     }
-    
+
+    /**
+     * @return \PHPixie\ORM\Mappers\Update
+     */
     public function update()
     {
         return $this->instance('update');
     }
-    
+
+    /**
+     * @return \PHPixie\ORM\Mappers\Cascade\Mapper\Delete
+     */
     public function cascadeDelete()
     {
         return $this->instance('cascadeDelete');
     }
-    
+
+    /**
+     * @return Mappers\Cascade\Path
+     */
     public function cascadePath()
     {
         return new \PHPixie\ORM\Mappers\Cascade\Path($this);