From 10e42976522cfe721d6511a8c40e88b9bd1c398c Mon Sep 17 00:00:00 2001 From: kodumbeats Date: Mon, 16 Aug 2021 18:59:33 -0400 Subject: [PATCH] Update attribute response models --- src/Appwrite/Utopia/Response/Model.php | 2 +- .../Utopia/Response/Model/Attribute.php | 2 +- .../Response/Model/AttributeBoolean.php | 2 +- .../Utopia/Response/Model/AttributeEmail.php | 8 +++---- .../Utopia/Response/Model/AttributeFloat.php | 22 +++++++---------- .../Utopia/Response/Model/AttributeIP.php | 8 +++---- .../Response/Model/AttributeInteger.php | 24 ++++++++----------- .../Utopia/Response/Model/AttributeString.php | 2 +- .../Utopia/Response/Model/AttributeURL.php | 6 ++--- 9 files changed, 34 insertions(+), 42 deletions(-) diff --git a/src/Appwrite/Utopia/Response/Model.php b/src/Appwrite/Utopia/Response/Model.php index 7c6aafdbd..73b660963 100644 --- a/src/Appwrite/Utopia/Response/Model.php +++ b/src/Appwrite/Utopia/Response/Model.php @@ -35,7 +35,7 @@ abstract class Model /** * Filter Document Structure * - * @return string + * @return Document */ public function filter(Document $document): Document { diff --git a/src/Appwrite/Utopia/Response/Model/Attribute.php b/src/Appwrite/Utopia/Response/Model/Attribute.php index c25b21da5..33df056a2 100644 --- a/src/Appwrite/Utopia/Response/Model/Attribute.php +++ b/src/Appwrite/Utopia/Response/Model/Attribute.php @@ -39,7 +39,7 @@ class Attribute extends Model 'description' => 'Is attribute an array?', 'default' => false, 'example' => false, - 'required' => false + 'require' => false ]) ; } diff --git a/src/Appwrite/Utopia/Response/Model/AttributeBoolean.php b/src/Appwrite/Utopia/Response/Model/AttributeBoolean.php index 93979288e..17c2e8960 100644 --- a/src/Appwrite/Utopia/Response/Model/AttributeBoolean.php +++ b/src/Appwrite/Utopia/Response/Model/AttributeBoolean.php @@ -16,7 +16,7 @@ class AttributeBoolean extends Model 'default' => null, 'example' => false, 'array' => false, - 'required' => false, + 'require' => false, ]) ; } diff --git a/src/Appwrite/Utopia/Response/Model/AttributeEmail.php b/src/Appwrite/Utopia/Response/Model/AttributeEmail.php index 11d068e8f..af090b77f 100644 --- a/src/Appwrite/Utopia/Response/Model/AttributeEmail.php +++ b/src/Appwrite/Utopia/Response/Model/AttributeEmail.php @@ -13,10 +13,10 @@ class AttributeEmail extends AttributeString ->addRule('format', [ 'type' => self::TYPE_STRING, 'description' => 'String format.', - 'default' => 'email', - 'example' => 'email', + 'default' => \json_encode(['name'=>APP_DATABASE_ATTRIBUTE_EMAIL]), + 'example' => \json_encode(['name'=>APP_DATABASE_ATTRIBUTE_EMAIL]), 'array' => false, - 'required' => true, + 'require' => true, ]) ->addRule('default', [ 'type' => self::TYPE_STRING, @@ -24,7 +24,7 @@ class AttributeEmail extends AttributeString 'default' => null, 'example' => 'default@example.com', 'array' => false, - 'required' => false, + 'require' => false, ]) ; } diff --git a/src/Appwrite/Utopia/Response/Model/AttributeFloat.php b/src/Appwrite/Utopia/Response/Model/AttributeFloat.php index 66259cfdb..ec90cc7ed 100644 --- a/src/Appwrite/Utopia/Response/Model/AttributeFloat.php +++ b/src/Appwrite/Utopia/Response/Model/AttributeFloat.php @@ -10,21 +10,17 @@ class AttributeFloat extends Attribute public function __construct() { $this - ->addRule('min', [ + ->addRule('format', [ 'type' => self::TYPE_FLOAT, - 'description' => 'Minimum value to enforce on new documents.', + 'description' => 'Float format.', 'default' => null, - 'example' => 0.5, + 'example' => \json_encode([ + 'name' => APP_DATABASE_ATTRIBUTE_FLOAT_RANGE, + 'min' => 1.5, + 'max' => 2.5, + ]), 'array' => false, - 'required' => false, - ]) - ->addRule('max', [ - 'type' => self::TYPE_FLOAT, - 'description' => 'Minimum value to enforce on new documents.', - 'default' => null, - 'example' => 2.5, - 'array' => false, - 'required' => false, + 'require' => false, ]) ->addRule('default', [ 'type' => self::TYPE_FLOAT, @@ -32,7 +28,7 @@ class AttributeFloat extends Attribute 'default' => null, 'example' => 2.5, 'array' => false, - 'required' => false, + 'require' => false, ]) ; } diff --git a/src/Appwrite/Utopia/Response/Model/AttributeIP.php b/src/Appwrite/Utopia/Response/Model/AttributeIP.php index a380e6e4d..ef6f5b4db 100644 --- a/src/Appwrite/Utopia/Response/Model/AttributeIP.php +++ b/src/Appwrite/Utopia/Response/Model/AttributeIP.php @@ -13,10 +13,10 @@ class AttributeIP extends AttributeString ->addRule('format', [ 'type' => self::TYPE_STRING, 'description' => 'String format.', - 'default' => 'ip', - 'example' => 'ip', + 'default' => \json_encode(['name'=>APP_DATABASE_ATTRIBUTE_IP]), + 'example' => \json_encode(['name'=>APP_DATABASE_ATTRIBUTE_IP]), 'array' => false, - 'required' => true, + 'require' => true, ]) ->addRule('default', [ 'type' => self::TYPE_STRING, @@ -24,7 +24,7 @@ class AttributeIP extends AttributeString 'default' => null, 'example' => '192.0.2.0', 'array' => false, - 'required' => false, + 'require' => false, ]) ; } diff --git a/src/Appwrite/Utopia/Response/Model/AttributeInteger.php b/src/Appwrite/Utopia/Response/Model/AttributeInteger.php index 3092a7145..161a9cb9b 100644 --- a/src/Appwrite/Utopia/Response/Model/AttributeInteger.php +++ b/src/Appwrite/Utopia/Response/Model/AttributeInteger.php @@ -10,21 +10,17 @@ class AttributeInteger extends Attribute public function __construct() { $this - ->addRule('min', [ - 'type' => self::TYPE_INTEGER, - 'description' => 'Minimum value to enforce on new documents.', + ->addRule('format', [ + 'type' => self::TYPE_STRING, + 'description' => 'Integer format.', 'default' => null, - 'example' => 0, + 'example' => \json_encode([ + 'name' => APP_DATABASE_ATTRIBUTE_INT_RANGE, + 'min' => 0, + 'max' => 10, + ]), 'array' => false, - 'required' => false, - ]) - ->addRule('max', [ - 'type' => self::TYPE_INTEGER, - 'description' => 'Minimum value to enforce on new documents.', - 'default' => null, - 'example' => 10, - 'array' => false, - 'required' => false, + 'require' => false, ]) ->addRule('default', [ 'type' => self::TYPE_INTEGER, @@ -32,7 +28,7 @@ class AttributeInteger extends Attribute 'default' => null, 'example' => 10, 'array' => false, - 'required' => false, + 'require' => false, ]) ; } diff --git a/src/Appwrite/Utopia/Response/Model/AttributeString.php b/src/Appwrite/Utopia/Response/Model/AttributeString.php index 29a86a4b2..9dd4b1829 100644 --- a/src/Appwrite/Utopia/Response/Model/AttributeString.php +++ b/src/Appwrite/Utopia/Response/Model/AttributeString.php @@ -22,7 +22,7 @@ class AttributeString extends Attribute 'default' => null, 'example' => 'default', 'array' => false, - 'required' => false, + 'require' => false, ]) ; } diff --git a/src/Appwrite/Utopia/Response/Model/AttributeURL.php b/src/Appwrite/Utopia/Response/Model/AttributeURL.php index 52a549e2a..20e7f09fa 100644 --- a/src/Appwrite/Utopia/Response/Model/AttributeURL.php +++ b/src/Appwrite/Utopia/Response/Model/AttributeURL.php @@ -13,8 +13,8 @@ class AttributeURL extends AttributeString ->addRule('format', [ 'type' => self::TYPE_STRING, 'description' => 'String format.', - 'default' => 'url', - 'example' => 'url', + 'default' => \json_encode(['name'=>APP_DATABASE_ATTRIBUTE_URL]), + 'example' => \json_encode(['name'=>APP_DATABASE_ATTRIBUTE_URL]), 'array' => false, 'required' => true, ]) @@ -24,7 +24,7 @@ class AttributeURL extends AttributeString 'default' => null, 'example' => 'http://example.com', 'array' => false, - 'required' => false, + 'require' => false, ]) ; }