Documentation

System.php

This api exposes CiviCRM system functionality.

Includes caching, logging, and checking system functionality.

Table of Contents

Functions

civicrm_api3_system_flush()  : array<string|int, mixed>
Flush all system caches.
_civicrm_api3_system_flush_spec()  : mixed
Adjust Metadata for Flush action.
_civicrm_api3_system_check_spec()  : mixed
System.Check API specification (optional).
civicrm_api3_system_check()  : array<string|int, mixed>
System Check API.
civicrm_api3_system_log()  : array<string|int, mixed>
Log entry to system log table.
_civicrm_api3_system_log_spec()  : mixed
Metadata for log function.
civicrm_api3_system_get()  : array<string|int, mixed>
System.Get API.
_civicrm_api3_system_get_redacted_ini()  : array<string|int, mixed>
Generate a sanitized/anonymized/redacted dump of the PHP configuration.
_civicrm_api3_system_get_redacted_mysql()  : array<string|int, mixed>
Generate ae sanitized/anonymized/redacted dump of MySQL configuration.
_civicrm_api3_system_get_redacted_settings()  : array<string|int, mixed>
Get redacted settings.
_civicrm_api3_system_get_whitelist()  : array<string|int, mixed>
Read a whitelist.
civicrm_api3_system_updatelogtables()  : mixed
Update log table structures.
civicrm_api3_system_utf8conversion()  : array<string|int, mixed>
Update log table structures.
_civicrm_api3_system_utf8conversion_spec()  : mixed
Metadata for conversion function.
_civicrm_api3_system_updatelogtables_spec()  : mixed
Adjust Metadata for Flush action.
civicrm_api3_system_updateindexes()  : array<string|int, mixed>
Update indexes.
_civicrm_api3_system_updateindexes_spec()  : mixed
Declare metadata for api System.getmissingindices
civicrm_api3_system_getmissingindices()  : array<string|int, mixed>
Get an array of indices that should be defined but are not.
_civicrm_api3_system_getmissingindices_spec()  : mixed
Declare metadata for api System.getmissingindices
civicrm_api3_system_createmissinglogtables()  : mixed
Creates missing log tables.
civicrm_api3_system_rebuildmultilingualschema()  : mixed
Rebuild Multilingual Schema

Functions

civicrm_api3_system_flush()

Flush all system caches.

