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`