Documentation

Download extends AbstractRunAction

in package

• Civi
• Api4
• Action
• SearchDisplay

Download the results of a SearchDisplay as a spreadsheet.

Table of Contents

Properties

$_debugOutput  : mixed

$_actionName  : string

$_apiParams  : array{select: array, where: array, having: array, orderBy: array, limit: int, offset: int, checkPermissions: bool, debug: bool}

$_entityName  : string

$afform  : string

Name of Afform, if this display is embedded (used for permissioning)

$chain  : array<string|int, mixed>

Additional api requests - will be called once per result.

$checkPermissions  : bool

Whether to enforce acl permissions based on the current user.

$debug  : bool

Add debugging info to the api result.

$display  : string|array<string|int, mixed>|null

Either the name of the display or an array containing the display definition (for preview mode)

$filterLabels  : array<string|int, mixed>

Filters passed directly into this display via Afform markup will have their labels appended to the Afform title.

$filters  : array<string|int, mixed>

Search conditions that will be automatically added to the WHERE or HAVING clauses

$format  : string

Requested file format.

$language  : string

Preferred language (optional)

$savedSearch  : string|array<string|int, mixed>

Either the name of the savedSearch or an array containing the savedSearch definition (for preview mode)

$seed  : int

Integer used as a seed when ordering by RAND().

$sort  : array<string|int, mixed>

Array of fields to use for ordering the results

$version  : int

Api version number; cannot be changed.

$_afform  : array<string|int, mixed>

$_arrayStorage  : array<string|int, mixed>

$_entityFields  : array<string|int, mixed>

$_id  : int

$_joinMap  : array<string|int, mixed>

$_paramInfo  : array<string|int, mixed>

$_qfKeys  : array<string|int, mixed>

$_reflection  : ReflectionClass

$_searchEntityFields  : array<string|int, mixed>

$_selectClause  : array<string|int, mixed>

$_selectQuery  : Api4SelectQuery

$currencyFields  : mixed

$editableInfo  : mixed

$entityActions  : array<string|int, mixed>

$formats  : mixed

$tasks  : array<string|int, mixed>

Methods

__call()  : static|mixed

Magic function to provide automatic getter/setter for params.

__construct()  : mixed

Action constructor.

__set()  : mixed

Strictly enforce api parameters

_run()  : mixed

addChain()  : $this

compareValues()  : bool

entityFields()  : array<string|int, mixed>

Returns schema fields for this entity & action.

evaluateCondition()  : bool

This function is used internally for evaluating field annotations.

execute()  : SearchDisplayRunResult

Override execute method to change the result object type

filterCompare()  : bool

getActionName()  : string

getAfform()  : string

getChain()  : array<string|int, mixed>

getCheckPermissions()  : bool

getDebug()  : bool

getDisplay()  : array<string|int, mixed>|string|null

getEntityName()  : string

getFilters()  : array<string|int, mixed>

getFormat()  : string

getLanguage()  : string|null

getParamInfo()  : array<string|int, mixed>

Get documentation for one or all params

getParams()  : array<string|int, mixed>

Serialize this object's params into an array

getPermissions()  : array<string|int, mixed>

getPseudoFields()  : array<string|int, array<string|int, mixed>>

Extra calculated fields provided by SearchKit

getSeed()  : string

getSelectClause()  : array<string|int, SqlExpression, dataType: string}>

Returns the select clause enhanced with metadata

getSort()  : array<string|int, mixed>

offsetExists()  : bool

offsetGet()  : mixed

offsetSet()  : void

offsetUnset()  : void

paramExists()  : bool

reflect()  : ReflectionClass

setAfform()  : $this

setChain()  : $this

setCheckPermissions()  : $this

setDebug()  : $this

setDisplay()  : $this

setFilters()  : $this

setFormat()  : $this

setLanguage()  : $this

setSeed()  : $this

setSort()  : $this

setVersion()  : $this

addCallbackToDebugOutput()  : mixed

When in debug mode, this logs the callback function being used by a Basic*Action class.

addSelectExpression()  : void

applyFilter()  : mixed

applyFilters()  : mixed

Applies supplied filters to the where clause

augmentSelectClause()  : void

Adds additional fields to the select clause required to render the display

checkLinkCondition()  : bool

Evaluate a link condition.

checkLinkConditions()  : bool

Check if a link should be shown based on its conditions.

checkPermissionToLoadSearch()  : mixed

Only SearchKit admins can use unsecured "preview mode" and pass an array for savedSearch or display

checkRequiredFields()  : array<string|int, mixed>

Validates required fields for actions which create a new object.

filterArray()  : array<string|int, mixed>

formatColumnValue()  : string

Returns final formatted column value

formatLink()  : array<string|int, mixed>|null

Format a link to resolve tokens and form the url.

formatResult()  : array<string|int, array{data: array, columns: array}>

Transforms each row into an array of raw data and an array of formatted columns

formatViewValue()  : array<string|int, mixed>|string

Return raw value if it is a single date, otherwise return parent {@inheritDoc}

formatWriteValues()  : mixed

Replaces pseudoconstants in input values

getColumnIcons()  : array<string|int, mixed>

Add icons to a column

getColumnLabel()  : string

getContentDisposition()  : string

Copied from \League\Csv\AbstractCsv::sendHeaders()

getCssRulesSelect()  : array<string|int, mixed>

Return fields needed for the select clause by a set of css rules

