ReportInstance
extends DAOEntity
in package
uses
ManagedEntity
ReportInstance entity.
Tags
Table of Contents
Methods
- __callStatic() : AbstractAction
- Magic method to return the action object for an api.
- autocomplete() : AutocompleteAction
- checkAccess() : CheckAccessAction
- create() : DAOCreateAction
- delete() : DAODeleteAction
- export() : ExportAction
- get() : DAOGetAction
- getActions() : GetActions
- 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
- permissions() : array<string|int, array<string|int, mixed>>
- Specify the permissions to access ReportInstance.
- replace() : BasicReplaceAction
- revert() : BasicBatchAction
- save() : DAOSaveAction
- 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
DAOCreateActiondelete()
public
static delete([bool $checkPermissions = TRUE ]) : DAODeleteAction
Parameters
- $checkPermissions : bool = TRUE
Return values
DAODeleteActionexport()
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
GetActionsgetEntityName()
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
GetLinkspermissions()
Specify the permissions to access ReportInstance.
public
static permissions() : array<string|int, array<string|int, mixed>>
Function exists to set the get permission on report instance get to access CiviCRM.
This allows the permission configured on the report to be implemented in the selectWhere hook.
Note this might be better as TRUE rather than access CiviCRM but the latter feels safer given we are deprecating civi-report and should err on the side of stricter security.
Return values
array<string|int, 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
BasicBatchActionsave()
public
static save([bool $checkPermissions = TRUE ]) : DAOSaveAction
Parameters
- $checkPermissions : bool = TRUE
Return values
DAOSaveActionupdate()
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.