*
* @return string|null
* WHERE-style clause to filter results,
- * or null if $table or $id is null
+ * or null if $table or $id is null
* @static
*/
public static function getClause($table, $id, &$tables) {
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Activity_DAO_Activity object
+ * @return CRM_Activity_DAO_Activity
*/
public static function retrieve(&$params, &$defaults) {
$activity = new CRM_Activity_DAO_Activity();
* component related activities w/ core activity retrieve process.
*
* @return array
- * of component id and name.
+ * Array of component id and name.
* @static
**/
public static function activityComponents() {
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Core_DAO_PrintLabel object on success, null otherwise
+ * @return CRM_Core_DAO_PrintLabel|null
+ * object on success, null otherwise
* @static
*/
public static function retrieve(&$params, &$defaults) {
* @param array $params
* (reference ) an assoc array of name/value pairs.
*
- * @return CRM_Campaign_DAO_Campaign object
+ * @return CRM_Campaign_DAO_Campaign
* @static
*/
public static function create(&$params) {
*
* @param array $params
*
- * @return CRM_Survey_DAO_Survey object
+ * @return CRM_Survey_DAO_Survey
* @static
*/
public static function create(&$params) {
* @param array $params
* (reference ) an assoc array of name/value pairs.
*
- * @return CRM_Case_BAO_Case object
+ * @return CRM_Case_BAO_Case
* @static
*/
public static function add(&$params) {
* @param array $params
* (reference ) an assoc array of name/value pairs.
*
- * @return CRM_Case_BAO_Case object
+ * @return CRM_Case_BAO_Case
* @static
*/
public static function &create(&$params) {
* @param array $ids
* (reference) the array that holds all the db ids.
*
- * @return CRM_Case_BAO_Case object
+ * @return CRM_Case_BAO_Case
* @static
*/
public static function retrieve(&$params, &$defaults, &$ids) {
* @param null $type
*
* @return array
- * of case activities
+ * Array of case activities
*
* @static
*/
*
* @throws CRM_Core_Exception
*
- * @return CRM_Case_BAO_CaseType object
+ * @return CRM_Case_BAO_CaseType
* @static
*/
public static function add(&$params) {
* @param array $params
* (reference ) an assoc array of name/value pairs.
*
- * @return CRM_Case_BAO_CaseType object
+ * @return CRM_Case_BAO_CaseType
* @static
*/
public static function &create(&$params) {
* (reference ) an assoc array to hold the name / value pairs.
* in a hierarchical manner
*
- * @return CRM_Case_BAO_CaseType object
+ * @return CRM_Case_BAO_CaseType
* @static
*/
public static function retrieve(&$params, &$defaults) {
}
/**
- * Get all Activty types for the CiviCase component
+ * Get all Activity types for the CiviCase component
*
* The static array activityType is returned
*
* @param bool $indexName
* True return activity name in array.
- * key else activity id as array key.
+ * key else activity id as array key.
*
* @param bool $all
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
*
- * @return CRM_Contact_BAO_Contact object
+ * @return CRM_Contact_BAO_Contact
* @static
*/
public static function add(&$params) {
* @param bool $skipDelete
*
* @throws Exception
- * @return CRM_Contact_BAO_Contact object
+ * @return CRM_Contact_BAO_Contact
* @static
*/
public static function &create(&$params, $fixAddress = TRUE, $invokeHooks = TRUE, $skipDelete = FALSE) {
/**
* @param array $crudLinkSpec
* With keys:.
- * - action: int, CRM_Core_Action::UPDATE or CRM_Core_Action::VIEW [default: VIEW]
- * - entity_table: string, eg "civicrm_contact"
- * - entity_id: int
+ * - action: int, CRM_Core_Action::UPDATE or CRM_Core_Action::VIEW [default: VIEW]
+ * - entity_table: string, eg "civicrm_contact"
+ * - entity_id: int
* @return array|NULL
- * NULL if unavailable, or an array. array has keys:
- * - path: string
- * - query: string
- * - title: string
+ * NULL if unavailable, or
+ * [path: string, query: string, title: string]
* @see CRM_Utils_System::createDefaultCrudLink
*/
public function createDefaultCrudLink($crudLinkSpec) {
* @param bool $microformat
* For location in microformat.
*
- * @return CRM_Contact_BAO_Contact object
+ * @return CRM_Contact_BAO_Contact
* @static
*/
public static function &retrieve(&$params, &$defaults, $microformat = FALSE) {
* Id of the contact.
*
* @return array
- * of display_name, email if found, do_not_email or (null,null,null)
+ * Array of display_name, email if found, do_not_email or (null,null,null)
* @static
*/
public static function getContactDetails($id) {
* @param int $contactId
*
* @return array
- * of context menu for logged in user.
+ * Array of context menu for logged in user.
* @static
*/
public static function contextMenu($contactId = NULL) {
*
* @param string $fieldName
* @param string $context
- * : @see CRM_Core_DAO::buildOptionsContext.
+ * @see CRM_Core_DAO::buildOptionsContext.
* @param array $props
- * : whatever is known about this dao object.
+ * whatever is known about this dao object.
*
* @return Array|bool
*/
* @param int $locationTypeID
*
* @return array
- * of display_name, email, location type and location id if found, or (null,null,null, null)
+ * Array of display_name, email, location type and location id if found, or (null,null,null, null)
* @static
*/
public static function getEmailDetails($id, $isPrimary = TRUE, $locationTypeID = NULL) {
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Contact_BAO_ContactType object on success, null otherwise
+ * @return CRM_Contact_BAO_ContactType|null
+ * object on success, null otherwise
* @static
*/
public static function retrieve(&$params, &$defaults) {
* @param bool $all
*
* @return array
- * of basic contact types information.
+ * Array of basic contact types information.
* @static
*/
public static function &basicTypeInfo($all = FALSE) {
* @param bool $all
*
* @return array
- * of basic contact types
+ * Array of basic contact types
* @static
*/
public static function basicTypes($all = FALSE) {
* @param bool $reset
*
* @return array
- * of sub type information
+ * Array of sub type information
* @static
*/
public static function &subTypeInfo($contactType = NULL, $all = FALSE, $ignoreCache = FALSE, $reset = FALSE) {
* @param bool $ignoreCache
*
* @return array
- * of all subtypes OR list of subtypes associated to
- * a given basic contact type
+ * all subtypes OR list of subtypes associated to
+ * a given basic contact type
* @static
*/
public static function subTypes($contactType = NULL, $all = FALSE, $columnName = 'name', $ignoreCache = FALSE) {
* @param bool $all
*
* @return array
- * of basic types + all subtypes.
+ * Array of basic types + all subtypes.
* @static
*/
public static function contactTypes($all = FALSE) {
* @param bool $reset
*
* @return array
- * of basic types + all subtypes.
+ * Array of basic types + all subtypes.
* @static
*/
public static function contactTypeInfo($all = FALSE, $reset = FALSE) {
* @param null $delimiter
*
* @return array
- * of basictypes with name as 'built-in name' and 'label' as value
+ * Array of basictypes with name as 'built-in name' and 'label' as value
* @static
*/
public static function contactTypePairs($all = FALSE, $typeName = NULL, $delimiter = NULL) {
* @param bool $ignoreCache
*
* @return array
- * of suppressed subTypes.
+ * Array of suppressed subTypes.
* @static
*/
public static function suppressSubTypes(&$subTypes, $ignoreCache = FALSE) {
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Contact_BAO_Group object
+ * @return CRM_Contact_BAO_Group
* @static
*/
public static function retrieve(&$params, &$defaults) {
* @param NULL $rowCount
*
* @return array
- * of group objects.
+ * Array of group objects.
*
*
* @todo other BAO functions that use returnProperties (e.g. Query Objects) receive the array flipped & filled with 1s and
* @param bool $isActive
* Value we want to set the is_active field.
*
- * @return CRM_Core_DAO
+ * @return CRM_Core_DAO|null
* DAO object on sucess, NULL otherwise
* @static
*/
*
* @return array
* associated array of group list
- * -rp = rowcount
- * -page= offset
+ * -rp = rowcount
+ * -page= offset
* @todo there seems little reason for the small number of functions that call this to pass in
* params that then need to be translated in this function since they are coding them when calling
*/
* @param array $params
* (reference ) an assoc array of name/value pairs.
*
- * @return CRM_Contact_BAO_Group object
+ * @return CRM_Contact_BAO_Group
* @static
*/
public static function add(&$params) {
*
* @param string $fieldName
* @param string $context
- * : @see CRM_Core_DAO::buildOptionsContext.
+ * @see CRM_Core_DAO::buildOptionsContext.
* @param array $props
- * : whatever is known about this dao object.
+ * whatever is known about this dao object.
*
* @return Array|bool
*/
* @param array $contact
* Contact object.
*
- * @return CRM_Contact_BAO_Contact object
+ * @return CRM_Contact_BAO_Contact
* @static
*/
public static function format(&$params, &$contact) {
* Get or build the list of search objects (via hook)
*
* @return array
- * of CRM_Contact_BAO_Query_Interface objects
+ * Array of CRM_Contact_BAO_Query_Interface objects
*/
public function getSearchQueryObjects() {
if ($this->_queryObjects === NULL) {
* and this is new in 4.6
* All existing calls have been changed to createMultiple except the api call - however, it is recommended
* that you call that as the end to end testing here is based on the api & refactoring may still be done
- * @param $params
+ * @param array $params
* @return \CRM_Contact_BAO_Relationship
* @throws \CRM_Core_Exception
*/
* (reference ) an assoc array of name/value pairs.
* @param array $ids
* The array that holds all the db ids.
- * per http://wiki.civicrm.org/confluence/display/CRM/Database+layer
+ * per http://wiki.civicrm.org/confluence/display/CRM/Database+layer
* "we are moving away from the $ids param "
*
- * @return CRM_Contact_BAO_Relationship object
+ * @return CRM_Contact_BAO_Relationship
* @static
*/
public static function createMultiple(&$params, $ids = array()) {
/**
* Resolve passed in contact IDs to contact_id_a & contact_id_b
- * @param $params
+ * @param array $params
* @param array $ids
* @param null $contactID
* @throws \CRM_Core_Exception
*
* @param int $contactID
* contact id whose employers.
- * are to be found.
+ * are to be found.
* @param string $name
* employers sort name.
*
* @static
*
* @return array
- * of contacts
+ * Array of contacts
*/
public static function getPermissionedContacts($contactID, $relTypeId, $name = NULL) {
$contacts = array();
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Contact_BAO_RelationshipType object
+ * @return CRM_Contact_BAO_RelationshipType
* @static
*/
public static function retrieve(&$params, &$defaults) {
* UNUSED.
*
* @return array
- * of rows for labels
+ * Array of rows for labels
*/
public static function getRows($contactIDs, $locationTypeID, $respectDoNotMail, $mergeSameAddress, $mergeSameHousehold) {
/**
* Get array of return properties for address fields required for mailing label
+ *
* @return array
- * return properites for address e.g
- * array (
- * - [street_address] => 1,
- * - [supplemental_address_1] => 1,
- * - [supplemental_address_2] => 1
- * )
+ * return properties for address e.g
+ * [street_address => 1, supplemental_address_1 => 1, supplemental_address_2 => 1]
*/
public static function getAddressReturnProperties() {
$mailingFormat = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
/**
* Get token list from mailing format & contacts
- * @param unknown_type $contacts
- * @return unknown
+ * @param array $contacts
+ * @return array
*/
public static function getTokenData(&$contacts) {
$mailingFormat = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
}
/**
- * @param $rows
+ * @param array $rows
*
* @return array
*/
public function mergeSameHousehold(&$rows) {
- # group selected contacts by type
+ // group selected contacts by type
$individuals = array();
$households = array();
foreach ($rows as $contact_id => $row) {
}
}
- # exclude individuals belonging to selected households
+ // exclude individuals belonging to selected households
foreach ($households as $household_id => $row) {
$dao = new CRM_Contact_DAO_Relationship();
$dao->contact_id_b = $household_id;
}
}
- # merge back individuals and households
+ // merge back individuals and households
$rows = array_merge($individuals, $households);
return $rows;
}
*
* @param array $params
* reference to an array containing all the.
- * values for import
+ * values for import
* @param int $onDuplicate
* @param int $cid
* contact id.
* @param array $ids
* The array that holds all the db ids.
*
- * @return CRM_Contribute_BAO_Contribution object
+ * @return CRM_Contribute_BAO_Contribution
* @static
*/
public static function add(&$params, $ids = array()) {
* @param array $ids
* The array that holds all the db ids.
*
- * @return CRM_Contribute_BAO_Contribution object
+ * @return CRM_Contribute_BAO_Contribution
* @static
*/
public static function create(&$params, $ids = array()) {
* @param array $ids
* (reference) the array that holds all the db ids.
*
- * @return CRM_Contribute_BAO_Contribution object
+ * @return CRM_Contribute_BAO_Contribution
* @static
*/
public static function retrieve(&$params, &$defaults, &$ids) {
* @param array $input
* An assoc array of name/value pairs.
* @param array $duplicates
- * (reference ) store ids of duplicate contribs.
- *
+ * (reference) store ids of duplicate contribs.
* @param int $id
*
* @return boolean
* true if duplicate, false otherwise
- * static
+ * @static
*/
public static function checkDuplicate($input, &$duplicates, $id = NULL) {
if (!$id) {
* pairs
*
* @param array $params
- * (reference ) an assoc array of name/value pairs.
+ * (reference) an assoc array of name/value pairs.
*
- * @return CRM_Contribute_BAO_ContributionProduct object
+ * @return CRM_Contribute_DAO_ContributionProduct
* @static
*/
public static function addPremium(&$params) {
*
* @return array
* contribution id if success else NULL
- * static
+ * @static
*/
public static function checkDuplicateIds($params) {
$dao = new CRM_Contribute_DAO_Contribution();
* Create address associated with contribution record.
*
* @param array $params
- * An associated array.
* @param int $billingLocationTypeID
*
* @return int
* @param string $componentName
* Event/Membership.
*
- * @return $contributionId pending contribution id.
+ * @return int
+ * pending contribution id.
* @static
*/
public static function checkOnlinePendingContribution($componentId, $componentName) {
}
/**
- * This function update contribution as well as related objects.
+ * Update contribution as well as related objects.
*/
public static function transitionComponents($params, $processContributionObject = FALSE) {
// get minimum required values.
}
/**
- * This function returns all contribution related object ids.
+ * Returns all contribution related object ids.
*/
public static function getComponentDetails($contributionId) {
$componentDetails = $pledgePayment = array();
);
}
- /*
+ /**
* Load objects relations to contribution object
* Objects are stored in the $_relatedObjects property
* In the first instance we are just moving functionality from BASEIpn -
- * see http://issues.civicrm.org/jira/browse/CRM-9996
+ * @see http://issues.civicrm.org/jira/browse/CRM-9996
+ *
+ * Note that the unit test for the BaseIPN class tests this function
*
* @param array $input
* Input as delivered from Payment Processor.
* Is Payment processor / contribution page required.
* @param bool $loadAll
* Load all related objects - even where id not passed in? (allows API to call this).
- * Note that the unit test for the BaseIPN class tests this function
- */
- /**
- * @param $input
- * @param $ids
- * @param bool $required
- * @param bool $loadAll
*
* @return bool
* @throws Exception
return TRUE;
}
- /*
+ /**
* Create array of message information - ie. return html version, txt version, to field
*
* @param array $input
* Incoming information.
- * - is_recur - should this be treated as recurring (not sure why you wouldn't
+ * - is_recur - should this be treated as recurring (not sure why you wouldn't
* just check presence of recur object but maintaining legacy approach
* to be careful)
* @param array $ids
* @param array $values
* Any values that may have already been compiled by calling process.
* This is augmented by values 'gathered' by gatherMessageValues
+ * @param bool $recur
* @param bool $returnMessageText
* Distinguishes between whether to send message or return.
* message text. We are working towards this function ALWAYS returning message text & calling
* function doing emails / pdfs with it
+ *
* @return array
* messages
- */
- /**
- * @param $input
- * @param $ids
- * @param $values
- * @param bool $recur
- * @param bool $returnMessageText
- *
* @throws Exception
*/
public function composeMessageArray(&$input, &$ids, &$values, $recur = FALSE, $returnMessageText = TRUE) {
}
}
- /*
+ /**
* Gather values for contribution mail - this function has been created
* as part of CRM-9996 refactoring as a step towards simplifying the composeMessage function
* Values related to the contribution in question are gathered
*
* @param array $input
* Input into function (probably from payment processor).
+ * @param array $values
* @param array $ids
- * The set of ids related to the inpurt.
+ * The set of ids related to the input.
*
* @return array
- *
- * NB don't add direct calls to the function as we intend to change the signature
- */
- /**
- * @param $input
- * @param $values
- * @param array $ids
- *
- * @return mixed
*/
public function _gatherMessageValues($input, &$values, $ids = array()) {
// set display address of contributor
*
* @param string $fieldName
* @param string $context
- * : @see CRM_Core_DAO::buildOptionsContext.
+ * @see CRM_Core_DAO::buildOptionsContext.
* @param array $props
- * : whatever is known about this dao object.
+ * whatever is known about this dao object.
*
* @return Array|bool
*/
* Function to record additional payment for partial and refund contributions
*
* @param int $contributionId
- * : is the invoice contribution id (got created after processing participant payment).
+ * is the invoice contribution id (got created after processing participant payment).
* @param array $trxnData
- * : to take user provided input of transaction details.
+ * to take user provided input of transaction details.
* @param string $paymentType
* 'owed' for purpose of recording partial payments, 'refund' for purpose of recording refund payments.
*/
* Form object.
* @param array $paymentParams
* Array with payment related key.
- * value pairs
+ * value pairs
* @param array $premiumParams
* Array with premium related key.
- * value pairs
+ * value pairs
* @param int $contactID
* Contact id.
* @param int $contributionTypeId
* @param array $params
* (reference ) an assoc array of name/value pairs.
*
- * @return CRM_Contribute_DAO_ContributionPage object
+ * @return CRM_Contribute_DAO_ContributionPage
* @static
*/
public static function &create(&$params) {
*
* @return boolean
* true if payment processor supports recurring
- * else false
+ * else false
*
* @static
*/
* @param array $params
* (reference ) an assoc array of name/value pairs.
*
- * @return CRM_Contribute_BAO_Contribution object
+ * @return CRM_Contribute_BAO_Contribution
* @static
* @todo move hook calls / extended logic to create - requires changing calls to call create not add
*/
*
* @return boolean
* true if duplicate, false otherwise
- * static
+ * @static
*/
public static function checkDuplicate($params, &$duplicates) {
$id = CRM_Utils_Array::value('id', $params);
*
* @return array
* an array of recurring ids count
- * static
+ * @static
*/
public static function getCount(&$ids) {
$recurID = implode(',', $ids);
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Contribute_BAO_ContributionSoft object
+ * @return CRM_Contribute_BAO_ContributionSoft
* @static
*/
public static function retrieve(&$params, &$defaults) {
* Include PCP data.
*
* @return array
- * of soft contribution ids, amounts, and associated contact ids
+ * Array of soft contribution ids, amounts, and associated contact ids
* @static
*/
public static function getSoftContribution($contributionID, $all = FALSE) {
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Contribute_BAO_ManagePremium object
+ * @return CRM_Contribute_BAO_ManagePremium
* @static
*/
public static function retrieve(&$params, &$defaults) {
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Contribute_BAO_ManagePremium object
+ * @return CRM_Contribute_BAO_ManagePremium
* @static
*/
public static function retrieve(&$params, &$defaults) {
/**
* @return array
- * of valid processors. The array resembles the DB table but also has 'object' as a key
+ * Array of valid processors. The array resembles the DB table but also has 'object' as a key
* @throws Exception
*/
public function getValidProcessors() {
* array of organization info.
* @param int $contactID
* individual contact id. One.
- * who is doing the process of signup / contribution.
+ * who is doing the process of signup / contribution.
*
* @param array $values
* form values array.
* @param $self
*
* @return array
- * of errors
+ * Array of errors
* @static
*/
public static function formRule($fields, $errors, $self) {
* @param array $values
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Core_DAO_ActionSchedule object on success, null otherwise
+ * @return CRM_Core_DAO_ActionSchedule|null
+ * object on success, null otherwise
* @static
*/
public static function retrieve(&$params, &$values) {
*
* @param array $entityElements
* The array containing entity_id and.
- * entity_table name
+ * entity_table name
*
* @return array
* the array of adrress data
* Get address sequence
*
* @return array
- * of address sequence.
+ * Array of address sequence.
*/
public static function addressSequence() {
$config = CRM_Core_Config::singleton();
*
* @param string $fieldName
* @param string $context
- * : @see CRM_Core_DAO::buildOptionsContext.
+ * @see CRM_Core_DAO::buildOptionsContext.
* @param array $props
- * : whatever is known about this dao object.
+ * whatever is known about this dao object.
*
* @return Array|bool
*/
* Input parameters to find object.
*
* @return array
- * of $block objects.
+ * Array of $block objects.
* @static
*/
public static function &getValues($blockName, $params) {
* Name of the above object.
*
* @return array
- * of $block objects.
+ * Array of $block objects.
* @static
*/
public static function retrieveBlock(&$block, $blockName) {
* Return likely default settings
* @return array
* site settings
- * -$url,
- * - $dir Base Directory
- * - $siteName
- * - $siteRoot
+ * - $url
+ * - $dir Base Directory
+ * - $siteName
+ * - $siteRoot
*/
public static function getBestGuessSettings() {
$config = CRM_Core_Config::singleton();
* @param array $params
* (reference) an assoc array of name/value pairs.
*
- * @return CRM_Core_DAO_CustomField object
+ * @return CRM_Core_DAO_CustomField
* @static
*/
public static function create(&$params) {
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Core_DAO_CustomField object
+ * @return CRM_Core_DAO_CustomField
* @static
*/
public static function retrieve(&$params, &$defaults) {
* @param int $fieldID
* The custom field ID.
*
- * @return CRM_Core_DAO_CustomField $field the field object
+ * @return CRM_Core_DAO_CustomField
+ * $field the field object
* @static
* public
*/
*
* @param array $includeFieldIds
* Ids of custom fields for which.
- * option groups must be included.
+ * option groups must be included.
*
* Currently this is required in the cases where option groups are to be included
* for inactive fields : CRM-5369
*
* @param array $params
* Custom data submitted.
- * ie array( 'custom_1' => 'validate me' );
+ * ie array( 'custom_1' => 'validate me' );
*
* @return array
* validation errors.
* @param array $params
* (reference) an assoc array of name/value pairs.
*
- * @return CRM_Core_DAO_CustomGroup object
+ * @return CRM_Core_DAO_CustomGroup
* @static
*/
public static function create(&$params) {
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Core_DAO_CustomGroup object
+ * @return CRM_Core_DAO_CustomGroup
* @static
*/
public static function retrieve(&$params, &$defaults) {
* @param bool $onlySubType
*
* @return array
- * array The returned array is keyed by group id and has the custom group table fields
- * and a subkey 'fields' holding the specific custom fields.
- * If entityId is passed in the fields keys have a subkey 'customValue' which holds custom data
- * if set for the given entity. This is structured as an array of values with each one having the keys 'id', 'data'
+ * The returned array is keyed by group id and has the custom group table fields
+ * and a subkey 'fields' holding the specific custom fields.
+ * If entityId is passed in the fields keys have a subkey 'customValue' which holds custom data
+ * if set for the given entity. This is structured as an array of values with each one having the keys 'id', 'data'
*
* @todo - review this - It also returns an array called 'info' with tables, select, from, where keys
- * The reason for the info array in unclear and it could be determined from parsing the group tree after creation
- * With caching the performance impact would be small & the function would be cleaner
- *
+ * The reason for the info array in unclear and it could be determined from parsing the group tree after creation
+ * With caching the performance impact would be small & the function would be cleaner
*
* @static
*/
* @param string $query
* @param array $includedTables
* Tables to include - required because the function (for historical reasons).
- * iterates through the group tree
+ * iterates through the group tree
*/
static public function buildTreeEntityDataFromQuery(&$groupTree, $query, $includedTables) {
$dao = CRM_Core_DAO::executeQuery($query);
* Var which should have the list appended.
*
* @return array
- * of types.
+ * Array of types.
*/
public static function getExtendedObjectTypes(&$types = array()) {
static $flag = FALSE, $objTypes = array();
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Core_BAO_CustomOption object
+ * @return CRM_Core_BAO_CustomOption
* @static
*/
public static function retrieve(&$params, &$defaults) {
/**
* Delete Option
*
- * param $optionId integer option id
+ * @param $optionId integer
+ * option id
*
* @static
*/
*
* @param bool $flatFormat
* This is true if you want simple associated.
- * array of all the contact's dashlets whether or not they are enabled.
+ * array of all the contact's dashlets whether or not they are enabled.
*
* @param int $contactID
* Provide the dashlets for the contact id.
- * passed rather than the current user.
+ * passed rather than the current user.
*
* @return array
* array of dashlets
* the default dashlets.
*
* @return array
- * of dashboard_id's
+ * Array of dashboard_id's
*/
public static function initializeDashlets() {
$dashlets = array();
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Core_DAO_Domain object
+ * @return CRM_Core_DAO_Domain
* @static
*/
public static function retrieve(&$params, &$defaults) {
*
* @param array $entityElements
* The array containing entity_id and.
- * entity_table name
+ * entity_table name
*
* @return array
* the array of email id's
* @param array $params
* (reference ) an assoc array of name/value pairs.
*
- * @return CRM_Core_BAO_EntityTag object
+ * @return CRM_Core_BAO_EntityTag
* @static
*/
public static function add(&$params) {
* @param array $params
* (reference ) an assoc array of name/value pairs.
*
- * @return CRM_Core_BAO_EntityTag object
+ * @return CRM_Core_BAO_EntityTag
* @static
*/
public static function del(&$params) {
*
* @param string $fieldName
* @param string $context
- * : @see CRM_Core_DAO::buildOptionsContext.
+ * @see CRM_Core_DAO::buildOptionsContext.
* @param array $props
- * : whatever is known about this dao object.
+ * whatever is known about this dao object.
*
* @return Array|bool
*/
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Core_BAO_LocationType object on success, null otherwise
+ * @return CRM_Core_BAO_LocationType|null
+ * object on success, null otherwise
* @static
*/
public static function retrieve(&$params, &$defaults) {
* @param string $trxnEntityTable
* Entity_table.
*
- * @return CRM_Core_BAO_FinancialTrxn object
+ * @return CRM_Core_BAO_FinancialTrxn
* @static
*/
public static function create(&$params, $trxnEntityTable = NULL) {
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Contribute_BAO_ContributionType object
+ * @return CRM_Contribute_BAO_ContributionType
* @static
*/
public static function retrieve(&$params, &$defaults) {
*
* @param array $entityElements
* The array containing entity_id and.
- * entity_table name
+ * entity_table name
*
* @return array
* the array of im details
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Core_DAO_Job object on success, null otherwise
+ * @return CRM_Core_DAO_Job|null
+ * object on success, null otherwise
* @static
*/
public static function retrieve(&$params, &$defaults) {
*
* @param string $groupName
*
- * @return CRM_Core_DAO_OptionValue object
+ * @return CRM_Core_DAO_OptionValue
* @static
*/
public static function retrieve(&$params, &$values, $groupName = 'label_format') {
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Core_BAO_LocaationType object on success, null otherwise
+ * @return CRM_Core_BAO_LocaationType|null
+ * object on success, null otherwise
* @static
*/
public static function retrieve(&$params, &$defaults) {
*
* @param bool $reset
*
- * @return CRM_Core_BAO_MailSettings DAO with the default mail settings set
+ * @return CRM_Core_BAO_MailSettings
+ * DAO with the default mail settings set
*/
public static function defaultDAO($reset = FALSE) {
static $mailSettings = array();
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Core_BAO_MailSettings object
+ * @return CRM_Core_BAO_MailSettings
* @static
*/
public static function retrieve(&$params, &$defaults) {
* @param array $params
* (reference ) an assoc array of name/value pairs.
*
- * @return CRM_Core_BAO_MailSettings object
+ * @return CRM_Core_BAO_MailSettings
* @static
*/
public static function create(&$params) {
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Core_BAO_MessageTemplate object
+ * @return CRM_Core_BAO_MessageTemplate
* @static
*/
public static function retrieve(&$params, &$defaults) {
* A string-keyed array of function params, see function body for details.
*
* @return array
- * of four parameters: a boolean whether the email was sent, and the subject, text and HTML templates
+ * Array of four parameters: a boolean whether the email was sent, and the subject, text and HTML templates
*/
public static function sendTemplate($params) {
$defaults = array(
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Core_BAO_Navigation object on success, NULL otherwise
+ * @return CRM_Core_BAO_Navigation|null
+ * object on success, NULL otherwise
* @static
*/
public static function retrieve(&$params, &$defaults) {
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Core_BAO_OptionGroup object
+ * @return CRM_Core_BAO_OptionGroup
* @static
*/
public static function retrieve(&$params, &$defaults) {
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Core_BAO_OptionValue object
+ * @return CRM_Core_BAO_OptionValue
* @static
*/
public static function retrieve(&$params, &$defaults) {
* @param array $values
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Core_DAO_OptionValue object
+ * @return CRM_Core_DAO_OptionValue
* @static
*/
public static function retrieve(&$params, &$values) {
* @param array $values
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Core_DAO_OptionValue object
+ * @return CRM_Core_DAO_OptionValue
* @static
*/
public static function retrieve(&$params, &$values) {
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Core_BAO_Persistent object
+ * @return CRM_Core_BAO_Persistent
* @static
*/
public static function retrieve(&$params, &$defaults) {
*
* @param array $entityElements
* The array containing entity_id and.
- * entity_table name
+ * entity_table name
*
* @param null $type
*
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Core_BAO_PreferencesDate object on success, null otherwise
+ * @return CRM_Core_BAO_PreferencesDate|null
+ * object on success, null otherwise
* @static
*/
public static function retrieve(&$params, &$defaults) {
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Core_BAO_UFField object
+ * @return CRM_Core_BAO_UFField
* @static
*/
public static function retrieve(&$params, &$defaults) {
* @param array $ids
* Array containing the id.
*
- * @return CRM_Core_BAO_UFField object
+ * @return CRM_Core_BAO_UFField
*
* @static
*/
* Array of profile fields that relate to address fields.
* @param array $profileFilter
* Filter to apply to profile fields - expected usage is to only fill based on.
- * the bottom profile per CRM-13726
+ * the bottom profile per CRM-13726
*
* @return bool
* Can the address block be hidden safe in the knowledge all fields are elsewhere collected (see CRM-15118)
* @param array $params
* (reference) an assoc array of name/value pairs.
*
- * @return CRM_Core_BAO_UFJoin object
+ * @return CRM_Core_BAO_UFJoin
* @static
*/
public static function addUFJoin(&$params) {
* @param array $params
* (reference) an assoc array of name/value pairs.
*
- * @return CRM_Core_DAO_UFJoin object
+ * @return CRM_Core_DAO_UFJoin
* @static
*/
public static function &create($params) {
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Core_DAO_WordRepalcement object
+ * @return CRM_Core_DAO_WordRepalcement
* @static
*/
/**
* @return array
- * of class names; each class implements CRM_Core_CodeGen_ITask
+ * Array of class names; each class implements CRM_Core_CodeGen_ITask
*/
public function getTasks() {
$components = array(
* @param array $pairs
* Each item is an array(0 => $searchBaseDir, 1 => $filePattern).
* @return array
- * of file paths
+ * Array of file paths
*/
public static function findManyFiles($pairs) {
$files = array();
* Get the variable from the form scope
*
* @param string $name
- * : name of the variable.
+ * name of the variable.
*
*
* @return mixed
* @static
*
* @return array
- * of CRM_Core_Reference_Interface
+ * Array of CRM_Core_Reference_Interface
*/
public static function getReferenceColumns() {
return array();
* @param bool $i18nRewrite
* @param bool $trapException
*
- * @return CRM_Core_DAO object that holds the results of the query
+ * @return CRM_Core_DAO
+ * object that holds the results of the query
* @static
*/
static function &executeQuery(
* Find all records which refer to this entity.
*
* @return array
- * of objects referencing this
+ * Array of objects referencing this
*/
public function findReferences() {
$links = self::getReferencesToTable(static::getTableName());
/**
* @return array
* each item has keys:
- * - name: string
- * - type: string
- * - count: int
- * - table: string|null SQL table name
- * - key: string|null SQL column name
+ * - name: string
+ * - type: string
+ * - count: int
+ * - table: string|null SQL table name
+ * - key: string|null SQL column name
*/
public function getReferenceCounts() {
$links = self::getReferencesToTable(static::getTableName());
*
* @return array
* structure of table and column, listing every table with a
- * foreign key reference to $tableName, and the column where the key appears.
+ * foreign key reference to $tableName, and the column where the key appears.
*/
public static function getReferencesToTable($tableName) {
$refsFound = array();
*
* @param string $fieldName
* @param string $context
- * : @see CRM_Core_DAO::buildOptionsContext.
+ * @see CRM_Core_DAO::buildOptionsContext.
* @param array $props
- * : whatever is known about this bao object.
+ * whatever is known about this bao object.
*
* @return Array|bool
*/
* alternative field name ('as') @todo- not actually used.
* @param bool $returnSanitisedArray
* Return a sanitised array instead of a clause.
- * this is primarily so we can add filters @ the api level to the Query object based fields
+ * this is primarily so we can add filters @ the api level to the Query object based fields
*
* @throws Exception
*
* @param $params : (array) api params
*
* @return array
- * of permissions to check for this entity-action combo
+ * Array of permissions to check for this entity-action combo
*/
function _civicrm_api3_permissions($entity, $action, &$params) {
$entity = _civicrm_api_get_entity_name_from_camel($entity);
* The human friendly error message.
* @param string $error_code
* A computer friendly error code. By convention, no space (but underscore allowed).
- * ex: mandatory_missing, duplicate, invalid_format
+ * ex: mandatory_missing, duplicate, invalid_format
* @param array $data
* Extra params to return. eg an extra array of ids. It is not mandatory, but can help the computer using the api. Keep in mind the api consumer isn't to be trusted. eg. the database password is NOT a good extra data.
*/
/**
* @param array $query
* Any of the following:.
- * - text: string, plain text to search for
- * - parent_table: string - entity to which file is directly attached
- * - parent_id: int - entity to which file is directly attached
- * - xparent_table: string - business-entity to which file is attached (directly or indirectly)
- * - xparent_id: int - business-entity to which file is attached (directly or indirectly)
+ * - text: string, plain text to search for
+ * - parent_table: string - entity to which file is directly attached
+ * - parent_id: int - entity to which file is directly attached
+ * - xparent_table: string - business-entity to which file is attached (directly or indirectly)
+ * - xparent_id: int - business-entity to which file is attached (directly or indirectly)
* @param int $limit
* @param int $offset
* @return array
* each item has keys:
- * - file_id: int
- * - parent_table: string - entity to which file is directly attached
- * - parent_id: int - entity to which file is directly attached
- * - xparent_table: string - business-entity to which file is attached (directly or indirectly)
- * - xparent_id: int - business-entity to which file is attached (directly or indirectly)
+ * - file_id: int
+ * - parent_table: string - entity to which file is directly attached
+ * - parent_id: int - entity to which file is directly attached
+ * - xparent_table: string - business-entity to which file is attached (directly or indirectly)
+ * - xparent_id: int - business-entity to which file is attached (directly or indirectly)
*/
public function search($query, $limit = self::DEFAULT_SEARCH_LIMIT, $offset = self::DEFAULT_SEARCH_OFFSET);
}
* @param string $label
* @param array $props
* Mix of html and widget properties, including:.
- * - select - params to give to select2 widget
- * - entity - defaults to contact
- * - create - can the user create a new entity on-the-fly?
+ * - select - params to give to select2 widget
+ * - entity - defaults to contact
+ * - create - can the user create a new entity on-the-fly?
* Set to TRUE if entity is contact and you want the default profiles,
* or pass in your own set of links. @see CRM_Core_BAO_UFGroup::getCreateLinks for format
* note that permissions are checked automatically
- * - api - array of settings for the getlist api wrapper
+ * - api - array of settings for the getlist api wrapper
* note that it accepts a 'params' setting which will be passed to the underlying api
- * - placeholder - string
- * - multiple - bool
- * - class, etc. - other html properties
+ * - placeholder - string
+ * - multiple - bool
+ * - class, etc. - other html properties
* @param bool $required
*
* @return HTML_QuickForm_Element
/**
* Get contact if for a form object. Prioritise
- * - cid in URL if 0 (on behalf on someoneelse)
+ * - cid in URL if 0 (on behalf on someoneelse)
* (@todo consider setting a variable if onbehalf for clarity of downstream 'if's
- * - logged in user id if it matches the one in the cid in the URL
- * - contact id validated from a checksum from a checksum
- * - 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?)
+ * - logged in user id if it matches the one in the cid in the URL
+ * - contact id validated from a checksum from a checksum
+ * - 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
*/
* Ids of profiles that are on the form (to be autofilled).
* @param array $autoCompleteField
*
- * - name_field
- * - id_field
- * - url (for ajax lookup)
+ * - name_field
+ * - id_field
+ * - url (for ajax lookup)
*
* @todo add data attributes so we can deal with multiple instances on a form
*/
* the default values are retrieved from the database
*
*
- * @return None
+ * @return array
*/
public static function setDefaultValues() {
$defaults = array();
* Process the form submission
*
*
- * @return None
+ * @return void
*/
public static function postProcess($params = array(), $type, $linkedEntities = array()) {
//Check entity_id not present in params take it from class variable
* whether to return all languages or just the enabled ones.
*
* @return array
- * of code/language name mappings
+ * Array of code/language name mappings
*/
public static function languages($justEnabled = FALSE) {
static $all = NULL;
*
* @param $text
* String string for translating.
- * @param $params
+ * @param array $params
* Array an array of additional parameters.
*
* @return string
* @param bool $fresh
*
* @return array
- * of values as specified by the above params
+ * Array of values as specified by the above params
* @static
* @void
*/
* Has links like edit, delete, disable ..etc.
*
* @return array
- * of option-values
+ * Array of option-values
*
* @static
*/
* Do you want only active option values?.
*
* @return array
- * of option-values
+ * Array of option-values
*
* @static
*/
/**
* Getter for payment form that is using the processor
* @deprecated
- * @return CRM_Core_Form A form object
+ * @return CRM_Core_Form
+ * A form object
*/
public function getForm() {
return $this->_paymentForm;
* @param bool $xmlSafe
* @return mixed
* value of the field, or empty string if the field is
- * not set
+ * not set
*/
public function _getParam($field, $xmlSafe = FALSE) {
$value = CRM_Utils_Array::value($field, $this->_params, '');
* Is it part of a recurring contribution.
* @param bool $returnMessageText
* Should text be returned instead of sent. This.
- * is because the function is also used to generate pdfs
+ * is because the function is also used to generate pdfs
*
* @return array
*/
*
* @return mixed
* value of the field, or empty string if the field is
- * not set
+ * not set
*/
public function _getParam($field) {
if (isset($this->_params[$field])) {
}
/**
- * Function exists to get the values from the rp_invoice_id string
+ * get the values from the rp_invoice_id string
*
* @param string $name
* E.g. i, values are stored in the string with letter codes.
* @param bool $abort
- * Fatal if not found?.
+ * Throw exception if not found
*
* @throws CRM_Core_Exception
- * @return unknown
+ * @return mixed
*/
public function getValue($name, $abort = TRUE) {
if ($abort && empty($this->_invoiceData[$name])) {
*
* @return mixed
* value of the field, or empty string if the field is
- * not set
+ * not set
*/
public function _getParam($field) {
if (isset($this->_params[$field])) {
* Given a permission string or array, check for access requirements
* @param mixed $permissions
* The permission to check as an array or string -see examples.
- * arrays
+ * arrays
*
* Ex 1
*
*
* @param $module
*
- * @return Array
- * of permissions, in the same format as CRM_Core_Permission::getCorePermissions().
+ * @return array
+ * Array of permissions, in the same format as CRM_Core_Permission::getCorePermissions().
* @see CRM_Core_Permission::getCorePermissions
*/
public static function getModulePermissions($module) {
* Get the permissions defined in the hook_civicrm_permission implementation
* in all enabled CiviCRM module extensions.
*
- * @return Array
- * of permissions, in the same format as CRM_Core_Permission::getCorePermissions().
+ * @return array
+ * Array of permissions, in the same format as CRM_Core_Permission::getCorePermissions().
*/
public function getAllModulePermissions() {
$permissions = array();
*
* @param $module
*
- * @return Array
- * of permissions, in the same format as CRM_Core_Permission::getCorePermissions().
+ * @return array
+ * Array of permissions, in the same format as CRM_Core_Permission::getCorePermissions().
*/
public static function getModulePermissions($module) {
$return_permissions = array();
*
* @param CRM_Core_DAO $targetDao
* The instance for which we want references.
- * @return CRM_Core_DAO a query-handle (like the result of CRM_Core_DAO::executeQuery)
+ * @return CRM_Core_DAO
+ * a query-handle (like the result of CRM_Core_DAO::executeQuery)
*/
public function findReferences($targetDao) {
$refColumn = $this->getReferenceKey();
* The instance for which we want references.
* @return array
* a record describing the reference; must include the keys:
- * - 'type': string (not necessarily unique)
- * - 'count': int
+ * - 'type': string (not necessarily unique)
+ * - 'count': int
*/
public function getReferenceCount($targetDao);
}
* @param CRM_Core_Form $form
*
* @return array
- * of rows
+ * Array of rows
*/
public function getRows($form) {
if ($form->_output == self::EXPORT || $form->_output == self::SCREEN) {
*
*
* @param string $name
- * : name of the variable.
+ * name of the variable.
* @param string $prefix
- * : adds another level of scope to the session.
+ * adds another level of scope to the session.
*
* @return mixed
*/
*
*
* @param string $name
- * : name of the timer.
+ * name of the timer.
* @param int $expire
- * : expiry time (in seconds).
+ * expiry time (in seconds).
*
* @return mixed
*/
* Must define 'name'.
* @param string $content
* Default content.
- * @param object $smarty
+ * @param CRM_Core_Smarty $smarty
* The Smarty object.
*
* @param $repeat
* Must define 'name'.
* @param string $content
* Default content.
- * @param object $smarty
+ * @param CRM_Core_Smarty $smarty
* The Smarty object.
*
* @param $repeat
* Template call's parameters.
* @param string $text
* {edit} block contents from the template.
- * @param object $smarty
+ * @param CRM_Core_Smarty $smarty
* The Smarty object.
*
* @return string
* Template call's parameters.
* @param string $text
* {ts} block contents from the template.
- * @param object $smarty
+ * @param CRM_Core_Smarty $smarty
* The Smarty object.
*
* @return string
* Template call's parameters.
* @param string $text
* {ts} block contents from the template.
- * @param object $smarty
+ * @param CRM_Core_Smarty $smarty
* The Smarty object.
*
* @return string
* Template call's parameters.
* @param string $text
* {serialize} block contents from the template.
- * @param object $smarty
+ * @param CRM_Core_Smarty $smarty
* The Smarty object.
*
* @return string
* Template call's parameters.
* @param string $text
* {ts} block contents from the template.
- * @param object $smarty
+ * @param CRM_Core_Smarty $smarty
* The Smarty object.
*
* @return string
/**
* Dynamically construct a link based on an entity-type and entity-id.
*
- * @param $params
- * Array with keys:.
- * - table: string
- * - id: int
- * - action: string, 'VIEW' or 'UPDATE' [default: VIEW]
- * - title: string [optionally override default title]
- * @param $smarty
+ * @param array $params
+ * Array with keys:
+ * - table: string
+ * - id: int
+ * - action: string, 'VIEW' or 'UPDATE' [default: VIEW]
+ * - title: string [optionally override default title]
+ * @param CRM_Core_Smarty $smarty
*
* @return string
*/
*
* @param string $params
* Params of the {crmKey} call, with the ‘name’ key holding the name of the key.
- * @param object $smarty
+ * @param CRM_Core_Smarty $smarty
* The Smarty object.
*
* @return string
*
* @param array $params
* - is_default: bool, true if this is normal/default instance of the menu (which may be subject to CIVICRM_DISABLE_DEFAULT_MENU)
- * @param object $smarty
+ * @param CRM_Core_Smarty $smarty
* The Smarty object.
*
* @return string
/**
* Determine the URL of a resource file
*
- * @param $params
- * Array with keys:.
- * - ext: string, extension name. see CRM_Core_Resources::getUrl
- * - file: string, relative file path. see CRM_Core_Resources::getUrl
- * @param $smarty
+ * @param array $params
+ * Array with keys:
+ * - ext: string, extension name. see CRM_Core_Resources::getUrl
+ * - file: string, relative file path. see CRM_Core_Resources::getUrl
+ * @param CRM_Core_Smarty $smarty
*
* @return string
*/
/**
* Add a Javascript file to a specific part of the page
*
- * @param $params
- * Array with keys:.
- * - ext: string, extension name. see CRM_Core_Resources::addScriptFile
- * - file: string, relative file path. see CRM_Core_Resources::addScriptFile
- * - url: string. see CRM_Core_Resources::addScriptURL
- * - weight: int; default: CRM_Core_Resources::DEFAULT_WEIGHT (0)
- * - region: string; default: CRM_Core_Resources::DEFAULT_REGION ('html-header')
- * @param $smarty
+ * @param array $params
+ * Array with keys:
+ * - ext: string, extension name. see CRM_Core_Resources::addScriptFile
+ * - file: string, relative file path. see CRM_Core_Resources::addScriptFile
+ * - url: string. see CRM_Core_Resources::addScriptURL
+ * - weight: int; default: CRM_Core_Resources::DEFAULT_WEIGHT (0)
+ * - region: string; default: CRM_Core_Resources::DEFAULT_REGION ('html-header')
+ * @param CRM_Core_Smarty $smarty
*
* @throws Exception
*/
* var urlParams = ts={$mySig.ts}&extra={$mySig.extra}&sig={$mySig.signature}
* {endcode}
*
- * @param $params
- * Array with keys:.
+ * @param array $params
+ * Array with keys:
* - var: string, a smarty variable to generate
* - ts: int, the current time (if omitted, autogenerated)
* - any other vars are put into the signature (sorted)
/**
* Add a stylesheet <LINK> to a specific part of the page
*
- * @param $params
- * Array with keys:.
- * - ext: string, extension name. see CRM_Core_Resources::addStyleFile
- * - file: string, relative file path. see CRM_Core_Resources::addStyleFile
- * - url: string. see CRM_Core_Resources::addStyleURL
- * - weight: int; default: CRM_Core_Resources::DEFAULT_WEIGHT (0)
- * - region: string; default: CRM_Core_Resources::DEFAULT_REGION ('html-header')
- * @param $smarty
+ * @param array $params
+ * Array with keys:
+ * - ext: string, extension name. see CRM_Core_Resources::addStyleFile
+ * - file: string, relative file path. see CRM_Core_Resources::addStyleFile
+ * - url: string. see CRM_Core_Resources::addStyleURL
+ * - weight: int; default: CRM_Core_Resources::DEFAULT_WEIGHT (0)
+ * - region: string; default: CRM_Core_Resources::DEFAULT_REGION ('html-header')
+ * @param CRM_Core_Smarty $smarty
*
* @throws Exception
*/
*
* @param array $params
* The function params.
- * @param object $smarty
+ * @param CRM_Core_Smarty $smarty
* Reference to the smarty object.
*
* @return string
*
* @param array $params
* The function params.
- * @param object $smarty
+ * @param CRM_Core_Smarty $smarty
* Reference to the smarty object.
*
* @return string
*
* @param array $params
* Template call's parameters.
- * @param object $smarty
+ * @param CRM_Core_Smarty $smarty
* The Smarty object.
*
* @return NULL
/**
* CiviCRM's Smarty report section totals plugin
*
- * Prints the correct report section total based on the given key and order in the section heirarchy
+ * Prints the correct report section total based on the given key and order in the section hierarchy
*
* @package CRM
* @author Allen Shaw <allen@nswebsolutions.com>
*/
/**
- * Smarty block function for printintg the correct report section total
+ * Smarty block function for printing the correct report section total
*
* Smarty param: string $key value of the current section column
* Smarty param: int $depth the depth of the current section
*
* @param array $params
* Template call's parameters.
- * @param object $smarty
+ * @param CRM_Core_Smarty $smarty
* The Smarty object.
*
* @return string
*/
function smarty_function_sectionTotal($params, &$smarty) {
/* section totals are stored in template variable 'sectionTotals',
- * which is a two-dimensional array keyed to a string which is a delimited
- * concatenation (using CRM_Core_DAO::VALUE_SEPARATOR) of ordered permutations
- * of section header values, e.g.,
- * 'foo' => 10,
- * 'foo[VALUE_SEAPARATOR]bar' => 5,
- * 'foo[VALUE_SEAPARATOR]bar2' => 5
- * Note: This array is created and assigned to the template in CRM_Report_Form::sectionTotals()
- */
+ * which is a two-dimensional array keyed to a string which is a delimited
+ * concatenation (using CRM_Core_DAO::VALUE_SEPARATOR) of ordered permutations
+ * of section header values, e.g.,
+ * 'foo' => 10,
+ * 'foo[VALUE_SEAPARATOR]bar' => 5,
+ * 'foo[VALUE_SEAPARATOR]bar2' => 5
+ * Note: This array is created and assigned to the template in CRM_Report_Form::sectionTotals()
+ */
static $sectionValues = array();
* Note: This will perform like a dog, but who cares -- at most, we deal with O(100) iterations
* as part of a background task.
*
- * @param $params
- * , array with keys:.
- * - activity_id: int, required
- * - target_var: string, optional; name of a variable which will store the first/only target contact; default "target"
- * - assignee_var: string, optional; name of a variable which will store the first/only assignee contact; default "assignee"
- * - return: string, optional; comma-separated list of fields to return for each contact
+ * @param array $params
+ * , Array with keys:
+ * - activity_id: int, required
+ * - target_var: string, optional; name of a variable which will store the first/only target contact; default "target"
+ * - assignee_var: string, optional; name of a variable which will store the first/only assignee contact; default "assignee"
+ * - return: string, optional; comma-separated list of fields to return for each contact
*
- * @param $smarty
+ * @param CRM_Core_Smarty $smarty
*
- * @return empty
+ * @return string
*/
function smarty_function_simpleActivityContacts($params, &$smarty) {
if (empty($params['activity_id'])) {
/**
* @param string $tpl_name
* @param $tpl_timestamp
- * @param $smarty_obj
+ * @param CRM_Core_Smarty $smarty_obj
*
* @return bool
*/
/**
* @param string $tpl_name
- * @param $smarty_obj
+ * @param CRM_Core_Smarty $smarty_obj
*
* @return bool
*/
/**
* @param string $tpl_name
- * @param $smarty_obj
+ * @param CRM_Core_Smarty $smarty_obj
*/
function civicrm_smarty_resource_string_get_trusted($tpl_name, &$smarty_obj) {
* @param string $name
* Name of page.
*
- * @return CRM_Core_State state object matching the name
+ * @return CRM_Core_State
+ * state object matching the name
*/
public function &getState($name) {
if (isset($this->_states[$name])) {
* Array of relationship name.
*
* @return array
- * of relationship name.
+ * Array of relationship name.
*/
public static function getFormattedList(&$list) {
$relName = array();
*
* @return boolean
* the result of this processing
- * It is called from both the preview & the import actions
- * (non-PHPdoc)
+ * It is called from both the preview & the import actions
+ *
* @see CRM_Custom_Import_Parser_BaseClass::summary()
*/
public function summary(&$values) {
/**
* @return array
- * of field names which will be compared, so everything except ID.
+ * Array of field names which will be compared, so everything except ID.
*/
public static function getContactFields() {
$contactFields = CRM_Contact_DAO_Contact::fields();
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Event_BAO_ManageEvent object
+ * @return CRM_Event_BAO_ManageEvent
* @static
*/
public static function retrieve(&$params, &$defaults) {
* Event template id.
*
* @return array
- * of custom data defaults.
+ * Array of custom data defaults.
*/
public static function getTemplateDefaultValues($templateId) {
$defaults = array();
* @param array $params
* (reference ) an assoc array of name/value pairs.
*
- * @return CRM_Event_BAO_Participant object
+ * @return CRM_Event_BAO_Participant
* @static
*/
public static function &add(&$params) {
* @param array $params
* (reference ) an assoc array of name/value pairs.
*
- * @return CRM_Event_BAO_Participant object
+ * @return CRM_Event_BAO_Participant
* @static
*/
public static function create(&$params) {
* (reference ) an assoc array of name/value pairs.
* @param array $input
* An assosiative array of name /value pairs.
- * from other function
+ * from other function
*
- * @return CRM_Contribute_BAO_Contribution object
+ * @return CRM_Contribute_BAO_Contribution
* @static
*/
public static function checkDuplicate($input, &$duplicates) {
* An array of additional participant ids.
*
* @return array
- * of Urls.
+ * Array of Urls.
* @static
*/
public static function getAdditionalParticipantUrl($participantIds) {
*
* @param string $fieldName
* @param string $context
- * : @see CRM_Core_DAO::buildOptionsContext.
+ * @see CRM_Core_DAO::buildOptionsContext.
* @param array $props
- * : whatever is known about this dao object.
+ * whatever is known about this dao object.
*
* @return Array|bool
*/
* Event template id.
*
* @return array
- * of custom data defaults.
+ * Array of custom data defaults.
*/
public function templateCustomDataValues($templateId) {
$defaults = array();
* the default values are retrieved from the database
*
*
- * @return None
+ * @return void
*/
public function setDefaultValues() {
$defaults = array();
* Process the form after the input has been submitted and validated
*
*
- * @return None
+ * @return void
*/
public function postProcess() {
$params = $this->controller->exportValues();
* Return a status-type-keyed array of status classes
*
* @return array
- * of status classes, keyed by status type
+ * Array of status classes, keyed by status type
*/
public static function &participantStatusClass() {
static $statusClasses = NULL;
* @param int $id
*
* @return array
- * of event id → template title pairs
+ * Array of event id → template title pairs
*/
public static function &eventTemplates($id = NULL) {
if (!self::$eventTemplates) {
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Contribute_BAO_FinancialItem object
+ * @return CRM_Contribute_BAO_FinancialItem
* @static
*/
public static function retrieve(&$params, &$defaults) {
* @param array $params
* (reference ) an assoc array of name/value pairs.
*
- * @return CRM_Core_BAO_FinancialTrxn object
+ * @return CRM_Core_BAO_FinancialTrxn
* @static
*/
public static function createEntityTrxn($params) {
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Contribute_BAO_ContributionType object
+ * @return CRM_Contribute_BAO_ContributionType
* @static
*/
public static function retrieve(&$params, &$defaults) {
*
* @param array $allValues
*
- * @return CRM_Contribute_BAO_ContributionType object
+ * @return CRM_Contribute_BAO_ContributionType
* @static
*/
public static function retrieve(&$params, &$defaults, &$allValues = array()) {
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Financial_DAO_PaymentProcessor object on success, null otherwise
+ * @return CRM_Financial_DAO_PaymentProcessor|null
+ * object on success, null otherwise
* @static
*/
public static function retrieve(&$params, &$defaults) {
* @param bool $is_active
* Value we want to set the is_active field.
*
- * @return Object
- * DAO object on sucess, null otherwise
+ * @return CRM_Financial_DAO_PaymentProcessor|null
+ * DAO object on success, null otherwise
*
* @static
*/
*
* @param NULL
*
- * @return object
+ * @return CRM_Financial_DAO_PaymentProcessor|null
* The default payment processor object on success,
- * null otherwise
+ * null otherwise
* @static
*/
public static function &getDefault() {
}
/**
- * Function to delete payment processor
+ * Delete payment processor
*
* @param int $paymentProcessorID
*
* Compare 2 payment processors to see which should go first based on is_default
* (sort function for sortDefaultFirst)
* @param array $processor1
- * @param array_type $processor2
+ * @param array $processor2
* @return number
*/
public static function defaultComparison($processor1, $processor2) {
* arguably this could go on the pseudoconstant class
*
* @param array $capabilities
- * capabilities of processor e.g
- * - BackOffice
- * - TestMode
- * - LiveMode
- * - FutureStartDate
- * include test processors (we want to phase this out in favour of the testMode Capability)
+ * capabilities of processor e.g
+ * - BackOffice
+ * - TestMode
+ * - LiveMode
+ * - FutureStartDate
*
* @param array $ids
*
* @param string $type
* Type of payment information to be retrieved.
*
- * @return int
- * / array / object based on type
+ * @return int|array|object
* @static
*/
public static function getProcessorForEntity($entityID, $component = 'contribute', $type = 'id') {
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Core_BAO_LocaationType object on success, null otherwise
+ * @return CRM_Core_BAO_LocaationType|null
+ * object on success, null otherwise
* @static
*/
public static function retrieve(&$params, &$defaults) {
/**
* Global validation rules for the form
*
- * @param $values
+ * @param array $values
+ * posted values of the form
* @param $files
* @param $self
*
- * @internal param array $fields posted values of the form
- *
* @return array
* list of errors to be posted back to the form
* @static
/**
* Global validation rules for the form
*
- * @param $values
+ * @param array $values
+ * posted values of the form
* @param $files
* @param $self
*
- * @internal param array $fields posted values of the form
- *
* @return array
* list of errors to be posted back to the form
* @static
* @param array $params
* (reference ) an assoc array of name/value pairs.
*
- * @return CRM_Friend_BAO_Friend object
+ * @return CRM_Friend_BAO_Friend
* @static
*/
public static function add(&$params) {
* @param array $params
* (reference ) an assoc array of name/value pairs.
*
- * @return CRM_Contact_BAO_Contact object
+ * @return CRM_Contact_BAO_Contact
* @static
*/
public static function create(&$params) {
* @param array $params
* (reference ) an assoc array of name/value pairs.
*
- * @return CRM_Friend_BAO_Friend object
+ * @return CRM_Friend_BAO_Friend
* @static
*/
public static function addTellAFriend(&$params) {
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Grant_BAO_ManageGrant object
+ * @return CRM_Grant_BAO_ManageGrant
* @static
*/
public static function retrieve(&$params, &$defaults) {
* Set and validate field values
*
* @param array $elements
- * : array.
+ * array.
* @param $erroneousField
- * : reference.
+ * reference.
*
* @return int
*/
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Core_BAO_LocaationType object
+ * @return CRM_Core_BAO_LocaationType
* @static
*/
public static function retrieve(&$params, &$defaults) {
* @param array $ids
* (deprecated) the array that holds all the db ids.
*
- * @return CRM_Mailing_BAO_Component object
+ * @return CRM_Mailing_BAO_Component
*
* @static
*/
* @param array $params
*
* @return array
- * of mailings for a contact
+ * Array of mailings for a contact
*
* @static
*/
* @params array $params
* Form values.
*
- * @param $params
+ * @param array $params
* @param array $ids
*
* @return object
* @param array $params
* Values of the new EventQueue.
*
- * @return CRM_Mailing_Event_BAO_Queue The new EventQueue
+ * @return CRM_Mailing_Event_BAO_Queue
+ * The new EventQueue
* @static
*/
public static function create($params) {
* The list of email.
* @param int $contactId
* Currently used during event registration/contribution.
- * Specifically to avoid linking group to wrong duplicate contact
- * during event registration.
+ * Specifically to avoid linking group to wrong duplicate contact
+ * during event registration.
* @param string $context
*
* @return void
* @param array $ids
* The array that holds all the db ids.
*
- * @return CRM_Member_BAO_Membership object
+ * @return CRM_Member_BAO_Membership
* @static
*/
public static function add(&$params, $ids = array()) {
*
* @throws CRM_Core_Exception
*
- * @return CRM_Member_BAO_Membership object
+ * @return CRM_Member_BAO_Membership
* @static
*/
public static function create(&$params, &$ids, $skipRedirect = FALSE, $activityType = 'Membership Signup') {
* (reference ) an assoc array to hold the name / value pairs.
* in a hierarchical manner
*
- * @return CRM_Member_BAO_Membership object
+ * @return CRM_Member_BAO_Membership
* @static
*/
public static function retrieve(&$params, &$defaults) {
* Membership id of values to return.
*
* @return array
- * of key value pairs
+ * Array of key value pairs
*/
public static function getStatusANDTypeValues($membershipId) {
$values = array();
* Mode of payment.
*
* @return array
- * of membership type
+ * Array of membership type
* @static
*/
public static function getContactsCancelledMembership($contactID, $isTest = FALSE) {
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Member_BAO_MembershipStatus object
+ * @return CRM_Member_BAO_MembershipStatus
* @static
*/
public static function retrieve(&$params, &$defaults) {
* (reference ) an assoc array of name/value pairs.
*
* @throws Exception
- * @return CRM_Member_BAO_MembershipStatus object
+ * @return CRM_Member_BAO_MembershipStatus
* @static
*/
public static function create($params) {
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Member_BAO_MembershipType object
+ * @return CRM_Member_BAO_MembershipType
* @static
*/
public static function retrieve(&$params, &$defaults) {
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Pledge_BAO_Pledge object
+ * @return CRM_Pledge_BAO_Pledge
* @static
*/
public static function retrieve(&$params, &$defaults) {
* @param array $params
* (reference ) an assoc array of name/value pairs.
*
- * @return CRM_Pledge_BAO_Pledge object
+ * @return CRM_Pledge_BAO_Pledge
* @static
*/
public static function &create(&$params) {
*
* @param int $pledgeID
* @return array
- * of int (civicrm_pledge_payment.id)
+ * Array of int (civicrm_pledge_payment.id)
*/
public static function findCancelablePayments($pledgeID) {
$statuses = array_flip(CRM_Contribute_PseudoConstant::contributionStatus());
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Pledge_BAO_PledgeBlock object
+ * @return CRM_Pledge_BAO_PledgeBlock
* @static
*/
public static function retrieve(&$params, &$defaults) {
* @param array $params
* (reference ) an assoc array of name/value pairs.
*
- * @return CRM_Pledge_BAO_PledgeBlock object
+ * @return CRM_Pledge_BAO_PledgeBlock
* @static
*/
public static function &create(&$params) {
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Pledge_BAO_PledgePayment object
+ * @return CRM_Pledge_BAO_PledgePayment
* @static
*/
public static function retrieve(&$params, &$defaults) {
* @param array $params
* (reference) an assoc array of name/value pairs.
*
- * @return CRM_Price_DAO_LineItem object
+ * @return CRM_Price_DAO_LineItem
* @static
*/
public static function create(&$params) {
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Price_BAO_LineItem object
+ * @return CRM_Price_BAO_LineItem
* @static
*/
public static function retrieve(&$params, &$defaults) {
*
* @param string $overrideWhereClause
* E.g "WHERE contribution id = 7 " per the getLineItemsByContributionID wrapper.
- * this function precedes the convenience of the contribution id but since it does quite a bit more than just a db retrieval we need to be able to use it even
- * when we don't want it's entity-id magix
+ * this function precedes the convenience of the contribution id but since it does quite a bit more than just a db retrieval we need to be able to use it even
+ * when we don't want it's entity-id magix
*
* @return array
- * of line items
+ * Array of line items
*/
public static function getLineItems($entityId, $entity = 'participant', $isQuick = NULL, $isQtyZero = TRUE, $relatedEntity = FALSE, $overrideWhereClause = '') {
$whereClause = $fromClause = NULL;
* to the price set used for particular event
* @param array $values
* Reference to the values array(.
- * this is
+ * this is
* lineItem array)
*
* @return void
* @param array $params
* (reference) an assoc array of name/value pairs.
*
- * @return CRM_Price_BAO_PriceField object
+ * @return CRM_Price_BAO_PriceField
* @static
*/
public static function add(&$params) {
* @param array $params
* (reference) an assoc array of name/value pairs.
*
- * @return CRM_Price_DAO_PriceField object
+ * @return CRM_Price_DAO_PriceField
* @static
*/
public static function create(&$params) {
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Price_DAO_PriceField object
+ * @return CRM_Price_DAO_PriceField
* @static
*/
public static function retrieve(&$params, &$defaults) {
*
* @param $ids
*
- * @return CRM_Price_DAO_PriceFieldValue object
+ * @return CRM_Price_DAO_PriceFieldValue
* @static
*/
public static function add(&$params, $ids = array()) {
*
* @param $ids
*
- * @return CRM_Price_DAO_PriceFieldValue object
+ * @return CRM_Price_DAO_PriceFieldValue
* @static
*/
public static function create(&$params, $ids = array()) {
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Price_DAO_PriceFieldValue object
+ * @return CRM_Price_DAO_PriceFieldValue
* @static
*/
public static function retrieve(&$params, &$defaults) {
* @param array $params
* (reference) an assoc array of name/value pairs.
*
- * @return CRM_Price_DAO_PriceSet object
+ * @return CRM_Price_DAO_PriceSet
* @static
*/
public static function create(&$params) {
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Price_DAO_PriceSet object
+ * @return CRM_Price_DAO_PriceSet
* @static
*/
public static function retrieve(&$params, &$defaults) {
*
* @return boolean
* false if fields exist for this set, true if the
- * set could be deleted
+ * set could be deleted
*
* @static
*/
* Price Set id.
*
* @return array
- * of the field ids
+ * Array of the field ids
*
* @static
*/
* Get or build the list of search objects (via hook)
*
* @return array
- * of CRM_Report_BAO_Hook_Interface objects
+ * Array of CRM_Report_BAO_Hook_Interface objects
*/
public function getSearchQueryObjects() {
if ($this->_queryObjects === NULL) {
* @param array $params
* (reference ) an assoc array of name/value pairs.
*
- * @return CRM_Report_DAO_ReportInstance object
+ * @return CRM_Report_DAO_ReportInstance
* @static
*/
public static function add(&$params) {
* @param array $params
* (reference ) an assoc array of name/value pairs.
*
- * @return CRM_Report_BAO_ReportInstance object
+ * @return CRM_Report_BAO_ReportInstance
* @static
*/
public static function &create(&$params) {
* Get phone columns to add to array
*
* @param array $options
- * - prefix Prefix to add to table (in case of more than one instance of the table)
- * - prefix_label Label to give columns from this phone table instance
+ * - prefix Prefix to add to table (in case of more than one instance of the table)
+ * - prefix_label Label to give columns from this phone table instance
*
* @return array
* phone columns definition
* Get address columns to add to array
*
* @param array $options
- * - prefix Prefix to add to table (in case of more than one instance of the table)
- * - prefix_label Label to give columns from this address table instance
+ * - prefix Prefix to add to table (in case of more than one instance of the table)
+ * - prefix_label Label to give columns from this address table instance
*
* @return array
* address columns definition
* Get address columns to add to array
*
* @param array $options
- * - prefix Prefix to add to table (in case of more than one instance of the table)
- * - prefix_label Label to give columns from this address table instance
+ * - prefix Prefix to add to table (in case of more than one instance of the table)
+ * - prefix_label Label to give columns from this address table instance
*
* @return array
* address columns definition
/**
* @param int $startId
* @param int $endId
- * @return CRM_Core_DAO columns include "id" and "image_URL"
+ * @return CRM_Core_DAO
+ * columns include "id" and "image_URL"
*/
public static function findContactImageUrls($startId, $endId) {
$sql = "
* @param array $params
* (reference ) an assoc array of name/value pairs.
*
- * @return CRM_Upgrade_Snapshot_V4p2_Price_BAO_Field object
+ * @return CRM_Upgrade_Snapshot_V4p2_Price_BAO_Field
* @static
*/
public static function &add(&$params) {
* @param array $params
* (reference) an assoc array of name/value pairs.
*
- * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_Field object
+ * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_Field
* @static
*/
public static function create(&$params) {
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_Field object
+ * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_Field
* @static
*/
public static function retrieve(&$params, &$defaults) {
*
* @param $ids
*
- * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue object
+ * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue
* @static
*/
public static function &add(&$params, $ids) {
*
* @param $ids
*
- * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue object
+ * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue
* @static
*/
public static function create(&$params, $ids) {
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue object
+ * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue
* @static
*/
public static function retrieve(&$params, &$defaults) {
* @param array $params
* (reference) an assoc array of name/value pairs.
*
- * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_LineItem object
+ * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_LineItem
* @static
*/
public static function create(&$params) {
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Upgrade_Snapshot_V4p2_Price_BAO_LineItem object
+ * @return CRM_Upgrade_Snapshot_V4p2_Price_BAO_LineItem
* @static
*/
public static function retrieve(&$params, &$defaults) {
* @param null $isQuick
*
* @return array
- * of line items
+ * Array of line items
*/
public static function getLineItems($entityId, $entity = 'participant', $isQuick = NULL) {
$selectClause = $whereClause = $fromClause = NULL;
* to the price set used for particular event
* @param array $values
* Reference to the values array(.
- * this is
+ * this is
* lineItem array)
*
* @return void
* @param array $params
* (reference) an assoc array of name/value pairs.
*
- * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_Set object
+ * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_Set
* @static
*/
public static function create(&$params) {
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_Set object
+ * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_Set
* @static
*/
public static function retrieve(&$params, &$defaults) {
*
* @return boolean
* false if fields exist for this set, true if the
- * set could be deleted
+ * set could be deleted
*
* @static
*/
* @param int id Price Set id
*
* @return array
- * of the field ids
+ * Array of the field ids
*
* @static
*/
* plugin status page or the Drupal admin/reports/status path.
*
* @return array
- * of messages
+ * Array of messages
* @link https://api.drupal.org/api/drupal/modules%21system%21system.api.php/function/hook_requirements
*/
public function checkAll() {
* requested directly.
*
* @return array
- * of messages
+ * Array of messages
* @see CRM-14091
*/
public function checkLogFileIsNotAccessible() {
* to search engines; it only means they can be requested directly.
*
* @return array
- * of messages
+ * Array of messages
* @see CRM-14091
*
* @TODO: Test with WordPress, Joomla.
* we'll probably match that).
*
* @return array
- * of messages
+ * Array of messages
* @see CRM-14091
*
* @TODO: Test with WordPress, Joomla.
*
* @param $format
* Given format ( eg 'M Y', 'Y M' ).
- * return array of qfMapping and date parts for date format.
+ * return array of qfMapping and date parts for date format.
*
* @return array|null|string
*/
* @param CRM_Core_DAO $dao
* The item for which we want a reference count.
* @param array $refCounts
- * Each item in the array is an array with keys:.
+ * Each item in the array is an Array with keys:
* - name: string, eg "sql:civicrm_email:contact_id"
* - type: string, eg "sql"
* - count: int, eg "5" if there are 5 email addresses that refer to $dao
*
* @param array $params
* Array fields include: groupName, from, toName, toEmail, subject, cc, bcc, text, html,
- * returnPath, replyTo, headers, attachments (array)
+ * returnPath, replyTo, headers, attachments (array)
* @param string $context
* The context in which the hook is being invoked, eg 'civimail'.
*
* The case ID.
*
* @return array
- * of data to be displayed, where the key is a unique id to be used for styling (div id's)
- * and the value is an array with keys 'label' and 'value' specifying label/value pairs
+ * Array of data to be displayed, where the key is a unique id to be used for styling (div id's)
+ * and the value is an array with keys 'label' and 'value' specifying label/value pairs
*/
public static function caseSummary($caseID) {
return self::singleton()->invoke(1, $caseID,
* activity, campaign, case, contact, contribution, event, grant, membership, and pledge
* @param array &$headers the list of column headers, an associative array with keys: ( name, sort, order )
* @param array &$rows the list of values, an associate array with fields that are displayed for that component
- * @param $selector
- *
- * @internal param array $seletor the selector object. Allows you access to the context of the search
+ * @param array $selector
+ * the selector object. Allows you access to the context of the search
*
* @return void
* modify the header and values object to pass the data u need
* @param CRM_Core_DAO $bao
* @param array $link
* To define the link, add these keys to $link:.
- * - title: string
- * - path: string
- * - query: array
- * - url: string (used in lieu of "path"/"query")
+ * - title: string
+ * - path: string
+ * - query: array
+ * - url: string (used in lieu of "path"/"query")
* Note: if making "url" CRM_Utils_System::url(), set $htmlize=false
* @return mixed
*/
* Hook name, e.g civicrm_pre.
* @param array $callable
* Function to call ie array(class, method).
- * eg. array($this, mymethod)
+ * eg. array($this, mymethod)
*/
public function setHook($hook, $callable) {
$this->adhocHooks[$hook] = $callable;
* @param string $jsCode
* Raw Javascript code.
* @return array
- * of translatable strings
+ * Array of translatable strings
*/
public static function parseStrings($jsCode) {
$strings = array();
* This may be inefficient and should generally be avoided.
*
* @return array
- * of string, constant names
+ * Array of string, constant names
*/
public static function findConstants() {
if (self::$constants === NULL) {
* @param $class
*
* @return array
- * of string, constant names
+ * Array of string, constant names
*/
public static function findConstantsByClass($class) {
$clazz = new ReflectionClass($class);
*
* @param array $crudLinkSpec
* With keys:.
- * - action: int, CRM_Core_Action::UPDATE or CRM_Core_Action::VIEW [default: VIEW]
- * - entity_table: string, eg "civicrm_contact"
- * - entity_id: int
+ * - action: int, CRM_Core_Action::UPDATE or CRM_Core_Action::VIEW [default: VIEW]
+ * - entity_table: string, eg "civicrm_contact"
+ * - entity_id: int
* @return array|NULL
* NULL if unavailable, or an array. array has keys:
- * - path: string
- * - query: array
- * - title: string
- * - url: string
+ * - path: string
+ * - query: array
+ * - title: string
+ * - url: string
*/
public static function createDefaultCrudLink($crudLinkSpec) {
$crudLinkSpec['action'] = CRM_Utils_Array::value('action', $crudLinkSpec, CRM_Core_Action::VIEW);
*
* @return bool
* TRUE for internal paths, FALSE for external. The drupal_add_js fn is able to add js more
- * efficiently if it is known to be in the drupal site
+ * efficiently if it is known to be in the drupal site
*/
public function formatResourceUrl(&$url) {
$internal = FALSE;
*
* @param array $contactIDs
* This should always be array(0) or its not anonymous - left to keep signature same.
- * as main fn
+ * as main fn
* @param string $returnProperties
* @param bool $skipOnHold
* @param bool $skipDeceased
* Field => value to be used in the WHERE.
* @param string $weightField
* Field which contains the weight value,.
- * defaults to 'weight'
+ * defaults to 'weight'
*
* @return bool
*/
* Field => value to be used in the WHERE.
* @param string $weightField
* Field which contains the weight value,.
- * defaults to 'weight'
+ * defaults to 'weight'
*
* @return bool
*/
* Field => value to be used in the WHERE.
* @param string $weightField
* Field which contains the weight value,.
- * defaults to 'weight'
+ * defaults to 'weight'
*
* @return int
*/
* Field => value to be used in the WHERE.
* @param string $weightField
* Field which contains the weight value,.
- * defaults to 'weight'
+ * defaults to 'weight'
*
* @return integer
*/
* Field => value to be used in the WHERE.
* @param string $weightField
* Field which contains the weight value,.
- * defaults to 'weight'
+ * defaults to 'weight'
*
* @return integer
*/
*
* @param null $groupBy
*
- * @return CRM_Core_DAO objet that holds the results of the query
+ * @return CRM_Core_DAO
+ * objet that holds the results of the query
*/
static function &query(
$queryType,
}
/**
- * @param array $testClasses
+ * @param array $paths
+ *
* @return array
* each element is an array with keys:
* - file: string
* @param array $db_config
* An array with keys:
* - host (with optional port specified eg. localhost:12345)
- * = database (name of database to select)
+ * - database (name of database to select)
* - username
* - password
*
* @param array $params
*
* @return array
- * of newly created acl property values.
+ * Array of newly created acl property values.
* @access public
*/
function civicrm_api3_acl_create($params) {
* @param array $params
*
* @return array
- * of retrieved acl property values.
+ * Array of retrieved acl property values.
* @access public
*/
function civicrm_api3_acl_get($params) {
* @param array $params
*
* @return array
- * of deleted values.
+ * Array of deleted values.
* @access public
*/
function civicrm_api3_acl_delete($params) {
* @param array $params
*
* @return array
- * of newly created acl_role property values.
+ * Array of newly created acl_role property values.
* @access public
*/
function civicrm_api3_acl_role_create($params) {
* @param array $params
*
* @return array
- * of retrieved acl_role property values.
+ * Array of retrieved acl_role property values.
* @access public
*/
function civicrm_api3_acl_role_get($params) {
* @param array $params
*
* @return array
- * of deleted values.
+ * Array of deleted values.
* @access public
*/
function civicrm_api3_acl_role_delete($params) {
* @param array $params
*
* @return array
- * of newly created activity contact records.
+ * Array of newly created activity contact records.
* @access public
*/
function civicrm_api3_activity_contact_create($params) {
* @param array $params
*
* @return array
- * of newly created tag property values.
+ * Array of newly created tag property values.
* @access public
*/
function civicrm_api3_address_create(&$params) {
*
* @param array $params
* @return array
- * of newly created file property values.
+ * Array of newly created file property values.
* @access public
* @throws API_Exception validation errors
*/
}
/**
- * @param $params
+ * @param array $params
* @return array
* @throws API_Exception
*/
* @param array $params
*
* @return array
- * of newly created batch property values.
+ * Array of newly created batch property values.
* @access public
*/
function civicrm_api3_batch_create($params) {
* @param array $params
*
* @return array
- * of retrieved batch property values.
+ * Array of retrieved batch property values.
* @access public
*/
function civicrm_api3_batch_get($params) {
* @param array $params
*
* @return array
- * of deleted values.
+ * Array of deleted values.
* @access public
*/
function civicrm_api3_batch_delete($params) {
/**
* @deprecated api notice
* @return array
- * of deprecated actions
+ * Array of deprecated actions
*/
function _civicrm_api3_case_deprecation() {
return array('activity_create' => 'Case api "activity_create" action is deprecated. Use the activity api instead.');
* @param int $contactID
* If present the contact with that ID is updated.
*
- * @return CRM_Contact_BAO_Contact object
+ * @return CRM_Contact_BAO_Contact
* @access public
* @static
*/
/**
* @deprecated api notice
* @return array
- * of deprecated actions
+ * Array of deprecated actions
*/
function _civicrm_api3_contact_deprecation() {
return array('getquick' => 'The "getquick" action is deprecated in favor of "getlist".');
* (reference ) input parameters.
*
* @return array
- * of contributions, if error an array with an error id and error message
+ * Array of contributions, if error an array with an error id and error message
* @static void
* @access public
* {@getfields Contribution_get}
*
* @param array $params
* Associative array of property name/value.
- * pairs to insert in new contact.
+ * pairs to insert in new contact.
* @param array $values
* The reformatted properties that we can use internally.
* '
* function after deletion so that the field is available for us (getfields manages date conversion
* among other things
*
- * @param $params
+ * @param array $params
* Array Associative array of property name/value pairs to create new custom field.
*
* @return array
/**
* Use this API to delete an existing custom group field.
*
- * @param $params
+ * @param array $params
* Array id of the field to be deleted.
*
* @return array
*
* @param array $params
* An associative array used in construction.
- * retrieval of the object
+ * retrieval of the object
* @todo missing get function
*
*
* See the CRM Data Model for custom_group property definitions
* $params['class_name'] is a required field, class being extended.
*
- * @param $params
+ * @param array $params
* Array Associative array of property name/value pairs to insert in group.
* {@getfields CustomGroup_create}
*
* @param array $params
*
* @return array
- * of newly created option_value property values.
+ * Array of newly created option_value property values.
* {@getfields OptionValue_create}
* @access public
*/
* @version $Id: CustomField.php 30879 2010-11-22 15:45:55Z shot $
*/
-/**
- * Files required for this package
- */
-
/**
* Sets custom values for an entity.
*
- *
- * @param $params
+ * @param array $params
* Expected keys are in format custom_fieldID:recordID or custom_groupName:fieldName:recordID.
- * for example:
- * // entity ID. You do not need to specify entity type, we figure it out based on the fields you're using
- * 'entity_id' => 123,
- * // (omitting :id) inserts or updates a field in a single-valued group
- * 'custom_6' => 'foo',
- * // custom_24 is checkbox or multiselect, so pass items as an array
- * 'custom_24' => array('bar', 'baz'),
- * // in this case custom_33 is part of a multi-valued group, and we're updating record id 5
- * 'custom_33:5' => value,
- * // inserts new record in multi-valued group
- * 'custom_33:-1' => value,
- * // inserts another new record in multi-valued group
- * 'custom_33:-2' => value,
- * // you can use group_name:field_name instead of ID
- * 'custom_some_group:my_field => 'myinfo',
- * // updates record ID 8 in my_other_field in multi-valued some_big_group
- * 'custom_some_big_group:my_other_field:8 => 'myinfo',
+ *
+ * @example
+ * // entity ID. You do not need to specify entity type, we figure it out based on the fields you're using
+ * 'entity_id' => 123,
+ * // (omitting :id) inserts or updates a field in a single-valued group
+ * 'custom_6' => 'foo',
+ * // custom_24 is checkbox or multiselect, so pass items as an array
+ * 'custom_24' => array('bar', 'baz'),
+ * // in this case custom_33 is part of a multi-valued group, and we're updating record id 5
+ * 'custom_33:5' => value,
+ * // inserts new record in multi-valued group
+ * 'custom_33:-1' => value,
+ * // inserts another new record in multi-valued group
+ * 'custom_33:-2' => value,
+ * // you can use group_name:field_name instead of ID
+ * 'custom_some_group:my_field => 'myinfo',
+ * // updates record ID 8 in my_other_field in multi-valued some_big_group
+ * 'custom_some_big_group:my_other_field:8 => 'myinfo',
*
*
* @throws Exception
- * @return array('values' => TRUE) or array('is_error' => 1, 'error_message' => 'what went wrong')
+ * @return array
+ * ['values' => TRUE] or ['is_error' => 1, 'error_message' => 'what went wrong']
*
* @access public
*/
/**
* Use this API to get existing custom values for an entity.
*
- * @param $params
+ * @param array $params
* Array specifying the entity_id.
- * Optionally include entity_type param, i.e. 'entity_type' => 'Activity'
- * If no entity_type is supplied, it will be determined based on the fields you request.
- * If no entity_type is supplied and no fields are specified, 'Contact' will be assumed.
- * Optionally include the desired custom data to be fetched (or else all custom data for this entity will be returned)
- * Example: 'entity_id' => 123, 'return.custom_6' => 1, 'return.custom_33' => 1
- * If you do not know the ID, you may use group name : field name, for example 'return.foo_stuff:my_field' => 1
+ * Optionally include entity_type param, i.e. 'entity_type' => 'Activity'
+ * If no entity_type is supplied, it will be determined based on the fields you request.
+ * If no entity_type is supplied and no fields are specified, 'Contact' will be assumed.
+ * Optionally include the desired custom data to be fetched (or else all custom data for this entity will be returned)
+ * Example: 'entity_id' => 123, 'return.custom_6' => 1, 'return.custom_33' => 1
+ * If you do not know the ID, you may use group name : field name, for example 'return.foo_stuff:my_field' => 1
*
* @throws API_Exception
* @return array
* @deprecated api notice
* @param array entities
* @return array
- * of deprecated api entities
+ * Array of deprecated api entities
*/
function _civicrm_api3_entity_deprecation($entities) {
$deprecated = array();
*
*/
-/**
- * Files required for this package
- */
-
/**
* Create a Event
*
*
* @param array $params
* Input parameters.
- * Allowed @params array keys are:
+ * Allowed @params array keys are:
* {@getfields event_create}
*
* @return array
* An associative array of name/value property values of civicrm_event.
* {@getfields event_get}
*
- * @return Array
- * of all found event property values.
+ * @return array
+ * Array of all found event property values.
* @access public
*
*/
* @param array $params
* API request params with 'key' or 'keys'.
* @return array
- * of extension keys
+ * Array of extension keys
* @throws API_Exception
*/
function _civicrm_api3_getKeys($params) {
* An associative array of name/value property values of civicrm_file.
*
* @return array
- * of newly created file property values.
+ * Array of newly created file property values.
* @access public
*/
function civicrm_api3_file_create($params) {
* @param array $params
* An associative array of name/value property values of civicrm_file.
*
- * @return Array
- * of all found file object property values.
+ * @return array
+ * Array of all found file object property values.
* @access public
*/
function civicrm_api3_file_get($params) {
* An array of name/value property values of civicrm_file.
*
* @return array
- * of updated file object property values
+ * Array of updated file object property values
* @access public
*/
function civicrm_api3_file_update($params) {
* @param array $params
*
* @return array
- * of newly created financial_account property values.
+ * Array of newly created financial_account property values.
* @access public
*/
function civicrm_api3_financial_account_create($params) {
* @param array $params
*
* @return array
- * of retrieved financial_account property values.
+ * Array of retrieved financial_account property values.
* @access public
*/
function civicrm_api3_financial_account_get($params) {
* @param array $params
*
* @return array
- * of deleted values.
+ * Array of deleted values.
* @access public
*/
function civicrm_api3_financial_account_delete($params) {
* @param array $params
*
* @return array
- * of newly created financial_type property values.
+ * Array of newly created financial_type property values.
* @access public
*/
function civicrm_api3_financial_type_create($params) {
* @param array $params
*
* @return array
- * of retrieved financial_type property values.
+ * Array of retrieved financial_type property values.
* @access public
*/
function civicrm_api3_financial_type_get($params) {
* @param array $params
*
* @return array
- * of deleted values.
+ * Array of deleted values.
* @access public
*/
function civicrm_api3_financial_type_delete($params) {
*
* @param array $apiRequest
* Api request as an array. Keys are.
- * - entity: string
- * - action: string
- * - version: string
- * - function: callback (mixed)
- * - params: array, varies
+ * - entity: string
+ * - action: string
+ * - version: string
+ * - function: callback (mixed)
+ * - params: array, varies
* @return array
* API success object
*/
* Api request as an array.
*
* @return array
- * of results
+ * Array of results
*/
function civicrm_api3_generic_getoptions($apiRequest) {
// Resolve aliases
* and call 'create' to save the revised entity.
*
* @param array $apiRequest
- * Array with keys:.
- * - entity: string
- * - action: string
- * - version: string
- * - function: callback (mixed)
- * - params: array, varies
+ * Array with keys:
+ * - entity: string
+ * - action: string
+ * - version: string
+ * - function: callback (mixed)
+ * - params: array, varies
*
* @return array|int|mixed
*/
/**
* @deprecated api notice
* @return array
- * of deprecated actions
+ * Array of deprecated actions
*/
function _civicrm_api3_group_contact_deprecation() {
return array(
* @example GroupOrganizationCreate.php
* {@getfields GroupOrganization_create}
*
- * @param $params
+ * @param array $params
* Array.
*
* @return array
* @param array $params
*
* @return array
- * of newly created IM property values.
+ * Array of newly created IM property values.
* @access public
*/
function civicrm_api3_im_create($params) {
*
* @param array $params
* Array of one or more valid property_name=>value pairs. If $params is set.
- * as null, all line_items will be returned (default limit is 25)
+ * as null, all line_items will be returned (default limit is 25)
*
* @return array
* Array of matching line_items
*
* @param array $params
* Array containing id of the group.
- * to be deleted
+ * to be deleted
*
* @return array
* API result array
*
* @param array $params
* Array of one or more valid property_name=>value pairs. If $params is set.
- * as null, all loc_blocks will be returned (default limit is 25)
+ * as null, all loc_blocks will be returned (default limit is 25)
*
* @return array
* Array of matching loc_blocks
*
*/
-/**
- * Files required for this package
- */
-
/**
* Handle a create event.
*
/**
* @deprecated api notice
* @return array
- * of deprecated actions
+ * Array of deprecated actions
*/
function _civicrm_api3_mailing_deprecation() {
return array('event_confirm' => 'Mailing api "event_confirm" action is deprecated. Use the mailing_event_confirm api instead.');
*
*/
-/**
- * Files required for this package
- */
-
/**
* Handle a create mailing ab testing
*
*
* @throws API_Exception
* @return array
- * of newly created mailing_component property values.
+ * Array of newly created mailing_component property values.
* @access public
*/
function civicrm_api3_mailing_component_create($params) {
* @param array $params
*
* @return array
- * of retrieved mailing_component property values.
+ * Array of retrieved mailing_component property values.
* @access public
*/
function civicrm_api3_mailing_component_get($params) {
*
* @throws API_Exception
* @return array
- * of deleted values.
+ * Array of deleted values.
* @access public
*/
function civicrm_api3_mailing_component_delete($params) {
*
*/
-/**
- * Files required for this package
- */
-
/**
* Handle creation of a Mailing Job for a Mailing.
*/
*
*/
-/**
- * Files required for this package
- */
-
/**
* Returns array of Mailing Recipients
*
* This API is used for deleting a contact membership
*
- * @param $params
+ * @param array $params
* Array array holding id - Id of the contact membership to be deleted.
*
* @return array
* An associative array of name/value property values of civicrm_membership.
*
* @return array
- * of newly created membership property values.
+ * Array of newly created membership property values.
* {@getfields membership_create}
* @access public
*/
* options affecting the desired results; has legacy support
* for just passing the contact_id itself as the argument
*
- * @return Array
- * of all found membership property values.
+ * @return array
+ * Array of all found membership property values.
* @access public
* @todo needs some love - basically only a get for a given contact right now
* {@getfields membership_get}
* An associative array of name/value property values of civicrm_membership_status.
*
* @return array
- * of newly created membership status property values.
+ * Array of newly created membership status property values.
* {@getfields MembershipStatus_create}
* @access public
*/
* @param array $params
* An associative array of name/value property values of civicrm_membership_status.
*
- * @return Array
- * of all found membership status property values.
+ * @return array
+ * Array of all found membership status property values.
* {@getfields MembershipStatus_get}
* @access public
*/
* @deprecated - should just use create
*
* @return array
- * of updated membership status property values
+ * Array of updated membership status property values
* @access public
*/
function &civicrm_api3_membership_status_update($params) {
* An associative array of name/value property values of civicrm_membership_type.
* {getfields MembershipType_get}
*
- * @return Array
- * of all found membership type property values.
+ * @return array
+ * Array of all found membership type property values.
* @access public
*/
function civicrm_api3_membership_type_get($params) {
*
*/
-/**
- * Files required for this package
- */
-
/**
* Create Note
*
*
* @return array
* array of properties,
- * if error an array with an error id and error message
+ * if error an array with an error id and error message
* {@getfields note_get}
* @static void
* @access public
*
* @throws API_Exception
* @return array
- * of newly created option_value property values.
+ * Array of newly created option_value property values.
* {@getfields OptionValue_create}
* @access public
*/
*
*/
-/**
- * Files required for this package
- */
-
/**
* Create an Event Participant
*
*
*/
-/**
- * Files required for this package
- */
-
/**
* Create a Event Participant Payment
*
* {@example ParticipantPaymentCreate.php 0}
*
* @return array
- * of newly created payment property values.
+ * Array of newly created payment property values.
* {@getfields ParticipantPayment_create}
* @access public
*/
* @param array $params
*
* @return array
- * of newly created PaymentProcessor property values.
+ * Array of newly created PaymentProcessor property values.
* @access public
*/
function civicrm_api3_payment_processor_create($params) {
* @param array $params
*
* @return array
- * of newly created phone property values.
+ * Array of newly created phone property values.
* @access public
*/
function civicrm_api3_phone_create($params) {
*
* @throws API_Exception
* @return array
- * of newly created premium property values.
+ * Array of newly created premium property values.
* @access public
*/
function civicrm_api3_premium_create($params) {
* @param array $params
*
* @return array
- * of retrieved premium property values.
+ * Array of retrieved premium property values.
* @access public
*/
function civicrm_api3_premium_get($params) {
*
* @throws API_Exception
* @return array
- * of deleted values.
+ * Array of deleted values.
* @access public
*/
function civicrm_api3_premium_delete($params) {
*
* @param array $params
* Array of one or more valid property_name=>value pairs. If $params is set.
- * as null, all price_fields will be returned (default limit is 25)
+ * as null, all price_fields will be returned (default limit is 25)
*
* @return array
* Array of matching price_fields
*
* @param array $params
* Array containing id of the group.
- * to be deleted
+ * to be deleted
*
* @return array
* API result array
*
* @param array $params
* Array of one or more valid property_name=>value pairs. If $params is set.
- * as null, all price_field_values will be returned (default limit is 25)
+ * as null, all price_field_values will be returned (default limit is 25)
*
* @return array
* Array of matching price_field_values
*
* @param array $params
* Array containing id of the group.
- * to be deleted
+ * to be deleted
*
* @return array
* API result array
*
* @param array $params
* Array of one or more valid property_name=>value pairs. If $params is set.
- * as null, all price_sets will be returned (default limit is 25)
+ * as null, all price_sets will be returned (default limit is 25)
*
* @return array
* Array of matching price_sets
*
* @param array $params
* Array containing id of the group.
- * to be deleted
+ * to be deleted
*
* @return array
* API result array
* @param array $params
*
* @return array
- * of newly created print_label property values.
+ * Array of newly created print_label property values.
* @access public
*/
function civicrm_api3_print_label_create($params) {
* @param array $params
*
* @return array
- * of retrieved print_label property values.
+ * Array of retrieved print_label property values.
* @access public
*/
function civicrm_api3_print_label_get($params) {
* @param array $params
*
* @return array
- * of deleted values.
+ * Array of deleted values.
* @access public
*/
function civicrm_api3_print_label_delete($params) {
*
* @throws API_Exception
* @return array
- * of newly created product property values.
+ * Array of newly created product property values.
* @access public
*/
function civicrm_api3_product_create($params) {
* @param array $params
*
* @return array
- * of retrieved product property values.
+ * Array of retrieved product property values.
* @access public
*/
function civicrm_api3_product_get($params) {
*
* @throws API_Exception
* @return array
- * of deleted values.
+ * Array of deleted values.
* @access public
*/
function civicrm_api3_product_delete($params) {
/**
* @deprecated api notice
* @return array
- * of deprecated actions
+ * Array of deprecated actions
*/
function _civicrm_api3_profile_deprecation() {
return array(
* @param array $params
*
* @return array
- * of newly created report instance property values.
+ * Array of newly created report instance property values.
* @access public
*/
function civicrm_api3_report_instance_create($params) {
* @param array $params
*
* @return array
- * of newly created option_value property values.
+ * Array of newly created option_value property values.
* {@getfields OptionValue_create}
* @access public
*/
* @param array $params
*
* @return array
- * of newly created sms_provider property values.
+ * Array of newly created sms_provider property values.
* @access public
*/
function civicrm_api3_sms_provider_create($params) {
* @param array $params
*
* @return array
- * of retrieved sms_provider property values.
+ * Array of retrieved sms_provider property values.
* @access public
*/
function civicrm_api3_sms_provider_get($params) {
* @param array $params
*
* @return array
- * of deleted values.
+ * Array of deleted values.
* @access public
*/
function civicrm_api3_sms_provider_delete($params) {
* @param array $params
*
* @return array
- * of newly created tag property values.
+ * Array of newly created tag property values.
* {@getfields tag_create}
* @access public
*/
/**
* Defines 'uf field' within a group.
*
- * @param $params
+ * @param array $params
* Array Associative array of property name/value pairs to create new uf field.
*
* @throws API_Exception
*/
/**
- * Files required for this package
+ * @param array $params
*/
function _civicrm_api3_uf_group_create_spec(&$params) {
$session = CRM_Core_Session::singleton();
/**
* Use this API to create a new group. See the CRM Data Model for uf_group property definitions
*
- * @param $params
+ * @param array $params
* Array Associative array of property name/value pairs to insert in group.
*
* @return array
* @param array $params
*
* @return array
- * of newly created website property values.
+ * Array of newly created website property values.
* @access public
* @todo convert to using basic create - BAO function non-std
*/
*
* @param array $params
* Array containing id of the word_replacement.
- * to be deleted
+ * to be deleted
*
* @return array
* api result array
* return the DAO of the function or Entity
* @param string $name
* Either a function of the api (civicrm_{entity}_create or the entity name.
- * return the DAO name to manipulate this function
- * eg. "civicrm_api3_contact_create" or "Contact" will return "CRM_Contact_BAO_Contact"
+ * return the DAO name to manipulate this function
+ * eg. "civicrm_api3_contact_create" or "Contact" will return "CRM_Contact_BAO_Contact"
* @return mixed|string
*/
function _civicrm_api3_get_DAO($name) {
* return the DAO of the function or Entity
* @param string $name
* Is either a function of the api (civicrm_{entity}_create or the entity name.
- * return the DAO name to manipulate this function
- * eg. "civicrm_contact_create" or "Contact" will return "CRM_Contact_BAO_Contact"
+ * return the DAO name to manipulate this function
+ * eg. "civicrm_contact_create" or "Contact" will return "CRM_Contact_BAO_Contact"
* @return mixed
*/
function _civicrm_api3_get_BAO($name) {
* @param array $params
* @param string $mode
* @param string $entity
- * @return CRM_Core_DAO query object
+ * @return CRM_Core_DAO
+ * query object
*/
function _civicrm_api3_get_query_object($params, $mode, $entity) {
$options = _civicrm_api3_get_options_from_params($params, TRUE, $entity, 'get');
* Params array as passed into civicrm_api.
* @param bool $queryObject
* Is this supporting a queryobject api (e.g contact) - if so we support more options.
- * for legacy report & return a unique fields array
+ * for legacy report & return a unique fields array
*
* @param string $entity
* @param string $action
* Returns the canonical name of a field
*
* @param $entity
- * : api entity name (string should already be standardized - no camelCase).
+ * api entity name (string should already be standardized - no camelCase).
* @param $fieldName
- * : any variation of a field's name (name, unique_name, api.alias).
+ * any variation of a field's name (name, unique_name, api.alias).
*
* @return bool|string
* fieldName or FALSE if the field does not exist
* Get a list of summary data points
*
* @return mixed; NULL or array with keys:
- * - summary: string
- * - total: numeric
+ * - summary: string
+ * - total: numeric
*/
function summary() {
return NULL;
/**
* Run a series of cron jobs and make an assertion about email deliveries
*
- * @param $cronRuns
- *
- * @internal param array $jobSchedule specifying when to run cron and what messages to expect; each item is an array with keys:
- * - time: string, e.g. '2012-06-15 21:00:01'
- * - recipients: array(array(string)), list of email addresses which should receive messages
+ * @param array $cronRuns
+ * array specifying when to run cron and what messages to expect; each item is an array with keys:
+ * - time: string, e.g. '2012-06-15 21:00:01'
+ * - recipients: array(array(string)), list of email addresses which should receive messages
*/
public function assertCronRuns($cronRuns) {
foreach ($cronRuns as $cronRun) {
}
}
- ////////////////////////////////
- ////////////////////////////////
- ////////////////////////////////
- ////////////////////////////////
-
/**
* @var array(DAO_Name => array(int)) List of items to garbage-collect during tearDown
*/
/**
* @return array
- * of CRM_Core_Permission_Base
+ * Array of CRM_Core_Permission_Base
*/
public function permissionClasses() {
$cases = array();
/**
* @param $entity
* @param $action
- * @param $params
+ * @param array $params
* @dataProvider okDataProvider
*/
public function testOk($entity, $action, $params) {
/**
* @param $entity
* @param $action
- * @param $params
+ * @param array $params
* @dataProvider badDataProvider
*/
public function testBad($entity, $action, $params, $expectedError) {
* payment processor
* @param int $id
* Id of the PayPal Pro payment processor.
- * to be deleted
+ * to be deleted
* @return boolean
* true if payment processor deleted, false otherwise
*/
/**
* @param array $cookies
- * Each item is an array with keys:.
- * - name: string
- * - value: string; note that RFC's don't define particular encoding scheme, so
+ * Each item is an Array with keys:
+ * - name: string
+ * - value: string; note that RFC's don't define particular encoding scheme, so
* you must pick one yourself and pre-encode; does not allow values with
* commas, semicolons, or whitespace
- * - path: string; default: '/'
- * - max_age: int; default: 1 week (7*24*60*60)
+ * - path: string; default: '/'
+ * - max_age: int; default: 1 week (7*24*60*60)
*/
protected function setCookies($cookies) {
foreach ($cookies as $cookie) {
* Selector.
* @param string $contactType
* @return array
- * of contact attributes (id, names, email)
+ * Array of contact attributes (id, names, email)
*/
public function createDialogContact($field = 'contact_id', $contactType = 'Individual') {
$selectId = 's2id_' . $this->getAttribute($field . '@id');
*
* @param array $customSets
* Custom sets i.e entity wise sets want to be created and checked.
- * e.g $customSets = array(array('entity' => 'Contribution', 'subEntity' => 'Donation',
+ * e.g $customSets = array(array('entity' => 'Contribution', 'subEntity' => 'Donation',
* 'triggerElement' => $triggerElement))
* array $triggerElement: the element which is responsible for custom group to load
*
}
/**
- * This function exists to wrap api functions
+ * wrap api functions
* so we can ensure they succeed & throw exceptions without litterering the test with checks
*
* @param string $entity
* @param array $params
* @param string $type
* Per http://php.net/manual/en/function.gettype.php possible types.
- * - boolean
- * - integer
- * - double
- * - string
- * - array
- * - object
+ * - boolean
+ * - integer
+ * - double
+ * - string
+ * - array
+ * - object
*
* @return array|int
*/
* @param array $params
* @param array $checkAgainst
* Array to compare result against.
- * - boolean
- * - integer
- * - double
- * - string
- * - array
- * - object
+ * - boolean
+ * - integer
+ * - double
+ * - string
+ * - array
+ * - object
*
* @throws Exception
* @return array|int
/**
* Generic function to create Organisation, to be used in test cases
*
- * @param array parameters for civicrm_contact_add api function call
- * @param int sequence number if creating multiple organizations
+ * @param array $params
+ * parameters for civicrm_contact_add api function call
+ * @param int $seq
+ * sequence number if creating multiple organizations
*
* @return int
* id of Organisation created
/**
* Generic function to create Individual, to be used in test cases
*
- * @param array parameters for civicrm_contact_add api function call
- * @param int sequence number if creating multiple individuals
+ * @param array $params
+ * parameters for civicrm_contact_add api function call
+ * @param int $seq
+ * sequence number if creating multiple individuals
*
* @return int
* id of Individual created
/**
* Generic function to create Household, to be used in test cases
*
- * @param array parameters for civicrm_contact_add api function call
- * @param int sequence number if creating multiple households
+ * @param array $params
+ * parameters for civicrm_contact_add api function call
+ * @param int $seq
+ * sequence number if creating multiple households
*
* @return int
* id of Household created
/**
* Helper function for getting sample contact properties
*
- * @param enum contact type: Individual, Organization
- * @param int sequence number for the values of this type
+ * @param string $contact_type
+ * enum contact type: Individual, Organization
+ * @param int $seq
+ * sequence number for the values of this type
*
* @return array
* properties of sample contact (ie. $params for API call)
/**
* Create Payment Processor
*
- * @return object
- * of Payment Processsor
+ * @return CRM_Financial_DAO_PaymentProcessor
+ * instance of Payment Processsor
*/
public function processorCreate() {
$processorParams = array(
* Create contribution page
*
* @param array $params
- * @return object
- * of contribution page
+ * @return array
+ * Array of contribution page
*/
public function contributionPageCreate($params) {
$this->_pageParams = array(
*
* @param int $tagId
* Id of the tag to be deleted.
+ *
+ * @return int
*/
public function tagDelete($tagId) {
require_once 'api/api.php';
* Contact_id.
* @param int $cTypeID
* Id of financial type.
- *
* @param int $invoiceID
* @param int $trxnID
* @param int $paymentInstrumentID
* @param bool $isFee
+ *
* @return int
* id of created contribution
*/
* @param array $params
* @param int $financialType
* Id of financial type.
- *
* @param int $invoiceID
* @param int $trxnID
+ *
* @return int
* id of created contribution
*/
* Add a Location Type
*
* @param array $params
- * @return CRM_Core_DAO_LocationType location id of created location
+ * @return CRM_Core_DAO_LocationType
+ * location id of created location
*/
public function locationTypeCreate($params = NULL) {
if ($params === NULL) {
*
* @param int $contributionPageId
* Id of the Contribution Page.
- * to be deleted
+ * to be deleted
* @return boolean
* true if Contribution Page deleted, false otherwise
*/
*
* @param int $contributionPageId
* Id of the Contribution Page.
- * to be deleted
+ * to be deleted
* @return array
- * of created pcp block
+ * Array of created pcp block
*/
public function create($contributionPageId) {
$profileParams = array(
* payment processor
* @param int $id
* Id of the PayPal Pro payment processor.
- * to be deleted
+ * to be deleted
* @return boolean
* true if payment processor deleted, false otherwise
*/
/**
* @return array
- * of contact details
+ * Array of contact details
*/
public function _testOfflineContribution() {
// Create a contact to be used as soft creditor
/**
* @var array
- * - contribution_page
- * - price_set
- * - price_field
- * - price_field_value
+ * - contribution_page
+ * - price_set
+ * - price_field
+ * - price_field_value
*/
protected $_ids = array();
projects / civicrm-core.git / commitdiff