Class RuleCollection

Common DataBase Table Manager Class - Persistent Object

CommonGLPI

CommonDBTM

RuleCollection

Direct known subclasses

RuleAssetCollection, RuleDictionnaryDropdownCollection, RuleDictionnaryPrinterCollection, RuleDictionnarySoftwareCollection, RuleImportComputerCollection, RuleImportEntityCollection, RuleMailCollectorCollection, RuleRightCollection, RuleSoftwareCategoryCollection, RuleTicketCollection

Indirect known subclasses

Located at rulecollection.class.php

Methods summary
`public static string`	# `getTable( string $classname = null )` Return the table used to store this object Return the table used to store this object Parameters `$classname` Force class (to avoid late_binding on inheritance) Returns string Overrides `CommonDBTM::getTable()`
`public`	# `setEntity( $entity = 0 )` Parameters `$entity` 0)
`public`	# `canList( )`
`public boolean`	# `isEntityAssign( )` Is the object assigned to an entity Is the object assigned to an entity Can be overloaded (ex : infocom) Returns boolean Overrides `CommonDBTM::isEntityAssign()`
`public :`	# `getCollectionSize( $recursive = true, $condition = 0 )` Get Collection Size : retrieve the number of rules Get Collection Size : retrieve the number of rules Parameters `$recursive` by default) `$condition` by default) Returns : number of rules
`public`	# `getRuleListQuery( $options = [] )` Deprecated 9.4 Parameters `$options` array
`public array`	# `getRuleListCriteria( array $options = [] )` Get rules list criteria Get rules list criteria Parameters `$options` Options Returns array
`public`	# `getCollectionPart( $options = [] )` Get Collection Part : retrieve descriptions of a range of rules Get Collection Part : retrieve descriptions of a range of rules Parameters `$options` of options may be : - start : first rule (in the result set - default 0) - limit : max number of rules to retrieve (default 0) - recursive : boolean get recursive rules - childirens : boolean get childrens rules
`public`	# `getCollectionDatas( $retrieve_criteria = 0, $retrieve_action = 0, $condition = 0 )` Get Collection Datas : retrieve descriptions and rules Get Collection Datas : retrieve descriptions and rules Parameters `$retrieve_criteria` the criterias of the rules ? (default 0) `$retrieve_action` the action of the rules ? (default 0) `$condition` with a specific condition
`public`	# `getRuleClassName( )`
`public`	# `getRuleClass( )` Get a instance of the class to manipulate rule of this collection Get a instance of the class to manipulate rule of this collection
`public true`	# `warningBeforeReplayRulesOnExistingDB( $target )` Is a confirmation needed before replay on DB ? If needed need to send 'replay_confirm' in POST Is a confirmation needed before replay on DB ? If needed need to send 'replay_confirm' in POST Parameters `$target` : where to go when done Returns true if confirmtion is needed, else false
`public -1`	# `replayRulesOnExistingDB( $offset = 0, $maxtime = 0, $items = [], $params = [] )` Replay Collection on DB Replay Collection on DB Parameters `$offset` row to work on (default 0) `$maxtime` max system time to stop working (default 0) `$items` containg items to replay. If empty -> all `$params` additional parameters if needed Returns -1 if all rows done, else offset for next run
`public Title`	# `getTitle( )` Get title used in list of rules Get title used in list of rules Returns Title of the rule collection
`public`	# `isRuleEntityAssigned( )` Indicates if the rule can be affected to an entity or if it's global Indicates if the rule can be affected to an entity or if it's global
`public`	# `isRuleRecursive( )` Indicates if the rule can be affected to an entity or if it's global Indicates if the rule can be affected to an entity or if it's global
`public`	# `isRuleUseConditions( )` Indicates if the rule use conditions Indicates if the rule use conditions
`public`	# `getDefaultRuleConditionForList( )` Indicates if the rule use conditions Indicates if the rule use conditions
`public`	# `showEngineSummary( )`
`public nothing`	# `showListRules( $target, $options = [] )` Show the list of rules Show the list of rules Parameters `$target` `$options` array Returns nothing
`public nothing`	# `showAdditionalInformationsInForm( $target )` Show the list of rules Show the list of rules Parameters `$target` Returns nothing
`public`	# `changeRuleOrder( $ID, $action, $condition = 0 )` Modify rule's ranking and automatically reorder all rules Modify rule's ranking and automatically reorder all rules Parameters `$ID` rule ID whose ranking must be modified `$action` or down `$condition` on a specific condition
`public true`	# `deleteRuleOrder( $ranking )` Update Rule Order when deleting a rule Update Rule Order when deleting a rule Parameters `$ranking` of the deleted rule Returns true if all ok
`public true`	# `moveRule( $ID, $ref_ID, $type = 'after' )` Move a rule in an ordered collection Move a rule in an ordered collection Parameters `$ID` the rule to move `$ref_ID` the rule position (0 means all, so before all or after all) `$type` move : after or before ( default 'after') Returns true if all ok
`public static nothing`	# `titleBackup( )` Print a title for backup rules Print a title for backup rules Returns nothing (display) Since 0.85
`public true`	# `duplicateRule( $ID )` Duplicate a rule Duplicate a rule Parameters `$ID` the rule to duplicate Returns true if all ok Since 0.85
`public static nothing,`	# `exportRulesToXML( items $items = [] )` Export rules in a xml format Export rules in a xml format Parameters `$items` the input data to transform to xml Returns nothing, send attachment to browser Since 0.85
`public static nothing`	# `displayImportRulesForm( )` Print a form to select a xml file for import rules Print a form to select a xml file for import rules Returns nothing (display) Since 0.85
`public static true`	# `isCriteraADropdown( $available_criteria, $condition, $criterion )` Check if a criterion is a dropdown or not Parameters `$available_criteria` criterai for this rule `$condition` rulecriteria condition `$criterion` criterion Returns true if a criterion is a dropdown, false otherwise Since 0.85
`public static true`	# `previewImportRules( )` Print a form to inform user when conflicts appear during the import of rules from a xml file Print a form to inform user when conflicts appear during the import of rules from a xml file Returns true if all ok Since 0.85
`public static true`	# `processImportRules( )` import rules in glpi after user validation import rules in glpi after user validation Returns true if all ok Since 0.85
`public the`	# `processAllRules( input $input = [], output $output = [], params $params = [], options $options = [] )` Process all the rules collection Process all the rules collection Parameters `$input` the input data used to check criterias (need to be clean slashes) `$output` the initial ouput array used to be manipulate by actions (need to be clean slashes) `$params` parameters for all internal functions (need to be clean slashes) `$options` options : - condition : specific condition to limit rule list - only_criteria : only react on specific criteria Returns the output array updated by actions (addslashes datas)
`public`	# `showRulesEnginePreviewCriteriasForm( $target, array $values, $condition = 0 )` Show form displaying results for rule collection preview Show form displaying results for rule collection preview Parameters `$target` to go `$values` of data `$condition` to limit rules (default 0)
`public the`	# `testAllRules( input $input = [], output $output = [], params $params = [], $condition = 0 )` Test all the rules collection Test all the rules collection Parameters `$input` the input data used to check criterias `$output` the initial ouput array used to be manipulate by actions `$params` parameters for all internal functions `$condition` to limit rules (DEFAULT 0) Returns the output array updated by actions
`public the`	# `prepareInputDataForProcess( $input, $params )` Prepare input datas for the rules collection Prepare input datas for the rules collection Parameters `$input` input data used to check criterias `$params` parameters Returns the updated input datas
`public the`	# `prepareInputDataForProcessWithPlugins( $input, $params )` Prepare input datas for the rules collection, also using plugins values Prepare input datas for the rules collection, also using plugins values Parameters `$input` input data used to check criterias `$params` parameters Returns the updated input datas Since 0.84
`public the`	# `prepareInputDataForTestProcess( $condition = 0 )` Prepare input datas for the rules collection Prepare input datas for the rules collection Parameters `$condition` to limit rules (DEFAULT 0) Returns the updated input datas
`public`	# `showRulesEnginePreviewResultsForm( $target, array $input, $condition = 0 )` Show form displaying results for rule engine preview Show form displaying results for rule engine preview Parameters `$target` to go `$input` of data `$condition` to limit rules (DEFAULT 0)
`public cleaned`	# `cleanTestOutputCriterias( array $output )` Unset criterias from the rule's ouput results (begins by _) Unset criterias from the rule's ouput results (begins by _) Parameters `$output` clean output array to clean Returns cleaned array
`public cleaned`	# `showTestResults( $rule, array $output, $global_result )` Show test results for a rule Show test results for a rule Parameters `$rule` object `$output` output data array `$global_result` global result Returns cleaned array
`public`	# `preProcessPreviewResults( $output )` Parameters `$output`
`public nothing`	# `title( )` Print a title if needed which will be displayed above list of rules Print a title if needed which will be displayed above list of rules Returns nothing (display)
`public static the`	# `getClassByType( $itemtype, $check_dictionnary_type = false )` Get rulecollection classname by giving his itemtype Get rulecollection classname by giving his itemtype Parameters `$itemtype` itemtype `$check_dictionnary_type` if the itemtype is a dictionnary or not (false by default) Returns the rulecollection class or null
`public`	# `showInheritedTab( )`
`public`	# `showChildrensTab( )`
`public`	# `getFieldsToLookFor( )` Get all the fields needed to perform the rule Get all the fields needed to perform the rule
`public boolean`	# `isNewItem( )` For tabs management : force isNewItem For tabs management : force isNewItem Returns boolean Since 0.83 Overrides `CommonDBTM::isNewItem()`
`public array`	# `defineTabs( array $options = [] )` Parameters `$options` Options - withtemplate is a template view ? Returns array array containing the tabs See CommonGLPI::defineTabs() Overrides `CommonGLPI::defineTabs()`
`public string`	# `getTabNameForItem( CommonGLPI $item, boolean $withtemplate = 0 )` Parameters `$item` Item on which the tab need to be displayed `$withtemplate` is a template object ? (default 0) Returns string tab name See CommonGLPI::getTabNameForItem() 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 array`	# `getDictionnaries( )` Get list of dictionnaries Get list of dictionnaries Returns array

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(), checkTemplateEntity(), 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(), getSpecificMassiveActions(), getSpecificValueToDisplay(), getSpecificValueToSelect(), getTableField(), getTablesOf(), getUnallowedFieldsForUnicity(), getUnicityErrorMessage(), getUnicityFieldsToDisplayInErrorMessage(), getValueToDisplay(), getValueToSelect(), initForm(), isActive(), isDeleted(), isDynamic(), isEntityForwardTo(), isField(), isNewID(), isPrivate(), isRecursive(), isTemplate(), listTemplates(), maybeActive(), maybeDeleted(), maybeDynamic(), maybeLocated(), maybePrivate(), maybeRecursive(), maybeTemplate(), post_addItem(), post_deleteFromDB(), post_deleteItem(), post_getEmpty(), post_getFromDB(), post_purgeItem(), post_restoreItem(), post_updateItem(), pre_deleteItem(), pre_updateInDB(), prepareInputForAdd(), prepareInputForUpdate(), processMassiveActionsForOneItemtype(), rawSearchOptions(), reset(), restore(), restoreInDB(), restoreInput(), saveInput(), searchOptions(), showDates(), showFormButtons(), showFormHeader(), showMassiveActionsSubForm(), unsetUndisclosedFields(), update(), updateInDB(), useDeletedToLockIfDynamic()

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

Properties summary
`public`	`$sub_type`	#
`public boolean`	`$stop_on_first_match`	# `false`
`public string`	`$orderby`	# `"ranking"`
`public boolean`	`$use_output_rule_process_as_next_input`	# `false`
`public boolean`	`$can_replay_rules`	# `false`
`public`	`$RuleList`	# `null`
`public string`	`$menu_type`	# `"rule"`
`public string`	`$menu_option`	# `""`
`public integer`	`$entity`	# `0`
`public static string`	`$rightname` Rightname used to check rights to do actions on item. Rightname used to check rights to do actions on item.	# `'config'`
`public string`	`$taborientation` Tab orientation : horizontal or vertical. Tab orientation : horizontal or vertical.	# `'horizontal'`

Properties inherited from CommonDBTM
`$additional_fields_for_dictionnary, $auto_message_on_action, $dohistory, $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, $undisclosedFields, $usenotepad`

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

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

Class RuleCollection

Direct known subclasses

Indirect known subclasses

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Deprecated

Parameters

Parameters

Returns

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Returns

Since

Parameters

Returns

Since

Returns

Since

Returns

Since

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Since

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Since

Overrides

Parameters

Returns