Overview

Namespaces

  • Glpi
    • Cache
    • Console
      • Command
      • Database
      • Ldap
      • Migration
      • Security
      • Task
    • Exception
  • None

Classes

  • AbstractQuery
  • Ajax
  • Alert
  • API
  • APIClient
  • APIRest
  • APIXmlrpc
  • Auth
  • AuthLDAP
  • AuthLdapReplicate
  • AuthMail
  • AutoUpdateSystem
  • Blacklist
  • BlacklistedMailContent
  • Budget
  • BudgetType
  • BusinessCriticity
  • Calendar
  • Calendar_Holiday
  • CalendarSegment
  • Cartridge
  • CartridgeItem
  • CartridgeItem_PrinterModel
  • CartridgeItemType
  • Central
  • Certificate
  • Certificate_Item
  • CertificateType
  • Change
  • Change_Group
  • Change_Item
  • Change_Problem
  • Change_Supplier
  • Change_Ticket
  • Change_User
  • ChangeCost
  • ChangeTask
  • ChangeValidation
  • CliMigration
  • CommonDBChild
  • CommonDBConnexity
  • CommonDBRelation
  • CommonDBTM
  • CommonDBVisible
  • CommonDCModelDropdown
  • CommonDevice
  • CommonDeviceModel
  • CommonDeviceType
  • CommonDropdown
  • CommonGLPI
  • CommonImplicitTreeDropdown
  • CommonITILActor
  • CommonITILCost
  • CommonITILObject
  • CommonITILTask
  • CommonITILValidation
  • CommonTreeDropdown
  • Computer
  • Computer_Item
  • Computer_SoftwareLicense
  • Computer_SoftwareVersion
  • ComputerAntivirus
  • ComputerModel
  • ComputerType
  • ComputerVirtualMachine
  • Config
  • Consumable
  • ConsumableItem
  • ConsumableItemType
  • Contact
  • Contact_Supplier
  • ContactType
  • Contract
  • Contract_Item
  • Contract_Supplier
  • ContractCost
  • ContractType
  • CronTask
  • CronTaskLog
  • Datacenter
  • DBConnection
  • DBmysql
  • DBmysqlIterator
  • DbUtils
  • DCRoom
  • DeviceBattery
  • DeviceBatteryModel
  • DeviceBatteryType
  • DeviceCase
  • DeviceCaseModel
  • DeviceCaseType
  • DeviceControl
  • DeviceControlModel
  • DeviceDrive
  • DeviceDriveModel
  • DeviceFirmware
  • DeviceFirmwareModel
  • DeviceFirmwareType
  • DeviceGeneric
  • DeviceGenericModel
  • DeviceGenericType
  • DeviceGraphicCard
  • DeviceGraphicCardModel
  • DeviceHardDrive
  • DeviceHardDriveModel
  • DeviceMemory
  • DeviceMemoryModel
  • DeviceMemoryType
  • DeviceMotherboard
  • DeviceMotherBoardModel
  • DeviceNetworkCard
  • DeviceNetworkCardModel
  • DevicePci
  • DevicePciModel
  • DevicePowerSupply
  • DevicePowerSupplyModel
  • DeviceProcessor
  • DeviceProcessorModel
  • DeviceSensor
  • DeviceSensorModel
  • DeviceSensorType
  • DeviceSimcard
  • DeviceSimcardType
  • DeviceSoundCard
  • DeviceSoundCardModel
  • DisplayPreference
  • Document
  • Document_Item
  • DocumentCategory
  • DocumentType
  • Domain
  • Dropdown
  • DropdownTranslation
  • Enclosure
  • EnclosureModel
  • Entity
  • Entity_KnowbaseItem
  • Entity_Reminder
  • Entity_RSSFeed
  • Fieldblacklist
  • FieldUnicity
  • Filesystem
  • FQDN
  • FQDNLabel
  • GLPI
  • GLPIKey
  • GLPIMailer
  • GLPINetwork
  • GLPIPDF
  • GLPIUploadHandler
  • Group
  • Group_KnowbaseItem
  • Group_Problem
  • Group_Reminder
  • Group_RSSFeed
  • Group_Ticket
  • Group_User
  • Holiday
  • Html
  • HTMLTableBase
  • HTMLTableCell
  • HTMLTableEntity
  • HTMLTableGroup
  • HTMLTableHeader
  • HTMLTableMain
  • HTMLTableRow
  • HTMLTableSubHeader
  • HTMLTableSuperHeader
  • Infocom
  • InterfaceType
  • IPAddress
  • IPAddress_IPNetwork
  • IPNetmask
  • IPNetwork
  • IPNetwork_Vlan
  • Item_DeviceBattery
  • Item_DeviceCase
  • Item_DeviceControl
  • Item_DeviceDrive
  • Item_DeviceFirmware
  • Item_DeviceGeneric
  • Item_DeviceGraphicCard
  • Item_DeviceHardDrive
  • Item_DeviceMemory
  • Item_DeviceMotherboard
  • Item_DeviceNetworkCard
  • Item_DevicePci
  • Item_DevicePowerSupply
  • Item_DeviceProcessor
  • Item_Devices
  • Item_DeviceSensor
  • Item_DeviceSimcard
  • Item_DeviceSoundCard
  • Item_Disk
  • Item_Enclosure
  • Item_OperatingSystem
  • Item_Problem
  • Item_Project
  • Item_Rack
  • Item_Ticket
  • Itil_Project
  • ITILCategory
  • ITILFollowup
  • ITILSolution
  • Knowbase
  • KnowbaseItem
  • KnowbaseItem_Comment
  • KnowbaseItem_Item
  • KnowbaseItem_Profile
  • KnowbaseItem_Revision
  • KnowbaseItem_User
  • KnowbaseItemCategory
  • KnowbaseItemTranslation
  • LevelAgreement
  • LevelAgreementLevel
  • Line
  • LineOperator
  • LineType
  • Link
  • Link_Itemtype
  • Location
  • Lock
  • Log
  • MailCollector
  • Manufacturer
  • MassiveAction
  • Migration
  • MigrationCleaner
  • Monitor
  • MonitorModel
  • MonitorType
  • Netpoint
  • Network
  • NetworkAlias
  • NetworkEquipment
  • NetworkEquipmentModel
  • NetworkEquipmentType
  • NetworkInterface
  • NetworkName
  • NetworkPort
  • NetworkPort_NetworkPort
  • NetworkPort_Vlan
  • NetworkPortAggregate
  • NetworkPortAlias
  • NetworkPortDialup
  • NetworkPortEthernet
  • NetworkPortFiberchannel
  • NetworkPortInstantiation
  • NetworkPortLocal
  • NetworkPortMigration
  • NetworkPortWifi
  • Notepad
  • Notification
  • Notification_NotificationTemplate
  • NotificationAjax
  • NotificationAjaxSetting
  • NotificationEvent
  • NotificationEventAbstract
  • NotificationEventAjax
  • NotificationEventMailing
  • NotificationMailing
  • NotificationMailingSetting
  • NotificationSetting
  • NotificationSettingConfig
  • NotificationTarget
  • NotificationTargetCartridgeItem
  • NotificationTargetCertificate
  • NotificationTargetChange
  • NotificationTargetCommonITILObject
  • NotificationTargetConsumableItem
  • NotificationTargetContract
  • NotificationTargetCrontask
  • NotificationTargetDBConnection
  • NotificationTargetFieldUnicity
  • NotificationTargetInfocom
  • NotificationTargetMailCollector
  • NotificationTargetObjectLock
  • NotificationTargetPlanningRecall
  • NotificationTargetProblem
  • NotificationTargetProject
  • NotificationTargetProjectTask
  • NotificationTargetReservation
  • NotificationTargetSavedsearch_Alert
  • NotificationTargetSoftwareLicense
  • NotificationTargetTicket
  • NotificationTargetUser
  • NotificationTemplate
  • NotificationTemplateTranslation
  • NotImportedEmail
  • ObjectLock
  • OLA
  • OlaLevel
  • OlaLevel_Ticket
  • OlaLevelAction
  • OlaLevelCriteria
  • OperatingSystem
  • OperatingSystemArchitecture
  • OperatingSystemEdition
  • OperatingSystemKernel
  • OperatingSystemKernelVersion
  • OperatingSystemServicePack
  • OperatingSystemVersion
  • PDU
  • Pdu_Plug
  • PDU_Rack
  • PDUModel
  • PDUType
  • Peripheral
  • PeripheralModel
  • PeripheralType
  • Phone
  • PhoneModel
  • PhonePowerSupply
  • PhoneType
  • Planning
  • PlanningRecall
  • Plug
  • Plugin
  • Preference
  • Printer
  • PrinterModel
  • PrinterType
  • Problem
  • Problem_Supplier
  • Problem_Ticket
  • Problem_User
  • ProblemCost
  • ProblemTask
  • Profile
  • Profile_Reminder
  • Profile_RSSFeed
  • Profile_User
  • ProfileRight
  • Project
  • ProjectCost
  • ProjectState
  • ProjectTask
  • ProjectTask_Ticket
  • ProjectTaskTeam
  • ProjectTaskTemplate
  • ProjectTaskType
  • ProjectTeam
  • ProjectType
  • PurgeLogs
  • QueryExpression
  • QueryParam
  • QuerySubQuery
  • QueryUnion
  • QueuedNotification
  • Rack
  • RackModel
  • RackType
  • RegisteredID
  • Reminder
  • Reminder_User
  • Report
  • RequestType
  • Reservation
  • ReservationItem
  • RSSFeed
  • RSSFeed_User
  • Rule
  • RuleAction
  • RuleAsset
  • RuleAssetCollection
  • RuleCollection
  • RuleCriteria
  • RuleDictionnaryComputerModel
  • RuleDictionnaryComputerModelCollection
  • RuleDictionnaryComputerType
  • RuleDictionnaryComputerTypeCollection
  • RuleDictionnaryDropdown
  • RuleDictionnaryDropdownCollection
  • RuleDictionnaryManufacturer
  • RuleDictionnaryManufacturerCollection
  • RuleDictionnaryMonitorModel
  • RuleDictionnaryMonitorModelCollection
  • RuleDictionnaryMonitorType
  • RuleDictionnaryMonitorTypeCollection
  • RuleDictionnaryNetworkEquipmentModel
  • RuleDictionnaryNetworkEquipmentModelCollection
  • RuleDictionnaryNetworkEquipmentType
  • RuleDictionnaryNetworkEquipmentTypeCollection
  • RuleDictionnaryOperatingSystem
  • RuleDictionnaryOperatingSystemArchitecture
  • RuleDictionnaryOperatingSystemArchitectureCollection
  • RuleDictionnaryOperatingSystemCollection
  • RuleDictionnaryOperatingSystemServicePack
  • RuleDictionnaryOperatingSystemServicePackCollection
  • RuleDictionnaryOperatingSystemVersion
  • RuleDictionnaryOperatingSystemVersionCollection
  • RuleDictionnaryPeripheralModel
  • RuleDictionnaryPeripheralModelCollection
  • RuleDictionnaryPeripheralType
  • RuleDictionnaryPeripheralTypeCollection
  • RuleDictionnaryPhoneModel
  • RuleDictionnaryPhoneModelCollection
  • RuleDictionnaryPhoneType
  • RuleDictionnaryPhoneTypeCollection
  • RuleDictionnaryPrinter
  • RuleDictionnaryPrinterCollection
  • RuleDictionnaryPrinterModel
  • RuleDictionnaryPrinterModelCollection
  • RuleDictionnaryPrinterType
  • RuleDictionnaryPrinterTypeCollection
  • RuleDictionnarySoftware
  • RuleDictionnarySoftwareCollection
  • RuleImportComputer
  • RuleImportComputerCollection
  • RuleImportEntity
  • RuleImportEntityCollection
  • RuleMailCollector
  • RuleMailCollectorCollection
  • RuleRight
  • RuleRightCollection
  • RuleRightParameter
  • RuleSoftwareCategory
  • RuleSoftwareCategoryCollection
  • RuleTicket
  • RuleTicketCollection
  • SavedSearch
  • SavedSearch_Alert
  • SavedSearch_User
  • Search
  • Session
  • SingletonRuleList
  • SLA
  • SlaLevel
  • SlaLevel_Ticket
  • SlaLevelAction
  • SlaLevelCriteria
  • SLM
  • Software
  • SoftwareCategory
  • SoftwareLicense
  • SoftwareLicenseType
  • SoftwareVersion
  • SolutionTemplate
  • SolutionType
  • SsoVariable
  • Stat
  • State
  • Supplier
  • Supplier_Ticket
  • SupplierType
  • TaskCategory
  • TaskTemplate
  • Telemetry
  • Ticket
  • Ticket_Ticket
  • Ticket_User
  • TicketCost
  • TicketFollowup
  • TicketRecurrent
  • TicketSatisfaction
  • TicketTask
  • TicketTemplate
  • TicketTemplateHiddenField
  • TicketTemplateMandatoryField
  • TicketTemplatePredefinedField
  • TicketValidation
  • Timer
  • Toolbox
  • Transfer
  • Update
  • User
  • UserCategory
  • UserEmail
  • UserTitle
  • VirtualMachineState
  • VirtualMachineSystem
  • VirtualMachineType
  • Vlan
  • WifiNetwork
  • XHProf
  • XML

Interfaces

  • NotificationEventInterface
  • NotificationInterface

Traits

  • DCBreadcrumb

Exceptions

  • CommonDBConnexityItemNotFound
  • HTMLTableCellFatherCoherentHeader
  • HTMLTableCellFatherSameRow
  • HTMLTableCellWithoutFather
  • HTMLTableUnknownHeader
  • HTMLTableUnknownHeaders
  • HTMLTableUnknownHeadersOrder

Functions

  • __
  • __s
  • _n
  • _nx
  • _sn
  • _sx
  • _x
  • autoName
  • closeDBConnections
  • contructListFromTree
  • contructTreeFromList
  • countDistinctElementsInTable
  • countElementsInTable
  • countElementsInTableForEntity
  • countElementsInTableForMyEntities
  • exportArrayToDB
  • formatUserName
  • get_hour_from_sql
  • getAllDatasFromTable
  • getAncestorsOf
  • getDateCriteria
  • getDateRequest
  • getDbRelations
  • getEntitiesRestrictCriteria
  • getEntitiesRestrictRequest
  • getForeignKeyFieldForItemType
  • getForeignKeyFieldForTable
  • getItemForItemtype
  • getItemtypeForForeignKeyField
  • getItemTypeForTable
  • getNextItem
  • getPlural
  • getPreviousItem
  • getRealQueryForTreeItem
  • getSingular
  • getSonsAndAncestorsOf
  • getSonsOf
  • getTableForItemType
  • getTableNameForForeignKeyField
  • getTreeForItem
  • getTreeLeafValueName
  • getTreeValueCompleteName
  • getTreeValueName
  • getUserName
  • glpi_autoload
  • importArrayFromDB
  • isAPI
  • isCommandLine
  • isForeignKeyField
  • isIndex
  • isPluginItemType
  • regenerateTreeCompleteName
  • Overview
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo

Class QueuedNotification

QueuedNotification class

CommonGLPI
Extended by CommonDBTM
Extended by QueuedNotification
Since: 0.85
Located at queuednotification.class.php
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

$nb
Number of items

Returns

string

Overrides

CommonGLPI::getTypeName()
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

CommonDBTM::canCreate()
public static array
# getForbiddenActionsForMenu( )

Get forbidden actions for menu : may be add / template

Get forbidden actions for menu : may be add / template

Returns

array
array of forbidden actions

Since

0.85

Overrides

CommonGLPI::getForbiddenActionsForMenu()
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

CommonDBTM::getForbiddenStandardMassiveAction()
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

CommonDBTM::getSpecificMassiveActions()
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

CommonDBTM::processMassiveActionsForOneItemtype()
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

CommonDBTM::prepareInputForAdd()
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

CommonDBTM::rawSearchOptions()
public static string
# getSpecificValueToDisplay( $field, $values, array $options = [] )

Parameters

$field
$values
$options
array

Returns

string
the string to display

Overrides

CommonDBTM::getSpecificValueToDisplay()
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

CommonDBTM::getSpecificValueToSelect()
public boolean
# sendById( integer $ID )

Send notification in queue

Send notification in queue

Parameters

$ID
Id

Returns

boolean
public static arrray
# cronInfo( $name )

Give cron information

Give cron information

Parameters

$name
task's name

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
# cleanHtml( $string )

Parameters

$string

Since

0.85
Methods inherited from CommonDBTM
__construct(), add(), addFiles(), addForwardEntity(), addMessageOnAddAction(), addMessageOnDeleteAction(), addMessageOnPurgeAction(), addMessageOnRestoreAction(), addMessageOnUpdateAction(), addNeededInfoToInput(), addToDB(), can(), canAddItem(), 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(), 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(), 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_addItem(), post_deleteFromDB(), post_deleteItem(), post_getEmpty(), post_getFromDB(), post_purgeItem(), post_restoreItem(), post_updateItem(), pre_deleteItem(), pre_updateInDB(), prepareInputForUpdate(), reset(), restore(), restoreInDB(), restoreInput(), saveInput(), searchOptions(), showDates(), showFormButtons(), showFormHeader(), showMassiveActionsSubForm(), unsetUndisclosedFields(), update(), updateInDB(), useDeletedToLockIfDynamic()
Methods inherited from CommonGLPI
addDefaultFormTab(), addStandardTab(), createTabEntry(), defineAllTabs(), defineTabs(), display(), displayStandardTab(), displayTabContentForItem(), getAdditionalMenuContent(), getAdditionalMenuLinks(), getAdditionalMenuOptions(), getAvailableDisplayOptions(), getDisplayOptions(), getDisplayOptionsLink(), getErrorMessage(), getFormURL(), getFormURLWithID(), getMenuContent(), getMenuName(), getMenuShorcut(), getOtherTabs(), getSearchURL(), getTabNameForItem(), getTabsURL(), getType(), isLayoutExcludedPage(), isLayoutWithMain(), redirectToList(), registerStandardTab(), showDebugInfo(), showDislayOptions(), showNavigationHeader(), showPrimaryForm(), showTabsContent(), updateDisplayOptions()
Properties summary
public static string $rightname

Rightname used to check rights to do actions on item.

Rightname used to check rights to do actions on item.

# 'queuednotification'
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, $taborientation, $undisclosedFields, $usenotepad
Properties inherited from CommonGLPI
$displaylist, $othertabs, $showdebug, $type
GLPI version 9.4.7 API API documentation generated by ApiGen