Report
extends AbstractEntity
in package
The Report API allows a user to view and run reports on their data
It bridges over classic CiviReport and SearchKit-based reports to provide an easy way for users to access their reports.
It's also hookable so other extensions could expose Reports (see how civi_report does it
as model)
Tags
Table of Contents
Methods
- __callStatic() : AbstractAction
- Magic method to return the action object for an api.
- checkAccess() : CheckAccessAction
- get() : Get
- getActions() : GetActions
- getEntityName() : string
- Get entity name from called class
- getEntityOptions() : array<string|int, mixed>
- getExtensionOptions() : array<string|int, mixed>
- getFields() : BasicGetFieldsAction
- 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, mixed>
- Returns a list of permissions needed to access the various actions in this api.
- 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
AbstractActioncheckAccess()
public
static checkAccess() : CheckAccessAction
Return values
CheckAccessActionget()
public
static get([bool $checkPermissions = true ]) : Get
Parameters
- $checkPermissions : bool = true
Return values
GetgetActions()
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
stringgetEntityOptions()
public
static getEntityOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>getExtensionOptions()
public
static getExtensionOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>getFields()
public
static getFields([bool $checkPermissions = true ]) : BasicGetFieldsAction
Parameters
- $checkPermissions : bool = true
Return values
BasicGetFieldsActiongetInfo()
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()
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>getDaoName()
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.