PHP Класс ArticlePublish

Наследование: extends DatabaseObject
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$m_columnNames
$m_dbTableName
$m_keyColumnNames
$m_keyIsAutoIncrement

Открытые методы

Метод Описание
ArticleHasFutureActions ( integer $p_articleNumber, integer $p_languageId ) : boolean Return TRUE if there are actions scheduled in the future.
ArticlePublish ( integer $p_id = null ) This table delays an article's publish time to a later date.
DoPendingActions ( ) : void Execute all pending actions.
GetArticleEvents ( integer $p_articleNumber, integer $p_languageId = null, boolean $p_onlyFutureEvents = false ) : array Get all the events that will change the article's state.
GetFutureActions ( integer $p_limit ) : array For now, this is mostly a hack to get the home page working.
GetPendingActions ( ) : array Get all the actions that currently need to be performed.
OnArticleDelete ( integer $p_articleNumber, integer $p_languageId ) : void This will be called whenever an article is deleted.
delete ( ) constructor
doAction ( ) : void Execute the action, and mark the action as completed.
getActionTime ( ) : string Get the time the event is scheduled to happen.
getArticleNumber ( ) : integer Return the article number associated with this action.
getArticlePublishId ( ) : integer Get the unique ID that identifies this action.
getFrontPageAction ( ) : mixed Get the front page state to switch to when the "publish time" arrives.
getLanguageId ( ) : integer Return the language ID of the article.
getPublishAction ( ) : mixed Get the published state to switch to when the "publish time" arrives: NULL for no action, 'P' for Publish, or 'U' for Unpublish.
getSectionPageAction ( ) : mixed Get the section page state to switch to when the "publish time" arrives.
setActionTime ( string $p_value ) : boolean Set the time when the action(s) should be taken.
setArticleNumber ( integer $p_value ) : boolean Set the Article number.
setCompleted ( ) : void Mark that this action has been completed.
setFrontPageAction ( $p_value ) : mixed Set the front page state to switch to when the "publish time" arrives.
setLanguageId ( integer $p_value ) : boolean Set the language ID.
setPublishAction ( $p_value ) : void Set the published state to switch to when the "publish time" arrives: NULL for no action, 'P' for Publish, or 'U' for Unpublish.
setSectionPageAction ( $p_value ) : mixed Set the section page state to switch to when the "publish time" arrives.

Описание методов

ArticleHasFutureActions() публичный статический Метод

Return TRUE if there are actions scheduled in the future.
public static ArticleHasFutureActions ( integer $p_articleNumber, integer $p_languageId ) : boolean
$p_articleNumber integer
$p_languageId integer
Результат boolean

ArticlePublish() публичный Метод

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

DoPendingActions() публичный статический Метод

Execute all pending actions.
public static DoPendingActions ( ) : void
Результат void

GetArticleEvents() публичный статический Метод

Returns an array of ArticlePublish objects.
public static GetArticleEvents ( integer $p_articleNumber, integer $p_languageId = null, boolean $p_onlyFutureEvents = false ) : array
$p_articleNumber integer
$p_languageId integer
$p_onlyFutureEvents boolean
Результат array

GetFutureActions() публичный статический Метод

The raw array is returned.
public static GetFutureActions ( integer $p_limit ) : array
$p_limit integer
Результат array

GetPendingActions() публичный статический Метод

Get all the actions that currently need to be performed.
public static GetPendingActions ( ) : array
Результат array

OnArticleDelete() публичный статический Метод

This will be called whenever an article is deleted.
public static OnArticleDelete ( integer $p_articleNumber, integer $p_languageId ) : void
$p_articleNumber integer
$p_languageId integer
Результат void

delete() публичный Метод

constructor
public delete ( )

doAction() публичный Метод

Execute the action, and mark the action as completed.
public doAction ( ) : void
Результат void

getActionTime() публичный Метод

Get the time the event is scheduled to happen.
public getActionTime ( ) : string
Результат string

getArticleNumber() публичный Метод

Return the article number associated with this action.
public getArticleNumber ( ) : integer
Результат integer

getArticlePublishId() публичный Метод

Get the unique ID that identifies this action.
public getArticlePublishId ( ) : integer
Результат integer

getFrontPageAction() публичный Метод

This can be NULL for no action, 'S' for Show, or 'R' for Remove.
public getFrontPageAction ( ) : mixed
Результат mixed

getLanguageId() публичный Метод

Return the language ID of the article.
public getLanguageId ( ) : integer
Результат integer

getPublishAction() публичный Метод

Get the published state to switch to when the "publish time" arrives: NULL for no action, 'P' for Publish, or 'U' for Unpublish.
public getPublishAction ( ) : mixed
Результат mixed

getSectionPageAction() публичный Метод

This can be NULL for no action, 'S' for Show, or 'R' for Remove.
public getSectionPageAction ( ) : mixed
Результат mixed

setActionTime() публичный Метод

The parameter given should be in the form "YYYY-MM-DD HH:MM:SS".
public setActionTime ( string $p_value ) : boolean
$p_value string
Результат boolean

setArticleNumber() публичный Метод

Set the Article number.
public setArticleNumber ( integer $p_value ) : boolean
$p_value integer
Результат boolean

setCompleted() публичный Метод

Mark that this action has been completed.
public setCompleted ( ) : void
Результат void

setFrontPageAction() публичный Метод

This can be NULL for no action, 'S' for Show, or 'R' for Remove.
public setFrontPageAction ( $p_value ) : mixed
Результат mixed

setLanguageId() публичный Метод

Set the language ID.
public setLanguageId ( integer $p_value ) : boolean
$p_value integer
Результат boolean

setPublishAction() публичный Метод

Set the published state to switch to when the "publish time" arrives: NULL for no action, 'P' for Publish, or 'U' for Unpublish.
public setPublishAction ( $p_value ) : void
Результат void

setSectionPageAction() публичный Метод

This can be NULL for no action, 'S' for Show, or 'R' for Remove.
public setSectionPageAction ( $p_value ) : mixed
Результат mixed

Описание свойств

$m_columnNames публичное свойство

public $m_columnNames

$m_dbTableName публичное свойство

public $m_dbTableName

$m_keyColumnNames публичное свойство

public $m_keyColumnNames

$m_keyIsAutoIncrement публичное свойство

public $m_keyIsAutoIncrement