NavigationServiceInterface::getDescendants() - Code Metrics - dkd/php-cmis-client - Measure and Improve Code Quality continuously with Scrutinizer

NavigationServiceInterface::getDescendants()
last analyzed 2019-11-19 13:16 UTC

↳ Parent: NavigationServiceInterface

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	11
c	0
b	0
f	0

<?php
namespace Dkd\PhpCmis;

/*
 * This file is part of php-cmis-client.
 *
 * (c) Sascha Egerer <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

use Dkd\PhpCmis\Data\ExtensionDataInterface;
use Dkd\PhpCmis\Data\ObjectDataInterface;
use Dkd\PhpCmis\Data\ObjectInFolderContainerInterface;
use Dkd\PhpCmis\Data\ObjectInFolderListInterface;
use Dkd\PhpCmis\Data\ObjectListInterface;
use Dkd\PhpCmis\Data\ObjectParentDataInterface;
use Dkd\PhpCmis\Enum\IncludeRelationships;
use phpDocumentor\Descriptor\Builder\Reflector\ConstantAssemblerTest;

/**
 * Navigation Service interface.
 *
 * See the CMIS 1.0 and CMIS 1.1 specifications for details on the operations,
 * parameters, exceptions and the domain model.
 */
interface NavigationServiceInterface
{
    /**
     * Gets the list of documents that are checked out that the user has access to.
     *
     * @param string $repositoryId the identifier for the repository
     * @param string $folderId the identifier for the folder
     * @param string|null $filter a comma-separated list of query names that defines which properties must be
     *      returned by the repository (default is repository specific)
     * @param string|null $orderBy a comma-separated list of query names that define the order of the result set.
     *      Each query name must be followed by the ascending modifier "ASC" or the descending modifier "DESC"
     *      (default is repository specific)
     * @param boolean $includeAllowableActions if <code>true</code>, then the repository must return the available
     *      actions for each object in the result set (default is <code>false</code>)
     * @param IncludeRelationships|null $includeRelationships indicates what relationships in which the objects
     *      participate must be returned (default is IncludeRelationships::NONE)
     * @param string $renditionFilter indicates what set of renditions the repository must return whose kind
     * matches this filter (default is "cmis:none")
     * @param integer|null $maxItems the maximum number of items to return in a response
     *      (default is repository specific)
     * @param integer $skipCount number of potential results that the repository MUST skip/page over before
     *      returning any results (default is 0)
     * @param ExtensionDataInterface|null $extension
     * @return ObjectListInterface
     */
    public function getCheckedOutDocs(

        $repositoryId,
        $folderId,
        $filter = null,
        $orderBy = null,
        $includeAllowableActions = false,
        IncludeRelationships $includeRelationships = null,
        $renditionFilter = Constants::RENDITION_NONE,
        $maxItems = null,
        $skipCount = 0,
        ExtensionDataInterface $extension = null
    );

    /**
     * Gets the list of child objects contained in the specified folder.
     *
     * @param string $repositoryId the identifier for the repository
     * @param string $folderId the identifier for the folder
     * @param string|null $filter a comma-separated list of query names that defines which properties must be
     *      returned by the repository (default is repository specific)
     * @param string|null $orderBy a comma-separated list of query names that define the order of the result set.
     *      Each query name must be followed by the ascending modifier "ASC" or the descending modifier "DESC"
     *      (default is repository specific)
     * @param boolean $includeAllowableActions if <code>true</code>, then the repository must return the available
     *      actions for each object in the result set (default is <code>false</code>)
     * @param IncludeRelationships|null $includeRelationships indicates what relationships in which the objects
     *      participate must be returned (default is IncludeRelationships::NONE)
     * @param string $renditionFilter indicates what set of renditions the repository must return whose kind
     *      matches this filter (default is "cmis:none")
     * @param boolean $includePathSegment if <code>true</code>, returns a path segment for each child object for use in
     *      constructing that object's path (default is <code>false</code>)
     * @param integer|null $maxItems the maximum number of items to return in a response
     *      (default is repository specific)
     * @param integer $skipCount number of potential results that the repository MUST skip/page over before
     *      returning any results (default is 0)
     * @param ExtensionDataInterface|null $extension
     * @return ObjectInFolderListInterface
     */
    public function getChildren(

        $repositoryId,
        $folderId,
        $filter = null,
        $orderBy = null,
        $includeAllowableActions = false,
        IncludeRelationships $includeRelationships = null,
        $renditionFilter = Constants::RENDITION_NONE,
        $includePathSegment = false,
        $maxItems = null,
        $skipCount = 0,
        ExtensionDataInterface $extension = null
    );