getCssStyles()  : array<string|int, mixed>

Evaluates conditional style rules

getField()  : array<string|int, mixed>|null

Returns field definition for a given field or NULL if not found

getIconsSelect()  : array<string|int, mixed>

Return fields needed for calculating a column's icons

getIdKeyName()  : string

Given an entity name, returns the data fieldName used to identify it.

getJoin()  : array{entity: string, alias: string, table: string, bridge: string|null}|null

getJoinFromAlias()  : string

Given an alias like Contact_Email_01_location_type_id this will return Contact_Email_01.location_type_id

getJoinLabel()  : string

getJoins()  : array<string|int, array{entity: string, alias: string, table: string, bridge: string|null}>

getLanguageOptions()  : array<string|int, mixed>

Get available preferred languages.

getMagicProperties()  : array<string|int, mixed>

Get a list of class properties for which magic methods are supported.

getOrderByFromSort()  : array<string|int, mixed>

Transforms the SORT param (which is expected to be an array of arrays) to the ORDER BY clause (which is an associative array of [field => DIR]

getParamDefaults()  : array<string|int, mixed>

getRuleCondition()  : array<string|int, mixed>

Returns the condition of a cssRules

getSelectAliases()  : array<string|int, string>

Returns an array of field names or aliases + allowed suffixes from the SELECT clause

getSelectExpression()  : SqlExpression, dataType: string}|null

getTokens()  : array<string|int, mixed>

Search a string for all square bracket tokens and return their contents (without the brackets)

hasValue()  : bool

Checks if a filter contains a non-empty value

limitArray()  : array<string|int, mixed>

loadSavedSearch()  : mixed

If SavedSearch is supplied as a string, this will load it as an array

loadSearchDisplay()  : void

Loads display if not already an array

preprocessLinks()  : void

Fills in info about each link in the search display.

processResult()  : mixed

queryArray()  : mixed

selectArray()  : array<string|int, mixed>

sendHeaders()  : mixed

Sets headers based on content type and file name

sortArray()  : array<string|int, mixed>

addFilterLabel()  : mixed

Sets $this->filterLabels to provide contextual titles to search Afforms

canAggregate()  : bool

Determines if a column belongs to an aggregate grouping

checkLinkAccess()  : bool

Check if a link should be visible to the user based on their permissions

evaluateFilters()  : bool

fieldBelongsToEntity()  : bool

Check if a field is appropriate for this entity type or sub-type.

findCurrencyField()  : string|null

Find currency field for an entity.

findFKFields()  : array<string|int, string>

Return all fields for this entity with a foreign key

formatColumn()  : array{val: mixed, links: array, edit: array, label: string, title: string, image: array, cssClass: string}

formatEditableColumn()  : array{entity: string, action: string, input_type: string, data_type: string, options: bool, serialize: bool, nullable: bool, fk_entity: string, value_key: string, record: array, value_path: string}|null

formatFieldLinks()  : array<string|int, array{text: string, url: string, target: string}>

Format a field value as links

formatImage()  : array{url: string, width: int, height: int}|null

formatLinksColumn()  : array<string|int, array{text: string, url: string, target: string, style: string, icon: string}>

Format links for a menu/buttons/links column

formatMultiLink()  : array<string|int, mixed>

Returns an array of multiple links for use as a dropdown-select when API::getLinks returns > 1 record

generateFileUrl()  : string

Convert file id to a readable url

getAfformDirectiveFilters()  : array<string|int, string>

Finds all directive filters and applies the ones with a literal value

getAfformFilterFields()  : array<string|int, string>

Returns a list of afform fields used as search filters

getColumnIcon()  : string|null

getCurrencyField()  : string|null

Return the corresponding currency field if a select expression is monetary

getEditableInfo()  : array{entity: string, input_type: string, data_type: string, options: bool, serialize: bool, nullable: bool, fk_entity: string, value_key: string, value_path: string, id_key: string, id_path: string, explicit_join: string, grouping_fields: array}|null

getEntityFields()  : array<string|int, mixed>

Used as a fallback for non-DAO entities which don't use the Query object

getLinkTokens()  : array<string|int, mixed>

Get fields needed by a link which should be added to the SELECT clause

getPermittedLinkAction()  : string|null

Given entity/action name, return the api action name if the user is allowed to run it.

getQfKey()  : string|null

getQuery()  : Api4SelectQuery|bool

Returns a Query object for the search entity, or FALSE if it doesn't have a DAO

getTask()  : array<string|int, mixed>|null

Returns information about a task, but only if user has permission to use it.

getUrl()  : string

getValue()  : mixed

getWhereClauseValues()  : array<string|int, mixed>

Returns any key/value pairs in the WHERE clause (those using the `=` operator)

loadAfform()  : array<string|int, mixed>|false

Return afform with name specified in api call.

outputCSV()  : mixed

Outputs headers and CSV directly to browser for download

outputSpreadsheet()  : mixed

Create PhpSpreadsheet document and output directly to browser for download

preprocessLink()  : void

renameIfAggregate()  : string

replaceTokens()  : string

rewrite()  : string

Rewrite field value, subtituting tokens and evaluating smarty tags

sortCompare()  : mixed

walkFilters()  : bool

Contact::create()
  ->setValue('first_name', 'Hello')
  ->addChain('add_a_group', GroupContact::create()
    ->setValue('contact_id', '$id')
    ->setValue('group_id', 123)
  )