Methods summary
public static
string
|
#
getTypeName( integer $nb = 0 )
Return the localized name of the current Type
Should be overloaded in each new class
Return the localized name of the current Type
Should be overloaded in each new class
Parameters
Returns
string
Overrides
|
public static
boolean
|
#
canCreate( )
Have I the global right to "create" the Object
May be overloaded if needed (ex KnowbaseItem)
Have I the global right to "create" the Object
May be overloaded if needed (ex KnowbaseItem)
Returns
boolean
Overrides
|
public
array
|
#
getForbiddenStandardMassiveAction( )
Get the standard massive actions which are forbidden
Get the standard massive actions which are forbidden
Returns
array an array of massive actions
Since
0.84
This should be overloaded in Class
Overrides
|
public
array
|
#
getSpecificMassiveActions( object $checkitem = null, $is_deleted = false )
Parameters
- $checkitem
- link item to check right (default NULL)
- $is_deleted
Returns
array an array of massive actions
See
CommonDBTM::getSpecificMassiveActions()
Overrides
|
public static
|
#
processMassiveActionsForOneItemtype( MassiveAction $ma, CommonDBTM $item, array $ids )
Parameters
- $ma
- the current massive action object
- $item
- the item on which apply the massive action
- $ids
- an array of the ids of the item on which apply the action
Returns
(direct submit to $ma object)
See
CommonDBTM::processMassiveActionsForOneItemtype()
Overrides
|
public
array
|
#
prepareInputForAdd( array $input )
Prepare input datas for adding the item
Prepare input datas for adding the item
Parameters
- $input
- datas used to add the item
Returns
array the modified $input array
Overrides
|
public
array
|
#
rawSearchOptions( )
Provides search options configuration. Do not rely directly
on this, @see CommonDBTM::searchOptions instead.
Provides search options configuration. Do not rely directly
on this, @see CommonDBTM::searchOptions instead.
Returns
array a not indexed array of search options
Since
9.3
This should be overloaded in Class
See
https://glpi-developer-documentation.rtfd.io/en/master/devapi/search.html
Overrides
|
public static
string
|
#
getSpecificValueToDisplay( $field, $values, array $options = [] )
Parameters
- $field
- $values
- $options
- array
Returns
string the string to display
Overrides
|
public static
string
|
#
getSpecificValueToSelect( string $field, string $name = '', string|array $values = '', array $options = [] )
display a specific field selection system
display a specific field selection system
Parameters
- $field
- name of the field
- $name
- name of the select (if empty use linkfield) (default '')
- $values
- with the value to select or a Single value (default '')
- $options
- aArray of options
Returns
string the string to display
Since
0.83
Overrides
|
public
boolean
|
#
sendById( integer $ID )
Send notification in queue
Send notification in queue
Parameters
Returns
boolean
|
public static
arrray
|
#
cronInfo( $name )
Give cron information
Parameters
Returns
arrray of information
|
public static
array
|
#
getPendings( string $send_time = null, integer $limit = 20, array $limit_modes = null, array $extra_where = [] )
Get pending notifications in queue
Get pending notifications in queue
Parameters
- $send_time
- Maximum sent_time
- $limit
- Query limit clause
- $limit_modes
- Modes to limit to
- $extra_where
- Extra params to add to the where clause
Returns
array
|
public static
integer
|
#
cronQueuedNotification( CommonDBTM $task = null )
Cron action on notification queue: send notifications in queue
Cron action on notification queue: send notifications in queue
Parameters
- $task
- for log (default NULL)
Returns
integer either 0 or 1
|
public static
integer
|
#
cronQueuedNotificationClean( CommonDBTM $task = null )
Cron action on queued notification: clean notification queue
Cron action on queued notification: clean notification queue
Parameters
- $task
- for log (default NULL)
Returns
integer either 0 or 1
|
public static
|
#
forceSendFor( string $itemtype, integer $items_id )
Force sending all mails in queue for a specific item
Force sending all mails in queue for a specific item
Parameters
- $itemtype
- item type
- $items_id
- id of the item
|
public
true
|
#
showForm( integer $ID, array $options = [] )
Print the queued mail form
Print the queued mail form
Parameters
- $ID
- ID of the item
- $options
- Options
Returns
true if displayed false if item not found or not right to display
|
public static
|
|