* contact object. the params array could contain additional unused name/value
* pairs
*
- * @param array $params (reference ) an assoc array of name/value pairs
+ * @param array $params
+ * (reference ) an assoc array of name/value pairs.
*
* @return CRM_Contact_BAO_Contact object
* @static
*
* This function is invoked from within the web form layer and also from the api layer
*
- * @param array $params (reference ) an assoc array of name/value pairs
- * @param boolean $fixAddress if we need to fix address
- * @param boolean $invokeHooks if we need to invoke hooks
+ * @param array $params
+ * (reference ) an assoc array of name/value pairs.
+ * @param bool $fixAddress
+ * If we need to fix address.
+ * @param bool $invokeHooks
+ * If we need to invoke hooks.
*
* @param bool $skipDelete
*
/**
* Get the display name and image of a contact
*
- * @param int $id the contactId
+ * @param int $id
+ * The contactId.
*
* @param bool $type
*
}
/**
- * @param array $crudLinkSpec with keys:
+ * @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
/**
* Get the values for pseudoconstants for name->value and reverse.
*
- * @param array $defaults (reference) the default values, some of which need to be resolved.
- * @param boolean $reverse true if we want to resolve the values in the reverse direction (value -> name)
+ * @param array $defaults
+ * (reference) the default values, some of which need to be resolved.
+ * @param bool $reverse
+ * True if we want to resolve the values in the reverse direction (value -> name).
*
* @return void
* @static
/**
* Fetch object based on array of properties
*
- * @param array $params (reference ) an assoc array of name/value pairs
- * @param array $defaults (reference ) an assoc array to hold the name / value pairs
+ * @param array $params
+ * (reference ) an assoc array of name/value pairs.
+ * @param array $defaults
+ * (reference ) an assoc array to hold the name / value pairs.
* in a hierarchical manner
- * @param boolean $microformat for location in microformat
+ * @param bool $microformat
+ * For location in microformat.
*
* @return CRM_Contact_BAO_Contact object
* @static
/**
* Get the display name of a contact
*
- * @param int $id id of the contact
+ * @param int $id
+ * Id of the contact.
*
* @return null|string display name of the contact if found
* @static
/**
* Delete a contact and all its associated records
*
- * @param int $id id of the contact to delete
- * @param bool $restore whether to actually restore, not delete
- * @param bool $skipUndelete whether to force contact delete or not
+ * @param int $id
+ * Id of the contact to delete.
+ * @param bool $restore
+ * Whether to actually restore, not delete.
+ * @param bool $skipUndelete
+ * Whether to force contact delete or not.
*
* @return boolean true if contact deleted, false otherwise
* @static
/**
* Delete the image of a contact
*
- * @param int $id id of the contact
+ * @param int $id
+ * Id of the contact.
*
* @return boolean true if contact image is deleted
*/
* Return relative path
* @todo make this a method of $config->userSystem (i.e. UF classes) rather than a static function
*
- * @param string $absolutePath absolute path
+ * @param string $absolutePath
+ * Absolute path.
*
* @return String $relativePath Relative url of uploaded image
*/
/**
* Return proportional height and width of the image
*
- * @param Integer $imageWidth width of image
+ * @param Integer $imageWidth
+ * Width of image.
*
- * @param Integer $imageHeight height of image
+ * @param Integer $imageHeight
+ * Height of image.
*
* @return Array thumb dimension of image
*/
* Validate type of contact image
*
* @param array $params
- * @param String $imageIndex index of image field
- * @param String $statusMsg status message to be set after operation
- * @param string $opType type of operation like fatal, bounce etc
+ * @param String $imageIndex
+ * Index of image field.
+ * @param String $statusMsg
+ * Status message to be set after operation.
+ * @param string $opType
+ * Type of operation like fatal, bounce etc.
*
* @return boolean true if valid image extension
*/
/**
* Get contact type for a contact.
*
- * @param int $id - id of the contact whose contact type is needed
+ * @param int $id
+ * Id of the contact whose contact type is needed.
*
* @return string contact_type if $id found else null ""
*
/**
* Get contact sub type for a contact.
*
- * @param int $id - id of the contact whose contact sub type is needed
+ * @param int $id
+ * Id of the contact whose contact sub type is needed.
*
* @param null $implodeDelimiter
*
/**
* Get pair of contact-type and sub-type for a contact.
*
- * @param int $id - id of the contact whose contact sub/contact type is needed
+ * @param int $id
+ * Id of the contact whose contact sub/contact type is needed.
*
* @return array
*
* scheme. Adding weight is super important
*
* @param int|string $contactType contact Type
- * @param boolean $status status is used to manipulate first title
- * @param boolean $showAll if true returns all fields (includes disabled fields)
- * @param boolean $isProfile if its profile mode
- * @param boolean $checkPermission if false, do not include permissioning clause (for custom data)
+ * @param bool $status
+ * Status is used to manipulate first title.
+ * @param bool $showAll
+ * If true returns all fields (includes disabled fields).
+ * @param bool $isProfile
+ * If its profile mode.
+ * @param bool $checkPermission
+ * If false, do not include permissioning clause (for custom data).
*
* @param bool $withMultiCustomFields
*
* currentlty we are using importable fields as exportable fields
*
* @param int|string $contactType contact Type
- * @param boolean $status true while exporting primary contacts
- * @param boolean $export true when used during export
- * @param boolean $search true when used during search, might conflict with export param?
+ * @param bool $status
+ * True while exporting primary contacts.
+ * @param bool $export
+ * True when used during export.
+ * @param bool $search
+ * True when used during search, might conflict with export param?.
*
* @param bool $withMultiRecord
*
/**
* Get the all contact details(Hierarchical)
*
- * @param int $contactId contact id
- * @param array $fields fields array
+ * @param int $contactId
+ * Contact id.
+ * @param array $fields
+ * Fields array.
*
* @return $values array contains the contact details
* @static
* for query to use and crete the right sql
*
* @param $fields
- * @param int $contactId contact id
+ * @param int $contactId
+ * Contact id.
*
* @return array a hierarchical property tree if appropriate
* @static
/**
* Get the display name, primary email and location type of a contact
*
- * @param int $id id of the contact
+ * @param int $id
+ * Id of the contact.
*
* @return array of display_name, email if found, do_not_email or (null,null,null)
* @static
/**
* Add/edit/register contacts through profile.
*
- * @param array $params Array of profile fields to be edited/added.
- * @param array $fields Array of fields from UFGroup
- * @param int $contactID id of the contact to be edited/added.
- * @param int $addToGroupID specifies the default group to which contact is added.
- * @param int $ufGroupId uf group id (profile id)
+ * @param array $params
+ * Array of profile fields to be edited/added.
+ * @param array $fields
+ * Array of fields from UFGroup.
+ * @param int $contactID
+ * Id of the contact to be edited/added.
+ * @param int $addToGroupID
+ * Specifies the default group to which contact is added.
+ * @param int $ufGroupId
+ * Uf group id (profile id).
* @param ctype
- * @param boolean $visibility basically lets us know where this request is coming from
+ * @param bool $visibility
+ * Basically lets us know where this request is coming from.
* if via a profile from web, we restrict what groups are changed
*
* @return int contact id created/edited
* does not respect ACLs for now, which might need to be rectified at some
* stage based on how its used
*
- * @param string $mail primary email address of the contact
- * @param string $ctype contact type
+ * @param string $mail
+ * Primary email address of the contact.
+ * @param string $ctype
+ * Contact type.
*
* @return object $dao contact details
* @static
/**
* Find the contact details associated with an OpenID
*
- * @param string $openId openId of the contact
- * @param string $ctype contact type
+ * @param string $openId
+ * OpenId of the contact.
+ * @param string $ctype
+ * Contact type.
*
* @return object $dao contact details
* @static
/**
* Funtion to get primary email of the contact
*
- * @param int $contactID contact id
+ * @param int $contactID
+ * Contact id.
*
* @return string $dao->email email address if present else null
* @static
/**
* Funtion to get primary OpenID of the contact
*
- * @param int $contactID contact id
+ * @param int $contactID
+ * Contact id.
*
* @return string $dao->openid OpenID if present else null
* @static
* Given the list of params in the params array, fetch the object
* and store the values in the values array
*
- * @param array $params input parameters to find object
- * @param array $values output values of the object
+ * @param array $params
+ * Input parameters to find object.
+ * @param array $values
+ * Output values of the object.
*
* @return CRM_Contact_BAO_Contact|null the found object or null
* @static
* Given the component name and returns
* the count of participation of contact
*
- * @param string $component input component name
- * @param integer $contactId input contact id
- * @param string $tableName optional tableName if component is custom group
+ * @param string $component
+ * Input component name.
+ * @param int $contactId
+ * Input contact id.
+ * @param string $tableName
+ * Optional tableName if component is custom group.
*
* @return total number of count of occurence in database
* @static
/**
* Process greetings and cache
*
- * @param object $contact contact object after save
- * @param boolean $useDefaults use default greeting values
+ * @param object $contact
+ * Contact object after save.
+ * @param bool $useDefaults
+ * Use default greeting values.
*
* @return void
* @static
/**
* Retrieve loc block ids w/ given condition.
*
- * @param int $contactId contact id.
- * @param array $criteria key => value pair which should be
+ * @param int $contactId
+ * Contact id.
+ * @param array $criteria
+ * Key => value pair which should be.
* fulfill by return record ids.
- * @param string $condOperator operator use for grouping multiple conditions.
+ * @param string $condOperator
+ * Operator use for grouping multiple conditions.
*
* @return array $locBlockIds loc block ids which fulfill condition.
* @static
* Retrieve display name of contact that address is shared
* based on $masterAddressId or $contactId .
*
- * @param int $masterAddressId master id.
- * @param int $contactId contact id.
+ * @param int $masterAddressId
+ * Master id.
+ * @param int $contactId
+ * Contact id.
*
* @return display name |null the found display name or null.
* @static
* Check if contact is being used in civicrm_domain
* based on $contactId
*
- * @param int $contactId contact id.
+ * @param int $contactId
+ * Contact id.
*
* @return bool true if present else false.
* @static
* TODO: Should we always assume chainselect? What fn should be responsible for controlling that flow?
* TODO: In context of chainselect, what to return if e.g. a country has no states?
*
- * @param String $fieldName
- * @param String $context : @see CRM_Core_DAO::buildOptionsContext
- * @param Array $props : whatever is known about this dao object
+ * @param string $fieldName
+ * @param string $context
+ * : @see CRM_Core_DAO::buildOptionsContext.
+ * @param array $props
+ * : whatever is known about this dao object.
*
* @return Array|bool
*/
/**
* Get the display name, primary email, location type and location id of a contact
*
- * @param int $id id of the contact
+ * @param int $id
+ * Id of the contact.
*
* @param bool $isPrimary
* @param int $locationTypeID
/**
* Get the sms number and display name of a contact
*
- * @param int $id id of the contact
+ * @param int $id
+ * Id of the contact.
*
* @param null $type
*
/**
* Get the information to map a contact
*
- * @param array $ids the list of ids for which we want map info
+ * @param array $ids
+ * The list of ids for which we want map info.
* $param int $locationTypeID
*
* @param int $locationTypeID
/**
* Check if the logged in user has permissions for the operation type
*
- * @param int $id contact id
+ * @param int $id
+ * Contact id.
* @param int|string $type the type of operation (view|edit)
*
* @return boolean true if the user has permission, false otherwise
*
* @param int $userID
* @param int|string $type the type of operation (view|edit)
- * @param boolean $force should we force a recompute
+ * @param bool $force
+ * Should we force a recompute.
*
* @return void
* @static
* Check if there are any contacts in cache table
*
* @param int|string $type the type of operation (view|edit)
- * @param int $contactID contact id
+ * @param int $contactID
+ * Contact id.
*
* @return boolean
* @static
/**
* Get the permission base on its relationship
*
- * @param int $selectedContactID contact id of selected contact
- * @param int $contactID contact id of the current contact
+ * @param int $selectedContactID
+ * Contact id of selected contact.
+ * @param int $contactID
+ * Contact id of the current contact.
*
* @return bool true if logged in user has permission to view
* selected contact record else false
/**
* Given a contact type, get the contact image
*
- * @param string $contactType contact type
- * @param boolean $urlOnly if we need to return only image url
- * @param int $contactId contact id
- * @param boolean $addProfileOverlay if profile overlay class should be added
+ * @param string $contactType
+ * Contact type.
+ * @param bool $urlOnly
+ * If we need to return only image url.
+ * @param int $contactId
+ * Contact id.
+ * @param bool $addProfileOverlay
+ * If profile overlay class should be added.
*
* @return string
* @static
/**
* Function check for mix contact ids(individual+household etc...)
*
- * @param array $contactIds array of contact ids
+ * @param array $contactIds
+ * Array of contact ids.
*
* @return boolen true or false true if mix contact array else fale
*
* Generate a checksum for a $entityId of type $entityType
*
* @param int $entityId
- * @param int $ts timestamp that checksum was generated
- * @param int $live life of this checksum in hours/ 'inf' for infinite
- * @param string $hash contact hash, if sent, prevents a query in inner loop
+ * @param int $ts
+ * Timestamp that checksum was generated.
+ * @param int $live
+ * Life of this checksum in hours/ 'inf' for infinite.
+ * @param string $hash
+ * Contact hash, if sent, prevents a query in inner loop.
*
* @param string $entityType
* @param null $hashSize
/**
* Make sure the checksum is valid for the passed in contactID
*
- * @param int $contactID
- * @param string $inputCheck checksum to match against
+ * @param int $contactID
+ * @param string $inputCheck
+ * Checksum to match against.
*
* @return boolean true if valid, else false
* @static
/**
* Get the count of contact loctions
*
- * @param int $contactId contact id
+ * @param int $contactId
+ * Contact id.
*
* @return int $locationCount max locations for the contact
* @static
/**
* Create Current employer relationship for a individual
*
- * @param int $contactID contact id of the individual
- * @param $organization (id or name)
+ * @param int $contactID
+ * Contact id of the individual.
+ * @param $organization
+ * (id or name).
* @param int $previousEmployerID
* @param bool $newContact
*
/**
* Create related memberships for current employer
*
- * @param int $contactID contact id of the individual
- * @param int $employerID contact id of the organization.
- * @param array $relationshipParams relationship params.
- * @param boolean $duplicate are we triggered existing relationship.
+ * @param int $contactID
+ * Contact id of the individual.
+ * @param int $employerID
+ * Contact id of the organization.
+ * @param array $relationshipParams
+ * Relationship params.
+ * @param bool $duplicate
+ * Are we triggered existing relationship.
*
* @param int $previousEmpID
*
/**
* Set current employer id and organization name
*
- * @param array $currentEmployerParams associated array of contact id and its employer id
+ * @param array $currentEmployerParams
+ * Associated array of contact id and its employer id.
*
*/
public static function setCurrentEmployer($currentEmployerParams) {
/**
* Update cached current employer name
*
- * @param int $organizationId current employer id
+ * @param int $organizationId
+ * Current employer id.
*
*/
public static function updateCurrentEmployer($organizationId) {
/**
* Clear cached current employer name
*
- * @param int $contactId contact id ( mostly individual contact id)
- * @param int $employerId contact id ( mostly organization contact id)
+ * @param int $contactId
+ * Contact id ( mostly individual contact id).
+ * @param int $employerId
+ * Contact id ( mostly organization contact id).
*
*/
public static function clearCurrentEmployer($contactId, $employerId = NULL) {
* Build form for related contacts / on behalf of organization.
*
* @param CRM_Core_Form $form
- * @param $contactType string contact type
+ * @param $contactType
+ * String contact type.
* @param int $countryID
* @param int $stateID
- * @param $title string fieldset title
+ * @param $title
+ * String fieldset title.
*
* @static
*/
* Clear cache employer name and employer id
* of all employee when employer get deleted.
*
- * @param int $employerId contact id of employer ( organization id )
+ * @param int $employerId
+ * Contact id of employer ( organization id ).
*
*/
public static function clearAllEmployee($employerId) {
/**
* Given an array of contact ids this function will return array with links to view contact page
*
- * @param array $contactIDs associated contact id's
+ * @param array $contactIDs
+ * Associated contact id's.
* @param bool $addViewLink
* @param bool $addEditLink
- * @param int $originalId associated with the contact which is edited
+ * @param int $originalId
+ * Associated with the contact which is edited.
*
*
* @return array $contactViewLinks returns array with links to contact view
/**
* This function retrieve component related contact information.
*
- * @param array $componentIds array of component Ids.
+ * @param array $componentIds
+ * Array of component Ids.
* @param string $componentName
- * @param array $returnProperties array of return elements.
+ * @param array $returnProperties
+ * Array of return elements.
*
* @return array $contactDetails array of contact info.@static
*/
* has same address as shared contact address. We copy the address so that search etc will be
* much efficient.
*
- * @param array $address this is associated array which contains submitted form values
+ * @param array $address
+ * This is associated array which contains submitted form values.
*
* @return void
* @static
/**
* Get the list of contact name give address associated array
*
- * @param array $addresses associated array of
+ * @param array $addresses
+ * Associated array of.
*
* @return array $contactNames associated array of contact names@static
*/
* caches, but are backing off from this with every release. Compromise between ease of coding versus
* performance versus being accurate at that very instant
*
- * @param $contactID - the contactID that was edited / deleted
+ * @param $contactID
+ * The contactID that was edited / deleted.
*
* @return void
* @static
/**
* Fetch the default greeting for a given contact type
*
- * @param string $contactType contact type
- * @param string $greetingType greeting type
+ * @param string $contactType
+ * Contact type.
+ * @param string $greetingType
+ * Greeting type.
*
* @return int or null
*/
* by the token substitution mechanism,
* before Smarty is invoked.
*
- * @param string $templateString the greeting template string with contact tokens + Smarty syntax
+ * @param string $templateString
+ * The greeting template string with contact tokens + Smarty syntax.
*
* @param $contactDetails
* @param int $contactID
/**
* Fetch object based on array of properties
*
- * @param array $params (reference ) an assoc array of name/value pairs
- * @param array $defaults (reference ) an assoc array to hold the flattened values
+ * @param array $params
+ * (reference ) an assoc array of name/value pairs.
+ * @param array $defaults
+ * (reference ) an assoc array to hold the flattened values.
*
* @return CRM_Contact_BAO_ContactType object on success, null otherwise
* @static
/**
* Retrieve all subtypes Information.
*
- * @param array $contactType .
+ * @param array $contactType
+ * ..
* @param bool $all
* @param bool $ignoreCache
* @param bool $reset
*
* retrieve all subtypes
*
- * @param array $contactType .
+ * @param array $contactType
+ * ..
* @param bool $all
* @param string $columnName
* @param bool $ignoreCache
*
* retrieve subtype pairs with name as 'subtype-name' and 'label' as value
*
- * @param array $contactType .
+ * @param array $contactType
+ * ..
* @param bool $all
* @param string $labelPrefix
* @param bool $ignoreCache
/**
* Check if a given type is a subtype
*
- * @param string $subType contact subType.
+ * @param string $subType
+ * Contact subType.
* @param bool $ignoreCache
*
* @return boolean true if subType, false otherwise.
/**
* Suppress all subtypes present in given array.
*
- * @param array $subTypes contact subTypes
+ * @param array $subTypes
+ * Contact subTypes.
* @param bool $ignoreCache
*
* @return array of suppressed subTypes.
/**
* Verify if a given subtype is associated with a given basic contact type.
*
- * @param string $subType contact subType
- * @param string $contactType contact Type
+ * @param string $subType
+ * Contact subType.
+ * @param string $contactType
+ * Contact Type.
* @param bool $ignoreCache
* @param string $columnName
*
/**
* Delete Contact SubTypes
*
- * @param int $contactTypeId ID of the Contact Subtype to be deleted.
+ * @param int $contactTypeId
+ * ID of the Contact Subtype to be deleted.
*
* @return bool
* @static
/**
* Add or update Contact SubTypes
*
- * @param array $params an assoc array of name/value pairs
+ * @param array $params
+ * An assoc array of name/value pairs.
*
* @return object
* @static
/**
* Update the is_active flag in the db
*
- * @param int $id id of the database record
- * @param boolean $is_active value we want to set the is_active field
+ * @param int $id
+ * Id of the database record.
+ * @param bool $is_active
+ * Value we want to set the is_active field.
*
* @return Object DAO object on success, null otherwise
* @static
* on the basis of custom data and relationship of specific subtype
* currently used in contact/edit form amd in import validation
*
- * @param int $contactId contact id.
- * @param string $subType subtype.
+ * @param int $contactId
+ * Contact id.
+ * @param string $subType
+ * Subtype.
*
* @return boolean true/false.
* @static
* This function currently works for contact subtypes only and could be later improved / genralized
* to work for other subtypes as well.
*
- * @param int $gID - custom group id.
- * @param array $subtypes - list of subtypes related to which entry is to be removed.
+ * @param int $gID
+ * Custom group id.
+ * @param array $subtypes
+ * List of subtypes related to which entry is to be removed.
*
* @return void
*/
/**
* Delete content / rows of a custom table specific entity-id for a given custom-group table.
*
- * @param int $customTable - custom table name.
- * @param int $entityID - entity id.
+ * @param int $customTable
+ * Custom table name.
+ * @param int $entityID
+ * Entity id.
*
* @return void
*/
* of time. This is the inverse function of create. It also stores all the retrieved
* values in the default array
*
- * @param array $params (reference ) an assoc array of name/value pairs
- * @param array $defaults (reference ) an assoc array to hold the flattened values
+ * @param array $params
+ * (reference ) an assoc array of name/value pairs.
+ * @param array $defaults
+ * (reference ) an assoc array to hold the flattened values.
*
* @return CRM_Contact_BAO_Group object
* @static
* Delete the group and all the object that connect to
* this group. Incredibly destructive
*
- * @param int $id group id
+ * @param int $id
+ * Group id.
*
* @return null
* @static
/**
* Get the count of a members in a group with the specific status
*
- * @param int $id group id
+ * @param int $id
+ * Group id.
* @param enum|string $status status of members in group
*
* @param bool $countChildGroups
/**
* Returns array of group object(s) matching a set of one or Group properties.
*
- * @param array $params Limits the set of groups returned.
- * @param array $returnProperties Which properties should be included in the returned group objects.
+ * @param array $params
+ * Limits the set of groups returned.
+ * @param array $returnProperties
+ * Which properties should be included in the returned group objects.
* (member_count should be last element.)
*
* @param null $sort
/**
* Make sure that the user has permission to access this group
*
- * @param int $id the id of the object
+ * @param int $id
+ * The id of the object.
*
* @return string the permission that the user has (or null)
* @static
/**
* Create a new group
*
- * @param array $params Associative array of parameters
+ * @param array $params
+ * Associative array of parameters.
*
* @return object|null The new group BAO (if created)
* @static
/**
* Defines a new smart group
*
- * @param array $params Associative array of parameters
+ * @param array $params
+ * Associative array of parameters.
*
* @return object|null The new group BAO (if created)
* @static
/**
* Update the is_active flag in the db
*
- * @param int $id id of the database record
- * @param boolean $isActive value we want to set the is_active field
+ * @param int $id
+ * Id of the database record.
+ * @param bool $isActive
+ * Value we want to set the is_active field.
*
* @return Object DAO object on sucess, null otherwise
* @static
/**
* Build the condition to retrieve groups.
*
- * @param string $groupType type of group(Access/Mailing) OR the key of the group
+ * @param string $groupType
+ * Type of group(Access/Mailing) OR the key of the group.
* @param bool|\boolen $excludeHidden exclude hidden groups.
*
* @return string $condition
* This function create the hidden smart group when user perform
* contact seach and want to send mailing to search contacts.
*
- * @param array $params ( reference ) an assoc array of name/value pairs
+ * @param array $params
+ * ( reference ) an assoc array of name/value pairs.
*
* @return array ( smartGroupId, ssId ) smart group id and saved search id
* @static
/**
* This function is a wrapper for ajax group selector
*
- * @param array $params associated array for params record id.
+ * @param array $params
+ * Associated array for params record id.
*
* @return array $groupList associated array of group list
* -rp = rowcount
/**
* This function to get list of groups
*
- * @param array $params associated array for params
+ * @param array $params
+ * Associated array for params.
*
* @return array
*/
/**
* This function to get hierarchical list of groups (parent followed by children)
*
- * @param array $groupIDs array of group ids
+ * @param array $groupIDs
+ * Array of group ids.
*
* @param null $parents
* @param string $spacer
* group object. the params array could contain additional unused name/value
* pairs
*
- * @param array $params (reference ) an assoc array of name/value pairs
+ * @param array $params
+ * (reference ) an assoc array of name/value pairs.
*
* @return CRM_Contact_BAO_Group object
* @static
/**
* Check if there is data to create the object
*
- * @param array $params (reference ) an assoc array of name/value pairs
+ * @param array $params
+ * (reference ) an assoc array of name/value pairs.
*
* @return boolean
* @static
* Given the list of params in the params array, fetch the object
* and store the values in the values array
*
- * @param array $params input parameters to find object
- * @param array $values output values of the object
+ * @param array $params
+ * Input parameters to find object.
+ * @param array $values
+ * Output values of the object.
*
* @return array (reference) the values that could be potentially assigned to smarty
* @static
/**
* Given an array of contact ids, add all the contacts to the group
*
- * @param array $contactIds the array of contact ids to be added
- * @param int $groupId the id of the group
+ * @param array $contactIds
+ * The array of contact ids to be added.
+ * @param int $groupId
+ * The id of the group.
* @param string $method
* @param string $status
* @param int $tracking
/**
* Given an array of contact ids, remove all the contacts from the group
*
- * @param array $contactIds (reference ) the array of contact ids to be removed
- * @param int $groupId the id of the group
+ * @param array $contactIds
+ * (reference ) the array of contact ids to be removed.
+ * @param int $groupId
+ * The id of the group.
*
* @param string $method
* @param string $status
/**
* Get list of all the groups and groups for a contact
*
- * @param int $contactId contact id
+ * @param int $contactId
+ * Contact id.
*
* @param bool $visibility
*
/**
* Get the list of groups for contact based on status of group membership
*
- * @param int $contactId contact id
- * @param string $status state of membership
- * @param int $numGroupContact number of groups for a contact that should be shown
- * @param boolean $count true if we are interested only in the count
- * @param boolean $ignorePermission true if we should ignore permissions for the current user
+ * @param int $contactId
+ * Contact id.
+ * @param string $status
+ * State of membership.
+ * @param int $numGroupContact
+ * Number of groups for a contact that should be shown.
+ * @param bool $count
+ * True if we are interested only in the count.
+ * @param bool $ignorePermission
+ * True if we should ignore permissions for the current user.
* useful in profile where permissions are limited for the user. If left
* at false only groups viewable by the current user are returned
- * @param boolean $onlyPublicGroups true if we want to hide system groups
+ * @param bool $onlyPublicGroups
+ * True if we want to hide system groups.
*
* @param bool $excludeHidden
*
/**
* Returns membership details of a contact for a group
*
- * @param int $contactId id of the contact
- * @param int $groupID Id of a perticuler group
- * @param string $method If we want the subscription history details for a specific method
+ * @param int $contactId
+ * Id of the contact.
+ * @param int $groupID
+ * Id of a perticuler group.
+ * @param string $method
+ * If we want the subscription history details for a specific method.
*
* @return object of group contact
* @static
/**
* Method to get Group Id
*
- * @param int $groupContactID Id of a perticuler group
+ * @param int $groupContactID
+ * Id of a perticuler group.
*
*
* @return groupID
* contacts from the groups
*
*
- * @param array $params (reference ) an assoc array of name/value pairs
- * @param array $contactId contact id
+ * @param array $params
+ * (reference ) an assoc array of name/value pairs.
+ * @param array $contactId
+ * Contact id.
*
* @param bool $visibility
* @param string $method
* Function merges the groups from otherContactID to mainContactID
* along with subscription history
*
- * @param int $mainContactId contact id of main contact record.
- * @param int $otherContactId contact id of record which is going to merge.
+ * @param int $mainContactId
+ * Contact id of main contact record.
+ * @param int $otherContactId
+ * Contact id of record which is going to merge.
*
* @see CRM_Dedupe_Merger::cpTables()
*
/**
* Given an array of contact ids, add all the contacts to the group
*
- * @param array $contactIDs the array of contact ids to be added
- * @param int $groupID the id of the group
+ * @param array $contactIDs
+ * The array of contact ids to be added.
+ * @param int $groupID
+ * The id of the group.
* @param string $method
* @param string $status
* @param null $tracking
* Get options for a given field.
* @see CRM_Core_DAO::buildOptions
*
- * @param String $fieldName
- * @param String $context : @see CRM_Core_DAO::buildOptionsContext
- * @param Array $props : whatever is known about this dao object
+ * @param string $fieldName
+ * @param string $context
+ * : @see CRM_Core_DAO::buildOptionsContext.
+ * @param array $props
+ * : whatever is known about this dao object.
*
* @return Array|bool
*/
* Check to see if we have cache entries for this group
* if not, regenerate, else return
*
- * @param $groupIDs of group that we are checking against
+ * @param $groupIDs
+ * Of group that we are checking against.
*
* @return boolean true if we did not regenerate, false if we did
*/
* Common function that formulates the query to see which groups needs to be refreshed
* based on their cache date and the smartGroupCacheTimeOut
*
- * @param string $groupIDClause the clause which limits which groups we need to evaluate
- * @param boolean $includeHiddenGroups hidden groups are excluded by default
+ * @param string $groupIDClause
+ * The clause which limits which groups we need to evaluate.
+ * @param bool $includeHiddenGroups
+ * Hidden groups are excluded by default.
*
* @return string the sql query which lists the groups that need to be refreshed
* @static
* in a locking scenario when some other process might have refreshed things underneath
* this process
*
- * @param int $groupID the group ID
- * @param boolean $includeHiddenGroups hidden groups are excluded by default
+ * @param int $groupID
+ * The group ID.
+ * @param bool $includeHiddenGroups
+ * Hidden groups are excluded by default.
*
* @return string the sql query which lists the groups that need to be refreshed
* @static
*
* @param int/array $groupID groupID of group that we are checking against
* if empty, all groups are checked
- * @param int $limit limits the number of groups we evaluate
+ * @param int $limit
+ * Limits the number of groups we evaluate.
*
* @return boolean true if we did not regenerate, false if we did
*/
/**
* Change the cache_date
*
- * @param $groupID array(int)
- * @param $processed bool, whether the cache data was recently modified
+ * @param $groupID
+ * Array(int).
+ * @param $processed
+ * Bool, whether the cache data was recently modified.
*/
public static function updateCacheTime($groupID, $processed) {
// only update cache entry if we had any values
* cache date, i.e. the removal is not done if the group was recently
* loaded into the cache.
*
- * @param $groupID int the groupID to delete cache entries, NULL for all groups
- * @param $onceOnly boolean run the function exactly once for all groups.
+ * @param $groupID
+ * Int the groupID to delete cache entries, NULL for all groups.
+ * @param $onceOnly
+ * Boolean run the function exactly once for all groups.
*
* @return void
* @static
/**
* Load the smart group cache for a saved search
*
- * @param object $group - the smart group that needs to be loaded
- * @param boolean $force - should we force a search through
+ * @param object $group
+ * The smart group that needs to be loaded.
+ * @param bool $force
+ * Should we force a search through.
*
*/
public static function load(&$group, $force = FALSE) {
* Note that this could potentially be a super slow function since
* it ensure that all contact groups are loaded in the cache
*
- * @param int $contactID
- * @param boolean $showHidden - hidden groups are shown only if this flag is set
+ * @param int $contactID
+ * @param bool $showHidden
+ * Hidden groups are shown only if this flag is set.
*
* @return array an array of groups that this contact belongs to
*/
* Adds a new child group identified by $childGroupId to the group
* identified by $groupId
*
- * @param int $parentID id of the group to add the child to
- * @param int $childID id of the new child group
+ * @param int $parentID
+ * Id of the group to add the child to.
+ * @param int $childID
+ * Id of the new child group.
*
*
* @return void
* identified by $groupId; does not delete child group, just the
* association between the two
*
- * @param $parentID The id of the group to remove the child from
- * @param $childID The id of the child group being removed
+ * @param $parentID
+ * The id of the group to remove the child from.
+ * @param $childID
+ * The id of the child group being removed.
*
* @return void
*
* identified by $groupId; does not delete child group, just the
* association between the two
*
- * @param int $childID The id of the child group being removed
+ * @param int $childID
+ * The id of the child group being removed.
*
* @return void
*
* Returns true if the association between parent and child is present,
* false otherwise.
*
- * @param $parentID The parent id of the association
- * @param $childID The child id of the association
+ * @param $parentID
+ * The parent id of the association.
+ * @param $childID
+ * The child id of the association.
*
* @return boolean True if association is found, false otherwise.
*
* Returns true if if the given groupId has 1 or more child groups,
* false otherwise.
*
- * @param $groupId The id of the group to check for child groups
+ * @param $groupId
+ * The id of the group to check for child groups.
*
* @return boolean True if 1 or more child groups are found, false otherwise.
*
* Returns true if the given groupId has 1 or more parent groups,
* false otherwise.
*
- * @param $groupId The id of the group to check for parent groups
+ * @param $groupId
+ * The id of the group to check for parent groups.
*
* @return boolean True if 1 or more parent groups are found, false otherwise.
*
* Returns true if checkGroupId is a parent of one of the groups in
* groupIds, false otherwise.
*
- * @param $groupIds Array of group ids (or one group id) to serve as the starting point
- * @param $checkGroupId The group id to check if it is a parent of the $groupIds group(s)
+ * @param $groupIds
+ * Array of group ids (or one group id) to serve as the starting point.
+ * @param $checkGroupId
+ * The group id to check if it is a parent of the $groupIds group(s).
*
* @return boolean True if $checkGroupId points to a group that is a parent of one of the $groupIds groups, false otherwise.
*
* Returns true if checkGroupId is a child of one of the groups in
* groupIds, false otherwise.
*
- * @param $groupIds Array of group ids (or one group id) to serve as the starting point
- * @param $checkGroupId The group id to check if it is a child of the $groupIds group(s)
+ * @param $groupIds
+ * Array of group ids (or one group id) to serve as the starting point.
+ * @param $checkGroupId
+ * The group id to check if it is a child of the $groupIds group(s).
*
* @return boolean True if $checkGroupId points to a group that is a child of one of the $groupIds groups, false otherwise.
*
* Returns true if checkGroupId is an ancestor of one of the groups in
* groupIds, false otherwise.
*
- * @param $groupIds Array of group ids (or one group id) to serve as the starting point
- * @param $checkGroupId The group id to check if it is an ancestor of the $groupIds group(s)
+ * @param $groupIds
+ * Array of group ids (or one group id) to serve as the starting point.
+ * @param $checkGroupId
+ * The group id to check if it is an ancestor of the $groupIds group(s).
*
* @return boolean True if $checkGroupId points to a group that is an ancestor of one of the $groupIds groups, false otherwise.
*
* Returns true if checkGroupId is a descendent of one of the groups in
* groupIds, false otherwise.
*
- * @param $groupIds Array of group ids (or one group id) to serve as the starting point
- * @param $checkGroupId The group id to check if it is a descendent of the $groupIds group(s)
+ * @param $groupIds
+ * Array of group ids (or one group id) to serve as the starting point.
+ * @param $checkGroupId
+ * The group id to check if it is a descendent of the $groupIds group(s).
*
* @return boolean True if $checkGroupId points to a group that is a descendent of one of the $groupIds groups, false otherwise.
*
/**
* Returns array of group ids of ancestor groups of the specified group.
*
- * @param $groupIds An array of valid group ids (passed by reference)
+ * @param $groupIds
+ * An array of valid group ids (passed by reference).
*
* @param bool $includeSelf
*
/**
* Returns array of ancestor groups of the specified group.
*
- * @param $groupIds An array of valid group ids (passed by reference)
+ * @param $groupIds
+ * An array of valid group ids (passed by reference).
*
* @param bool $includeSelf
* @return \An $groupArray List of ancestor groups@access public
/**
* Returns array of group ids of child groups of the specified group.
*
- * @param $groupIds An array of valid group ids (passed by reference)
+ * @param $groupIds
+ * An array of valid group ids (passed by reference).
*
* @return array $groupIdArray List of groupIds that represent the requested group and its children@access public
*/
/**
* Returns array of group ids of parent groups of the specified group.
*
- * @param $groupIds An array of valid group ids (passed by reference)
+ * @param $groupIds
+ * An array of valid group ids (passed by reference).
*
* @return array $groupIdArray List of groupIds that represent the requested group and its parents@access public
*/
/**
* Returns array of group ids of descendent groups of the specified group.
*
- * @param $groupIds An array of valid group ids (passed by reference)
+ * @param $groupIds
+ * An array of valid group ids (passed by reference).
*
* @param bool $includeSelf
* @return array $groupIdArray List of groupIds that represent the requested group and its descendents@access public
/**
* Returns array of descendent groups of the specified group.
*
- * @param $groupIds An array of valid group ids (passed by reference)
+ * @param $groupIds
+ * An array of valid group ids (passed by reference).
*
* @param bool $includeSelf
* @return \An $groupArray List of descendent groups@access public
/**
* Returns array of group ids of valid potential child groups of the specified group.
*
- * @param $groupId The group id to get valid potential children for
+ * @param $groupId
+ * The group id to get valid potential children for.
*
* @return array $groupIdArray List of groupIds that represent the valid potential children of the group@access public
*/
/**
* Takes an associative array and creates a groupOrganization object
*
- * @param array $params (reference ) an assoc array of name/value pairs
+ * @param array $params
+ * (reference ) an assoc array of name/value pairs.
*
* @return CRM_Contact_DAO_GroupOrganization
* @static
/**
* Format the params
*
- * @param array $params (reference ) an assoc array of name/value pairs
- * @param array $formatedValues (reference ) an assoc array of name/value pairs
+ * @param array $params
+ * (reference ) an assoc array of name/value pairs.
+ * @param array $formatedValues
+ * (reference ) an assoc array of name/value pairs.
*
* @return void
* @static
/**
* Check if there is data to create the object
*
- * @param array $params (reference ) an assoc array of name/value pairs
+ * @param array $params
+ * (reference ) an assoc array of name/value pairs.
*
* @return boolean
* @static
/**
* Delete Group Organization
*
- * @param int $groupOrganizationID group organization id that needs to be deleted
+ * @param int $groupOrganizationID
+ * Group organization id that needs to be deleted.
*
* @return mixed|null $results no of deleted group organization on success, false otherwise@access public
*/
/**
* Update the household with primary contact id
*
- * @param integer $primaryContactId null if deleting primary contact
- * @param integer $contactId contact id
+ * @param int $primaryContactId
+ * Null if deleting primary contact.
+ * @param int $contactId
+ * Contact id.
*
* @return Object DAO object on success
* @static
/**
* Function is used to format the individual contact values
*
- * @param array $params (reference ) an assoc array of name/value pairs
- * @param array $contact contact object
+ * @param array $params
+ * (reference ) an assoc array of name/value pairs.
+ * @param array $contact
+ * Contact object.
*
* @return CRM_Contact_BAO_Contact object
* @static
/**
* Regenerates display_name for contacts with given prefixes/suffixes
*
- * @param array $ids the array with the prefix/suffix id governing which contacts to regenerate
- * @param int $action the action describing whether prefix/suffix was UPDATED or DELETED
+ * @param array $ids
+ * The array with the prefix/suffix id governing which contacts to regenerate.
+ * @param int $action
+ * The action describing whether prefix/suffix was UPDATED or DELETED.
*
* @return void
*/
/**
* Check if there is data to create the object
*
- * @param array $params (reference ) an assoc array of name/value pairs
+ * @param array $params
+ * (reference ) an assoc array of name/value pairs.
*
* @return boolean
* @static
* @param array $params
* @param array $returnProperties
* @param array $fields
- * @param boolean $includeContactIds
- * @param boolean $strict
+ * @param bool $includeContactIds
+ * @param bool $strict
* @param bool|int $mode - mode the search is operating on
*
* @param bool $skipPermission
/**
* Generate the query based on what type of query we need
*
- * @param boolean $count
- * @param boolean $sortByChar
- * @param boolean $groupContacts
- * @param boolean $onlyDeleted
+ * @param bool $count
+ * @param bool $sortByChar
+ * @param bool $groupContacts
+ * @param bool $onlyDeleted
*
* @return array sql query parts as an array
*/
* @param array $fields
* @param array $tables
* @param $whereTables
- * @param boolean $strict
+ * @param bool $strict
*
* @return string
* @static
/**
* Create the from clause
*
- * @param array $tables tables that need to be included in this from clause
+ * @param array $tables
+ * Tables that need to be included in this from clause.
* if null, return mimimal from clause (i.e. civicrm_contact)
- * @param array $inner tables that should be inner-joined
- * @param array $right tables that should be right-joined
+ * @param array $inner
+ * Tables that should be inner-joined.
+ * @param array $right
+ * Tables that should be right-joined.
*
* @param bool $primaryLocation
* @param int $mode
}
/**
- * @param array $groups
+ * @param array $groups
* @param string $tableAlias
* @param string $joinTable
*
/**
* Add start & end date criteria in
* @param string $grouping
- * @param array $where = array to add where clauses to, in case you are generating a temp table
+ * @param array $where
+ * = array to add where clauses to, in case you are generating a temp table.
* not the main query.
*/
public function addRelationshipDateClauses($grouping, &$where){
* @param string $sort
* @param int $offset
* @param int $row_count
- * @param bool $smartGroupCache ?? update smart group cache?
- * @param bool $count return count obnly
- * @param bool $skipPermissions Should permissions be ignored or should the logged in user's permissions be applied
+ * @param bool $smartGroupCache
+ * ?? update smart group cache?.
+ * @param bool $count
+ * Return count obnly.
+ * @param bool $skipPermissions
+ * Should permissions be ignored or should the logged in user's permissions be applied.
*
*
* @return array
/**
* Create and query the db for an contact search
*
- * @param int $offset the offset for the query
- * @param int $rowCount the number of rows to return
- * @param string $sort the order by string
- * @param boolean $count is this a count only query ?
- * @param boolean $includeContactIds should we include contact ids?
- * @param boolean $sortByChar if true returns the distinct array of first characters for search results
- * @param boolean $groupContacts if true, return only the contact ids
- * @param boolean $returnQuery should we return the query as a string
- * @param string $additionalWhereClause if the caller wants to further restrict the search (used for components)
+ * @param int $offset
+ * The offset for the query.
+ * @param int $rowCount
+ * The number of rows to return.
+ * @param string $sort
+ * The order by string.
+ * @param bool $count
+ * Is this a count only query ?.
+ * @param bool $includeContactIds
+ * Should we include contact ids?.
+ * @param bool $sortByChar
+ * If true returns the distinct array of first characters for search results.
+ * @param bool $groupContacts
+ * If true, return only the contact ids.
+ * @param bool $returnQuery
+ * Should we return the query as a string.
+ * @param string $additionalWhereClause
+ * If the caller wants to further restrict the search (used for components).
* @param null $sortOrder
- * @param string $additionalFromClause should be clause with proper joins, effective to reduce where clause load.
+ * @param string $additionalFromClause
+ * Should be clause with proper joins, effective to reduce where clause load.
*
* @param bool $skipOrderAndLimit
*
* Fetch a list of contacts from the prev/next cache for displaying a search results page
*
* @param string $cacheKey
- * @param int $offset
- * @param int $rowCount
- * @param bool $includeContactIds
+ * @param int $offset
+ * @param int $rowCount
+ * @param bool $includeContactIds
* @return CRM_Core_DAO
*/
public function getCachedContacts($cacheKey, $offset, $rowCount, $includeContactIds) {
* Note that these 2 params were in the code when extracted from another function
* and a second round extraction would be to make them properties of the class
*
- * @param bool $onlyDeleted Only get deleted contacts
- * @param bool $count Return Count only
+ * @param bool $onlyDeleted
+ * Only get deleted contacts.
+ * @param bool $count
+ * Return Count only.
*
* @return null
*/
* builds the where Clause for the query
* used for handling 'IS NULL'/'IS NOT NULL' operators
*
- * @param string $field fieldname
- * @param string $op operator
- * @param string $value value
- * @param string $dataType data type of the field
+ * @param string $field
+ * Fieldname.
+ * @param string $op
+ * Operator.
+ * @param string $value
+ * Value.
+ * @param string $dataType
+ * Data type of the field.
*
* @return string where clause for the query
*/
/**
* Builds the necessary structures for all fields that are similar to option value lookups
*
- * @param $name string the name of the field
- * @param $op string the sql operator, this function should handle ALL SQL operators
- * @param $value string|integer|array depends on the operator and who's calling the query builder
- * @param $grouping int the index where to place the where clause
- * @param $selectValues the key value pairs for this element. This allows us to use this function for things besides option-value pairs
- * @param $field array an array that contains various properties of the field identified by $name
- * @param $label string The label for this field element
- * @param $dataType string The data type for this element
+ * @param $name
+ * String the name of the field.
+ * @param $op
+ * String the sql operator, this function should handle ALL SQL operators.
+ * @param $value
+ * String|integer|array depends on the operator and who's calling the query builder.
+ * @param $grouping
+ * Int the index where to place the where clause.
+ * @param $selectValues
+ * The key value pairs for this element. This allows us to use this function for things besides option-value pairs.
+ * @param $field
+ * Array an array that contains various properties of the field identified by $name.
+ * @param $label
+ * String The label for this field element.
+ * @param $dataType
+ * String The data type for this element.
* @param bool $useIDsOnly
*
* @return void adds the where clause and qill to the query object
* super nice js widgets to do the hard work
*
* @param string $string
- * @param string $dataType the dataType we should check for the values, default integer
+ * @param string $dataType
+ * The dataType we should check for the values, default integer.
*
* @return bool|array if string does not match the patter
* array of numeric values if string does match the pattern
/**
* Include pseudo fields LEFT JOIN
- * @param string|array $sort can be a object or string
+ * @param string|array $sort can be a object or string
*
* @return array
*/
* search field. This approach assumes that each field has a unique-name (ie that the field's
* unique-name in the API matches the unique-name in the search-builder).
*
- * @param array $apiEntities list of entities whose options should be automatically scanned using API metadata
- * @param array $fieldOptions keys are field unique-names; values describe how to lookup the options
+ * @param array $apiEntities
+ * List of entities whose options should be automatically scanned using API metadata.
+ * @param array $fieldOptions
+ * Keys are field unique-names; values describe how to lookup the options.
* For boolean options, use value "yesno". For pseudoconstants/FKs, use the name of an API entity
* from which the metadata of the field may be queried. (Yes - that is a mouthful.)
* @void
* For multiple a new variant of this function needs to be written and migrated to as this is a bit
* nasty
*
- * @param array $params (reference ) an assoc array of name/value pairs
- * @param array $ids the array that holds all the db ids
+ * @param array $params
+ * (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
* "we are moving away from the $ids param "
*
/**
* This is the function that check/add if the relationship created is valid
*
- * @param array $params (reference ) an assoc array of name/value pairs
- * @param integer $contactId this is contact id for adding relationship
- * @param array $ids the array that holds all the db ids
+ * @param array $params
+ * (reference ) an assoc array of name/value pairs.
+ * @param int $contactId
+ * This is contact id for adding relationship.
+ * @param array $ids
+ * The array that holds all the db ids.
*
* @return CRM_Contact_BAO_Relationship
* @static
/**
* Check if there is data to create the object
*
- * @param array $params (reference ) an assoc array of name/value pairs
+ * @param array $params
+ * (reference ) an assoc array of name/value pairs.
*
* @return boolean
* @static
/**
* Get get list of relationship type based on the contact type.
*
- * @param int $contactId this is the contact id of the current contact.
+ * @param int $contactId
+ * This is the contact id of the current contact.
* @param null $contactSuffix
- * @param string $relationshipId the id of the existing relationship if any
- * @param string $contactType contact type
- * @param boolean $all if true returns relationship types in both the direction
- * @param string $column name/label that going to retrieve from db.
+ * @param string $relationshipId
+ * The id of the existing relationship if any.
+ * @param string $contactType
+ * Contact type.
+ * @param bool $all
+ * If true returns relationship types in both the direction.
+ * @param string $column
+ * Name/label that going to retrieve from db.
* @param bool $biDirectional
- * @param string $contactSubType includes relationshiptypes between this subtype
- * @param boolean $onlySubTypeRelationTypes if set only subtype which is passed by $contactSubType
+ * @param string $contactSubType
+ * Includes relationshiptypes between this subtype.
+ * @param bool $onlySubTypeRelationTypes
+ * If set only subtype which is passed by $contactSubType.
* related relationshiptypes get return
*
* @static
/**
* Delete the relationship
*
- * @param int $id relationship id
+ * @param int $id
+ * Relationship id.
*
* @return null
*
/**
* Disable/enable the relationship
*
- * @param int $id relationship id
+ * @param int $id
+ * Relationship id.
*
* @param $action
*
/**
* Delete the object records that are associated with this contact
*
- * @param int $contactId id of the contact to delete
+ * @param int $contactId
+ * Id of the contact to delete.
*
* @return void
* @static
/**
* Get the other contact in a relationship
*
- * @param int $id relationship id
+ * @param int $id
+ * Relationship id.
*
* $returns returns the contact ids in the realtionship
*
/**
* Check if the relationship type selected between two contacts is correct
*
- * @param int $contact_a 1st contact id
- * @param int $contact_b 2nd contact id
- * @param int $relationshipTypeId relationship type id
+ * @param int $contact_a
+ * 1st contact id.
+ * @param int $contact_b
+ * 2nd contact id.
+ * @param int $relationshipTypeId
+ * Relationship type id.
*
* @return boolean true if it is valid relationship else false
* @static
/**
* This function does the validtion for valid relationship
*
- * @param array $params this array contains the values there are subitted by the form
- * @param array $ids the array that holds all the db ids
- * @param integer $contactId this is contact id for adding relationship
+ * @param array $params
+ * This array contains the values there are subitted by the form.
+ * @param array $ids
+ * The array that holds all the db ids.
+ * @param int $contactId
+ * This is contact id for adding relationship.
*
* @return string
@access public
/**
* This function checks for duplicate relationship
*
- * @param array $params (reference ) an assoc array of name/value pairs
- * @param integer $id this the id of the contact whom we are adding relationship
- * @param integer $contactId this is contact id for adding relationship
- * @param integer $relationshipId this is relationship id for the contact
+ * @param array $params
+ * (reference ) an assoc array of name/value pairs.
+ * @param int $id
+ * This the id of the contact whom we are adding relationship.
+ * @param int $contactId
+ * This is contact id for adding relationship.
+ * @param int $relationshipId
+ * This is relationship id for the contact.
*
* @return boolean true if record exists else false
* @static
/**
* Update the is_active flag in the db
*
- * @param int $id id of the database record
- * @param boolean $is_active value we want to set the is_active field
+ * @param int $id
+ * Id of the database record.
+ * @param bool $is_active
+ * Value we want to set the is_active field.
*
* @throws CiviCRM_API3_Exception
* @return Object DAO object on success, null otherwise
* Given the list of params in the params array, fetch the object
* and store the values in the values array
*
- * @param array $params input parameters to find object
- * @param array $values output values of the object
+ * @param array $params
+ * Input parameters to find object.
+ * @param array $values
+ * Output values of the object.
*
* @return array (reference) the values that could be potentially assigned to smarty
* @static
/**
* Helper function to form the sql for relationship retrieval
*
- * @param int $contactId contact id
- * @param int $status (check const at top of file)
- * @param int $numRelationship no of relationships to display (limit)
- * @param int $count get the no of relationships
+ * @param int $contactId
+ * Contact id.
+ * @param int $status
+ * (check const at top of file).
+ * @param int $numRelationship
+ * No of relationships to display (limit).
+ * @param int $count
+ * Get the no of relationships.
* $param int $relationshipId relationship id
* @param int $relationshipId
- * @param string $direction the direction we are interested in a_b or b_a
- * @param array $params array of extra values including relationship_type_id per api spec
+ * @param string $direction
+ * The direction we are interested in a_b or b_a.
+ * @param array $params
+ * Array of extra values including relationship_type_id per api spec.
*
* return string the query for this diretion
*
/**
* This is the function to get the list of relationships
*
- * @param int $contactId contact id
- * @param int $status 1: Past 2: Disabled 3: Current
- * @param int $numRelationship no of relationships to display (limit)
- * @param int $count get the no of relationships
+ * @param int $contactId
+ * Contact id.
+ * @param int $status
+ * 1: Past 2: Disabled 3: Current.
+ * @param int $numRelationship
+ * No of relationships to display (limit).
+ * @param int $count
+ * Get the no of relationships.
* $param int $relationshipId relationship id
* $param array $links the list of links to display
* $param int $permissionMask the permission mask to be applied for the actions
/**
* Get get list of relationship type based on the target contact type.
*
- * @param string $targetContactType it's valid contact tpye(may be Individual , Organization , Household)
+ * @param string $targetContactType
+ * It's valid contact tpye(may be Individual , Organization , Household).
*
* @return array - array reference of all relationship types with context to current contact type .
*
* membership is is extedned by the same relationship type to that
* of the existing relationship.
*
- * @param $contactId Int contact id
- * @param $params array array of values submitted by POST
- * @param $ids array array of ids
+ * @param $contactId
+ * Int contact id.
+ * @param $params
+ * Array array of values submitted by POST.
+ * @param $ids
+ * Array array of ids.
* @param \const|\which $action which action called this function
*
* @param bool $active
/**
* Get Current Employer for Contact
*
- * @param $contactIds Contact Ids
+ * @param $contactIds
+ * Contact Ids.
*
* @return array $currentEmployer array of the current employer@static
*/
/**
* Return list of permissioned employer for a given contact.
*
- * @param $contactID int contact id whose employers
+ * @param $contactID
+ * Int contact id whose employers.
* are to be found.
- * @param $name string employers sort name
+ * @param $name
+ * String employers sort name.
*
* @static
*
/**
* Function to return list of permissioned contacts for a given contact and relationship type
*
- * @param $contactID int contact id whose permissioned contacts are to be found.
- * @param $relTypeId string one or more relationship type id's
- * @param $name string
+ * @param $contactID
+ * Int contact id whose permissioned contacts are to be found.
+ * @param $relTypeId
+ * String one or more relationship type id's.
+ * @param $name
+ * String.
*
* @static
*
* Merge relationships from otherContact to mainContact
* Called during contact merge operation
*
- * @param int $mainId contact id of main contact record.
- * @param int $otherId contact id of record which is going to merge.
- * @param array $sqls (reference) array of sql statements to append to.
+ * @param int $mainId
+ * Contact id of main contact record.
+ * @param int $otherId
+ * Contact id of record which is going to merge.
+ * @param array $sqls
+ * (reference) array of sql statements to append to.
*
* @see CRM_Dedupe_Merger::cpTables()
*
* and to add clauses to limit the return to those relationships which COULD inherit a membership type
* (as opposed to those who inherit a particular membership
*
- * @param array $params api input array
+ * @param array $params
+ * Api input array.
* @param null $direction
*
* @return array
/**
* This function is a wrapper for contact relationship selector
*
- * @param array $params associated array for params record id.
+ * @param array $params
+ * Associated array for params record id.
*
* @return array $contactRelationships associated array of contact relationships
*/
/**
* Fetch object based on array of properties
*
- * @param array $params (reference ) an assoc array of name/value pairs
- * @param array $defaults (reference ) an assoc array to hold the flattened values
+ * @param array $params
+ * (reference ) an assoc array of name/value pairs.
+ * @param array $defaults
+ * (reference ) an assoc array to hold the flattened values.
*
* @return CRM_Contact_BAO_RelationshipType object
* @static
/**
* Update the is_active flag in the db
*
- * @param int $id id of the database record
- * @param boolean $is_active value we want to set the is_active field
+ * @param int $id
+ * Id of the database record.
+ * @param bool $is_active
+ * Value we want to set the is_active field.
*
* @return Object DAO object on sucess, null otherwise
* @static
/**
* Add the relationship type in the db
*
- * @param array $params (reference ) an assoc array of name/value pairs
- * @param array $ids the array that holds all the db ids
+ * @param array $params
+ * (reference ) an assoc array of name/value pairs.
+ * @param array $ids
+ * The array that holds all the db ids.
*
* @return CRM_Contact_DAO_RelationshipType
* @static
* Takes a bunch of params that are needed to match certain criteria and
* retrieves the relevant objects.
*
- * @param array $params (reference ) an assoc array of name/value pairs
- * @param array $defaults (reference ) an assoc array to hold the flattened values
+ * @param array $params
+ * (reference ) an assoc array of name/value pairs.
+ * @param array $defaults
+ * (reference ) an assoc array to hold the flattened values.
*
* @return CRM_Contact_BAO_SavedSearch
* @static
/**
* Given an id, extract the formValues of the saved search
*
- * @param int $id the id of the saved search
+ * @param int $id
+ * The id of the saved search.
*
* @return array the values of the posted saved search
* @static
/**
* Get the where clause for a saved search
*
- * @param int $id saved search id
- * @param array $tables (reference ) add the tables that are needed for the select clause
- * @param array $whereTables (reference ) add the tables that are needed for the where clause
+ * @param int $id
+ * Saved search id.
+ * @param array $tables
+ * (reference ) add the tables that are needed for the select clause.
+ * @param array $whereTables
+ * (reference ) add the tables that are needed for the where clause.
*
* @return string the where clause for this saved search
* @static
/**
* Given an id, get the name of the saved search
*
- * @param int $id the id of the saved search
+ * @param int $id
+ * The id of the saved search.
*
* @param string $value
*
/**
* Create a new subscription history record
*
- * @param array $params Values for the new history record
+ * @param array $params
+ * Values for the new history record.
*
* @return object $history The new history object
* @static
/**
* Erase a contact's subscription history records
*
- * @param int $id The contact id
+ * @param int $id
+ * The contact id.
*
* @return void
* @static
/**
* Global validation rules for the form
*
- * @param array $fields posted values of the form
- * @param array $errors list of errors to be posted back to the form
- * @param int $contactId contact id if doing update.
+ * @param array $fields
+ * Posted values of the form.
+ * @param array $errors
+ * List of errors to be posted back to the form.
+ * @param int $contactId
+ * Contact id if doing update.
*
* @return bool $primaryID email/openId@static
*/
/**
* Is there any real significant data in the hierarchical location array
*
- * @param array $fields the hierarchical value representation of this location
+ * @param array $fields
+ * The hierarchical value representation of this location.
*
* @return boolean true if data exists, false otherwise
* @static
/**
* That checks for duplicate contacts
*
- * @param array $fields fields array which are submitted
+ * @param array $fields
+ * Fields array which are submitted.
* @param $errors
- * @param int $contactID contact id
- * @param string $contactType contact type
+ * @param int $contactID
+ * Contact id.
+ * @param string $contactType
+ * Contact type.
*
*/
public static function checkDuplicateContacts(&$fields, &$errors, $contactID, $contactType) {
* This function either parse street address in to child
* elements or build street address from child elements.
*
- * @param $params array of key value consist of address blocks.
+ * @param $params
+ * Array of key value consist of address blocks.
*
* @return array $parseSuccess as array of sucess/fails for each address block@static
*/
* Check parse result and if some address block fails then this
* function return the status message for all address blocks.
*
- * @param $parseResult an array of address blk instance and its status.
+ * @param $parseResult
+ * An array of address blk instance and its status.
*
* @return null|string $statusMsg string status message for all address blocks.@static
*/
* Convert normal number to ordinal number format.
* like 1 => 1st, 2 => 2nd and so on...
*
- * @param $number int number to convert in to ordinal number.
+ * @param $number
+ * Int number to convert in to ordinal number.
*
* @return ordinal number for given number.
* @static
* Update membership status to deceased
* function return the status message for updated membership.
*
- * @param $deceasedParams array having contact id and deceased value.
+ * @param $deceasedParams
+ * Array having contact id and deceased value.
*
* @return null|string $updateMembershipMsg string status message for updated membership.
*/
/**
* Global validation rules for the form
*
- * @param array $fields posted values of the form
+ * @param array $fields
+ * Posted values of the form.
*
* @param $files
* @param $self
/**
* Global validation rules for the form
*
- * @param array $fields posted values of the form
+ * @param array $fields
+ * Posted values of the form.
*
* @return array list of errors to be posted back to the form
* @static
* Build form for address input fields
*
* @param CRM_Core_Form $form
- * @param int $addressBlockCount - the index of the address array (if multiple addresses on a page)
- * @param boolean $sharing - false, if we want to skip the address sharing features
- * @param boolean $inlineEdit true when edit used in inline edit
+ * @param int $addressBlockCount
+ * The index of the address array (if multiple addresses on a page).
+ * @param bool $sharing
+ * False, if we want to skip the address sharing features.
+ * @param bool $inlineEdit
+ * True when edit used in inline edit.
*
* @return void
*
/**
* Set default values for address block
*
- * @param array $defaults defaults associated array
- * @param CRM_Core_Form $form form object
+ * @param array $defaults
+ * Defaults associated array.
+ * @param CRM_Core_Form $form
+ * Form object.
*
* @static
*/
/**
* Build the form object elements for Communication Preferences object
*
- * @param CRM_Core_Form $form reference to the form object
+ * @param CRM_Core_Form $form
+ * Reference to the form object.
*
* @return void
* @static
/**
* Global form rule
*
- * @param array $fields the input form values
- * @param array $files the uploaded files if any
+ * @param array $fields
+ * The input form values.
+ * @param array $files
+ * The uploaded files if any.
* @param $self
*
* @return true if no errors, else array of errors
/**
* Build the form object elements for CustomData object
*
- * @param CRM_Core_Form $form reference to the form object
+ * @param CRM_Core_Form $form
+ * Reference to the form object.
*
* @return void
* @static
/**
* Build the form object elements for Demographics object
*
- * @param CRM_Core_Form $form reference to the form object
+ * @param CRM_Core_Form $form
+ * Reference to the form object.
*
* @return void
* @static
/**
* Build the form object elements for an email object
*
- * @param CRM_Core_Form $form reference to the form object
- * @param int $blockCount block number to build
- * @param boolean $blockEdit is it block edit
+ * @param CRM_Core_Form $form
+ * Reference to the form object.
+ * @param int $blockCount
+ * Block number to build.
+ * @param bool $blockEdit
+ * Is it block edit.
*
* @return void
* @static
* This function provides the HTML form elements that are specific
* to the Household Contact Type
*
- * @param CRM_Core_Form $form form object
- * @param int $inlineEditMode ( 1 for contact summary
+ * @param CRM_Core_Form $form
+ * Form object.
+ * @param int $inlineEditMode
+ * ( 1 for contact summary.
* top bar form and 2 for display name edit )
*
* @return void
/**
* Add rule for household
*
- * @param array $fields array of form values
- * @param array $files - unused
+ * @param array $fields
+ * Array of form values.
+ * @param array $files
+ * Unused.
* @param int $contactID
*
* @return array|bool $error@static
/**
* Build the form object elements for an IM object
*
- * @param CRM_Core_Form $form reference to the form object
- * @param int $blockCount block number to build
- * @param boolean $blockEdit is it block edit
+ * @param CRM_Core_Form $form
+ * Reference to the form object.
+ * @param int $blockCount
+ * Block number to build.
+ * @param bool $blockEdit
+ * Is it block edit.
*
* @return void
* @static
* This function provides the HTML form elements that are specific
* to the Individual Contact Type
*
- * @param CRM_Core_Form $form form object
- * @param int $inlineEditMode ( 1 for contact summary
+ * @param CRM_Core_Form $form
+ * Form object.
+ * @param int $inlineEditMode
+ * ( 1 for contact summary.
* top bar form and 2 for display name edit )
*
* @return void
/**
* Global form rule
*
- * @param array $fields the input form values
- * @param array $files the uploaded files if any
+ * @param array $fields
+ * The input form values.
+ * @param array $files
+ * The uploaded files if any.
* @param int $contactID
*
* @return true if no errors, else array of errors
/**
* Build the form object
*
- * @param CRM_Core_Form $form form object
+ * @param CRM_Core_Form $form
+ * Form object.
*
* @return void
*/
/**
* Ensure that modified_date hasn't changed in the underlying DB
*
- * @param array $fields the input form values
- * @param array $files the uploaded files if any
+ * @param array $fields
+ * The input form values.
+ * @param array $files
+ * The uploaded files if any.
* @param int $contactID
*
* @return true if no errors, else array of errors
/**
* Build the form object elements for an open id object
*
- * @param CRM_Core_Form $form reference to the form object
- * @param int $blockCount block number to build
- * @param boolean $blockEdit is it block edit
+ * @param CRM_Core_Form $form
+ * Reference to the form object.
+ * @param int $blockCount
+ * Block number to build.
+ * @param bool $blockEdit
+ * Is it block edit.
*
* @return void
* @static
* This function provides the HTML form elements that are specific
* to the Organization Contact Type
*
- * @param CRM_Core_Form $form form object
- * @param int $inlineEditMode ( 1 for contact summary
+ * @param CRM_Core_Form $form
+ * Form object.
+ * @param int $inlineEditMode
+ * ( 1 for contact summary.
* top bar form and 2 for display name edit )
*
* @return void
/**
* Build the form object elements for a phone object
*
- * @param CRM_Core_Form $form reference to the form object
- * @param int $addressBlockCount block number to build
- * @param boolean $blockEdit is it block edit
+ * @param CRM_Core_Form $form
+ * Reference to the form object.
+ * @param int $addressBlockCount
+ * Block number to build.
+ * @param bool $blockEdit
+ * Is it block edit.
*
* @return void
* @static
* This function is to build form elements
* params object $form object of the form
*
- * @param CRM_Core_Form $form the form object that we are operating on
- * @param int $contactId contact id
- * @param int $type what components are we interested in
- * @param boolean $visibility visibility of the field
+ * @param CRM_Core_Form $form
+ * The form object that we are operating on.
+ * @param int $contactId
+ * Contact id.
+ * @param int $type
+ * What components are we interested in.
+ * @param bool $visibility
+ * Visibility of the field.
* @param null $isRequired
- * @param string $groupName if used for building group block
- * @param string $tagName if used for building tag block
- * @param string $fieldName this is used in batch profile(i.e to build multiple blocks)
+ * @param string $groupName
+ * If used for building group block.
+ * @param string $tagName
+ * If used for building tag block.
+ * @param string $fieldName
+ * This is used in batch profile(i.e to build multiple blocks).
*
* @param string $groupElementType
*
/**
* Set defaults for relevant form elements
*
- * @param int $id the contact id
- * @param array $defaults the defaults array to store the values in
- * @param int $type what components are we interested in
- * @param string $fieldName this is used in batch profile(i.e to build multiple blocks)
+ * @param int $id
+ * The contact id.
+ * @param array $defaults
+ * The defaults array to store the values in.
+ * @param int $type
+ * What components are we interested in.
+ * @param string $fieldName
+ * This is used in batch profile(i.e to build multiple blocks).
*
* @param string $groupElementType
*
/**
* Build the form object elements for an Website object
*
- * @param CRM_Core_Form $form reference to the form object
- * @param int $blockCount block number to build
+ * @param CRM_Core_Form $form
+ * Reference to the form object.
+ * @param int $blockCount
+ * Block number to build.
*
* @return void
* @static
/**
* Global validation rules for the form
*
- * @param array $fields posted values of the form
- * @param array $errors list of errors to be posted back to the form
+ * @param array $fields
+ * Posted values of the form.
+ * @param array $errors
+ * List of errors to be posted back to the form.
*
* @return array $errors@static
*/
/**
* Global validation rules for the form
*
- * @param array $fields posted values of the form
- * @param array $errors list of errors to be posted back to the form
+ * @param array $fields
+ * Posted values of the form.
+ * @param array $errors
+ * List of errors to be posted back to the form.
*
* @return array $errors@static
*/
/**
* This function provides the HTML form elements
*
- * @param CRM_Core_Form $form form object
+ * @param CRM_Core_Form $form
+ * Form object.
* @param int $contactID
*
* @return void
/**
* Ensure that oplock_ts hasn't changed in the underlying DB
*
- * @param array $fields the input form values
- * @param array $files the uploaded files if any
+ * @param array $fields
+ * The input form values.
+ * @param array $files
+ * The uploaded files if any.
* @param int $contactID
*
* @return true if no errors, else array of errors
/**
* Global validation rules for the form
*
- * @param array $fields posted values of the form
- * @param array $errors list of errors to be posted back to the form
+ * @param array $fields
+ * Posted values of the form.
+ * @param array $errors
+ * List of errors to be posted back to the form.
*
* @return array $errors@static
*/
/**
* Global validation rules for the form
*
- * @param array $fields posted values of the form
- * @param array $errors list of errors to be posted back to the form
+ * @param array $fields
+ * Posted values of the form.
+ * @param array $errors
+ * List of errors to be posted back to the form.
*
* @return array $errors@static
*/
/**
* Date validation
*
- * @param array $params (reference ) an assoc array of name/value pairs
+ * @param array $params
+ * (reference ) an assoc array of name/value pairs.
*
* @return mixed true or array of errors
* @static
/**
* Normalize default values for multiselect plugins
*
- * @param $defaults array
+ * @param $defaults
+ * Array.
* @return array
*/
public function normalizeDefaultValues(&$defaults) {
*
* TODO: Understand why $queryLimit and $detailLimit are different
*
- * @param string $queryText a string of text to search for
- * @param string $entityIDTableName a temporary table into which we can write a list of all matching IDs
- * @param string $detailTable a table into which we can write details about a page worth of matches
+ * @param string $queryText
+ * A string of text to search for.
+ * @param string $entityIDTableName
+ * A temporary table into which we can write a list of all matching IDs.
+ * @param string $detailTable
+ * A table into which we can write details about a page worth of matches.
* @param array|NULL $queryLimit overall limit (applied when building $entityIDTableName)
* NULL if no limit; or array(0 => $limit, 1 => $offset)
* @param array|NULL $detailLimit final limit (applied when building $detailTable)
/**
* @param string $queryText
- * @param array $tables a list of places to query. Keys may be:
+ * @param array $tables
+ * A list of places to query. Keys may be:.
* - sql: an array of SQL queries to execute
* - final: an array of SQL queries to execute at the end
* - *: All other keys are treated as table names
* Create a SQL expression for matching against a list of
* text columns.
*
- * @param string $table eg "civicrm_note" or "civicrm_note mynote"
+ * @param string $table
+ * Eg "civicrm_note" or "civicrm_note mynote".
* @param array|string $fullTextFields list of field names
* @param string $queryText
* @return string SQL, eg "MATCH (col1) AGAINST (queryText)" or "col1 LIKE '%queryText%'"
*
* @param string $toTable
* @param string $parentIdColumn
- * @param array $files see return format of CRM_Core_FileSearchInterface::search
+ * @param array $files
+ * See return format of CRM_Core_FileSearchInterface::search.
*/
public function moveFileIDs($toTable, $parentIdColumn, $files) {
if (empty($files)) {
* Simple shell that derived classes can call to add buttons to
* the form with a customized title for the main Submit
*
- * @param string $title title of the main button
- * @param string $nextType button type for the form after processing
+ * @param string $title
+ * Title of the main button.
+ * @param string $nextType
+ * Button type for the form after processing.
* @param string $backType
* @param bool $submitOnce
*
* This function is to get the result of the search for Add to * forms
*
* @param CRM_Core_Form $form
- * @param array $params This contains elements for search criteria
+ * @param array $params
+ * This contains elements for search criteria.
*
*
* @return void
/**
* Global form rule
*
- * @param array $fields the input form values
+ * @param array $fields
+ * The input form values.
*
* @return true if no errors, else array of errors
* @static
/**
* Parse street address
- * @param array $contactValues contact values
- * @param CRM_Core_Form $form form object
+ * @param array $contactValues
+ * Contact values.
+ * @param CRM_Core_Form $form
+ * Form object.
*/
public static function parseStreetAddress(&$contactValues, &$form) {
if (!is_array($contactValues) || !is_array($form->_fields)) {
/**
* Global form rule
*
- * @param array $fields the input form values
- * @param array $files the uploaded files if any
- * @param object $self form object
+ * @param array $fields
+ * The input form values.
+ * @param array $files
+ * The uploaded files if any.
+ * @param object $self
+ * Form object.
*
* @return true if no errors, else array of errors
* @static
/**
* Form rule
*
- * @param array $fields the input form values
+ * @param array $fields
+ * The input form values.
* @param array $dontCare
- * @param array $self additional values form 'this'
+ * @param array $self
+ * Additional values form 'this'.
*
* @return true if no errors, else array of errors
*
/**
* Create labels (pdf)
*
- * @param array $contactRows assciated array of contact data
- * @param string $format format in which labels needs to be printed
- * @param string $fileName The name of the file to save the label in
+ * @param array $contactRows
+ * Assciated array of contact data.
+ * @param string $format
+ * Format in which labels needs to be printed.
+ * @param string $fileName
+ * The name of the file to save the label in.
*
* @return null
*/
/**
* Create labels (pdf)
*
- * @param array $contactRows assciated array of contact data
- * @param string $format format in which labels needs to be printed
- * @param string $fileName The name of the file to save the label in
+ * @param array $contactRows
+ * Assciated array of contact data.
+ * @param string $format
+ * Format in which labels needs to be printed.
+ * @param string $fileName
+ * The name of the file to save the label in.
*
* @return null
*/
* Get the rows for the labels
*
* @param $contactIDs
- * @param integer $locationTypeID
- * @param boolean $respectDoNotMail
+ * @param int $locationTypeID
+ * @param bool $respectDoNotMail
* @param $mergeSameAddress
- * @param bool $mergeSameHousehold UNUSED
+ * @param bool $mergeSameHousehold
+ * UNUSED.
*
* @return array of rows for labels
*/
* Assign smarty variables to the template that will be used by google api to plot the contacts
*
* @param $ids
- * @param int $locationId location_id
+ * @param int $locationId
+ * Location_id.
* @param $page
* @param $addBreadCrumb
* @param string $type
/**
* Form rule
*
- * @param array $fields the input form values
+ * @param array $fields
+ * The input form values.
* @param array $dontCare
- * @param array $self additional values form 'this'
+ * @param array $self
+ * Additional values form 'this'.
*
* @return true if no errors, else array of errors
*
/**
* Global validation rules for the form
*
- * @param array $fields posted values of the form
+ * @param array $fields
+ * Posted values of the form.
*
* @return array list of errors to be posted back to the form
* @static
/**
* Global form rule
*
- * @param array $fields the input form values
- * @param array $files the uploaded files if any
+ * @param array $fields
+ * The input form values.
+ * @param array $files
+ * The uploaded files if any.
* @param CRM_Core_Form $form
*
* @return true if no errors, else array of errors
/**
* Form rule
*
- * @param array $fields the input form values
+ * @param array $fields
+ * The input form values.
* @param array $dontCare
- * @param array $self additional values form 'this'
+ * @param array $self
+ * Additional values form 'this'.
*
* @return true if no errors, else array of errors
*
/**
* Global validation rules for the form
*
- * @param array $fields posted values of the form
+ * @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 array $fields posted values of the form
+ * @param array $fields
+ * Posted values of the form.
*
* @param $files
* @param $self
/**
* Set IM Service Provider type fields
*
- * @param array $elements IM service provider type ids
+ * @param array $elements
+ * IM service provider type ids.
*
* @return void
*/
/**
* Set IM Service Provider type fields for related contacts
*
- * @param array $elements IM service provider type ids of related contact
+ * @param array $elements
+ * IM service provider type ids of related contact.
*
* @return void
*/
/**
* Handle the values in mapField mode
*
- * @param array $values the array of values belonging to this line
+ * @param array $values
+ * The array of values belonging to this line.
*
* @return boolean
*/
/**
* Handle the values in preview mode
*
- * @param array $values the array of values belonging to this line
+ * @param array $values
+ * The array of values belonging to this line.
*
* @return boolean the result of this processing
*/
/**
* Handle the values in summary mode
*
- * @param array $values the array of values belonging to this line
+ * @param array $values
+ * The array of values belonging to this line.
*
* @return boolean the result of this processing
*/
/**
* Handle the values in import mode
*
- * @param int $onDuplicate the code for what action to take on duplicates
- * @param array $values the array of values belonging to this line
+ * @param int $onDuplicate
+ * The code for what action to take on duplicates.
+ * @param array $values
+ * The array of values belonging to this line.
*
* @param bool $doGeocodeAddress
*
* Check if an error in custom data
*
* @param array $params
- * @param String $errorMessage A string containing all the error-fields.
+ * @param string $errorMessage
+ * A string containing all the error-fields.
*
* @param null $csType
* @param null $relationships
* eg value might be m/M, ma/MA, mal/MAL, male return 'Male'
* but if value is 'maleabc' than return false
*
- * @param string $gender check this value across gender values.
+ * @param string $gender
+ * Check this value across gender values.
*
* retunr gender value / false
*
* Check if an error in Core( non-custom fields ) field
*
* @param array $params
- * @param String $errorMessage A string containing all the error-fields.
+ * @param string $errorMessage
+ * A string containing all the error-fields.
*
*/
public function isErrorInCoreData($params, &$errorMessage) {
/**
* Build error-message containing error-fields
*
- * @param String $errorName A string containing error-field name.
- * @param String $errorMessage A string containing all the error-fields, where the new errorName is concatenated.
+ * @param string $errorName
+ * A string containing error-field name.
+ * @param string $errorMessage
+ * A string containing all the error-fields, where the new errorName is concatenated.
*
* @static
*/
/**
* Format params for update and fill mode
*
- * @param $params array reference to an array containing all the
+ * @param $params
+ * Array reference to an array containing all the.
* values for import
- * @param $onDuplicate int
- * @param $cid int contact id
+ * @param $onDuplicate
+ * Int.
+ * @param $cid
+ * Int contact id.
*/
public function formatParams(&$params, $onDuplicate, $cid) {
if ($onDuplicate == CRM_Import_Parser::DUPLICATE_SKIP) {
/**
* Convert any given date string to default date array.
*
- * @param array $params has given date-format
- * @param array $formatted store formatted date in this array
- * @param int $dateType type of date
- * @param string $dateParam index of params
+ * @param array $params
+ * Has given date-format.
+ * @param array $formatted
+ * Store formatted date in this array.
+ * @param int $dateType
+ * Type of date.
+ * @param string $dateParam
+ * Index of params.
* @static
*/
public function formatCustomDate(&$params, &$formatted, $dateType, $dateParam) {
/**
* Format common params data to proper format to store.
*
- * @param array $params contain record values.
- * @param array $formatted array of formatted data.
- * @param array $contactFields contact DAO fields.
+ * @param array $params
+ * Contain record values.
+ * @param array $formatted
+ * Array of formatted data.
+ * @param array $contactFields
+ * Contact DAO fields.
* @static
*/
public function formatCommonData($params, &$formatted, &$contactFields) {
/**
* Generate status and error message for unparsed street address records.
*
- * @param array $values the array of values belonging to each row
- * @param array $statusFieldName store formatted date in this array
+ * @param array $values
+ * The array of values belonging to each row.
+ * @param array $statusFieldName
+ * Store formatted date in this array.
* @param $returnCode
*
* @return int
/**
* Delete a saved search.
*
- * @param int $id - id of saved search
+ * @param int $id
+ * Id of saved search.
*
* @return void
*
/**
* Add urls for display in the actions menu
* @param CRM_Core_Page $obj
- * @param integer $cid
+ * @param int $cid
*/
public static function addUrls(&$obj, $cid) {
$uid = CRM_Core_BAO_UFMatch::getUFId($cid);
/**
* Remove/ rejoin the group
*
- * @param int $groupContactId id of crm_group_contact
- * @param string $status this is the status that should be updated.
+ * @param int $groupContactId
+ * Id of crm_group_contact.
+ * @param string $status
+ * This is the status that should be updated.
*
* $access public
* @param int $contactID
* Class constructor
*
* @param $customSearchClass
- * @param array $formValues array of form values imported
- * @param array $params array of parameters for query
+ * @param array $formValues
+ * Array of form values imported.
+ * @param array $params
+ * Array of parameters for query.
* @param null $returnProperties
* @param \const|int $action - action of search basic or advanced.
*
* Returns the column headers as an array of tuples:
* (name, sortName (key to the sort array))
*
- * @param string $action the action being performed
- * @param enum $output what should the result set include (web/email/csv)
+ * @param string $action
+ * The action being performed.
+ * @param enum $output
+ * What should the result set include (web/email/csv).
*
* @return array the column headers that need to be displayed
*/
/**
* Returns all the rows in the given offset and rowCount
*
- * @param enum $action the action being performed
- * @param int $offset the row number to start from
- * @param int $rowCount the number of rows to return
- * @param string $sort the sql string that describes the sort order
- * @param enum $output what should the result set include (web/email/csv)
+ * @param enum $action
+ * The action being performed.
+ * @param int $offset
+ * The row number to start from.
+ * @param int $rowCount
+ * The number of rows to return.
+ * @param string $sort
+ * The sql string that describes the sort order.
+ * @param enum $output
+ * What should the result set include (web/email/csv).
*
* @return int the total number of rows for this action
*/
/**
* This function is called to rebuild prev next cache using full sql in case of core search ( excluding custom search)
*
- * @param int $start start for limit clause
- * @param int $end end for limit clause
+ * @param int $start
+ * Start for limit clause.
+ * @param int $end
+ * End for limit clause.
* @param CRM_Utils_Sort $sort
- * @param string $cacheKey cache key
+ * @param string $cacheKey
+ * Cache key.
*
* @return void
*/
* Given the current formValues, gets the query in local
* language
*
- * @param array(
+ * @param array(
reference) $formValues submitted formValues
*
* @return array $qill which contains an array of strings
/**
* Name of export file.
*
- * @param string $output type of output
+ * @param string $output
+ * Type of output.
*
* @return string name of the file
*/
* Class constructor
*
* @param $customSearchClass
- * @param array $formValues array of form values imported
- * @param array $params array of parameters for query
+ * @param array $formValues
+ * Array of form values imported.
+ * @param array $params
+ * Array of parameters for query.
* @param null $returnProperties
* @param \const|int $action - action of search basic or advanced.
*
* Returns the column headers as an array of tuples:
* (name, sortName (key to the sort array))
*
- * @param string $action the action being performed
- * @param enum $output what should the result set include (web/email/csv)
+ * @param string $action
+ * The action being performed.
+ * @param enum $output
+ * What should the result set include (web/email/csv).
*
* @return array the column headers that need to be displayed
*/
/**
* Returns all the rows in the given offset and rowCount
*
- * @param enum $action the action being performed
- * @param int $offset the row number to start from
- * @param int $rowCount the number of rows to return
- * @param string $sort the sql string that describes the sort order
- * @param enum $output what should the result set include (web/email/csv)
+ * @param enum $action
+ * The action being performed.
+ * @param int $offset
+ * The row number to start from.
+ * @param int $rowCount
+ * The number of rows to return.
+ * @param string $sort
+ * The sql string that describes the sort order.
+ * @param enum $output
+ * What should the result set include (web/email/csv).
*
* @return int the total number of rows for this action
*/
* Given the current formValues, gets the query in local
* language
*
- * @param array(
+ * @param array(
reference) $formValues submitted formValues
*
* @return array $qill which contains an array of strings
/**
* Name of export file.
*
- * @param string $output type of output
+ * @param string $output
+ * Type of output.
*
* @return string name of the file
*/
* to avoid using conditional state machine, much more efficient
* and simpler
*
- * @param CRM_Core_Controller $controller the controller object
+ * @param CRM_Core_Controller $controller
+ * The controller object.
*
* @param string $formName
*
* of the user
*
* @param int $permission
- * @param bool $deletedContacts are these tasks for operating on deleted contacts?
+ * @param bool $deletedContacts
+ * Are these tasks for operating on deleted contacts?.
*
* @return array set of tasks that are valid for the user
*/
projects / civicrm-core.git / commitdiff