Documentation

Domain.php

This api exposes CiviCRM Domain configuration settings.

Table of Contents

Functions

civicrm_api3_domain_get()  : array<string|int, mixed>
Get CiviCRM Domain details.
_civicrm_api3_domain_get_spec()  : mixed
Adjust Metadata for Get action.
civicrm_api3_domain_create()  : array<string|int, mixed>
Create a new Domain.
_civicrm_api3_domain_create_spec()  : mixed
Adjust Metadata for Create action.

Functions

civicrm_api3_domain_get()

Get CiviCRM Domain details.

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

_civicrm_api3_domain_get_spec()

Adjust Metadata for Get action.

_civicrm_api3_domain_get_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_domain_create()

Create a new Domain.

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

_civicrm_api3_domain_create_spec()

Adjust Metadata for Create action.

_civicrm_api3_domain_create_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.


        
On this page

Search results