SearchDisplay
extends DAOEntity
in package
uses
ManagedEntity
SearchDisplay entity.
Provided by the Search Kit extension.
Tags
Table of Contents
Methods
- __callStatic() : AbstractAction
- Magic method to return the action object for an api.
- autocomplete() : AutocompleteAction
- checkAccess() : CheckAccessAction
- create() : DAOCreateAction
- createBatch() : CreateBatch
- delete() : DAODeleteAction
- download() : Download
- emailReport() : EmailReport
- export() : ExportAction
- get() : DAOGetAction
- getActions() : GetActions
- getDefault() : GetDefault
- getEntityName() : string
- Get entity name from called class
- getFields() : DAOGetFieldsAction
- getInfo() : array{name: string, title: string, description: string, title_plural: string, type: string, paths: array, class: string, primary_key: array, searchable: string, dao: string, label_field: string, icon: string}
- Reflection function called by Entity::get()
- getLinks() : GetLinks
- getSearchTasks() : GetSearchTasks
- inlineEdit() : InlineEdit
- permissions() : array<string|int, mixed>
- Returns a list of permissions needed to access the various actions in this api.
- replace() : BasicReplaceAction
- revert() : BasicBatchAction
- run() : Run
- runBatch() : RunBatch
- save() : DAOSaveAction
- saveFile() : SaveFile
- update() : DAOUpdateAction
- getDaoName() : CRM_Core_DAO|string|null
- getEntityTitle() : string
- Overridable function to return a localized title for this entity.
Methods
__callStatic()
Magic method to return the action object for an api.
public
static __callStatic(string $action, array<string|int, mixed> $args) : AbstractAction
Parameters
- $action : string
- $args : array<string|int, mixed>
Tags
Return values
AbstractActionautocomplete()
public
static autocomplete([bool $checkPermissions = true ]) : AutocompleteAction
Parameters
- $checkPermissions : bool = true
Return values
AutocompleteActioncheckAccess()
public
static checkAccess() : CheckAccessAction
Return values
CheckAccessActioncreate()
public
static create([bool $checkPermissions = true ]) : DAOCreateAction
Parameters
- $checkPermissions : bool = true
Return values
DAOCreateActioncreateBatch()
public
createBatch(bool $checkPemissions) : CreateBatch
Parameters
- $checkPemissions : bool
Return values
CreateBatchdelete()
public
static delete([bool $checkPermissions = true ]) : DAODeleteAction
Parameters
- $checkPermissions : bool = true
Return values
DAODeleteActiondownload()
public
static download([bool $checkPermissions = true ]) : Download
Parameters
- $checkPermissions : bool = true
Return values
DownloademailReport()
public
static emailReport([bool $checkPermissions = true ]) : EmailReport
Parameters
- $checkPermissions : bool = true
Return values
EmailReportexport()
public
static export([bool $checkPermissions = true ]) : ExportAction
Parameters
- $checkPermissions : bool = true
Return values
ExportActionget()
public
static get([bool $checkPermissions = true ]) : DAOGetAction
Parameters
- $checkPermissions : bool = true
Return values
DAOGetActiongetActions()
public
static getActions([bool $checkPermissions = true ]) : GetActions
Parameters
- $checkPermissions : bool = true
Return values
GetActionsgetDefault()
public
static getDefault([bool $checkPermissions = true ]) : GetDefault
Parameters
- $checkPermissions : bool = true
Return values
GetDefaultgetEntityName()
Get entity name from called class
public
static getEntityName() : string
Return values
stringgetFields()
public
static getFields([bool $checkPermissions = true ]) : DAOGetFieldsAction
Parameters
- $checkPermissions : bool = true
Return values
DAOGetFieldsActiongetInfo()
Reflection function called by Entity::get()
public
static getInfo() : array{name: string, title: string, description: string, title_plural: string, type: string, paths: array, class: string, primary_key: array, searchable: string, dao: string, label_field: string, icon: string}
Tags
Return values
array{name: string, title: string, description: string, title_plural: string, type: string, paths: array, class: string, primary_key: array, searchable: string, dao: string, label_field: string, icon: string}getLinks()
public
static getLinks([bool $checkPermissions = true ]) : GetLinks
Parameters
- $checkPermissions : bool = true
Return values
GetLinksgetSearchTasks()
public
static getSearchTasks([bool $checkPermissions = true ]) : GetSearchTasks
Parameters
- $checkPermissions : bool = true
Return values
GetSearchTasksinlineEdit()
public
static inlineEdit([bool $checkPermissions = true ]) : InlineEdit
Parameters
- $checkPermissions : bool = true
Return values
InlineEditpermissions()
Returns a list of permissions needed to access the various actions in this api.
public
static permissions() : array<string|int, mixed>
Return values
array<string|int, mixed>replace()
public
static replace([bool $checkPermissions = true ]) : BasicReplaceAction
Parameters
- $checkPermissions : bool = true
Return values
BasicReplaceActionrevert()
public
static revert([bool $checkPermissions = true ]) : BasicBatchAction
Parameters
- $checkPermissions : bool = true
Return values
BasicBatchActionrun()
public
static run([bool $checkPermissions = true ]) : Run
Parameters
- $checkPermissions : bool = true
Return values
RunrunBatch()
public
runBatch(bool $checkPemissions) : RunBatch
Parameters
- $checkPemissions : bool
Return values
RunBatchsave()
public
static save([bool $checkPermissions = true ]) : DAOSaveAction
Parameters
- $checkPermissions : bool = true
Return values
DAOSaveActionsaveFile()
public
static saveFile([bool $checkPermissions = true ]) : SaveFile
Parameters
- $checkPermissions : bool = true
Return values
SaveFileupdate()
public
static update([bool $checkPermissions = true ]) : DAOUpdateAction
Parameters
- $checkPermissions : bool = true
Return values
DAOUpdateActiongetDaoName()
protected
static getDaoName() : CRM_Core_DAO|string|null
Return values
CRM_Core_DAO|string|nullgetEntityTitle()
Overridable function to return a localized title for this entity.
protected
static getEntityTitle([bool $plural = false ]) : string
Parameters
- $plural : bool = false
-
Whether to return a plural title.