Skip to content
Browse files

Automatic generation of phpDoc.

  • Loading branch information...
1 parent c59cb39 commit 5fe6788340e3438f2dc322e878c83d8f9d924af6 @ThePixelDeveloper ThePixelDeveloper committed
View
4 classes/Gignite/TheCure/Connections/Connection.php
@@ -10,6 +10,10 @@
interface Connection {
+ /**
+ * @abstract
+ * @return mixed
+ */
public function get();
}
View
17 classes/Gignite/TheCure/Mapper/Actions.php
@@ -39,14 +39,25 @@
public function find($suffix = NULL, array $where = NULL);
/**
- * Find a single record.
- *
- *
+ * @abstract
+ * @param null $suffix
+ * @param null $where
+ * @return mixed
*/
public function find_one($suffix = NULL, $where = NULL);
+ /**
+ * @abstract
+ * @param \Gignite\TheCure\Models\Model $model
+ * @return mixed
+ */
public function save(Model $model);
+ /**
+ * @abstract
+ * @param $model
+ * @return mixed
+ */
public function delete($model);
}
View
39 classes/Gignite/TheCure/Mapper/Container.php
@@ -21,16 +21,34 @@
class Container {
+ /**
+ * @var
+ */
protected $config;
+ /**
+ * @var
+ */
protected $factory;
+ /**
+ * @var
+ */
protected $connection;
+ /**
+ * @var
+ */
protected $identities;
+ /**
+ * @var
+ */
protected $mappers;
-
+
+ /**
+ * @var string
+ */
protected $type;
/**
@@ -50,11 +68,17 @@ public function __construct($type)
$this->type = $type;
}
+ /**
+ * @return string
+ */
protected function type()
{
return $this->type;
}
+ /**
+ * @return mixed
+ */
protected function factory()
{
if ($this->factory === NULL)
@@ -65,6 +89,10 @@ protected function factory()
return $this->factory;
}
+ /**
+ * @param null $config
+ * @return mixed
+ */
public function config($config = NULL)
{
if (is_array($config))
@@ -88,6 +116,9 @@ public function config($config = NULL)
return $this->config;
}
+ /**
+ * @return mixed
+ */
protected function mapper_config()
{
$mappers = $this->config('mappers');
@@ -99,6 +130,9 @@ protected function mapper_config()
}
}
+ /**
+ * @return mixed
+ */
protected function connection()
{
if ($this->connection === NULL)
@@ -120,6 +154,9 @@ protected function connection()
return $this->connection;
}
+ /**
+ * @return mixed
+ */
protected function identities()
{
if ($this->identities === NULL)
View
4 classes/Gignite/TheCure/Models/Model.php
@@ -32,8 +32,8 @@
/**
* Get/set the data transfer object.
*
- * @param StdClass If setting pass in a StdClass
- * @return StdClass If getting
+ * @param Object $object If setting pass in an Object
+ * @return Object If getting
*/
public function __object(Object $object = NULL)
{
View
9 classes/Gignite/TheCure/Relation/Add.php
@@ -12,7 +12,14 @@
use Gignite\TheCure\Mapper\Container;
interface Add {
-
+
+ /**
+ * @abstract
+ * @param \Gignite\TheCure\Mapper\Container $container
+ * @param $object
+ * @param $relation
+ * @return mixed
+ */
public function add(Container $container, $object, $relation);
}
View
9 classes/Gignite/TheCure/Relation/Remove.php
@@ -12,7 +12,14 @@
use Gignite\TheCure\Mapper\Container;
interface Remove {
-
+
+ /**
+ * @abstract
+ * @param \Gignite\TheCure\Mapper\Container $container
+ * @param $object
+ * @param $relation
+ * @return mixed
+ */
public function remove(Container $container, $object, $relation);
}
View
9 classes/Gignite/TheCure/Relation/Set.php
@@ -12,7 +12,14 @@
use Gignite\TheCure\Mapper\Container;
interface Set {
-
+
+ /**
+ * @abstract
+ * @param \Gignite\TheCure\Mapper\Container $container
+ * @param $object
+ * @param $relation
+ * @return mixed
+ */
public function set(Container $container, $object, $relation);
}

0 comments on commit 5fe6788

Please sign in to comment.
Something went wrong with that request. Please try again.