Tariqa SOAP
 All Data Structures Namespaces Files Functions Variables Enumerations
tariqaLatestNews Class Reference
Inheritance diagram for tariqaLatestNews:
Tariqa

Public Member Functions

 __construct ($config, $soap)
 latestNewsSearch ($token, $query, $range=null)
 latestNewsListLanguages ($token)
 latestNewsFetch ($token, $resultset, $first=null, $count=null)
 latestNewsGetDocument ($token, $id)
 fetchLatestNews ($token, $query, $range=null, $page_number=null, $page_size=null, $paginal=true, $range_count=null)
 getLatestNewsArticle ($token, $id)
 latestNewsSearchIDOL ($token, $query, $extra_data=null)
 latestNewsGetDocumentIDOL ($token, $id, $highlight=null)

Data Fields

 $soap

Protected Attributes

 $config = null

Constructor & Destructor Documentation

__construct ( config,
soap 
)

Constructs a tariqaThemes Object

Returns:
Tariqa

Member Function Documentation

fetchLatestNews ( token,
query,
range = null,
page_number = null,
page_size = null,
paginal = true,
range_count = null 
)

Fetch the articles from the LatestNews database

Parameters:
string$tokenSession Identifier
string$querySQL query
float$rangeTime range in days (you may use fractions!) [OPTIONAL]
int$page_numberWhich page of articles to fetch [OPTIONAL]
int$page_sizeHow many articles should be displayed on each page [OPTIONAL]
boolean$paginalIf set to true, the results are paginated, else page_number represents the first result, and page_size the number of results [OPTIONAL]
float$range_countThe number of days to fetch the news starting ahead $range days (you may use fractions!) [OPTIONAL]
Returns:
Resultset
getLatestNewsArticle ( token,
id 
)

Fetch the articles from the LatestNews database

Parameters:
string$tokenSession Identifier
string$idArticle ID
Returns:
Article
latestNewsFetch ( token,
resultset,
first = null,
count = null 
)

Fetch the articles from the LatestNews database

Parameters:
string$tokenSession Identifier
LatestNewsResultset$resultsetThe resultset returned by a latestNewsSearch() operation
int$first[OPTIONAL]
int$count[OPTIONAL]
Returns:
LatestNewsDocument[]
latestNewsGetDocument ( token,
id 
)

Get a LatestNews Document

Parameters:
string$tokenSession Identifier
int$idArticle ID
Returns:
LatestNewsDocument
latestNewsGetDocumentIDOL ( token,
id,
highlight = null 
)

Fetches a latest news IDOL document

Parameters:
string$tokenThe token identifier
int$idThe document identifier
string$highlightThe terms to be highlighted [OPTIONAL] public
Returns:
LatestNewsDocument

Returns the latestnews languages

Parameters:
string$tokenThe session identifier public
Returns:
LatestNewsLanguage[]
latestNewsSearch ( token,
query,
range = null 
)

Search for articles in the LatestNews database

Parameters:
string$tokenSession Identifier
string$querySQL query
float$rangeTime range in days (you may use fractions!) [OPTIONAL]
Returns:
LatestNewsResultset
latestNewsSearchIDOL ( token,
query,
extra_data = null 
)

Performs a search in the latest news IDOL database

Parameters:
string$tokenThe token identifier
LatestNewsQuery$queryThe query
string$extra_dataExtra data lines (GET encoded) [OPTIONAL] public
Returns:
LatestNewsResultSetIDOL

Field Documentation

$config = null [protected]

Reimplemented from Tariqa.

$soap

Reimplemented from Tariqa.


The documentation for this class was generated from the following file: