PHP Class Scalr_UI_Controller_Announcements

Inheritance: extends Scalr_UI_Controller

Datei anzeigen Open project: scalr/scalr Class Usage Examples

Public Methods

Method	Description
defaultAction ( )
hasAccess ( )
viewAction ( )
xListAction ( JsonData $sort, string $query = null, integer $start, integer $limit = 25 )
xListAnnouncementsAction ( ) : array	Get announcements for dashboard Announcement and popup What's new in Scalr
xRemoveAction ( JsonData $ids )
xSaveAction ( string $msg, string $title, integer $id = null )	Add or update announcement message
xSetTmAction ( integer $tm )	If session is not virtual, - sets UserSetting::NAME_UI_ANNOUNCEMENT_TIME

Private Methods

Method	Description
dbAnnouncements ( $type, $params ) : array	Get announcements from DB ordered by added desc
getRssFeedXml ( string $url ) : SimpleXMLElement \| false	Get RSS feed content
prepareDataForDashboard ( Announcement $announcement ) : array	Transform entity of type MESSAGE for client-side (dashboard, popup)
prepareDataForList ( Announcement $announcement ) : array	Transform entity of type MESSAGE for client-side (view, edit)
rssAnnouncements ( $type, $params ) : array	Get announcements from rss feed or from rss cache if any

Method Details

defaultAction() public method

public defaultAction ( )

hasAccess() public method

public hasAccess ( )

viewAction() public method

public viewAction ( )

xListAction() public method

public xListAction ( JsonData $sort, string $query = null, integer $start, integer $limit = 25 )
$sort	Scalr\UI\Request\JsonData	Sorting order, defaults to added desc
$query	string	optional If set search in fields `id` (exact match), `title`, `msg` (partial match)
$start	integer	optional Offset
$limit	integer	optional Limit

xListAnnouncementsAction() public method

Get announcements for dashboard Announcement and popup What's new in Scalr

public xListAnnouncementsAction ( ) : array
return	array

xRemoveAction() public method

public xRemoveAction ( JsonData $ids )
$ids	Scalr\UI\Request\JsonData	Array of announcements' ids to remove

xSaveAction() public method

Add or update announcement message

public xSaveAction ( string $msg, string $title, integer $id = null )
$msg	string	Announcement's text
$title	string	Announcement's title
$id	integer	optional Announcement's ID

xSetTmAction() public method

If session is not virtual, - sets UserSetting::NAME_UI_ANNOUNCEMENT_TIME

public xSetTmAction ( integer $tm )
$tm	integer	Unix timestamp