note: this page is automatically generated from embedded documentation in the PHP source.

Overview

See:

http://n2.talis.com/wiki/Contentbox

Constructors

• Contentbox - Create a new instance of this class

Methods

• get_item - Get an item from the contentbox
• get_item_by_path - Get an item from the contentbox using only it's path
• make_search_uri
• parse_results_xml - Parse the results of a search on the contentbox.
• search - Perform a search on the contentbox
• search_to_resource_list - Perform a search on the contentbox.
• search_to_triple_list - Perform a search on the contentbox

Constructor Detail

Contentbox

public Contentbox(mixed uri, mixed credentials, mixed request_factory)

Create a new instance of this class

Param:

string uri URI of the contentbox

Credentials credentials the credentials to use for authenticated requests (optional)

Method Detail

get_item

public void get_item(mixed uri)

Get an item from the contentbox

Param:

string uri the full uri of the item in the content box.

Return:

HttpResponse

get_item_by_path

public void get_item_by_path(mixed path)

Get an item from the contentbox using only it's path

Param:

string path the path of the item in the content box.

Return:

HttpResponse

make_search_uri

public void make_search_uri(mixed query, mixed max, mixed offset, mixed sort)

parse_results_xml

public void parse_results_xml(mixed uri, mixed xml)

Parse the results of a search on the contentbox.

Param:

string uri the URI used to obtain the search

string xml the xml returned from a search request

Return:

ResourceList

search

public void search(mixed query, mixed max, mixed offset, mixed sort)

Perform a search on the contentbox

Param:

string query the query expression used to query the content box.

int max maximum number of results for a search. (optional, defaults to 10)

int offset an offset into search results. Use with max to implement paging. (optional, defaults to 0)

string sort a comma separated list of field names that should be used to order the results.

Return:

HttpResponse

search_to_resource_list

public void search_to_resource_list(mixed query, mixed max, mixed offset)

Perform a search on the contentbox. This method returns an empty ResourceList if the HTTP request fails for any reason.

Param:

string query the query expression used to query the content box.

int max maximum number of results for a search. (optional, defaults to 10)

int offset an offset into search results. Use with max to implement paging. (optional, defaults to 0)

Return:

ResourceList

search_to_triple_list

public void search_to_triple_list(mixed query, mixed max, mixed offset)

Perform a search on the contentbox

Deprecated:

triple lists are deprecated

Generated by PHPDoctor 2RC2