Raws Class Reference

Base class for RAWS interface classes. More...

Inherits Zend_Gdata_App.

Inherited by Rams, Rass, and Rats.

List of all members.

Public Member Functions
	__construct ($user=null, $pwd=null, $base_uri=null, $path=null, $client=null, $applicationId= 'MyCompany-MyApp-1.0', $ssl=False)
	Create Raws object.
	setBaseUri ($value, $ssl=False)
	Set the base uri (e.g.
	setSSL ($ssl)
	Change the ssl property of the client.
	getNextFeed ($feed, $className=null)
	Follow the URL stored in the 'next' link element of the feed, and return the feed in the server response (or null).
	getNextLink ($feed)
	Return the URL stored in the 'next' link element of the feed, and return the feed in the server response (or null).
	getLastFeed ($feed, $className=null)
	Follow the URL stored in the 'last' link element of the feed, and return the feed in the server response (or null).
	getLastLink ($feed)
	Return the URL stored in the 'last' link element of the feed, and return the feed in the server response (or null).
	getLastNr ($feed)
	Return the URL stored in the 'next' link element of the feed, and return the feed in the server response (or null).
	setCredentials ($user, $pwd)
	Change login credentials.

---

Detailed Description

Base class for RAWS interface classes.

Examples:

rams_concurrent.php, rams_customer_resources.php, rams_geo.php, rams_set_traffic_limit.php, rams_storage.php, rams_total.php, rams_ttype.php, rass_basics_get_feed.php, rass_basics_manage_file_dir.php, rass_batch_upload.php, rass_meta_create.php, rass_meta_search.php, rass_meta_vocabs.php, rass_tag_search.php, rass_tag_set.php, rats_job.php, rats_quicktest.php, and raws_links_and_pagination.php.

---

Constructor & Destructor Documentation

Raws.__construct	(	$	user = null,
		$	pwd = null,
		$	base_uri = null,
		$	path = null,
		$	client = null,
		$	applicationId = 'MyCompany-MyApp-1.0',
		$	ssl = False
	)

Create Raws object.

Parameters:

	Zend_Http_Client	$client
	string	$applicationId The identity of the app in the form of Company-AppName-Version

Reimplemented in Rass, and Rats.

---

Member Function Documentation

Raws.setBaseUri	(	$	value,
		$	ssl = False
	)

Set the base uri (e.g.

http://rats.enc01.rambla.be) to be used by all derived classes.

Parameters:

	string	$value The base uri passed by the caller (may have the form "http://rats.enc01.rambla.be" or "rats.enc01.rambla.be")
	bool	$ssl Use ssl or not.

Raws.setSSL

(

$

ssl

)

Change the ssl property of the client.

Parameters:

bool

$ssl Use ssl or not.

Raws.getNextFeed	(	$	feed,
		$	className = null
	)

Follow the URL stored in the 'next' link element of the feed, and return the feed in the server response (or null).

Parameters:

	Raws_Feed	$feed Class derived from Raws_Feed
	string	$className Optional: name of the class derived from Raws_Feed.

Returns:

Raws_Feed Class derived from Raws_Feed, or null.

Raws.getNextLink

(

$

feed

)

Return the URL stored in the 'next' link element of the feed, and return the feed in the server response (or null).

Parameters:

Raws_Feed

$feed Class derived from Raws_Feed

Returns:

string URL inside the 'next' link element of the feed, or null.

Raws.getLastFeed	(	$	feed,
		$	className = null
	)

Follow the URL stored in the 'last' link element of the feed, and return the feed in the server response (or null).

Parameters:

	Raws_Feed	$feed Class derived from Raws_Feed
	string	$className Optional: name of the class derived from Raws_Feed.

Returns:

Raws_Feed Class derived from Raws_Feed, or null.

Raws.getLastLink

(

$

feed

)

Return the URL stored in the 'last' link element of the feed, and return the feed in the server response (or null).

Parameters:

Raws_Feed

$feed Class derived from Raws_Feed

Returns:

string URL inside the 'next' link element of the feed, or null.

Raws.getLastNr

(

$

feed

)

Return the URL stored in the 'next' link element of the feed, and return the feed in the server response (or null).

Parameters:

Raws_Feed

$feed Class derived from Raws_Feed

Returns:

string Number of the last page.

Raws.setCredentials	(	$	user,
		$	pwd
	)

Change login credentials.

Parameters:

	string	$user Name of the CDN user.
	string	$pwd Password of the CDN user.

---