Open Semantic Framework PHP API  3.0
 All Data Structures Namespaces Files Functions Variables Pages
AuthListerQuery Class Reference

Auth Lister Query to a OSF Auth Lister web service endpoint. More...

Inheritance diagram for AuthListerQuery:

Public Member Functions

 __construct ($network, $appID, $apiKey, $userID)
 Constructor. More...
 
 getDatasetsUri ()
 Specifies that this query will return all the datasets URI currently existing, and accessible by the user, in the OSF network instance. More...
 
 getRegisteredWebServiceEndpointsUri ()
 Specifies that this query will return all the web service endpoints URI currently registered to this OSF network instance. More...
 
 getDatasetGroupsAccesses ($datasetUri)
 Specifies that this query will return all the group access records in the OSF network instance. More...
 
 getUserAccesses ()
 Specifies that this query will return all the datasets URI currently existing, and accessible by the user, in the OSF network instance, along with their CRUD permissions. More...
 
 getGroupAccesses ($group)
 Specifies that this query will return all the datasets URI currently existing, and accessible by the group, in the OSF network instance, along with their CRUD permissions. More...
 
 getGroups ()
 Specifies that this query will return all the groups currently defined in the OSF instance. More...
 
 getGroupUsers ($group)
 Specifies that this query will return all the users registered to a group. More...
 
 getUserGroups ()
 Specifies that this query will return all the groups where the user is registered to. More...
 
 includeAllWebServiceUris ()
 Specifies if you want to get all the WebService URIs along with all the access records. More...
 
 includeNoWebServiceUris ()
 Specifies if you do not want to include any web service URIs for the access records. More...
 
 includeTargerWebServiceUri ($uri)
 Specifies which target web service you want to include in the resultset. More...
 

Detailed Description

Auth Lister Query to a OSF Auth Lister web service endpoint.

The Auth: Lister Web service is used to list all of the datasets accessible to a given user, list all of the datasets accessible to a given user with all of its CRUD permissions, to list all of the Web services registered to the WSF (Web Services Framework) and to list all of the CRUD permissions, for all users, for a given dataset created on a WSF.

This Web service is used to list all the things that are registered / authenticated in a Web Service Framework network.

Here is a code example of how this class can be used by developers:

// Use the AuthListerQuery class
use \StructuredDynamics\osf\php\api\ws\auth\lister\AuthListerQuery;
// Create the AuthListerQuery object
$authlister = new AuthListerQuery("http://demo.citizen-dan.org/ws/");
// Specifies that we want to get all the dataset URIs available to the server that send this query.
$authlister->getDatasetsUri();
// Send the auth lister query to the endpoint
$authlister->send();
// Get back the resultset returned by the endpoint
$resultset = $authlister->getResultset();
// Print different serializations for that resultset
print_r($resultset->getResultset());
See also
http://wiki.opensemanticframework.org/index.php/Auth:_Lister
Author
Frederick Giasson, Structured Dynamics LLC.

Definition at line 51 of file AuthListerQuery.php.

Constructor & Destructor Documentation

__construct (   $network,
  $appID,
  $apiKey,
  $userID 
)

Constructor.

Parameters
mixed$networkOSF network where to send this query. Ex: http://localhost/ws/
mixed$appIDThe Application ID of the instance instance to key. The APP-ID is related to the API-KEY
mixed$apiKeyThe API Key of the OSF web service endpoints
mixed$userIDThe ID of the user that is doing the query

Definition at line 61 of file AuthListerQuery.php.

Member Function Documentation

getDatasetGroupsAccesses (   $datasetUri)

Specifies that this query will return all the group access records in the OSF network instance.

This information will only be returned if the requester has permissions on the core OSF registry dataset.

Parameters
$datasetUrithe URI of the target dataset for which you want the access records for all its users
See also
http://wiki.opensemanticframework.org/index.php/Auth:_Lister#Web_Service_Endpoint_Information
Author
Frederick Giasson, Structured Dynamics LLC.*

Definition at line 131 of file AuthListerQuery.php.

getDatasetsUri ( )

Specifies that this query will return all the datasets URI currently existing, and accessible by the user, in the OSF network instance.

This is the default behavior of this service.

See also
http://wiki.opensemanticframework.org/index.php/Auth:_Lister#Web_Service_Endpoint_Information
Author
Frederick Giasson, Structured Dynamics LLC.*

Definition at line 99 of file AuthListerQuery.php.

getGroupAccesses (   $group)

Specifies that this query will return all the datasets URI currently existing, and accessible by the group, in the OSF network instance, along with their CRUD permissions.

See also
http://wiki.opensemanticframework.org/index.php/Auth:_Lister#Web_Service_Endpoint_Information
Author
Frederick Giasson, Structured Dynamics LLC.*

Definition at line 162 of file AuthListerQuery.php.

getGroups ( )

Specifies that this query will return all the groups currently defined in the OSF instance.

See also
http://wiki.opensemanticframework.org/index.php/Auth:_Lister#Web_Service_Endpoint_Information
Author
Frederick Giasson, Structured Dynamics LLC.*

Definition at line 178 of file AuthListerQuery.php.

getGroupUsers (   $group)

Specifies that this query will return all the users registered to a group.

See also
http://wiki.opensemanticframework.org/index.php/Auth:_Lister#Web_Service_Endpoint_Information
Author
Frederick Giasson, Structured Dynamics LLC.*

Definition at line 192 of file AuthListerQuery.php.

getRegisteredWebServiceEndpointsUri ( )

Specifies that this query will return all the web service endpoints URI currently registered to this OSF network instance.

See also
http://wiki.opensemanticframework.org/index.php/Auth:_Lister#Web_Service_Endpoint_Information
Author
Frederick Giasson, Structured Dynamics LLC.*

Definition at line 114 of file AuthListerQuery.php.

getUserAccesses ( )

Specifies that this query will return all the datasets URI currently existing, and accessible by the user, in the OSF network instance, along with their CRUD permissions.

See also
http://wiki.opensemanticframework.org/index.php/Auth:_Lister#Web_Service_Endpoint_Information
Author
Frederick Giasson, Structured Dynamics LLC.*

Definition at line 147 of file AuthListerQuery.php.

getUserGroups ( )

Specifies that this query will return all the groups where the user is registered to.

See also
http://wiki.opensemanticframework.org/index.php/Auth:_Lister#Web_Service_Endpoint_Information
Author
Frederick Giasson, Structured Dynamics LLC.*

Definition at line 208 of file AuthListerQuery.php.

includeAllWebServiceUris ( )

Specifies if you want to get all the WebService URIs along with all the access records.

Depending on the usecase, this list can be quite large and the returned resultset can be huge.

This is the default behavior of this service.

See also
http://wiki.opensemanticframework.org/index.php/Auth:_Lister#Web_Service_Endpoint_Information
Author
Frederick Giasson, Structured Dynamics LLC.*

Definition at line 226 of file AuthListerQuery.php.

includeNoWebServiceUris ( )

Specifies if you do not want to include any web service URIs for the access records.

See also
http://wiki.opensemanticframework.org/index.php/Auth:_Lister#Web_Service_Endpoint_Information
Author
Frederick Giasson, Structured Dynamics LLC.*

Definition at line 240 of file AuthListerQuery.php.

includeTargerWebServiceUri (   $uri)

Specifies which target web service you want to include in the resultset.

Parameters
mixed$uriURI of the web service endpoint to include
See also
http://wiki.opensemanticframework.org/index.php/Auth:_Lister#Web_Service_Endpoint_Information
Author
Frederick Giasson, Structured Dynamics LLC.*

Definition at line 256 of file AuthListerQuery.php.