* * @author Maxence Lange * * @license GNU AGPL version 3 or any later version * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as * published by the Free Software Foundation, either version 3 of the * License, or (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public License * along with this program. If not, see . * */ namespace OCP\FilesMetadata\Model; /** * Model that help building queries with metadata and metadata indexes * * @since 28.0.0 */ interface IMetadataQuery { /** @since 28.0.0 */ public const EXTRA = 'metadata'; /** * Add metadata linked to file id to the query * * @see self::extractMetadata() * @since 28.0.0 */ public function retrieveMetadata(): void; /** * extract metadata from a result row * * @param array $row result row * * @return IFilesMetadata metadata * @see self::retrieveMetadata() * @since 28.0.0 */ public function extractMetadata(array $row): IFilesMetadata; /** * join the metadata_index table, based on a metadataKey. * This will prep the query for condition based on this specific metadataKey. * If a link to the metadataKey already exists, returns known alias. * * TODO: investigate how to support a search done on multiple values for same key (AND). * * @param string $metadataKey metadata key * @param bool $enforce limit the request only to existing metadata * * @return string generated table alias * @since 28.0.0 */ public function joinIndex(string $metadataKey, bool $enforce = false): string; /** * returns the name of the field for metadata key to be used in query expressions * * @param string $metadataKey metadata key * * @return string table field * @since 28.0.0 */ public function getMetadataKeyField(string $metadataKey): string; /** * returns the name of the field for metadata string value to be used in query expressions * * @param string $metadataKey metadata key * * @return string table field * @since 28.0.0 */ public function getMetadataValueField(string $metadataKey): string; } tive' href='/redmine.git/tree/app/models/group_builtin.rb?h=3.0.3'>treecommit diff stats

path: root/app/models/group_builtin.rb

blob: d6df3e3874d1a41e0b62f6e2c82abeb1a0247f18 (plain)