* Reference to an activity object.
*
* @return \CRM_Activity_BAO_ICalendar
- * @access public
*/
public function __construct(&$act) {
$this->activity = $act;
* @param null $activityTypeIDs
*
* @return \CRM_Activity_Selector_Activity
- * @access public
*/
function __construct(
$contactId,
* @param null $compContext
*
* @return \CRM_Activity_Selector_Search
- * @access public
*/
function __construct(
&$queryParams,
*
* @return mixed
* $campaigns a set of campaigns.
- * @access public
*/
public static function getCampaigns(
$includeId = NULL,
*
* @throws Exception
* @return void
- * @access public
*/
public static function sendEmail($params, $sendEmailMode) {
* @param string $context
*
* @return \CRM_Campaign_Selector_Search
- * @access public
*/
function __construct(
&$queryParams,
*
* @return array|void
* $activity object of newly creted activity via email
- * @access public
*/
public static function recordActivityViaEmail($file) {
if (!file_exists($file) ||
* @param string $context
*
* @return \CRM_Case_Selector_Search
- * @access public
*/
function __construct(
&$queryParams,
*
* @return int|null
* no of deleted group organization on success, false otherwise
- * @access public
*/
public static function deleteGroupOrganization($groupOrganizationID) {
$results = NULL;
* @param string $operator
*
* @return \CRM_Contact_BAO_Query
- * @access public
*/
function __construct(
$params = NULL, $returnProperties = NULL, $fields = NULL,
* This is contact id for adding relationship.
*
* @return string
- * @access public
*/
public static function checkValidRelationship($params, $ids, $contactId) {
$errors = '';
* @return array
* reference to the array of default values
*
- * @access public
*/
public function setDefaultValues() {
$defaults = array();
* @param null $contextMenu
*
* @return \CRM_Contact_Selector_Custom
- * @access public
*/
function __construct(
$customSearchClass,
*
* @return mixed|null
* $results no of deleted Contribution on success, false otherwise
- * @access public
*/
public static function deleteContribution($id) {
CRM_Utils_Hook::pre('delete', 'Contribution', $id, CRM_Core_DAO::$_nullArray);
* @param null $compContext
*
* @return \CRM_Contribute_Selector_Search
- * @access public
*/
function __construct(
&$queryParams,
*
* @return boolean
* true if error, false otherwise
- * @access public
*/
function civicrm_error($result) {
if (is_array($result)) {
/**
* Save an acl
*
- * Allowed @params array keys are:
* {@getfields acl_create}
* @example aclCreate.php
*
*
* @return array
* Array of newly created acl property values.
- * @access public
*/
function civicrm_api3_acl_create($params) {
return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
/**
* Get an acl
*
- * Allowed @params array keys are:
* {@getfields acl_get}
* @example aclCreate.php
*
*
* @return array
* Array of retrieved acl property values.
- * @access public
*/
function civicrm_api3_acl_get($params) {
return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
/**
* Delete an acl
*
- * Allowed @params array keys are:
* {@getfields acl_delete}
* @example aclCreate.php
*
*
* @return array
* Array of deleted values.
- * @access public
*/
function civicrm_api3_acl_delete($params) {
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
*
* @return array
* Array of newly created acl_role property values.
- * @access public
*/
function civicrm_api3_acl_role_create($params) {
return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
*
* @return array
* Array of retrieved acl_role property values.
- * @access public
*/
function civicrm_api3_acl_role_get($params) {
return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
*
* @return array
* Array of deleted values.
- * @access public
*/
function civicrm_api3_acl_role_delete($params) {
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
* @return array
* API result array
*
- * @access public
*/
function civicrm_api3_action_schedule_delete($params) {
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
*
* @return array
* Array of newly created activity contact records.
- * @access public
*/
function civicrm_api3_activity_contact_create($params) {
return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
* Api Result
*
* @example ActivityContact.php
- * @access public
*/
function civicrm_api3_activity_contact_delete($params) {
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
* @return array
* details of found tags else error
*
- * @access public
*/
function civicrm_api3_activity_contact_get($params) {
return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
*
* @return array
* activity types keyed by id
- * @access public
- *
- * @example ActivityTypeGet.php
* @deprecated - use getoptions
*/
function civicrm_api3_activity_type_get($params) {
* create activity type (
*
* @param array $params
- * Associated array of fields.
- * $params['option_value_id'] is required for updation of activity type
*
* @return array
* created / updated activity type
*
- * @access public
- *
* @deprecated - use option_value create
*/
function civicrm_api3_activity_type_create($params) {
* @return array
* API result array
*
- * @access public
- *
* @deprecated - we will introduce OptionValue Delete- plse consider helping with this if not done
*/
function civicrm_api3_activity_type_delete($params) {
*
* @return array
* Array of newly created tag property values.
- * @access public
*/
function civicrm_api3_address_create(&$params) {
/**
*
* @return array
* api result array
- * @access public
*/
function civicrm_api3_address_delete($params) {
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
* @return array
* details of found addresses else error
* {@getfields address_get}
- * @access public
*/
function civicrm_api3_address_get(&$params) {
return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'Address');
* @param array $params
* @return array
* Array of newly created file property values.
- * @access public
* @throws API_Exception validation errors
*/
function civicrm_api3_attachment_create($params) {
return civicrm_api3_create_success($result, $params, 'Attachment', 'create');
}
+/**
+ * @param $spec
+ */
function _civicrm_api3_attachment_delete_spec(&$spec) {
unset($spec['id']['api.required']);
$entityFileFields = CRM_Core_DAO_EntityFile::fields();
*
* @return array
* Array of newly created batch property values.
- * @access public
*/
function civicrm_api3_batch_create($params) {
return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
*
* @return array
* Array of retrieved batch property values.
- * @access public
*/
function civicrm_api3_batch_get($params) {
return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
*
* @return array
* Array of deleted values.
- * @access public
*/
function civicrm_api3_batch_delete($params) {
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
* @return array
* campaign array
* {@getfields campaign_create}
- * @access public
*/
function civicrm_api3_campaign_create($params) {
return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Campaign');
* (reference) returns flag true if successful, error
* message otherwise
* {@getfields campaign_delete}
- * @access public
*/
function civicrm_api3_campaign_delete($params) {
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
* @return array
* api result array
*
- * @access public
*/
function civicrm_api3_case_update($params) {
//check parameters
* @return boolean
* true if success, else false
* {@getfields case_delete}
- * @access public
*/
function civicrm_api3_case_delete($params) {
//check parameters
* @return array
* API result array
*
- * @access public
*/
function civicrm_api3_case_type_create($params) {
civicrm_api3_verify_mandatory($params, _civicrm_api3_get_DAO(__FUNCTION__));
*
* @return array
* case types keyed by id
- * @access public
*/
function civicrm_api3_case_type_get($params) {
if (!empty($params['options']) && !empty($params['options']['is_count'])) {
* @return array
* API Result Array
*
- * @access public
*/
function civicrm_api3_contact_create($params) {
* @return array
* API Result Array
* {@getfields RelationshipType_delete}
- * @access public
*/
function civicrm_api3_relationship_type_delete($params) {
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
*
* @return array
* details of found instances
- * @access public
*/
function civicrm_api3_report_instance_get($params) {
return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
*
* @return array
* Array of newly created report instance property values.
- * @access public
*/
function civicrm_api3_report_instance_create($params) {
return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
*
* @return array
* Api result
- * @access public
*/
function civicrm_api3_report_instance_delete($params) {
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
* @return array
* details of found Option Values
* {@getfields OptionValue_get}
- * @access public
*/
function civicrm_api3_report_template_get($params) {
require_once 'api/v3/OptionValue.php';
* @return array
* Array of newly created option_value property values.
* {@getfields OptionValue_create}
- * @access public
*/
function civicrm_api3_report_template_create($params) {
require_once 'api/v3/OptionValue.php';
* @return array
* Api result
* {@getfields ReportTemplate_create}
- * @access public
*/
function civicrm_api3_report_template_delete($params) {
require_once 'api/v3/OptionValue.php';
*
* @return array
* details of found instances
- * @access public
*/
function civicrm_api3_report_template_getrows($params) {
civicrm_api3_verify_one_mandatory($params, NULL, array('report_id', 'instance_id'));
*
* @return array
* details of found instances
- * @access public
*/
function _civicrm_api3_report_template_getrows_spec(&$params) {
$params['report_id'] = array(
* @return array
* api result array
* {@getfields setting_create}
- * @access public
*/
function civicrm_api3_setting_create($params) {
$domains = _civicrm_api3_setting_getDomainArray($params);
* @return array
* Array of matching settings
* {@getfields setting_get}
- * @access public
*/
function civicrm_api3_setting_get($params) {
$domains = _civicrm_api3_setting_getDomainArray($params);
* @return array
* Array of matching settings
* {@getfields setting_get}
- * @access public
*/
function civicrm_api3_setting_getvalue($params) {
$config = CRM_Core_Config::singleton();
*
* @return array
* Array of newly created sms_provider property values.
- * @access public
*/
function civicrm_api3_sms_provider_create($params) {
return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
*
* @return array
* Array of retrieved sms_provider property values.
- * @access public
*/
function civicrm_api3_sms_provider_get($params) {
return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
*
* @return array
* Array of deleted values.
- * @access public
*/
function civicrm_api3_sms_provider_delete($params) {
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
* @return array
* api result array
* {@getfields survey_create}
- * @access public
*/
function civicrm_api3_survey_create($params) {
return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Survey');
* @return array
* API result Array of matching surveys
* {@getfields survey_get}
- * @access public
*/
function civicrm_api3_survey_get($params) {
return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'Survey');
* @return array
* api result array
* {@getfields survey_delete}
- * @access public
*/
function civicrm_api3_survey_delete($params) {
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
/**
* System.Get API
*
- * @param arary $params
+ * @param array $params
+ * @return array
*/
function civicrm_api3_system_get($params) {
$returnValues = array(
* @return array
* Array of newly created tag property values.
* {@getfields tag_create}
- * @access public
*/
function civicrm_api3_tag_create($params) {
return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
* @return array
* API result array
* {@getfields tag_delete}
- * @access public
*/
function civicrm_api3_tag_delete($params) {
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
* @return array
* details of found tags else error
* {@getfields tag_get}
- * @access public
*/
function civicrm_api3_tag_get($params) {
* (reference) Array
* {@getfields UFField_get
* @example UFFieldGet.php
- * @access public
*/
function civicrm_api3_uf_field_get($params) {
return _civicrm_api3_basic_get('CRM_Core_BAO_UFField', $params);
* API result array
* {@getfields UFGroup_create}
* @example UFGroupCreate.php
- * @access public
*/
function civicrm_api3_uf_group_create($params) {
return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
* Array of matching profiles
* {@getfields UFGroup_get}
* @example UFGroupGet.php
- * @access public
*/
function civicrm_api3_uf_group_get($params) {
* @return array
* api result array
* {@getfields uf_match_create}
- * @access public
*/
function civicrm_api3_uf_match_create($params) {
return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
* @return array
* api result array
* {@getfields uf_match_create}
- * @access public
*/
function civicrm_api3_uf_match_delete($params) {
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
* @return array
* details of found websites
*
- * @access public
*/
function civicrm_api3_website_get($params) {
return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'website');
* @return array
* api result array
*
- * @access public
*/
function civicrm_api3_word_replacement_delete($params) {
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
* @param array $params
* @param string $mode
* @param string $entity
- * @return CRM_Core_DAO
- * query object
+ * @return array(CRM_Core_DAO|CRM_Contact_BAO_Query)
*/
function _civicrm_api3_get_query_object($params, $mode, $entity) {
$options = _civicrm_api3_get_options_from_params($params, TRUE, $entity, 'get');
*
* @return array
*
- * @access public
*/
function _civicrm_api3_dao_to_array($dao, $params = NULL, $uniqueFields = TRUE, $entity = "", $autoFind = TRUE) {
$result = array();
* @param array|bool $uniqueFields
*
* @return array
- * @access public
*/
function _civicrm_api3_object_to_array(&$dao, &$values, $uniqueFields = FALSE) {
* @return bool
* Sshould the missing fields be returned as an array (core error created as default)
* true if all fields present, depending on $result a core error is created of an array of missing fields is returned
- * @access public
*/
function _civicrm_api3_check_required_fields($params, $daoName, $return = FALSE) {
//@deprecated - see notes