*
* @see IIndexDocument::setAccess
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @package OC\FullTextSearch\Model
*/
/**
* Owner of the document can be set at the init of the object.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* IDocumentAccess constructor.
*
/**
* Set the Owner of the document.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @param string $ownerId
*
/**
* Get the Owner of the document.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @return string
*/
/**
* Set the viewer of the document.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @param string $viewerId
*
/**
* Get the viewer of the document.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @return string
*/
/**
* Set the list of users that have read access to the document.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @param array $users
*
/**
* Add an entry to the list of users that have read access to the document.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @param string $user
*
* Add multiple entries to the list of users that have read access to the
* document.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @param array $users
*
/**
* Get the complete list of users that have read access to the document.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @return array
*/
/**
* Set the list of groups that have read access to the document.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @param array $groups
*
/**
* Add an entry to the list of groups that have read access to the document.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @param string $group
*
* Add multiple entries to the list of groups that have read access to the
* document.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @param array $groups
*
/**
* Get the complete list of groups that have read access to the document.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @return array
*/
/**
* Set the list of circles that have read access to the document.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @param array $circles
*
/**
* Add an entry to the list of circles that have read access to the document.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @param string $circle
*
* Add multiple entries to the list of groups that have read access to the
* document.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @param array $circles
*
/**
* Get the complete list of circles that have read access to the document.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @return array
*/
/**
* Set the list of links that have read access to the document.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @param array $links
*
/**
* Get the list of links that have read access to the document.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @return array
*/
/**
- * @since 15.0.0
+ * @since 16.0.0
*
* @return array
*/
*
* @see IIndexDocument::setAccess
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @package OCP\FullTextSearch\Model
*/
/**
* Owner of the document can be set at the init of the object.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* IDocumentAccess constructor.
*
/**
* Set the Owner of the document.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @param string $ownerId
*
/**
* Get the Owner of the document.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @return string
*/
/**
* Set the viewer of the document.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @param string $viewerId
*
/**
* Get the viewer of the document.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @return string
*/
/**
* Set the list of users that have read access to the document.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @param array $users
*
/**
* Add an entry to the list of users that have read access to the document.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @param string $user
*
* Add multiple entries to the list of users that have read access to the
* document.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @param array $users
*
/**
* Get the complete list of users that have read access to the document.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @return array
*/
/**
* Set the list of groups that have read access to the document.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @param array $groups
*
/**
* Add an entry to the list of groups that have read access to the document.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @param string $group
*
* Add multiple entries to the list of groups that have read access to the
* document.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @param array $groups
*
/**
* Get the complete list of groups that have read access to the document.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @return array
*/
/**
* Set the list of circles that have read access to the document.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @param array $circles
*
/**
* Add an entry to the list of circles that have read access to the document.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @param string $circle
*
* Add multiple entries to the list of groups that have read access to the
* document.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @param array $circles
*
/**
* Get the complete list of circles that have read access to the document.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @return array
*/
/**
* Set the list of links that have read access to the document.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @param array $links
*
/**
* Get the list of links that have read access to the document.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @return array
*/
/**
- * @since 15.0.0
+ * @since 16.0.0
*
* Interface ISearchOption
*
interface ISearchOption {
+ /**
+ * @since 16.0.0
+ */
const CHECKBOX = 'checkbox';
+
+ /**
+ * @since 16.0.0
+ */
const INPUT = 'input';
+ /**
+ * @since 16.0.0
+ */
const INPUT_SMALL = 'small';
*
* @see ISearchRequest::getOption
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @param string $name
*
/**
* Get the name/key of the option.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @return string
*/
/**
* Set the title/display name of the option.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @param string $title
*
/**
* Get the title of the option.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @return string
*/
* Set the type of the option.
* $type can be ISearchOption::CHECKBOX or ISearchOption::INPUT
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @param string $type
*
/**
* Get the type of the option.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @return string
*/
* In case of Type is INPUT, set the size of the input field.
* Value can be ISearchOption::INPUT_SMALL or not defined.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @param string $size
*
/**
* Get the size of the INPUT.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @return string
*/
* In case of Type is , set the placeholder to be displayed in the input
* field.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @param string $placeholder
*
/**
* Get the placeholder.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @return string
*/
*
* @see IFullTextSearchProvider::getSearchTemplate
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @package OCP\FullTextSearch\Model
*/
* Set the class of the icon to be displayed in the left panel of the
* FullTextSearch navigation page, in front of the related Content Provider.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @param string $class
*
/**
* Get the class of the icon.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @return string
*/
/**
* Set the path of a CSS file that will be loaded when needed.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @param string $css
*
/**
* Get the path of the CSS file.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @return string
*/
* This should only be used if your Content Provider needs to set options in
* a way not generated by FullTextSearch
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @param string $template
*
/**
* Get the path of the template file.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @return string
*/
*
* @see ISearchOption
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @param ISearchOption $option
*
/**
* Get all options to be displayed in the Panel.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @return ISearchOption[]
*/
*
* @see ISearchOption
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @param ISearchOption $option
*
/**
* Get all options to be displayed in the FullTextSearch navigation page.
*
- * @since 15.0.0
+ * @since 16.0.0
*
* @return array
*/
projects / nextcloud-server.git / commitdiff