appwrite/src/Appwrite/Utopia/Response/Model/Bucket.php

<?php

namespace Appwrite\Utopia\Response\Model;

use Appwrite\Utopia\Response;
use Appwrite\Utopia\Response\Model;

class Bucket extends Model
{

    public function __construct()
    {
        $this
        ->addRule('$id', [
            'type' => self::TYPE_STRING,
            'description' => 'Bucket ID.',
            'default' => '',
            'example' => '5e5ea5c16897e',
        ])
        ->addRule('$read', [
            'type' => self::TYPE_STRING,
            'description' => 'File read permissions.',
            'default' => [],
            'example' => ['role:all'],
            'array' => true,
        ])
        ->addRule('$write', [
            'type' => self::TYPE_STRING,
            'description' => 'File write permissions.',
            'default' => [],
            'example' => ['user:608f9da25e7e1'],
            'array' => true,
        ])
        ->addRule('permission', [
            'type' => self::TYPE_STRING,
            'description' => 'Bucket permission model. Possible values: `bucket` or `file`',
            'default' => '',
            'example' => 'file',
        ])
        ->addRule('dateCreated', [
            'type' => self::TYPE_INTEGER,
            'description' => 'Bucket creation date in Unix timestamp.',
            'default' => 0,
            'example' => 1592981250,
        ])
        ->addRule('dateUpdated', [
            'type' => self::TYPE_INTEGER,
            'description' => 'Bucket update date in Unix timestamp.',
            'default' => 0,
            'example' => 1592981250,
        ])
        ->addRule('name', [
            'type' => self::TYPE_STRING,
            'description' => 'Bucket name.',
            'default' => '',
            'example' => 'Documents',
        ])
        ->addRule('enabled', [
            'type' => self::TYPE_BOOLEAN,
            'description' => 'Bucket enabled.',
            'default' => true,
            'example' => false,
        ])
        ->addRule('adapter', [
            'type' => self::TYPE_STRING,
            'description' => 'Storage adapter.',
            'default' => '',
            'example' => 'local',
        ])
        ->addRule('adapterCredentials', [
            'type' => self::TYPE_JSON,
            'description' => 'Storage adapter credentials.',
            'default' => new \stdClass,
            'example' => ['key' => 'value'],
        ])
        ->addRule('maximumFileSize', [
            'type' => self::TYPE_INTEGER,
            'description' => 'Maximum file size supported.',
            'default' => 0,
            'example' => 100,
        ])
        ->addRule('allowedFileExtensions', [
            'type' => self::TYPE_STRING,
            'description' => 'Allowed file extensions.',
            'default' => [],
            'example' => ['jpg', 'png'],
            'array' => true
        ])
        ->addRule('encryption', [
            'type' => self::TYPE_BOOLEAN,
            'description' => 'Bucket is encrypted.',
            'default' => true,
            'example' => false,
        ])
        ->addRule('antiVirus', [
            'type' => self::TYPE_BOOLEAN,
            'description' => 'Virus scanning is enabled.',
            'default' => true,
            'example' => false,
        ])
    ;
    }

    /**
     * Get Name
     *
     * @return string
     */
    public function getName(): string
    {
        return 'Bucket';
    }

    /**
     * Get Collection
     *
     * @return string
     */
    public function getType(): string
    {
        return Response::MODEL_BUCKET;
    }
}