Commit 6a0b768e authored by totten's avatar totten

INFRA-132 - CRM/Core - Convert single-line @param to multi-line

parent 014c4014
......@@ -111,7 +111,8 @@ class CRM_Core_Action {
/**
* Called by the request object to translate a string into a mask
*
* @param string $str the action to be resolved
* @param string $str
* The action to be resolved.
*
* @return int the action mask corresponding to the input string
* @static
......@@ -129,7 +130,8 @@ class CRM_Core_Action {
* Given a string or an array of strings, determine the bitmask
* for this set of actions
*
* @param mixed $item either a single string or an array of strings
* @param mixed $item
* Either a single string or an array of strings.
*
* @return int the action mask corresponding to the input args
* @static
......@@ -152,7 +154,8 @@ class CRM_Core_Action {
/**
* Given a string determine the bitmask for this specific string
*
* @param string $item the input action to process
* @param string $item
* The input action to process.
*
* @return int the action mask corresponding to the input string
* @static
......@@ -167,7 +170,8 @@ class CRM_Core_Action {
*
* Given an action mask, find the corresponding description
*
* @param int $mask the action mask
* @param int $mask
* The action mask.
*
* @return string the corresponding action description
* @static
......@@ -185,11 +189,16 @@ class CRM_Core_Action {
* Given a set of links and a mask, return the html action string for
* the links associated with the mask
*
* @param array $links the set of link items
* @param int $mask the mask to be used. a null mask means all items
* @param array $values the array of values for parameter substitution in the link items
* @param string $extraULName enclosed extra links in this UL.
* @param boolean $enclosedAllInSingleUL force to enclosed all links in single UL.
* @param array $links
* The set of link items.
* @param int $mask
* The mask to be used. a null mask means all items.
* @param array $values
* The array of values for parameter substitution in the link items.
* @param string $extraULName
* Enclosed extra links in this UL.
* @param bool $enclosedAllInSingleUL
* Force to enclosed all links in single UL.
*
* @param null $op
* @param null $objectName
......@@ -301,8 +310,10 @@ class CRM_Core_Action {
* Given a string and an array of values, substitute the real values
* in the placeholder in the str in the CiviCRM format
*
* @param string $str the string to be replaced
* @param array $values the array of values for parameter substitution in the str
* @param string $str
* The string to be replaced.
* @param array $values
* The array of values for parameter substitution in the str.
*
* @return string the substituted string
* @static
......
......@@ -86,7 +86,8 @@ class CRM_Core_BAO_ActionSchedule extends CRM_Core_DAO_ActionSchedule {
/**
* Retrieve list of selections/drop downs for Scheduled Reminder form
*
* @param bool $id mapping id
* @param bool $id
* Mapping id.
*
* @return array associated array of all the drop downs in the form
* @static
......@@ -315,7 +316,8 @@ class CRM_Core_BAO_ActionSchedule extends CRM_Core_DAO_ActionSchedule {
/**
* Retrieve list of Scheduled Reminders
*
* @param bool $namesOnly return simple list of names
* @param bool $namesOnly
* Return simple list of names.
*
* @param null $entityValue
* @param int $id
......@@ -580,8 +582,10 @@ AND cas.entity_value = $id AND
/**
* Add the schedules reminders 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_Core_DAO_ActionSchedule
* @static
......@@ -599,8 +603,10 @@ AND cas.entity_value = $id AND
* retrieves the relevant objects. It also stores all the retrieved
* values in the default array
*
* @param array $params (reference ) an assoc array of name/value pairs
* @param array $values (reference ) an assoc array to hold the flattened values
* @param array $params
* (reference ) an assoc array of name/value pairs.
* @param array $values
* (reference ) an assoc array to hold the flattened values.
*
* @return CRM_Core_DAO_ActionSchedule object on success, null otherwise
* @static
......@@ -626,7 +632,8 @@ AND cas.entity_value = $id AND
/**
* Delete a Reminder
*
* @param int $id ID of the Reminder to be deleted.
* @param int $id
* ID of the Reminder to be deleted.
*
* @static
*/
......@@ -645,8 +652,10 @@ AND cas.entity_value = $id AND
/**
* 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
......
......@@ -41,8 +41,10 @@ class CRM_Core_BAO_Address extends CRM_Core_DAO_Address {
/**
* Takes an associative array and creates a address
*
* @param array $params (reference ) an assoc array of name/value pairs
* @param boolean $fixAddress true if you need to fix (format) address values
* @param array $params
* (reference ) an assoc array of name/value pairs.
* @param bool $fixAddress
* True if you need to fix (format) address values.
* before inserting in db
*
* @param null $entity
......@@ -133,8 +135,10 @@ class CRM_Core_BAO_Address extends CRM_Core_DAO_Address {
/**
* Takes an associative array and adds address
*
* @param array $params (reference ) an assoc array of name/value pairs
* @param boolean $fixAddress true if you need to fix (format) address values
* @param array $params
* (reference ) an assoc array of name/value pairs.
* @param bool $fixAddress
* True if you need to fix (format) address values.
* before inserting in db
*
* @return object CRM_Core_BAO_Address object on success, null otherwise
......@@ -196,7 +200,8 @@ class CRM_Core_BAO_Address extends CRM_Core_DAO_Address {
/**
* Format the address params to have reasonable values
*
* @param array $params (reference ) an assoc array of name/value pairs
* @param array $params
* (reference ) an assoc array of name/value pairs.
*
* @return void
* @static
......@@ -395,7 +400,8 @@ class CRM_Core_BAO_Address extends CRM_Core_DAO_Address {
/**
* 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
*
......@@ -451,8 +457,10 @@ class CRM_Core_BAO_Address extends CRM_Core_DAO_Address {
* Given the list of params in the params array, fetch the object
* and store the values in the values array
*
* @param array $entityBlock associated array of fields
* @param boolean $microformat if microformat output is required
* @param array $entityBlock
* Associated array of fields.
* @param bool $microformat
* If microformat output is required.
* @param int|string $fieldName conditional field name
*
* @return array $addresses array with address fields
......@@ -574,7 +582,8 @@ class CRM_Core_BAO_Address extends CRM_Core_DAO_Address {
/**
* Get all the addresses for a specified contact_id, with the primary address being first
*
* @param int $id the contact id
* @param int $id
* The contact id.
*
* @param bool $updateBlankLocInfo
*
......@@ -610,7 +619,8 @@ ORDER BY civicrm_address.is_primary DESC, address_id ASC";
/**
* Get all the addresses for a specified location_block id, with the primary address being first
*
* @param array $entityElements the array containing entity_id and
* @param array $entityElements
* The array containing entity_id and.
* entity_table name
*
* @return array the array of adrress data
......@@ -687,8 +697,8 @@ ORDER BY civicrm_address.is_primary DESC, civicrm_address.location_type_id DESC,
* NB: civic street formats for en_CA and fr_CA used by default if those locales are active
* otherwise en_US format is default action
*
* @param string Street address including number and apt
* @param string Locale - to set locale used to parse address
* @param string Street address including number and apt
* @param string Locale - to set locale used to parse address
*
* @return array $parseFields parsed fields values.
* @static
......@@ -822,7 +832,8 @@ ORDER BY civicrm_address.is_primary DESC, civicrm_address.location_type_id DESC,
* Validate the address fields based on the address options enabled
* in the Address Settings
*
* @param array $fields an array of importable/exportable contact fields
* @param array $fields
* An array of importable/exportable contact fields.
*
* @return array $fields an array of contact fields and only the enabled address options
* @static
......@@ -850,7 +861,8 @@ ORDER BY civicrm_address.is_primary DESC, civicrm_address.location_type_id DESC,
/**
* Check if current address is used by any other contacts
*
* @param int $addressId address id
* @param int $addressId
* Address id.
*
* @return count of contacts that use this shared address
* @static
......@@ -863,8 +875,10 @@ ORDER BY civicrm_address.is_primary DESC, civicrm_address.location_type_id DESC,
/**
* Check if current address fields are shared with any other address
*
* @param array $fields address fields in profile
* @param int $contactId contact id
* @param array $fields
* Address fields in profile.
* @param int $contactId
* Contact id.
*
* @static
*/
......@@ -933,8 +947,10 @@ SELECT is_primary,
/**
* Update the shared addresses if master address is modified
*
* @param int $addressId address id
* @param array $params associated array of address params
* @param int $addressId
* Address id.
* @param array $params
* Associated array of address params.
*
* @return void
* @static
......@@ -960,7 +976,8 @@ SELECT is_primary,
/**
* Merge contacts with the Same address to get one shared label
* @param array $rows - array[contact_id][contactDetails]
* @param array $rows
* Array[contact_id][contactDetails].
*/
public static function mergeSameAddress(&$rows) {
$uniqueAddress = array();
......@@ -1033,8 +1050,10 @@ SELECT is_primary,
* Note that currently we create relationship only for Individual contacts
* Individual + Household and Individual + Orgnization
*
* @param int $masterAddressId master address id
* @param array $params associated array of submitted values
* @param int $masterAddressId
* Master address id.
* @param array $params
* Associated array of submitted values.
*
* @return void
* @static
......@@ -1103,9 +1122,12 @@ SELECT is_primary,
/**
* Check and set the status for shared address delete
*
* @param int $addressId address id
* @param int $contactId contact id
* @param boolean $returnStatus by default false
* @param int $addressId
* Address id.
* @param int $contactId
* Contact id.
* @param bool $returnStatus
* By default false.
*
* @return string $statusMessage
* @static
......@@ -1174,9 +1196,11 @@ SELECT is_primary,
* 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
*/
......
......@@ -51,8 +51,10 @@ class CRM_Core_BAO_Block {
* Given the list of params in the params array, fetch the object
* and store the values in the values array
*
* @param string $blockName name of the above object
* @param array $params input parameters to find object
* @param string $blockName
* Name of the above object.
* @param array $params
* Input parameters to find object.
*
* @return array of $block objects.
* @static
......@@ -95,8 +97,10 @@ class CRM_Core_BAO_Block {
* Given the list of params in the params array, fetch the object
* and store the values in the values array
*
* @param Object $block typically a Phone|Email|IM|OpenID object
* @param string $blockName name of the above object
* @param Object $block
* Typically a Phone|Email|IM|OpenID object.
* @param string $blockName
* Name of the above object.
*
* @return array of $block objects.
* @static
......@@ -124,8 +128,10 @@ class CRM_Core_BAO_Block {
/**
* Check if the current block object has any valid data
*
* @param array $blockFields array of fields that are of interest for this object
* @param array $params associated array of submitted fields
* @param array $blockFields
* Array of fields that are of interest for this object.
* @param array $params
* Associated array of submitted fields.
*
* @return boolean true if the block has data, otherwise false
* @static
......@@ -142,8 +148,10 @@ class CRM_Core_BAO_Block {
/**
* Check if the current block exits
*
* @param string $blockName bloack name
* @param array $params associated array of submitted fields
* @param string $blockName
* Bloack name.
* @param array $params
* Associated array of submitted fields.
*
* @return boolean true if the block exits, otherwise false
* @static
......@@ -160,8 +168,10 @@ class CRM_Core_BAO_Block {
/**
* Get all block ids for a contact
*
* @param string $blockName block name
* @param int $contactId contact id
* @param string $blockName
* Block name.
* @param int $contactId
* Contact id.
*
* @param null $entityElements
* @param bool $updateBlankLocInfo
......@@ -202,8 +212,10 @@ class CRM_Core_BAO_Block {
/**
* Takes an associative array and creates a block
*
* @param string $blockName block name
* @param array $params (reference ) an assoc array of name/value pairs
* @param string $blockName
* Block name.
* @param array $params
* (reference ) an assoc array of name/value pairs.
* @param null $entity
* @param int $contactId
*
......@@ -382,8 +394,10 @@ class CRM_Core_BAO_Block {
/**
* Delete block
*
* @param string $blockName block name
* @param int $params associates array
* @param string $blockName
* Block name.
* @param int $params
* Associates array.
*
* @return void
* @static
......
......@@ -47,7 +47,8 @@ class CRM_Core_BAO_CMSUser {
/**
* Synchronizing cms users with CiviCRM contacts
*
* @param bool $is_interactive whether to show statuses & perform redirects
* @param bool $is_interactive
* Whether to show statuses & perform redirects.
* This behavior is misplaced in the BAO layer, but we'll preserve it to avoid
* contract changes in the middle of the support cycle. In the next major
* release, we should remove & document it.
......@@ -222,8 +223,10 @@ class CRM_Core_BAO_CMSUser {
/**
* Create CMS user using Profile
*
* @param array $params associated array
* @param string $mail email id for cms user
* @param array $params
* Associated array.
* @param string $mail
* Email id for cms user.
*
* @return int contact id that has been created
* @static
......@@ -251,8 +254,10 @@ class CRM_Core_BAO_CMSUser {
* Create Form for CMS user using Profile
*
* @param CRM_Core_Form $form
* @param integer $gid id of group of profile
* @param bool $emailPresent true if the profile field has email(primary)
* @param int $gid
* Id of group of profile.
* @param bool $emailPresent
* True if the profile field has email(primary).
* @param \const|int $action
*
* @return FALSE|void WTF
......@@ -335,8 +340,10 @@ class CRM_Core_BAO_CMSUser {
* Checks that there is a valid username & email
* optionally checks password is present & matches DB & gets the CMS to validate
*
* @param array $fields Posted values of form
* @param array $files uploaded files if any
* @param array $fields
* Posted values of form.
* @param array $files
* Uploaded files if any.
* @param CRM_Core_Form $form
*
* @return array|bool
......@@ -412,7 +419,8 @@ class CRM_Core_BAO_CMSUser {
/**
* Check if a cms user already exists.
*
* @param Array $contact array of contact-details
* @param Array $contact
* Array of contact-details.
*
* @return uid if user exists, false otherwise
*
......
......@@ -54,9 +54,12 @@ class CRM_Core_BAO_Cache extends CRM_Core_DAO_Cache {
/**
* Retrieve an item from the DB cache
*
* @param string $group (required) The group name of the item
* @param string $path (required) The path under which this item is stored
* @param int $componentID The optional component ID (so componenets can share the same name space)
* @param string $group
* (required) The group name of the item.
* @param string $path
* (required) The path under which this item is stored.
* @param int $componentID
* The optional component ID (so componenets can share the same name space).
*
* @return object The data if present in cache, else null
* @static
......@@ -92,8 +95,10 @@ class CRM_Core_BAO_Cache extends CRM_Core_DAO_Cache {
/**
* Retrieve all items in a group
*
* @param string $group (required) The group name of the item
* @param int $componentID The optional component ID (so componenets can share the same name space)
* @param string $group
* (required) The group name of the item.
* @param int $componentID
* The optional component ID (so componenets can share the same name space).
*
* @return object The data if present in cache, else null
* @static
......@@ -131,10 +136,14 @@ class CRM_Core_BAO_Cache extends CRM_Core_DAO_Cache {
/**
* Store an item in the DB cache
*
* @param object $data (required) A reference to the data that will be serialized and stored
* @param string $group (required) The group name of the item
* @param string $path (required) The path under which this item is stored
* @param int $componentID The optional component ID (so componenets can share the same name space)
* @param object $data
* (required) A reference to the data that will be serialized and stored.
* @param string $group
* (required) The group name of the item.
* @param string $path
* (required) The path under which this item is stored.
* @param int $componentID
* The optional component ID (so componenets can share the same name space).
*
* @return void
* @static
......@@ -185,8 +194,10 @@ class CRM_Core_BAO_Cache extends CRM_Core_DAO_Cache {
* Delete all the cache elements that belong to a group OR
* delete the entire cache if group is not specified
*
* @param string $group The group name of the entries to be deleted
* @param string $path path of the item that needs to be deleted
* @param string $group
* The group name of the entries to be deleted.
* @param string $path
* Path of the item that needs to be deleted.
* @param bool|\booleab $clearAll clear all caches
*
* @return void
......@@ -225,10 +236,12 @@ class CRM_Core_BAO_Cache extends CRM_Core_DAO_Cache {
* This function takes entries from the session array and stores it in the cache.
* It also deletes the entries from the $_SESSION object (for a smaller session size)
*
* @param array $names Array of session values that should be persisted
* @param array $names
* Array of session values that should be persisted.
* This is either a form name + qfKey or just a form name
* (in the case of profile)
* @param boolean $resetSession Should session state be reset on completion of DB store?
* @param bool $resetSession
* Should session state be reset on completion of DB store?.
*
* @return void
* @static
......@@ -264,7 +277,8 @@ class CRM_Core_BAO_Cache extends CRM_Core_DAO_Cache {
/* Retrieve the session values from the cache and populate the $_SESSION array
*
* @param array $names Array of session values that should be persisted
* @param array $names
* Array of session values that should be persisted.
* This is either a form name + qfKey or just a form name
* (in the case of profile)
*
......
......@@ -44,7 +44,8 @@ class CRM_Core_BAO_ConfigSetting {
* Create civicrm settings. This is the same as add but it clears the cache and
* reloads the config object
*
* @param array $params associated array of civicrm variables
* @param array $params
* Associated array of civicrm variables.
*
* @return null
* @static
......@@ -60,7 +61,8 @@ class CRM_Core_BAO_ConfigSetting {
/**
* Add civicrm settings
*
* @param array $params associated array of civicrm variables
* @param array $params
* Associated array of civicrm variables.
*
* @return null
* @static
......@@ -141,7 +143,8 @@ class CRM_Core_BAO_ConfigSetting {
/**
* Fix civicrm setting variables
*
* @param array $params associated array of civicrm variables
* @param array $params
* Associated array of civicrm variables.
*
* @return null
* @static
......@@ -173,8 +176,10 @@ class CRM_Core_BAO_ConfigSetting {
/**
* Format the array containing before inserting in db
*
* @param array $params associated array of civicrm variables(submitted)
* @param array $values associated array of civicrm variables stored in db
* @param array $params
* Associated array of civicrm variables(submitted).
* @param array $values
* Associated array of civicrm variables stored in db.
*
* @return null
* @static
......@@ -652,7 +657,8 @@ WHERE option_group_id = (
* Takes a componentName and enables it in the config
* Primarily used during unit testing
*
* @param string $componentName name of the component to be enabled, needs to be valid
* @param string $componentName
* Name of the component to be enabled, needs to be valid.
*
* @return boolean - true if valid component name and enabling succeeds, else false
* @static
......
This diff is collapsed.
This diff is collapsed.
......@@ -42,8 +42,10 @@ class CRM_Core_BAO_CustomOption {
/**
* 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