Class CommonTreeDropdown

CommonTreeDropdown Class

Hierarchical and cross entities

CommonGLPI

CommonDBTM

CommonDropdown

CommonTreeDropdown

Direct known subclasses

BusinessCriticity, CommonImplicitTreeDropdown, SoftwareLicenseType, State, TaskCategory, DocumentCategory, Entity, Group, ITILCategory, KnowbaseItemCategory, Location, SoftwareCategory, SoftwareLicense

Indirect known subclasses

IPNetwork

Abstract
Located at commontreedropdown.class.php

Methods summary
`public array`	# `getAdditionalFields( )` Return Additional Fields for this type Return Additional Fields for this type Returns array Overrides `CommonDropdown::getAdditionalFields()`
`public array`	# `defineTabs( array $options = [] )` Define tabs to display 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 `CommonDropdown::defineTabs()`
`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 `CommonGLPI::getTabNameForItem()`
`public static boolean`	# `displayTabContentForItem( CommonGLPI $item, integer $tabnum = 1, boolean $withtemplate = 0 )` show Tab content 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 `CommonGLPI::displayTabContentForItem()`
`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`	# `adaptTreeFieldsFromUpdateOrAdd( $input )` Parameters `$input`
`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 `CommonDropdown::prepareInputForAdd()`
`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 `CommonDropdown::pre_deleteItem()`
`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 `CommonDropdown::prepareInputForUpdate()`
`public`	# `regenerateTreeUnderID( $ID, $updateName, $changeParent )` Parameters `$ID` `$updateName` `$changeParent`
`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 `CommonDBTM::post_addItem()`
`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 `CommonDBTM::post_updateItem()`
`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 `CommonDBTM::post_deleteFromDB()`
`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 `CommonDropdown::getSpecificMassiveActions()`
`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 `CommonDropdown::showMassiveActionsSubForm()`
`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 `CommonDropdown::processMassiveActionsForOneItemtype()`
`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 `CommonDropdown::rawSearchOptions()`
`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 `CommonDropdown::haveChildren()`
`public static string`	# `cleanTreeText( $value )` reformat text field describing a tree (such as completename) reformat text field describing a tree (such as completename) Parameters `$value` string 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 `CommonDropdown::findID()`
`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 `CommonDropdown::import()`

Methods inherited from CommonDropdown
`displayHeader(), displaySpecificTypeField(), getLinks(), getMenuContent(), getMenuShorcut(), getTypeName(), importExternal(), isUsed(), maybeTranslated(), showDeleteConfirmForm(), showForm(), title()`

Methods inherited from CommonDBTM
__construct(), add(), addFiles(), addForwardEntity(), addMessageOnAddAction(), addMessageOnDeleteAction(), addMessageOnPurgeAction(), addMessageOnRestoreAction(), addMessageOnUpdateAction(), addNeededInfoToInput(), addToDB(), can(), canAddItem(), canCreate(), canCreateItem(), canDelete(), canDeleteItem(), canEdit(), canGlobal(), canMassiveAction(), canPurge(), canPurgeItem(), canUnrecurs(), canUpdate(), canUpdateItem(), canView(), canViewItem(), check(), checkEntity(), checkGlobal(), checkSpecificValues(), checkUnicity(), cleanDBonMarkDeleted(), cleanDBonPurge(), cleanHistory(), cleanRelationData(), cleanRelationTable(), cleanTranslations(), clearSavedInput(), delete(), deleteByCriteria(), deleteChildrenAndRelationsFromDb(), deleteFromDB(), dropdown(), filterValues(), find(), forceTable(), forwardEntityInformations(), generateLinkContents(), getAutofillMark(), getComments(), getCompleteNameField(), getEmpty(), getEntityID(), getField(), getForbiddenStandardMassiveAction(), getForeignKeyField(), getForeignKeyFieldsOf(), getFromDB(), getFromDBByCrit(), getFromDBByRequest(), getFromIter(), getFromResultSet(), getID(), getIndexName(), getItemEntity(), getLink(), getLinkURL(), getLinkedItems(), getLinkedItemsCount(), getLogTypeID(), getMassiveActionsForItemtype(), getName(), getNameField(), getNameID(), getOptions(), getPostAdditionalInfosForName(), getPreAdditionalInfosForName(), getRawCompleteName(), getRawName(), getRights(), getSearchOptionByField(), getSearchOptionIDByField(), getSearchOptionsToAdd(), getSpecificValueToDisplay(), getSpecificValueToSelect(), getTable(), getTableField(), getTablesOf(), getUnallowedFieldsForUnicity(), getUnicityErrorMessage(), getUnicityFieldsToDisplayInErrorMessage(), getValueToDisplay(), getValueToSelect(), initForm(), isActive(), isDeleted(), isDynamic(), isEntityAssign(), isEntityForwardTo(), isField(), isNewID(), isNewItem(), isPrivate(), isRecursive(), isTemplate(), listTemplates(), maybeActive(), maybeDeleted(), maybeDynamic(), maybeLocated(), maybePrivate(), maybeRecursive(), maybeTemplate(), post_deleteItem(), post_getEmpty(), post_getFromDB(), post_purgeItem(), post_restoreItem(), pre_updateInDB(), reset(), restore(), restoreInDB(), restoreInput(), saveInput(), searchOptions(), showDates(), showFormButtons(), showFormHeader(), unsetUndisclosedFields(), update(), updateInDB(), useDeletedToLockIfDynamic()

Methods inherited from CommonGLPI
addDefaultFormTab(), addStandardTab(), createTabEntry(), defineAllTabs(), display(), displayStandardTab(), getAdditionalMenuContent(), getAdditionalMenuLinks(), getAdditionalMenuOptions(), getAvailableDisplayOptions(), getDisplayOptions(), getDisplayOptionsLink(), getErrorMessage(), getForbiddenActionsForMenu(), getFormURL(), getFormURLWithID(), getMenuName(), getOtherTabs(), getSearchURL(), getTabsURL(), getType(), isLayoutExcludedPage(), isLayoutWithMain(), redirectToList(), registerStandardTab(), showDebugInfo(), showDislayOptions(), showNavigationHeader(), showPrimaryForm(), showTabsContent(), updateDisplayOptions()

Properties summary
`public boolean`	`$can_be_translated`	# `false`

Properties inherited from CommonDropdown
`$display_dropdowntitle, $dohistory, $first_level_menu, $must_be_replace, $rightname, $second_level_menu, $third_level_menu`

Properties inherited from CommonDBTM
`$additional_fields_for_dictionnary, $auto_message_on_action, $fields, $fkfield, $foreign_key_fields_of, $forward_entity_to, $get_item_to_display_tab, $history_blacklist, $no_form_page, $notable, $notificationqueueonaction, $plugins_forward_entity, $searchopt, $tables_of, $taborientation, $usenotepad`

Properties inherited from CommonGLPI
`$displaylist, $othertabs, $showdebug, $type`

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

Class CommonTreeDropdown

Direct known subclasses

Indirect known subclasses

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Since

Overrides

Parameters

Returns

Since

Overrides

Parameters

Parameters

Parameters

Returns

Since

See

Overrides

Returns

Overrides

Parameters

Returns

Since

See

Overrides

Parameters

Parameters

Overrides

Parameters

Overrides

Overrides

Returns

Parameters

Returns

See

Overrides

Parameters

Returns

Since

See

Overrides

Parameters

Returns

Since

See

Overrides

Returns

Since

See

Overrides

Overrides

Parameters

Returns

Parameters

Returns

Overrides

Parameters

Returns

Overrides