PHP Class Reminder, glpi

Inheritance: extends DBTable
Mostrar archivo Open project: glpi-project/glpi Class Usage Examples

Public Properties

Property Type Description
$dohistory From CommonDBTM
$rightname

Protected Properties

Property Type Description
$entities
$groups
$profiles
$users For visibility checks

Public Methods

Method Description
addVisibilityJoins ( $forceall = false ) : string Return visibility joins to add to SQL
addVisibilityRestrict ( ) : string Return visibility SQL restriction to add
canCreate ( )
canCreateItem ( )
canPurge ( )
canPurgeItem ( )
canUpdate ( )
canUpdateItem ( )
canView ( )
canViewItem ( )
cleanDBonPurge ( )
countVisibilities ( )
defineTabs ( $options = [] )
displayPlanningItem ( array $val, $who, $type = "", $complete ) : Nothing Display a Planning Item
displayTabContentForItem ( CommonGLPI $item, $tabnum = 1, $withtemplate )
getAlreadyPlannedInformation ( array $val ) : Already Display a Planning Item
getRights ( $interface = 'central' )
getSearchOptions ( )
getSpecificValueToDisplay ( $field, $values, array $options = [] )
getSpecificValueToSelect ( $field, $name = '', $values = '', array $options = [] )
getTabNameForItem ( CommonGLPI $item, $withtemplate )
getTypeName ( $nb )
haveVisibilityAccess ( ) : boolean Is the login user have access to reminder based on visibility configuration
populatePlanning ( $options = [] ) : array Populate the planning with planned reminder
post_addItem ( )
post_getEmpty ( )
post_getFromDB ( )
post_updateItem ( $history = 1 )
pre_updateInDB ( )
prepareInputForAdd ( $input )
prepareInputForUpdate ( $input )
showForm ( $ID, $options = [] ) Print the reminder form
showListForCentral ( $personal = true ) : Nothing Show list for central view
showVisibility ( ) Show visibility config for a reminder

Method Details

addVisibilityJoins() static public method

Return visibility joins to add to SQL
static public addVisibilityJoins ( $forceall = false ) : string
$forceall force all joins (false by default)
return string joins to add

addVisibilityRestrict() static public method

Return visibility SQL restriction to add
static public addVisibilityRestrict ( ) : string
return string restrict to add

canCreate() static public method

static public canCreate ( )

canCreateItem() public method

public canCreateItem ( )

canPurge() static public method

Since: 0.85 for personnal reminder
static public canPurge ( )

canPurgeItem() public method

See also: CommonDBTM::canPurgeItem()
public canPurgeItem ( )

canUpdate() static public method

Since: 0.85 for personnal reminder
static public canUpdate ( )

canUpdateItem() public method

public canUpdateItem ( )

canView() static public method

static public canView ( )

canViewItem() public method

public canViewItem ( )

cleanDBonPurge() public method

See also: CommonDBTM::cleanDBonPurge()
public cleanDBonPurge ( )

countVisibilities() public method

public countVisibilities ( )

defineTabs() public method

See also: CommonGLPI::defineTabs()
public defineTabs ( $options = [] )

displayPlanningItem() static public method

Display a Planning Item
static public displayPlanningItem ( array $val, $who, $type = "", $complete ) : Nothing
$val array array of the item to display
$who ID of the user (0 if all)
$type position of the item in the time block (in, through, begin or end) (default '')
$complete complete display (more details) (default 0)
return Nothing (display function)

displayTabContentForItem() static public method

static public displayTabContentForItem ( CommonGLPI $item, $tabnum = 1, $withtemplate )
$item CommonGLPI CommonGLPI object
$tabnum (default 1)
$withtemplate (default 0)

getAlreadyPlannedInformation() static public method

Display a Planning Item
static public getAlreadyPlannedInformation ( array $val ) : Already
$val array Array of the item to display
return Already planned information

getRights() public method

See also: commonDBTM::getRights()
public getRights ( $interface = 'central' )

getSearchOptions() public method

public getSearchOptions ( )

getSpecificValueToDisplay() static public method

static public getSpecificValueToDisplay ( $field, $values, array $options = [] )
$field
$values
$options array array

getSpecificValueToSelect() static public method

static public getSpecificValueToSelect ( $field, $name = '', $values = '', array $options = [] )
$field
$name (default '')
$values (default '')
$options array array

getTabNameForItem() public method

See also: CommonGLPI::getTabNameForItem()
public getTabNameForItem ( CommonGLPI $item, $withtemplate )
$item CommonGLPI

getTypeName() static public method

static public getTypeName ( $nb )

haveVisibilityAccess() public method

Is the login user have access to reminder based on visibility configuration
public haveVisibilityAccess ( ) : boolean
return boolean

populatePlanning() static public method

Populate the planning with planned reminder
static public populatePlanning ( $options = [] ) : array
$options array of possible options: - who ID of the user (0 = undefined) - who_group ID of the group of users (0 = undefined) - begin Date - end Date - color - event_type_color - check_planned (boolean) - display_done_events (boolean)
return array of planning item

post_addItem() public method

public post_addItem ( )

post_getEmpty() public method

public post_getEmpty ( )

post_getFromDB() public method

public post_getFromDB ( )

post_updateItem() public method

See also: CommonDBTM::post_updateItem()
public post_updateItem ( $history = 1 )

pre_updateInDB() public method

public pre_updateInDB ( )

prepareInputForAdd() public method

See also: CommonDBTM::prepareInputForAdd()
public prepareInputForAdd ( $input )

prepareInputForUpdate() public method

See also: CommonDBTM::prepareInputForUpdate()
public prepareInputForUpdate ( $input )

showForm() public method

Print the reminder form
public showForm ( $ID, $options = [] )
$ID integer Id of the item to print
$options array of possible options: - target filename : where to go when done. - from_planning_ajax : set to disable planning form part

showListForCentral() static public method

Show list for central view
static public showListForCentral ( $personal = true ) : Nothing
$personal boolean : display reminders created by me ? (true by default)
return Nothing (display function)

showVisibility() public method

Show visibility config for a reminder
public showVisibility ( )

Property Details

$dohistory public_oe property

From CommonDBTM
public $dohistory

$entities protected_oe property

protected $entities

$groups protected_oe property

protected $groups

$profiles protected_oe property

protected $profiles

$rightname static_oe public_oe property

static public $rightname

$users protected_oe property

For visibility checks
protected $users