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

Auth Registrar Group Query to a OSF Auth Registrar Group web service endpoint. More...

Inheritance diagram for AuthRegistrarGroupQuery:

Public Member Functions

 __construct ($network, $appID, $apiKey, $userID)
 Constructor. More...
 
 group ($uri)
 Sepcifies the group URI. More...
 
 application ($id)
 Sepcifies the Application ID where the group should be created. More...
 
 createGroup ()
 Specify that we want to create a new group. More...
 
 deleteGroup ()
 Specify that we want to delete a new group. More...
 

Detailed Description

Auth Registrar Group Query to a OSF Auth Registrar Group web service endpoint.

The Auth Registrar: Group Web service is used to register a new Group to the OSF instance. This group will be used to give access to the group's users to certain datasets.

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

use \StructuredDynamics\osf\framework\Namespaces;
use \StructuredDynamics\osf\php\api\ws\auth\registrar\ws\AuthRegistrarGroupQuery;
// Register a new web service endpoint to the OSF instance
$arg = new AuthRegistrarGroupQuery("http://localhost/ws/");
// Specify the group URI
$arg->group("http://localhost/wsf/groups/new-group");
// Specify the Application ID where this group belongs
$arg->application("some-id");
// Specify that we want to create a new group in that application
$arg->createGroup();
// Send the query
$arg->send();
if($arws->isSuccessful())
{
// ...
}
else
{
echo "Web service registration failed: ".$arg->getStatus()." (".$arg->getStatusMessage().")\n";
echo $arg->getStatusMessageDescription();
}
See also
http://wiki.opensemanticframework.org/index.php/Auth_Registrar:_Group
Author
Frederick Giasson, Structured Dynamics LLC.

Definition at line 57 of file AuthRegistrarGroupQuery.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 67 of file AuthRegistrarGroupQuery.php.

Member Function Documentation

application (   $id)

Sepcifies the Application ID where the group should be created.

Required: This function must be called before sending the query

Parameters
mixed$idID of the application
See also
http://wiki.opensemanticframework.org/index.php/Auth_Registrar:_Group#Web_Service_Endpoint_Information
Author
Frederick Giasson, Structured Dynamics LLC.

Definition at line 122 of file AuthRegistrarGroupQuery.php.

createGroup ( )

Specify that we want to create a new group.

Required: This function must be called before sending the query

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

Definition at line 138 of file AuthRegistrarGroupQuery.php.

deleteGroup ( )

Specify that we want to delete a new group.

Required: This function must be called before sending the query

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

Definition at line 154 of file AuthRegistrarGroupQuery.php.

group (   $uri)

Sepcifies the group URI.

Required: This function must be called before sending the query

Parameters
mixed$uriURI of the target group
See also
http://wiki.opensemanticframework.org/index.php/Auth_Registrar:_Group#Web_Service_Endpoint_Information
Author
Frederick Giasson, Structured Dynamics LLC.

Definition at line 104 of file AuthRegistrarGroupQuery.php.