PHP Interface Swiftriver\Core\Modules\SiSPS\PushParsers\IPushParser

ファイルを表示 Open project: ushahidi/Swiftriver-2011

Public Methods

Method Description
GetDescription ( ) : string This method returns a string describing the implementation details of this parser
GetSettings ( ) : settings[] This function allows us to get the settings for each parser
PushAndParse ( String $raw_content = null, String $post_content = null, String $get_content = null, String $file_content = null ) : Swiftriver\Core\ObjectModel\Content[] Provided with the raw content, this method parses the raw content and converts it to SwiftRiver content object model
ReturnType ( ) : string This method returns a string describing the type of sources it can parse. For example, the RSSParser returns "Feeds".

Method Details

GetDescription() public method

This method returns a string describing the implementation details of this parser
public GetDescription ( ) : string
return string - implementation details

GetSettings() public method

This function allows us to get the settings for each parser
public GetSettings ( ) : settings[]
return settings[]

PushAndParse() public method

Provided with the raw content, this method parses the raw content and converts it to SwiftRiver content object model
public PushAndParse ( String $raw_content = null, String $post_content = null, String $get_content = null, String $file_content = null ) : Swiftriver\Core\ObjectModel\Content[]
$raw_content String (if content gets sent raw)
$post_content String (if content gets sent as HTTP POST)
$get_content String (if content gets sent as HTTP GET)
$file_content String (if content gets sent a file over HTTP upload)
return Swiftriver\Core\ObjectModel\Content[] contentItems

ReturnType() public method

This method returns a string describing the type of sources it can parse. For example, the RSSParser returns "Feeds".
public ReturnType ( ) : string
return string type of sources parsed