Skip to content

Commit

Permalink
Update PHPDocs to meet standards
Browse files Browse the repository at this point in the history
  • Loading branch information
grantbacon committed Jul 15, 2013
1 parent b521eb3 commit 63d3088
Showing 1 changed file with 17 additions and 16 deletions.
33 changes: 17 additions & 16 deletions client/JasperClient.php
Original file line number Diff line number Diff line change
Expand Up @@ -908,6 +908,7 @@ public function getRepository($uri = null, $query = null, $wsType = null, $recur
return $result;
}


/**
* This function retrieves a resource descriptor for a specified resource at $path on the server.
* If you wish to supply information to the input controls you can supply the data to the $p and $pl arguments.
Expand Down Expand Up @@ -1304,19 +1305,19 @@ public function deletePermission(Permission $perm) {
$url = $this->restUrl2 . '/permissions' . substr($perm->getUri(), 5) . ';recipient=' . str_replace('/', '%2F', $perm->getRecipientUri());
$this->prepAndSend($url, array(200, 204), 'DELETE', null);
}
/**
* Obtain the permissions of a resource on the server
*
* @param string $uri URI of resource you wish to obtain permissions
* @param boolean $effectivePermissions shows all permissions who affect uri
* @param string $recipient Type type of permission (user or role)
* @param string $recipientId the id of the recipient (requires recipientType)
* @param boolean $resolveAll resolve for all matched recipients
* @return array<RepositoryPermission> array of permission objects
*/
public function searchRepositoryPermissions($uri, $effectivePermissions = null, $recipientType = null, $recipientId = null, $resolveAll = null) {


/**
* Obtain the permissions of a resource on the server
*
* @param $uri URI of resource you wish to obtain permissions
* @param $effectivePermissions shows all permissions who affect uri
* @param $recipientType Type type of permission (user or role)
* @param $recipientId the id of the recipient (requires recipientType)
* @param $resolveAll resolve for all matched recipients
* @return array<RepositoryPermission> array of permission objects
*/
public function searchRepositoryPermissions($uri, $effectivePermissions = null, $recipientType = null, $recipientId = null, $resolveAll = null) {
$result = array();
$url = $this->restUrl2 . '/permissions' . $uri;
$url .= '?' . JasperClient::query_suffix(array(
Expand All @@ -1341,8 +1342,8 @@ public function searchRepositoryPermissions($uri, $effectivePermissions = null,
/**
* Update a set of permissions on the server.
*
* @param uri URI of the resource in the repository
* @param permissions an array of RepositoryPermission objects representing changes made
* @param $uri URI of the resource in the repository
* @param $permissions an array of RepositoryPermission objects representing changes made
*/
public function updateRepositoryPermissions($uri, $permissions) {
$url = $this->restUrl2 . '/permissions' . $uri;
Expand All @@ -1353,7 +1354,7 @@ public function updateRepositoryPermissions($uri, $permissions) {
/**
* Create new permissions on the server.
*
* @param permissions an array of RepositoryPermission objects completely defining new permissions
* @param $permissions an array of RepositoryPermission objects completely defining new permissions
*/
public function createRepositoryPermissions($permissions) {
$url = $this->restUrl2 . '/permissions';
Expand Down

0 comments on commit 63d3088

Please sign in to comment.