drupal-civicrm/sites/all/modules/civicrm/api/v3/Pcp.php
2018-01-14 13:10:16 +00:00

87 lines
3.1 KiB
PHP

<?php
/*
* +--------------------------------------------------------------------+
* | CiviCRM version 4.7 |
* +--------------------------------------------------------------------+
* | Copyright CiviCRM LLC (c) 2004-2017 |
* +--------------------------------------------------------------------+
* | This file is a part of CiviCRM. |
* | |
* | CiviCRM is free software; you can copy, modify, and distribute it |
* | under the terms of the GNU Affero General Public License |
* | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
* | |
* | CiviCRM is distributed in the hope that it will be useful, but |
* | WITHOUT ANY WARRANTY; without even the implied warranty of |
* | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
* | See the GNU Affero General Public License for more details. |
* | |
* | You should have received a copy of the GNU Affero General Public |
* | License and the CiviCRM Licensing Exception along |
* | with this program; if not, contact CiviCRM LLC |
* | at info[AT]civicrm[DOT]org. If you have questions about the |
* | GNU Affero General Public License or the licensing of CiviCRM, |
* | see the CiviCRM license FAQ at http://civicrm.org/licensing |
* +--------------------------------------------------------------------+
*/
/**
* This api exposes CiviCRM PCP records.
*
*
* @package CiviCRM_APIv3
*/
/**
* Create or update a survey.
*
* @param array $params
* Array per getfields metadata.
*
* @return array api result array
*/
function civicrm_api3_pcp_create($params) {
return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Pcp');
}
/**
* Adjust Metadata for Create action.
*
* The metadata is used for setting defaults, documentation & validation.
*
* @param array $params
* Array of parameters determined by getfields.
*/
function _civicrm_api3_pcp_create_spec(&$params) {
$params['title']['api.required'] = 1;
$params['contact_id']['api.required'] = 1;
$params['page_id']['api.required'] = 1;
$params['pcp_block_id']['api.required'] = 1;
}
/**
* Returns array of pcps matching a set of one or more properties.
*
* @param array $params
* Array per getfields
*
* @return array Array of matching pcps
*/
function civicrm_api3_pcp_get($params) {
return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'Pcp');
}
/**
* Delete an existing PCP.
*
* This method is used to delete any existing PCP given its id.
*
* @param array $params
* [id]
*
* @return array api result array
*/
function civicrm_api3_pcp_delete($params) {
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}