Maslosoft / Mangan

src/Criteria.php

Doc Comments +1 added lines, -1 removed lines

@@ -424,7 +424,7 @@
 
 	/**
 	 * Set conditions
-	 * @param array|Conditions $conditions
+	 * @param Conditions $conditions
 	 * @return Criteria
 	 */
 	public function setConditions($conditions)

src/Decorators/Model/AliasDecorator.php

Doc Comments +10 added lines, -2 removed lines

@@ -34,7 +34,7 @@ 
 	 * @param AnnotatedInterface $model Document model which will be decorated
 	 * @param mixed $dbValues
 	 * @param string $transformatorClass Transformator class used
-	 * @return bool Return true if value should be assigned to model
+	 * @return boolean|null Return true if value should be assigned to model
 	 */
 	public function read($model, &$dbValues, $transformatorClass = TransformatorInterface::class)
 	{
@@ -55,7 +55,7 @@ 
 	 * @param AnnotatedInterface $model Model which is about to be decorated
 	 * @param mixed[] $dbValues Whole model values from database. This is associative array with keys same as model properties (use $name param to access value). This is passed by reference.
 	 * @param string $transformatorClass Transformator class used
-	 * @return bool Return true to store value to database
+	 * @return boolean|null Return true to store value to database
 	 */
 	public function write($model, &$dbValues, $transformatorClass = TransformatorInterface::class)
 	{
@@ -70,6 +70,10 @@ 
 		}
 	}
 
+	/**
+	 * @param ManganMeta $meta
+	 * @param AnnotatedInterface $model
+	 */
 	private function _readValue($meta, $from, $to, &$dbValues, $model)
 	{
 		$fieldMeta = $meta->$from;
@@ -84,6 +88,10 @@ 
 		}
 	}
 
+	/**
+	 * @param ManganMeta $meta
+	 * @param AnnotatedInterface $model
+	 */
 	private function _writeValue($meta, $from, $to, &$dbValues, $model)
 	{
 		$fieldMeta = $meta->$from;

src/Helpers/PropertyFilter/Filter.php

Doc Comments +3 added lines

@@ -26,6 +26,9 @@
 class Filter extends Transformator implements TransformatorFilterInterface
 {
 
+	/**
+	 * @param \Maslosoft\Addendum\Interfaces\AnnotatedInterface $model
+	 */
 	public function fromModel($model, DocumentPropertyMeta $fieldMeta)
 	{
 		return $this->getFor($fieldMeta->name)->fromModel($model, $fieldMeta);

src/Traits/Model/TrashableTrait.php

Doc Comments +1 added lines, -1 removed lines

@@ -35,7 +35,7 @@
 
 	/**
 	 * Move to trash
-	 * @return boolean
+	 * @return false|null
 	 * @Ignored
 	 */
 	public function trash()

src/DataProvider.php

Doc Comments +2 added lines, -2 removed lines

@@ -150,7 +150,7 @@ 
 
 	/**
 	 * Returns the criteria.
-	 * @return array the query criteria
+	 * @return CriteriaInterface the query criteria
 	 * @since v1.0
 	 */
 	public function getCriteria()
@@ -204,7 +204,7 @@ 
 	/**
 	 * Returns the pagination object.
 	 * @param string $className the pagination object class name. Parameter is available since version 1.1.13.
-	 * @return CPagination|false the pagination object. If this is false, it means the pagination is disabled.
+	 * @return boolean the pagination object. If this is false, it means the pagination is disabled.
 	 */
 	public function getPagination($className = 'CPagination')
 	{

src/Finder.php

Doc Comments +1 added lines, -2 removed lines

@@ -137,7 +137,6 @@ 
 	 * ];
 	 * ```
 	 *
-	 * @param mixed $pk primary key value. Use array for composite key.
 	 * @param array|CriteriaInterface $criteria
 	 * @return AnnotatedInterface|null
 	 * @Ignored
@@ -394,7 +393,7 @@ 
 
 	/**
 	 * Trigger before find event
-	 * @return boolean
+	 * @return boolean|null
 	 */
 	private function _beforeFind()
 	{

src/Transformers/YamlString.php

Doc Comments +2 added lines, -2 removed lines

@@ -23,9 +23,9 @@
 
 	/**
 	 * Returns the given object as an associative array
-	 * @param AnnotatedInterface|object $model
+	 * @param AnnotatedInterface $model
 	 * @param string[] $fields Fields to transform
-	 * @return array an associative array of the contents of this object
+	 * @return string an associative array of the contents of this object
 	 */
 	public static function fromModel(AnnotatedInterface $model, $fields = [])
 	{

src/Transformers/JsonString.php

Doc Comments +2 added lines, -2 removed lines

@@ -23,9 +23,9 @@
 
 	/**
 	 * Returns the given object as an associative array
-	 * @param AnnotatedInterface|object $model
+	 * @param AnnotatedInterface $model
 	 * @param string[] $fields Fields to transform
-	 * @return array an associative array of the contents of this object
+	 * @return string an associative array of the contents of this object
 	 */
 	public static function fromModel(AnnotatedInterface $model, $fields = [])
 	{

src/Helpers/Sanitizer/Factory.php

Doc Comments +3 added lines

@@ -37,6 +37,9 @@
 	private static $sanitizers = [];
 	private static $arraySanitizers = [];
 
+	/**
+	 * @param string $transformatorClass
+	 */
 	public static function create(DocumentPropertyMeta $meta, DocumentTypeMeta $modelMeta, $transformatorClass)
 	{
 		$sanitizerClass = self::_resolve($meta, $modelMeta);