2021-04-08 20:39:23 +12:00
|
|
|
<?php
|
|
|
|
|
|
|
|
namespace Appwrite\Utopia\Response\Model;
|
|
|
|
|
|
|
|
use Appwrite\Utopia\Response;
|
2022-01-18 05:25:20 +13:00
|
|
|
use Utopia\Database\Document as DatabaseDocument;
|
2021-04-08 20:39:23 +12:00
|
|
|
|
|
|
|
class Document extends Any
|
|
|
|
{
|
|
|
|
/**
|
|
|
|
* Get Name
|
2021-10-07 03:22:38 +13:00
|
|
|
*
|
2021-04-08 20:39:23 +12:00
|
|
|
* @return string
|
|
|
|
*/
|
|
|
|
public function getName(): string
|
|
|
|
{
|
|
|
|
return 'Document';
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2021-12-15 23:19:29 +13:00
|
|
|
* Get Type
|
2021-10-07 03:22:38 +13:00
|
|
|
*
|
2021-04-08 20:39:23 +12:00
|
|
|
* @return string
|
|
|
|
*/
|
|
|
|
public function getType(): string
|
|
|
|
{
|
|
|
|
return Response::MODEL_DOCUMENT;
|
|
|
|
}
|
|
|
|
|
|
|
|
public function __construct()
|
|
|
|
{
|
|
|
|
$this
|
|
|
|
->addRule('$id', [
|
|
|
|
'type' => self::TYPE_STRING,
|
|
|
|
'description' => 'Document ID.',
|
|
|
|
'default' => '',
|
|
|
|
'example' => '5e5ea5c16897e',
|
|
|
|
])
|
|
|
|
->addRule('$collection', [
|
|
|
|
'type' => self::TYPE_STRING,
|
|
|
|
'description' => 'Collection ID.',
|
|
|
|
'default' => '',
|
|
|
|
'example' => '5e5ea5c15117e',
|
|
|
|
])
|
2021-06-11 06:19:10 +12:00
|
|
|
->addRule('$read', [
|
|
|
|
'type' => self::TYPE_STRING,
|
|
|
|
'description' => 'Document read permissions.',
|
|
|
|
'default' => '',
|
2021-07-01 03:10:45 +12:00
|
|
|
'example' => 'role:all',
|
2021-06-11 06:19:10 +12:00
|
|
|
'array' => true,
|
|
|
|
])
|
|
|
|
->addRule('$write', [
|
|
|
|
'type' => self::TYPE_STRING,
|
|
|
|
'description' => 'Document write permissions.',
|
|
|
|
'default' => '',
|
2021-07-01 03:10:45 +12:00
|
|
|
'example' => 'user:608f9da25e7e1',
|
2021-06-11 06:19:10 +12:00
|
|
|
'array' => true,
|
|
|
|
])
|
|
|
|
;
|
2021-04-08 20:39:23 +12:00
|
|
|
}
|
2022-01-18 05:25:20 +13:00
|
|
|
|
|
|
|
public function filter(DatabaseDocument $document): DatabaseDocument
|
|
|
|
{
|
|
|
|
$document->removeAttribute('$internalId');
|
|
|
|
|
|
|
|
return $document;
|
|
|
|
}
|
2021-04-08 20:39:23 +12:00
|
|
|
}
|