PHP Class IssuePublish

Inheritance: extends BaseFrm, implements publish
Datei anzeigen Open project: sourcefabric/newscoop Class Usage Examples

Public Properties

Property Type Description
$m_columnNames
$m_dbTableName
$m_keyColumnNames
$m_keyIsAutoIncrement

Public Methods

Method Description
DoPendingActions ( ) : void Execute all pending actions.
GetFutureActions ( integer $p_limit ) : array For now, this is mostly a hack to get the home page working.
GetIssueEvents ( integer $p_publicationId, integer $p_issueNumber, $p_languageId = null, boolean $p_includeCompleted = true ) : array Get all the events that will change the issue's state.
GetPendingActions ( ) : array Get all the actions that currently need to be performed.
IssuePublish ( integer $p_id = null ) This table delays an issue's publish time to a later date.
OnIssueDelete ( $p_publicationId, integer $p_issueNumber, $p_languageId ) This should be called whenever an issue is deleted.
doAction ( ) : void Execute the action.
getActionTime ( ) : string Get the time the event is scheduled to happen.
getEventId ( ) : integer
getIssueNumber ( ) : integer
getLanguageId ( ) : integer
getPublicationId ( ) : integer
getPublishAction ( ) : mixed Get the published state to switch to when the "publish time" arrives.
getPublishArticlesAction ( ) : mixed Get whether to publish the articles when the "publish time" arrives.
isCompleted ( ) : boolean Return true if the action has been carried out.
setActionTime ( string $p_value ) : boolean Set the time the action should be executed.
setCompleted ( ) : void Mark that this action has been completed.
setIssueNumber ( integer $p_value ) : boolean Enter description here.
setLanguageId ( integer $p_value ) : boolean Set the language ID of the issue to publish.
setPublicationId ( integer $p_value ) : boolean Set the publication ID.
setPublishAction ( string $p_value ) : void Set the published state to switch to when the "publish time" arrives: 'P' for Publish, or 'U' for Unpublish.
setPublishArticlesAction ( string $p_value ) : mixed Set the front page state to switch to when the "publish time" arrives: 'Y' for Yes, or 'N' for No.

Method Details

DoPendingActions() public static method

Execute all pending actions.
public static DoPendingActions ( ) : void
return void

GetFutureActions() public static method

The raw array is returned.
public static GetFutureActions ( integer $p_limit ) : array
$p_limit integer
return array

GetIssueEvents() public static method

Returns an array of IssuePublish objects.
public static GetIssueEvents ( integer $p_publicationId, integer $p_issueNumber, $p_languageId = null, boolean $p_includeCompleted = true ) : array
$p_publicationId integer
$p_issueNumber integer
$p_includeCompleted boolean
return array

GetPendingActions() public static method

Get all the actions that currently need to be performed.
public static GetPendingActions ( ) : array
return array

IssuePublish() public method

This table delays an issue's publish time to a later date.
public IssuePublish ( integer $p_id = null )
$p_id integer

OnIssueDelete() public static method

This should be called whenever an issue is deleted.
public static OnIssueDelete ( $p_publicationId, integer $p_issueNumber, $p_languageId )
$p_issueNumber integer

doAction() public method

Execute the action.
public doAction ( ) : void
return void

getActionTime() public method

Will be returned in the format: YYYY-MM-DD HH:MM:SS
public getActionTime ( ) : string
return string

getEventId() public method

public getEventId ( ) : integer
return integer

getIssueNumber() public method

public getIssueNumber ( ) : integer
return integer

getLanguageId() public method

public getLanguageId ( ) : integer
return integer

getPublicationId() public method

public getPublicationId ( ) : integer
return integer

getPublishAction() public method

This can be NULL for no action, 'P' for Publish, or 'U' for Unpublish.
public getPublishAction ( ) : mixed
return mixed

getPublishArticlesAction() public method

This can be 'Y' for 'Yes', or 'N' for 'No'.
public getPublishArticlesAction ( ) : mixed
return mixed

isCompleted() public method

Return true if the action has been carried out.
public isCompleted ( ) : boolean
return boolean

setActionTime() public method

Set the time the action should be executed.
public setActionTime ( string $p_value ) : boolean
$p_value string Must be in the form YYYY-MM-DD HH:MM:SS
return boolean

setCompleted() public method

Mark that this action has been completed.
public setCompleted ( ) : void
return void

setIssueNumber() public method

..
public setIssueNumber ( integer $p_value ) : boolean
$p_value integer
return boolean

setLanguageId() public method

Set the language ID of the issue to publish.
public setLanguageId ( integer $p_value ) : boolean
$p_value integer
return boolean

setPublicationId() public method

Set the publication ID.
public setPublicationId ( integer $p_value ) : boolean
$p_value integer
return boolean

setPublishAction() public method

Set the published state to switch to when the "publish time" arrives: 'P' for Publish, or 'U' for Unpublish.
public setPublishAction ( string $p_value ) : void
$p_value string
return void

setPublishArticlesAction() public method

Set the front page state to switch to when the "publish time" arrives: 'Y' for Yes, or 'N' for No.
public setPublishArticlesAction ( string $p_value ) : mixed
$p_value string
return mixed

Property Details

$m_columnNames public_oe property

public $m_columnNames

$m_dbTableName public_oe property

public $m_dbTableName

$m_keyColumnNames public_oe property

public $m_keyColumnNames

$m_keyIsAutoIncrement public_oe property

public $m_keyIsAutoIncrement