PHP Class Swiftriver\Core\ObjectModel\Channel

Mostrar archivo Open project: ushahidi/Swiftriver-2011 Class Usage Examples

Public Properties

Property Type Description
$active boolean If this job is currently active or not
$deleted boolean Shows if the Channel has been deleted by the user - NOTE: we never remove a Channel
$id string The genuine unique ID of this Channel
$inprocess boolean A boolean indicating if the Channel is currently being processed
$lastSuccess time The last time this Channel was sucessfully run though the SiSPS
$lastrun time The last time the Channel was run throught the SiSPS - Note this time is not the last sucess just the last run
$name string The friendly name of this Channel
$nextrun time The time this Channel is next due to be run throught the SiSPS
$parameters string[] Parameters required to get content For example, parameters may be: array ( "type" -> "email", "connectionString" -> "someConnectionString" );
$subType string The subtype of the Channel - given by the parser
$timesrun integer the number of sucessful time this Channel have been run throught the SiSPS
$trusted boolean Value indicating that sources from this channel should recieve top veracity scores on creation
$type string The type of the Channel - given by the parser
$updatePeriod The period in minutes that the Channel should be updated

Property Details

$active public_oe property

If this job is currently active or not
public bool $active
return boolean

$deleted public_oe property

Shows if the Channel has been deleted by the user - NOTE: we never remove a Channel
public bool $deleted
return boolean

$id public_oe property

The genuine unique ID of this Channel
public string $id
return string

$inprocess public_oe property

A boolean indicating if the Channel is currently being processed
public bool $inprocess
return boolean

$lastSuccess public_oe property

The last time this Channel was sucessfully run though the SiSPS
public time $lastSuccess
return time

$lastrun public_oe property

The last time the Channel was run throught the SiSPS - Note this time is not the last sucess just the last run
public time $lastrun
return time

$name public_oe property

The friendly name of this Channel
public string $name
return string

$nextrun public_oe property

The time this Channel is next due to be run throught the SiSPS
public time $nextrun
return time

$parameters public_oe property

Parameters required to get content For example, parameters may be: array ( "type" -> "email", "connectionString" -> "someConnectionString" );
public string[] $parameters
return string[]

$subType public_oe property

The subtype of the Channel - given by the parser
public string $subType
return string

$timesrun public_oe property

the number of sucessful time this Channel have been run throught the SiSPS
public int $timesrun
return integer

$trusted public_oe property

Value indicating that sources from this channel should recieve top veracity scores on creation
public bool $trusted
return boolean

$type public_oe property

The type of the Channel - given by the parser
public string $type
return string

$updatePeriod public_oe property

The period in minutes that the Channel should be updated
public $updatePeriod