From 91cea1a20620ac8e327341d5b3182738c5129003 Mon Sep 17 00:00:00 2001 From: Graham Campbell Date: Tue, 29 Jul 2014 23:19:06 +0100 Subject: [PATCH 1/3] Corrected the exception constructor docblocks --- src/Exception/DeleteMethodNotFound.php | 2 +- src/Exception/SaveMethodNotFound.php | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Exception/DeleteMethodNotFound.php b/src/Exception/DeleteMethodNotFound.php index 45f6c92..26c10c8 100644 --- a/src/Exception/DeleteMethodNotFound.php +++ b/src/Exception/DeleteMethodNotFound.php @@ -23,7 +23,7 @@ class DeleteMethodNotFound extends MethodNotFound /** * Create a new instance. * - * @param string $model + * @param string $object * @param string $method * @param string $message * diff --git a/src/Exception/SaveMethodNotFound.php b/src/Exception/SaveMethodNotFound.php index ef3abcd..7902c09 100644 --- a/src/Exception/SaveMethodNotFound.php +++ b/src/Exception/SaveMethodNotFound.php @@ -23,7 +23,7 @@ class SaveMethodNotFound extends MethodNotFound /** * Create a new instance. * - * @param string $model + * @param string $object * @param string $method * @param string $message * From b574d03389b44b53dedffb5df285ca938cd214c9 Mon Sep 17 00:00:00 2001 From: Graham Campbell Date: Tue, 29 Jul 2014 23:20:09 +0100 Subject: [PATCH 2/3] Corrected completely wrong docblocks --- src/Kind.php | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/src/Kind.php b/src/Kind.php index 511e036..6d7a9fb 100644 --- a/src/Kind.php +++ b/src/Kind.php @@ -33,23 +33,23 @@ abstract class Kind ); /** - * Holds the Kind we are working on. + * The kind of attribute that will be generate. * - * @type \League\FactoryMuffin\Kind + * @type string */ protected $kind; /** - * Holds the model data. + * The name of the model class. * - * @type array + * @type string */ protected $model; /** - * Holds the faker factory. + * The faker factory or generator instance. * - * @type \Faker\Factory + * @type \Faker\Factory|\Faker\Generator */ protected $faker; @@ -63,10 +63,10 @@ abstract class Kind /** * Initialise our Kind. * - * @param $kind - * @param $model - * @param $faker - * @param $save Have we saved the parent object, or just created an instance? + * @param string $kind The kind of attribute that will be generate. + * @param string $model The name of the model class. + * @param \Faker\Factory|\Faker\Generator $faker The faker factory or generator instance. + * @param bool $save Have we saved the parent object? */ public function __construct($kind, $model, $faker, $save = false) { @@ -79,9 +79,9 @@ public function __construct($kind, $model, $faker, $save = false) /** * Detect the type of Kind we are processing. * - * @param mixed $kind - * @param array $model - * @param bool $save + * @param string $kind The kind of attribute that will be generate. + * @param string $model The name of the model class. + * @param bool $save Have we saved the parent object? * * @return \League\FactoryMuffin\Kind */ From b86277687b4379cbe789ce8589c4d83e63254df9 Mon Sep 17 00:00:00 2001 From: Graham Campbell Date: Tue, 29 Jul 2014 23:24:12 +0100 Subject: [PATCH 3/3] Fixed a typo --- src/FactoryMuffin.php | 2 +- src/Kind.php | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/FactoryMuffin.php b/src/FactoryMuffin.php index 80706c7..830ffeb 100644 --- a/src/FactoryMuffin.php +++ b/src/FactoryMuffin.php @@ -253,7 +253,7 @@ public function define($model, array $definition = array()) * * This method will return a string, or an instance of the model. * - * @param string $kind The kind of attribute that will be generate. + * @param string $kind The kind of attribute that will be generated. * @param string $model The name of the model class. * @param bool $save Are we saving an object, or just creating an instance? * diff --git a/src/Kind.php b/src/Kind.php index 6d7a9fb..96c09e3 100644 --- a/src/Kind.php +++ b/src/Kind.php @@ -33,7 +33,7 @@ abstract class Kind ); /** - * The kind of attribute that will be generate. + * The kind of attribute that will be generated. * * @type string */ @@ -63,7 +63,7 @@ abstract class Kind /** * Initialise our Kind. * - * @param string $kind The kind of attribute that will be generate. + * @param string $kind The kind of attribute that will be generated. * @param string $model The name of the model class. * @param \Faker\Factory|\Faker\Generator $faker The faker factory or generator instance. * @param bool $save Have we saved the parent object? @@ -79,7 +79,7 @@ public function __construct($kind, $model, $faker, $save = false) /** * Detect the type of Kind we are processing. * - * @param string $kind The kind of attribute that will be generate. + * @param string $kind The kind of attribute that will be generated. * @param string $model The name of the model class. * @param bool $save Have we saved the parent object? *