PHP Class Swiftriver\Core\Modules\DataContext\MySql_V2\DataContext

Author: mg[at]swiftly[dot]org
Inheritance: implements Swiftriver\Core\DAL\DataContextInterfaces\IAPIKeyDataContext, implements Swiftriver\Core\DAL\DataContextInterfaces\IChannelDataContext, implements Swiftriver\Core\DAL\DataContextInterfaces\IContentDataContext, implements Swiftriver\Core\DAL\DataContextInterfaces\ISourceDataContext, implements Swiftriver\Core\DAL\DataContextInterfaces\ITrustLogDataContext
Show file Open project: ushahidi/Swiftriver-2011 Class Usage Examples

Public Methods

Method Description
AddRegisteredCoreAPIKey ( string $key ) : boolean Given a new APIKey, this method adds it to the data store or registered API keys.
DeleteContent ( Content[] $content ) Given an array of content items, this method removes them from the data store.
GetChannelsById ( string[] $ids ) : Channel[] Given the IDs of Channels, this method gets them from the underlying data store
GetContent ( string[] $ids, $orderby = null ) : Content[] Given an array of content is's, this function will fetch the content objects from the data store.
GetContentList ( string[] $parameters )
GetSourcesById ( string[] $ids ) : Source[] Given the IDs of Sources, this method gets them from the underlying data store
IsRegisterdCoreAPIKey ( string $key ) : boolean Checks that the given API Key is registed for this Core install
ListAllChannels ( ) : Channel[] Lists all the current Channel in the core
ListAllSources ( ) : Source[] Lists all the current Source in the core
PDOConnection ( ) : PDO Generic function used to gain a new PDO connection to the database.
RecordSourceScoreChange ( string $sourceId, string $markerId, integer $change, string | null $reason = null ) This method redords the fact that a marker (sweeper) has changed the score of a source by marking a content items as either 'acurate', 'chatter' or 'inacurate'
RemoveChannels ( string[] $ids ) Given a list of IDs this method removes the Channels from the data store.
RemoveRegisteredCoreAPIKey ( $key ) : boolean Given an APIKey, this method will remove it from the data store of registered API Keys Returns true on sucess
SaveChannels ( $channels ) Adds a list of new Channels to the data store
SaveContent ( Content[] $content ) Given a set of content items, this method will persist them to the data store, if they already exists then this method should update the values in the data store.
SelectNextDueChannel ( DateTime $time ) : Channel Given a date time, this function returns the next due Channel.

Method Details

AddRegisteredCoreAPIKey() public static method

Returns true on sucess
public static AddRegisteredCoreAPIKey ( string $key ) : boolean
$key string
return boolean

DeleteContent() public static method

Given an array of content items, this method removes them from the data store.
public static DeleteContent ( Content[] $content )
$content Swiftriver\Core\ObjectModel\Content[]

GetChannelsById() public static method

Given the IDs of Channels, this method gets them from the underlying data store
public static GetChannelsById ( string[] $ids ) : Channel[]
$ids string[]
return Swiftriver\Core\ObjectModel\Channel[]

GetContent() public static method

Given an array of content is's, this function will fetch the content objects from the data store.
public static GetContent ( string[] $ids, $orderby = null ) : Content[]
$ids string[]
return Swiftriver\Core\ObjectModel\Content[]

GetContentList() public static method

public static GetContentList ( string[] $parameters )
$parameters string[]

GetSourcesById() public static method

Given the IDs of Sources, this method gets them from the underlying data store
public static GetSourcesById ( string[] $ids ) : Source[]
$ids string[]
return Swiftriver\Core\ObjectModel\Source[]

IsRegisterdCoreAPIKey() public static method

Checks that the given API Key is registed for this Core install
public static IsRegisterdCoreAPIKey ( string $key ) : boolean
$key string
return boolean

ListAllChannels() public static method

Lists all the current Channel in the core
public static ListAllChannels ( ) : Channel[]
return Swiftriver\Core\ObjectModel\Channel[]

ListAllSources() public static method

Lists all the current Source in the core
public static ListAllSources ( ) : Source[]
return Swiftriver\Core\ObjectModel\Source[]

PDOConnection() public static method

Generic function used to gain a new PDO connection to the database.
public static PDOConnection ( ) : PDO
return PDO

RecordSourceScoreChange() public static method

This method redords the fact that a marker (sweeper) has changed the score of a source by marking a content items as either 'acurate', 'chatter' or 'inacurate'
public static RecordSourceScoreChange ( string $sourceId, string $markerId, integer $change, string | null $reason = null )
$sourceId string
$markerId string
$change integer
$reason string | null

RemoveChannels() public static method

Given a list of IDs this method removes the Channels from the data store.
public static RemoveChannels ( string[] $ids )
$ids string[]

RemoveRegisteredCoreAPIKey() public static method

Given an APIKey, this method will remove it from the data store of registered API Keys Returns true on sucess
public static RemoveRegisteredCoreAPIKey ( $key ) : boolean
return boolean

SaveChannels() public static method

Adds a list of new Channels to the data store
public static SaveChannels ( $channels )

SaveContent() public static method

Given a set of content items, this method will persist them to the data store, if they already exists then this method should update the values in the data store.
public static SaveContent ( Content[] $content )
$content Swiftriver\Core\ObjectModel\Content[]

SelectNextDueChannel() public static method

Given a date time, this function returns the next due Channel.
public static SelectNextDueChannel ( DateTime $time ) : Channel
$time DateTime
return Swiftriver\Core\ObjectModel\Channel