123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335 |
- <?php
- declare(strict_types=1);
- /**
- * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
- * SPDX-License-Identifier: AGPL-3.0-or-later
- */
- namespace OCP\FilesMetadata\Model;
- use JsonSerializable;
- use OCP\FilesMetadata\Exceptions\FilesMetadataNotFoundException;
- use OCP\FilesMetadata\Exceptions\FilesMetadataTypeException;
- /**
- * Model that store the value of a single metadata.
- * It stores the value, its type and the index status.
- *
- * @see IFilesMetadata
- * @since 28.0.0
- */
- interface IMetadataValueWrapper extends JsonSerializable {
- /** @since 28.0.0 */
- public const TYPE_STRING = 'string';
- /** @since 28.0.0 */
- public const TYPE_INT = 'int';
- /** @since 28.0.0 */
- public const TYPE_FLOAT = 'float';
- /** @since 28.0.0 */
- public const TYPE_BOOL = 'bool';
- /** @since 28.0.0 */
- public const TYPE_ARRAY = 'array';
- /** @since 28.0.0 */
- public const TYPE_STRING_LIST = 'string[]';
- /** @since 28.0.0 */
- public const TYPE_INT_LIST = 'int[]';
- /** @since 28.0.0 */
- public const EDIT_FORBIDDEN = 0;
- /** @since 28.0.0 */
- public const EDIT_REQ_OWNERSHIP = 1;
- /** @since 28.0.0 */
- public const EDIT_REQ_WRITE_PERMISSION = 2;
- /** @since 28.0.0 */
- public const EDIT_REQ_READ_PERMISSION = 3;
- /**
- * Unless a call of import() to deserialize an object is expected, a valid value type is needed here.
- *
- * @param string $type value type
- *
- * @see self::TYPE_INT
- * @see self::TYPE_FLOAT
- * @see self::TYPE_BOOL
- * @see self::TYPE_ARRAY
- * @see self::TYPE_STRING_LIST
- * @see self::TYPE_INT_LIST
- * @see self::TYPE_STRING
- * @since 28.0.0
- */
- public function __construct(string $type);
- /**
- * returns the value type
- *
- * @return string value type
- * @see self::TYPE_INT
- * @see self::TYPE_FLOAT
- * @see self::TYPE_BOOL
- * @see self::TYPE_ARRAY
- * @see self::TYPE_STRING_LIST
- * @see self::TYPE_INT_LIST
- * @see self::TYPE_STRING
- * @since 28.0.0
- */
- public function getType(): string;
- /**
- * returns if the set value type is the one expected
- *
- * @param string $type value type
- *
- * @return bool
- * @see self::TYPE_INT
- * @see self::TYPE_FLOAT
- * @see self::TYPE_BOOL
- * @see self::TYPE_ARRAY
- * @see self::TYPE_STRING_LIST
- * @see self::TYPE_INT_LIST
- * @see self::TYPE_STRING
- * @since 28.0.0
- */
- public function isType(string $type): bool;
- /**
- * throws an exception if the type is not correctly set
- *
- * @param string $type value type
- *
- * @return self
- * @throws FilesMetadataTypeException if type cannot be confirmed
- * @see self::TYPE_INT
- * @see self::TYPE_BOOL
- * @see self::TYPE_ARRAY
- * @see self::TYPE_STRING_LIST
- * @see self::TYPE_INT_LIST
- * @see self::TYPE_STRING
- * @see self::TYPE_FLOAT
- * @since 28.0.0
- */
- public function assertType(string $type): self;
- /**
- * set a string value
- *
- * @param string $value string to be set as value
- *
- * @return self
- * @throws FilesMetadataTypeException if wrapper was not set to store a string
- * @since 28.0.0
- */
- public function setValueString(string $value): self;
- /**
- * set a int value
- *
- * @param int $value int to be set as value
- *
- * @return self
- * @throws FilesMetadataTypeException if wrapper was not set to store an int
- * @since 28.0.0
- */
- public function setValueInt(int $value): self;
- /**
- * set a float value
- *
- * @param float $value float to be set as value
- *
- * @return self
- * @throws FilesMetadataTypeException if wrapper was not set to store a float
- * @since 28.0.0
- */
- public function setValueFloat(float $value): self;
- /**
- * set a bool value
- *
- * @param bool $value bool to be set as value
- *
- * @return self
- * @throws FilesMetadataTypeException if wrapper was not set to store a bool
- * @since 28.0.0
- */
- public function setValueBool(bool $value): self;
- /**
- * set an array value
- *
- * @param array $value array to be set as value
- *
- * @return self
- * @throws FilesMetadataTypeException if wrapper was not set to store an array
- * @since 28.0.0
- */
- public function setValueArray(array $value): self;
- /**
- * set a string list value
- *
- * @param string[] $value string list to be set as value
- *
- * @return self
- * @throws FilesMetadataTypeException if wrapper was not set to store a string list
- * @since 28.0.0
- */
- public function setValueStringList(array $value): self;
- /**
- * set an int list value
- *
- * @param int[] $value int list to be set as value
- *
- * @return self
- * @throws FilesMetadataTypeException if wrapper was not set to store an int list
- * @since 28.0.0
- */
- public function setValueIntList(array $value): self;
- /**
- * get stored value
- *
- * @return string set value
- * @throws FilesMetadataTypeException if wrapper was not set to store a string
- * @throws FilesMetadataNotFoundException if value is not set
- * @since 28.0.0
- */
- public function getValueString(): string;
- /**
- * get stored value
- *
- * @return int set value
- * @throws FilesMetadataTypeException if wrapper was not set to store an int
- * @throws FilesMetadataNotFoundException if value is not set
- * @since 28.0.0
- */
- public function getValueInt(): int;
- /**
- * get stored value
- *
- * @return float set value
- * @throws FilesMetadataTypeException if wrapper was not set to store a float
- * @throws FilesMetadataNotFoundException if value is not set
- * @since 28.0.0
- */
- public function getValueFloat(): float;
- /**
- * get stored value
- *
- * @return bool set value
- * @throws FilesMetadataTypeException if wrapper was not set to store a bool
- * @throws FilesMetadataNotFoundException if value is not set
- * @since 28.0.0
- */
- public function getValueBool(): bool;
- /**
- * get stored value
- *
- * @return array set value
- * @throws FilesMetadataTypeException if wrapper was not set to store an array
- * @throws FilesMetadataNotFoundException if value is not set
- * @since 28.0.0
- */
- public function getValueArray(): array;
- /**
- * get stored value
- *
- * @return string[] set value
- * @throws FilesMetadataTypeException if wrapper was not set to store a string list
- * @throws FilesMetadataNotFoundException if value is not set
- * @since 28.0.0
- */
- public function getValueStringList(): array;
- /**
- * get stored value
- *
- * @return int[] set value
- * @throws FilesMetadataTypeException if wrapper was not set to store an int list
- * @throws FilesMetadataNotFoundException if value is not set
- * @since 28.0.0
- */
- public function getValueIntList(): array;
- /**
- * get stored value
- *
- * @return string|int|float|bool|array|string[]|int[] set value
- * @throws FilesMetadataNotFoundException if value is not set
- * @since 28.0.0
- */
- public function getValueAny(): mixed;
- /**
- * get stored etag value
- *
- * @return string stored etag
- * @since 29.0.0
- */
- public function getEtag(): string;
- /**
- * set etag value
- *
- * @param string $etag etag value
- *
- * @return self
- * @since 29.0.0
- */
- public function setEtag(string $etag): self;
- /**
- * @param bool $indexed TRUE to set the stored value as an indexed value
- *
- * @return self
- * @since 28.0.0
- */
- public function setIndexed(bool $indexed): self;
- /**
- * returns if value is an indexed value
- *
- * @return bool TRUE if value is an indexed value
- * @since 28.0.0
- */
- public function isIndexed(): bool;
- /**
- * set remote edit permission
- * (Webdav PROPPATCH)
- *
- * @param int $permission edit permission
- *
- * @return self
- * @since 28.0.0
- */
- public function setEditPermission(int $permission): self;
- /**
- * get remote edit permission
- * (Webdav PROPPATCH)
- *
- * @return int edit permission
- * @since 28.0.0
- */
- public function getEditPermission(): int;
- /**
- * deserialize the object from a json
- *
- * @param array $data serialized version of the object
- *
- * @return self
- * @see jsonSerialize
- * @since 28.0.0
- */
- public function import(array $data): self;
- }
|