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

Revision Delete Query to a OSF Revision Delete web service endpoint. More...

Inheritance diagram for RevisionDeleteQuery:

Public Member Functions

 __construct ($network, $appID, $apiKey, $userID)
 Constructor. More...
 
 revisionUri ($uri)
 Specifies the URI of the revision record to delete. More...
 
 dataset ($dataset)
 Specifies the dataset URI where the record is indexed. More...
 

Detailed Description

Revision Delete Query to a OSF Revision Delete web service endpoint.

The Revision: Delete web service endpoint deletes a revision of a record. It cannot delete a published revision. If a published revision needs to be deleted, then it needs to be updated such that the published stage is remove before being able to delete it or to use the CRUD: Delete (soft) web service endpoint.

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

// Use the RevisionDeleteQuery class
use \StructuredDynamics\osf\php\api\ws\revision\delete\RevisionDeleteQuery;
// Create the RevisionDeleteQuery object
$revisiondelete = new RevisionDeleteQuery("http://demo.citizen-dan.org/ws/");
$revisiondelete->recordUri('http://demo.citizen-dan.org/datasets/test/1/revision/12335.123');
$revisiondelete->dataset('http://demo.citizen-dan.org/datasets/test/');
// Send the revision delete query to the endpoint
$revisiondelete->send();
// Get back the resultset returned by the endpoint
$resultset = $revisiondelete->getResultset();
// Print different serializations for that resultset
print_r($resultset->getResultset());
See also
http://wiki.opensemanticframework.org/index.php/Revision:_Delete
Author
Frederick Giasson, Structured Dynamics LLC.

Definition at line 49 of file RevisionDeleteQuery.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 59 of file RevisionDeleteQuery.php.

Member Function Documentation

dataset (   $dataset)

Specifies the dataset URI where the record is indexed.

Parameters
$datasetThe dataset URI where the record is indexed. This is the URI of the dataset, and not the URI of the revisions dataset.
See also
http://wiki.opensemanticframework.org/index.php/Revision:_Delete#Web_Service_Endpoint_Information
Author
Frederick Giasson, Structured Dynamics LLC.

Definition at line 112 of file RevisionDeleteQuery.php.

revisionUri (   $uri)

Specifies the URI of the revision record to delete.

This URI can be found using the RevisionUpdateQuery() call.

Parameters
$uriURI of the revision record to delete
See also
http://wiki.opensemanticframework.org/index.php/Revision:_Delete#Web_Service_Endpoint_Information
Author
Frederick Giasson, Structured Dynamics LLC.*

Definition at line 95 of file RevisionDeleteQuery.php.