LFSWorldDataProvider Class Reference

Inheritance diagram for LFSWorldDataProvider:

LFSWorldChart LFSWorldHighlights LFSWorldHostsList LFSWorldHotlapLog LFSWorldHotlaps LFSWorldPersonalBests LFSWorldPersonalStats LFSWorldTeamsList LFSWorldWorldRecords List of all members.

Public Member Functions

 LFSWorldDataProvider ($srcMetaData=array(), $params=array())
 parse ($rawList, &$outputList)
 getData ()
 getParams ()
 getSrcMetaData ()
 getURL ()
 initParams (&$params)
 getLastRequestTime ()
 saveRequestTime ()

Protected Member Functions

 _init ()

Protected Attributes

 $m_oRequest = null
 $m_aSrcMetaData = array()
 $m_aParams = array()

Detailed Description

Base class for parsing basic LFSWorld data sources.

Version:
2.1.00

Definition at line 23 of file base.php.


Constructor & Destructor Documentation

LFSWorldDataProvider::LFSWorldDataProvider srcMetaData = array(),
params = array()
 

LFSWorldDataProvider base class Ctor.

Parameters:
srcMetaData (Array) An array of data to be passed to a cache.
params (Array) An array of params to be merged with the runtime and static params in order to specify how the parser should execute.
Returns:
(Void)

Definition at line 51 of file base.php.

References _init().


Member Function Documentation

LFSWorldDataProvider::_init  )  [protected]
 

Initialisation function called at the end of the ctor. This func allows for per-provider init without having to recreate a base class compatible ctor.

Definition at line 65 of file base.php.

Referenced by LFSWorldDataProvider().

LFSWorldDataProvider::getData  ) 
 

Makes the HTTP request and performs decompression / error checking etc.

Returns:
(Mixed) Parsed data on success (usually array), false otherwise.

Definition at line 103 of file base.php.

References getURL(), isLFSWorldError(), parse(), PPFDecompress(), and saveRequestTime().

LFSWorldDataProvider::getLastRequestTime  ) 
 

Retrieves a UNIX timestamp representing the last time this provider made a request.

Returns:
(Integer) UNIX timestamp representing last time the provider made a request, or 0 if a request has never been made or can not be determined.

Definition at line 244 of file base.php.

Referenced by initParams().

LFSWorldDataProvider::getParams  ) 
 

Accessor method for retrieving the params stored in this instance.

Returns:
(Array) An array of params stored in this instance.

Definition at line 149 of file base.php.

LFSWorldDataProvider::getSrcMetaData  ) 
 

Accessor method for retrieving the meta data stored in this instance.

Returns:
(Array) An array of meta data stored in this instance.

Definition at line 160 of file base.php.

LFSWorldDataProvider::getURL  ) 
 

Accessor method for retrieving the base url of the data source.

Returns:
(String) The base url of the data source as a string.

Reimplemented in LFSWorldHighlights.

Definition at line 171 of file base.php.

Referenced by getData().

LFSWorldDataProvider::initParams &$  params  ) 
 

Checks and adjusts input parameters where required & possible.

Parameters:
params (&Array) An array of parameters for the provider.
Returns:
(Boolean) True if the parameters provided are ok, false otherwise.

Reimplemented in LFSWorldChart, LFSWorldHighlights, LFSWorldHotlaps, LFSWorldHotlapLog, LFSWorldPersonalBests, LFSWorldPersonalStats, and LFSWorldWorldRecords.

Definition at line 183 of file base.php.

References getLastRequestTime(), and PPFCanDecompress().

LFSWorldDataProvider::parse rawList,
&$  outputList
 

Parses the raw data from LFSWorld in to an array.

Parameters:
rawList (String) The raw list retrieved from LFSWorld that needs to be parsed.
[out] outputList (Array) A reference to an array that will store the parsed output.
Returns:
(Boolean) True on success, false otherwise.

Reimplemented in LFSWorldHighlights, LFSWorldHotlapLog, LFSWorldHostsList, LFSWorldPersonalStats, and LFSWorldTeamsList.

Definition at line 77 of file base.php.

Referenced by getData().

LFSWorldDataProvider::saveRequestTime  ) 
 

Saves the current time as the last time of a request for this provider.

Returns:
(Void)

Definition at line 258 of file base.php.

References $s.

Referenced by getData().


Member Data Documentation

LFSWorldDataProvider::$m_aParams = array() [protected]
 

(Array) An array of parameters to be merged with the runtime and static parameters in order to specify how the parser should execute.

Definition at line 41 of file base.php.

LFSWorldDataProvider::$m_aSrcMetaData = array() [protected]
 

(Array) An array of meta data possibly useful to other parts of a program. (Such as tarpit duration)

Reimplemented in LFSWorldHighlights, LFSWorldHotlaps, LFSWorldHotlapLog, LFSWorldHostsList, LFSWorldPersonalBests, LFSWorldPersonalStats, LFSWorldTeamsList, and LFSWorldWorldRecords.

Definition at line 35 of file base.php.

LFSWorldDataProvider::$m_oRequest = null [protected]
 

(Object) The PEAR HTTP_Request object.

Definition at line 29 of file base.php.


Generated on Wed Oct 25 03:13:33 2006 for LFSWorldParsingProviderFramework by  doxygen 1.4.6