civicrm_api3_system_flush(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>

Input parameters.

  • triggers: bool, whether to drop/create SQL triggers; default: FALSE
  • session: bool, whether to reset the CiviCRM session data; default: FALSE
Return values
array<string|int, mixed>

_civicrm_api3_system_flush_spec()

Adjust Metadata for Flush action.

_civicrm_api3_system_flush_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters
$params : array<string|int, mixed>

Array of parameters determined by getfields.

civicrm_api3_system_check()

System Check API.

civicrm_api3_system_check(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>
Tags
see
civicrm_api3_create_success
see
civicrm_api3_create_error
throws
CRM_Core_Exception
Return values
array<string|int, mixed> —

API result descriptor; return items are alert codes/messages

civicrm_api3_system_log()

Log entry to system log table.

civicrm_api3_system_log(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>
Return values
array<string|int, mixed>

_civicrm_api3_system_log_spec()

Metadata for log function.

_civicrm_api3_system_log_spec(array<string|int, mixed> &$params) : mixed
Parameters
$params : array<string|int, mixed>

civicrm_api3_system_get()

System.Get API.

civicrm_api3_system_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>
Return values
array<string|int, mixed>

_civicrm_api3_system_get_redacted_ini()

Generate a sanitized/anonymized/redacted dump of the PHP configuration.

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

Some INI fields contain site-identifying information (SII) -- e.g. URLs, hostnames, file paths, IP addresses, passwords, or free-form comments could be used to identify a site or gain access to its resources.

A number of INI fields have been examined to determine whether they contain SII. Approved fields are put in a whitelist; all other fields are redacted.

Redaction hides the substance of a field but does not completely omit all information. Consider the field 'mail.log' - setting this field has a functional effect (it enables or disables the logging behavior) and also points to particular file. Empty values (FALSE/NULL/0/"") will pass through redaction, but all other values will be replaced by a string (eg "REDACTED"). This roughly indicates whether the option is enabled/disabled without giving away its content.

Return values
array<string|int, mixed>

_civicrm_api3_system_get_redacted_mysql()

Generate ae sanitized/anonymized/redacted dump of MySQL configuration.

_civicrm_api3_system_get_redacted_mysql() : array<string|int, mixed>
Tags
see
_civicrm_api3_system_get_redacted_ini
Return values
array<string|int, mixed>

_civicrm_api3_system_get_redacted_settings()

Get redacted settings.

_civicrm_api3_system_get_redacted_settings() : array<string|int, mixed>
Tags
throws
CRM_Core_Exception
Return values
array<string|int, mixed>

_civicrm_api3_system_get_whitelist()

Read a whitelist.

_civicrm_api3_system_get_whitelist(string $whitelistFile) : array<string|int, mixed>
Parameters
$whitelistFile : string

Name of a file. Each line is a field name. Comments begin with "#".

Return values
array<string|int, mixed>

civicrm_api3_system_updatelogtables()

Update log table structures.

civicrm_api3_system_updatelogtables(mixed $params) : mixed

This updates the engine type if defined in the hook and changes the field type for log_conn_id to reflect CRM-18193.

Parameters
$params : mixed

civicrm_api3_system_utf8conversion()

Update log table structures.

civicrm_api3_system_utf8conversion(array<string|int, mixed> $params) : array<string|int, mixed>

This updates the engine type if defined in the hook and changes the field type for log_conn_id to reflect CRM-18193.

Parameters
$params : array<string|int, mixed>
Tags
throws
CRM_Core_Exception
Return values
array<string|int, mixed>

_civicrm_api3_system_utf8conversion_spec()

Metadata for conversion function.

_civicrm_api3_system_utf8conversion_spec(array<string|int, mixed> &$params) : mixed
Parameters
$params : array<string|int, mixed>

_civicrm_api3_system_updatelogtables_spec()

Adjust Metadata for Flush action.

_civicrm_api3_system_updatelogtables_spec(array<string|int, mixed> &$params) : mixed

The metadata is used for setting defaults, documentation & validation.

Parameters
$params : array<string|int, mixed>

Array of parameters determined by getfields.

civicrm_api3_system_updateindexes()

Update indexes.

civicrm_api3_system_updateindexes(array<string|int, mixed> $params) : array<string|int, mixed>

This adds any indexes that exist in the schema but not the database.

Parameters
$params : array<string|int, mixed>
Return values
array<string|int, mixed>

_civicrm_api3_system_updateindexes_spec()

Declare metadata for api System.getmissingindices

_civicrm_api3_system_updateindexes_spec(array<string|int, mixed> &$params) : mixed
Parameters
$params : array<string|int, mixed>

civicrm_api3_system_getmissingindices()

Get an array of indices that should be defined but are not.

civicrm_api3_system_getmissingindices(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>
Return values
array<string|int, mixed>

_civicrm_api3_system_getmissingindices_spec()

Declare metadata for api System.getmissingindices

_civicrm_api3_system_getmissingindices_spec(array<string|int, mixed> &$params) : mixed
Parameters
$params : array<string|int, mixed>

civicrm_api3_system_createmissinglogtables()

Creates missing log tables.

civicrm_api3_system_createmissinglogtables() : mixed

CRM-20838 - This adds any missing log tables into the database.

civicrm_api3_system_rebuildmultilingualschema()

Rebuild Multilingual Schema

civicrm_api3_system_rebuildmultilingualschema() : mixed 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results