    /**
     * Gets the set of descendant objects contained in the specified folder or any of its child folders.
     *
     * @param string $repositoryId the identifier for the repository
     * @param string $folderId the identifier for the folder
     * @param integer $depth the number of levels of depth in the folder hierarchy from which to return results
     * @param string|null $filter a comma-separated list of query names that defines which properties must be
     *      returned by the repository (default is repository specific)
     * @param boolean $includeAllowableActions if <code>true</code>, then the repository must return the available
     *      actions for each object in the result set (default is <code>false</code>)
     * @param IncludeRelationships|null $includeRelationships indicates what relationships in which the objects
     *      participate must be returned (default is IncludeRelationships::NONE)
     * @param string $renditionFilter indicates what set of renditions the repository must return whose kind
     *      matches this filter (default is "cmis:none")
     * @param boolean $includePathSegment if <code>true</code>, returns a path segment for each child object for use in
     *      constructing that object's path (default is <code>false</code>)
     * @param ExtensionDataInterface|null $extension
     * @return ObjectInFolderContainerInterface[]
     */
    public function getDescendants(
        $repositoryId,
        $folderId,
        $depth,
        $filter = null,
        $includeAllowableActions = false,
        IncludeRelationships $includeRelationships = null,
        $renditionFilter = Constants::RENDITION_NONE,
        $includePathSegment = false,
        ExtensionDataInterface $extension = null
    );

    /**
     * Gets the parent folder object for the specified folder object.
     *
     * @param string $repositoryId the identifier for the repository
     * @param string $folderId the identifier for the folder
     * @param string|null $filter a comma-separated list of query names that defines which properties must be
     *      returned by the repository (default is repository specific)
     * @param ExtensionDataInterface|null $extension
     * @return ObjectDataInterface
     */
    public function getFolderParent(
        $repositoryId,
        $folderId,
        $filter = null,
        ExtensionDataInterface $extension = null
    );

    /**
     * Gets the set of descendant folder objects contained in the specified folder.
     *
     * @param string $repositoryId the identifier for the repository
     * @param string $folderId the identifier for the folder
     * @param integer $depth the number of levels of depth in the folder hierarchy from which to return results
     * @param string|null $filter a comma-separated list of query names that defines which properties must be
     *      returned by the repository (default is repository specific)
     * @param boolean $includeAllowableActions if <code>true</code>, then the repository must return the available
     *      actions for each object in the result set (default is <code>false</code>)
     * @param IncludeRelationships|null $includeRelationships indicates what relationships in which the objects
     *      participate must be returned (default is IncludeRelationships::NONE)
     * @param string $renditionFilter indicates what set of renditions the repository must return whose kind
     *      matches this filter (default is "cmis:none")
     * @param boolean $includePathSegment if <code>true</code>, returns a path segment for each child object for use in
     *      constructing that object's path (default is <code>false</code>)
     * @param ExtensionDataInterface|null $extension
     * @return ObjectInFolderContainerInterface[]
     */
    public function getFolderTree(
        $repositoryId,
        $folderId,
        $depth,
        $filter = null,
        $includeAllowableActions = false,
        IncludeRelationships $includeRelationships = null,
        $renditionFilter = Constants::RENDITION_NONE,
        $includePathSegment = false,
        ExtensionDataInterface $extension = null
    );

    /**
     * Gets the parent folder(s) for the specified non-folder, fileable object
     *
     * @param string $repositoryId the identifier for the repository
     * @param string $objectId the identifier for the object
     * @param string|null $filter a comma-separated list of query names that defines which properties must be
     *      returned by the repository (default is repository specific)
     * @param boolean $includeAllowableActions if <code>true</code>, then the repository must return the available
     *      actions for each object in the result set (default is <code>false</code>)
     * @param IncludeRelationships|null $includeRelationships indicates what relationships in which the objects
     *      participate must be returned (default is IncludeRelationships::NONE)
     * @param string $renditionFilter indicates what set of renditions the repository must return whose kind
     *      matches this filter (default is "cmis:none")
     * @param boolean $includeRelativePathSegment if <code>true</code>, returns a relative path segment for each parent
     *      object for use in constructing that object's path (default is <code>false</code>)
     * @param ExtensionDataInterface|null $extension
     * @return ObjectParentDataInterface[]
     */
    public function getObjectParents(
        $repositoryId,
        $objectId,
        $filter = null,
        $includeAllowableActions = false,
        IncludeRelationships $includeRelationships = null,
        $renditionFilter = Constants::RENDITION_NONE,
        $includeRelativePathSegment = false,
        ExtensionDataInterface $extension = null
    );
}


