Permalink
Browse files

Clean up phpDocs

  • Loading branch information...
1 parent 5fe6788 commit d86b0ff03922db108c5bba339c09eda735e16de7 @ThePixelDeveloper ThePixelDeveloper committed May 2, 2012
@@ -25,7 +25,7 @@ class Model extends Iterable {
/**
* @param $collection
- * @param \Gignite\TheCure\IdentityMap $identities
+ * @param IdentityMap $identities
* @param $class_name
*/
public function __construct(
@@ -39,7 +39,7 @@ public function __construct(
}
/**
- * @return \Gignite\TheCure\IdentityMap
+ * @return IdentityMap
*/
protected function identities()
{
@@ -55,7 +55,7 @@ protected function class_name()
}
/**
- * @return \Gignite\TheCure\Models\Model|mixed
+ * @return Model|mixed
*/
public function current()
{
@@ -48,14 +48,14 @@ public function find_one($suffix = NULL, $where = NULL);
/**
* @abstract
- * @param \Gignite\TheCure\Models\Model $model
+ * @param Model $model
* @return mixed
*/
public function save(Model $model);
/**
* @abstract
- * @param $model
+ * @param $model
* @return mixed
*/
public function delete($model);
@@ -21,34 +21,16 @@
class Container {
- /**
- * @var
- */
protected $config;
- /**
- * @var
- */
protected $factory;
- /**
- * @var
- */
protected $connection;
- /**
- * @var
- */
protected $identities;
- /**
- * @var
- */
protected $mappers;
- /**
- * @var string
- */
protected $type;
/**
@@ -90,7 +72,7 @@ protected function factory()
}
/**
- * @param null $config
+ * @param null $config
* @return mixed
*/
public function config($config = NULL)
@@ -25,23 +25,12 @@
abstract class Mapper
implements MapperActions, FactorySetGet, IdentitiesSetGet, ConfigSetGet {
- /**
- * @var
- */
protected $identities;
-
- /**
- * @var
- */
protected $factory;
-
- /**
- * @var
- */
protected $config;
/**
- * @param \Gignite\TheCure\IdentityMap|null $identities
+ * @param IdentityMap|null $identities
* @return mixed
*/
public function identities(IdentityMap $identities = NULL)
@@ -71,7 +60,7 @@ public function config($config)
}
/**
- * @param \Gignite\TheCure\Factory|null $factory
+ * @param Factory|null $factory
* @return mixed
*/
public function factory(Factory $factory = NULL)
@@ -94,7 +83,7 @@ protected function collection_name()
}
/**
- * @param null $suffix
+ * @param null $suffix
* @return mixed
*/
protected function model_class($suffix = NULL)
@@ -103,10 +92,10 @@ protected function model_class($suffix = NULL)
}
/**
- * @param $suffix
- * @param $where
- * @param $callback
- * @return \Gignite\TheCure\Collections\Model
+ * @param $suffix
+ * @param $where
+ * @param $callback
+ * @return Collections\Model
* @throws \InvalidArgumentException
*/
protected function create_collection($suffix, $where, $callback)
@@ -136,6 +125,11 @@ protected function create_collection($suffix, $where, $callback)
/**
* [!!] We probably always need to check to see if Model
* actually exists even if pulled from identities.
+ *
+ * @param $suffix
+ * @param $where
+ * @param $callback
+ * @return mixed
*/
protected function create_model($suffix, $where, $callback)
{
@@ -175,8 +169,8 @@ protected function create_model($suffix, $where, $callback)
}
/**
- * @param \Gignite\TheCure\Models\Model $model
- * @param $callback
+ * @param Model $model
+ * @param $callback
*/
protected function save_model(Model $model, $callback)
{
@@ -191,8 +185,8 @@ protected function save_model(Model $model, $callback)
}
/**
- * @param $model
- * @param $callback
+ * @param $model
+ * @param $callback
* @return mixed
*/
protected function delete_model($model, $callback)
@@ -71,7 +71,7 @@ public static function each_where($collection, $where, $callback)
/**
* @param null $suffix
* @param array|null $where
- * @return \Gignite\TheCure\Collections\Model|\Gignite\TheCure\Mapper\Collection
+ * @return Model|Collection
*/
public function find($suffix = NULL, array $where = NULL)
{
@@ -135,7 +135,7 @@ function ($record) use ($collection, & $found)
}
/**
- * @param \Gignite\TheCure\Models\Model $model
+ * @param Model $model
*/
public function save(Model $model)
{
@@ -26,7 +26,7 @@
* Sets the connection property if one is passed in otherwise
* it returns the connection.
*
- * @param \Gignite\TheCure\Connections\Connection|null $connection
+ * @param Connection|null $connection
* @return \Mongo
*/
public function connection(Connection $connection = NULL)
@@ -75,7 +75,7 @@ protected function query_options()
*
* @param null $suffix
* @param array|null $where
- * @return \Gignite\TheCure\Collections\Model|\Gignite\TheCure\Mapper\Collection
+ * @return Model|Collection
*/
public function find($suffix = NULL, array $where = NULL)
{
@@ -124,7 +124,7 @@ function ($where) use ($collection)
/**
* Saves a models data to Mongo
*
- * @param \Gignite\TheCure\Models\Model $model
+ * @param Model $model
*/
public function save(Model $model)
{
@@ -32,7 +32,7 @@ public static function fields()
protected $__container;
/**
- * @param \Gignite\TheCure\Mapper\Container|null $container
+ * @param Container|null $container
* @return mixed
*/
public function __container(Container $container = NULL)
@@ -15,9 +15,9 @@
/**
* @abstract
- * @param \Gignite\TheCure\Mapper\Container $container
- * @param $object
- * @param $relation
+ * @param Container $container
+ * @param $object
+ * @param $relation
* @return mixed
*/
public function add(Container $container, $object, $relation);
@@ -15,9 +15,9 @@
/**
* @abstract
- * @param \Gignite\TheCure\Mapper\Container $container
- * @param $object
- * @param $relation
+ * @param Container $container
+ * @param $object
+ * @param $relation
* @return mixed
*/
public function remove(Container $container, $object, $relation);
@@ -15,9 +15,9 @@
/**
* @abstract
- * @param \Gignite\TheCure\Mapper\Container $container
- * @param $object
- * @param $relation
+ * @param Container $container
+ * @param $object
+ * @param $relation
* @return mixed
*/
public function set(Container $container, $object, $relation);
@@ -15,7 +15,7 @@
class OneToMany extends Relationship implements Relation\Add, Relation\Remove {
/**
- * @param \Gignite\TheCure\Mapper\Container $container
+ * @param Container $container
* @param $ids
* @return mixed
*/
@@ -27,7 +27,7 @@ public function find(Container $container, $ids)
}
/**
- * @param \Gignite\TheCure\Mapper\Container $container
+ * @param Container $container
* @param $model
* @param $relation
*/
@@ -57,12 +57,12 @@ public function add(Container $container, $model, $relation)
}
/**
- * @param \Gignite\TheCure\Mapper\Container $container
+ * @param Container $container
* @param $model
* @param $relation
* @return mixed
- * @throws \Gignite\TheCure\Relation\NotFoundException
- * @throws \Gignite\TheCure\Relation\FieldNotFoundException
+ * @throws Relation\NotFoundException
+ * @throws Relation\FieldNotFoundException
*/
public function remove(Container $container, $model, $relation)
{
@@ -15,7 +15,7 @@
class OneToOne extends Relationship implements Relation\Set, Relation\Remove {
/**
- * @param \Gignite\TheCure\Mapper\Container $container
+ * @param Container $container
* @param $id
* @return mixed
*/
@@ -25,7 +25,7 @@ public function find(Container $container, $id)
}
/**
- * @param \Gignite\TheCure\Mapper\Container $container
+ * @param Container $container
* @param $model
* @param $relation
*/
@@ -43,11 +43,11 @@ public function set(Container $container, $model, $relation)
}
/**
- * @param \Gignite\TheCure\Mapper\Container $container
+ * @param Container $container
* @param $model
* @param $relation
* @return mixed
- * @throws \Gignite\TheCure\Relation\FieldNotFoundException
+ * @throws Relation\FieldNotFoundException
*/
public function remove(Container $container, $model, $relation)
{
@@ -67,8 +67,8 @@ protected function mapper_suffix()
}
/**
- * @param \Gignite\TheCure\Mapper\Container $container
- * @return \Gignite\TheCure\Mapper\Mapper
+ * @param Container $container
+ * @return Mapper
*/
protected function mapper(Container $container)
{
@@ -77,7 +77,7 @@ protected function mapper(Container $container)
/**
* @abstract
- * @param \Gignite\TheCure\Mapper\Container $container
+ * @param Container $container
* @param $value
* @return mixed
*/

0 comments on commit d86b0ff

Please sign in to comment.