* @param int $contactId
*
* @return array
- * Dates - ('created_date' => $, 'modified_date' => $)
+ * Dates - ('created_date' => $, 'modified_date' => $)
*/
public static function getTimestamps($contactId) {
$timestamps = CRM_Core_DAO::executeQuery(
* @param array $props
* whatever is known about this dao object.
*
- * @return Array|bool
+ * @return array|bool
*/
public static function buildOptions($fieldName, $context = NULL, $props = array()) {
$params = array();
* @param array $fields
* The hierarchical value representation of this location.
*
- * @return boolean
+ * @return bool
* true if data exists, false otherwise
*/
public static function blockDataExists(&$fields) {
* @param array $params
* (reference ) an assoc array of name/value pairs.
*
- * @return boolean
- *
+ * @return bool
*/
public static function dataExists(&$params) {
//check if location type is set if not return false
* @param array $props
* whatever is known about this dao object.
*
- * @return Array|bool
+ * @return array|bool
*/
public static function buildOptions($fieldName, $context = NULL, $props = array()) {
$params = array();
* The custom field ID.
*
* @return CRM_Core_DAO_CustomField
- * $field the field object
- * public
+ * The field object.
*/
public static function getFieldObject($fieldID) {
$field = new CRM_Core_DAO_CustomField();
* @param int $newGroupID
* FK to civicrm_custom_group.
*
- * @return array(
- * string) or TRUE
+ * @return array
+ * array(string) or TRUE
*/
public static function _moveFieldValidate($fieldID, $newGroupID) {
$errors = array();
*
* @param bool $getCount
*
- * @return boolean
+ * @return bool
* does this entity have data in this custom table
*/
static public function customGroupDataExistsForEntity($entityID, $table, $getCount = FALSE) {
* @param bool $force
* whether to force the deletion, even if there are custom fields.
*
- * @return boolean
+ * @return bool
* false if field exists for this group, true if group gets deleted.
- *
*/
public static function deleteGroup($group, $force = FALSE) {
* @param array $removeCustomFieldTypes
* Remove custom fields of a type eg: array("Individual") ;.
*
- *
- * @return boolean
+ * @return bool
* false if it matches else true
*/
public static function checkCustomField($customFieldId, &$removeCustomFieldTypes) {
* @param int $entityId
* @param string $entityTable
*
- * @return boolean
+ * @return bool
*/
public static function del($entityId, $entityTable) {
// delete all discount records with the selected discounted id
*
* @param int $optionValueId
*
- * @return boolean
+ * @return bool
*
*/
public static function del($optionValueId) {
* @param int $domainID
* @param bool $force
*
- * @return boolean
+ * @return bool
* true if item is already in cache
*/
public static function inCache(
*
* @return array
* the following information as appropriate for each setting
- * - name
- * - type
- * - default
- * - add (CiviCRM version added)
- * - is_domain
- * - is_contact
- * - description
- * - help_text
+ * - name
+ * - type
+ * - default
+ * - add (CiviCRM version added)
+ * - is_domain
+ * - is_contact
+ * - description
+ * - help_text
*/
public static function getSettingSpecification(
$componentID = NULL,
/**
* Civicrm_setting didn't exist before 4.1.alpha1 and this function helps taking decisions during upgrade
*
- * @return boolean
+ * @return bool
*/
public static function isUpgradeFromPreFourOneAlpha1() {
if (CRM_Core_Config::isUpgradeMode()) {
* @param int $id
* Tag id.
*
- * @return boolean
+ * @return bool
*/
public static function del($id) {
// since this is a destructive operation, lets make sure
* @param array $params
* (reference ) an assoc array of name/value pairs.
*
- * @return boolean
+ * @return bool
*/
public static function dataExists(&$params) {
// Disallow empty values except for the number zero.
/**
* Performs the server side validation
* @since 1.0
- * @return boolean
+ * @return bool
* true if no error found
* @throws HTML_QuickForm_Error
*/
/**
* Boolean function to determine if this is a one form page
*
- * @return boolean
+ * @return bool
*/
public function isSimpleForm() {
return $this->_state->getType() & (CRM_Core_State::START | CRM_Core_State::FINISH);
* - cid from the url if the caller has ACL permission to view
* - fallback is logged in user (or ? NULL if no logged in user) (@todo wouldn't 0 be more intuitive?)
*
- * @return NULL|integer
+ * @return NULL|int
*/
public function getContactID() {
$tempID = CRM_Utils_Request::retrieve('cid', 'Positive', $this);
* Boolean Return FALSE if the relevant objects don't exist.
* @param int $paymentProcessorID
* Id of the payment processor ID in use.
- * @return boolean
+ * @return bool
*/
public function validateData(&$input, &$ids, &$objects, $required = TRUE, $paymentProcessorID = NULL) {
* @param int $paymentProcessorID
* @param array $error_handling
*
- * @return boolean
+ * @return bool
*/
public function loadObjects(&$input, &$ids, &$objects, $required, $paymentProcessorID, $error_handling = NULL) {
if (empty($error_handling)) {
* @param array $objects
* @param object $transaction
* @param array $input
- * @return boolean
+ * @return bool
*/
public function failed(&$objects, &$transaction, $input = array()) {
$contribution = &$objects['contribution'];
* Handled pending contribution status
* @param array $objects
* @param object $transaction
- * @return boolean
+ * @return bool
*/
public function pending(&$objects, &$transaction) {
$transaction->commit();
* @param string $method
* Method to check for.
*
- * @return boolean
+ * @return bool
*/
public function isSupported($method = 'cancelSubscription') {
if ($this->_paymentProcessor['payment_processor_type'] != 'PayPal') {
* @param string $str
* The permission to check.
*
- * @return boolean
+ * @return bool
* true if yes, else false
*/
public function check($str) {
* @param array $props
* whatever is known about this dao object.
*
- * @return Array|bool
+ * @return array|bool
*/
public static function buildOptions($fieldName, $context = NULL, $props = array()) {
$params = array('condition' => array());
*
* @param $result
*
- * @return boolean
+ * @return bool
* true if error, false otherwise
*/
function civicrm_error($result) {
*
* @param mixed[] (reference ) input parameters
*
- * {@example AddressGet.php 0}
* @param array $params
* An associative array of name/value pairs.
*
* @return array
* details of found addresses else error
- * {@getfields address_get}
*/
function civicrm_api3_address_get(&$params) {
return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'Address');
* 'move_to_trash' => bool (defaults to false)
*
* @throws API_Exception
- * @return boolean
+ * @return bool
* true if success, else false
*/
function civicrm_api3_case_delete($params) {
*
* @return array
* api result array
- * {@getfields contribution_recur_create}
*/
function civicrm_api3_contribution_recur_create($params) {
return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
*
* @return array
* API result Array of matching contribution_recurs
- * {@getfields contribution_recur_get}
*/
function civicrm_api3_contribution_recur_get($params) {
return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
* @param array $params
* (reference) array containing id of the recurring contribution.
*
- * @return boolean
+ * @return bool
* returns true is successfully cancelled
*/
function civicrm_api3_contribution_recur_cancel($params) {
*
* @return array
* API result array
- * message otherwise
- * {@getfields contribution_recur_delete}
*/
function civicrm_api3_contribution_recur_delete($params) {
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
*
* @return array
* API result array
- * {@getfields email_create}
*/
function civicrm_api3_email_create($params) {
return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
*
* @example EmailDelete.php Standard Delete Example
*
- * @return boolean
+ * @return bool
* | error true if successfull, error otherwise
- * {@getfields email_delete}
*/
function civicrm_api3_email_delete($params) {
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
*
* @return array
* api result array
- * {@getfields email_get}
*/
function civicrm_api3_email_get($params) {
*
* @return array
* TBD
- * {@getfields GroupNesting_create
* @todo Work out the return value.
*/
function civicrm_api3_group_nesting_create($params) {
*
* @return array
* api result array
- * {@getfields line_item_create}
*/
function civicrm_api3_line_item_create($params) {
$params = CRM_Contribute_BAO_Contribution::checkTaxAmount($params, TRUE);
*
* @return array
* Array of matching line_items
- * {@getfields line_item_get}
*/
function civicrm_api3_line_item_get($params) {
return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
*
* @return array
* API result array
- * {@getfields line_item_delete}
*/
function civicrm_api3_line_item_delete($params) {
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
* $Id$
*
*/
+
/**
* Handle a confirm event
*
* @param array $params
* Associative array of property.
- * name/value pairs to insert in new 'survey'
*
* @throws Exception
* @return array
* api result array
- * {@getfields mailing_event_confirm_create}
*/
function civicrm_api3_mailing_event_queue_create($params) {
if (!array_key_exists('id', $params) && !array_key_exists('email_id', $params) && !array_key_exists('phone_id', $params)) {
*
* @param array $params
*
- * @return boolean
+ * @return bool
* true if success, else false
*/
function civicrm_api3_membership_type_delete($params) {
*
* @param array $params
* An associative array of name/value property values of civicrm_participant_payment.
- * @example ParticipantPaymentCreate.php
- * {@example ParticipantPaymentCreate.php 0}
*
* @return array
* Array of newly created payment property values.
- * {@getfields ParticipantPayment_create}
*/
function civicrm_api3_participant_payment_create($params) {
* (reference ) input parameters.
*
* @return array
- * contribution_id of created or updated record
*/
function civicrm_api3_survey_respondant_get(&$params) {
projects / civicrm-core.git / commitdiff