1		<?php
2		namespace Dkd\PhpCmis;
3
4		/*
5		* This file is part of php-cmis-client.
6		*
7		* (c) Sascha Egerer <[email protected]>
8		*
9		* For the full copyright and license information, please view the LICENSE
10		* file that was distributed with this source code.
11		*/
12
13		use Dkd\PhpCmis\Data\ExtensionDataInterface;
14		use Dkd\PhpCmis\Data\ObjectDataInterface;
15		use Dkd\PhpCmis\Data\ObjectInFolderContainerInterface;
16		use Dkd\PhpCmis\Data\ObjectInFolderListInterface;
17		use Dkd\PhpCmis\Data\ObjectListInterface;
18		use Dkd\PhpCmis\Data\ObjectParentDataInterface;
19		use Dkd\PhpCmis\Enum\IncludeRelationships;
20		use phpDocumentor\Descriptor\Builder\Reflector\ConstantAssemblerTest;
21
22		/**
23		* Navigation Service interface.
24		*
25		* See the CMIS 1.0 and CMIS 1.1 specifications for details on the operations,
26		* parameters, exceptions and the domain model.
27		*/
28		interface NavigationServiceInterface
29		{
30		/**
31		* Gets the list of documents that are checked out that the user has access to.
32		*
33		* @param string $repositoryId the identifier for the repository
34		* @param string $folderId the identifier for the folder
35		* @param string\|null $filter a comma-separated list of query names that defines which properties must be
36		* returned by the repository (default is repository specific)
37		* @param string\|null $orderBy a comma-separated list of query names that define the order of the result set.
38		* Each query name must be followed by the ascending modifier "ASC" or the descending modifier "DESC"
39		* (default is repository specific)
40		* @param boolean $includeAllowableActions if <code>true</code>, then the repository must return the available
41		* actions for each object in the result set (default is <code>false</code>)
42		* @param IncludeRelationships\|null $includeRelationships indicates what relationships in which the objects
43		* participate must be returned (default is IncludeRelationships::NONE)
44		* @param string $renditionFilter indicates what set of renditions the repository must return whose kind
45		* matches this filter (default is "cmis:none")
46		* @param integer\|null $maxItems the maximum number of items to return in a response
47		* (default is repository specific)
48		* @param integer $skipCount number of potential results that the repository MUST skip/page over before
49		* returning any results (default is 0)
50		* @param ExtensionDataInterface\|null $extension
51		* @return ObjectListInterface
52		*/
53	View Code Duplication	public function getCheckedOutDocs(
		0 ignored issues – show Duplication introduced 2017-09-06 15:38 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
54		$repositoryId,
55		$folderId,
56		$filter = null,
57		$orderBy = null,
58		$includeAllowableActions = false,
59		IncludeRelationships $includeRelationships = null,
60		$renditionFilter = Constants::RENDITION_NONE,
61		$maxItems = null,
62		$skipCount = 0,
63		ExtensionDataInterface $extension = null
64		);
65
66		/**
67		* Gets the list of child objects contained in the specified folder.
68		*
69		* @param string $repositoryId the identifier for the repository
70		* @param string $folderId the identifier for the folder
71		* @param string\|null $filter a comma-separated list of query names that defines which properties must be
72		* returned by the repository (default is repository specific)
73		* @param string\|null $orderBy a comma-separated list of query names that define the order of the result set.
74		* Each query name must be followed by the ascending modifier "ASC" or the descending modifier "DESC"
75		* (default is repository specific)
76		* @param boolean $includeAllowableActions if <code>true</code>, then the repository must return the available
77		* actions for each object in the result set (default is <code>false</code>)
78		* @param IncludeRelationships\|null $includeRelationships indicates what relationships in which the objects
79		* participate must be returned (default is IncludeRelationships::NONE)
80		* @param string $renditionFilter indicates what set of renditions the repository must return whose kind
81		* matches this filter (default is "cmis:none")
82		* @param boolean $includePathSegment if <code>true</code>, returns a path segment for each child object for use in
83		* constructing that object's path (default is <code>false</code>)
84		* @param integer\|null $maxItems the maximum number of items to return in a response
85		* (default is repository specific)
86		* @param integer $skipCount number of potential results that the repository MUST skip/page over before
87		* returning any results (default is 0)
88		* @param ExtensionDataInterface\|null $extension
89		* @return ObjectInFolderListInterface
90		*/
91	View Code Duplication	public function getChildren(
		0 ignored issues – show Duplication introduced 2017-09-06 15:38 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
92		$repositoryId,
93		$folderId,
94		$filter = null,
95		$orderBy = null,
96		$includeAllowableActions = false,
97		IncludeRelationships $includeRelationships = null,
98		$renditionFilter = Constants::RENDITION_NONE,
99		$includePathSegment = false,
100		$maxItems = null,
101		$skipCount = 0,
102		ExtensionDataInterface $extension = null
103		);
104
105		/**
106		* Gets the set of descendant objects contained in the specified folder or any of its child folders.
107		*
108		* @param string $repositoryId the identifier for the repository
109		* @param string $folderId the identifier for the folder
110		* @param integer $depth the number of levels of depth in the folder hierarchy from which to return results
111		* @param string\|null $filter a comma-separated list of query names that defines which properties must be
112		* returned by the repository (default is repository specific)
113		* @param boolean $includeAllowableActions if <code>true</code>, then the repository must return the available
114		* actions for each object in the result set (default is <code>false</code>)
115		* @param IncludeRelationships\|null $includeRelationships indicates what relationships in which the objects
116		* participate must be returned (default is IncludeRelationships::NONE)
117		* @param string $renditionFilter indicates what set of renditions the repository must return whose kind
118		* matches this filter (default is "cmis:none")
119		* @param boolean $includePathSegment if <code>true</code>, returns a path segment for each child object for use in
120		* constructing that object's path (default is <code>false</code>)
121		* @param ExtensionDataInterface\|null $extension
122		* @return ObjectInFolderContainerInterface[]
123		*/
124		public function getDescendants(
125		$repositoryId,
126		$folderId,
127		$depth,
128		$filter = null,
129		$includeAllowableActions = false,
130		IncludeRelationships $includeRelationships = null,
131		$renditionFilter = Constants::RENDITION_NONE,
132		$includePathSegment = false,
133		ExtensionDataInterface $extension = null
134		);
135
136		/**
137		* Gets the parent folder object for the specified folder object.
138		*
139		* @param string $repositoryId the identifier for the repository
140		* @param string $folderId the identifier for the folder
141		* @param string\|null $filter a comma-separated list of query names that defines which properties must be
142		* returned by the repository (default is repository specific)
143		* @param ExtensionDataInterface\|null $extension
144		* @return ObjectDataInterface
145		*/
146		public function getFolderParent(
147		$repositoryId,
148		$folderId,
149		$filter = null,
150		ExtensionDataInterface $extension = null
151		);
152
153		/**
154		* Gets the set of descendant folder objects contained in the specified folder.
155		*
156		* @param string $repositoryId the identifier for the repository
157		* @param string $folderId the identifier for the folder
158		* @param integer $depth the number of levels of depth in the folder hierarchy from which to return results
159		* @param string\|null $filter a comma-separated list of query names that defines which properties must be
160		* returned by the repository (default is repository specific)
161		* @param boolean $includeAllowableActions if <code>true</code>, then the repository must return the available
162		* actions for each object in the result set (default is <code>false</code>)
163		* @param IncludeRelationships\|null $includeRelationships indicates what relationships in which the objects
164		* participate must be returned (default is IncludeRelationships::NONE)
165		* @param string $renditionFilter indicates what set of renditions the repository must return whose kind
166		* matches this filter (default is "cmis:none")
167		* @param boolean $includePathSegment if <code>true</code>, returns a path segment for each child object for use in
168		* constructing that object's path (default is <code>false</code>)
169		* @param ExtensionDataInterface\|null $extension
170		* @return ObjectInFolderContainerInterface[]
171		*/
172		public function getFolderTree(
173		$repositoryId,
174		$folderId,
175		$depth,
176		$filter = null,
177		$includeAllowableActions = false,
178		IncludeRelationships $includeRelationships = null,
179		$renditionFilter = Constants::RENDITION_NONE,
180		$includePathSegment = false,
181		ExtensionDataInterface $extension = null
182		);
183
184		/**
185		* Gets the parent folder(s) for the specified non-folder, fileable object
186		*
187		* @param string $repositoryId the identifier for the repository
188		* @param string $objectId the identifier for the object
189		* @param string\|null $filter a comma-separated list of query names that defines which properties must be
190		* returned by the repository (default is repository specific)
191		* @param boolean $includeAllowableActions if <code>true</code>, then the repository must return the available
192		* actions for each object in the result set (default is <code>false</code>)
193		* @param IncludeRelationships\|null $includeRelationships indicates what relationships in which the objects
194		* participate must be returned (default is IncludeRelationships::NONE)
195		* @param string $renditionFilter indicates what set of renditions the repository must return whose kind
196		* matches this filter (default is "cmis:none")
197		* @param boolean $includeRelativePathSegment if <code>true</code>, returns a relative path segment for each parent
198		* object for use in constructing that object's path (default is <code>false</code>)
199		* @param ExtensionDataInterface\|null $extension
200		* @return ObjectParentDataInterface[]
201		*/
202		public function getObjectParents(
203		$repositoryId,
204		$objectId,
205		$filter = null,
206		$includeAllowableActions = false,
207		IncludeRelationships $includeRelationships = null,
208		$renditionFilter = Constants::RENDITION_NONE,
209		$includeRelativePathSegment = false,
210		ExtensionDataInterface $extension = null
211		);
212		}
213

dkd / php-cmis-client

GitHub Access Token became invalid

NavigationServiceInterface::getDescendants() last analyzed 2019-11-19 13:16 UTC

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

NavigationServiceInterface::getDescendants()
last analyzed 2019-11-19 13:16 UTC