Methods summary
public
array
|
#
getAdditionalFields( )
Return Additional Fields for this type
Return Additional Fields for this type
Returns
array
Overrides
|
public
array
|
#
defineTabs( array $options = [] )
Define tabs to display
NB : Only called for existing object
Parameters
- $options
Options
- withtemplate is a template view ?
Returns
array array containing the tabs
Overrides
|
public
string
|
#
getTabNameForItem( CommonGLPI $item, boolean $withtemplate = 0 )
Get Tab Name used for itemtype
Get Tab Name used for itemtype
NB : Only called for existing object Must check right on what will be displayed + template
Parameters
- $item
- Item on which the tab need to be displayed
- $withtemplate
- is a template object ? (default 0)
Returns
string tab name
Since
0.83
Overrides
|
public static
boolean
|
#
displayTabContentForItem( CommonGLPI $item, integer $tabnum = 1, boolean $withtemplate = 0 )
show Tab content
Parameters
- $item
- Item on which the tab need to be displayed
- $tabnum
- tab number (default 1)
- $withtemplate
- is a template object ? (default 0)
Returns
boolean
Since
0.83
Overrides
|
public static
|
#
getCompleteNameFromParents( $parentCompleteName, $thisName )
Compute completename based on parent one
Compute completename based on parent one
Parameters
- $parentCompleteName
- parent complete name (need to be stripslashes / comes from DB)
- $thisName
- item name (need to be addslashes : comes from input)
|
public
|
|
public
array
|
#
prepareInputForAdd( array $input )
Parameters
- $input
- datas used to add the item
Returns
array the modified $input array
Since
0.83.3
See
CommonDBTM::prepareInputForAdd()
Overrides
|
public
boolean
|
#
pre_deleteItem( )
Actions done before the DELETE of the item in the database /
Maybe used to add another check for deletion
Actions done before the DELETE of the item in the database /
Maybe used to add another check for deletion
Returns
boolean true if item need to be deleted else false
Overrides
|
public
array
|
#
prepareInputForUpdate( array $input )
Parameters
- $input
- data used to update the item
Returns
array the modified $input array
Since
0.83.3
See
CommonDBTM::prepareInputForUpdate()
Overrides
|
public
|
|
protected
|
#
cleanParentsSons( null|integer $id = null, boolean $cache = true )
Clean sons of all parents from caches
Clean sons of all parents from caches
Parameters
- $id
- Parent id to clean. Default to current id
- $cache
- Whether to clean cache (defaults to true)
|
protected
|
#
addSonInParents( )
Add new son in its parent in cache
Add new son in its parent in cache
|
public
|
#
post_addItem( )
Actions done after the ADD of the item in the database
Actions done after the ADD of the item in the database
Overrides
|
public
|
#
post_updateItem( boolean $history = 1 )
Actions done after the UPDATE of the item in the database
Actions done after the UPDATE of the item in the database
Parameters
- $history
- store changes history ? (default 1)
Overrides
|
public
|
#
post_deleteFromDB( )
Actions done after the DELETE of the item in the database
Actions done after the DELETE of the item in the database
Overrides
|
public
string
|
#
getTreeLink( )
Get the this for all the current item and all its parent
Get the this for all the current item and all its parent
Returns
string
|
public
|
#
showChildren( )
Print the HTML array children of a TreeDropdown
Print the HTML array children of a TreeDropdown
|
public
array
|
#
getSpecificMassiveActions( object $checkitem = null )
Parameters
- $checkitem
- link item to check right (default NULL)
Returns
array an array of massive actions
See
CommonDBTM::getSpecificMassiveActions()
Overrides
|
public static
boolean
|
#
showMassiveActionsSubForm( MassiveAction $ma )
Parameters
- $ma
- the current massive action object
Returns
boolean false if parameters displayed ?
Since
0.85
See
CommonDBTM::showMassiveActionsSubForm()
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)
Since
0.85
See
CommonDBTM::processMassiveActionsForOneItemtype()
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
|
#
haveChildren( )
Report if a dropdown have Child
Used to (dis)allow delete action
Report if a dropdown have Child
Used to (dis)allow delete action
Overrides
|
public static
string
|
#
cleanTreeText( $value )
reformat text field describing a tree (such as completename)
reformat text field describing a tree (such as completename)
Parameters
Returns
string
|
public
integer
|
#
findID( array & $input )
check if a dropdown already exists (before import)
check if a dropdown already exists (before import)
Parameters
- $input
- of value to import (name)
Returns
integer the ID of the new (or -1 if not found)
Overrides
|
public
integer|boolean
|
#
import( array $input )
Import a dropdown - check if already exists
Import a dropdown - check if already exists
Parameters
- $input
- of value to import (name, ...)
Returns
integer|boolean the ID of the new or existing dropdown (-1 or false on failure)
Overrides
|