mbk-lab
/
nextcloud
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

fixing phpdoc 

Signed-off-by: Maxence Lange <maxence@artificial-owl.com>
This commit is contained in:
Maxence Lange 2019-03-04 09:49:29 -01:00
parent 3bdc78e981
commit adfadf821b
4 changed files with 73 additions and 63 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
lib/private/FullTextSearch/Model/DocumentAccess.php
View File

@ -51,7 +51,7 @@ use OCP\FullTextSearch\Model\IDocumentAccess;
* *
* @see IIndexDocument::setAccess * @see IIndexDocument::setAccess
* *
* @since 15.0.0 * @since 16.0.0
* *
* @package OC\FullTextSearch\Model * @package OC\FullTextSearch\Model
*/ */
@ -80,7 +80,7 @@ final class DocumentAccess implements IDocumentAccess, JsonSerializable {
/** /**
* Owner of the document can be set at the init of the object. * Owner of the document can be set at the init of the object.
* *
* @since 15.0.0 * @since 16.0.0
* *
* IDocumentAccess constructor. * IDocumentAccess constructor.
* *
@ -94,7 +94,7 @@ final class DocumentAccess implements IDocumentAccess, JsonSerializable {
/** /**
* Set the Owner of the document. * Set the Owner of the document.
* *
* @since 15.0.0 * @since 16.0.0
* *
* @param string $ownerId * @param string $ownerId
* *
@ -109,7 +109,7 @@ final class DocumentAccess implements IDocumentAccess, JsonSerializable {
/** /**
* Get the Owner of the document. * Get the Owner of the document.
* *
* @since 15.0.0 * @since 16.0.0
* *
* @return string * @return string
*/ */
@ -121,7 +121,7 @@ final class DocumentAccess implements IDocumentAccess, JsonSerializable {
/** /**
* Set the viewer of the document. * Set the viewer of the document.
* *
* @since 15.0.0 * @since 16.0.0
* *
* @param string $viewerId * @param string $viewerId
* *
@ -136,7 +136,7 @@ final class DocumentAccess implements IDocumentAccess, JsonSerializable {
/** /**
* Get the viewer of the document. * Get the viewer of the document.
* *
* @since 15.0.0 * @since 16.0.0
* *
* @return string * @return string
*/ */
@ -148,7 +148,7 @@ final class DocumentAccess implements IDocumentAccess, JsonSerializable {
/** /**
* Set the list of users that have read access to the document. * Set the list of users that have read access to the document.
* *
* @since 15.0.0 * @since 16.0.0
* *
* @param array $users * @param array $users
* *
@ -163,7 +163,7 @@ final class DocumentAccess implements IDocumentAccess, JsonSerializable {
/** /**
* Add an entry to the list of users that have read access to the document. * 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 * @param string $user
* *
@ -179,7 +179,7 @@ final class DocumentAccess implements IDocumentAccess, JsonSerializable {
* Add multiple entries to the list of users that have read access to the * Add multiple entries to the list of users that have read access to the
* document. * document.
* *
* @since 15.0.0 * @since 16.0.0
* *
* @param array $users * @param array $users
* *
@ -194,7 +194,7 @@ final class DocumentAccess implements IDocumentAccess, JsonSerializable {
/** /**
* Get the complete list of users that have read access to the document. * Get the complete list of users that have read access to the document.
* *
* @since 15.0.0 * @since 16.0.0
* *
* @return array * @return array
*/ */
@ -206,7 +206,7 @@ final class DocumentAccess implements IDocumentAccess, JsonSerializable {
/** /**
* Set the list of groups that have read access to the document. * Set the list of groups that have read access to the document.
* *
* @since 15.0.0 * @since 16.0.0
* *
* @param array $groups * @param array $groups
* *
@ -221,7 +221,7 @@ final class DocumentAccess implements IDocumentAccess, JsonSerializable {
/** /**
* Add an entry to the list of groups that have read access to the document. * 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 * @param string $group
* *
@ -237,7 +237,7 @@ final class DocumentAccess implements IDocumentAccess, JsonSerializable {
* Add multiple entries to the list of groups that have read access to the * Add multiple entries to the list of groups that have read access to the
* document. * document.
* *
* @since 15.0.0 * @since 16.0.0
* *
* @param array $groups * @param array $groups
* *
@ -252,7 +252,7 @@ final class DocumentAccess implements IDocumentAccess, JsonSerializable {
/** /**
* Get the complete list of groups that have read access to the document. * Get the complete list of groups that have read access to the document.
* *
* @since 15.0.0 * @since 16.0.0
* *
* @return array * @return array
*/ */
@ -264,7 +264,7 @@ final class DocumentAccess implements IDocumentAccess, JsonSerializable {
/** /**
* Set the list of circles that have read access to the document. * Set the list of circles that have read access to the document.
* *
* @since 15.0.0 * @since 16.0.0
* *
* @param array $circles * @param array $circles
* *
@ -279,7 +279,7 @@ final class DocumentAccess implements IDocumentAccess, JsonSerializable {
/** /**
* Add an entry to the list of circles that have read access to the document. * 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 * @param string $circle
* *
@ -295,7 +295,7 @@ final class DocumentAccess implements IDocumentAccess, JsonSerializable {
* Add multiple entries to the list of groups that have read access to the * Add multiple entries to the list of groups that have read access to the
* document. * document.
* *
* @since 15.0.0 * @since 16.0.0
* *
* @param array $circles * @param array $circles
* *
@ -310,7 +310,7 @@ final class DocumentAccess implements IDocumentAccess, JsonSerializable {
/** /**
* Get the complete list of circles that have read access to the document. * Get the complete list of circles that have read access to the document.
* *
* @since 15.0.0 * @since 16.0.0
* *
* @return array * @return array
*/ */
@ -322,7 +322,7 @@ final class DocumentAccess implements IDocumentAccess, JsonSerializable {
/** /**
* Set the list of links that have read access to the document. * Set the list of links that have read access to the document.
* *
* @since 15.0.0 * @since 16.0.0
* *
* @param array $links * @param array $links
* *
@ -337,7 +337,7 @@ final class DocumentAccess implements IDocumentAccess, JsonSerializable {
/** /**
* Get the list of links that have read access to the document. * Get the list of links that have read access to the document.
* *
* @since 15.0.0 * @since 16.0.0
* *
* @return array * @return array
*/ */
@ -347,7 +347,7 @@ final class DocumentAccess implements IDocumentAccess, JsonSerializable {
/** /**
* @since 15.0.0 * @since 16.0.0
* *
* @return array * @return array
*/ */

40
lib/public/FullTextSearch/Model/IDocumentAccess.php
View File

@ -47,7 +47,7 @@ namespace OCP\FullTextSearch\Model;
* *
* @see IIndexDocument::setAccess * @see IIndexDocument::setAccess
* *
* @since 15.0.0 * @since 16.0.0
* *
* @package OCP\FullTextSearch\Model * @package OCP\FullTextSearch\Model
*/ */
@ -57,7 +57,7 @@ interface IDocumentAccess {
/** /**
* Owner of the document can be set at the init of the object. * Owner of the document can be set at the init of the object.
* *
* @since 15.0.0 * @since 16.0.0
* *
* IDocumentAccess constructor. * IDocumentAccess constructor.
* *
@ -69,7 +69,7 @@ interface IDocumentAccess {
/** /**
* Set the Owner of the document. * Set the Owner of the document.
* *
* @since 15.0.0 * @since 16.0.0
* *
* @param string $ownerId * @param string $ownerId
* *
@ -80,7 +80,7 @@ interface IDocumentAccess {
/** /**
* Get the Owner of the document. * Get the Owner of the document.
* *
* @since 15.0.0 * @since 16.0.0
* *
* @return string * @return string
*/ */
@ -90,7 +90,7 @@ interface IDocumentAccess {
/** /**
* Set the viewer of the document. * Set the viewer of the document.
* *
* @since 15.0.0 * @since 16.0.0
* *
* @param string $viewerId * @param string $viewerId
* *
@ -101,7 +101,7 @@ interface IDocumentAccess {
/** /**
* Get the viewer of the document. * Get the viewer of the document.
* *
* @since 15.0.0 * @since 16.0.0
* *
* @return string * @return string
*/ */
@ -111,7 +111,7 @@ interface IDocumentAccess {
/** /**
* Set the list of users that have read access to the document. * Set the list of users that have read access to the document.
* *
* @since 15.0.0 * @since 16.0.0
* *
* @param array $users * @param array $users
* *
@ -122,7 +122,7 @@ interface IDocumentAccess {
/** /**
* Add an entry to the list of users that have read access to the document. * 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 * @param string $user
* *
@ -134,7 +134,7 @@ interface IDocumentAccess {
* Add multiple entries to the list of users that have read access to the * Add multiple entries to the list of users that have read access to the
* document. * document.
* *
* @since 15.0.0 * @since 16.0.0
* *
* @param array $users * @param array $users
* *
@ -145,7 +145,7 @@ interface IDocumentAccess {
/** /**
* Get the complete list of users that have read access to the document. * Get the complete list of users that have read access to the document.
* *
* @since 15.0.0 * @since 16.0.0
* *
* @return array * @return array
*/ */
@ -155,7 +155,7 @@ interface IDocumentAccess {
/** /**
* Set the list of groups that have read access to the document. * Set the list of groups that have read access to the document.
* *
* @since 15.0.0 * @since 16.0.0
* *
* @param array $groups * @param array $groups
* *
@ -166,7 +166,7 @@ interface IDocumentAccess {
/** /**
* Add an entry to the list of groups that have read access to the document. * 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 * @param string $group
* *
@ -178,7 +178,7 @@ interface IDocumentAccess {
* Add multiple entries to the list of groups that have read access to the * Add multiple entries to the list of groups that have read access to the
* document. * document.
* *
* @since 15.0.0 * @since 16.0.0
* *
* @param array $groups * @param array $groups
* *
@ -189,7 +189,7 @@ interface IDocumentAccess {
/** /**
* Get the complete list of groups that have read access to the document. * Get the complete list of groups that have read access to the document.
* *
* @since 15.0.0 * @since 16.0.0
* *
* @return array * @return array
*/ */
@ -199,7 +199,7 @@ interface IDocumentAccess {
/** /**
* Set the list of circles that have read access to the document. * Set the list of circles that have read access to the document.
* *
* @since 15.0.0 * @since 16.0.0
* *
* @param array $circles * @param array $circles
* *
@ -210,7 +210,7 @@ interface IDocumentAccess {
/** /**
* Add an entry to the list of circles that have read access to the document. * 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 * @param string $circle
* *
@ -222,7 +222,7 @@ interface IDocumentAccess {
* Add multiple entries to the list of groups that have read access to the * Add multiple entries to the list of groups that have read access to the
* document. * document.
* *
* @since 15.0.0 * @since 16.0.0
* *
* @param array $circles * @param array $circles
* *
@ -233,7 +233,7 @@ interface IDocumentAccess {
/** /**
* Get the complete list of circles that have read access to the document. * Get the complete list of circles that have read access to the document.
* *
* @since 15.0.0 * @since 16.0.0
* *
* @return array * @return array
*/ */
@ -243,7 +243,7 @@ interface IDocumentAccess {
/** /**
* Set the list of links that have read access to the document. * Set the list of links that have read access to the document.
* *
* @since 15.0.0 * @since 16.0.0
* *
* @param array $links * @param array $links
* *
@ -254,7 +254,7 @@ interface IDocumentAccess {
/** /**
* Get the list of links that have read access to the document. * Get the list of links that have read access to the document.
* *
* @since 15.0.0 * @since 16.0.0
* *
* @return array * @return array
*/ */

32
lib/public/FullTextSearch/Model/ISearchOption.php
View File

@ -32,7 +32,7 @@ namespace OCP\FullTextSearch\Model;
/** /**
* @since 15.0.0 * @since 16.0.0
* *
* Interface ISearchOption * Interface ISearchOption
* *
@ -41,9 +41,19 @@ namespace OCP\FullTextSearch\Model;
interface ISearchOption { interface ISearchOption {
/**
* @since 16.0.0
*/
const CHECKBOX = 'checkbox'; const CHECKBOX = 'checkbox';
/**
* @since 16.0.0
*/
const INPUT = 'input'; const INPUT = 'input';
/**
* @since 16.0.0
*/
const INPUT_SMALL = 'small'; const INPUT_SMALL = 'small';
@ -54,7 +64,7 @@ interface ISearchOption {
* *
* @see ISearchRequest::getOption * @see ISearchRequest::getOption
* *
* @since 15.0.0 * @since 16.0.0
* *
* @param string $name * @param string $name
* *
@ -65,7 +75,7 @@ interface ISearchOption {
/** /**
* Get the name/key of the option. * Get the name/key of the option.
* *
* @since 15.0.0 * @since 16.0.0
* *
* @return string * @return string
*/ */
@ -75,7 +85,7 @@ interface ISearchOption {
/** /**
* Set the title/display name of the option. * Set the title/display name of the option.
* *
* @since 15.0.0 * @since 16.0.0
* *
* @param string $title * @param string $title
* *
@ -86,7 +96,7 @@ interface ISearchOption {
/** /**
* Get the title of the option. * Get the title of the option.
* *
* @since 15.0.0 * @since 16.0.0
* *
* @return string * @return string
*/ */
@ -97,7 +107,7 @@ interface ISearchOption {
* Set the type of the option. * Set the type of the option.
* $type can be ISearchOption::CHECKBOX or ISearchOption::INPUT * $type can be ISearchOption::CHECKBOX or ISearchOption::INPUT
* *
* @since 15.0.0 * @since 16.0.0
* *
* @param string $type * @param string $type
* *
@ -108,7 +118,7 @@ interface ISearchOption {
/** /**
* Get the type of the option. * Get the type of the option.
* *
* @since 15.0.0 * @since 16.0.0
* *
* @return string * @return string
*/ */
@ -119,7 +129,7 @@ interface ISearchOption {
* In case of Type is INPUT, set the size of the input field. * In case of Type is INPUT, set the size of the input field.
* Value can be ISearchOption::INPUT_SMALL or not defined. * Value can be ISearchOption::INPUT_SMALL or not defined.
* *
* @since 15.0.0 * @since 16.0.0
* *
* @param string $size * @param string $size
* *
@ -130,7 +140,7 @@ interface ISearchOption {
/** /**
* Get the size of the INPUT. * Get the size of the INPUT.
* *
* @since 15.0.0 * @since 16.0.0
* *
* @return string * @return string
*/ */
@ -141,7 +151,7 @@ interface ISearchOption {
* In case of Type is , set the placeholder to be displayed in the input * In case of Type is , set the placeholder to be displayed in the input
* field. * field.
* *
* @since 15.0.0 * @since 16.0.0
* *
* @param string $placeholder * @param string $placeholder
* *
@ -152,7 +162,7 @@ interface ISearchOption {
/** /**
* Get the placeholder. * Get the placeholder.
* *
* @since 15.0.0 * @since 16.0.0
* *
* @return string * @return string
*/ */

22
lib/public/FullTextSearch/Model/ISearchTemplate.php
View File

@ -55,7 +55,7 @@ use OCP\FullTextSearch\IFullTextSearchProvider;
* *
* @see IFullTextSearchProvider::getSearchTemplate * @see IFullTextSearchProvider::getSearchTemplate
* *
* @since 15.0.0 * @since 16.0.0
* *
* @package OCP\FullTextSearch\Model * @package OCP\FullTextSearch\Model
*/ */
@ -66,7 +66,7 @@ interface ISearchTemplate {
* Set the class of the icon to be displayed in the left panel of the * 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. * FullTextSearch navigation page, in front of the related Content Provider.
* *
* @since 15.0.0 * @since 16.0.0
* *
* @param string $class * @param string $class
* *
@ -77,7 +77,7 @@ interface ISearchTemplate {
/** /**
* Get the class of the icon. * Get the class of the icon.
* *
* @since 15.0.0 * @since 16.0.0
* *
* @return string * @return string
*/ */
@ -87,7 +87,7 @@ interface ISearchTemplate {
/** /**
* Set the path of a CSS file that will be loaded when needed. * Set the path of a CSS file that will be loaded when needed.
* *
* @since 15.0.0 * @since 16.0.0
* *
* @param string $css * @param string $css
* *
@ -98,7 +98,7 @@ interface ISearchTemplate {
/** /**
* Get the path of the CSS file. * Get the path of the CSS file.
* *
* @since 15.0.0 * @since 16.0.0
* *
* @return string * @return string
*/ */
@ -111,7 +111,7 @@ interface ISearchTemplate {
* This should only be used if your Content Provider needs to set options in * This should only be used if your Content Provider needs to set options in
* a way not generated by FullTextSearch * a way not generated by FullTextSearch
* *
* @since 15.0.0 * @since 16.0.0
* *
* @param string $template * @param string $template
* *
@ -122,7 +122,7 @@ interface ISearchTemplate {
/** /**
* Get the path of the template file. * Get the path of the template file.
* *
* @since 15.0.0 * @since 16.0.0
* *
* @return string * @return string
*/ */
@ -135,7 +135,7 @@ interface ISearchTemplate {
* *
* @see ISearchOption * @see ISearchOption
* *
* @since 15.0.0 * @since 16.0.0
* *
* @param ISearchOption $option * @param ISearchOption $option
* *
@ -146,7 +146,7 @@ interface ISearchTemplate {
/** /**
* Get all options to be displayed in the Panel. * Get all options to be displayed in the Panel.
* *
* @since 15.0.0 * @since 16.0.0
* *
* @return ISearchOption[] * @return ISearchOption[]
*/ */
@ -158,7 +158,7 @@ interface ISearchTemplate {
* *
* @see ISearchOption * @see ISearchOption
* *
* @since 15.0.0 * @since 16.0.0
* *
* @param ISearchOption $option * @param ISearchOption $option
* *
@ -169,7 +169,7 @@ interface ISearchTemplate {
/** /**
* Get all options to be displayed in the FullTextSearch navigation page. * Get all options to be displayed in the FullTextSearch navigation page.
* *
* @since 15.0.0 * @since 16.0.0
* *
* @return array * @return array
*/ */