dcMaintenanceAdmin Class Reference

Static Public Member Functions
static	dcMaintenanceInit (dcMaintenance $maintenance)
static	adminDashboardFavorites (dcFavorites $favs)
static	adminDashboardFavoritesActive ($request, $params)
static	adminDashboardFavoritesCallback (ArrayObject $icon)
static	adminDashboardItems (ArrayObject $items)
static	adminDashboardOptionsForm ()
static	adminAfterDashboardOptionsUpdate (?string $user_id=null)
static	adminPageHelpBlock (ArrayObject $blocks)
static	pluginsToolsHeaders (string $module)

Member Function Documentation

dcMaintenanceInit()

static dcMaintenanceInit ( dcMaintenance  $maintenance )

static

Register default tasks.

Parameters

dcMaintenance

$maintenance

dcMaintenance instance

References dcMaintenance\addTab().

adminDashboardFavorites()

static adminDashboardFavorites ( dcFavorites  $favs )

static

Favorites

Parameters

dcFavorites

$favs

favs

References dcCore\app(), dcPage\getPF(), dcAuth\PERMISSION_ADMIN, and dcFavorites\register().

adminDashboardFavoritesActive()

static adminDashboardFavoritesActive (   $request,   $params  )

static

Is maintenance plugin active

Parameters

string	$request	The request
array	$params	The parameters

Returns

bool true if maintenance plugin is active else false

adminDashboardFavoritesCallback()

static adminDashboardFavoritesCallback ( ArrayObject  $icon )

static

Favorites hack.

This updates maintenance fav icon text if there are tasks required maintenance.

Parameters

arrayObject

$icon

The icon

References dcCore\app(), and dcPage\getPF().

adminDashboardItems()

static adminDashboardItems ( ArrayObject  $items )

static

Dashboard items stack.

Parameters

arrayObject

$items

The items

References dcAdminHelper\adminIcon(), dcCore\app(), dt\dt2str(), and dcPage\getPF().

adminDashboardOptionsForm()

static adminDashboardOptionsForm ( )

static

User preferences form.

This add options for superadmin user to show or not expired taks.

References dcCore\app(), and form\checkbox().

adminAfterDashboardOptionsUpdate()

static adminAfterDashboardOptionsUpdate ( ?string  $user_id = null )

static

User preferences update.

Parameters

string

$user_id

The user identifier

References dcCore\app().

adminPageHelpBlock()

static adminPageHelpBlock ( ArrayObject  $blocks )

static

Build a well sorted help for tasks.

This method is not so good if used with lot of tranlsations as it grows memory usage and translations files size, it is better to use help ressource files but keep it for exemple of how to use behavior adminPageHelpBlock. Cheers, JC

Parameters

arrayObject

$blocks

The blocks

pluginsToolsHeaders()

static pluginsToolsHeaders ( string  $module )

static

Add javascript for plugin configuration.

Parameters

string

$module

The module

Returns

string

References dcPage\jsModuleLoad().

---

The documentation for this class was generated from the following file:

• plugins/maintenance/inc/admin.behaviors.php