From 6a0b768e17b6b5271ee014b4ac30066376de1f52 Mon Sep 17 00:00:00 2001 From: Tim Otten Date: Tue, 6 Jan 2015 11:41:07 -0800 Subject: [PATCH] INFRA-132 - CRM/Core - Convert single-line @param to multi-line --- CRM/Core/Action.php | 33 ++- CRM/Core/BAO/ActionSchedule.php | 27 +- CRM/Core/BAO/Address.php | 78 +++-- CRM/Core/BAO/Block.php | 42 ++- CRM/Core/BAO/CMSUser.php | 24 +- CRM/Core/BAO/Cache.php | 42 ++- CRM/Core/BAO/ConfigSetting.php | 18 +- CRM/Core/BAO/CustomField.php | 168 +++++++---- CRM/Core/BAO/CustomGroup.php | 165 +++++++---- CRM/Core/BAO/CustomOption.php | 21 +- CRM/Core/BAO/CustomQuery.php | 5 +- CRM/Core/BAO/CustomValue.php | 15 +- CRM/Core/BAO/CustomValueTable.php | 12 +- CRM/Core/BAO/Dashboard.php | 33 ++- CRM/Core/BAO/Discount.php | 15 +- CRM/Core/BAO/Domain.php | 9 +- CRM/Core/BAO/Email.php | 18 +- CRM/Core/BAO/EntityTag.php | 47 ++- CRM/Core/BAO/Extension.php | 18 +- CRM/Core/BAO/File.php | 18 +- CRM/Core/BAO/FinancialTrxn.php | 33 ++- CRM/Core/BAO/IM.php | 9 +- CRM/Core/BAO/Job.php | 18 +- CRM/Core/BAO/LabelFormat.php | 55 ++-- CRM/Core/BAO/Location.php | 30 +- CRM/Core/BAO/LocationType.php | 18 +- CRM/Core/BAO/Log.php | 3 +- CRM/Core/BAO/MailSettings.php | 15 +- CRM/Core/BAO/Mapping.php | 51 ++-- CRM/Core/BAO/MessageTemplate.php | 20 +- CRM/Core/BAO/Navigation.php | 78 +++-- CRM/Core/BAO/Note.php | 75 +++-- CRM/Core/BAO/OpenID.php | 12 +- CRM/Core/BAO/OptionGroup.php | 24 +- CRM/Core/BAO/OptionValue.php | 45 ++- CRM/Core/BAO/PaperSize.php | 37 ++- CRM/Core/BAO/PdfFormat.php | 37 ++- CRM/Core/BAO/Persistent.php | 12 +- CRM/Core/BAO/Phone.php | 15 +- CRM/Core/BAO/PreferencesDate.php | 14 +- CRM/Core/BAO/PrevNextCache.php | 9 +- CRM/Core/BAO/RecurringEntity.php | 108 ++++--- CRM/Core/BAO/SchemaHandler.php | 3 +- CRM/Core/BAO/Setting.php | 69 +++-- CRM/Core/BAO/Tag.php | 36 ++- CRM/Core/BAO/UFField.php | 84 ++++-- CRM/Core/BAO/UFGroup.php | 273 ++++++++++++------ CRM/Core/BAO/UFJoin.php | 9 +- CRM/Core/BAO/UFMatch.php | 45 ++- CRM/Core/BAO/Website.php | 15 +- CRM/Core/BAO/WordReplacement.php | 15 +- CRM/Core/Block.php | 27 +- CRM/Core/ClassLoader.php | 3 +- CRM/Core/CodeGen/Config.php | 3 +- CRM/Core/CodeGen/ITask.php | 3 +- CRM/Core/CodeGen/Specification.php | 3 +- CRM/Core/CodeGen/Util/File.php | 6 +- CRM/Core/CodeGen/Util/Template.php | 12 +- CRM/Core/CodeGen/Util/Xml.php | 3 +- CRM/Core/Component.php | 3 +- CRM/Core/Component/Info.php | 9 +- CRM/Core/Config.php | 14 +- CRM/Core/Config/Defaults.php | 3 +- CRM/Core/Controller.php | 30 +- CRM/Core/Controller/Simple.php | 8 +- CRM/Core/DAO.php | 187 ++++++++---- CRM/Core/Error.php | 58 ++-- CRM/Core/Exception.php | 9 +- CRM/Core/FileSearchInterface.php | 3 +- CRM/Core/Form.php | 106 ++++--- CRM/Core/Form/Date.php | 46 +-- CRM/Core/Form/RecurringEntity.php | 3 +- CRM/Core/Form/Renderer.php | 30 +- CRM/Core/Form/Tag.php | 33 ++- CRM/Core/HTMLInputCoder.php | 3 +- CRM/Core/I18n.php | 38 ++- CRM/Core/I18n/Schema.php | 51 ++-- CRM/Core/IDS.php | 3 +- CRM/Core/InnoDBIndexer.php | 8 +- CRM/Core/Invoke.php | 15 +- CRM/Core/Key.php | 3 +- CRM/Core/Lock.php | 9 +- CRM/Core/ManagedEntities.php | 15 +- CRM/Core/Menu.php | 12 +- CRM/Core/OptionGroup.php | 65 +++-- CRM/Core/OptionValue.php | 42 ++- CRM/Core/Page.php | 26 +- CRM/Core/Page/AJAX.php | 18 +- CRM/Core/Page/Basic.php | 42 ++- CRM/Core/Page/Redirect.php | 15 +- CRM/Core/Payment.php | 23 +- CRM/Core/Payment/AuthorizeNet.php | 40 ++- CRM/Core/Payment/AuthorizeNetIPN.php | 15 +- CRM/Core/Payment/BaseIPN.php | 34 ++- CRM/Core/Payment/Dummy.php | 9 +- CRM/Core/Payment/Elavon.php | 9 +- CRM/Core/Payment/FirstData.php | 9 +- CRM/Core/Payment/Form.php | 15 +- CRM/Core/Payment/Google.php | 21 +- CRM/Core/Payment/GoogleIPN.php | 30 +- CRM/Core/Payment/IATS.php | 6 +- CRM/Core/Payment/Moneris.php | 9 +- CRM/Core/Payment/PayJunction.php | 12 +- CRM/Core/Payment/PayPalImpl.php | 18 +- CRM/Core/Payment/PayPalProIPN.php | 23 +- CRM/Core/Payment/PayflowPro.php | 15 +- CRM/Core/Payment/PaymentExpress.php | 12 +- CRM/Core/Payment/PaymentExpressIPN.php | 15 +- CRM/Core/Payment/Realex.php | 15 +- CRM/Core/Payment/eWAY.php | 9 +- CRM/Core/Permission.php | 30 +- CRM/Core/Permission/Base.php | 48 ++- CRM/Core/Permission/Drupal.php | 9 +- CRM/Core/Permission/Drupal6.php | 12 +- CRM/Core/Permission/Drupal8.php | 3 +- CRM/Core/Permission/DrupalBase.php | 21 +- CRM/Core/Permission/Joomla.php | 6 +- CRM/Core/Permission/Soap.php | 3 +- CRM/Core/Permission/UnitTests.php | 12 +- CRM/Core/Permission/WordPress.php | 3 +- CRM/Core/PseudoConstant.php | 89 +++--- CRM/Core/QuickForm/Action.php | 3 +- CRM/Core/QuickForm/Action/Back.php | 9 +- CRM/Core/QuickForm/Action/Cancel.php | 9 +- CRM/Core/QuickForm/Action/Display.php | 15 +- CRM/Core/QuickForm/Action/Done.php | 3 +- CRM/Core/QuickForm/Action/Jump.php | 9 +- CRM/Core/QuickForm/Action/Next.php | 9 +- CRM/Core/QuickForm/Action/Process.php | 9 +- CRM/Core/QuickForm/Action/Refresh.php | 9 +- CRM/Core/QuickForm/Action/Reload.php | 9 +- CRM/Core/QuickForm/Action/Submit.php | 9 +- CRM/Core/QuickForm/Action/Upload.php | 27 +- CRM/Core/QuickForm/NestedAdvMultiSelect.php | 12 +- CRM/Core/Reference/Dynamic.php | 3 +- CRM/Core/Reference/Interface.php | 6 +- CRM/Core/Region.php | 21 +- CRM/Core/Report/Excel.php | 27 +- CRM/Core/Resources.php | 96 ++++-- CRM/Core/SelectValues.php | 4 +- CRM/Core/Selector/API.php | 28 +- CRM/Core/Selector/Base.php | 7 +- CRM/Core/Selector/Controller.php | 22 +- CRM/Core/Session.php | 63 ++-- CRM/Core/ShowHideBlocks.php | 51 ++-- CRM/Core/Smarty.php | 11 +- CRM/Core/Smarty/plugins/block.crmRegion.php | 9 +- CRM/Core/Smarty/plugins/block.crmScope.php | 9 +- CRM/Core/Smarty/plugins/block.edit.php | 9 +- CRM/Core/Smarty/plugins/block.htxt.php | 9 +- CRM/Core/Smarty/plugins/block.localize.php | 9 +- CRM/Core/Smarty/plugins/block.serialize.php | 9 +- CRM/Core/Smarty/plugins/block.ts.php | 9 +- .../Smarty/plugins/function.crmAttributes.php | 3 +- .../Smarty/plugins/function.crmCrudLink.php | 3 +- CRM/Core/Smarty/plugins/function.crmKey.php | 6 +- .../plugins/function.crmNavigationMenu.php | 3 +- .../Smarty/plugins/function.crmResURL.php | 3 +- .../Smarty/plugins/function.crmScript.php | 3 +- .../Smarty/plugins/function.crmSigner.php | 3 +- CRM/Core/Smarty/plugins/function.crmStyle.php | 3 +- CRM/Core/Smarty/plugins/function.docURL.php | 6 +- CRM/Core/Smarty/plugins/function.help.php | 6 +- .../Smarty/plugins/function.isValueChange.php | 6 +- .../Smarty/plugins/function.sectionTotal.php | 6 +- .../function.simpleActivityContacts.php | 3 +- .../Smarty/plugins/modifier.crmAddClass.php | 6 +- CRM/Core/Smarty/plugins/modifier.crmDate.php | 3 +- .../Smarty/plugins/modifier.crmDelete.php | 6 +- .../Smarty/plugins/modifier.crmFirstWord.php | 3 +- .../Smarty/plugins/modifier.crmInsert.php | 12 +- CRM/Core/Smarty/plugins/modifier.crmMoney.php | 6 +- .../plugins/modifier.crmNumberFormat.php | 12 +- .../Smarty/plugins/modifier.crmReplace.php | 9 +- .../plugins/modifier.crmStripAlternatives.php | 3 +- CRM/Core/Smarty/plugins/modifier.htmlize.php | 3 +- .../Smarty/plugins/modifier.mb_truncate.php | 4 +- .../Smarty/plugins/modifier.substring.php | 2 +- CRM/Core/State.php | 15 +- CRM/Core/StateMachine.php | 36 ++- CRM/Core/Transaction.php | 18 +- 181 files changed, 2866 insertions(+), 1477 deletions(-) diff --git a/CRM/Core/Action.php b/CRM/Core/Action.php index 6c505b1797..832cb52d90 100644 --- a/CRM/Core/Action.php +++ b/CRM/Core/Action.php @@ -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 diff --git a/CRM/Core/BAO/ActionSchedule.php b/CRM/Core/BAO/ActionSchedule.php index 36b06c0fbf..762063f1d6 100644 --- a/CRM/Core/BAO/ActionSchedule.php +++ b/CRM/Core/BAO/ActionSchedule.php @@ -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 diff --git a/CRM/Core/BAO/Address.php b/CRM/Core/BAO/Address.php index 1726d4c040..e241c59009 100644 --- a/CRM/Core/BAO/Address.php +++ b/CRM/Core/BAO/Address.php @@ -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 */ diff --git a/CRM/Core/BAO/Block.php b/CRM/Core/BAO/Block.php index 034846cad7..461b22428a 100644 --- a/CRM/Core/BAO/Block.php +++ b/CRM/Core/BAO/Block.php @@ -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 diff --git a/CRM/Core/BAO/CMSUser.php b/CRM/Core/BAO/CMSUser.php index 5113034ff1..cdaebe3a51 100644 --- a/CRM/Core/BAO/CMSUser.php +++ b/CRM/Core/BAO/CMSUser.php @@ -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 * diff --git a/CRM/Core/BAO/Cache.php b/CRM/Core/BAO/Cache.php index 9892961e59..31776e24eb 100644 --- a/CRM/Core/BAO/Cache.php +++ b/CRM/Core/BAO/Cache.php @@ -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) * diff --git a/CRM/Core/BAO/ConfigSetting.php b/CRM/Core/BAO/ConfigSetting.php index 86b02406e4..48be9c9b49 100644 --- a/CRM/Core/BAO/ConfigSetting.php +++ b/CRM/Core/BAO/ConfigSetting.php @@ -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 diff --git a/CRM/Core/BAO/CustomField.php b/CRM/Core/BAO/CustomField.php index acabbf47d3..fb78197550 100644 --- a/CRM/Core/BAO/CustomField.php +++ b/CRM/Core/BAO/CustomField.php @@ -125,7 +125,8 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { * * 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 array $params + * (reference) an assoc array of name/value pairs. * * @return CRM_Core_DAO_CustomField object * @static @@ -313,8 +314,10 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { /** * 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_Core_DAO_CustomField object * @static @@ -326,8 +329,10 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { /** * 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 * @@ -345,7 +350,8 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { /** * Get the field title. * - * @param int $id id of field. + * @param int $id + * Id of field. * * @return string name * @@ -359,14 +365,22 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { /** * Store and return an array of all active custom fields. * - * @param string $customDataType type of Custom Data; empty is a synonym for "all contact data types" - * @param boolean $showAll If true returns all fields (includes disabled fields) - * @param boolean $inline If true returns all inline fields (includes disabled fields) - * @param int $customDataSubType Custom Data sub type value - * @param int $customDataSubName Custom Data sub name value - * @param boolean $onlyParent return only top level custom data, for eg, only Participant and ignore subname and subtype - * @param boolean $onlySubType return only custom data for subtype - * @param boolean $checkPermission if false, do not include permissioning clause + * @param string $customDataType + * Type of Custom Data; empty is a synonym for "all contact data types". + * @param bool $showAll + * If true returns all fields (includes disabled fields). + * @param bool $inline + * If true returns all inline fields (includes disabled fields). + * @param int $customDataSubType + * Custom Data sub type value. + * @param int $customDataSubName + * Custom Data sub name value. + * @param bool $onlyParent + * Return only top level custom data, for eg, only Participant and ignore subname and subtype. + * @param bool $onlySubType + * Return only custom data for subtype. + * @param bool $checkPermission + * If false, do not include permissioning clause. * * @return array $fields - an array of active custom fields. * @@ -579,10 +593,14 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { * Return the field ids and names (with groups) for import purpose. * * @param int|string $contactType Contact type - * @param boolean $showAll If true returns all fields (includes disabled fields) - * @param boolean $onlyParent return fields ONLY related to basic types - * @param boolean $search when called from search and multiple records need to be returned - * @param boolean $checkPermission if false, do not include permissioning clause + * @param bool $showAll + * If true returns all fields (includes disabled fields). + * @param bool $onlyParent + * Return fields ONLY related to basic types. + * @param bool $search + * When called from search and multiple records need to be returned. + * @param bool $checkPermission + * If false, do not include permissioning clause. * * @param bool $withMultiple * @@ -649,7 +667,8 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { /** * Get the field id from an import key * - * @param string $key The key to parse + * @param string $key + * The key to parse. * * @param bool $all * @return int|null The id (if exists) @@ -674,7 +693,8 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { /** * Use the cache to get all values of a specific custom field * - * @param int $fieldID the custom field ID + * @param int $fieldID + * The custom field ID. * * @return CRM_Core_DAO_CustomField $field the field object * @static @@ -708,13 +728,19 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { /** * This function for building custom fields * - * @param CRM_Core_Form $qf form object (reference) - * @param string $elementName name of the custom field + * @param CRM_Core_Form $qf + * Form object (reference). + * @param string $elementName + * Name of the custom field. * @param int $fieldId - * @param boolean $inactiveNeeded -deprecated - * @param bool $useRequired true if required else false - * @param boolean $search true if used for search else false - * @param string $label label for custom field + * @param bool $inactiveNeeded + * -deprecated. + * @param bool $useRequired + * True if required else false. + * @param bool $search + * True if used for search else false. + * @param string $label + * Label for custom field. * * @static */ @@ -1034,7 +1060,8 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { /** * Delete the Custom Field. * - * @param object $field - the field object + * @param object $field + * The field object. * * @return boolean * @@ -1065,9 +1092,12 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { * Given a custom field value, its id and the set of options * find the display value for this field * - * @param mixed $value the custom field value - * @param int $id the custom field id - * @param int $options the assoc array of option name/value pairs + * @param mixed $value + * The custom field value. + * @param int $id + * The custom field id. + * @param int $options + * The assoc array of option name/value pairs. * * @param int $contactID * @param int $fieldID @@ -1301,12 +1331,18 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { /** * Set default values for custom data used in profile * - * @param int $customFieldId custom field id - * @param string $elementName custom field name - * @param array $defaults associated array of fields - * @param int $contactId contact id - * @param int $mode profile mode - * @param mixed $value if passed - dont fetch value from db, + * @param int $customFieldId + * Custom field id. + * @param string $elementName + * Custom field name. + * @param array $defaults + * Associated array of fields. + * @param int $contactId + * Contact id. + * @param int $mode + * Profile mode. + * @param mixed $value + * If passed - dont fetch value from db,. * just format the given value * * @static @@ -1502,15 +1538,24 @@ class CRM_Core_BAO_CustomField extends CRM_Core_DAO_CustomField { /** * Format custom fields before inserting * - * @param int $customFieldId custom field id - * @param array $customFormatted formatted array - * @param mix $value value of custom field - * @param string $customFieldExtend custom field extends - * @param int $customValueId custom option value id - * @param int $entityId entity id (contribution, membership...) - * @param boolean $inline consider inline custom groups only - * @param boolean $checkPermission if false, do not include permissioning clause - * @param boolean $includeViewOnly if true, fields marked 'View Only' are included. Required for APIv3. + * @param int $customFieldId + * Custom field id. + * @param array $customFormatted + * Formatted array. + * @param mix $value + * Value of custom field. + * @param string $customFieldExtend + * Custom field extends. + * @param int $customValueId + * Custom option value id. + * @param int $entityId + * Entity id (contribution, membership...). + * @param bool $inline + * Consider inline custom groups only. + * @param bool $checkPermission + * If false, do not include permissioning clause. + * @param bool $includeViewOnly + * If true, fields marked 'View Only' are included. Required for APIv3. * * @return array $customFormatted formatted custom field array * @static @@ -1854,8 +1899,10 @@ SELECT $columnName /** * Determine whether it would be safe to move a field * - * @param int $fieldID FK to civicrm_custom_field - * @param int $newGroupID FK to civicrm_custom_group + * @param int $fieldID + * FK to civicrm_custom_field. + * @param int $newGroupID + * FK to civicrm_custom_group. * * @return array( string) or TRUE @@ -1938,8 +1985,10 @@ WHERE id IN ( %1, %2 ) /** * Move a custom data field from one group (table) to another * - * @param int $fieldID FK to civicrm_custom_field - * @param int $newGroupID FK to civicrm_custom_group + * @param int $fieldID + * FK to civicrm_custom_field. + * @param int $newGroupID + * FK to civicrm_custom_group. * * @return void */ @@ -1982,8 +2031,10 @@ WHERE id IN ( %1, %2 ) /** * Get the database table name and column name for a custom field * - * @param int $fieldID - the fieldID of the custom field - * @param boolean $force - force the sql to be run again (primarily used for tests) + * @param int $fieldID + * The fieldID of the custom field. + * @param bool $force + * Force the sql to be run again (primarily used for tests). * * @return array - fatal is fieldID does not exists, else array of tableName, columnName * @static @@ -2015,7 +2066,8 @@ AND cf.id = %1"; /** * Get custom option groups * - * @param array $includeFieldIds ids of custom fields for which + * @param array $includeFieldIds + * Ids of custom fields for which. * option groups must be included. * * Currently this is required in the cases where option groups are to be included @@ -2061,8 +2113,10 @@ INNER JOIN civicrm_custom_field f ON ( g.id = f.option_group_id ) /** * Fix orphan groups * - * @param int $customFieldId custom field id - * @param int $optionGroupId option group id + * @param int $customFieldId + * Custom field id. + * @param int $optionGroupId + * Option group id. * * @return void * @static @@ -2088,7 +2142,8 @@ INNER JOIN civicrm_custom_field f ON ( g.id = f.option_group_id ) * Check if option group is related to more than one * custom field * - * @param int $optionGroupId option group id + * @param int $optionGroupId + * Option group id. * * @return void * @static @@ -2319,7 +2374,8 @@ WHERE f.id IN ($ids)"; /** * Validate custom data. * - * @param array $params custom data submitted. + * @param array $params + * Custom data submitted. * ie array( 'custom_1' => 'validate me' ); * * @return array $errors validation errors. diff --git a/CRM/Core/BAO/CustomGroup.php b/CRM/Core/BAO/CustomGroup.php index 6a3f5aa162..be7850a27c 100644 --- a/CRM/Core/BAO/CustomGroup.php +++ b/CRM/Core/BAO/CustomGroup.php @@ -51,7 +51,8 @@ class CRM_Core_BAO_CustomGroup extends CRM_Core_DAO_CustomGroup { * * 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 array $params + * (reference) an assoc array of name/value pairs. * * @return CRM_Core_DAO_CustomGroup object * @static @@ -225,8 +226,10 @@ class CRM_Core_BAO_CustomGroup extends CRM_Core_DAO_CustomGroup { /** * 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_Core_DAO_CustomGroup object * @static @@ -238,8 +241,10 @@ class CRM_Core_BAO_CustomGroup extends CRM_Core_DAO_CustomGroup { /** * 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 boolean $is_active + * Value we want to set the is_active field. * * @return Object DAO object on sucess, null otherwise * @static @@ -258,9 +263,12 @@ class CRM_Core_BAO_CustomGroup extends CRM_Core_DAO_CustomGroup { /** * Determine if given entity (sub)type has any custom groups * - * @param string $extends e.g. "Individual", "Activity" - * @param int $columnId e.g. custom-group matching mechanism (usu NULL for matching on sub type-id); see extends_entity_column_id - * @param string $columnValue e.g. "Student" or "3" or "3\05"; see extends_entity_column_value + * @param string $extends + * E.g. "Individual", "Activity". + * @param int $columnId + * E.g. custom-group matching mechanism (usu NULL for matching on sub type-id); see extends_entity_column_id. + * @param string $columnValue + * E.g. "Student" or "3" or "3\05"; see extends_entity_column_value. * * @return bool */ @@ -308,8 +316,10 @@ class CRM_Core_BAO_CustomGroup extends CRM_Core_DAO_CustomGroup { * * An array containing all custom groups and their custom fields is returned. * - * @param string $entityType - of the contact whose contact type is needed - * @param CRM_Core_Form $form - not used but required + * @param string $entityType + * Of the contact whose contact type is needed. + * @param CRM_Core_Form $form + * Not used but required. * @param int $entityID * @param int $groupID * @param string $subType @@ -636,8 +646,10 @@ ORDER BY civicrm_custom_group.weight, * Check whether the custom group has any data for the given entity. * * - * @param integer $entityID id of entity for whom we are checking data for - * @param string $table table that we are checking + * @param int $entityID + * Id of entity for whom we are checking data for. + * @param string $table + * Table that we are checking. * * @param bool $getCount * @@ -663,10 +675,14 @@ ORDER BY civicrm_custom_group.weight, * multiple fields. These now have a new behaviour (one at a time) but the single fields still use this * mechanism as it seemed to be acceptable in this context * - * @param array $groupTree (reference) group tree array which is being built - * @param integer $entityID id of entity for whom the tree is being build up. - * @param array $entitySingleSelectClauses array of select clauses relevant to the entity - * @param array $singleFieldTablesWithEntityData array of tables in which this entity has data + * @param array $groupTree + * (reference) group tree array which is being built. + * @param int $entityID + * Id of entity for whom the tree is being build up. + * @param array $entitySingleSelectClauses + * Array of select clauses relevant to the entity. + * @param array $singleFieldTablesWithEntityData + * Array of tables in which this entity has data. */ static public function buildEntityTreeSingleFields(&$groupTree, $entityID, $entitySingleSelectClauses, $singleFieldTablesWithEntityData) { $select = implode(', ', $entitySingleSelectClauses); @@ -688,10 +704,14 @@ ORDER BY civicrm_custom_group.weight, * * This is done one table at a time to avoid Cross-Joins resulting in too many rows being returned * - * @param array $groupTree (reference) group tree array which is being built - * @param integer $entityID id of entity for whom the tree is being build up. - * @param array $entityMultipleSelectClauses array of select clauses relevant to the entity - * @param array $multipleFieldTablesWithEntityData array of tables in which this entity has data + * @param array $groupTree + * (reference) group tree array which is being built. + * @param int $entityID + * Id of entity for whom the tree is being build up. + * @param array $entityMultipleSelectClauses + * Array of select clauses relevant to the entity. + * @param array $multipleFieldTablesWithEntityData + * Array of tables in which this entity has data. */ static public function buildEntityTreeMultipleFields(&$groupTree, $entityID, $entityMultipleSelectClauses, $multipleFieldTablesWithEntityData) { foreach ($entityMultipleSelectClauses as $table => $selectClauses) { @@ -711,9 +731,11 @@ ORDER BY civicrm_custom_group.weight, * * This function represents shared code between the buildEntityTreeMultipleFields & the buildEntityTreeSingleFields function * - * @param array $groupTree (reference) group tree array which is being built + * @param array $groupTree + * (reference) group tree array which is being built. * @param string $query - * @param array $includedTables tables to include - required because the function (for historical reasons) + * @param array $includedTables + * Tables to include - required because the function (for historical reasons). * iterates through the group tree */ static public function buildTreeEntityDataFromQuery(&$groupTree, $query, $includedTables) { @@ -740,11 +762,16 @@ ORDER BY civicrm_custom_group.weight, /** * Build the entity-specific custom data into the group tree on a per-field basis * - * @param object $dao object representing the custom field to be populated into the groupTree - * @param array $groupTree (reference) the group tree being build - * @param string $table table name - * @param unknown_type $groupID custom group ID - * @param unknown_type $fieldID custom field ID + * @param object $dao + * Object representing the custom field to be populated into the groupTree. + * @param array $groupTree + * (reference) the group tree being build. + * @param string $table + * Table name. + * @param unknown_type $groupID + * Custom group ID. + * @param unknown_type $fieldID + * Custom field ID. */ static public function buildCustomFieldData($dao, &$groupTree, $table, $groupID, $fieldID) { $column = $groupTree[$groupID]['fields'][$fieldID]['column_name']; @@ -844,7 +871,8 @@ ORDER BY civicrm_custom_group.weight, /** * Get the group title. * - * @param int $id id of group. + * @param int $id + * Id of group. * * @return string title * @@ -860,9 +888,12 @@ ORDER BY civicrm_custom_group.weight, * * An array containing custom group details (including their custom field) is returned. * - * @param int $groupId - group id whose details are needed - * @param boolean $searchable - is this field searchable - * @param array $extends - which table does it extend if any + * @param int $groupId + * Group id whose details are needed. + * @param bool $searchable + * Is this field searchable. + * @param array $extends + * Which table does it extend if any. * * @param null $inSelector * @@ -1063,7 +1094,8 @@ ORDER BY civicrm_custom_group.weight, * currently if entity type is 'Contact', 'Individual', 'Household', 'Organization' * tableName is 'civicrm_contact' * - * @param string $entityType what entity are we extending here ? + * @param string $entityType + * What entity are we extending here ?. * * @return string $tableName * @@ -1124,7 +1156,8 @@ ORDER BY civicrm_custom_group.weight, * If there are custom-groups which only apply to certain subtypes, * those WILL be included. * - * @param $entityType string + * @param $entityType + * String. * * @return CRM_Core_DAO_CustomGroup */ @@ -1139,7 +1172,8 @@ ORDER BY civicrm_custom_group.weight, * the custom group is extending. * * @param $customGroupDAO - * @param string $entityType - what entity are we extending here ? + * @param string $entityType + * What entity are we extending here ?. * * @param object CRM_Core_DAO_CustomGroup (reference) - Custom Group DAO. * @param bool $allSubtypes @@ -1206,8 +1240,10 @@ ORDER BY civicrm_custom_group.weight, /** * Delete the Custom Group. * - * @param $group object the DAO custom group object - * @param $force boolean whether to force the deletion, even if there are custom fields + * @param $group + * Object the DAO custom group object. + * @param $force + * Boolean whether to force the deletion, even if there are custom fields. * * @return boolean false if field exists for this group, true if group gets deleted. * @@ -1513,10 +1549,14 @@ ORDER BY civicrm_custom_group.weight, /** * Generic function to build all the form elements for a specific group tree * - * @param CRM_Core_Form $form the form object - * @param array $groupTree the group tree object - * @param boolean $inactiveNeeded return inactive custom groups - * @param string $prefix prefix for custom grouptree assigned to template + * @param CRM_Core_Form $form + * The form object. + * @param array $groupTree + * The group tree object. + * @param bool $inactiveNeeded + * Return inactive custom groups. + * @param string $prefix + * Prefix for custom grouptree assigned to template. * * @return void * @static @@ -1549,8 +1589,10 @@ ORDER BY civicrm_custom_group.weight, * Extract the get params from the url, validate * and store it in session * - * @param CRM_Core_Form $form the form object - * @param string $type the type of custom group we are using + * @param CRM_Core_Form $form + * The form object. + * @param string $type + * The type of custom group we are using. * * @return array * @static @@ -1655,8 +1697,10 @@ ORDER BY civicrm_custom_group.weight, * Check the type of custom field type (eg: Used for Individual, Contribution, etc) * this function is used to get the custom fields of a type (eg: Used for Individual, Contribution, etc ) * - * @param int $customFieldId custom field id - * @param array $removeCustomFieldTypes remove custom fields of a type eg: array("Individual") ; + * @param int $customFieldId + * Custom field id. + * @param array $removeCustomFieldTypes + * Remove custom fields of a type eg: array("Individual") ;. * * * @return boolean false if it matches else true @@ -1764,8 +1808,10 @@ SELECT IF( EXISTS(SELECT name FROM civicrm_contact_type WHERE name like %1), 1, /** * Function returns formatted groupTree, sothat form can be easily build in template * - * @param array $groupTree associated array - * @param int $groupCount group count by default 1, but can varry for multiple value custom data + * @param array $groupTree + * Associated array. + * @param int $groupCount + * Group count by default 1, but can varry for multiple value custom data. * @param object form object * * @return array $formattedGroupTree @@ -1834,9 +1880,12 @@ SELECT IF( EXISTS(SELECT name FROM civicrm_contact_type WHERE name like %1), 1, /** * Build custom data view * - * @param CRM_Core_Form $form page object - * @param array $groupTree associated array - * @param boolean $returnCount true if customValue count needs to be returned + * @param CRM_Core_Form $form + * Page object. + * @param array $groupTree + * Associated array. + * @param bool $returnCount + * True if customValue count needs to be returned. * @param int $gID * @param null $prefix * @param int $customValueId @@ -1924,9 +1973,12 @@ SELECT IF( EXISTS(SELECT name FROM civicrm_contact_type WHERE name like %1), 1, /** * Format custom value according to data, view mode * - * @param array $values associated array of custom values - * @param array $field associated array - * @param boolean $dncOptionPerLine true if optionPerLine should not be consider + * @param array $values + * Associated array of custom values. + * @param array $field + * Associated array. + * @param bool $dncOptionPerLine + * True if optionPerLine should not be consider. * * @return array|null|string */ @@ -2158,7 +2210,8 @@ SELECT IF( EXISTS(SELECT name FROM civicrm_contact_type WHERE name like %1), 1, /** * Get the custom group titles by custom field ids. * - * @param array $fieldIds - array of custom field ids. + * @param array $fieldIds + * Array of custom field ids. * * @return array $groupLabels - array consisting of groups and fields labels with ids. */ @@ -2203,7 +2256,8 @@ SELECT civicrm_custom_group.id as groupID, civicrm_custom_group.title as groupT /** * Check whether custom group is empty or not. * - * @param int $gID - custom group id. + * @param int $gID + * Custom group id. * * @return boolean true if empty otherwise false. */ @@ -2230,7 +2284,8 @@ SELECT civicrm_custom_group.id as groupID, civicrm_custom_group.title as groupT /** * Get the list of types for objects that a custom group extends to. * - * @param array $types - var which should have the list appended. + * @param array $types + * Var which should have the list appended. * * @return array of types. */ diff --git a/CRM/Core/BAO/CustomOption.php b/CRM/Core/BAO/CustomOption.php index 9b4c5ecad1..2dd00e5ae0 100644 --- a/CRM/Core/BAO/CustomOption.php +++ b/CRM/Core/BAO/CustomOption.php @@ -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 + * (reference ) an assoc array of name/value pairs. + * @param array $defaults + * (reference ) an assoc array to hold the flattened values. * * @return CRM_Core_BAO_CustomOption object * @static @@ -61,8 +63,10 @@ class CRM_Core_BAO_CustomOption { /** * Returns all active options ordered by weight for a given field * - * @param int $fieldID field whose options are needed - * @param boolean $inactiveNeeded do we need inactive options ? + * @param int $fieldID + * Field whose options are needed. + * @param boolean $inactiveNeeded + * Do we need inactive options ?. * * @return array $customOption all active options for fieldId * @static @@ -106,11 +110,14 @@ class CRM_Core_BAO_CustomOption { * Returns the option label for a custom field with a specific value. Handles all * custom field data and html types * - * @param $fieldId int the custom field ID + * @param $fieldId + * Int the custom field ID. * @pram $value string the value (typically from the DB) of this custom field * @param $value - * @param $htmlType string the html type of the field (optional) - * @param $dataType string the data type of the field (optional) + * @param $htmlType + * String the html type of the field (optional). + * @param $dataType + * String the data type of the field (optional). * * @return string the label to display for this custom field * @static diff --git a/CRM/Core/BAO/CustomQuery.php b/CRM/Core/BAO/CustomQuery.php index 8dc966650e..6cfabd34ee 100644 --- a/CRM/Core/BAO/CustomQuery.php +++ b/CRM/Core/BAO/CustomQuery.php @@ -136,7 +136,8 @@ class CRM_Core_BAO_CustomQuery { * Takes in a set of custom field ids andsets up the data structures to * generate a query * - * @param array $ids the set of custom field ids + * @param array $ids + * The set of custom field ids. * * @param bool $contactSearch * @param array $locationSpecificFields @@ -258,7 +259,7 @@ SELECT label, value * Generate the select clause and the associated tables * for the from clause * - * @param NULL + * @param NULL * * @return void */ diff --git a/CRM/Core/BAO/CustomValue.php b/CRM/Core/BAO/CustomValue.php index b667468997..8d7561f39a 100644 --- a/CRM/Core/BAO/CustomValue.php +++ b/CRM/Core/BAO/CustomValue.php @@ -42,8 +42,10 @@ class CRM_Core_BAO_CustomValue extends CRM_Core_DAO { /** * Validate a value against a CustomField type * - * @param string $type The type of the data - * @param string $value The data to be validated + * @param string $type + * The type of the data. + * @param string $value + * The data to be validated. * * @return boolean True if the value is of the specified type * @static @@ -119,7 +121,8 @@ class CRM_Core_BAO_CustomValue extends CRM_Core_DAO { /** * Given a 'civicrm' type string, return the mysql data store area * - * @param string $type the civicrm type string + * @param string $type + * The civicrm type string. * * @return the mysql data store placeholder * @static @@ -190,8 +193,10 @@ class CRM_Core_BAO_CustomValue extends CRM_Core_DAO { /** * Delet option value give an option value and custom group id * - * @param int $customValueID custom value ID - * @param int $customGroupID custom group ID + * @param int $customValueID + * Custom value ID. + * @param int $customGroupID + * Custom group ID. * * @return void * @static diff --git a/CRM/Core/BAO/CustomValueTable.php b/CRM/Core/BAO/CustomValueTable.php index ab1556afeb..a3d59bed39 100644 --- a/CRM/Core/BAO/CustomValueTable.php +++ b/CRM/Core/BAO/CustomValueTable.php @@ -253,7 +253,8 @@ class CRM_Core_BAO_CustomValueTable { /** * Given a field return the mysql data type associated with it * - * @param string $type the civicrm type string + * @param string $type + * The civicrm type string. * * @param int $maxLength * @@ -372,14 +373,17 @@ class CRM_Core_BAO_CustomValueTable { /** * Return an array of all custom values associated with an entity. * - * @param int $entityID Identification number of the entity - * @param string $entityType Type of entity that the entityID corresponds to, specified + * @param int $entityID + * Identification number of the entity. + * @param string $entityType + * Type of entity that the entityID corresponds to, specified. * as a string with format "''". Comma separated * list may be used to specify OR matches. Allowable values * are enumerated types in civicrm_custom_group.extends field. * Optional. Default value assumes entityID references a * contact entity. - * @param array $fieldIDs optional list of fieldIDs that we want to retrieve. If this + * @param array $fieldIDs + * Optional list of fieldIDs that we want to retrieve. If this. * is set the entityType is ignored * * @param bool $formatMultiRecordField diff --git a/CRM/Core/BAO/Dashboard.php b/CRM/Core/BAO/Dashboard.php index 3e092a9501..dedcf89956 100644 --- a/CRM/Core/BAO/Dashboard.php +++ b/CRM/Core/BAO/Dashboard.php @@ -40,7 +40,8 @@ class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard { /** * Add Dashboard * - * @param array $params values + * @param array $params + * Values. * * @static * @@ -57,8 +58,10 @@ class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard { /** * Get the list of dashlets enabled by admin * - * @param boolean $all all or only active - * @param boolean $checkPermission all or only authorized for the current user + * @param bool $all + * All or only active. + * @param bool $checkPermission + * All or only authorized for the current user. * * @return array $widgets array of dashlets * @static @@ -93,10 +96,12 @@ class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard { * Additionlly, initializes the dashboard with defaults if this is the * user's first visit to their dashboard. * - * @param boolean $flatFormat this is true if you want simple associated + * @param bool $flatFormat + * This is true if you want simple associated. * array of all the contact's dashlets whether or not they are enabled. * - * @param integer $contactID provide the dashlets for the contact id + * @param int $contactID + * Provide the dashlets for the contact id. * passed rather than the current user. * * @return array $dashlets array of dashlets @@ -185,7 +190,8 @@ class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard { /** * Check dashlet permission for current user * - * @param string $permission comma separated list + * @param string $permission + * Comma separated list. * @param string $operator * * @return boolean true if use has permission else false @@ -259,7 +265,8 @@ class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard { /** * Get details of each dashlets * - * @param int $dashletID widget ID + * @param int $dashletID + * Widget ID. * * @return array associted array title and content * @static @@ -327,7 +334,8 @@ class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard { /** * Save changes made by use to the Dashlet * - * @param array $columns associated array + * @param array $columns + * Associated array. * * @param int $contactID * @@ -395,7 +403,8 @@ class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard { /** * Add dashlets * - * @param array $params associated array + * @param array $params + * Associated array. * * @return object $dashlet returns dashlet object * @static @@ -510,7 +519,8 @@ class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard { } /** - * @param array $params each item is a spec for a dashlet on the contact's dashboard + * @param array $params + * Each item is a spec for a dashlet on the contact's dashboard. * @return bool */ public static function addContactDashletToDashboard(&$params) { @@ -529,7 +539,8 @@ class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard { /** * Reset dashlet cache * - * @param int $contactID reset cache only for specific contact + * @param int $contactID + * Reset cache only for specific contact. * * @return void * @static diff --git a/CRM/Core/BAO/Discount.php b/CRM/Core/BAO/Discount.php index abe7e25353..0eff753524 100644 --- a/CRM/Core/BAO/Discount.php +++ b/CRM/Core/BAO/Discount.php @@ -67,7 +67,8 @@ class CRM_Core_BAO_Discount extends CRM_Core_DAO_Discount { * discount object. the params array contains 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 object CRM_Core_DAO_Discount object on success, otherwise null * @static @@ -83,8 +84,10 @@ class CRM_Core_BAO_Discount extends CRM_Core_DAO_Discount { * Determine whether the given table/id * has discount associated with it * - * @param integer $entityId entity id to be searched - * @param string $entityTable entity table to be searched + * @param integer $entityId + * Entity id to be searched. + * @param string $entityTable + * Entity table to be searched. * * @return array $optionGroupIDs option group Ids associated with discount * @@ -104,8 +107,10 @@ class CRM_Core_BAO_Discount extends CRM_Core_DAO_Discount { /** * Determine in which discount set the registration date falls * - * @param int $entityID entity id to be searched - * @param string $entityTable entity table to be searched + * @param int $entityID + * Entity id to be searched. + * @param string $entityTable + * Entity table to be searched. * * @return integer $dao->id discount id of the set which matches * the date criteria diff --git a/CRM/Core/BAO/Domain.php b/CRM/Core/BAO/Domain.php index f9b91d60d7..fba2870043 100644 --- a/CRM/Core/BAO/Domain.php +++ b/CRM/Core/BAO/Domain.php @@ -51,8 +51,10 @@ class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain { /** * 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_Core_DAO_Domain object * @static @@ -90,7 +92,8 @@ class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain { * the civicrm_domain.config_backend in multiple domains. When/if config_backend * goes away, this hack should be removed. * - * @param integer $domainID id for domain you want to set as current + * @param int $domainID + * Id for domain you want to set as current. * @deprecated * @see http://issues.civicrm.org/jira/browse/CRM-11204 */ diff --git a/CRM/Core/BAO/Email.php b/CRM/Core/BAO/Email.php index e2045750cc..99015fb0ff 100644 --- a/CRM/Core/BAO/Email.php +++ b/CRM/Core/BAO/Email.php @@ -42,7 +42,8 @@ class CRM_Core_BAO_Email extends CRM_Core_DAO_Email { * Create email address - note that the create function calls 'add' but * has more business logic * - * @param array $params input parameters + * @param array $params + * Input parameters. * * @return object */ @@ -60,7 +61,8 @@ class CRM_Core_BAO_Email extends CRM_Core_DAO_Email { /** * Takes an associative array and adds email * - * @param array $params (reference ) an assoc array of name/value pairs + * @param array $params + * (reference ) an assoc array of name/value pairs. * * @return object CRM_Core_BAO_Email object on success, null otherwise * @static @@ -112,7 +114,8 @@ WHERE contact_id = {$params['contact_id']} * Given the list of params in the params array, fetch the object * and store the values in the values array * - * @param array $entityBlock input parameters to find object + * @param array $entityBlock + * Input parameters to find object. * * @return boolean * @static @@ -124,7 +127,8 @@ WHERE contact_id = {$params['contact_id']} /** * Get all the emails for a specified contact_id, with the primary email being first * - * @param int $id the contact id + * @param int $id + * The contact id. * * @param bool $updateBlankLocInfo * @@ -181,7 +185,8 @@ ORDER BY civicrm_email.is_primary DESC, email_id ASC "; /** * Get all the emails for a specified location_block id, with the primary email 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 email id's @@ -230,7 +235,8 @@ ORDER BY e.is_primary DESC, email_id ASC "; /** * Set / reset hold status for an email * - * @param object $email email object + * @param object $email + * Email object. * * @return void * @static diff --git a/CRM/Core/BAO/EntityTag.php b/CRM/Core/BAO/EntityTag.php index e6b2d4bebb..5be2c20a1d 100644 --- a/CRM/Core/BAO/EntityTag.php +++ b/CRM/Core/BAO/EntityTag.php @@ -40,8 +40,10 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { * Given a contact id, it returns an array of tag id's the * contact belongs to. * - * @param int $entityID id of the entity usually the contactID. - * @param string $entityTable name of the entity table usually 'civicrm_contact' + * @param int $entityID + * Id of the entity usually the contactID. + * @param string $entityTable + * Name of the entity table usually 'civicrm_contact'. * * @return array( ) reference $tag array of category id's the contact belongs to. @@ -69,7 +71,8 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { * 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_Core_BAO_EntityTag object * @static @@ -99,7 +102,8 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { /** * Check if there is data to create the object * - * @param array $params an assoc array of name/value pairs + * @param array $params + * An assoc array of name/value pairs. * * @return boolean * @static @@ -111,7 +115,8 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { /** * Delete the tag for a contact * - * @param array $params (reference ) an assoc array of name/value pairs + * @param array $params + * (reference ) an assoc array of name/value pairs. * * @return CRM_Core_BAO_EntityTag object * @static @@ -130,9 +135,12 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { /** * Given an array of entity ids and entity table, add all the entity to the tags * - * @param array $entityIds (reference ) the array of entity ids to be added - * @param int $tagId the id of the tag - * @param string $entityTable name of entity table default:civicrm_contact + * @param array $entityIds + * (reference ) the array of entity ids to be added. + * @param int $tagId + * The id of the tag. + * @param string $entityTable + * Name of entity table default:civicrm_contact. * * @return array (total, added, notAdded) count of enities added to tag * @static @@ -172,9 +180,12 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { /** * Given an array of entity ids and entity table, remove entity(s) tags * - * @param array $entityIds (reference ) the array of entity ids to be removed - * @param int $tagId the id of the tag - * @param string $entityTable name of entity table default:civicrm_contact + * @param array $entityIds + * (reference ) the array of entity ids to be removed. + * @param int $tagId + * The id of the tag. + * @param string $entityTable + * Name of entity table default:civicrm_contact. * * @return array (total, removed, notRemoved) count of entities removed from tags * @static @@ -214,7 +225,8 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { /** * Takes an associative array and creates tag entity record for all tag entities * - * @param array $params (reference) an assoc array of name/value pairs + * @param array $params + * (reference) an assoc array of name/value pairs. * @param $entityTable * @param int $entityID * @@ -258,7 +270,8 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { /** * This function returns all entities assigned to a specific tag * - * @param object $tag an object of a tag. + * @param object $tag + * An object of a tag. * * @return array $entityIds array of entity ids */ @@ -383,9 +396,11 @@ class CRM_Core_BAO_EntityTag extends CRM_Core_DAO_EntityTag { * 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 */ diff --git a/CRM/Core/BAO/Extension.php b/CRM/Core/BAO/Extension.php index d2f7f991b0..bc785846a9 100644 --- a/CRM/Core/BAO/Extension.php +++ b/CRM/Core/BAO/Extension.php @@ -42,8 +42,10 @@ class CRM_Core_BAO_Extension extends CRM_Core_DAO_Extension { /** * 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_Core_BAO_LocationType object on success, null otherwise * @static @@ -61,7 +63,8 @@ class CRM_Core_BAO_Extension extends CRM_Core_DAO_Extension { /** * Delete an extension * - * @param int $id Id of the extension to be deleted. + * @param int $id + * Id of the extension to be deleted. * * @return void * @@ -76,8 +79,10 @@ class CRM_Core_BAO_Extension extends CRM_Core_DAO_Extension { /** * Change the schema version of an extension * - * @param $fullName string, the fully-qualified name (eg "com.example.myextension") - * @param $schemaVersion string + * @param $fullName + * String, the fully-qualified name (eg "com.example.myextension"). + * @param $schemaVersion + * String. * @return void */ public static function setSchemaVersion($fullName, $schemaVersion) { @@ -92,7 +97,8 @@ class CRM_Core_BAO_Extension extends CRM_Core_DAO_Extension { /** * Determine the schema version of an extension * - * @param $fullName string, the fully-qualified name (eg "com.example.myextension") + * @param $fullName + * String, the fully-qualified name (eg "com.example.myextension"). * @return string */ public static function getSchemaVersion($fullName) { diff --git a/CRM/Core/BAO/File.php b/CRM/Core/BAO/File.php index 19a00907b1..ee584c68a0 100644 --- a/CRM/Core/BAO/File.php +++ b/CRM/Core/BAO/File.php @@ -323,7 +323,8 @@ class CRM_Core_BAO_File extends CRM_Core_DAO_File { } /** - * @param string $entityTable table-name or "*" (to reference files directly by file-id) + * @param string $entityTable + * Table-name or "*" (to reference files directly by file-id). * @param int $entityID * @param int $fileTypeID * @param int $fileID @@ -461,9 +462,12 @@ AND CEF.entity_id = %2"; * Return a clean url string and the number of attachment for a * given entityTable, entityID * - * @param $entityTable string The entityTable to which the file is attached - * @param $entityID int The id of the object in the above entityTable - * @param $separator string The string separator where to implode the urls + * @param $entityTable + * String The entityTable to which the file is attached. + * @param $entityID + * Int The id of the object in the above entityTable. + * @param $separator + * String The string separator where to implode the urls. * * @return array An array with 2 elements. The string and the number of attachments * @static @@ -647,9 +651,11 @@ AND CEF.entity_id = %2"; /** * Display paper icon for a file attachment -- CRM-13624 * - * @param $entityTable string The entityTable to which the file is attached. eg "civicrm_contact", "civicrm_note", "civicrm_activity" + * @param $entityTable + * String The entityTable to which the file is attached. eg "civicrm_contact", "civicrm_note", "civicrm_activity". * If you have the ID of a specific row in civicrm_file, use $entityTable='*' - * @param $entityID int The id of the object in the above entityTable + * @param $entityID + * Int The id of the object in the above entityTable. * * @return array|NULL list of HTML snippets; one HTML snippet for each attachment. If none found, then NULL * diff --git a/CRM/Core/BAO/FinancialTrxn.php b/CRM/Core/BAO/FinancialTrxn.php index 710987e415..ac43f72462 100644 --- a/CRM/Core/BAO/FinancialTrxn.php +++ b/CRM/Core/BAO/FinancialTrxn.php @@ -49,9 +49,11 @@ class CRM_Core_BAO_FinancialTrxn extends CRM_Financial_DAO_FinancialTrxn { /** * Takes an associative array and creates a financial transaction object * - * @param array $params (reference ) an assoc array of name/value pairs + * @param array $params + * (reference ) an assoc array of name/value pairs. * - * @param string $trxnEntityTable entity_table + * @param string $trxnEntityTable + * Entity_table. * * @return CRM_Core_BAO_FinancialTrxn object * @static @@ -120,8 +122,10 @@ class CRM_Core_BAO_FinancialTrxn extends CRM_Financial_DAO_FinancialTrxn { /** * 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_Contribute_BAO_ContributionType object * @static @@ -140,8 +144,10 @@ class CRM_Core_BAO_FinancialTrxn extends CRM_Financial_DAO_FinancialTrxn { * Given an entity_id and entity_table, check for corresponding entity_financial_trxn and financial_trxn record. * NOTE: This should be moved to separate BAO for EntityFinancialTrxn when we start adding more code for that object. * - * @param $entity_id id of the entity usually the contactID. - * @param string $orderBy to get single trxn id for a entity table i.e last or first. + * @param $entity_id + * Id of the entity usually the contactID. + * @param string $orderBy + * To get single trxn id for a entity table i.e last or first. * @param bool $newTrxn * * @return array $tag array of category id's the contact belongs to. @@ -184,7 +190,8 @@ LIMIT 1;"; * Given an entity_id and entity_table, check for corresponding entity_financial_trxn and financial_trxn record. * @todo This should be moved to separate BAO for EntityFinancialTrxn when we start adding more code for that object. * - * @param int $entity_id id of the entity usually the contactID. + * @param int $entity_id + * Id of the entity usually the contactID. * * @return array $tag array of catagory id's the contact belongs to. * @@ -205,7 +212,8 @@ WHERE ft.entity_table = 'civicrm_contribution' AND ft.entity_id = %1 /** * Given an financial_trxn_id check for previous entity_financial_trxn. * - * @param $financial_trxn_id id of the latest payment. + * @param $financial_trxn_id + * Id of the latest payment. * * * @return array $payment array of previous payments @@ -256,8 +264,10 @@ WHERE ef2.financial_trxn_id =%1 * Given an entity_id and entity_table, check for corresponding entity_financial_trxn and financial_trxn record. * NOTE: This should be moved to separate BAO for EntityFinancialTrxn when we start adding more code for that object. * - * @param $entity_id id of the entity usually the contactID. - * @param string $entity_table name of the entity table usually 'civicrm_contact' + * @param $entity_id + * Id of the entity usually the contactID. + * @param string $entity_table + * Name of the entity table usually 'civicrm_contact'. * * @return array $tag array of catagory id's the contact belongs to. * @@ -352,7 +362,8 @@ WHERE ceft.entity_id = %1"; /** * Create financial trxn and items when fee is charged * - * @param array $params to create trxn entries + * @param array $params + * To create trxn entries. * * @static */ diff --git a/CRM/Core/BAO/IM.php b/CRM/Core/BAO/IM.php index 9e4f1757dd..79374fdfe4 100644 --- a/CRM/Core/BAO/IM.php +++ b/CRM/Core/BAO/IM.php @@ -41,7 +41,8 @@ class CRM_Core_BAO_IM extends CRM_Core_DAO_IM { /** * Takes an associative array and adds im * - * @param array $params (reference ) an assoc array of name/value pairs + * @param array $params + * (reference ) an assoc array of name/value pairs. * * @return object CRM_Core_BAO_IM object on success, null otherwise * @static @@ -74,7 +75,8 @@ class CRM_Core_BAO_IM extends CRM_Core_DAO_IM { /** * Get all the ims for a specified contact_id, with the primary im being first * - * @param int $id the contact id + * @param int $id + * The contact id. * * @param bool $updateBlankLocInfo * @@ -125,7 +127,8 @@ ORDER BY /** * Get all the ims for a specified location_block id, with the primary im 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 im details diff --git a/CRM/Core/BAO/Job.php b/CRM/Core/BAO/Job.php index 0161394746..f368db54db 100644 --- a/CRM/Core/BAO/Job.php +++ b/CRM/Core/BAO/Job.php @@ -48,7 +48,8 @@ class CRM_Core_BAO_Job extends CRM_Core_DAO_Job { /** * Add the payment-processor type in the db * - * @param array $params an assoc array of name/value pairs + * @param array $params + * An assoc array of name/value pairs. * * @return CRM_Financial_DAO_PaymentProcessorType * @static @@ -64,8 +65,10 @@ class CRM_Core_BAO_Job extends CRM_Core_DAO_Job { * 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 $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_Core_DAO_Job object on success, null otherwise * @static @@ -83,8 +86,10 @@ class CRM_Core_BAO_Job extends CRM_Core_DAO_Job { /** * 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 * @@ -97,7 +102,8 @@ class CRM_Core_BAO_Job extends CRM_Core_DAO_Job { /** * Function to delete scheduled job * - * @param $jobID ID of the job to be deleted. + * @param $jobID + * ID of the job to be deleted. * * @return bool|null * @static diff --git a/CRM/Core/BAO/LabelFormat.php b/CRM/Core/BAO/LabelFormat.php index d7d9f0c603..0ecd262fd0 100644 --- a/CRM/Core/BAO/LabelFormat.php +++ b/CRM/Core/BAO/LabelFormat.php @@ -172,7 +172,8 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue { /** * Get font names supported by the TCPDF package used to create PDF labels. * - * @param string $name group name + * @param string $name + * Group name. * * @return array array of font names * @static @@ -268,8 +269,9 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue { /** * Add ordering fields to Label Format list * - * @param array (reference) $list List of Label Formats - * @param string $returnURL URL of page calling this function + * @param array (reference) $list List of Label Formats + * @param string $returnURL + * URL of page calling this function. * * @return array (reference) List of Label Formats * @static @@ -282,8 +284,10 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue { /** * Retrieve list of Label Formats. * - * @param bool $namesOnly return simple list of names - * @param string $groupName group name of the label format option group + * @param bool $namesOnly + * Return simple list of names. + * @param string $groupName + * Group name of the label format option group. * * @return array (reference) label format list * @static @@ -312,7 +316,8 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue { /** * Retrieve the default Label Format values * - * @param string $groupName label format group name + * @param string $groupName + * Label format group name. * * @return array Name/value pairs containing the default Label Format values. * @static @@ -333,8 +338,10 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue { /** * Get Label Format from the DB * - * @param string $field Field name to search by - * @param int $val Field value to search for + * @param string $field + * Field name to search by. + * @param int $val + * Field value to search for. * * @param string $groupName * @@ -354,7 +361,8 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue { /** * Get Label Format by Name * - * @param int $name Label format name. Empty = get default label format + * @param int $name + * Label format name. Empty = get default label format. * * @return array $values (reference) associative array of name/value pairs */ @@ -365,8 +373,10 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue { /** * Get Label Format by ID * - * @param int $id label format id. 0 = get default label format - * @param string $groupName group name + * @param int $id + * Label format id. 0 = get default label format. + * @param string $groupName + * Group name. * * @return array $values (reference) associative array of name/value pairs */ @@ -377,7 +387,8 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue { /** * Get Label Format field from associative array * - * @param string $field name of a label format field + * @param string $field + * Name of a label format field. * @param array (reference) $values associative array of name/value pairs containing * label format field selections * @@ -410,8 +421,10 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue { * retrieves the relevant objects. Typically the valid params are only * label id. 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. * * @param string $groupName * @@ -458,9 +471,11 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue { /** * Save the Label Format in the DB * - * @param array (reference) $values associative array of name/value pairs - * @param int $id id of the database record (null = new record) - * @param string $groupName group name of the label format + * @param array (reference) $values associative array of name/value pairs + * @param int $id + * Id of the database record (null = new record). + * @param string $groupName + * Group name of the label format. * * @return void */ @@ -524,8 +539,10 @@ class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue { /** * Delete a Label Format * - * @param int $id ID of the label format to be deleted. - * @param string $groupName group name + * @param int $id + * ID of the label format to be deleted. + * @param string $groupName + * Group name. * @static */ public static function del($id, $groupName) { diff --git a/CRM/Core/BAO/Location.php b/CRM/Core/BAO/Location.php index 7317b02559..541c301b1e 100644 --- a/CRM/Core/BAO/Location.php +++ b/CRM/Core/BAO/Location.php @@ -46,8 +46,10 @@ class CRM_Core_BAO_Location extends CRM_Core_DAO { /** * Create various elements of location block * - * @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 @@ -151,7 +153,8 @@ WHERE e.id = %1"; /** * Takes an associative array and adds location block * - * @param array $params (reference ) an assoc array of name/value pairs + * @param array $params + * (reference ) an assoc array of name/value pairs. * * @return object CRM_Core_BAO_locBlock object on success, null otherwise * @static @@ -167,7 +170,8 @@ WHERE e.id = %1"; /** * Delete the Location Block * - * @param int $locBlockId id of the Location Block + * @param int $locBlockId + * Id of the Location Block. * * @return void * @static @@ -209,7 +213,8 @@ WHERE e.id = %1"; /** * 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 @@ -261,8 +266,10 @@ WHERE e.id = %1"; /** * Delete all the block associated with the location * - * @param int $contactId contact id - * @param int $locationTypeId id of the location to delete + * @param int $contactId + * Contact id. + * @param int $locationTypeId + * Id of the location to delete. * * @return void * @static @@ -294,8 +301,10 @@ WHERE e.id = %1"; /** * Copy or update location block. * - * @param int $locBlockId location block id. - * @param int $updateLocBlockId update location block id + * @param int $locBlockId + * Location block id. + * @param int $updateLocBlockId + * Update location block id. * * @return int newly created/updated location block id. */ @@ -342,7 +351,8 @@ WHERE e.id = %1"; * If contact has data for any location block, make sure * contact should have only one primary block, CRM-5051 * - * @param int $contactId - contact id + * @param int $contactId + * Contact id. * * @static */ diff --git a/CRM/Core/BAO/LocationType.php b/CRM/Core/BAO/LocationType.php index c4f104f1af..3144feabf4 100644 --- a/CRM/Core/BAO/LocationType.php +++ b/CRM/Core/BAO/LocationType.php @@ -50,8 +50,10 @@ class CRM_Core_BAO_LocationType extends CRM_Core_DAO_LocationType { /** * 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_Core_BAO_LocaationType object on success, null otherwise * @static @@ -69,8 +71,10 @@ class CRM_Core_BAO_LocationType extends CRM_Core_DAO_LocationType { /** * 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 * @@ -116,7 +120,8 @@ class CRM_Core_BAO_LocationType extends CRM_Core_DAO_LocationType { /** * Add a Location Type * - * @param array $params reference array contains the values submitted by the form + * @param array $params + * Reference array contains the values submitted by the form. * * @static * @@ -143,7 +148,8 @@ class CRM_Core_BAO_LocationType extends CRM_Core_DAO_LocationType { /** * Delete location Types * - * @param int $locationTypeId ID of the location type to be deleted. + * @param int $locationTypeId + * ID of the location type to be deleted. * * @static */ diff --git a/CRM/Core/BAO/Log.php b/CRM/Core/BAO/Log.php index e5cd6bfa87..89675ee6dc 100644 --- a/CRM/Core/BAO/Log.php +++ b/CRM/Core/BAO/Log.php @@ -69,7 +69,8 @@ class CRM_Core_BAO_Log extends CRM_Core_DAO_Log { /** * Add log to civicrm_log table * - * @param array $params array of name-value pairs of log table. + * @param array $params + * Array of name-value pairs of log table. * * @static */ diff --git a/CRM/Core/BAO/MailSettings.php b/CRM/Core/BAO/MailSettings.php index a0b741641f..83e73fb3f7 100644 --- a/CRM/Core/BAO/MailSettings.php +++ b/CRM/Core/BAO/MailSettings.php @@ -108,8 +108,10 @@ class CRM_Core_BAO_MailSettings extends CRM_Core_DAO_MailSettings { * mail settings id. 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_Core_BAO_MailSettings object * @static @@ -130,7 +132,8 @@ class CRM_Core_BAO_MailSettings extends CRM_Core_DAO_MailSettings { /** * Add new mail Settings. * - * @param array $params reference array contains the values submitted by the form + * @param array $params + * Reference array contains the values submitted by the form. * * @static * @@ -164,7 +167,8 @@ class CRM_Core_BAO_MailSettings extends CRM_Core_DAO_MailSettings { /** * Takes an associative array and creates a mail settings 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_Core_BAO_MailSettings object * @static @@ -186,7 +190,8 @@ class CRM_Core_BAO_MailSettings extends CRM_Core_DAO_MailSettings { /** * Delete the mail settings. * - * @param int $id mail settings id + * @param int $id + * Mail settings id. * * @return mixed|null * @static diff --git a/CRM/Core/BAO/Mapping.php b/CRM/Core/BAO/Mapping.php index 83473b728c..1b1c0bbbf7 100644 --- a/CRM/Core/BAO/Mapping.php +++ b/CRM/Core/BAO/Mapping.php @@ -44,8 +44,10 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { /** * 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 object CRM_Core_DAO_Mapping object on success, otherwise null * @static @@ -63,7 +65,8 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { /** * Delete the mapping * - * @param int $id mapping id + * @param int $id + * Mapping id. * * @return boolean * @static @@ -94,7 +97,8 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { * contact object. the params array could contain additional unused name/value * pairs * - * @param array $params an array of name/value pairs + * @param array $params + * An array of name/value pairs. * * @return object CRM_Core_DAO_Mapper object on success, otherwise null * @static @@ -110,7 +114,8 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { /** * Get the list of mappings * - * @param string $mappingTypeId mapping type id + * @param string $mappingTypeId + * Mapping type id. * * @return array $mapping array of mapping name * @static @@ -131,7 +136,8 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { /** * Get the mapping fields * - * @param int $mappingId mapping id + * @param int $mappingId + * Mapping id. * * @return array $mappingFields array of mapping fields * @static @@ -188,8 +194,10 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { /** * Check Duplicate Mapping Name * - * @param $nameField string mapping Name - * @param $mapTypeId string mapping Type + * @param $nameField + * String mapping Name. + * @param $mapTypeId + * String mapping Type. * * @return boolean */ @@ -203,7 +211,8 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { /** * Function returns associated array of elements, that will be passed for search * - * @param int $smartGroupId smart group id + * @param int $smartGroupId + * Smart group id. * * @return array $returnFields associated array of elements@static */ @@ -233,10 +242,12 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { * Build the mapping form * * @param CRM_Core_Form $form - * @param string $mappingType (Export/Import/Search Builder) + * @param string $mappingType + * (Export/Import/Search Builder). * @param int $mappingId * @param int $columnNo - * @param int $blockCount (no of blocks shown) + * @param int $blockCount + * (no of blocks shown). * @param null $exportMode * * @return void @@ -902,7 +913,8 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { * Function returns all custom fields with group title and * field label * - * @param int $relationshipTypeId related relationship type id + * @param int $relationshipTypeId + * Related relationship type id. * * @return array all custom field titles */ @@ -920,7 +932,8 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { /** * Function returns all Custom group Names * - * @param int $customfieldId related file id + * @param int $customfieldId + * Related file id. * * @return null|string $customGroupName all custom group names@static */ @@ -940,8 +953,10 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { /** * Function returns associated array of elements, that will be passed for search * - * @param array $params associated array of submitted values - * @param bool $row row no of the fields + * @param array $params + * Associated array of submitted values. + * @param bool $row + * Row no of the fields. * * * @return array $returnFields formatted associated array of elements@static @@ -1136,8 +1151,10 @@ class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping { /** * Save the mapping field info for search builder / export given the formvalues * - * @param array $params asscociated array of formvalues - * @param int $mappingId mapping id + * @param array $params + * Asscociated array of formvalues. + * @param int $mappingId + * Mapping id. * * @return null * @static diff --git a/CRM/Core/BAO/MessageTemplate.php b/CRM/Core/BAO/MessageTemplate.php index 0182b2eae1..938aea66b0 100644 --- a/CRM/Core/BAO/MessageTemplate.php +++ b/CRM/Core/BAO/MessageTemplate.php @@ -43,8 +43,10 @@ class CRM_Core_BAO_MessageTemplate extends CRM_Core_DAO_MessageTemplate { /** * 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_Core_BAO_MessageTemplate object * @static @@ -62,8 +64,10 @@ class CRM_Core_BAO_MessageTemplate extends CRM_Core_DAO_MessageTemplate { /** * 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 @@ -75,7 +79,8 @@ class CRM_Core_BAO_MessageTemplate extends CRM_Core_DAO_MessageTemplate { /** * Add the Message Templates * - * @param array $params reference array contains the values submitted by the form + * @param array $params + * Reference array contains the values submitted by the form. * * @static * @@ -270,7 +275,7 @@ class CRM_Core_BAO_MessageTemplate extends CRM_Core_DAO_MessageTemplate { /** * Revert a message template to its default subject+text+HTML state * - * @param integer id id of the template + * @param int id id of the template * * @return void */ @@ -302,7 +307,8 @@ class CRM_Core_BAO_MessageTemplate extends CRM_Core_DAO_MessageTemplate { /** * Send an email from the specified template based on an array of params * - * @param array $params a string-keyed array of function params, see function body for details + * @param array $params + * A string-keyed array of function params, see function body for details. * * @return array of four parameters: a boolean whether the email was sent, and the subject, text and HTML templates */ diff --git a/CRM/Core/BAO/Navigation.php b/CRM/Core/BAO/Navigation.php index 4c8721325d..9dec705973 100644 --- a/CRM/Core/BAO/Navigation.php +++ b/CRM/Core/BAO/Navigation.php @@ -47,8 +47,10 @@ class CRM_Core_BAO_Navigation extends CRM_Core_DAO_Navigation { /** * 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 * @@ -123,8 +125,10 @@ class CRM_Core_BAO_Navigation extends CRM_Core_DAO_Navigation { /** * 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_Core_BAO_Navigation object on success, null otherwise * @static @@ -145,8 +149,10 @@ class CRM_Core_BAO_Navigation extends CRM_Core_DAO_Navigation { /** * Calculate navigation weight * - * @param $parentID parent_id of a menu - * @param $menuID menu id + * @param $parentID + * Parent_id of a menu. + * @param $menuID + * Menu id. * * @return int $weight string@static */ @@ -211,9 +217,12 @@ FROM civicrm_navigation WHERE domain_id = $domainID {$whereClause} ORDER BY pare /** * Helper function for getNavigationList( ) * - * @param array $list menu info - * @param array $navigations navigation menus - * @param string $separator menu separator + * @param array $list + * Menu info. + * @param array $navigations + * Navigation menus. + * @param string $separator + * Menu separator. */ public static function _getNavigationLabel($list, &$navigations, $separator = '') { $i18n = CRM_Core_I18n::singleton(); @@ -232,8 +241,10 @@ FROM civicrm_navigation WHERE domain_id = $domainID {$whereClause} ORDER BY pare /** * Helper function for getNavigationList( ) * - * @param string $val menu name - * @param array $pidGroups parent menus + * @param string $val + * Menu name. + * @param array $pidGroups + * Parent menus. * @return array */ public static function _getNavigationValue($val, &$pidGroups) { @@ -253,9 +264,12 @@ FROM civicrm_navigation WHERE domain_id = $domainID {$whereClause} ORDER BY pare /** * Build navigation tree * - * @param array $navigationTree nested array of menus - * @param int $parentID parent id - * @param boolean $navigationMenu true when called for building top navigation menu + * @param array $navigationTree + * Nested array of menus. + * @param int $parentID + * Parent id. + * @param bool $navigationMenu + * True when called for building top navigation menu. * * @return array $navigationTree nested array of menus * @static @@ -306,8 +320,10 @@ ORDER BY parent_id, weight"; /** * Build menu * - * @param boolean $json by default output is html - * @param boolean $navigationMenu true when called for building top navigation menu + * @param bool $json + * By default output is html. + * @param bool $navigationMenu + * True when called for building top navigation menu. * * @return returns html or json object * @static @@ -372,8 +388,8 @@ ORDER BY parent_id, weight"; * * @param array $value * @param string $navigationString - * @param boolean $json - * @param boolean $skipMenuItems + * @param bool $json + * @param bool $skipMenuItems * @return string */ public static function recurseNavigation(&$value, &$navigationString, $json, $skipMenuItems) { @@ -559,7 +575,8 @@ ORDER BY parent_id, weight"; /** * Create navigation for CiviCRM Admin Menu * - * @param int $contactID contact id + * @param int $contactID + * Contact id. * * @return string $navigation returns navigation html * @static @@ -623,7 +640,8 @@ ORDER BY parent_id, weight"; /** * Reset navigation for all contacts or a specified contact * - * @param integer $contactID - reset only entries belonging to that contact ID + * @param int $contactID + * Reset only entries belonging to that contact ID. * @return string */ public static function resetNavigation($contactID = NULL) { @@ -659,7 +677,8 @@ ORDER BY parent_id, weight"; /** * Process navigation * - * @param array $params associated array, $_GET + * @param array $params + * Associated array, $_GET. * * @return void * @static @@ -693,9 +712,12 @@ ORDER BY parent_id, weight"; /** * Process move action * - * @param $nodeID node that is being moved - * @param $referenceID parent id where node is moved. 0 mean no parent - * @param $position new position of the nod, it starts with 0 - n + * @param $nodeID + * Node that is being moved. + * @param $referenceID + * Parent id where node is moved. 0 mean no parent. + * @param $position + * New position of the nod, it starts with 0 - n. * * @return void * @static @@ -776,7 +798,8 @@ ORDER BY parent_id, weight"; /** * Get the info on navigation item * - * @param int $navigationID navigation id + * @param int $navigationID + * Navigation id. * * @return array associated array * @static @@ -795,8 +818,9 @@ ORDER BY parent_id, weight"; /** * Update menu * - * @param array $params - * @param array $newParams new value of params + * @param array $params + * @param array $newParams + * New value of params. * @static */ public static function processUpdate($params, $newParams) { diff --git a/CRM/Core/BAO/Note.php b/CRM/Core/BAO/Note.php index bc417d76e8..d8ca0704a7 100644 --- a/CRM/Core/BAO/Note.php +++ b/CRM/Core/BAO/Note.php @@ -47,7 +47,8 @@ class CRM_Core_BAO_Note extends CRM_Core_DAO_Note { /** * Given a note id, retrieve the note text * - * @param int $id id of the note to retrieve + * @param int $id + * Id of the note to retrieve. * * @return string the note text or null if note not found * @@ -60,7 +61,8 @@ class CRM_Core_BAO_Note extends CRM_Core_DAO_Note { /** * Given a note id, retrieve the note subject * - * @param int $id id of the note to retrieve + * @param int $id + * Id of the note to retrieve. * * @return string the note subject or null if note not found * @@ -73,7 +75,8 @@ class CRM_Core_BAO_Note extends CRM_Core_DAO_Note { /** * Given a note id, decide if the note should be displayed based on privacy setting * - * @param object $note Either the id of the note to retrieve, or the CRM_Core_DAO_Note object itself + * @param object $note + * Either the id of the note to retrieve, or the CRM_Core_DAO_Note object itself. * * @return boolean TRUE if the note should be displayed, otherwise FALSE * @@ -128,8 +131,10 @@ class CRM_Core_BAO_Note extends CRM_Core_DAO_Note { * note object. the params array could contain additional unused name/value * pairs * - * @param array $params (reference) an assoc array of name/value pairs - * @param array $ids (deprecated) associated array with note id - preferably set $params['id'] + * @param array $params + * (reference) an assoc array of name/value pairs. + * @param array $ids + * (deprecated) associated array with note id - preferably set $params['id']. * * @return object $note CRM_Core_BAO_Note object * @static @@ -215,7 +220,8 @@ class CRM_Core_BAO_Note extends CRM_Core_DAO_Note { /** * 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 @@ -232,9 +238,12 @@ class CRM_Core_BAO_Note extends CRM_Core_DAO_Note { * 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 int $numNotes the maximum number of notes to return (0 if all) + * @param array $params + * Input parameters to find object. + * @param array $values + * Output values of the object. + * @param int $numNotes + * The maximum number of notes to return (0 if all). * * @return object $notes Object of CRM_Core_BAO_Note * @static @@ -275,8 +284,10 @@ class CRM_Core_BAO_Note extends CRM_Core_DAO_Note { /** * Delete the notes * - * @param int $id note id - * @param boolean $showStatus do we need to set status or not + * @param int $id + * Note id. + * @param bool $showStatus + * Do we need to set status or not. * * @return mixed|null $return no of deleted notes on success, false otherwise@access public * @static @@ -324,7 +335,8 @@ class CRM_Core_BAO_Note extends CRM_Core_DAO_Note { /** * Delete all records for this contact id * - * @param int $id ID of the contact for which note needs to be deleted. + * @param int $id + * ID of the contact for which note needs to be deleted. * * @return void * @@ -346,7 +358,8 @@ class CRM_Core_BAO_Note extends CRM_Core_DAO_Note { /** * Retrieve all records for this entity-id * - * @param int $id ID of the relationship for which records needs to be retrieved. + * @param int $id + * ID of the relationship for which records needs to be retrieved. * * @param string $entityTable * @@ -402,9 +415,12 @@ ORDER BY modified_date desc"; /** * Get all descendent notes of the note with given ID * - * @param int $parentId ID of the note to start from - * @param int $maxDepth Maximum number of levels to descend into the tree; if not given, will include all descendents. - * @param bool $snippet If TRUE, returned values will be pre-formatted for display in a table of notes. + * @param int $parentId + * ID of the note to start from. + * @param int $maxDepth + * Maximum number of levels to descend into the tree; if not given, will include all descendents. + * @param bool $snippet + * If TRUE, returned values will be pre-formatted for display in a table of notes. * * @return array Nested associative array beginning with direct children of given note. * @@ -417,7 +433,8 @@ ORDER BY modified_date desc"; /** * Get total count of direct children visible to the current user * - * @param int $id Note ID + * @param int $id + * Note ID. * * @return int $count Number of notes having the give note as parent * @@ -440,11 +457,16 @@ ORDER BY modified_date desc"; /** * Recursive function to get all descendent notes of the note with given ID * - * @param int $parentId ID of the note to start from - * @param int $maxDepth Maximum number of levels to descend into the tree; if not given, will include all descendents. - * @param bool $snippet If TRUE, returned values will be pre-formatted for display in a table of notes. - * @param array $tree (Reference) Variable to store all found descendents - * @param int $depth Depth of current iteration within the descendent tree (used for comparison against maxDepth) + * @param int $parentId + * ID of the note to start from. + * @param int $maxDepth + * Maximum number of levels to descend into the tree; if not given, will include all descendents. + * @param bool $snippet + * If TRUE, returned values will be pre-formatted for display in a table of notes. + * @param array $tree + * (Reference) Variable to store all found descendents. + * @param int $depth + * Depth of current iteration within the descendent tree (used for comparison against maxDepth). * * @return array Nested associative array beginning with direct children of given note. * @static @@ -505,8 +527,10 @@ ORDER BY modified_date desc"; /** * Given a note id, get a list of the ids of all notes that are descendents of that note * - * @param int $parentId Id of the given note - * @param array $ids (reference) one-dimensional array to store found descendent ids + * @param int $parentId + * Id of the given note. + * @param array $ids + * (reference) one-dimensional array to store found descendent ids. * * @return array $ids One-dimensional array containing ids of all desendent notes */ @@ -527,7 +551,8 @@ ORDER BY modified_date desc"; /** * Delete all note related to contact when contact is deleted * - * @param int $contactID contact id whose notes to be deleted + * @param int $contactID + * Contact id whose notes to be deleted. * * @return void * @static diff --git a/CRM/Core/BAO/OpenID.php b/CRM/Core/BAO/OpenID.php index 5ac7f70380..feb9f97b51 100644 --- a/CRM/Core/BAO/OpenID.php +++ b/CRM/Core/BAO/OpenID.php @@ -41,7 +41,8 @@ class CRM_Core_BAO_OpenID extends CRM_Core_DAO_OpenID { /** * Takes an associative array and adds OpenID * - * @param array $params (reference ) an assoc array of name/value pairs + * @param array $params + * (reference ) an assoc array of name/value pairs. * * @return object CRM_Core_BAO_OpenID object on success, null otherwise * @static @@ -62,7 +63,8 @@ class CRM_Core_BAO_OpenID extends CRM_Core_DAO_OpenID { * Given the list of params in the params array, fetch the object * and store the values in the values array * - * @param array $entityBlock input parameters to find object + * @param array $entityBlock + * Input parameters to find object. * * @return mixed * @static @@ -74,7 +76,8 @@ class CRM_Core_BAO_OpenID extends CRM_Core_DAO_OpenID { /** * Returns whether or not this OpenID is allowed to login * - * @param string $identity_url the OpenID to check + * @param string $identity_url + * The OpenID to check. * * @return boolean * @static @@ -91,7 +94,8 @@ class CRM_Core_BAO_OpenID extends CRM_Core_DAO_OpenID { /** * Get all the openids for a specified contact_id, with the primary openid being first * - * @param int $id the contact id + * @param int $id + * The contact id. * * @param bool $updateBlankLocInfo * diff --git a/CRM/Core/BAO/OptionGroup.php b/CRM/Core/BAO/OptionGroup.php index 0e2191f624..eb52614605 100644 --- a/CRM/Core/BAO/OptionGroup.php +++ b/CRM/Core/BAO/OptionGroup.php @@ -44,8 +44,10 @@ class CRM_Core_BAO_OptionGroup extends CRM_Core_DAO_OptionGroup { /** * 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_Core_BAO_OptionGroup object * @static @@ -63,8 +65,10 @@ class CRM_Core_BAO_OptionGroup extends CRM_Core_DAO_OptionGroup { /** * 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 @@ -76,8 +80,10 @@ class CRM_Core_BAO_OptionGroup extends CRM_Core_DAO_OptionGroup { /** * Add the Option Group * - * @param array $params reference array contains the values submitted by the form - * @param array $ids reference array contains the id + * @param array $params + * Reference array contains the values submitted by the form. + * @param array $ids + * Reference array contains the id. * * @static * @@ -107,7 +113,8 @@ class CRM_Core_BAO_OptionGroup extends CRM_Core_DAO_OptionGroup { /** * Delete Option Group * - * @param int $optionGroupId Id of the Option Group to be deleted. + * @param int $optionGroupId + * Id of the Option Group to be deleted. * * @return void * @@ -127,7 +134,8 @@ class CRM_Core_BAO_OptionGroup extends CRM_Core_DAO_OptionGroup { /** * Get title of the option group * - * @param int $optionGroupId Id of the Option Group. + * @param int $optionGroupId + * Id of the Option Group. * * @return String title * diff --git a/CRM/Core/BAO/OptionValue.php b/CRM/Core/BAO/OptionValue.php index 0a902a83b5..8e320c1944 100644 --- a/CRM/Core/BAO/OptionValue.php +++ b/CRM/Core/BAO/OptionValue.php @@ -45,7 +45,8 @@ class CRM_Core_BAO_OptionValue extends CRM_Core_DAO_OptionValue { * Create option value - note that the create function calls 'add' but * has more business logic * - * @param array $params input parameters + * @param array $params + * Input parameters. * * @return object */ @@ -124,8 +125,10 @@ class CRM_Core_BAO_OptionValue extends CRM_Core_DAO_OptionValue { /** * 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_Core_BAO_OptionValue object * @static @@ -143,8 +146,10 @@ class CRM_Core_BAO_OptionValue extends CRM_Core_DAO_OptionValue { /** * 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 @@ -156,8 +161,10 @@ class CRM_Core_BAO_OptionValue extends CRM_Core_DAO_OptionValue { /** * Add an Option Value * - * @param array $params reference array contains the values submitted by the form - * @param array $ids reference array contains the id + * @param array $params + * Reference array contains the values submitted by the form. + * @param array $ids + * Reference array contains the id. * * @static * @@ -241,7 +248,8 @@ class CRM_Core_BAO_OptionValue extends CRM_Core_DAO_OptionValue { /** * Retrieve activity type label and description * - * @param int $activityTypeId activity type id + * @param int $activityTypeId + * Activity type id. * * @return array label and description * @static @@ -263,7 +271,8 @@ class CRM_Core_BAO_OptionValue extends CRM_Core_DAO_OptionValue { /** * Get the Option Value title. * - * @param int $id id of Option Value + * @param int $id + * Id of Option Value. * * @return string title * @@ -277,8 +286,10 @@ class CRM_Core_BAO_OptionValue extends CRM_Core_DAO_OptionValue { /** * Updates contacts affected by the option value passed. * - * @param Integer $optionValueId the option value id. - * @param int $action the action describing whether prefix/suffix was UPDATED or DELETED + * @param int $optionValueId + * The option value id. + * @param int $action + * The action describing whether prefix/suffix was UPDATED or DELETED. * * @return bool */ @@ -407,7 +418,8 @@ class CRM_Core_BAO_OptionValue extends CRM_Core_DAO_OptionValue { * Updates options values weights. * * @param int $opGroupId - * @param array $opWeights options value , weight pair + * @param array $opWeights + * Options value , weight pair. * * @return void * @static @@ -434,7 +446,8 @@ class CRM_Core_BAO_OptionValue extends CRM_Core_DAO_OptionValue { * Does not take any filtering arguments. The object is to avoid hitting the DB and retrieve * from memory * - * @param int $optionGroupID the option group for which we want the values from + * @param int $optionGroupID + * The option group for which we want the values from. * * @return array an array of array of values for this option group * @static @@ -466,7 +479,8 @@ class CRM_Core_BAO_OptionValue extends CRM_Core_DAO_OptionValue { * Get the values of all option values given an option group ID as a key => value pair * Use above cached function to make it super efficient * - * @param int $optionGroupID the option group for which we want the values from + * @param int $optionGroupID + * The option group for which we want the values from. * * @return array an associative array of label, value pairs * @static @@ -484,7 +498,8 @@ class CRM_Core_BAO_OptionValue extends CRM_Core_DAO_OptionValue { * Get the values of all option values given an option group Name as a key => value pair * Use above cached function to make it super efficient * - * @param string $optionGroupName the option group name for which we want the values from + * @param string $optionGroupName + * The option group name for which we want the values from. * * @return array an associative array of label, value pairs * @static diff --git a/CRM/Core/BAO/PaperSize.php b/CRM/Core/BAO/PaperSize.php index 796b9074c1..bfce94cdb8 100644 --- a/CRM/Core/BAO/PaperSize.php +++ b/CRM/Core/BAO/PaperSize.php @@ -87,8 +87,9 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue { /** * Add ordering fields to Paper Size list * - * @param array (reference) $list List of Paper Sizes - * @param string $returnURL URL of page calling this function + * @param array (reference) $list List of Paper Sizes + * @param string $returnURL + * URL of page calling this function. * * @return array (reference) List of Paper Sizes * @static @@ -101,7 +102,8 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue { /** * Retrieve list of Paper Sizes. * - * @param bool $namesOnly return simple list of names + * @param bool $namesOnly + * Return simple list of names. * * @return array (reference) Paper Size list * @static @@ -151,8 +153,10 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue { /** * Get Paper Size from the DB * - * @param string $field Field name to search by - * @param int $val Field value to search for + * @param string $field + * Field name to search by. + * @param int $val + * Field value to search for. * * @return array $values (reference) associative array of name/value pairs */ @@ -170,7 +174,8 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue { /** * Get Paper Size by Name * - * @param int $name Paper Size name. Empty = get default Paper Size + * @param int $name + * Paper Size name. Empty = get default Paper Size. * * @return array $values (reference) associative array of name/value pairs */ @@ -181,7 +186,8 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue { /** * Get Paper Size by ID * - * @param int $id Paper Size id. 0 = get default Paper Size + * @param int $id + * Paper Size id. 0 = get default Paper Size. * * @return array $values (reference) associative array of name/value pairs */ @@ -192,7 +198,8 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue { /** * Get Paper Size field from associative array * - * @param string $field name of a Paper Size field + * @param string $field + * Name of a Paper Size field. * @param array (reference) $values associative array of name/value pairs containing * Paper Size field selections * @@ -225,8 +232,10 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue { * retrieves the relevant objects. Typically the valid params are only * paper size id. 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_OptionValue object * @static @@ -260,8 +269,9 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue { /** * Save the Paper Size in the DB * - * @param array (reference) $values associative array of name/value pairs - * @param int $id id of the database record (null = new record) + * @param array (reference) $values associative array of name/value pairs + * @param int $id + * Id of the database record (null = new record). * * @return void */ @@ -319,7 +329,8 @@ class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue { /** * Delete a Paper Size * - * @param int $id ID of the Paper Size to be deleted. + * @param int $id + * ID of the Paper Size to be deleted. * * @static */ diff --git a/CRM/Core/BAO/PdfFormat.php b/CRM/Core/BAO/PdfFormat.php index 03fdbb5b39..06e039bb43 100644 --- a/CRM/Core/BAO/PdfFormat.php +++ b/CRM/Core/BAO/PdfFormat.php @@ -144,8 +144,9 @@ class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue { /** * Add ordering fields to Page Format list * - * @param array (reference) $list List of PDF Page Formats - * @param string $returnURL URL of page calling this function + * @param array (reference) $list List of PDF Page Formats + * @param string $returnURL + * URL of page calling this function. * * @return void * @static @@ -158,7 +159,8 @@ class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue { /** * Get list of PDF Page Formats. * - * @param bool $namesOnly return simple list of names + * @param bool $namesOnly + * Return simple list of names. * * @return array (reference) PDF Page Format list * @static @@ -211,8 +213,10 @@ class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue { /** * Get PDF Page Format from the DB * - * @param string $field Field name to search by - * @param int $val Field value to search for + * @param string $field + * Field name to search by. + * @param int $val + * Field value to search for. * * @return array $values (reference) associative array of name/value pairs */ @@ -230,7 +234,8 @@ class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue { /** * Get PDF Page Format by Name * - * @param int $name PDF Page Format name. Empty = get default PDF Page Format + * @param int $name + * PDF Page Format name. Empty = get default PDF Page Format. * * @return array $values (reference) associative array of name/value pairs */ @@ -241,7 +246,8 @@ class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue { /** * Get PDF Page Format by ID * - * @param int $id PDF Page Format id. 0 = get default PDF Page Format + * @param int $id + * PDF Page Format id. 0 = get default PDF Page Format. * * @return array $values (reference) associative array of name/value pairs */ @@ -252,7 +258,8 @@ class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue { /** * Get PDF Page Format field from associative array * - * @param string $field name of a PDF Page Format field + * @param string $field + * Name of a PDF Page Format field. * @param array (reference) $values associative array of name/value pairs containing * PDF Page Format field selections * @@ -285,8 +292,10 @@ class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue { * retrieves the relevant objects. Typically the valid params are only * format id. 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_OptionValue object * @static @@ -320,8 +329,9 @@ class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue { /** * Save the PDF Page Format in the DB * - * @param array (reference) $values associative array of name/value pairs - * @param int $id id of the database record (null = new record) + * @param array (reference) $values associative array of name/value pairs + * @param int $id + * Id of the database record (null = new record). * * @return void */ @@ -375,7 +385,8 @@ class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue { /** * Delete a PDF Page Format * - * @param int $id ID of the PDF Page Format to be deleted. + * @param int $id + * ID of the PDF Page Format to be deleted. * * @static */ diff --git a/CRM/Core/BAO/Persistent.php b/CRM/Core/BAO/Persistent.php index da0ad9da3c..229d726540 100644 --- a/CRM/Core/BAO/Persistent.php +++ b/CRM/Core/BAO/Persistent.php @@ -37,8 +37,10 @@ class CRM_Core_BAO_Persistent extends CRM_Core_DAO_Persistent { /** * 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_Core_BAO_Persistent object * @static @@ -60,8 +62,10 @@ class CRM_Core_BAO_Persistent extends CRM_Core_DAO_Persistent { /** * Add the Persistent Record * - * @param array $params reference array contains the values submitted by the form - * @param array $ids reference array contains the id + * @param array $params + * Reference array contains the values submitted by the form. + * @param array $ids + * Reference array contains the id. * * @static * diff --git a/CRM/Core/BAO/Phone.php b/CRM/Core/BAO/Phone.php index d1a80847e6..a5868e3c10 100644 --- a/CRM/Core/BAO/Phone.php +++ b/CRM/Core/BAO/Phone.php @@ -42,7 +42,8 @@ class CRM_Core_BAO_Phone extends CRM_Core_DAO_Phone { * Create phone object - note that the create function calls 'add' but * has more business logic * - * @param array $params input parameters + * @param array $params + * Input parameters. */ /** * @param array $params @@ -68,7 +69,8 @@ class CRM_Core_BAO_Phone extends CRM_Core_DAO_Phone { /** * Takes an associative array and adds phone * - * @param array $params (reference ) an assoc array of name/value pairs + * @param array $params + * (reference ) an assoc array of name/value pairs. * * @return object CRM_Core_BAO_Phone object on success, null otherwise * @static @@ -105,7 +107,8 @@ class CRM_Core_BAO_Phone extends CRM_Core_DAO_Phone { /** * Get all the phone numbers for a specified contact_id, with the primary being first * - * @param int $id the contact id + * @param int $id + * The contact id. * * @param bool $updateBlankLocInfo * @param null $type @@ -177,7 +180,8 @@ ORDER BY civicrm_phone.is_primary DESC, phone_id ASC "; /** * Get all the phone numbers for a specified location_block id, with the primary phone being first * - * @param array $entityElements the array containing entity_id and + * @param array $entityElements + * The array containing entity_id and. * entity_table name * * @param null $type @@ -233,7 +237,8 @@ ORDER BY ph.is_primary DESC, phone_id ASC "; /** * Set NULL to phone, mapping, uffield * - * @param $optionId value of option to be deleted + * @param $optionId + * Value of option to be deleted. * * return void * @static diff --git a/CRM/Core/BAO/PreferencesDate.php b/CRM/Core/BAO/PreferencesDate.php index 8959d4f1a9..efe1ed99ce 100644 --- a/CRM/Core/BAO/PreferencesDate.php +++ b/CRM/Core/BAO/PreferencesDate.php @@ -49,8 +49,10 @@ class CRM_Core_BAO_PreferencesDate extends CRM_Core_DAO_PreferencesDate { /** * 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_Core_BAO_PreferencesDate object on success, null otherwise * @static @@ -68,8 +70,10 @@ class CRM_Core_BAO_PreferencesDate extends CRM_Core_DAO_PreferencesDate { /** * 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 * @@ -82,7 +86,7 @@ class CRM_Core_BAO_PreferencesDate extends CRM_Core_DAO_PreferencesDate { /** * Delete preference dates * - * @param int $id + * @param int $id * * @static */ diff --git a/CRM/Core/BAO/PrevNextCache.php b/CRM/Core/BAO/PrevNextCache.php index 9cd9df9fef..fe80b9dfb2 100644 --- a/CRM/Core/BAO/PrevNextCache.php +++ b/CRM/Core/BAO/PrevNextCache.php @@ -397,11 +397,14 @@ WHERE cacheKey LIKE %1 AND is_selected = 1 /** * Get the selections * - * @param string $cacheKey cache key - * @param string $action action + * @param string $cacheKey + * Cache key. + * @param string $action + * Action. * $action : get - get only selection records * getall - get all the records of the specified cache key - * @param string $entity_table entity table + * @param string $entity_table + * Entity table. * * @return array */ diff --git a/CRM/Core/BAO/RecurringEntity.php b/CRM/Core/BAO/RecurringEntity.php index a5d6b17e63..685ffda698 100644 --- a/CRM/Core/BAO/RecurringEntity.php +++ b/CRM/Core/BAO/RecurringEntity.php @@ -135,7 +135,8 @@ class CRM_Core_BAO_RecurringEntity extends CRM_Core_DAO_RecurringEntity { /** * Save records in civicrm_recujrring_entity table * - * @param array $params reference array contains the values submitted by the form + * @param array $params + * Reference array contains the values submitted by the form . * * @static * @@ -166,9 +167,12 @@ class CRM_Core_BAO_RecurringEntity extends CRM_Core_DAO_RecurringEntity { /** * Wrapper for the function add() to add entry in recurring entity * - * @param int $parentId Parent entity id - * @param int $entityId Child entity id - * @param String $entityTable Name of the entity table + * @param int $parentId + * Parent entity id . + * @param int $entityId + * Child entity id . + * @param string $entityTable + * Name of the entity table . * * @static * @@ -187,7 +191,8 @@ class CRM_Core_BAO_RecurringEntity extends CRM_Core_DAO_RecurringEntity { /** * This function updates the mode column in the civicrm_recurring_entity table * - * @param int $mode Mode of the entity to cascade changes across parent/child relations eg 1 - only this entity, 2 - this and the following entities, 3 - All the entity + * @param int $mode + * Mode of the entity to cascade changes across parent/child relations eg 1 - only this entity, 2 - this and the following entities, 3 - All the entity . * * * @return void @@ -385,11 +390,16 @@ class CRM_Core_BAO_RecurringEntity extends CRM_Core_DAO_RecurringEntity { /** * This function gets all the children for a particular parent entity * - * @param int $parentId Parent entity id - * @param string $entityTable Name of the entity table - * @param boolean $includeParent If true parent id is included in result set and vice versa - * @param int $mode 1. retrieve only one entity. 2. retrieve all future entities in the repeating set. 3. all entities in the repeating set. - * @param int $initiatorId the instance where this function is invoked from + * @param int $parentId + * Parent entity id . + * @param string $entityTable + * Name of the entity table . + * @param bool $includeParent + * If true parent id is included in result set and vice versa . + * @param int $mode + * 1. retrieve only one entity. 2. retrieve all future entities in the repeating set. 3. all entities in the repeating set. . + * @param int $initiatorId + * The instance where this function is invoked from . * * @static * @@ -450,10 +460,14 @@ class CRM_Core_BAO_RecurringEntity extends CRM_Core_DAO_RecurringEntity { * This function when passed an entity id checks if it has parent and * returns all other entities that are connected to same parent. * - * @param int $entityId entity id - * @param string $entityTable Entity table name - * @param boolean $includeParent Include parent in result set - * @param int $mode 1. retrieve only one entity. 2. retrieve all future entities in the repeating set. 3. all entities in the repeating set. + * @param int $entityId + * Entity id . + * @param string $entityTable + * Entity table name . + * @param bool $includeParent + * Include parent in result set . + * @param int $mode + * 1. retrieve only one entity. 2. retrieve all future entities in the repeating set. 3. all entities in the repeating set. . * * @static * @@ -470,9 +484,12 @@ class CRM_Core_BAO_RecurringEntity extends CRM_Core_DAO_RecurringEntity { /** * This function gets the parent for the entity id passed to it * - * @param int $entityId entity ID - * @param string $entityTable Entity table name - * @param boolean $includeParent Include parent in result set + * @param int $entityId + * Entity ID . + * @param string $entityTable + * Entity table name . + * @param bool $includeParent + * Include parent in result set . * * @static * @@ -503,10 +520,14 @@ class CRM_Core_BAO_RecurringEntity extends CRM_Core_DAO_RecurringEntity { /** * This function copies the information from parent entity and creates other entities with same information * - * @param string $entityTable Entity table name - * @param array $fromCriteria array of all the fields & values on which basis to copy - * @param array $newParams array of all the fields & values to be copied besides the other fields - * @param boolean $createRecurringEntity if to create a record in recurring_entity table + * @param string $entityTable + * Entity table name . + * @param array $fromCriteria + * Array of all the fields & values on which basis to copy . + * @param array $newParams + * Array of all the fields & values to be copied besides the other fields . + * @param bool $createRecurringEntity + * If to create a record in recurring_entity table . * * @static * @@ -535,7 +556,8 @@ class CRM_Core_BAO_RecurringEntity extends CRM_Core_DAO_RecurringEntity { * This function acts as a listener to dao->update whenever there is an update, * and propagates any changes to all related entities present in recurring entity table * - * @param object $event An object of /Civi/Core/DAO/Event/PostUpdate containing dao object that was just updated + * @param object $event + * An object of /Civi/Core/DAO/Event/PostUpdate containing dao object that was just updated . * * @static * @@ -607,7 +629,8 @@ class CRM_Core_BAO_RecurringEntity extends CRM_Core_DAO_RecurringEntity { * This function acts as a listener to dao->save, * and creates entries for linked entities in recurring entity table * - * @param object $event An object of /Civi/Core/DAO/Event/PostUpdate containing dao object that was just inserted + * @param object $event + * An object of /Civi/Core/DAO/Event/PostUpdate containing dao object that was just inserted . * * @static * @@ -716,7 +739,8 @@ class CRM_Core_BAO_RecurringEntity extends CRM_Core_DAO_RecurringEntity { /** * This function acts as a listener to dao->delete, and deletes an entry from recurring_entity table * - * @param object $event An object of /Civi/Core/DAO/Event/PostUpdate containing dao object that was just deleted + * @param object $event + * An object of /Civi/Core/DAO/Event/PostUpdate containing dao object that was just deleted . * * @static * @@ -757,8 +781,10 @@ class CRM_Core_BAO_RecurringEntity extends CRM_Core_DAO_RecurringEntity { /** * This function deletes main entity and related linked entities from recurring-entity table * - * @param int $entityId Entity id - * @param string $entityTable Name of the entity table + * @param int $entityId + * Entity id . + * @param string $entityTable + * Name of the entity table . * * @static * @@ -799,7 +825,8 @@ class CRM_Core_BAO_RecurringEntity extends CRM_Core_DAO_RecurringEntity { /** * This function maps values posted from form to civicrm_action_schedule columns * - * @param array $formParams and array of form values posted + * @param array $formParams + * And array of form values posted . * * @return array */ @@ -876,7 +903,8 @@ class CRM_Core_BAO_RecurringEntity extends CRM_Core_DAO_RecurringEntity { /** * This function gets all the columns of civicrm_action_schedule table based on id(primary key) * - * @param int $scheduleReminderId primary key of civicrm_action_schedule table + * @param int $scheduleReminderId + * Primary key of civicrm_action_schedule table . * * @static * @@ -901,7 +929,8 @@ class CRM_Core_BAO_RecurringEntity extends CRM_Core_DAO_RecurringEntity { /** * This function is a wrapper of getScheduleReminderDetailsById function * - * @param int $scheduleReminderId primary key of civicrm_action_schedule table + * @param int $scheduleReminderId + * Primary key of civicrm_action_schedule table . * * @return array */ @@ -919,7 +948,8 @@ class CRM_Core_BAO_RecurringEntity extends CRM_Core_DAO_RecurringEntity { * This function takes criterias saved in civicrm_action_schedule table * and creates recursion rule * - * @param array $scheduleReminderDetails array of repeat criterias saved in civicrm_action_schedule table + * @param array $scheduleReminderDetails + * Array of repeat criterias saved in civicrm_action_schedule table . * * @return object When object */ @@ -1022,8 +1052,10 @@ class CRM_Core_BAO_RecurringEntity extends CRM_Core_DAO_RecurringEntity { /** * This function gets time difference between the two datetime object * - * @param DateTime $startDate Start Date - * @param DateTime $endDate End Date + * @param DateTime $startDate + * Start Date . + * @param DateTime $endDate + * End Date . * * @static * @@ -1040,8 +1072,10 @@ class CRM_Core_BAO_RecurringEntity extends CRM_Core_DAO_RecurringEntity { /** * This function gets all columns from civicrm_action_schedule on the basis of event id * - * @param int $entityId Entity ID - * @param string $used_for Specifies for which entity type it's used for + * @param int $entityId + * Entity ID . + * @param string $used_for + * Specifies for which entity type it's used for . * * @static * @@ -1069,8 +1103,10 @@ class CRM_Core_BAO_RecurringEntity extends CRM_Core_DAO_RecurringEntity { /** * Update mode column in civicrm_recurring_entity table for event related tabs * - * @param int $entityId event id - * @param string $linkedEntityTable Linked entity table name for this event + * @param int $entityId + * Event id . + * @param string $linkedEntityTable + * Linked entity table name for this event . * @return array */ public static function updateModeLinkedEntity($entityId, $linkedEntityTable, $mainEntityTable) { diff --git a/CRM/Core/BAO/SchemaHandler.php b/CRM/Core/BAO/SchemaHandler.php index 109a6591cc..2d04ed022f 100644 --- a/CRM/Core/BAO/SchemaHandler.php +++ b/CRM/Core/BAO/SchemaHandler.php @@ -363,7 +363,8 @@ ALTER TABLE {$tableName} /** * Delete a civiCRM-table * - * @param String $tableName name of the table to be created. + * @param String $tableName + * Name of the table to be created. * * @return true if successfully deleted, false otherwise * diff --git a/CRM/Core/BAO/Setting.php b/CRM/Core/BAO/Setting.php index a8722e737d..b8475d451f 100644 --- a/CRM/Core/BAO/Setting.php +++ b/CRM/Core/BAO/Setting.php @@ -66,10 +66,14 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { /** * Checks whether an item is present in the in-memory cache table * - * @param string $group (required) The group name of the item - * @param string $name (required) The name of the setting - * @param int $componentID The optional component ID (so components can share the same name space) - * @param int $contactID If set, this is a contactID specific setting, else its a global setting + * @param string $group + * (required) The group name of the item. + * @param string $name + * (required) The name of the setting. + * @param int $componentID + * The optional component ID (so components can share the same name space). + * @param int $contactID + * If set, this is a contactID specific setting, else its a global setting. * @param bool|int $load if true, load from local cache (typically memcache) * * @param int $domainID @@ -196,11 +200,16 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { /** * Retrieve the value of a setting from the DB table * - * @param string $group (required) The group name of the item - * @param string $name (required) The name under which this item is stored - * @param int $componentID The optional component ID (so componenets can share the same name space) - * @param string $defaultValue The default value to return for this setting if not present in DB - * @param int $contactID If set, this is a contactID specific setting, else its a global setting + * @param string $group + * (required) The group name of the item. + * @param string $name + * (required) The name under which this item is stored. + * @param int $componentID + * The optional component ID (so componenets can share the same name space). + * @param string $defaultValue + * The default value to return for this setting if not present in DB. + * @param int $contactID + * If set, this is a contactID specific setting, else its a global setting. * * @param int $domainID * @@ -250,7 +259,8 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { /** * Store multiple items in the setting table * - * @param array $params (required) An api formatted array of keys and values + * @param array $params + * (required) An api formatted array of keys and values. * @param null $domains * @param $settingsToReturn * @@ -317,12 +327,17 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { * * _setItem() is the common logic shared by setItem() and setItems(). * - * @param object $value (required) The value that will be serialized and stored - * @param string $group (required) The group name of the item - * @param string $name (required) The name of the setting - * @param int $componentID The optional component ID (so componenets can share the same name space) + * @param object $value + * (required) The value that will be serialized and stored. + * @param string $group + * (required) The group name of the item. + * @param string $name + * (required) The name of the setting. + * @param int $componentID + * The optional component ID (so componenets can share the same name space). * @param int $contactID - * @param int $createdID An optional ID to assign the creator to. If not set, retrieved from session + * @param int $createdID + * An optional ID to assign the creator to. If not set, retrieved from session. * * @param int $domainID * @@ -353,7 +368,8 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { * * _setItem() is the common logic shared by setItem() and setItems(). * - * @param array $metadata metadata describing this field + * @param array $metadata + * Metadata describing this field. * @param $value * @param $group * @param string $name @@ -435,7 +451,8 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { * * _setItem() is the common logic shared by setItem() and setItems(). * - * @param array $params (required) An api formatted array of keys and values + * @param array $params + * (required) An api formatted array of keys and values. * @param null $domains * * @throws api_Exception @@ -503,8 +520,10 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { * * This function filters on the fields like 'version' & 'debug' that are not settings * - * @param array $params Parameters as passed into API - * @param array $fields empty array to be populated with fields metadata + * @param array $params + * Parameters as passed into API. + * @param array $fields + * Empty array to be populated with fields metadata. * @param bool $createMode * * @throws api_Exception @@ -608,7 +627,8 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { * * The following params will filter the result. If none are passed all settings will be returns * - * @param int $componentID id of relevant component + * @param int $componentID + * Id of relevant component. * @param array $filters * @param int $domainID * @param null $profile @@ -669,7 +689,8 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { /** * Load the settings files defined in a series of folders - * @param array $metaDataFolders list of folder paths + * @param array $metaDataFolders + * List of folder paths. * @return array */ public static function loadSettingsMetaDataFolders($metaDataFolders) { @@ -703,8 +724,10 @@ class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { * Filter the settings metadata according to filters passed in. This is a convenience filter * and allows selective reverting / filling of settings * - * @param array $filters Filters to match against data - * @param array $settingSpec metadata to filter + * @param array $filters + * Filters to match against data. + * @param array $settingSpec + * Metadata to filter. */ public static function _filterSettingsSpecification($filters, &$settingSpec) { if (empty($filters)) { diff --git a/CRM/Core/BAO/Tag.php b/CRM/Core/BAO/Tag.php index 435cdc7e21..e58209512d 100644 --- a/CRM/Core/BAO/Tag.php +++ b/CRM/Core/BAO/Tag.php @@ -44,8 +44,10 @@ class CRM_Core_BAO_Tag extends CRM_Core_DAO_Tag { /** * 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 object CRM_Core_DAO_Tag object on success, otherwise null * @static @@ -180,11 +182,16 @@ class CRM_Core_BAO_Tag extends CRM_Core_DAO_Tag { /** * Function to retrieve tags * - * @param string $usedFor which type of tag entity - * @param array $tags tags array - * @param int $parentId parent id if you want need only children - * @param string $separator separator to indicate children - * @param boolean $formatSelectable add special property for non-selectable + * @param string $usedFor + * Which type of tag entity. + * @param array $tags + * Tags array. + * @param int $parentId + * Parent id if you want need only children. + * @param string $separator + * Separator to indicate children. + * @param bool $formatSelectable + * Add special property for non-selectable. * tag, so they cannot be selected * * @return array @@ -307,7 +314,8 @@ class CRM_Core_BAO_Tag extends CRM_Core_DAO_Tag { /** * Delete the tag * - * @param int $id tag id + * @param int $id + * Tag id. * * @return boolean * @static @@ -343,8 +351,10 @@ class CRM_Core_BAO_Tag extends CRM_Core_DAO_Tag { * 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 $ids (optional) the array that holds all the db ids - we are moving away from this in bao + * @param array $params + * (reference) an assoc array of name/value pairs. + * @param array $ids + * (optional) the array that holds all the db ids - we are moving away from this in bao. * signatures * * @return object CRM_Core_DAO_Tag object on success, otherwise null @@ -394,7 +404,8 @@ class CRM_Core_BAO_Tag extends CRM_Core_DAO_Tag { /** * 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 @@ -412,7 +423,8 @@ class CRM_Core_BAO_Tag extends CRM_Core_DAO_Tag { /** * Get the tag sets for a entity object * - * @param string $entityTable entity_table + * @param string $entityTable + * Entity_table. * * @return array $tagSets array of tag sets * @static diff --git a/CRM/Core/BAO/UFField.php b/CRM/Core/BAO/UFField.php index 3f1c0b333c..24cc27cf20 100644 --- a/CRM/Core/BAO/UFField.php +++ b/CRM/Core/BAO/UFField.php @@ -49,8 +49,10 @@ class CRM_Core_BAO_UFField extends CRM_Core_DAO_UFField { /** * 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_Core_BAO_UFField object * @static @@ -62,7 +64,8 @@ class CRM_Core_BAO_UFField extends CRM_Core_DAO_UFField { /** * Get the form title. * - * @param int $id id of uf_form + * @param int $id + * Id of uf_form. * * @return string title * @@ -76,8 +79,10 @@ class CRM_Core_BAO_UFField extends CRM_Core_DAO_UFField { /** * 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 @@ -100,7 +105,8 @@ class CRM_Core_BAO_UFField extends CRM_Core_DAO_UFField { /** * Delete the profile Field. * - * @param int $id Field Id + * @param int $id + * Field Id. * * @return boolean * @@ -118,7 +124,8 @@ class CRM_Core_BAO_UFField extends CRM_Core_DAO_UFField { /** * Check duplicate for duplicate field in a group * - * @param array $params an associative array with field and values + * @param array $params + * An associative array with field and values. * @param $ids * * @return mixed @@ -191,8 +198,10 @@ WHERE cf.id IN (" . $customFieldIds . ") AND is_multiple = 1 LIMIT 0,1"; /** * Add the UF Field * - * @param array $params (reference) array containing the values submitted by the form - * @param array $ids array containing the id + * @param array $params + * (reference) array containing the values submitted by the form. + * @param array $ids + * Array containing the id. * * @return CRM_Core_BAO_UFField object * @@ -247,7 +256,8 @@ WHERE cf.id IN (" . $customFieldIds . ") AND is_multiple = 1 LIMIT 0,1"; /** * Automatically determine one weight and modify others * - * @param array $params UFField record, e.g. with 'weight', 'uf_group_id', and 'field_id' + * @param array $params + * UFField record, e.g. with 'weight', 'uf_group_id', and 'field_id'. * @return int */ public static function autoWeight($params) { @@ -264,8 +274,10 @@ WHERE cf.id IN (" . $customFieldIds . ") AND is_multiple = 1 LIMIT 0,1"; /** * Enable/disable profile field given a custom field id * - * @param int $customFieldId custom field id - * @param boolean $is_active set the is_active field + * @param int $customFieldId + * Custom field id. + * @param bool $is_active + * Set the is_active field. * * @return void * @static @@ -286,8 +298,10 @@ WHERE cf.id IN (" . $customFieldIds . ") AND is_multiple = 1 LIMIT 0,1"; * Copy existing profile fields to * new profile from the already built profile * - * @param int $old_id from which we need to copy - * @param boolean $new_id in which to copy + * @param int $old_id + * From which we need to copy. + * @param bool $new_id + * In which to copy. * * @return void * @static @@ -307,7 +321,8 @@ WHERE cf.id IN (" . $customFieldIds . ") AND is_multiple = 1 LIMIT 0,1"; /** * Delete profile field given a custom field * - * @param int $customFieldId ID of the custom field to be deleted + * @param int $customFieldId + * ID of the custom field to be deleted. * * @return void * @@ -328,8 +343,10 @@ WHERE cf.id IN (" . $customFieldIds . ") AND is_multiple = 1 LIMIT 0,1"; /** * Enable/disable profile field given a custom group id * - * @param int $customGroupId custom group id - * @param boolean $is_active value we want to set the is_active field + * @param int $customGroupId + * Custom group id. + * @param bool $is_active + * Value we want to set the is_active field. * * @return void * @static @@ -437,9 +454,12 @@ WHERE cf.id IN (" . $customFieldIds . ") AND is_multiple = 1 LIMIT 0,1"; * Find out whether given profile group uses $required * and/or $optional profile types * - * @param integer $ufGroupId profile id - * @param array $required array of types those are required - * @param array $optional array of types those are optional + * @param int $ufGroupId + * Profile id. + * @param array $required + * Array of types those are required. + * @param array $optional + * Array of types those are optional. * * @return boolean $valid * @static @@ -549,9 +569,12 @@ WHERE cf.id IN (" . $customFieldIds . ") AND is_multiple = 1 LIMIT 0,1"; /** * Get the profile type (eg: individual/organization/household) * - * @param int $ufGroupId uf group id - * @param boolean $returnMixType this is true, then field type of mix profile field is returned - * @param boolean $onlyPure true if only pure profiles are required + * @param int $ufGroupId + * Uf group id. + * @param bool $returnMixType + * This is true, then field type of mix profile field is returned. + * @param bool $onlyPure + * True if only pure profiles are required. * * @param bool $skipComponentType * @@ -573,8 +596,10 @@ WHERE cf.id IN (" . $customFieldIds . ") AND is_multiple = 1 LIMIT 0,1"; * Get the profile type (eg: individual/organization/household) * * @param string $ufGroupType - * @param boolean $returnMixType this is true, then field type of mix profile field is returned - * @param boolean $onlyPure true if only pure profiles are required + * @param bool $returnMixType + * This is true, then field type of mix profile field is returned. + * @param bool $onlyPure + * True if only pure profiles are required. * @param bool $skipComponentType * * @return string profile group_type @@ -768,9 +793,12 @@ SELECT id * transfer profile address data to billing fields * http://issues.civicrm.org/jira/browse/CRM-5869 * - * @param string $key Field key - e.g. street_address-Primary, first_name - * @param array $profileAddressFields array of profile fields that relate to address fields - * @param array $profileFilter filter to apply to profile fields - expected usage is to only fill based on + * @param string $key + * Field key - e.g. street_address-Primary, first_name. + * @param array $profileAddressFields + * Array of profile fields that relate to address fields. + * @param array $profileFilter + * Filter to apply to profile fields - expected usage is to only fill based on. * the bottom profile per CRM-13726 * * @return bool Can the address block be hidden safe in the knowledge all fields are elsewhere collected (see CRM-15118) diff --git a/CRM/Core/BAO/UFGroup.php b/CRM/Core/BAO/UFGroup.php index d8c2b14ba1..cb828687c1 100644 --- a/CRM/Core/BAO/UFGroup.php +++ b/CRM/Core/BAO/UFGroup.php @@ -51,8 +51,10 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { /** * 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 object CRM_Core_DAO_UFGroup object * @static @@ -64,7 +66,8 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { /** * Retrieve the first non-generic contact type * - * @param int $id id of uf_group + * @param int $id + * Id of uf_group. * * @return string contact type */ @@ -94,7 +97,8 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { /** * Get the form title. * - * @param int $id id of uf_form + * @param int $id + * Id of uf_form. * * @return string title * @@ -108,8 +112,10 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { /** * 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 CRM_Core_DAO_UFGroup object on success, null otherwise * @static @@ -121,8 +127,10 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { /** * Get all the registration fields * - * @param int $action what action are we doing - * @param int $mode mode + * @param int $action + * What action are we doing. + * @param int $mode + * Mode. * * @param null $ctype * @@ -175,11 +183,14 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { /** * Get all the listing fields * - * @param int $action what action are we doing - * @param int $visibility visibility of fields we are interested in - * @param bool $considerSelector whether to consider the in_selector parameter + * @param int $action + * What action are we doing. + * @param int $visibility + * Visibility of fields we are interested in. + * @param bool $considerSelector + * Whether to consider the in_selector parameter. * @param array $ufGroupIds - * @param boolean $searchable + * @param bool $searchable * * @param null $restrict * @param bool $skipPermission @@ -244,13 +255,17 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { * and format for use with buildProfile. This is the SQL analog of * formatUFFields(). * - * @param mix $id the id of the UF group or ids of ufgroup + * @param mix $id + * The id of the UF group or ids of ufgroup. * @param bool|int $register are we interested in registration fields - * @param int $action what action are we doing - * @param int $visibility visibility of fields we are interested in - * @param $searchable + * @param int $action + * What action are we doing. + * @param int $visibility + * Visibility of fields we are interested in. + * @param $searchable * @param bool $showAll - * @param string $restrict should we restrict based on a specified profile type + * @param string $restrict + * Should we restrict based on a specified profile type. * @param bool $skipPermission * @param null $ctype * @param int $permissionType @@ -348,9 +363,12 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { * Format a list of UFFields for use with buildProfile. This is the in-memory analog * of getFields(). * - * @param array $groupArr (mimic CRM_UF_DAO_UFGroup) - * @param array $fieldArrs list of fields (each mimics CRM_UF_DAO_UFField) - * @param bool $visibility visibility of fields we are interested in + * @param array $groupArr + * (mimic CRM_UF_DAO_UFGroup). + * @param array $fieldArrs + * List of fields (each mimics CRM_UF_DAO_UFField). + * @param bool $visibility + * Visibility of fields we are interested in. * @param bool $searchable * @param bool $showAll * @param null $ctype @@ -404,7 +422,8 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { * @param array $addressCustomFields * @param array $importableFields * @param array $customFields - * @param int $permissionType eg CRM_Core_Permission::CREATE + * @param int $permissionType + * Eg CRM_Core_Permission::CREATE. * @return array */ protected static function formatUFField( @@ -521,7 +540,8 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { * @param bool $searchable * @param bool $showAll * @param int $visibility - * @param string $orderBy comma-delimited list of SQL columns + * @param string $orderBy + * Comma-delimited list of SQL columns. * @return string */ protected static function createUFFieldQuery($groupId, $searchable, $showAll, $visibility, $orderBy) { @@ -678,10 +698,13 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { /** * Check the data validity * - * @param int $userID the user id that we are actually editing - * @param string $title the title of the group we are interested in + * @param int $userID + * The user id that we are actually editing. + * @param string $title + * The title of the group we are interested in. * @param bool $register - * @param int $action the action of the form + * @param int $action + * The action of the form. * * @pram boolean $register is this the registrtion form * @return boolean true if form is valid @@ -719,12 +742,18 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { /** * Get the html for the form that represents this particular group * - * @param int $userID the user id that we are actually editing - * @param string $title the title of the group we are interested in - * @param int $action the action of the form - * @param boolean $register is this the registration form - * @param boolean $reset should we reset the form? - * @param int $profileID do we have the profile ID? + * @param int $userID + * The user id that we are actually editing. + * @param string $title + * The title of the group we are interested in. + * @param int $action + * The action of the form. + * @param bool $register + * Is this the registration form. + * @param bool $reset + * Should we reset the form?. + * @param int $profileID + * Do we have the profile ID?. * * @param bool $doNotProcess * @param null $ctype @@ -870,8 +899,10 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { /** * Searches for a contact in the db with similar attributes * - * @param array $params the list of values to be used in the where clause - * @param int $id the current contact id (hence excluded from matching) + * @param array $params + * The list of values to be used in the where clause. + * @param int $id + * The current contact id (hence excluded from matching). * @param string $contactType * * @return int|null contact_id if found, null otherwise @@ -894,11 +925,16 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { * for this contact * * @param int $cid - * @param array $fields the profile fields of interest - * @param array $values the values for the above fields - * @param boolean $searchable searchable or not - * @param array $componentWhere component condition - * @param boolean $absolute return urls in absolute form (useful when sending an email) + * @param array $fields + * The profile fields of interest. + * @param array $values + * The values for the above fields. + * @param bool $searchable + * Searchable or not. + * @param array $componentWhere + * Component condition. + * @param bool $absolute + * Return urls in absolute form (useful when sending an email). * @param null $additionalWhereClause * * @return void @@ -1308,7 +1344,8 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { /** * Check if profile Group used by any module. * - * @param int $id profile Id + * @param int $id + * Profile Id. * * @return boolean * @@ -1334,7 +1371,8 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { /** * Delete the profile Group. * - * @param int $id profile Id + * @param int $id + * Profile Id. * * @return boolean * @@ -1365,8 +1403,10 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { /** * Add the UF Group * - * @param array $params reference array contains the values submitted by the form - * @param array $ids reference array contains the id + * @param array $params + * Reference array contains the values submitted by the form. + * @param array $ids + * Reference array contains the id. * * @static * @@ -1407,8 +1447,10 @@ class CRM_Core_BAO_UFGroup extends CRM_Core_DAO_UFGroup { /** * Make uf join entries for an uf group * - * @param array $params (reference) an assoc array of name/value pairs - * @param int $ufGroupId ufgroup id + * @param array $params + * (reference) an assoc array of name/value pairs. + * @param int $ufGroupId + * Ufgroup id. * * @return void * @static @@ -1476,9 +1518,12 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) /** * Get the UF Join records for an ufgroup id * - * @param int $ufGroupId uf group id - * @param int $displayName if set return display name in array - * @param int $status if set return module other than default modules (User Account/User registration/Profile) + * @param int $ufGroupId + * Uf group id. + * @param int $displayName + * If set return display name in array. + * @param int $status + * If set return module other than default modules (User Account/User registration/Profile). * * @return array $ufGroupJoinRecords * @@ -1523,7 +1568,8 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) /** * Function takes an associative array and creates a ufjoin record for ufgroup * - * @param array $params (reference) an assoc array of name/value pairs + * @param array $params + * (reference) an assoc array of name/value pairs. * * @return CRM_Core_BAO_UFJoin object * @static @@ -1538,7 +1584,8 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) /** * Delete the uf join record for an uf group * - * @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 @@ -1552,7 +1599,8 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) /** * Get the weight for ufjoin record * - * @param int $ufGroupId if $ufGroupId get update weight or add weight + * @param int $ufGroupId + * If $ufGroupId get update weight or add weight. * * @return int weight of the UFGroup * @static @@ -1581,10 +1629,13 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) /** * Get the uf group for a module * - * @param string $moduleName module name - * @param int $count no to increment the weight + * @param string $moduleName + * Module name. + * @param int $count + * No to increment the weight. * @param bool $skipPermission - * @param int $op - which operation (view, edit, create, etc) to check permission for + * @param int $op + * Which operation (view, edit, create, etc) to check permission for. * @param array|NULL $returnFields list of UFGroup fields to return; NULL for default * * @return array $ufGroups array of ufgroups for a module @@ -1656,7 +1707,8 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) /** * Filter ufgroups based on logged in user contact type * - * @param int $ufGroupId uf group id (profile id) + * @param int $ufGroupId + * Uf group id (profile id). * @param int $contactID * * @return boolean true or false @@ -1698,11 +1750,14 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) * Add profile field to a form * * @param CRM_Core_Form $form - * @param array $field properties - * @param int $mode profile mode + * @param array $field + * Properties. + * @param int $mode + * Profile mode. * @param int $contactId * @param bool $online - * @param string $usedFor for building up prefixed fieldname for special cases (e.g. onBehalf, Honor) + * @param string $usedFor + * For building up prefixed fieldname for special cases (e.g. onBehalf, Honor). * @param int $rowNumber * @param string $prefix * @@ -2201,12 +2256,17 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) /** * Set profile defaults * - * @param int $contactId contact id - * @param array $fields associative array of fields - * @param array $defaults defaults array - * @param boolean $singleProfile true for single profile else false(batch update) - * @param int $componentId id for specific components like contribute, event etc - * @param null $component + * @param int $contactId + * Contact id. + * @param array $fields + * Associative array of fields. + * @param array $defaults + * Defaults array. + * @param bool $singleProfile + * True for single profile else false(batch update). + * @param int $componentId + * Id for specific components like contribute, event etc. + * @param null $component * * @return null * @static @@ -2454,8 +2514,10 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) /** * Get profiles by type eg: pure Individual etc * - * @param array $types associative array of types eg: types('Individual') - * @param boolean $onlyPure true if only pure profiles are required + * @param array $types + * Associative array of types eg: types('Individual'). + * @param bool $onlyPure + * True if only pure profiles are required. * * @return array $profiles associative array of profiles * @static @@ -2482,8 +2544,10 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) * Check whether a profile is valid combination of * required and/or optional profile types * - * @param array $required array of types those are required - * @param array $optional array of types those are optional + * @param array $required + * Array of types those are required. + * @param array $optional + * Array of types those are optional. * * @return array $profiles associative array of profiles * @static @@ -2512,8 +2576,10 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) * Check whether a profile is valid combination of * required profile fields * - * @param array $ufId integer id of the profile - * @param array $required array of fields those are required in the profile + * @param array $ufId + * Integer id of the profile. + * @param array $required + * Array of fields those are required in the profile. * * @return array $profiles associative array of profiles * @static @@ -2579,7 +2645,8 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) * This function is to make a copy of a profile, including * all the fields in the profile * - * @param int $id the profile id to copy + * @param int $id + * The profile id to copy. * * @return void */ @@ -2635,8 +2702,10 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) /** * Process that send notification e-mails * - * @param int $contactID contact id - * @param array $values associative array of name/value pair + * @param int $contactID + * Contact id. + * @param array $values + * Associative array of name/value pair. * * @return void */ @@ -2693,8 +2762,10 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) * for this group and notify email only if group's notify field is * set and field values are not empty * - * @param int $gid group id - * @param int $cid contact id + * @param int $gid + * Group id. + * @param int $cid + * Contact id. * @param array $params * @param bool $skipCheck * @@ -2727,7 +2798,8 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) /** * Assign uf fields to template * - * @param int $gid group id + * @param int $gid + * Group id. * @param array $values * @param CRM_Core_Smarty $template * @@ -2744,7 +2816,8 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) /** * Format fields for dupe Contact Matching * - * @param array $params associated array + * @param array $params + * Associated array. * * @param int $contactId * @@ -2878,9 +2951,11 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) /** * Calculate the profile type 'group_type' as per profile fields. * - * @param int $gId profile id + * @param int $gId + * Profile id. * @param bool $includeTypeValues - * @param int $ignoreFieldId ignore particular profile field + * @param int $ignoreFieldId + * Ignore particular profile field. * * @return array list of calculated group type */ @@ -2895,7 +2970,8 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) * * @param $ufFields * @param bool $includeTypeValues - * @param int $ignoreFieldId ignore perticular profile field + * @param int $ignoreFieldId + * Ignore perticular profile field. * * @return array list of calculated group type */ @@ -2963,7 +3039,8 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) * BirthDate + StudentField + Subject + SurveyOnlyField Individual,Activity,Student\0ActivityType:28 * * @param int $gId - * @param array $groupTypes With key having group type names + * @param array $groupTypes + * With key having group type names. * * @return Boolean */ @@ -3026,8 +3103,10 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) /** * Create a "group_type" string * - * @param array $coreTypes e.g. array('Individual','Contact','Student') - * @param array $subTypes e.g. array('ActivityType' => array(7, 11)) + * @param array $coreTypes + * E.g. array('Individual','Contact','Student'). + * @param array $subTypes + * E.g. array('ActivityType' => array(7, 11)). * @param string $delim * * @return string @@ -3053,10 +3132,14 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) /** * This function is used to setDefault componet specific profile fields. * - * @param array $fields profile fields. - * @param int $componentId componetID - * @param string $component component name - * @param array $defaults an array of default values. + * @param array $fields + * Profile fields. + * @param int $componentId + * ComponetID. + * @param string $component + * Component name. + * @param array $defaults + * An array of default values. * * @param bool $isStandalone * @@ -3192,7 +3275,8 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) /** * @param array|string $profiles - name of profile(s) to create links for - * @param array $appendProfiles - name of profile(s) to append to each link + * @param array $appendProfiles + * Name of profile(s) to append to each link. * * @return array */ @@ -3234,7 +3318,8 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) /** * Retrieve groups of profiles * - * @param integer $profileID id of the profile + * @param int $profileID + * Id of the profile. * * @return array returns array * @static @@ -3253,8 +3338,10 @@ AND ( entity_id IS NULL OR entity_id <= 0 ) * Alter contact params by filtering existing subscribed groups and returns * unsubscribed groups array for subscription. * - * @param array $params contact params - * @param int $contactId user contact id + * @param array $params + * Contact params. + * @param int $contactId + * User contact id. * * @return array $subscribeGroupIds This contains array of groups for subscription */ @@ -3326,7 +3413,8 @@ SELECT group_id /** * Check if we are rendering mixed profiles * - * @param array $profileIds associated array of profile ids + * @param array $profileIds + * Associated array of profile ids. * * @return boolean $mixProfile true if profile is mixed * @static @@ -3523,7 +3611,8 @@ SELECT group_id /** * This is function is used to format pseudo fields * - * @param array $fields associated array of profile fields + * @param array $fields + * Associated array of profile fields. * * @static */ diff --git a/CRM/Core/BAO/UFJoin.php b/CRM/Core/BAO/UFJoin.php index 8c5b056055..557e6523b0 100644 --- a/CRM/Core/BAO/UFJoin.php +++ b/CRM/Core/BAO/UFJoin.php @@ -41,7 +41,8 @@ class CRM_Core_BAO_UFJoin extends CRM_Core_DAO_UFJoin { /** * Takes an associative array and creates a uf join 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_Core_DAO_UFJoin object * @static @@ -91,7 +92,8 @@ class CRM_Core_BAO_UFJoin extends CRM_Core_DAO_UFJoin { * Given an assoc list of params, find if there is a record * for this set of params * - * @param array $params (reference) an assoc array of name/value pairs + * @param array $params + * (reference) an assoc array of name/value pairs. * * @return int or null * @static @@ -127,7 +129,8 @@ class CRM_Core_BAO_UFJoin extends CRM_Core_DAO_UFJoin { * Given an assoc list of params, find if there is a record * for this set of params and return the group id * - * @param array $params (reference) an assoc array of name/value pairs + * @param array $params + * (reference) an assoc array of name/value pairs. * * @return int or null * @static diff --git a/CRM/Core/BAO/UFMatch.php b/CRM/Core/BAO/UFMatch.php index e1c5d90997..e2f223b6f7 100644 --- a/CRM/Core/BAO/UFMatch.php +++ b/CRM/Core/BAO/UFMatch.php @@ -42,7 +42,8 @@ class CRM_Core_BAO_UFMatch extends CRM_Core_DAO_UFMatch { * Create UF Match, Note that thsi function is here in it's simplest form @ the moment * * - * @param array $params input parameters + * @param array $params + * Input parameters. */ /** * @param array $params @@ -68,8 +69,10 @@ class CRM_Core_BAO_UFMatch extends CRM_Core_DAO_UFMatch { * object for this user. If the user has new values, we need * to update the CRM DB with the new values * - * @param Object $user the drupal user object - * @param boolean $update has the user object been edited + * @param Object $user + * The drupal user object. + * @param bool $update + * Has the user object been edited. * @param $uf * * @param $ctype @@ -171,11 +174,16 @@ class CRM_Core_BAO_UFMatch extends CRM_Core_DAO_UFMatch { * Synchronize the object with the UF Match entry. Can be called stand-alone from * the drupalUsers script * - * @param Object $user the drupal user object - * @param string $userKey the id of the user from the uf object - * @param string $uniqId the OpenID of the user - * @param string $uf the name of the user framework - * @param integer $status returns the status if user created or already exits (used for CMS sync) + * @param Object $user + * The drupal user object. + * @param string $userKey + * The id of the user from the uf object. + * @param string $uniqId + * The OpenID of the user. + * @param string $uf + * The name of the user framework. + * @param int $status + * Returns the status if user created or already exits (used for CMS sync). * * @param null $ctype * @param bool $isLogin @@ -357,7 +365,8 @@ AND domain_id = %4 /** * Update the uf_name in the user object * - * @param int $contactId id of the contact to update + * @param int $contactId + * Id of the contact to update. * * @return void * @static @@ -410,8 +419,10 @@ AND domain_id = %4 /** * Update the email value for the contact and user profile * - * @param $contactId Int Contact ID of the user - * @param $emailAddress email to be modified for the user + * @param $contactId + * Int Contact ID of the user. + * @param $emailAddress + * Email to be modified for the user. * * @return void * @static @@ -465,7 +476,8 @@ AND domain_id = %4 /** * Delete the object records that are associated with this cms user * - * @param int $ufID id of the user to delete + * @param int $ufID + * Id of the user to delete. * * @return void * @static @@ -481,7 +493,8 @@ AND domain_id = %4 /** * Get the contact_id given a uf_id * - * @param int $ufID Id of UF for which related contact_id is required + * @param int $ufID + * Id of UF for which related contact_id is required. * * @return int contact_id on success, null otherwise * @static @@ -504,7 +517,8 @@ AND domain_id = %4 /** * Get the uf_id given a contact_id * - * @param int $contactID ID of the contact for which related uf_id is required + * @param int $contactID + * ID of the contact for which related uf_id is required. * * @return int uf_id of the given contact_id on success, null otherwise * @static @@ -610,7 +624,8 @@ AND domain_id = %4 /** * Get uf match values for given uf id or logged in user. * - * @param int $ufID uf id. + * @param int $ufID + * Uf id. * * return array $ufValues uf values. ** diff --git a/CRM/Core/BAO/Website.php b/CRM/Core/BAO/Website.php index 5373d463eb..ff08619fd1 100644 --- a/CRM/Core/BAO/Website.php +++ b/CRM/Core/BAO/Website.php @@ -41,7 +41,8 @@ class CRM_Core_BAO_Website extends CRM_Core_DAO_Website { /** * Takes an associative array and adds im * - * @param array $params (reference ) an assoc array of name/value pairs + * @param array $params + * (reference ) an assoc array of name/value pairs. * * @return object CRM_Core_BAO_Website object on success, null otherwise * @static @@ -61,8 +62,10 @@ class CRM_Core_BAO_Website extends CRM_Core_DAO_Website { /** * Process website * - * @param array $params associated array - * @param int $contactID contact id + * @param array $params + * Associated array. + * @param int $contactID + * Contact id. * * @param $skipDelete * @@ -111,7 +114,8 @@ class CRM_Core_BAO_Website extends CRM_Core_DAO_Website { /** * Delete website * - * @param array $ids website ids + * @param array $ids + * Website ids. * * @return void * @static @@ -154,7 +158,8 @@ class CRM_Core_BAO_Website extends CRM_Core_DAO_Website { /** * Get all the websites for a specified contact_id * - * @param int $id the contact id + * @param int $id + * The contact id. * * @param bool $updateBlankLocInfo * diff --git a/CRM/Core/BAO/WordReplacement.php b/CRM/Core/BAO/WordReplacement.php index b6a534a79d..a50f313b09 100644 --- a/CRM/Core/BAO/WordReplacement.php +++ b/CRM/Core/BAO/WordReplacement.php @@ -53,8 +53,10 @@ class CRM_Core_BAO_WordReplacement extends CRM_Core_DAO_WordReplacement { * 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_Core_DAO_WordRepalcement object * @static @@ -127,7 +129,8 @@ class CRM_Core_BAO_WordReplacement extends CRM_Core_DAO_WordReplacement { /** * Delete website * - * @param int $id WordReplacement id + * @param int $id + * WordReplacement id. * * @return object * @static @@ -145,7 +148,8 @@ class CRM_Core_BAO_WordReplacement extends CRM_Core_DAO_WordReplacement { /** * Get all word-replacements in the form of an array * - * @param int $id domain ID + * @param int $id + * Domain ID. * @return array * @see civicrm_domain.locale_custom_strings */ @@ -222,7 +226,8 @@ WHERE domain_id = %1 * However, if there's a bug in here prior to 4.4.0, we should apply the * bugfix in both places. * - * @param bool $rebuildEach whether to perform rebuild after each individual API call + * @param bool $rebuildEach + * Whether to perform rebuild after each individual API call. * @return array Each item is $params for WordReplacement.create * @see CRM_Core_BAO_WordReplacement::convertConfigArraysToAPIParams */ diff --git a/CRM/Core/Block.php b/CRM/Core/Block.php index b59591ced2..799033e72d 100644 --- a/CRM/Core/Block.php +++ b/CRM/Core/Block.php @@ -182,8 +182,10 @@ class CRM_Core_Block { /** * Returns the desired property from the $_properties array * - * @param int $id one of the class constants (ADD, SEARCH, etc.) - * @param string $property the desired property + * @param int $id + * One of the class constants (ADD, SEARCH, etc.). + * @param string $property + * The desired property. * * @return string the value of the desired property */ @@ -197,9 +199,12 @@ class CRM_Core_Block { /** * Sets the desired property in the $_properties array * - * @param int $id one of the class constants (ADD, SEARCH, etc.) - * @param string $property the desired property - * @param string $value the value of the desired property + * @param int $id + * One of the class constants (ADD, SEARCH, etc.). + * @param string $property + * The desired property. + * @param string $value + * The value of the desired property. * * @return void */ @@ -560,7 +565,8 @@ class CRM_Core_Block { /** * Given an id creates a subject/content array * - * @param int $id id of the block + * @param int $id + * Id of the block. * * @return array */ @@ -637,9 +643,12 @@ class CRM_Core_Block { /** * Given an id and a template, fetch the contents * - * @param int $id id of the block - * @param string $fileName name of the template file - * @param array $properties template variables + * @param int $id + * Id of the block. + * @param string $fileName + * Name of the template file. + * @param array $properties + * Template variables. * * @return array */ diff --git a/CRM/Core/ClassLoader.php b/CRM/Core/ClassLoader.php index 574b96416f..0022213d32 100644 --- a/CRM/Core/ClassLoader.php +++ b/CRM/Core/ClassLoader.php @@ -70,7 +70,8 @@ class CRM_Core_ClassLoader { /** * Registers this instance as an autoloader. * - * @param Boolean $prepend Whether to prepend the autoloader or not + * @param bool $prepend + * Whether to prepend the autoloader or not. * * @api */ diff --git a/CRM/Core/CodeGen/Config.php b/CRM/Core/CodeGen/Config.php index 39a5900fa7..fffbaa17e3 100644 --- a/CRM/Core/CodeGen/Config.php +++ b/CRM/Core/CodeGen/Config.php @@ -38,7 +38,8 @@ class CRM_Core_CodeGen_Config extends CRM_Core_CodeGen_BaseTask { } /** - * @param string $cms "drupal"|"wordpress" + * @param string $cms + * "drupal"|"wordpress". * @return null|string path to config template */ public function findConfigTemplate($cms) { diff --git a/CRM/Core/CodeGen/ITask.php b/CRM/Core/CodeGen/ITask.php index 2f436c9f4e..fac04e9c6b 100644 --- a/CRM/Core/CodeGen/ITask.php +++ b/CRM/Core/CodeGen/ITask.php @@ -7,7 +7,8 @@ interface CRM_Core_CodeGen_ITask { /** * Make configuration object available to the task. * - * @param $config is currently the CRM_Core_CodeGen_Main object. + * @param $config + * Is currently the CRM_Core_CodeGen_Main object. */ public function setConfig($config); diff --git a/CRM/Core/CodeGen/Specification.php b/CRM/Core/CodeGen/Specification.php index 53b47f8a00..23f00fb443 100644 --- a/CRM/Core/CodeGen/Specification.php +++ b/CRM/Core/CodeGen/Specification.php @@ -13,7 +13,8 @@ class CRM_Core_CodeGen_Specification { * Read and parse. * * @param $schemaPath - * @param string $buildVersion which version of the schema to build + * @param string $buildVersion + * Which version of the schema to build. */ public function parse($schemaPath, $buildVersion) { $this->buildVersion = $buildVersion; diff --git a/CRM/Core/CodeGen/Util/File.php b/CRM/Core/CodeGen/Util/File.php index d68c14050a..7b3b80899c 100644 --- a/CRM/Core/CodeGen/Util/File.php +++ b/CRM/Core/CodeGen/Util/File.php @@ -47,7 +47,8 @@ class CRM_Core_CodeGen_Util_File { /** * Calculate a cumulative digest based on a collection of files * - * @param array $files list of file names (strings) + * @param array $files + * List of file names (strings). * @param callable|string $digest a one-way hash function (string => string) * * @return string @@ -78,7 +79,8 @@ class CRM_Core_CodeGen_Util_File { /** * Find files in several directories using several filename patterns * - * @param array $pairs each item is an array(0 => $searchBaseDir, 1 => $filePattern) + * @param array $pairs + * Each item is an array(0 => $searchBaseDir, 1 => $filePattern). * @return array of file paths */ public static function findManyFiles($pairs) { diff --git a/CRM/Core/CodeGen/Util/Template.php b/CRM/Core/CodeGen/Util/Template.php index 89985d1af9..5f6b2f09b2 100644 --- a/CRM/Core/CodeGen/Util/Template.php +++ b/CRM/Core/CodeGen/Util/Template.php @@ -39,8 +39,10 @@ class CRM_Core_CodeGen_Util_Template { } /** - * @param array $inputs template filenames - * @param string $outpath full path to the desired output file + * @param array $inputs + * Template filenames. + * @param string $outpath + * Full path to the desired output file. */ public function runConcat($inputs, $outpath) { if (file_exists($outpath)) { @@ -53,8 +55,10 @@ class CRM_Core_CodeGen_Util_Template { } /** - * @param string $infile filename of the template, without a path - * @param string $outpath full path to the desired output file + * @param string $infile + * Filename of the template, without a path. + * @param string $outpath + * Full path to the desired output file. */ public function run($infile, $outpath) { $renderedContents = $this->smarty->fetch($infile); diff --git a/CRM/Core/CodeGen/Util/Xml.php b/CRM/Core/CodeGen/Util/Xml.php index d58e43d156..16ba470348 100644 --- a/CRM/Core/CodeGen/Util/Xml.php +++ b/CRM/Core/CodeGen/Util/Xml.php @@ -5,7 +5,8 @@ */ class CRM_Core_CodeGen_Util_Xml { /** - * @param string $file path to input + * @param string $file + * Path to input. * * @return SimpleXMLElement|bool */ diff --git a/CRM/Core/Component.php b/CRM/Core/Component.php index 84dd89d535..b8bcbc5b78 100644 --- a/CRM/Core/Component.php +++ b/CRM/Core/Component.php @@ -419,7 +419,8 @@ class CRM_Core_Component { /** * Handle table dependencies of components * - * @param array $tables array of tables + * @param array $tables + * Array of tables. * * @return null * @static diff --git a/CRM/Core/Component/Info.php b/CRM/Core/Component/Info.php index 45a1d25ca8..f9c0b07b21 100644 --- a/CRM/Core/Component/Info.php +++ b/CRM/Core/Component/Info.php @@ -98,8 +98,10 @@ abstract class CRM_Core_Component_Info { protected $keyword; /** - * @param string $name name of the component - * @param string $namespace namespace prefix for component's files + * @param string $name + * Name of the component. + * @param string $namespace + * Namespace prefix for component's files. * @param int $componentID */ public function __construct($name, $namespace, $componentID) { @@ -167,7 +169,8 @@ abstract class CRM_Core_Component_Info { /** * Determine how many other records refer to a given record * - * @param CRM_Core_DAO $dao the item for which we want a reference count + * @param CRM_Core_DAO $dao + * The item for which we want a reference count. * @return array each item in the array is an array with keys: * - name: string, eg "sql:civicrm_email:contact_id" * - type: string, eg "sql" diff --git a/CRM/Core/Config.php b/CRM/Core/Config.php index a7f7947646..c94461856a 100644 --- a/CRM/Core/Config.php +++ b/CRM/Core/Config.php @@ -187,8 +187,10 @@ class CRM_Core_Config extends CRM_Core_Config_Variables { /** * Singleton function used to manage this object. * - * @param $loadFromDB boolean whether to load from the database - * @param $force boolean whether to force a reconstruction + * @param $loadFromDB + * Boolean whether to load from the database. + * @param $force + * Boolean whether to force a reconstruction. * * @return CRM_Core_Config * @static @@ -534,7 +536,8 @@ class CRM_Core_Config extends CRM_Core_Config_Variables { /** * Retrieve a mailer to send any mail from the application * - * @param boolean $persist open a persistent smtp connection, should speed up mailings + * @param bool $persist + * Open a persistent smtp connection, should speed up mailings. * @return object */ public static function &getMailer($persist = FALSE) { @@ -612,7 +615,8 @@ class CRM_Core_Config extends CRM_Core_Config_Variables { /** * Create a new instance of a PEAR Mail driver * - * @param string $driver 'CRM_Mailing_BAO_Spool' or a name suitable for Mail::factory() + * @param string $driver + * 'CRM_Mailing_BAO_Spool' or a name suitable for Mail::factory(). * @param array $params * @return Mail (More specifically, a class which implements the "send()" function) */ @@ -661,7 +665,7 @@ class CRM_Core_Config extends CRM_Core_Config_Variables { * Verify that the needed parameters are not null in the config * * @param CRM_Core_Config (reference ) the system config object - * @param array (reference ) the parameters that need a value + * @param array (reference ) the parameters that need a value * * @return boolean * @static diff --git a/CRM/Core/Config/Defaults.php b/CRM/Core/Config/Defaults.php index ddc92b5614..f389622b75 100644 --- a/CRM/Core/Config/Defaults.php +++ b/CRM/Core/Config/Defaults.php @@ -113,7 +113,8 @@ class CRM_Core_Config_Defaults { /** * Set the default values * - * @param array $defaults associated array of form elements + * @param array $defaults + * Associated array of form elements. * @param bool|\boolena $formMode this funtion is called to set default * values in an empty db, also called when setting component using GUI * this variable is set true for GUI diff --git a/CRM/Core/Controller.php b/CRM/Core/Controller.php index dfa475c648..48cda51967 100644 --- a/CRM/Core/Controller.php +++ b/CRM/Core/Controller.php @@ -382,8 +382,8 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { * Helper function to add all the needed default actions. Note that the framework * redefines all of the default QFC actions * - * @param string directory to store all the uploaded files - * @param array names for the various upload buttons (note u can have more than 1 upload) + * @param string directory to store all the uploaded files + * @param array names for the various upload buttons (note u can have more than 1 upload) * * * @return void @@ -519,8 +519,9 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { /** * Store the variable with the value in the form scope * - * @param string|array $name name of the variable or an assoc array of name/value pairs - * @param mixed $value value of the variable if string + * @param string|array $name name of the variable or an assoc array of name/value pairs + * @param mixed $value + * Value of the variable if string. * * * @return void @@ -533,7 +534,8 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { /** * Get the variable from the form scope * - * @param string $name : name of the variable + * @param string $name + * : name of the variable. * * @@ -548,7 +550,8 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { * Create the header for the wizard from the list of pages * Store the created header in smarty * - * @param string $currentPageName name of the page being displayed + * @param string $currentPageName + * Name of the page being displayed. * * @return array */ @@ -604,7 +607,8 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { * Assign value to name in template * * @param string $var - * @param mixed $value value of varaible + * @param mixed $value + * Value of varaible. * * @return void */ @@ -616,7 +620,8 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { * Assign value to name in template by reference * * @param string $var - * @param mixed $value (reference) value of varaible + * @param mixed $value + * (reference) value of varaible. * * @return void */ @@ -628,7 +633,8 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { * Appends values to template variables * * @param array|string $tpl_var the template variable name(s) - * @param mixed $value the value to append + * @param mixed $value + * The value to append. * @param bool $merge */ public function append($tpl_var, $value=NULL, $merge=FALSE) { @@ -649,7 +655,7 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { /** * Setter for embedded * - * @param boolean $embedded + * @param bool $embedded * * @return void */ @@ -669,7 +675,7 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { /** * Setter for skipRedirection * - * @param boolean $skipRedirection + * @param bool $skipRedirection * * @return void */ @@ -718,7 +724,7 @@ class CRM_Core_Controller extends HTML_QuickForm_Controller { /** * Setter for print * - * @param boolean $print + * @param bool $print * * @return void */ diff --git a/CRM/Core/Controller/Simple.php b/CRM/Core/Controller/Simple.php index a9ff7219eb..d27171db0a 100644 --- a/CRM/Core/Controller/Simple.php +++ b/CRM/Core/Controller/Simple.php @@ -43,10 +43,12 @@ class CRM_Core_Controller_Simple extends CRM_Core_Controller { * * @param null $path * @param bool $title - * @param string path the class Path of the form being implemented + * @param string path the class Path of the form being implemented * @param bool $imageUpload - * @param bool $addSequence should we add a unique sequence number to the end of the key - * @param bool $ignoreKey should we not set a qfKey for this controller (for standalone forms) + * @param bool $addSequence + * Should we add a unique sequence number to the end of the key. + * @param bool $ignoreKey + * Should we not set a qfKey for this controller (for standalone forms). * @param bool $attachUpload * * diff --git a/CRM/Core/DAO.php b/CRM/Core/DAO.php index 685fe8a695..92f266caf5 100644 --- a/CRM/Core/DAO.php +++ b/CRM/Core/DAO.php @@ -97,7 +97,8 @@ class CRM_Core_DAO extends DB_DataObject { /** * Initialize the DAO object * - * @param string $dsn the database connection string + * @param string $dsn + * The database connection string. * * @return void * @static @@ -162,7 +163,8 @@ class CRM_Core_DAO extends DB_DataObject { * * @param string $fieldName * @param array $fieldDef - * @param int $counter the globally-unique ID of the test object + * @param int $counter + * The globally-unique ID of the test object. */ protected function assignTestValue($fieldName, &$fieldDef, $counter) { $dbName = $fieldDef['name']; @@ -308,8 +310,10 @@ class CRM_Core_DAO extends DB_DataObject { /** * Execute a query by the current DAO, localizing it along the way (if needed). * - * @param string $query the SQL query for execution - * @param bool $i18nRewrite whether to rewrite the query + * @param string $query + * The SQL query for execution. + * @param bool $i18nRewrite + * Whether to rewrite the query. * * @return object the current DAO object after the query execution */ @@ -326,7 +330,8 @@ class CRM_Core_DAO extends DB_DataObject { /** * Static function to set the factory instance for this class. * - * @param object $factory the factory application object + * @param object $factory + * The factory application object. * * @return void * @static @@ -415,7 +420,7 @@ class CRM_Core_DAO extends DB_DataObject { /** * Get/set an associative array of table columns * - * @param array key=>type array + * @param array key=>type array * @return array (associative) */ public function table() { @@ -498,7 +503,8 @@ class CRM_Core_DAO extends DB_DataObject { * Given an associative array of name/value pairs, extract all the values * that belong to this object and initialize the object with said values * - * @param array $params (reference ) associative array of name/value pairs + * @param array $params + * (reference ) associative array of name/value pairs. * * @return boolean did we copy all null values into the object */ @@ -538,8 +544,10 @@ class CRM_Core_DAO extends DB_DataObject { * this is a destructive store, calling function is responsible * for keeping sanity of id's. * - * @param object $object the object that we are extracting data from - * @param array $values (reference ) associative array of name/value pairs + * @param object $object + * The object that we are extracting data from. + * @param array $values + * (reference ) associative array of name/value pairs. * * @return void * @static @@ -560,7 +568,8 @@ class CRM_Core_DAO extends DB_DataObject { /** * Create an attribute for this specific field. We only do this for strings and text * - * @param array $field the field under task + * @param array $field + * The field under task. * * @return array|null the attributes for the object * @static @@ -609,8 +618,10 @@ class CRM_Core_DAO extends DB_DataObject { * Get the size and maxLength attributes for this text field * (or for all text fields) in the DAO object. * - * @param string $class name of DAO class - * @param string $fieldName field that i'm interested in or null if + * @param string $class + * Name of DAO class. + * @param string $fieldName + * Field that i'm interested in or null if. * you want the attributes for all DAO text fields * * @return array assoc array of name => attribute pairs @@ -651,11 +662,15 @@ class CRM_Core_DAO extends DB_DataObject { /** * Check if there is a record with the same name in the db * - * @param string $value the value of the field we are checking - * @param string $daoName the dao object name - * @param string $daoID the id of the object being updated. u can change your name + * @param string $value + * The value of the field we are checking. + * @param string $daoName + * The dao object name. + * @param string $daoID + * The id of the object being updated. u can change your name. * as long as there is no conflict - * @param string $fieldName the name of the field in the DAO + * @param string $fieldName + * The name of the field in the DAO. * * @return boolean true if object exists * @static @@ -679,7 +694,8 @@ class CRM_Core_DAO extends DB_DataObject { * * @param string $tableName * @param string $columnName - * @param bool $i18nRewrite whether to rewrite the query on multilingual setups + * @param bool $i18nRewrite + * Whether to rewrite the query on multilingual setups. * * @return boolean true if exists, else false * @static @@ -924,7 +940,8 @@ FROM civicrm_domain /** * Find a DAO object for the given ID and return it. * - * @param int $id Id of the DAO object being searched for. + * @param int $id + * Id of the DAO object being searched for. * * @return object Object of the type of the class that called this function. */ @@ -940,11 +957,16 @@ FROM civicrm_domain /** * Given a DAO name, a column name and a column value, find the record and GET the value of another column in that record * - * @param string $daoName Name of the DAO (Example: CRM_Contact_DAO_Contact to retrieve value from a contact) - * @param int $searchValue Value of the column you want to search by - * @param string $returnColumn Name of the column you want to GET the value of - * @param string $searchColumn Name of the column you want to search by - * @param boolean $force Skip use of the cache + * @param string $daoName + * Name of the DAO (Example: CRM_Contact_DAO_Contact to retrieve value from a contact). + * @param int $searchValue + * Value of the column you want to search by. + * @param string $returnColumn + * Name of the column you want to GET the value of. + * @param string $searchColumn + * Name of the column you want to search by. + * @param bool $force + * Skip use of the cache. * * @return string|null Value of $returnColumn in the retrieved record * @static @@ -985,11 +1007,16 @@ FROM civicrm_domain /** * Given a DAO name, a column name and a column value, find the record and SET the value of another column in that record * - * @param string $daoName Name of the DAO (Example: CRM_Contact_DAO_Contact to retrieve value from a contact) - * @param int $searchValue Value of the column you want to search by - * @param string $setColumn Name of the column you want to SET the value of - * @param string $setValue SET the setColumn to this value - * @param string $searchColumn Name of the column you want to search by + * @param string $daoName + * Name of the DAO (Example: CRM_Contact_DAO_Contact to retrieve value from a contact). + * @param int $searchValue + * Value of the column you want to search by. + * @param string $setColumn + * Name of the column you want to SET the value of. + * @param string $setValue + * SET the setColumn to this value. + * @param string $searchColumn + * Name of the column you want to search by. * * @return boolean true if we found and updated the object, else false * @static @@ -1014,7 +1041,8 @@ FROM civicrm_domain * Get sort string * * @param array|object $sort either array or CRM_Utils_Sort - * @param string $default - default sort value + * @param string $default + * Default sort value. * * @return string - sortString * @static @@ -1038,10 +1066,14 @@ FROM civicrm_domain /** * Fetch object based on array of properties * - * @param string $daoName name of the dao object - * @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 $returnProperities an assoc array of fields that need to be returned, eg array( 'first_name', 'last_name') + * @param string $daoName + * Name of the dao object. + * @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 $returnProperities + * An assoc array of fields that need to be returned, eg array( 'first_name', 'last_name'). * * @return object an object of type referenced by daoName * @static @@ -1066,8 +1098,10 @@ FROM civicrm_domain /** * Delete the object records that are associated with this contact * - * @param string $daoName name of the dao object - * @param int $contactId id of the contact to delete + * @param string $daoName + * Name of the dao object. + * @param int $contactId + * Id of the contact to delete. * * @return void * @static @@ -1083,7 +1117,8 @@ FROM civicrm_domain /** * Execute a query * - * @param string $query query to be executed + * @param string $query + * Query to be executed. * * @param array $params * @param bool $abort @@ -1136,7 +1171,8 @@ FROM civicrm_domain /** * Execute a query and get the single result * - * @param string $query query to be executed + * @param string $query + * Query to be executed. * @param array $params * @param bool $abort * @param bool $i18nRewrite @@ -1256,13 +1292,18 @@ FROM civicrm_domain * This function is to make a shallow copy of an object * and all the fields in the object * - * @param string $daoName name of the dao - * @param array $criteria array of all the fields & values + * @param string $daoName + * Name of the dao. + * @param array $criteria + * Array of all the fields & values. * on which basis to copy - * @param array $newData array of all the fields & values + * @param array $newData + * Array of all the fields & values. * to be copied besides the other fields - * @param string $fieldsFix array of fields that you want to prefix/suffix/replace - * @param string $blockCopyOfDependencies fields that you want to block from + * @param string $fieldsFix + * Array of fields that you want to prefix/suffix/replace. + * @param string $blockCopyOfDependencies + * Fields that you want to block from. * getting copied * * @@ -1409,11 +1450,13 @@ SELECT contact_id /** * Fetch object based on array of properties * - * @param string $daoName name of the dao object + * @param string $daoName + * Name of the dao object. * @param string $fieldIdName * @param int $fieldId * @param $details - * @param array $returnProperities an assoc array of fields that need to be returned, eg array( 'first_name', 'last_name') + * @param array $returnProperities + * An assoc array of fields that need to be returned, eg array( 'first_name', 'last_name'). * * @return object an object of type referenced by daoName * @static @@ -1489,8 +1532,10 @@ SELECT contact_id /** * Escape a list of strings for use with "WHERE X IN (...)" queries. * - * @param $strings array - * @param $default string the value to use if $strings has no elements + * @param $strings + * Array. + * @param $default + * String the value to use if $strings has no elements. * @return string eg "abc","def","ghi" */ public static function escapeStrings($strings, $default = NULL) { @@ -1757,7 +1802,8 @@ SELECT contact_id * Build a list of triggers via hook and add them to (err, reconcile them * with) the database. * - * @param $tableName string the specific table requiring a rebuild; or NULL to rebuild all tables + * @param $tableName + * String the specific table requiring a rebuild; or NULL to rebuild all tables. * @param bool $force * * @see CRM-9716 @@ -1800,7 +1846,8 @@ SELECT contact_id /** * Wrapper function to drop triggers * - * @param $tableName string the specific table requiring a rebuild; or NULL to rebuild all tables + * @param $tableName + * String the specific table requiring a rebuild; or NULL to rebuild all tables. */ public static function dropTriggers($tableName = NULL) { $info = array(); @@ -1813,8 +1860,10 @@ SELECT contact_id } /** - * @param $info array per hook_civicrm_triggerInfo - * @param $onlyTableName string the specific table requiring a rebuild; or NULL to rebuild all tables + * @param $info + * Array per hook_civicrm_triggerInfo. + * @param $onlyTableName + * String the specific table requiring a rebuild; or NULL to rebuild all tables. */ public static function createTriggers(&$info, $onlyTableName = NULL) { // Validate info array, should probably raise errors? @@ -1924,7 +1973,8 @@ SELECT contact_id /** * Given a list of fields, create a list of references. * - * @param string $className BAO/DAO class name + * @param string $className + * BAO/DAO class name. * @return array */ public static function createReferenceColumns($className) { @@ -2007,7 +2057,8 @@ SELECT contact_id * schema metadata in dynamicForeignKey which enumerates a restricted * set of possible entity_table's. * - * @param string $tableName table referred to + * @param string $tableName + * Table referred to. * * @return array structure of table and column, listing every table with a * foreign key reference to $tableName, and the column where the key appears. @@ -2031,7 +2082,8 @@ SELECT contact_id /** * Lookup the value of a MySQL global configuration variable. * - * @param string $name e.g. "thread_stack" + * @param string $name + * E.g. "thread_stack". * @param mixed $default * @return mixed */ @@ -2054,8 +2106,10 @@ SELECT contact_id * The overriding function will generally call the lower-level CRM_Core_PseudoConstant::get * * @param string $fieldName - * @param string $context : @see CRM_Core_DAO::buildOptionsContext - * @param array $props : whatever is known about this bao object + * @param string $context + * : @see CRM_Core_DAO::buildOptionsContext. + * @param array $props + * : whatever is known about this bao object. * * @return Array|bool */ @@ -2091,7 +2145,7 @@ SELECT contact_id /** * Provides documentation and validation for the buildOptions $context param * - * @param String $context + * @param string $context * * @throws Exception * @return array @@ -2137,11 +2191,16 @@ SELECT contact_id * $field => array('LIKE' => array('%me%)) * etc * - * @param string $fieldName name of fields - * @param $filter array filter to be applied indexed by operator - * @param $type String type of field (not actually used - nor in api @todo ) - * @param $alias String alternative field name ('as') @todo- not actually used - * @param bool $returnSanitisedArray return a sanitised array instead of a clause + * @param string $fieldName + * Name of fields. + * @param $filter + * Array filter to be applied indexed by operator. + * @param $type + * String type of field (not actually used - nor in api @todo ). + * @param $alias + * String alternative field name ('as') @todo- not actually used. + * @param bool $returnSanitisedArray + * Return a sanitised array instead of a clause. * this is primarily so we can add filters @ the api level to the Query object based fields * * @throws Exception @@ -2234,8 +2293,10 @@ SELECT contact_id * which can be longer than this length, this function helps with creating * strings that meet various criteria. * - * @param string $string - the string to be shortened - * @param int $length - the max length of the string + * @param string $string + * The string to be shortened. + * @param int $length + * The max length of the string. * * @param bool $makeRandom * diff --git a/CRM/Core/Error.php b/CRM/Core/Error.php index e6b543fac9..81c8f1e71c 100644 --- a/CRM/Core/Error.php +++ b/CRM/Core/Error.php @@ -299,9 +299,12 @@ class CRM_Core_Error extends PEAR_ErrorStack { /** * Display an error page with an error message describing what happened * - * @param string $message the error message - * @param string $code the error code if any - * @param string $email the email address to notify of this situation + * @param string $message + * The error message. + * @param string $code + * The error code if any. + * @param string $email + * The email address to notify of this situation. * * @throws Exception * @@ -465,11 +468,11 @@ class CRM_Core_Error extends PEAR_ErrorStack { * Outputs pre-formatted debug information. Flushes the buffers * so we can interrupt a potential POST/redirect * - * @param string name of debug section - * @param mixed reference to variables that we need a trace of - * @param bool should we log or return the output - * @param bool whether to generate a HTML-escaped output - * @param bool should we check permissions before displaying output + * @param string name of debug section + * @param mixed reference to variables that we need a trace of + * @param bool should we log or return the output + * @param bool whether to generate a HTML-escaped output + * @param bool should we check permissions before displaying output * useful when we die during initialization and permissioning * subsystem is not initialized - CRM-13765 * @@ -515,9 +518,12 @@ class CRM_Core_Error extends PEAR_ErrorStack { * * @param string $variable_name * @param mixed $variable - * @param bool $print should we use print_r ? (else we use var_dump) - * @param bool $log should we log or return the output - * @param string $comp variable name + * @param bool $print + * Should we use print_r ? (else we use var_dump). + * @param bool $log + * Should we log or return the output. + * @param string $comp + * Variable name. * * @return string the generated output * @@ -562,9 +568,11 @@ class CRM_Core_Error extends PEAR_ErrorStack { * Display the error message on terminal * * @param $message - * @param bool $out should we log or return the output + * @param bool $out + * Should we log or return the output. * - * @param string $comp message to be output + * @param string $comp + * Message to be output. * @return string format of the backtrace * * @@ -671,9 +679,12 @@ class CRM_Core_Error extends PEAR_ErrorStack { /** * Render a backtrace array as a string * - * @param array $backTrace array of stack frames - * @param boolean $showArgs TRUE if we should try to display content of function arguments (which could be sensitive); FALSE to display only the type of each function argument - * @param int $maxArgLen maximum number of characters to show from each argument string + * @param array $backTrace + * Array of stack frames. + * @param bool $showArgs + * TRUE if we should try to display content of function arguments (which could be sensitive); FALSE to display only the type of each function argument. + * @param int $maxArgLen + * Maximum number of characters to show from each argument string. * @return string printable plain-text */ public static function formatBacktrace($backTrace, $showArgs = TRUE, $maxArgLen = 80) { @@ -688,9 +699,12 @@ class CRM_Core_Error extends PEAR_ErrorStack { /** * Render a backtrace array as an array * - * @param array $backTrace array of stack frames - * @param boolean $showArgs TRUE if we should try to display content of function arguments (which could be sensitive); FALSE to display only the type of each function argument - * @param int $maxArgLen maximum number of characters to show from each argument string + * @param array $backTrace + * Array of stack frames. + * @param bool $showArgs + * TRUE if we should try to display content of function arguments (which could be sensitive); FALSE to display only the type of each function argument. + * @param int $maxArgLen + * Maximum number of characters to show from each argument string. * @return array * @see debug_backtrace * @see Exception::getTrace() @@ -826,7 +840,8 @@ class CRM_Core_Error extends PEAR_ErrorStack { /** * Set a status message in the session, then bounce back to the referrer. * - * @param string $status The status message to set + * @param string $status + * The status message to set. * * @param null $redirect * @param string $title @@ -873,7 +888,8 @@ class CRM_Core_Error extends PEAR_ErrorStack { /** * PEAR error-handler to quietly catch otherwise fatal errors. Intended for use with smtp transport. * - * @param object $obj The PEAR_ERROR object + * @param object $obj + * The PEAR_ERROR object. * @return object $obj * @static */ diff --git a/CRM/Core/Exception.php b/CRM/Core/Exception.php index b14e863358..855b947515 100644 --- a/CRM/Core/Exception.php +++ b/CRM/Core/Exception.php @@ -30,10 +30,13 @@ * Base class for exceptions generated by CiviCRM. * This Exception returns more information than the default one. We are using it from the * form layer to allow redirects to occur without having redirects in the BAO - * @param string $message the human friendly error message - * @param string $error_code a computer friendly error code. By convention, no space (but underscore allowed) + * @param string $message + * The human friendly error message. + * @param string $error_code + * A computer friendly error code. By convention, no space (but underscore allowed). * ex: mandatory_missing, duplicate, invalid_format - * @param array $data extra params to return. eg an extra array of ids. It is not mandatory, but can help the computer using the api. Keep in mind the api consumer isn't to be trusted. eg. the database password is NOT a good extra data + * @param array $data + * Extra params to return. eg an extra array of ids. It is not mandatory, but can help the computer using the api. Keep in mind the api consumer isn't to be trusted. eg. the database password is NOT a good extra data. */ class CRM_Core_Exception extends PEAR_Exception { diff --git a/CRM/Core/FileSearchInterface.php b/CRM/Core/FileSearchInterface.php index eb41768da7..e1267968c5 100644 --- a/CRM/Core/FileSearchInterface.php +++ b/CRM/Core/FileSearchInterface.php @@ -4,7 +4,8 @@ interface CRM_Core_FileSearchInterface { const DEFAULT_SEARCH_OFFSET = 0; /** - * @param array $query any of the following: + * @param array $query + * Any of the following:. * - text: string, plain text to search for * - parent_table: string - entity to which file is directly attached * - parent_id: int - entity to which file is directly attached diff --git a/CRM/Core/Form.php b/CRM/Core/Form.php index b9689f6b11..62362f76a2 100644 --- a/CRM/Core/Form.php +++ b/CRM/Core/Form.php @@ -157,10 +157,13 @@ class CRM_Core_Form extends HTML_QuickForm_Page { * We should not use QuickForm directly. This class provides a lot * of default convenient functions, rules and buttons * - * @param object $state State associated with this form + * @param object $state + * State associated with this form. * @param \const|\enum|int $action The mode the form is operating in (None/Create/View/Update/Delete) - * @param string $method The type of http method used (GET/POST) - * @param string $name The name of the form if different from class name + * @param string $method + * The type of http method used (GET/POST). + * @param string $name + * The name of the form if different from class name. * * @return \CRM_Core_Form */ @@ -243,7 +246,8 @@ class CRM_Core_Form extends HTML_QuickForm_Page { * @param string $label * @param string|array $attributes (options for select elements) * @param bool $required - * @param array $extra (attributes for select elements) + * @param array $extra + * (attributes for select elements). * * @return HTML_QuickForm_Element could be an error object */ @@ -316,7 +320,8 @@ class CRM_Core_Form extends HTML_QuickForm_Page { /** * This function is just a wrapper, so that we can call all the hook functions - * @param bool $allowAjax - FIXME: This feels kind of hackish, ideally we would take the json-related code from this function + * @param bool $allowAjax + * FIXME: This feels kind of hackish, ideally we would take the json-related code from this function. * and bury it deeper down in the controller */ public function mainProcess($allowAjax = TRUE) { @@ -475,7 +480,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { /** * Add default Next / Back buttons * - * @param array array of associative arrays in the order in which the buttons should be + * @param array array of associative arrays in the order in which the buttons should be * displayed. The associate array has 3 fields: 'type', 'name' and 'isDefault' * The base form class will define a bunch of static arrays for commonly used * formats @@ -576,7 +581,8 @@ class CRM_Core_Form extends HTML_QuickForm_Page { /** * Setter function for title. * - * @param string $title the title of the form + * @param string $title + * The title of the form. * * @return void */ @@ -708,9 +714,12 @@ class CRM_Core_Form extends HTML_QuickForm_Page { /** * Error reporting mechanism * - * @param string $message Error Message - * @param int $code Error Code - * @param CRM_Core_DAO $dao A data access object on which we perform a rollback if non - empty + * @param string $message + * Error Message. + * @param int $code + * Error Code. + * @param CRM_Core_DAO $dao + * A data access object on which we perform a rollback if non - empty. * * @return void */ @@ -727,8 +736,8 @@ class CRM_Core_Form extends HTML_QuickForm_Page { /** * Store the variable with the value in the form scope * - * @param string name : name of the variable - * @param mixed value : value of the variable + * @param string name : name of the variable + * @param mixed value : value of the variable * * * @return void @@ -741,7 +750,7 @@ class CRM_Core_Form extends HTML_QuickForm_Page { /** * Get the variable from the form scope * - * @param string name : name of the variable + * @param string name : name of the variable * * * @return mixed @@ -763,7 +772,8 @@ class CRM_Core_Form extends HTML_QuickForm_Page { /** * Setter for action * - * @param int $action the mode we want to set the form + * @param int $action + * The mode we want to set the form. * * @return void */ @@ -774,8 +784,10 @@ class CRM_Core_Form extends HTML_QuickForm_Page { /** * Assign value to name in template * - * @param string $var name of variable - * @param mixed $value value of variable + * @param string $var + * Name of variable. + * @param mixed $value + * Value of variable. * * @return void */ @@ -786,8 +798,10 @@ class CRM_Core_Form extends HTML_QuickForm_Page { /** * Assign value to name in template by reference * - * @param string $var name of variable - * @param mixed $value value of varaible + * @param string $var + * Name of variable. + * @param mixed $value + * Value of varaible. * * @return void */ @@ -799,7 +813,8 @@ class CRM_Core_Form extends HTML_QuickForm_Page { * Appends values to template variables * * @param array|string $tpl_var the template variable name(s) - * @param mixed $value the value to append + * @param mixed $value + * The value to append. * @param bool $merge */ public function append($tpl_var, $value=NULL, $merge=FALSE) { @@ -930,8 +945,10 @@ class CRM_Core_Form extends HTML_QuickForm_Page { * 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|string $submitOnce If true, add javascript to next button submit which prevents it from being clicked more than once * @@ -982,8 +999,10 @@ class CRM_Core_Form extends HTML_QuickForm_Page { * Adds a select based on field metadata * TODO: This could be even more generic and widget type (select in this case) could also be read from metadata * Perhaps a method like $form->bind($name) which would look up all metadata for named field - * @param $name - field name to go on the form - * @param array $props - mix of html attributes and special properties, namely + * @param $name + * Field name to go on the form. + * @param array $props + * Mix of html attributes and special properties, namely. * - entity (api entity name, can usually be inferred automatically from the form class) * - field (field name - only needed if different from name used on the form) * - option_url - path to edit this option list - usually retrieved automatically - set to NULL to disable link @@ -1048,12 +1067,17 @@ class CRM_Core_Form extends HTML_QuickForm_Page { /** * Add a widget for selecting/editing/creating/copying a profile form * - * @param string $name HTML form-element name - * @param string $label Printable label - * @param string $allowCoreTypes only present a UFGroup if its group_type includes a subset of $allowCoreTypes; e.g. 'Individual', 'Activity' - * @param string $allowSubTypes only present a UFGroup if its group_type is compatible with $allowSubypes + * @param string $name + * HTML form-element name. + * @param string $label + * Printable label. + * @param string $allowCoreTypes + * Only present a UFGroup if its group_type includes a subset of $allowCoreTypes; e.g. 'Individual', 'Activity'. + * @param string $allowSubTypes + * Only present a UFGroup if its group_type is compatible with $allowSubypes. * @param array $entities - * @param bool $default //CRM-15427 + * @param bool $default + * //CRM-15427. */ public function addProfileSelector($name, $label, $allowCoreTypes, $allowSubTypes, $entities, $default = FALSE) { // Output widget @@ -1225,16 +1249,20 @@ class CRM_Core_Form extends HTML_QuickForm_Page { /** * Add date - * @param string $name name of the element - * @param string $label label of the element - * @param array $attributes key / value pair + * @param string $name + * Name of the element. + * @param string $label + * Label of the element. + * @param array $attributes + * Key / value pair. * * // if you need time * $attributes = array( * 'addTime' => true, * 'formatType' => 'relative' or 'birth' etc check advanced date settings * ); - * @param boolean $required true if required + * @param bool $required + * True if required. * */ public function addDate($name, $label, $required = FALSE, $attributes = NULL) { @@ -1382,7 +1410,8 @@ class CRM_Core_Form extends HTML_QuickForm_Page { * Create a single or multiple entity ref field * @param string $name * @param string $label - * @param array $props mix of html and widget properties, including: + * @param array $props + * Mix of html and widget properties, including:. * - select - params to give to select2 widget * - entity - defaults to contact * - create - can the user create a new entity on-the-fly? @@ -1440,7 +1469,8 @@ class CRM_Core_Form extends HTML_QuickForm_Page { * BAO layer. In this case fields are checked against the $_datefields defined for the form * and if time is defined it is incorporated * - * @param array $params input params from the form + * @param array $params + * Input params from the form. * * @todo it would probably be better to work on $this->_params than a passed array * @todo standardise the format which dates are passed to the BAO layer in & remove date @@ -1575,7 +1605,8 @@ class CRM_Core_Form extends HTML_QuickForm_Page { * * {/if} * - * @param array $profiles ids of profiles that are on the form (to be autofilled) + * @param array $profiles + * Ids of profiles that are on the form (to be autofilled). * @param array $autoCompleteField * * - name_field @@ -1642,8 +1673,9 @@ class CRM_Core_Form extends HTML_QuickForm_Page { /** * Set default values on form for given contact (or no contact defaults) * - * @param mixed $profile_id (can be id, or profile name) - * @param integer $contactID + * @param mixed $profile_id + * (can be id, or profile name). + * @param int $contactID * * @return array */ diff --git a/CRM/Core/Form/Date.php b/CRM/Core/Form/Date.php index 74b9a8303a..f244db0d74 100644 --- a/CRM/Core/Form/Date.php +++ b/CRM/Core/Form/Date.php @@ -42,7 +42,8 @@ Class CRM_Core_Form_Date { /** * This function is to build the date-format form * - * @param CRM_Core_Form $form the form object that we are operating on + * @param CRM_Core_Form $form + * The form object that we are operating on. * * @static */ @@ -73,14 +74,16 @@ Class CRM_Core_Form_Date { * This function is to retrieve the date range - relative or absolute * and assign it to the form * - * @param CRM_Core_Form $form - the form the dates should be added to + * @param CRM_Core_Form $form + * The form the dates should be added to. * @param string $fieldName - * @param integer $count + * @param int $count * @param string $from * @param string $to * @param string $fromLabel - * @param boolean $required - * @param array $operators Additional value pairs to add + * @param bool $required + * @param array $operators + * Additional value pairs to add. * @param string $dateFormat * @param bool|string $displayTime * @@ -112,16 +115,18 @@ Class CRM_Core_Form_Date { * This function is to build the date range array that will provide the form option values * It can be - relative or absolute * - * @param CRM_Core_Form $form the form object that we are operating on + * @param CRM_Core_Form $form + * The form object that we are operating on. * @param string $fieldName - * @param integer $count - * @param String $from - * @param String $to - * @param String $fromLabel - * @param Boolean $required - * @param Array $operators Additional Operator Selections to add - * @param String $dateFormat - * @param Boolean $displayTime + * @param int $count + * @param string $from + * @param string $to + * @param string $fromLabel + * @param bool $required + * @param array $operators + * Additional Operator Selections to add. + * @param string $dateFormat + * @param bool $displayTime * @return array Values for Selector */ static function returnDateRangeSelector( @@ -224,15 +229,18 @@ Class CRM_Core_Form_Date { /** * This function is to build the date range - relative or absolute * - * @param CRM_Core_Form $form the form object that we are operating on + * @param CRM_Core_Form $form + * The form object that we are operating on. * @param string $fieldName - * @param Array $selector array of option values to add - * @param string $from Label + * @param array $selector + * Array of option values to add. + * @param string $from + * Label. * @param string|\stringe $to * @param string $fromLabel - * @param boolean $required + * @param bool $required * @param string $dateFormat - * @param boolean $displayTime + * @param bool $displayTime * * @return null */ diff --git a/CRM/Core/Form/RecurringEntity.php b/CRM/Core/Form/RecurringEntity.php index 96a82a7e18..7081143b0a 100644 --- a/CRM/Core/Form/RecurringEntity.php +++ b/CRM/Core/Form/RecurringEntity.php @@ -227,7 +227,8 @@ class CRM_Core_Form_RecurringEntity { /** * 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 diff --git a/CRM/Core/Form/Renderer.php b/CRM/Core/Form/Renderer.php index 9a50bf101f..9422f0adf0 100644 --- a/CRM/Core/Form/Renderer.php +++ b/CRM/Core/Form/Renderer.php @@ -94,9 +94,12 @@ class CRM_Core_Form_Renderer extends HTML_QuickForm_Renderer_ArraySmarty { * make the html compliant with our css etc * * - * @param $element HTML_QuickForm_element - * @param $required bool - Whether an element is required - * @param $error string - Error associated with the element + * @param $element + * HTML_QuickForm_element. + * @param $required + * Bool - Whether an element is required. + * @param $error + * String - Error associated with the element. * * @return array */ @@ -142,9 +145,12 @@ class CRM_Core_Form_Renderer extends HTML_QuickForm_Renderer_ArraySmarty { * based attributes so we can style this form element better * * - * @param $element HTML_QuickForm_element object - * @param $required bool Whether an element is required - * @param $error string Error associated with the element + * @param $element + * HTML_QuickForm_element object. + * @param $required + * Bool Whether an element is required. + * @param $error + * String Error associated with the element. * * @return array * @static @@ -203,7 +209,8 @@ class CRM_Core_Form_Renderer extends HTML_QuickForm_Renderer_ArraySmarty { /** * Convert IDs to values and format for display * - * @param $field HTML_QuickForm_element + * @param $field + * HTML_QuickForm_element. */ public static function preProcessEntityRef($field) { $val = $field->getValue(); @@ -235,8 +242,10 @@ class CRM_Core_Form_Renderer extends HTML_QuickForm_Renderer_ArraySmarty { /** * Render entity references as text. * If user has permission, format as link (for now limited to contacts). - * @param $el array - * @param $field HTML_QuickForm_element + * @param $el + * Array. + * @param $field + * HTML_QuickForm_element. */ public function renderFrozenEntityRef(&$el, $field) { $entity = $field->getAttribute('data-api-entity'); @@ -265,7 +274,8 @@ class CRM_Core_Form_Renderer extends HTML_QuickForm_Renderer_ArraySmarty { * * Todo: Migrate contact reference fields to use EntityRef * - * @param $field HTML_QuickForm_element + * @param $field + * HTML_QuickForm_element. */ public static function preprocessContactReference($field) { $val = $field->getValue(); diff --git a/CRM/Core/Form/Tag.php b/CRM/Core/Form/Tag.php index 26d25412b8..f0399c196e 100644 --- a/CRM/Core/Form/Tag.php +++ b/CRM/Core/Form/Tag.php @@ -43,13 +43,20 @@ class CRM_Core_Form_Tag { /** * Build tag widget if correct parent is passed * - * @param CRM_Core_Form $form form object - * @param string $parentNames parent name ( tag name) - * @param string $entityTable entitytable 'eg: civicrm_contact' - * @param int $entityId entityid 'eg: contact id' - * @param boolean $skipTagCreate true if tag need be created using ajax - * @param boolean $skipEntityAction true if need to add entry in entry table via ajax - * @param string $tagsetElementName if you need to create tagsetlist with specific name + * @param CRM_Core_Form $form + * Form object. + * @param string $parentNames + * Parent name ( tag name). + * @param string $entityTable + * Entitytable 'eg: civicrm_contact'. + * @param int $entityId + * Entityid 'eg: contact id'. + * @param bool $skipTagCreate + * True if tag need be created using ajax. + * @param bool $skipEntityAction + * True if need to add entry in entry table via ajax. + * @param string $tagsetElementName + * If you need to create tagsetlist with specific name. * * @return void * @static @@ -117,10 +124,14 @@ class CRM_Core_Form_Tag { /** * Save entity tags when it is not save used AJAX * - * @param array $params associated array - * @param int $entityId entity id, eg: contact id, activity id, case id, file id - * @param string $entityTable entity table - * @param CRM_Core_Form $form form object + * @param array $params + * Associated array. + * @param int $entityId + * Entity id, eg: contact id, activity id, case id, file id. + * @param string $entityTable + * Entity table. + * @param CRM_Core_Form $form + * Form object. * * @return void * @static diff --git a/CRM/Core/HTMLInputCoder.php b/CRM/Core/HTMLInputCoder.php index 4ecf187876..13cb432f54 100644 --- a/CRM/Core/HTMLInputCoder.php +++ b/CRM/Core/HTMLInputCoder.php @@ -43,7 +43,8 @@ class CRM_Core_HTMLInputCoder { * submitted values across XSS vulnerability. * * @param array|string $values - * @param bool $castToString If TRUE, all scalars will be filtered (and therefore cast to strings) + * @param bool $castToString + * If TRUE, all scalars will be filtered (and therefore cast to strings). * If FALSE, then non-string values will be preserved */ public static function encodeInput(&$values, $castToString = TRUE) { diff --git a/CRM/Core/I18n.php b/CRM/Core/I18n.php index 8fef7866cc..ee83f8bb75 100644 --- a/CRM/Core/I18n.php +++ b/CRM/Core/I18n.php @@ -55,7 +55,8 @@ class CRM_Core_I18n { /** * A locale-based constructor that shouldn't be called from outside of this class (use singleton() instead). * - * @param $locale string the base of this certain object's existence + * @param $locale + * String the base of this certain object's existence. * * @return \CRM_Core_I18n */ @@ -117,7 +118,8 @@ class CRM_Core_I18n { /** * Return languages available in this instance of CiviCRM. * - * @param $justEnabled boolean whether to return all languages or just the enabled ones + * @param $justEnabled + * Boolean whether to return all languages or just the enabled ones. * * @return array of code/language name mappings */ @@ -170,8 +172,9 @@ class CRM_Core_I18n { /** * Replace arguments in a string with their values. Arguments are represented by % followed by their number. * - * @param $str string source string - * @param mixed arguments, can be passed in an array or through single variables + * @param $str + * String source string. + * @param mixed arguments, can be passed in an array or through single variables * * @return string modified string */ @@ -207,8 +210,10 @@ class CRM_Core_I18n { * - count - The item count for plural mode (3rd parameter of ngettext()) * - context - gettext context of that string (for homonym handling) * - * @param $text string the original string - * @param $params array the params of the translation (if any) + * @param $text + * String the original string. + * @param $params + * Array the params of the translation (if any). * * @return string the translated string */ @@ -339,7 +344,8 @@ class CRM_Core_I18n { /** * Translate a string to the current locale. * - * @param $string string this string should be translated + * @param $string + * String this string should be translated. * * @return string the translated string */ @@ -350,8 +356,10 @@ class CRM_Core_I18n { /** * Localize (destructively) array values. * - * @param $array array the array for localization (in place) - * @param $params array an array of additional parameters + * @param $array + * Array the array for localization (in place). + * @param $params + * Array an array of additional parameters. * * @return void */ @@ -375,7 +383,8 @@ class CRM_Core_I18n { /** * Localize (destructively) array elements with keys of 'title'. * - * @param $array array the array for localization (in place) + * @param $array + * Array the array for localization (in place). * * @return void */ @@ -394,7 +403,8 @@ class CRM_Core_I18n { /** * Binds a gettext domain, wrapper over bindtextdomain(). * - * @param $key Key of the extension (can be 'civicrm', or 'org.example.foo'). + * @param $key + * Key of the extension (can be 'civicrm', or 'org.example.foo'). * * @return Boolean True if the domain was changed for an extension. */ @@ -484,8 +494,10 @@ class CRM_Core_I18n { /** * Short-named function for string translation, defined in global scope so it's available everywhere. * - * @param $text string string for translating - * @param $params array an array of additional parameters + * @param $text + * String string for translating. + * @param $params + * Array an array of additional parameters. * * @return string the translated string */ diff --git a/CRM/Core/I18n/Schema.php b/CRM/Core/I18n/Schema.php index ae87b4afe8..7307be120d 100644 --- a/CRM/Core/I18n/Schema.php +++ b/CRM/Core/I18n/Schema.php @@ -60,7 +60,8 @@ class CRM_Core_I18n_Schema { * Switch database from single-lang to multi (by adding * the first language and dropping the original columns). * - * @param $locale string the first locale to create (migrate to) + * @param $locale + * String the first locale to create (migrate to). * * @return void */ @@ -114,7 +115,8 @@ class CRM_Core_I18n_Schema { * Switch database from multi-lang back to single (by dropping * additional columns and views and retaining only the selected locale). * - * @param $retain string the locale to retain + * @param $retain + * String the locale to retain. * * @return void */ @@ -153,9 +155,12 @@ class CRM_Core_I18n_Schema { /** * Switch a given table from multi-lang to single (by retaining only the selected locale). * - * @param $retain string the locale to retain - * @param $table string the table containing the column - * @param $class string schema structure class to use to recreate indices + * @param $retain + * String the locale to retain. + * @param $table + * String the table containing the column. + * @param $class + * String schema structure class to use to recreate indices. * * @param array $triggers * @@ -235,8 +240,10 @@ class CRM_Core_I18n_Schema { * Add a new locale to a multi-lang db, setting * its values to the current default locale. * - * @param $locale string the new locale to add - * @param $source string the locale to copy from + * @param $locale + * String the new locale to add. + * @param $source + * String the locale to copy from. * * @return void */ @@ -292,8 +299,10 @@ class CRM_Core_I18n_Schema { /** * Rebuild multilingual indices, views and triggers (useful for upgrades) * - * @param $locales array locales to be rebuilt - * @param $version string version of schema structure to use + * @param $locales + * Array locales to be rebuilt. + * @param $version + * String version of schema structure to use. * * @return void */ @@ -356,7 +365,8 @@ class CRM_Core_I18n_Schema { /** * Rewrite SQL query to use views to access tables with localized columns. * - * @param $query string the query for rewrite + * @param $query + * String the query for rewrite. * * @return string the rewritten query */ @@ -426,9 +436,12 @@ class CRM_Core_I18n_Schema { /** * CREATE INDEX queries for a given locale and table * - * @param $locale string locale for which the queries should be created (null to create original indices) - * @param $table string table for which the queries should be created - * @param $class string schema structure class to use + * @param $locale + * String locale for which the queries should be created (null to create original indices). + * @param $table + * String table for which the queries should be created. + * @param $class + * String schema structure class to use. * * @return array array of CREATE INDEX queries */ @@ -465,10 +478,14 @@ class CRM_Core_I18n_Schema { /** * CREATE VIEW query for a given locale and table * - * @param $locale string locale of the view - * @param $table string table of the view - * @param CRM_Core_DAO $dao a DAO object to run DESCRIBE queries - * @param $class string schema structure class to use + * @param $locale + * String locale of the view. + * @param $table + * String table of the view. + * @param CRM_Core_DAO $dao + * A DAO object to run DESCRIBE queries. + * @param $class + * String schema structure class to use. * * @return array array of CREATE INDEX queries */ diff --git a/CRM/Core/IDS.php b/CRM/Core/IDS.php index c785482eb4..13f31f1cae 100644 --- a/CRM/Core/IDS.php +++ b/CRM/Core/IDS.php @@ -96,7 +96,8 @@ class CRM_Core_IDS { /** * Create the default config file for the IDS system * - * @param boolean $force should we recreate it irrespective if it exists or not + * @param bool $force + * Should we recreate it irrespective if it exists or not. * * @return string the full path to the config file * @static diff --git a/CRM/Core/InnoDBIndexer.php b/CRM/Core/InnoDBIndexer.php index e538f177a9..5f880e1d2b 100644 --- a/CRM/Core/InnoDBIndexer.php +++ b/CRM/Core/InnoDBIndexer.php @@ -87,7 +87,8 @@ class CRM_Core_InnoDBIndexer { * * @param bool $oldValue * @param bool $newValue - * @param array $metadata Specification of the setting (per *.settings.php) + * @param array $metadata + * Specification of the setting (per *.settings.php). */ public static function onToggleFts($oldValue, $newValue, $metadata) { $indexer = CRM_Core_InnoDBIndexer::singleton(); @@ -128,7 +129,8 @@ class CRM_Core_InnoDBIndexer { * Determine if an index is expected to exist * * @param string $table - * @param array $fields list of field names that must be in the index + * @param array $fields + * List of field names that must be in the index. * @return bool */ public function hasDeclaredIndex($table, $fields) { @@ -261,7 +263,7 @@ class CRM_Core_InnoDBIndexer { } /** - * @param boolean $isActive + * @param bool $isActive */ public function setActive($isActive) { $this->isActive = $isActive; diff --git a/CRM/Core/Invoke.php b/CRM/Core/Invoke.php index 2dd61dae81..236111391c 100644 --- a/CRM/Core/Invoke.php +++ b/CRM/Core/Invoke.php @@ -100,7 +100,8 @@ class CRM_Core_Invoke { /** * Hackish support /civicrm/menu/rebuild * - * @param array $args list of path parts + * @param array $args + * List of path parts. * @void */ static public function hackMenuRebuild($args) { @@ -120,7 +121,8 @@ class CRM_Core_Invoke { /** * Perform general setup * - * @param array $args list of path parts + * @param array $args + * List of path parts. * @void */ static public function init($args) { @@ -139,7 +141,8 @@ class CRM_Core_Invoke { /** * Hackish support for /standalone/* * - * @param array $args list of path parts + * @param array $args + * List of path parts. * @void */ static public function hackStandalone($args) { @@ -158,7 +161,8 @@ class CRM_Core_Invoke { /** * Determine which menu $item corresponds to $args * - * @param array $args list of path parts + * @param array $args + * List of path parts. * @return array; see CRM_Core_Menu */ static public function getItem($args) { @@ -183,7 +187,8 @@ class CRM_Core_Invoke { /** * Given a menu item, call the appropriate controller and return the response * - * @param array $item see CRM_Core_Menu + * @param array $item + * See CRM_Core_Menu. * @return string, HTML */ static public function runItem($item) { diff --git a/CRM/Core/Key.php b/CRM/Core/Key.php index 5ddd661c9b..b724685d37 100644 --- a/CRM/Core/Key.php +++ b/CRM/Core/Key.php @@ -75,7 +75,8 @@ class CRM_Core_Key { * and a private key. Modelled after drupal's form API * * @param string $name - * @param bool $addSequence should we add a unique sequence number to the end of the key + * @param bool $addSequence + * Should we add a unique sequence number to the end of the key. * * @return string valid formID * @static diff --git a/CRM/Core/Lock.php b/CRM/Core/Lock.php index b042b2b682..eb42b3c207 100644 --- a/CRM/Core/Lock.php +++ b/CRM/Core/Lock.php @@ -44,10 +44,13 @@ class CRM_Core_Lock { /** * Initialize the constants used during lock acquire / release * - * @param string $name name of the lock. Please prefix with component / functionality + * @param string $name + * Name of the lock. Please prefix with component / functionality. * e.g. civimail.cronjob.JOB_ID - * @param int $timeout the number of seconds to wait to get the lock. 1 if not set - * @param boolean $serverWideLock should this lock be applicable across your entire mysql server + * @param int $timeout + * The number of seconds to wait to get the lock. 1 if not set. + * @param bool $serverWideLock + * Should this lock be applicable across your entire mysql server. * this is useful if you have multiple sites running on the same * mysql server and you want to limit the number of parallel cron * jobs - CRM-91XX diff --git a/CRM/Core/ManagedEntities.php b/CRM/Core/ManagedEntities.php index d8b3361b2b..7d8749bf65 100644 --- a/CRM/Core/ManagedEntities.php +++ b/CRM/Core/ManagedEntities.php @@ -53,8 +53,10 @@ class CRM_Core_ManagedEntities { } /** - * @param array $modules CRM_Core_Module - * @param array $declarations per hook_civicrm_managed + * @param array $modules + * CRM_Core_Module. + * @param array $declarations + * Per hook_civicrm_managed. */ public function __construct($modules, $declarations) { $this->moduleIndex = self::createModuleIndex($modules); @@ -123,7 +125,8 @@ class CRM_Core_ManagedEntities { * Create, update, and delete entities declared by an active module * * @param \CRM_Core_Module|string $module string - * @param $todos array $name => array() + * @param $todos + * Array $name => array(). */ public function reconcileEnabledModule(CRM_Core_Module $module, $todos) { $dao = new CRM_Core_DAO_Managed(); @@ -185,7 +188,8 @@ class CRM_Core_ManagedEntities { /** * Create a new entity * - * @param array $todo entity specification (per hook_civicrm_managedEntities) + * @param array $todo + * Entity specification (per hook_civicrm_managedEntities). */ public function insertNewEntity($todo) { $result = civicrm_api($todo['entity'], 'create', $todo['params']); @@ -206,7 +210,8 @@ class CRM_Core_ManagedEntities { * Update an entity which (a) is believed to exist and which (b) ought to be active. * * @param CRM_Core_DAO_Managed $dao - * @param array $todo entity specification (per hook_civicrm_managedEntities) + * @param array $todo + * Entity specification (per hook_civicrm_managedEntities). */ public function updateExistingEntity($dao, $todo) { $policy = CRM_Utils_Array::value('update', $todo, 'always'); diff --git a/CRM/Core/Menu.php b/CRM/Core/Menu.php index 87ee520133..0698cea81a 100644 --- a/CRM/Core/Menu.php +++ b/CRM/Core/Menu.php @@ -71,7 +71,8 @@ class CRM_Core_Menu { /** * This function fetches the menu items from xml and xmlMenu hooks * - * @param boolen $fetchFromXML fetch the menu items from xml and not from cache + * @param boolen $fetchFromXML + * Fetch the menu items from xml and not from cache. * * @return array */ @@ -162,7 +163,8 @@ class CRM_Core_Menu { /** * This function defines information for various menu items * - * @param boolen $fetchFromXML fetch the menu items from xml and not from cache + * @param boolen $fetchFromXML + * Fetch the menu items from xml and not from cache. * * @static */ @@ -479,8 +481,10 @@ class CRM_Core_Menu { /** * Get the breadcrumb for a given path. * - * @param array $menu An array of all the menu items. - * @param string $path Path for which breadcrumb is to be build. + * @param array $menu + * An array of all the menu items. + * @param string $path + * Path for which breadcrumb is to be build. * * @return array The breadcrumb for this path * diff --git a/CRM/Core/OptionGroup.php b/CRM/Core/OptionGroup.php index 961d7aa942..6102935c09 100644 --- a/CRM/Core/OptionGroup.php +++ b/CRM/Core/OptionGroup.php @@ -92,16 +92,25 @@ class CRM_Core_OptionGroup { * (radio, select, checkbox etc). OptionGroups for most cases have the * 'label' in the label colum and the 'id' or 'name' in the value column * - * @param $name string name of the option group - * @param $flip boolean results are return in id => label format if false + * @param $name + * String name of the option group. + * @param $flip + * Boolean results are return in id => label format if false. * if true, the results are reversed - * @param $grouping boolean if true, return the value in 'grouping' column - * @param $localize boolean if true, localize the results before returning - * @param $condition string add another condition to the sql query - * @param $labelColumnName string the column to use for 'label' - * @param $onlyActive boolean return only the action option values - * @param $fresh boolean ignore cache entries and go back to DB - * @param $keyColumnName string the column to use for 'key' + * @param $grouping + * Boolean if true, return the value in 'grouping' column. + * @param $localize + * Boolean if true, localize the results before returning. + * @param $condition + * String add another condition to the sql query. + * @param $labelColumnName + * String the column to use for 'label'. + * @param $onlyActive + * Boolean return only the action option values. + * @param $fresh + * Boolean ignore cache entries and go back to DB. + * @param $keyColumnName + * String the column to use for 'key'. * * @return array the values as specified by the above params * @static @@ -195,12 +204,17 @@ WHERE v.option_group_id = g.id * (radio, select, checkbox etc). OptionGroups for most cases have the * 'label' in the label colum and the 'id' or 'name' in the value column * - * @param $id integer id of the option group - * @param $flip boolean results are return in id => label format if false + * @param $id + * Integer id of the option group. + * @param $flip + * Boolean results are return in id => label format if false. * if true, the results are reversed - * @param $grouping boolean if true, return the value in 'grouping' column - * @param $localize boolean if true, localize the results before returning - * @param $labelColumnName string the column to use for 'label' + * @param $grouping + * Boolean if true, return the value in 'grouping' column. + * @param $localize + * Boolean if true, localize the results before returning. + * @param $labelColumnName + * String the column to use for 'label'. * * @param bool $onlyActive * @param bool $fresh @@ -246,19 +260,21 @@ WHERE v.option_group_id = g.id * is assigned a new fieldname by id or id's by title * (each within a specificied option_group) * - * @param array $params Reference array of values submitted by the form. Based on + * @param array $params + * Reference array of values submitted by the form. Based on. * $flip, creates new elements in $params for each field in * the $names array. * If $flip = false, adds root field name => title * If $flip = true, adds actual field name => id * - * @param array $names Reference array of fieldnames we want transformed. + * @param array $names + * Reference array of fieldnames we want transformed. * Array key = 'postName' (field name submitted by form in $params). * Array value = array( 'newName' => $newName, 'groupName' => $groupName). * * - * @param boolean $flip + * @param boolean $flip * * @return void * @@ -397,7 +413,8 @@ WHERE v.option_group_id = g.id /** * Get option_value.value from default option_value row for an option group * - * @param string $groupName the name of the option group + * @param string $groupName + * The name of the option group. * * @static * @@ -430,8 +447,10 @@ WHERE v.option_group_id = g.id * @TODO: Should update the group if it already exists intelligently, so multi-lingual is * not messed up. Currently deletes the old group * - * @param string $groupName the name of the option group - make sure there is no conflict - * @param array $values the associative array that has information on the option values + * @param string $groupName + * The name of the option group - make sure there is no conflict. + * @param array $values + * The associative array that has information on the option values. * the keys of this array are: * string 'title' (required) * string 'value' (required) @@ -440,8 +459,10 @@ WHERE v.option_group_id = g.id * int 'weight' (optional) - the order in which the value are displayed * bool 'is_default' (optional) - is this the default one to display when rendered in form * bool 'is_active' (optional) - should this element be rendered - * @param int $defaultID (reference) - the option value ID of the default element (if set) is returned else 'null' - * @param null $groupTitle the optional label of the option group else set to group name + * @param int $defaultID + * (reference) - the option value ID of the default element (if set) is returned else 'null'. + * @param null $groupTitle + * The optional label of the option group else set to group name. * * @static * diff --git a/CRM/Core/OptionValue.php b/CRM/Core/OptionValue.php index 1b9599eb3e..3f94ed40a1 100644 --- a/CRM/Core/OptionValue.php +++ b/CRM/Core/OptionValue.php @@ -61,9 +61,12 @@ class CRM_Core_OptionValue { /** * Return option-values of a particular group * - * @param array $groupParams Array containing group fields whose option-values is to retrieved. - * @param string $orderBy for orderBy clause - * @param array $links has links like edit, delete, disable ..etc + * @param array $groupParams + * Array containing group fields whose option-values is to retrieved. + * @param string $orderBy + * For orderBy clause. + * @param array $links + * Has links like edit, delete, disable ..etc. * * @return array of option-values * @@ -171,10 +174,13 @@ class CRM_Core_OptionValue { /** * Add/edit option-value of a particular group * - * @param array $params Array containing exported values from the invoking form. - * @param array $groupParams Array containing group fields whose option-values is to retrieved/saved. + * @param array $params + * Array containing exported values from the invoking form. + * @param array $groupParams + * Array containing group fields whose option-values is to retrieved/saved. * @param $action - * @param integer $optionValueID has the id of the optionValue being edited, disabled ..etc + * @param integer $optionValueID + * Has the id of the optionValue being edited, disabled ..etc. * * @return CRM_Core_DAO_OptionValue * @@ -237,12 +243,16 @@ class CRM_Core_OptionValue { /** * Check if there is a record with the same name in the db * - * @param string $value the value of the field we are checking - * @param string $daoName the dao object name - * @param string $daoID the id of the object being updated. u can change your name + * @param string $value + * The value of the field we are checking. + * @param string $daoName + * The dao object name. + * @param string $daoID + * The id of the object being updated. u can change your name. * as long as there is no conflict * @param int $optionGroupID - * @param string $fieldName the name of the field in the DAO + * @param string $fieldName + * The name of the field in the DAO. * * @return boolean true if object exists * @static @@ -362,13 +372,17 @@ class CRM_Core_OptionValue { /** * Return option-values of a particular group * - * @param array $groupParams Array containing group fields + * @param array $groupParams + * Array containing group fields. * whose option-values is to retrieved. - * @param array $values (reference) to the array which + * @param array $values + * (reference) to the array which. * will have the values for the group - * @param string $orderBy for orderBy clause + * @param string $orderBy + * For orderBy clause. * - * @param boolean $isActive do you want only active option values? + * @param boolean $isActive + * Do you want only active option values?. * * @return array of option-values * diff --git a/CRM/Core/Page.php b/CRM/Core/Page.php index f77dfa0b12..ffc980765e 100644 --- a/CRM/Core/Page.php +++ b/CRM/Core/Page.php @@ -120,8 +120,10 @@ class CRM_Core_Page { /** * Class constructor * - * @param string $title title of the page - * @param int $mode mode of the page + * @param string $title + * Title of the page. + * @param int $mode + * Mode of the page. * * @return CRM_Core_Page */ @@ -244,8 +246,9 @@ class CRM_Core_Page { /** * Store the variable with the value in the form scope * - * @param string|array $name name of the variable or an assoc array of name/value pairs - * @param mixed $value value of the variable if string + * @param string|array $name name of the variable or an assoc array of name/value pairs + * @param mixed $value + * Value of the variable if string. * * * @return void @@ -258,7 +261,7 @@ class CRM_Core_Page { /** * Get the variable from the form scope * - * @param string name : name of the variable + * @param string name : name of the variable * * * @return mixed @@ -272,7 +275,8 @@ class CRM_Core_Page { * Assign value to name in template * * @param string $var - * @param mixed $value value of varaible + * @param mixed $value + * Value of varaible. * * @return void */ @@ -284,7 +288,8 @@ class CRM_Core_Page { * Assign value to name in template by reference * * @param string $var - * @param mixed $value (reference) value of varaible + * @param mixed $value + * (reference) value of varaible. * * @return void */ @@ -296,7 +301,8 @@ class CRM_Core_Page { * Appends values to template variables * * @param array|string $tpl_var the template variable name(s) - * @param mixed $value the value to append + * @param mixed $value + * The value to append. * @param bool $merge */ public function append($tpl_var, $value=NULL, $merge=FALSE) { @@ -359,7 +365,7 @@ class CRM_Core_Page { /** * Setter for embedded * - * @param boolean $embedded + * @param bool $embedded * * @return void */ @@ -379,7 +385,7 @@ class CRM_Core_Page { /** * Setter for print * - * @param boolean $print + * @param bool $print * * @return void */ diff --git a/CRM/Core/Page/AJAX.php b/CRM/Core/Page/AJAX.php index a040bc14ce..aeb5f95963 100644 --- a/CRM/Core/Page/AJAX.php +++ b/CRM/Core/Page/AJAX.php @@ -130,9 +130,12 @@ class CRM_Core_Page_AJAX { /** * Determine whether the request is for a valid class/method name. * - * @param string $type 'method'|'class'|'' - * @param string $className 'Class_Name' - * @param string $fnName method name + * @param string $type + * 'method'|'class'|''. + * @param string $className + * 'Class_Name'. + * @param string $fnName + * Method name. * * @return bool */ @@ -208,9 +211,12 @@ class CRM_Core_Page_AJAX { /** * Send autocomplete results to the client. Input can be a simple or nested array. - * @param array $results - If nested array, also provide: - * @param string $val - array key to use as the value - * @param string $key - array key to use as the key + * @param array $results + * If nested array, also provide:. + * @param string $val + * Array key to use as the value. + * @param string $key + * Array key to use as the key. * @deprecated */ public static function autocompleteResults($results, $val='label', $key='id') { diff --git a/CRM/Core/Page/Basic.php b/CRM/Core/Page/Basic.php index d3c139590b..1c099622dc 100644 --- a/CRM/Core/Page/Basic.php +++ b/CRM/Core/Page/Basic.php @@ -76,7 +76,8 @@ abstract class CRM_Core_Page_Basic extends CRM_Core_Page { /** * UserContext to pop back to * - * @param int $mode mode that we are in + * @param int $mode + * Mode that we are in. * * @return string */ @@ -85,7 +86,8 @@ abstract class CRM_Core_Page_Basic extends CRM_Core_Page { /** * Get userContext params * - * @param int $mode mode that we are in + * @param int $mode + * Mode that we are in. * * @return string */ @@ -96,8 +98,10 @@ abstract class CRM_Core_Page_Basic extends CRM_Core_Page { /** * Allow objects to be added based on permission * - * @param int $id the id of the object - * @param int $name the name or title of the object + * @param int $id + * The id of the object. + * @param int $name + * The name or title of the object. * * @return string permission value if permission is granted, else null */ @@ -109,7 +113,8 @@ abstract class CRM_Core_Page_Basic extends CRM_Core_Page { * Allows the derived class to add some more state variables to * the controller. By default does nothing, and hence is abstract * - * @param CRM_Core_Controller $controller the controller object + * @param CRM_Core_Controller $controller + * The controller object. * * @return void */ @@ -118,8 +123,10 @@ abstract class CRM_Core_Page_Basic extends CRM_Core_Page { /** * Class constructor * - * @param string $title title of the page - * @param int $mode mode of the page + * @param string $title + * Title of the page. + * @param int $mode + * Mode of the page. * * @return \CRM_Core_Page_Basic */ @@ -275,11 +282,16 @@ abstract class CRM_Core_Page_Basic extends CRM_Core_Page { * object. Check the is_active and is_required flags to display valid * actions * - * @param CRM_Core_DAO $object the object being considered - * @param int $action the base set of actions - * @param array $values the array of values that we send to the template - * @param array $links the array of links - * @param string $permission the permission assigned to this object + * @param CRM_Core_DAO $object + * The object being considered. + * @param int $action + * The base set of actions. + * @param array $values + * The array of values that we send to the template. + * @param array $links + * The array of links. + * @param string $permission + * The permission assigned to this object. * * @param bool $forceAction * @@ -353,8 +365,10 @@ abstract class CRM_Core_Page_Basic extends CRM_Core_Page { /** * Edit this entity. * - * @param int $mode - what mode for the form ? - * @param int $id - id of the entity (for update, view operations) + * @param int $mode + * What mode for the form ?. + * @param int $id + * Id of the entity (for update, view operations). * * @param bool $imageUpload * @param bool $pushUserContext diff --git a/CRM/Core/Page/Redirect.php b/CRM/Core/Page/Redirect.php index 6b71ed5096..4550cfd70c 100644 --- a/CRM/Core/Page/Redirect.php +++ b/CRM/Core/Page/Redirect.php @@ -19,11 +19,16 @@ class CRM_Core_Page_Redirect extends CRM_Core_Page { } /** - * @param array $requestPath the parts of the path in the current page request - * @param array $requestArgs any GET arguments - * @param array $pageArgs the page_arguments registered in the router - * @param array $requestArgs any parameters passed as part of this page request - * @param bool $absolute whether to return an absolute URL + * @param array $requestPath + * The parts of the path in the current page request. + * @param array $requestArgs + * Any GET arguments. + * @param array $pageArgs + * The page_arguments registered in the router. + * @param array $requestArgs + * Any parameters passed as part of this page request. + * @param bool $absolute + * Whether to return an absolute URL. * @return string URL */ public static function createUrl($requestPath, $requestArgs, $pageArgs, $absolute) { diff --git a/CRM/Core/Payment.php b/CRM/Core/Payment.php index b5a066a706..c6cd405655 100644 --- a/CRM/Core/Payment.php +++ b/CRM/Core/Payment.php @@ -86,10 +86,16 @@ abstract class CRM_Core_Payment { /** * Singleton function used to manage this object * - * @param string $mode the mode of operation: live or test - * @param array $paymentProcessor the details of the payment processor being invoked - * @param object $paymentForm deprecated - avoid referring to this if possible. If you have to use it document why as this is scary interaction - * @param boolean $force should we force a reload of this payment object + * @param string $mode + * The mode of operation: live or test. + * @param array $paymentProcessor + * The details of the payment processor being invoked. + * @param object $paymentForm + * Deprecated - avoid referring to this if possible. If you have to use it document why as this is scary interaction. + * @param bool $force + * Should we force a reload of this payment object. + * + * @return CRM_Core_Payment * @return \CRM_Core_Payment * @throws \CRM_Core_Exception * @static @@ -150,7 +156,8 @@ abstract class CRM_Core_Payment { /** * Check if capability is supported - * @param string $capability e.g BackOffice, LiveMode, FutureRecurStartDate + * @param string $capability + * E.g BackOffice, LiveMode, FutureRecurStartDate. * * @return bool */ @@ -426,7 +433,8 @@ abstract class CRM_Core_Payment { * This function collects all the information from a web/api form and invokes * the relevant payment processor specific functions to perform the transaction * - * @param array $params assoc array of input parameters for this transaction + * @param array $params + * Assoc array of input parameters for this transaction. * * @return array the result in an nice formatted array (or an error object) * @abstract @@ -602,7 +610,8 @@ abstract class CRM_Core_Payment { /** * Check whether a method is present ( & supported ) by the payment processor object. * - * @param string $method method to check for. + * @param string $method + * Method to check for. * * @return boolean */ diff --git a/CRM/Core/Payment/AuthorizeNet.php b/CRM/Core/Payment/AuthorizeNet.php index 3aabcc2241..5e8b4afedf 100644 --- a/CRM/Core/Payment/AuthorizeNet.php +++ b/CRM/Core/Payment/AuthorizeNet.php @@ -40,7 +40,8 @@ class CRM_Core_Payment_AuthorizeNet extends CRM_Core_Payment { /** * Constructor * - * @param string $mode the mode of operation: live or test + * @param string $mode + * The mode of operation: live or test. * * @param $paymentProcessor * @@ -66,11 +67,14 @@ class CRM_Core_Payment_AuthorizeNet extends CRM_Core_Payment { /** * Singleton function used to manage this object * - * @param string $mode the mode of operation: live or test - * @param array $paymentProcessor the details of the payment processor being invoked - * @param CRM_Core_Form $paymentForm reference (deprecated) - * @param boolean $force - * should we force a reload of this payment object + * @param string $mode + * The mode of operation: live or test. + * @param array $paymentProcessor + * The details of the payment processor being invoked. + * @param CRM_Core_Form $paymentForm + * Reference to the form object if available. + * @param bool $force + * Should we force a reload of this payment object. * * @return object * @static @@ -102,7 +106,8 @@ class CRM_Core_Payment_AuthorizeNet extends CRM_Core_Payment { /** * Submit a payment using Advanced Integration Method * - * @param array $params assoc array of input parameters for this transaction + * @param array $params + * Assoc array of input parameters for this transaction. * * @return array the result in a nice formatted array (or an error object) */ @@ -400,7 +405,8 @@ class CRM_Core_Payment_AuthorizeNet extends CRM_Core_Payment { /** * Checks to see if invoice_id already exists in db * - * @param int $invoiceId The ID to check + * @param int $invoiceId + * The ID to check. * * @return bool True if ID exists, else false */ @@ -446,9 +452,12 @@ class CRM_Core_Payment_AuthorizeNet extends CRM_Core_Payment { * Check the gateway MD5 response to make sure that this is a proper * gateway response * - * @param string $responseMD5 MD5 hash generated by the gateway - * @param string $transaction_id Transaction id generated by the gateway - * @param string $amount Purchase amount + * @param string $responseMD5 + * MD5 hash generated by the gateway. + * @param string $transaction_id + * Transaction id generated by the gateway. + * @param string $amount + * Purchase amount. * * @param bool $ipn * @@ -492,7 +501,8 @@ class CRM_Core_Payment_AuthorizeNet extends CRM_Core_Payment { * Split a CSV file. Requires , as delimiter and " as enclosure. * Based off notes from http://php.net/fgetcsv * - * @param string $data a single CSV line + * @param string $data + * A single CSV line. * * @return array CSV fields */ @@ -527,7 +537,8 @@ class CRM_Core_Payment_AuthorizeNet extends CRM_Core_Payment { * Function is from Authorize.Net sample code, and used * to prevent the requirement of XML functions. * - * @param string $content XML reply from Authorize.Net + * @param string $content + * XML reply from Authorize.Net. * * @return array refId, resultCode, code, text, subscriptionId */ @@ -566,7 +577,8 @@ class CRM_Core_Payment_AuthorizeNet extends CRM_Core_Payment { /** * Get the value of a field if set * - * @param string $field the field + * @param string $field + * The field. * * @param bool $xmlSafe * @return mixed value of the field, or empty string if the field is diff --git a/CRM/Core/Payment/AuthorizeNetIPN.php b/CRM/Core/Payment/AuthorizeNetIPN.php index 28d667693b..4957fbb559 100644 --- a/CRM/Core/Payment/AuthorizeNetIPN.php +++ b/CRM/Core/Payment/AuthorizeNetIPN.php @@ -37,7 +37,8 @@ class CRM_Core_Payment_AuthorizeNetIPN extends CRM_Core_Payment_BaseIPN { /** * Constructor function * - * @param $inputData array contents of HTTP REQUEST + * @param $inputData + * Array contents of HTTP REQUEST. * * @throws CRM_Core_Exception */ @@ -302,10 +303,14 @@ INNER JOIN civicrm_membership_payment mp ON m.id = mp.membership_id AND mp.contr } /** - * @param string $name parameter name - * @param string $type parameter type - * @param bool $abort abort if not present - * @param null $default default value + * @param string $name + * Parameter name. + * @param string $type + * Parameter type. + * @param bool $abort + * Abort if not present. + * @param null $default + * Default value. * * @throws CRM_Core_Exception * @return mixed diff --git a/CRM/Core/Payment/BaseIPN.php b/CRM/Core/Payment/BaseIPN.php index 2345281d14..f9afb4f399 100644 --- a/CRM/Core/Payment/BaseIPN.php +++ b/CRM/Core/Payment/BaseIPN.php @@ -74,11 +74,16 @@ class CRM_Core_Payment_BaseIPN { * Paypal allows you to resend Instant Payment Notifications if you, for example, moved site * and didn't update your IPN URL. * - * @param array $input interpreted values from the values returned through the IPN - * @param array $ids more interpreted values (ids) from the values returned through the IPN - * @param array $objects an empty array that will be populated with loaded object - * @param boolean $required boolean Return FALSE if the relevant objects don't exist - * @param integer $paymentProcessorID Id of the payment processor ID in use + * @param array $input + * Interpreted values from the values returned through the IPN. + * @param array $ids + * More interpreted values (ids) from the values returned through the IPN. + * @param array $objects + * An empty array that will be populated with loaded object. + * @param bool $required + * Boolean Return FALSE if the relevant objects don't exist. + * @param int $paymentProcessorID + * Id of the payment processor ID in use. * @return boolean */ public function validateData(&$input, &$ids, &$objects, $required = TRUE, $paymentProcessorID = NULL) { @@ -124,8 +129,8 @@ class CRM_Core_Payment_BaseIPN { * @param $input * @param array $ids * @param array $objects - * @param boolean $required - * @param integer $paymentProcessorID + * @param bool $required + * @param int $paymentProcessorID * @param array $error_handling * * @return boolean @@ -698,12 +703,17 @@ LIMIT 1;"; * Send receipt from contribution. Note that the compose message part has been moved to contribution * In general LoadObjects is called first to get the objects but the composeMessageArray function now calls it * - * @param array $input Incoming data from Payment processor - * @param array $ids Related object IDs + * @param array $input + * Incoming data from Payment processor. + * @param array $ids + * Related object IDs. * @param $objects - * @param array $values values related to objects that have already been loaded - * @param bool $recur is it part of a recurring contribution - * @param bool $returnMessageText Should text be returned instead of sent. This + * @param array $values + * Values related to objects that have already been loaded. + * @param bool $recur + * Is it part of a recurring contribution. + * @param bool $returnMessageText + * Should text be returned instead of sent. This. * is because the function is also used to generate pdfs * * @return array diff --git a/CRM/Core/Payment/Dummy.php b/CRM/Core/Payment/Dummy.php index bc1b046eca..93f07389c0 100644 --- a/CRM/Core/Payment/Dummy.php +++ b/CRM/Core/Payment/Dummy.php @@ -45,7 +45,8 @@ class CRM_Core_Payment_Dummy extends CRM_Core_Payment { /** * Constructor * - * @param string $mode the mode of operation: live or test + * @param string $mode + * The mode of operation: live or test. * * @param $paymentProcessor * @@ -60,7 +61,8 @@ class CRM_Core_Payment_Dummy extends CRM_Core_Payment { /** * Singleton function used to manage this object * - * @param string $mode the mode of operation: live or test + * @param string $mode + * The mode of operation: live or test. * * @param object $paymentProcessor * @param null $paymentForm @@ -86,7 +88,8 @@ class CRM_Core_Payment_Dummy extends CRM_Core_Payment { /** * Submit a payment using Advanced Integration Method * - * @param array $params assoc array of input parameters for this transaction + * @param array $params + * Assoc array of input parameters for this transaction. * * @return array the result in a nice formatted array (or an error object) */ diff --git a/CRM/Core/Payment/Elavon.php b/CRM/Core/Payment/Elavon.php index b0b3e6bcdb..90daeb5a81 100644 --- a/CRM/Core/Payment/Elavon.php +++ b/CRM/Core/Payment/Elavon.php @@ -40,7 +40,8 @@ class CRM_Core_Payment_Elavon extends CRM_Core_Payment { /********************************************************** * Constructor * - * @param string $mode the mode of operation: live or test + * @param string $mode + * The mode of operation: live or test. * * @param $paymentProcessor * @@ -56,7 +57,8 @@ class CRM_Core_Payment_Elavon extends CRM_Core_Payment { /** * Singleton function used to manage this object * - * @param string $mode the mode of operation: live or test + * @param string $mode + * The mode of operation: live or test. * * @param object $paymentProcessor * @@ -315,7 +317,8 @@ class CRM_Core_Payment_Elavon extends CRM_Core_Payment { /** * Checks to see if invoice_id already exists in db * - * @param int $invoiceId The ID to check + * @param int $invoiceId + * The ID to check. * * @return bool True if ID exists, else false */ diff --git a/CRM/Core/Payment/FirstData.php b/CRM/Core/Payment/FirstData.php index b725821c08..15a18c87c6 100644 --- a/CRM/Core/Payment/FirstData.php +++ b/CRM/Core/Payment/FirstData.php @@ -65,7 +65,8 @@ class CRM_Core_Payment_FirstData extends CRM_Core_Payment { /********************************************************** * Constructor * - * @param string $mode the mode of operation: live or test + * @param string $mode + * The mode of operation: live or test. * * @param $paymentProcessor * @@ -80,7 +81,8 @@ class CRM_Core_Payment_FirstData extends CRM_Core_Payment { /** * Singleton function used to manage this object * - * @param string $mode the mode of operation: live or test + * @param string $mode + * The mode of operation: live or test. * * @param object $paymentProcessor * @@ -328,7 +330,8 @@ class CRM_Core_Payment_FirstData extends CRM_Core_Payment { /** * Checks to see if invoice_id already exists in db * - * @param int $invoiceId The ID to check + * @param int $invoiceId + * The ID to check. * * @return bool True if ID exists, else false */ diff --git a/CRM/Core/Payment/Form.php b/CRM/Core/Payment/Form.php index ca4a162ebe..2264f41fd1 100644 --- a/CRM/Core/Payment/Form.php +++ b/CRM/Core/Payment/Form.php @@ -45,8 +45,10 @@ class CRM_Core_Payment_Form { * Note that this code is written to accommodate the possibility CiviCRM will switch to implementing pay later as a manual processor in future * * @param CRM_Contribute_Form_AbstractEditPayment|CRM_Contribute_Form_Contribution_Main $form - * @param array $processor array of properties including 'object' as loaded from CRM_Financial_BAO_PaymentProcessor::getPaymentProcessors - * @param bool $forceBillingFieldsForPayLater display billing fields even for pay later + * @param array $processor + * Array of properties including 'object' as loaded from CRM_Financial_BAO_PaymentProcessor::getPaymentProcessors. + * @param bool $forceBillingFieldsForPayLater + * Display billing fields even for pay later. */ static public function setPaymentFieldsByProcessor(&$form, $processor, $forceBillingFieldsForPayLater = FALSE) { $form->billingFieldSets = array(); @@ -242,8 +244,10 @@ class CRM_Core_Payment_Form { /** * @param CRM_Contribute_Form_AbstractEditPayment|CRM_Contribute_Form_Contribution_Main|CRM_Core_Payment_ProcessorForm|CRM_Contribute_Form_UpdateBilling $form - * @param array $processor array of properties including 'object' as loaded from CRM_Financial_BAO_PaymentProcessor::getPaymentProcessors - * @param bool $isBillingDataOptional This manifests for 'NULL' (pay later) payment processor as the addition of billing fields to the form and + * @param array $processor + * Array of properties including 'object' as loaded from CRM_Financial_BAO_PaymentProcessor::getPaymentProcessors. + * @param bool $isBillingDataOptional + * This manifests for 'NULL' (pay later) payment processor as the addition of billing fields to the form and. * for payment processors that gather payment data on site as rendering the fields as not being required. (not entirely sure why but this * is implemented for back office forms) * @@ -272,7 +276,8 @@ class CRM_Core_Payment_Form { /** * @param CRM_Core_Form $form - * @param array $paymentFields array of properties including 'object' as loaded from CRM_Financial_BAO_PaymentProcessor::getPaymentProcessors + * @param array $paymentFields + * Array of properties including 'object' as loaded from CRM_Financial_BAO_PaymentProcessor::getPaymentProcessors. * @param $paymentFields */ diff --git a/CRM/Core/Payment/Google.php b/CRM/Core/Payment/Google.php index 50bb83aeec..bf219b8de0 100644 --- a/CRM/Core/Payment/Google.php +++ b/CRM/Core/Payment/Google.php @@ -62,7 +62,8 @@ class CRM_Core_Payment_Google extends CRM_Core_Payment { /** * Constructor * - * @param string $mode the mode of operation: live or test + * @param string $mode + * The mode of operation: live or test. * * @param $paymentProcessor * @@ -77,7 +78,8 @@ class CRM_Core_Payment_Google extends CRM_Core_Payment { /** * Singleton function used to manage this object * - * @param string $mode the mode of operation: live or test + * @param string $mode + * The mode of operation: live or test. * * @param object $paymentProcessor * @@ -128,7 +130,8 @@ class CRM_Core_Payment_Google extends CRM_Core_Payment { * This function collects all the information from a web/api form and invokes * the relevant payment processor specific functions to perform the transaction * - * @param array $params assoc array of input parameters for this transaction + * @param array $params + * Assoc array of input parameters for this transaction. * * @return array the result in an nice formatted array (or an error object) * @abstract @@ -140,7 +143,8 @@ class CRM_Core_Payment_Google extends CRM_Core_Payment { /** * Sets appropriate parameters for checking out to google * - * @param array $params name value pair of contribution datat + * @param array $params + * Name value pair of contribution datat. * * @param $component * @@ -212,9 +216,12 @@ class CRM_Core_Payment_Google extends CRM_Core_Payment { /** * Builds appropriate parameters for checking out to google and submits the post params * - * @param array $params name value pair of contribution data - * @param string $component event/contribution - * @param object $cart object of googel cart + * @param array $params + * Name value pair of contribution data. + * @param string $component + * Event/contribution. + * @param object $cart + * Object of googel cart. * * @return void * diff --git a/CRM/Core/Payment/GoogleIPN.php b/CRM/Core/Payment/GoogleIPN.php index c3e3b532b8..9ca575835c 100644 --- a/CRM/Core/Payment/GoogleIPN.php +++ b/CRM/Core/Payment/GoogleIPN.php @@ -87,7 +87,8 @@ class CRM_Core_Payment_GoogleIPN extends CRM_Core_Payment_BaseIPN { /** * Constructor * - * @param string $mode the mode of operation: live or test + * @param string $mode + * The mode of operation: live or test. * * @param $paymentProcessor * @@ -103,8 +104,10 @@ class CRM_Core_Payment_GoogleIPN extends CRM_Core_Payment_BaseIPN { /** * The function gets called when a new order takes place. * - * @param xml $dataRoot response send by google in xml format - * @param array $privateData contains the name value pair of + * @param xml $dataRoot + * Response send by google in xml format. + * @param array $privateData + * Contains the name value pair of . * * @param $component * @@ -243,9 +246,11 @@ class CRM_Core_Payment_GoogleIPN extends CRM_Core_Payment_BaseIPN { /** * The function gets called when the state(CHARGED, CANCELLED..) changes for an order * - * @param string $status status of the transaction send by google + * @param string $status + * Status of the transaction send by google. * @param $dataRoot - * @param array $privateData contains the name value pair of + * @param array $privateData + * Contains the name value pair of . * * @param $component * @@ -394,7 +399,8 @@ WHERE contribution_recur_id = {$ids['contributionRecur']} /** * Singleton function used to manage this object * - * @param string $mode the mode of operation: live or test + * @param string $mode + * The mode of operation: live or test. * * @param $component * @param $paymentProcessor @@ -412,7 +418,8 @@ WHERE contribution_recur_id = {$ids['contributionRecur']} /** * The function retrieves the amount the contribution is for, based on the order-no google sends * - * @param int $orderNo send by google + * @param int $orderNo + * send by google. * * @return amount */ @@ -430,9 +437,12 @@ WHERE contribution_recur_id = {$ids['contributionRecur']} /** * The function returns the component(Event/Contribute..), given the google-order-no and merchant-private-data * - * @param array $privateData contains the name value pair of - * @param int $orderNo send by google - * @param string $root root of xml-response + * @param array $privateData + * Contains the name value pair of . + * @param int $orderNo + * send by google. + * @param string $root + * Root of xml-response. * * @param $response * @param $serial diff --git a/CRM/Core/Payment/IATS.php b/CRM/Core/Payment/IATS.php index 8eda80cfcd..a53077024d 100644 --- a/CRM/Core/Payment/IATS.php +++ b/CRM/Core/Payment/IATS.php @@ -51,7 +51,8 @@ class CRM_Core_Payment_IATS extends CRM_Core_Payment { /** * Constructor * - * @param string $mode the mode of operation: live or test + * @param string $mode + * The mode of operation: live or test. * * @param $paymentProcessor * @@ -99,7 +100,8 @@ class CRM_Core_Payment_IATS extends CRM_Core_Payment { * This function collects all the information from a web/api form and invokes * the relevant payment processor specific functions to perform the transaction * - * @param array $params assoc array of input parameters for this transaction + * @param array $params + * Assoc array of input parameters for this transaction. * * @return array the result in an nice formatted array (or an error object) * @abstract diff --git a/CRM/Core/Payment/Moneris.php b/CRM/Core/Payment/Moneris.php index 975fee6552..5226b9ca46 100644 --- a/CRM/Core/Payment/Moneris.php +++ b/CRM/Core/Payment/Moneris.php @@ -49,7 +49,8 @@ class CRM_Core_Payment_Moneris extends CRM_Core_Payment { /** * Constructor * - * @param string $mode the mode of operation: live or test + * @param string $mode + * The mode of operation: live or test. * * @param $paymentProcessor * @@ -81,7 +82,8 @@ class CRM_Core_Payment_Moneris extends CRM_Core_Payment { /** * Singleton function used to manage this object * - * @param string $mode the mode of operation: live or test + * @param string $mode + * The mode of operation: live or test. * * @param object $paymentProcessor * @@ -106,7 +108,8 @@ class CRM_Core_Payment_Moneris extends CRM_Core_Payment { * This function collects all the information from a web/api form and invokes * the relevant payment processor specific functions to perform the transaction * - * @param array $params assoc array of input parameters for this transaction + * @param array $params + * Assoc array of input parameters for this transaction. * * @return array the result in an nice formatted array (or an error object) * @abstract diff --git a/CRM/Core/Payment/PayJunction.php b/CRM/Core/Payment/PayJunction.php index 62bc2f3f01..e77af14209 100644 --- a/CRM/Core/Payment/PayJunction.php +++ b/CRM/Core/Payment/PayJunction.php @@ -31,7 +31,8 @@ class CRM_Core_Payment_PayJunction extends CRM_Core_Payment { /** * Constructor * - * @param string $mode the mode of operation: live or test + * @param string $mode + * The mode of operation: live or test. * * @param $paymentProcessor * @@ -49,7 +50,8 @@ class CRM_Core_Payment_PayJunction extends CRM_Core_Payment { /** * Singleton function used to manage this object * - * @param string $mode the mode of operation: live or test + * @param string $mode + * The mode of operation: live or test. * * @param object $paymentProcessor * @param null $paymentForm @@ -80,7 +82,8 @@ class CRM_Core_Payment_PayJunction extends CRM_Core_Payment { * This function collects all the information from a web/api form and invokes * the relevant payment processor specific functions to perform the transaction * - * @param array $params assoc array of input parameters for this transaction + * @param array $params + * Assoc array of input parameters for this transaction. * * @return array the result in an nice formatted array (or an error object) * @abstract @@ -235,7 +238,8 @@ class CRM_Core_Payment_PayJunction extends CRM_Core_Payment { /** * Get the value of a field if set * - * @param string $field the field + * @param string $field + * The field. * * @return mixed value of the field, or empty string if the field is * not set diff --git a/CRM/Core/Payment/PayPalImpl.php b/CRM/Core/Payment/PayPalImpl.php index 1171467e16..7ba916439c 100644 --- a/CRM/Core/Payment/PayPalImpl.php +++ b/CRM/Core/Payment/PayPalImpl.php @@ -49,7 +49,8 @@ class CRM_Core_Payment_PayPalImpl extends CRM_Core_Payment { /** * Constructor * - * @param string $mode the mode of operation: live or test + * @param string $mode + * The mode of operation: live or test. * * @param $paymentProcessor * @@ -77,7 +78,8 @@ class CRM_Core_Payment_PayPalImpl extends CRM_Core_Payment { /** * Singleton function used to manage this object * - * @param string $mode the mode of operation: live or test + * @param string $mode + * The mode of operation: live or test. * * @param object $paymentProcessor * @param null $paymentForm @@ -113,7 +115,8 @@ class CRM_Core_Payment_PayPalImpl extends CRM_Core_Payment { /** * Express checkout code. Check PayPal documentation for more information * - * @param array $params assoc array of input parameters for this transaction + * @param array $params + * Assoc array of input parameters for this transaction. * * @return array the result in an nice formatted array (or an error object) */ @@ -156,7 +159,8 @@ class CRM_Core_Payment_PayPalImpl extends CRM_Core_Payment { /** * Get details from paypal. Check PayPal documentation for more information * - * @param string $token the key associated with this transaction + * @param string $token + * The key associated with this transaction. * * @return array the result in an nice formatted array (or an error object) */ @@ -314,7 +318,8 @@ class CRM_Core_Payment_PayPalImpl extends CRM_Core_Payment { * This function collects all the information from a web/api form and invokes * the relevant payment processor specific functions to perform the transaction * - * @param array $params assoc array of input parameters for this transaction + * @param array $params + * Assoc array of input parameters for this transaction. * * @param string $component * @return array the result in an nice formatted array (or an error object) @@ -440,7 +445,8 @@ class CRM_Core_Payment_PayPalImpl extends CRM_Core_Payment { /** * Check whether a method is present ( & supported ) by the payment processor object. * - * @param string $method method to check for. + * @param string $method + * Method to check for. * * @return boolean */ diff --git a/CRM/Core/Payment/PayPalProIPN.php b/CRM/Core/Payment/PayPalProIPN.php index e8d8154571..595c9fd3a7 100644 --- a/CRM/Core/Payment/PayPalProIPN.php +++ b/CRM/Core/Payment/PayPalProIPN.php @@ -63,7 +63,8 @@ class CRM_Core_Payment_PayPalProIPN extends CRM_Core_Payment_BaseIPN { /** * Constructor function * - * @param array $inputData contents of HTTP REQUEST + * @param array $inputData + * Contents of HTTP REQUEST. * * @throws CRM_Core_Exception */ @@ -76,8 +77,10 @@ class CRM_Core_Payment_PayPalProIPN extends CRM_Core_Payment_BaseIPN { /** * Function exists to get the values from the rp_invoice_id string * - * @param string $name e.g. i, values are stored in the string with letter codes - * @param boolean $abort fatal if not found? + * @param string $name + * E.g. i, values are stored in the string with letter codes. + * @param bool $abort + * Fatal if not found?. * * @throws CRM_Core_Exception * @return unknown @@ -128,12 +131,16 @@ class CRM_Core_Payment_PayPalProIPN extends CRM_Core_Payment_BaseIPN { } /** - * @param string $name of variable to return - * @param string $type data type + * @param string $name + * Of variable to return. + * @param string $type + * Data type. * - String * - Integer - * @param string $location - deprecated - * @param boolean $abort abort if empty + * @param string $location + * Deprecated. + * @param bool $abort + * Abort if empty. * * @throws CRM_Core_Exception * @return Ambigous @@ -155,7 +162,7 @@ class CRM_Core_Payment_PayPalProIPN extends CRM_Core_Payment_BaseIPN { * @param array $input * @param array $ids * @param array $objects - * @param boolean $first + * @param bool $first * @return void|boolean */ public function recur(&$input, &$ids, &$objects, $first) { diff --git a/CRM/Core/Payment/PayflowPro.php b/CRM/Core/Payment/PayflowPro.php index 9a7aec0950..e103f278c1 100644 --- a/CRM/Core/Payment/PayflowPro.php +++ b/CRM/Core/Payment/PayflowPro.php @@ -29,7 +29,8 @@ class CRM_Core_Payment_PayflowPro extends CRM_Core_Payment { /* * Constructor * - * @param string $mode the mode of operation: live or test + * @param string $mode + * The mode of operation: live or test. * * @return void */ @@ -47,7 +48,8 @@ class CRM_Core_Payment_PayflowPro extends CRM_Core_Payment { /** * Singleton function used to manage this object * - * @param string $mode the mode of operation: live or test + * @param string $mode + * The mode of operation: live or test. * * @param object $paymentProcessor * @@ -77,7 +79,8 @@ class CRM_Core_Payment_PayflowPro extends CRM_Core_Payment { * This function collects all the information from a web/api form and invokes * the relevant payment processor specific functions to perform the transaction * - * @param array $params assoc array of input parameters for this transaction + * @param array $params + * Assoc array of input parameters for this transaction. * * @return array the result in an nice formatted array (or an error object) * @abstract @@ -375,7 +378,8 @@ class CRM_Core_Payment_PayflowPro extends CRM_Core_Payment { /** * Checks to see if invoice_id already exists in db * - * @param int $invoiceId The ID to check + * @param int $invoiceId + * The ID to check. * * @return bool True if ID exists, else false */ @@ -426,7 +430,8 @@ class CRM_Core_Payment_PayflowPro extends CRM_Core_Payment { * NOTE: Called by Events and Contribute to check config params are set prior to trying * register any credit card details * - * @param string $mode the mode we are operating in (live or test) - not used + * @param string $mode + * The mode we are operating in (live or test) - not used. * * returns string $errorMsg if any errors found - null if OK * diff --git a/CRM/Core/Payment/PaymentExpress.php b/CRM/Core/Payment/PaymentExpress.php index a04acb8cf1..991ec83e13 100644 --- a/CRM/Core/Payment/PaymentExpress.php +++ b/CRM/Core/Payment/PaymentExpress.php @@ -53,7 +53,8 @@ class CRM_Core_Payment_PaymentExpress extends CRM_Core_Payment { /** * Constructor * - * @param string $mode the mode of operation: live or test + * @param string $mode + * The mode of operation: live or test. * * @param $paymentProcessor * @@ -69,7 +70,8 @@ class CRM_Core_Payment_PaymentExpress extends CRM_Core_Payment { /** * Singleton function used to manage this object * - * @param string $mode the mode of operation: live or test + * @param string $mode + * The mode of operation: live or test. * * @param object $paymentProcessor * @param null $paymentForm @@ -151,7 +153,8 @@ class CRM_Core_Payment_PaymentExpress extends CRM_Core_Payment { * This function collects all the information from a web/api form and invokes * the relevant payment processor specific functions to perform the transaction * - * @param array $params assoc array of input parameters for this transaction + * @param array $params + * Assoc array of input parameters for this transaction. * * @return array the result in an nice formatted array (or an error object) * @abstract @@ -163,7 +166,8 @@ class CRM_Core_Payment_PaymentExpress extends CRM_Core_Payment { /** * Main transaction function * - * @param array $params name value pair of contribution data + * @param array $params + * Name value pair of contribution data. * * @param $component * diff --git a/CRM/Core/Payment/PaymentExpressIPN.php b/CRM/Core/Payment/PaymentExpressIPN.php index 8e7fb9d79b..62cf077502 100644 --- a/CRM/Core/Payment/PaymentExpressIPN.php +++ b/CRM/Core/Payment/PaymentExpressIPN.php @@ -84,7 +84,8 @@ class CRM_Core_Payment_PaymentExpressIPN extends CRM_Core_Payment_BaseIPN { /** * Constructor * - * @param string $mode the mode of operation: live or test + * @param string $mode + * The mode of operation: live or test. * * @param $paymentProcessor * @@ -100,7 +101,8 @@ class CRM_Core_Payment_PaymentExpressIPN extends CRM_Core_Payment_BaseIPN { /** * Singleton function used to manage this object * - * @param string $mode the mode of operation: live or test + * @param string $mode + * The mode of operation: live or test. * * @param $paymentProcessor * @param null $paymentForm @@ -120,7 +122,8 @@ class CRM_Core_Payment_PaymentExpressIPN extends CRM_Core_Payment_BaseIPN { * The function gets called when a new order takes place. * * @param $success - * @param array $privateData contains the name value pair of + * @param array $privateData + * Contains the name value pair of . * * @param $component * @param $amount @@ -209,8 +212,10 @@ class CRM_Core_Payment_PaymentExpressIPN extends CRM_Core_Payment_BaseIPN { /** * The function returns the component(Event/Contribute..)and whether it is Test or not * - * @param array $privateData contains the name-value pairs of transaction related data - * @param int $orderNo send by google + * @param array $privateData + * Contains the name-value pairs of transaction related data. + * @param int $orderNo + * send by google. * * @return array context of this call (test, component, payment processor id) * @static diff --git a/CRM/Core/Payment/Realex.php b/CRM/Core/Payment/Realex.php index b52db211f3..a9b63b33c4 100644 --- a/CRM/Core/Payment/Realex.php +++ b/CRM/Core/Payment/Realex.php @@ -57,7 +57,8 @@ class CRM_Core_Payment_Realex extends CRM_Core_Payment { /** * Constructor * - * @param string $mode the mode of operation: live or test + * @param string $mode + * The mode of operation: live or test. * * @param $paymentProcessor * @@ -80,7 +81,8 @@ class CRM_Core_Payment_Realex extends CRM_Core_Payment { /** * Singleton function used to manage this object * - * @param string $mode the mode of operation: live or test + * @param string $mode + * The mode of operation: live or test. * * @param object $paymentProcessor * @@ -140,7 +142,8 @@ class CRM_Core_Payment_Realex extends CRM_Core_Payment { /** * Submit a payment using Advanced Integration Method * - * @param array $params assoc array of input parameters for this transaction + * @param array $params + * Assoc array of input parameters for this transaction. * * @return array the result in a nice formatted array (or an error object) */ @@ -453,7 +456,8 @@ class CRM_Core_Payment_Realex extends CRM_Core_Payment { /** * Checks to see if invoice_id already exists in db * - * @param int $invoiceId The ID to check + * @param int $invoiceId + * The ID to check. * * @return bool True if ID exists, else false */ @@ -466,7 +470,8 @@ class CRM_Core_Payment_Realex extends CRM_Core_Payment { /** * Get the value of a field if set * - * @param string $field the field + * @param string $field + * The field. * * @return mixed value of the field, or empty string if the field is * not set diff --git a/CRM/Core/Payment/eWAY.php b/CRM/Core/Payment/eWAY.php index a4721ec84d..8c59057244 100644 --- a/CRM/Core/Payment/eWAY.php +++ b/CRM/Core/Payment/eWAY.php @@ -106,7 +106,8 @@ class CRM_Core_Payment_eWAY extends CRM_Core_Payment { /********************************************************** * Constructor * - * @param string $mode the mode of operation: live or test + * @param string $mode + * The mode of operation: live or test. * * @param $paymentProcessor * @@ -126,7 +127,8 @@ class CRM_Core_Payment_eWAY extends CRM_Core_Payment { /** * Singleton function used to manage this object * - * @param string $mode the mode of operation: live or test + * @param string $mode + * The mode of operation: live or test. * * @param object $paymentProcessor * @param null $paymentForm @@ -434,7 +436,8 @@ class CRM_Core_Payment_eWAY extends CRM_Core_Payment { /** * Checks to see if invoice_id already exists in db * - * @param int $invoiceId The ID to check + * @param int $invoiceId + * The ID to check. * * @return bool True if ID exists, else false */ diff --git a/CRM/Core/Permission.php b/CRM/Core/Permission.php index 87506175dd..29a58e381c 100644 --- a/CRM/Core/Permission.php +++ b/CRM/Core/Permission.php @@ -82,7 +82,8 @@ class CRM_Core_Permission { /** * Given a permission string or array, check for access requirements - * @param mixed $permissions the permission to check as an array or string -see examples + * @param mixed $permissions + * The permission to check as an array or string -see examples. * arrays * * Ex 1 @@ -157,7 +158,8 @@ class CRM_Core_Permission { /** * Given a group/role array, check for access requirements * - * @param array $array the group/role to check + * @param array $array + * The group/role to check. * * @return boolean true if yes, else false * @static @@ -170,9 +172,12 @@ class CRM_Core_Permission { /** * Get the permissioned where clause for the user * - * @param int $type the type of permission needed - * @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 $type + * The type of permission needed. + * @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 group where clause for this user */ @@ -185,7 +190,8 @@ class CRM_Core_Permission { * Get all groups from database, filtered by permissions * for this user * - * @param string $groupType type of group(Access/Mailing) + * @param string $groupType + * Type of group(Access/Mailing). * @param bool|\boolen $excludeHidden exclude hidden groups. * * @static @@ -424,8 +430,10 @@ class CRM_Core_Permission { /** * Check permissions for delete and edit actions * - * @param string $module component name. - * @param integer $action action to be check across component + * @param string $module + * Component name. + * @param int $action + * Action to be check across component. * * * @return bool @@ -737,7 +745,8 @@ class CRM_Core_Permission { /** * Get all the contact emails for users that have a specific permission * - * @param string $permissionName name of the permission we are interested in + * @param string $permissionName + * Name of the permission we are interested in. * * @return string a comma separated list of email addresses */ @@ -749,7 +758,8 @@ class CRM_Core_Permission { /** * Get all the contact emails for users that have a specific role * - * @param string $roleName name of the role we are interested in + * @param string $roleName + * Name of the role we are interested in. * * @return string a comma separated list of email addresses */ diff --git a/CRM/Core/Permission/Base.php b/CRM/Core/Permission/Base.php index 0626c7a0a3..eb1869b588 100644 --- a/CRM/Core/Permission/Base.php +++ b/CRM/Core/Permission/Base.php @@ -46,7 +46,8 @@ class CRM_Core_Permission_Base { * * @param $perm * @param string $nativePrefix - * @param array $map array($portableName => $nativeName) + * @param array $map + * Array($portableName => $nativeName). * * @internal param string $name e.g. "administer CiviCRM", "cms:access user record", "Drupal:administer content", "Joomla:action:com_asset" * @return NULL|string a permission name @@ -77,9 +78,12 @@ class CRM_Core_Permission_Base { /** * Get the permissioned where clause for the user * - * @param int $type the type of permission needed - * @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 $type + * The type of permission needed. + * @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 group where clause for this user */ @@ -89,9 +93,12 @@ class CRM_Core_Permission_Base { /** * Get the permissioned where clause for the user when trying to see groups * - * @param int $type the type of permission needed - * @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 $type + * The type of permission needed. + * @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 group where clause for this user */ @@ -104,7 +111,8 @@ class CRM_Core_Permission_Base { * Get all groups from database, filtered by permissions * for this user * - * @param string $groupType type of group(Access/Mailing) + * @param string $groupType + * Type of group(Access/Mailing). * @param bool|\boolen $excludeHidden exclude hidden groups. * * @@ -117,9 +125,12 @@ class CRM_Core_Permission_Base { /** * Get group clause for this user * - * @param int $type the type of permission needed - * @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 $type + * The type of permission needed. + * @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 group where clause for this user */ @@ -130,7 +141,8 @@ class CRM_Core_Permission_Base { /** * Given a permission string, check for access requirements * - * @param string $str the permission to check + * @param string $str + * The permission to check. * * @return boolean true if yes, else false */ @@ -142,7 +154,8 @@ class CRM_Core_Permission_Base { /** * Given a roles array, check for access requirements * - * @param array $array the roles to check + * @param array $array + * The roles to check. * * @return boolean true if yes, else false */ @@ -154,7 +167,8 @@ class CRM_Core_Permission_Base { /** * Get all the contact emails for users that have a specific permission * - * @param string $permissionName name of the permission we are interested in + * @param string $permissionName + * Name of the permission we are interested in. * * @return string a comma separated list of email addresses */ @@ -165,7 +179,8 @@ class CRM_Core_Permission_Base { /** * Get all the contact emails for users that have a specific role * - * @param string $roleName name of the role we are interested in + * @param string $roleName + * Name of the role we are interested in. * * @return string a comma separated list of email addresses */ @@ -190,7 +205,8 @@ class CRM_Core_Permission_Base { * deleted. This is useful during module upgrade when the newer module * version has removed permission that were defined in the older version. * - * @param array $permissions same format as CRM_Core_Permission::getCorePermissions(). + * @param array $permissions + * Same format as CRM_Core_Permission::getCorePermissions(). * * @throws CRM_Core_Exception * @see CRM_Core_Permission::getCorePermissions diff --git a/CRM/Core/Permission/Drupal.php b/CRM/Core/Permission/Drupal.php index d9943dc442..3271ffb574 100644 --- a/CRM/Core/Permission/Drupal.php +++ b/CRM/Core/Permission/Drupal.php @@ -65,7 +65,8 @@ class CRM_Core_Permission_Drupal extends CRM_Core_Permission_DrupalBase{ /** * Given a permission string, check for access requirements * - * @param string $str the permission to check + * @param string $str + * The permission to check. * * @param int $contactID * @@ -91,7 +92,8 @@ class CRM_Core_Permission_Drupal extends CRM_Core_Permission_DrupalBase{ /** * Given a roles array, check for access requirements * - * @param array $array the roles to check + * @param array $array + * The roles to check. * * @return boolean true if yes, else false */ @@ -131,7 +133,8 @@ class CRM_Core_Permission_Drupal extends CRM_Core_Permission_DrupalBase{ /** * Get all the contact emails for users that have a specific permission * - * @param string $permissionName name of the permission we are interested in + * @param string $permissionName + * Name of the permission we are interested in. * * @return string a comma separated list of email addresses */ diff --git a/CRM/Core/Permission/Drupal6.php b/CRM/Core/Permission/Drupal6.php index 767f34b956..b81a37d42b 100644 --- a/CRM/Core/Permission/Drupal6.php +++ b/CRM/Core/Permission/Drupal6.php @@ -64,7 +64,8 @@ class CRM_Core_Permission_Drupal6 extends CRM_Core_Permission_DrupalBase { /** * Given a permission string, check for access requirements * - * @param string $str the permission to check + * @param string $str + * The permission to check. * * @param int $contactID * @@ -90,7 +91,8 @@ class CRM_Core_Permission_Drupal6 extends CRM_Core_Permission_DrupalBase { /** * Given a roles array, check for access requirements * - * @param array $array the roles to check + * @param array $array + * The roles to check. * * @return boolean true if yes, else false */ @@ -111,7 +113,8 @@ class CRM_Core_Permission_Drupal6 extends CRM_Core_Permission_DrupalBase { /** * Get all the contact emails for users that have a specific role * - * @param string $roleName name of the role we are interested in + * @param string $roleName + * Name of the role we are interested in. * * @return string a comma separated list of email addresses */ @@ -144,7 +147,8 @@ class CRM_Core_Permission_Drupal6 extends CRM_Core_Permission_DrupalBase { /** * Get all the contact emails for users that have a specific permission * - * @param string $permissionName name of the permission we are interested in + * @param string $permissionName + * Name of the permission we are interested in. * * @return string a comma separated list of email addresses */ diff --git a/CRM/Core/Permission/Drupal8.php b/CRM/Core/Permission/Drupal8.php index 62b5196ac9..380c0ea4fa 100644 --- a/CRM/Core/Permission/Drupal8.php +++ b/CRM/Core/Permission/Drupal8.php @@ -40,7 +40,8 @@ class CRM_Core_Permission_Drupal8 extends CRM_Core_Permission_DrupalBase{ /** * Given a permission string, check for access requirements * - * @param string $str The permission to check + * @param string $str + * The permission to check. * * @return bool */ diff --git a/CRM/Core/Permission/DrupalBase.php b/CRM/Core/Permission/DrupalBase.php index 587ba80adc..e417956745 100644 --- a/CRM/Core/Permission/DrupalBase.php +++ b/CRM/Core/Permission/DrupalBase.php @@ -65,8 +65,10 @@ class CRM_Core_Permission_DrupalBase extends CRM_Core_Permission_Base { * Get all groups from database, filtered by permissions * for this user * - * @param string $groupType type of group(Access/Mailing) - * @param bool $excludeHidden exclude hidden groups. + * @param string $groupType + * Type of group(Access/Mailing). + * @param bool $excludeHidden + * Exclude hidden groups. * * * @return array - array reference of all groups. @@ -135,9 +137,12 @@ class CRM_Core_Permission_DrupalBase extends CRM_Core_Permission_Base { * @todo the history of this function is that there was some confusion as to * whether it was filtering contacts or groups & some cruft may remain * - * @param int $type the type of permission needed - * @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 $type + * The type of permission needed. + * @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 clause to add to the query retrieving viewable groups */ @@ -249,7 +254,8 @@ class CRM_Core_Permission_DrupalBase extends CRM_Core_Permission_Base { /** * Given a roles array, check for access requirements * - * @param array $array the roles to check + * @param array $array + * The roles to check. * * @return boolean true if yes, else false * @@ -277,7 +283,8 @@ class CRM_Core_Permission_DrupalBase extends CRM_Core_Permission_Base { /** * Get all the contact emails for users that have a specific permission * - * @param string $permissionName name of the permission we are interested in + * @param string $permissionName + * Name of the permission we are interested in. * * @return string a comma separated list of email addresses */ diff --git a/CRM/Core/Permission/Joomla.php b/CRM/Core/Permission/Joomla.php index f58c7bad95..a012cac210 100644 --- a/CRM/Core/Permission/Joomla.php +++ b/CRM/Core/Permission/Joomla.php @@ -40,7 +40,8 @@ class CRM_Core_Permission_Joomla extends CRM_Core_Permission_Base { /** * Given a permission string, check for access requirements * - * @param string $str the permission to check + * @param string $str + * The permission to check. * * @return boolean true if yes, else false */ @@ -96,7 +97,8 @@ class CRM_Core_Permission_Joomla extends CRM_Core_Permission_Base { /** * Given a roles array, check for access requirements * - * @param array $array the roles to check + * @param array $array + * The roles to check. * * @return boolean true if yes, else false * @static diff --git a/CRM/Core/Permission/Soap.php b/CRM/Core/Permission/Soap.php index d690eec06e..c8df36b409 100644 --- a/CRM/Core/Permission/Soap.php +++ b/CRM/Core/Permission/Soap.php @@ -41,7 +41,8 @@ class CRM_Core_Permission_Soap extends CRM_Core_Permission_Base { /** * Given a permission string, check for access requirements * - * @param string $str the permission to check + * @param string $str + * The permission to check. * * @return boolean true if yes, else false */ diff --git a/CRM/Core/Permission/UnitTests.php b/CRM/Core/Permission/UnitTests.php index a4c7e625d0..4345800486 100644 --- a/CRM/Core/Permission/UnitTests.php +++ b/CRM/Core/Permission/UnitTests.php @@ -44,7 +44,8 @@ class CRM_Core_Permission_UnitTests extends CRM_Core_Permission_Base { /** * Given a permission string, check for access requirements * - * @param string $str the permission to check + * @param string $str + * The permission to check. * * @return boolean true if yes, else false */ @@ -63,9 +64,12 @@ class CRM_Core_Permission_UnitTests extends CRM_Core_Permission_Base { /** * Get the permissioned where clause for the user * - * @param int $type the type of permission needed - * @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 $type + * The type of permission needed. + * @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 group where clause for this user */ diff --git a/CRM/Core/Permission/WordPress.php b/CRM/Core/Permission/WordPress.php index d6c137beac..a9eedb7c81 100644 --- a/CRM/Core/Permission/WordPress.php +++ b/CRM/Core/Permission/WordPress.php @@ -40,7 +40,8 @@ class CRM_Core_Permission_WordPress extends CRM_Core_Permission_Base { /** * Given a permission string, check for access requirements * - * @param string $str the permission to check + * @param string $str + * The permission to check. * * @return boolean true if yes, else false */ diff --git a/CRM/Core/PseudoConstant.php b/CRM/Core/PseudoConstant.php index 17c7c95332..8907b56434 100644 --- a/CRM/Core/PseudoConstant.php +++ b/CRM/Core/PseudoConstant.php @@ -214,9 +214,9 @@ class CRM_Core_PseudoConstant { * NOTE: Rather than calling this function directly use CRM_*_BAO_*::buildOptions() * @see http://wiki.civicrm.org/confluence/display/CRMDOC/Pseudoconstant+%28option+list%29+Reference * - * @param String $daoName - * @param String $fieldName - * @param Array $params + * @param string $daoName + * @param string $fieldName + * @param array $params * - name string name of the option group * - flip boolean results are return in id => label format if false * if true, the results are reversed @@ -228,7 +228,7 @@ class CRM_Core_PseudoConstant { * - orderColumn string the column to use for sorting, defaults to 'weight' column if one exists, else defaults to labelColumn * - onlyActive boolean return only the action option values * - fresh boolean ignore cache entries and go back to DB - * @param String $context: Context string + * @param string $context: Context string * * @return Array|bool - array on success, FALSE on error. * @@ -443,9 +443,9 @@ class CRM_Core_PseudoConstant { /** * Fetch the translated label for a field given its key * - * @param String $baoName - * @param String $fieldName - * @param String|Int $key + * @param string $baoName + * @param string $fieldName + * @param string|Int $key * * TODO: Accept multivalued input? * @@ -465,9 +465,9 @@ class CRM_Core_PseudoConstant { /** * Fetch the machine name for a field given its key * - * @param String $baoName - * @param String $fieldName - * @param String|Int $key + * @param string $baoName + * @param string $fieldName + * @param string|Int $key * * @return bool|null|string * FALSE if the given field has no associated option list @@ -485,9 +485,9 @@ class CRM_Core_PseudoConstant { /** * Fetch the key for a field option given its name * - * @param String $baoName - * @param String $fieldName - * @param String|Int $value + * @param string $baoName + * @param string $fieldName + * @param string|Int $value * * @return bool|null|string|number * FALSE if the given field has no associated option list @@ -538,12 +538,18 @@ class CRM_Core_PseudoConstant { * * Note: any database errors will be trapped by the DAO. * - * @param array $var the associative array we will fill - * @param string $name the name of the DAO - * @param boolean $all get all objects. default is to get only active ones. - * @param string $retrieve the field that we are interested in (normally name, differs in some objects) - * @param string $filter the field that we want to filter the result set with - * @param string $condition the condition that gets passed to the final query as the WHERE clause + * @param array $var + * The associative array we will fill. + * @param string $name + * The name of the DAO. + * @param bool $all + * Get all objects. default is to get only active ones. + * @param string $retrieve + * The field that we are interested in (normally name, differs in some objects). + * @param string $filter + * The field that we want to filter the result set with. + * @param string $condition + * The condition that gets passed to the final query as the WHERE clause. * * @param null $orderby * @param string $key @@ -698,7 +704,7 @@ class CRM_Core_PseudoConstant { * * @static * - * @param bool|int $id - Optional id to return + * @param bool|int $id - Optional id to return * * @param bool $limit * @@ -753,7 +759,7 @@ class CRM_Core_PseudoConstant { * * @static * - * @param bool|int $id - Optional id to return + * @param bool|int $id - Optional id to return * * @param bool $limit * @@ -927,8 +933,10 @@ WHERE id = %1"; * * Note: any database errors will be trapped by the DAO. * - * @param string $groupType type of group(Access/Mailing) - * @param bool $excludeHidden exclude hidden groups. + * @param string $groupType + * Type of group(Access/Mailing). + * @param bool $excludeHidden + * Exclude hidden groups. * * @static * @@ -984,8 +992,10 @@ WHERE id = %1"; * * Note: any database errors will be trapped by the DAO. * - * @param string $groupType type of group(Access/Mailing) - * @param bool $excludeHidden exclude hidden groups. + * @param string $groupType + * Type of group(Access/Mailing). + * @param bool $excludeHidden + * Exclude hidden groups. * * @static * @@ -1054,8 +1064,10 @@ WHERE id = %1"; * * Note: any database errors will be trapped by the DAO. * - * @param string $valueColumnName db column name/label. - * @param boolean $reset reset relationship types if true + * @param string $valueColumnName + * Db column name/label. + * @param bool $reset + * Reset relationship types if true. * * @static * @@ -1386,7 +1398,7 @@ WHERE id = %1"; * * @static * - * @param bool|int $id - Optional id to return + * @param bool|int $id - Optional id to return * * @return array - array reference of all Counties */ @@ -1416,8 +1428,10 @@ WHERE id = %1"; * * @static * - * @param boolean $all - get payment processors - default is to get only active ones. - * @param boolean $test - get test payment processors + * @param bool $all + * Get payment processors - default is to get only active ones. + * @param bool $test + * Get test payment processors. * * @param null $additionalCond * @@ -1450,7 +1464,8 @@ WHERE id = %1"; * * @static * - * @param boolean $all - get payment processors - default is to get only active ones. + * @param bool $all + * Get payment processors - default is to get only active ones. * * @param int $id * @param string $return @@ -1662,7 +1677,8 @@ ORDER BY name"; * Given a state ID return the country ID, this allows * us to populate forms and values for downstream code * - * @param $stateID int + * @param $stateID + * Int. * * @return int the country id that the state belongs to * @static @@ -1689,7 +1705,8 @@ WHERE id = %1 * * @static * - * @param $filter - get All Email Greetings - default is to get only active ones. + * @param $filter + * Get All Email Greetings - default is to get only active ones. * * @param string $columnName * @@ -1798,7 +1815,8 @@ WHERE id = %1 * * @static * - * @param boolean $optionGroupName - get All Option Group values- default is to get only active ones. + * @param bool $optionGroupName + * Get All Option Group values- default is to get only active ones. * * @param int $id * @param null $condition @@ -1820,7 +1838,8 @@ WHERE id = %1 /** * Fetch the list of active extensions of type 'module' * - * @param $fresh bool whether to forcibly reload extensions list from canonical store + * @param $fresh + * Bool whether to forcibly reload extensions list from canonical store. * @static * * @return array - array(array('prefix' => $, 'file' => $)) diff --git a/CRM/Core/QuickForm/Action.php b/CRM/Core/QuickForm/Action.php index d62fea1679..36a65562ca 100644 --- a/CRM/Core/QuickForm/Action.php +++ b/CRM/Core/QuickForm/Action.php @@ -50,7 +50,8 @@ class CRM_Core_QuickForm_Action extends HTML_QuickForm_Action { /** * Constructor * - * @param object $stateMachine reference to state machine object + * @param object $stateMachine + * Reference to state machine object. * * @return \CRM_Core_QuickForm_Action @access public diff --git a/CRM/Core/QuickForm/Action/Back.php b/CRM/Core/QuickForm/Action/Back.php index bab15f7326..c268336123 100644 --- a/CRM/Core/QuickForm/Action/Back.php +++ b/CRM/Core/QuickForm/Action/Back.php @@ -38,7 +38,8 @@ class CRM_Core_QuickForm_Action_Back extends CRM_Core_QuickForm_Action { /** * Class constructor * - * @param object $stateMachine reference to state machine object + * @param object $stateMachine + * Reference to state machine object. * * @return \CRM_Core_QuickForm_Action_Back */ @@ -49,8 +50,10 @@ class CRM_Core_QuickForm_Action_Back extends CRM_Core_QuickForm_Action { /** * Processes the request. * - * @param CRM_Core_Form $page the current form-page - * @param string $actionName Current action name, as one Action object can serve multiple actions + * @param CRM_Core_Form $page + * The current form-page. + * @param string $actionName + * Current action name, as one Action object can serve multiple actions. * * @return void */ diff --git a/CRM/Core/QuickForm/Action/Cancel.php b/CRM/Core/QuickForm/Action/Cancel.php index 9f3435c7cb..198e0d1b7c 100644 --- a/CRM/Core/QuickForm/Action/Cancel.php +++ b/CRM/Core/QuickForm/Action/Cancel.php @@ -38,7 +38,8 @@ class CRM_Core_QuickForm_Action_Cancel extends CRM_Core_QuickForm_Action { /** * Class constructor * - * @param object $stateMachine reference to state machine object + * @param object $stateMachine + * Reference to state machine object. * * @return \CRM_Core_QuickForm_Action_Cancel @access public @@ -50,8 +51,10 @@ class CRM_Core_QuickForm_Action_Cancel extends CRM_Core_QuickForm_Action { /** * Processes the request. * - * @param CRM_Core_Form $page CRM_Core_Form the current form-page - * @param string $actionName Current action name, as one Action object can serve multiple actions + * @param CRM_Core_Form $page + * CRM_Core_Form the current form-page. + * @param string $actionName + * Current action name, as one Action object can serve multiple actions. * * @return void */ diff --git a/CRM/Core/QuickForm/Action/Display.php b/CRM/Core/QuickForm/Action/Display.php index 1af51fab64..c92139478b 100644 --- a/CRM/Core/QuickForm/Action/Display.php +++ b/CRM/Core/QuickForm/Action/Display.php @@ -50,7 +50,8 @@ class CRM_Core_QuickForm_Action_Display extends CRM_Core_QuickForm_Action { /** * Class constructor * - * @param object $stateMachine reference to state machine object + * @param object $stateMachine + * Reference to state machine object. * * @return \CRM_Core_QuickForm_Action_Display @access public @@ -62,8 +63,10 @@ class CRM_Core_QuickForm_Action_Display extends CRM_Core_QuickForm_Action { /** * Processes the request. * - * @param CRM_Core_Form $page CRM_Core_Form the current form-page - * @param string $actionName Current action name, as one Action object can serve multiple actions + * @param CRM_Core_Form $page + * CRM_Core_Form the current form-page. + * @param string $actionName + * Current action name, as one Action object can serve multiple actions. * * @return void */ @@ -102,7 +105,8 @@ class CRM_Core_QuickForm_Action_Display extends CRM_Core_QuickForm_Action { /** * Render the page using a custom templating system * - * @param CRM_Core_Form $page the CRM_Core_Form page + * @param CRM_Core_Form $page + * The CRM_Core_Form page. * * * @return void @@ -186,7 +190,8 @@ class CRM_Core_QuickForm_Action_Display extends CRM_Core_QuickForm_Action { /** * Set the various rendering templates * - * @param CRM_Core_Form $page the CRM_Core_Form page + * @param CRM_Core_Form $page + * The CRM_Core_Form page. * * @return void */ diff --git a/CRM/Core/QuickForm/Action/Done.php b/CRM/Core/QuickForm/Action/Done.php index f07ea2d649..e1fbff4309 100644 --- a/CRM/Core/QuickForm/Action/Done.php +++ b/CRM/Core/QuickForm/Action/Done.php @@ -38,7 +38,8 @@ class CRM_Core_QuickForm_Action_Done extends CRM_Core_QuickForm_Action { /** * Class constructor * - * @param object $stateMachine reference to state machine object + * @param object $stateMachine + * Reference to state machine object. * * @return \CRM_Core_QuickForm_Action_Done @access public diff --git a/CRM/Core/QuickForm/Action/Jump.php b/CRM/Core/QuickForm/Action/Jump.php index 95818fcb4a..52ff324167 100644 --- a/CRM/Core/QuickForm/Action/Jump.php +++ b/CRM/Core/QuickForm/Action/Jump.php @@ -38,7 +38,8 @@ class CRM_Core_QuickForm_Action_Jump extends CRM_Core_QuickForm_Action { /** * Class constructor * - * @param object $stateMachine reference to state machine object + * @param object $stateMachine + * Reference to state machine object. * * @return \CRM_Core_QuickForm_Action_Jump @access public @@ -50,8 +51,10 @@ class CRM_Core_QuickForm_Action_Jump extends CRM_Core_QuickForm_Action { /** * Processes the request. * - * @param CRM_Core_Form $page CRM_Core_Form the current form-page - * @param string $actionName Current action name, as one Action object can serve multiple actions + * @param CRM_Core_Form $page + * CRM_Core_Form the current form-page. + * @param string $actionName + * Current action name, as one Action object can serve multiple actions. * * @return void */ diff --git a/CRM/Core/QuickForm/Action/Next.php b/CRM/Core/QuickForm/Action/Next.php index f58977fc78..8df1e00bf8 100644 --- a/CRM/Core/QuickForm/Action/Next.php +++ b/CRM/Core/QuickForm/Action/Next.php @@ -38,7 +38,8 @@ class CRM_Core_QuickForm_Action_Next extends CRM_Core_QuickForm_Action { /** * Class constructor * - * @param object $stateMachine reference to state machine object + * @param object $stateMachine + * Reference to state machine object. * * @return \CRM_Core_QuickForm_Action_Next @access public @@ -50,8 +51,10 @@ class CRM_Core_QuickForm_Action_Next extends CRM_Core_QuickForm_Action { /** * Processes the request. * - * @param CRM_Core_Form $page CRM_Core_Form the current form-page - * @param string $actionName Current action name, as one Action object can serve multiple actions + * @param CRM_Core_Form $page + * CRM_Core_Form the current form-page. + * @param string $actionName + * Current action name, as one Action object can serve multiple actions. * * @return void */ diff --git a/CRM/Core/QuickForm/Action/Process.php b/CRM/Core/QuickForm/Action/Process.php index 2587069d48..eb47b050b5 100644 --- a/CRM/Core/QuickForm/Action/Process.php +++ b/CRM/Core/QuickForm/Action/Process.php @@ -38,7 +38,8 @@ class CRM_Core_QuickForm_Action_Process extends CRM_Core_QuickForm_Action { /** * Class constructor * - * @param object $stateMachine reference to state machine object + * @param object $stateMachine + * Reference to state machine object. * * @return \CRM_Core_QuickForm_Action_Process @access public @@ -50,8 +51,10 @@ class CRM_Core_QuickForm_Action_Process extends CRM_Core_QuickForm_Action { /** * Processes the request. * - * @param CRM_Core_Form $page CRM_Core_Form the current form-page - * @param string $actionName Current action name, as one Action object can serve multiple actions + * @param CRM_Core_Form $page + * CRM_Core_Form the current form-page. + * @param string $actionName + * Current action name, as one Action object can serve multiple actions. * * @return void */ diff --git a/CRM/Core/QuickForm/Action/Refresh.php b/CRM/Core/QuickForm/Action/Refresh.php index f768cd6cca..2c48660f1a 100644 --- a/CRM/Core/QuickForm/Action/Refresh.php +++ b/CRM/Core/QuickForm/Action/Refresh.php @@ -38,7 +38,8 @@ class CRM_Core_QuickForm_Action_Refresh extends CRM_Core_QuickForm_Action { /** * Class constructor * - * @param object $stateMachine reference to state machine object + * @param object $stateMachine + * Reference to state machine object. * * @return \CRM_Core_QuickForm_Action_Refresh @access public @@ -50,8 +51,10 @@ class CRM_Core_QuickForm_Action_Refresh extends CRM_Core_QuickForm_Action { /** * Processes the request. * - * @param CRM_Core_Form $page the current form-page - * @param string $actionName Current action name, as one Action object can serve multiple actions + * @param CRM_Core_Form $page + * The current form-page. + * @param string $actionName + * Current action name, as one Action object can serve multiple actions. * * @return void */ diff --git a/CRM/Core/QuickForm/Action/Reload.php b/CRM/Core/QuickForm/Action/Reload.php index 4655f3effa..69d5fc36d4 100644 --- a/CRM/Core/QuickForm/Action/Reload.php +++ b/CRM/Core/QuickForm/Action/Reload.php @@ -41,7 +41,8 @@ class CRM_Core_QuickForm_Action_Reload extends CRM_Core_QuickForm_Action { /** * Class constructor * - * @param object $stateMachine reference to state machine object + * @param object $stateMachine + * Reference to state machine object. * * @return \CRM_Core_QuickForm_Action_Reload @access public @@ -53,8 +54,10 @@ class CRM_Core_QuickForm_Action_Reload extends CRM_Core_QuickForm_Action { /** * Processes the request. * - * @param CRM_Core_Form $page CRM_Core_Form the current form-page - * @param string $actionName Current action name, as one Action object can serve multiple actions + * @param CRM_Core_Form $page + * CRM_Core_Form the current form-page. + * @param string $actionName + * Current action name, as one Action object can serve multiple actions. * * @return void */ diff --git a/CRM/Core/QuickForm/Action/Submit.php b/CRM/Core/QuickForm/Action/Submit.php index d1d25bc34c..7becd87e3a 100644 --- a/CRM/Core/QuickForm/Action/Submit.php +++ b/CRM/Core/QuickForm/Action/Submit.php @@ -38,7 +38,8 @@ class CRM_Core_QuickForm_Action_Submit extends CRM_Core_QuickForm_Action { /** * Class constructor * - * @param object $stateMachine reference to state machine object + * @param object $stateMachine + * Reference to state machine object. * * @return \CRM_Core_QuickForm_Action_Submit @access public @@ -50,8 +51,10 @@ class CRM_Core_QuickForm_Action_Submit extends CRM_Core_QuickForm_Action { /** * Processes the request. * - * @param CRM_Core_Form $page CRM_Core_Form the current form-page - * @param string $actionName Current action name, as one Action object can serve multiple actions + * @param CRM_Core_Form $page + * CRM_Core_Form the current form-page. + * @param string $actionName + * Current action name, as one Action object can serve multiple actions. * * @return void */ diff --git a/CRM/Core/QuickForm/Action/Upload.php b/CRM/Core/QuickForm/Action/Upload.php index 87733285fb..8359a7867a 100644 --- a/CRM/Core/QuickForm/Action/Upload.php +++ b/CRM/Core/QuickForm/Action/Upload.php @@ -50,9 +50,12 @@ class CRM_Core_QuickForm_Action_Upload extends CRM_Core_QuickForm_Action { /** * Class constructor * - * @param object $stateMachine reference to state machine object - * @param string $uploadDir directory to store the uploaded files - * @param array $uploadNames element names of the various uploadable files + * @param object $stateMachine + * Reference to state machine object. + * @param string $uploadDir + * Directory to store the uploaded files. + * @param array $uploadNames + * Element names of the various uploadable files. * * @return \CRM_Core_QuickForm_Action_Upload @access public @@ -67,10 +70,14 @@ class CRM_Core_QuickForm_Action_Upload extends CRM_Core_QuickForm_Action { /** * Upload and move the file if valid to the uploaded directory * - * @param CRM_Core_Form $page the CRM_Core_Form object - * @param object $data the QFC data container - * @param string $pageName the name of the page which index the data container with - * @param string $uploadName the name of the uploaded file + * @param CRM_Core_Form $page + * The CRM_Core_Form object. + * @param object $data + * The QFC data container. + * @param string $pageName + * The name of the page which index the data container with. + * @param string $uploadName + * The name of the uploaded file. * * @return void */ @@ -110,8 +117,10 @@ class CRM_Core_QuickForm_Action_Upload extends CRM_Core_QuickForm_Action { /** * Processes the request. * - * @param CRM_Core_Form $page CRM_Core_Form the current form-page - * @param string $actionName Current action name, as one Action object can serve multiple actions + * @param CRM_Core_Form $page + * CRM_Core_Form the current form-page. + * @param string $actionName + * Current action name, as one Action object can serve multiple actions. * * @return void */ diff --git a/CRM/Core/QuickForm/NestedAdvMultiSelect.php b/CRM/Core/QuickForm/NestedAdvMultiSelect.php index 1be3868e2b..b03196e896 100644 --- a/CRM/Core/QuickForm/NestedAdvMultiSelect.php +++ b/CRM/Core/QuickForm/NestedAdvMultiSelect.php @@ -47,10 +47,14 @@ class CRM_Core_QuickForm_NestedAdvMultiSelect extends HTML_QuickForm_advmultisel * loading options with fancy attributes. * * @param mixed &$options Options source currently supports assoc array or DB_result - * @param mixed $param1 (optional) See function detail - * @param mixed $param2 (optional) See function detail - * @param mixed $param3 (optional) See function detail - * @param mixed $param4 (optional) See function detail + * @param mixed $param1 + * (optional) See function detail. + * @param mixed $param2 + * (optional) See function detail. + * @param mixed $param3 + * (optional) See function detail. + * @param mixed $param4 + * (optional) See function detail. * * @since version 1.5.0 (2009-02-15) * @return PEAR_Error|NULL on error and TRUE on success diff --git a/CRM/Core/Reference/Dynamic.php b/CRM/Core/Reference/Dynamic.php index c33477eb3d..32b9f1caa5 100644 --- a/CRM/Core/Reference/Dynamic.php +++ b/CRM/Core/Reference/Dynamic.php @@ -19,7 +19,8 @@ class CRM_Core_Reference_Dynamic extends CRM_Core_Reference_Basic { /** * Create a query to find references to a particular record * - * @param CRM_Core_DAO $targetDao the instance for which we want references + * @param CRM_Core_DAO $targetDao + * The instance for which we want references. * @return CRM_Core_DAO a query-handle (like the result of CRM_Core_DAO::executeQuery) */ public function findReferences($targetDao) { diff --git a/CRM/Core/Reference/Interface.php b/CRM/Core/Reference/Interface.php index 169de419d2..c331707e34 100644 --- a/CRM/Core/Reference/Interface.php +++ b/CRM/Core/Reference/Interface.php @@ -19,7 +19,8 @@ interface CRM_Core_Reference_Interface { /** * Create a query to find references to a particular record * - * @param CRM_Core_DAO $targetDao the instance for which we want references + * @param CRM_Core_DAO $targetDao + * The instance for which we want references. * @return CRM_Core_DAO|NULL a query-handle (like the result of CRM_Core_DAO::executeQuery) */ public function findReferences($targetDao); @@ -27,7 +28,8 @@ interface CRM_Core_Reference_Interface { /** * Create a query to find references to a particular record * - * @param CRM_Core_DAO $targetDao the instance for which we want references + * @param CRM_Core_DAO $targetDao + * The instance for which we want references. * @return array a record describing the reference; must include the keys: * - 'type': string (not necessarily unique) * - 'count': int diff --git a/CRM/Core/Region.php b/CRM/Core/Region.php index 15d76aa184..9b0384ea5a 100644 --- a/CRM/Core/Region.php +++ b/CRM/Core/Region.php @@ -10,7 +10,8 @@ class CRM_Core_Region { * Obtain the content for a given region * * @param string $name - * @param bool $autocreate whether to automatically create an empty region + * @param bool $autocreate + * Whether to automatically create an empty region. * @return CRM_Core_Region */ public static function &instance($name, $autocreate = TRUE) { @@ -83,7 +84,8 @@ class CRM_Core_Region { * Note: This function does not perform any extra encoding of markup, script code, or etc. If * you're passing in user-data, you must clean it yourself. * - * @param $snippet array; keys: + * @param $snippet + * Array; keys:. * - type: string (auto-detected for markup, template, callback, script, scriptUrl, jquery, style, styleUrl) * - name: string, optional * - weight: int, optional; default=1 @@ -146,8 +148,10 @@ class CRM_Core_Region { /** * Render all the snippets in a region * - * @param string $default HTML, the initial content of the region - * @param bool $allowCmsOverride allow CMS to override rendering of region + * @param string $default + * HTML, the initial content of the region. + * @param bool $allowCmsOverride + * Allow CMS to override rendering of region. * @return string, HTML */ public function render($default, $allowCmsOverride = TRUE) { @@ -233,7 +237,8 @@ class CRM_Core_Region { /** * Add block of static HTML to a region * - * @param string $markup HTML + * @param string $markup + * HTML. * public function addMarkup($markup) { return $this->add(array( @@ -247,7 +252,8 @@ class CRM_Core_Region { * * Note: File is not evaluated until the page is rendered * - * @param string $template path to the Smarty template file + * @param string $template + * Path to the Smarty template file. * public function addTemplate($template) { return $this->add(array( @@ -260,7 +266,8 @@ class CRM_Core_Region { * Use a callback function to extend a region * * @param mixed $callback - * @param array $arguments optional, array of parameters for callback; if omitted, the default arguments are ($snippetSpec, $html) + * @param array $arguments + * Optional, array of parameters for callback; if omitted, the default arguments are ($snippetSpec, $html). * public function addCallback($callback, $arguments = FALSE) { return $this->add(array( diff --git a/CRM/Core/Report/Excel.php b/CRM/Core/Report/Excel.php index 2d98bd6f24..5437970d17 100644 --- a/CRM/Core/Report/Excel.php +++ b/CRM/Core/Report/Excel.php @@ -38,10 +38,13 @@ class CRM_Core_Report_Excel { * Outputs a result set with a given header * in the string buffer result * - * @param string $header (reference ) column headers - * @param string $rows (reference ) result set rows + * @param string $header + * (reference ) column headers. + * @param string $rows + * (reference ) result set rows. * @param null $titleHeader - * @param boolean $print should the output be printed + * @param boolean $print + * Should the output be printed. * * @param bool $outputHeader * @@ -189,12 +192,18 @@ class CRM_Core_Report_Excel { /** * Write a CSV file to the browser output * - * @param string $fileName - the name of the file that will be downloaded (this is sent to the browser) - * @param array $header - an array of the headers - * @param array $rows - an array of arrays of the table contents - * @param string $titleHeader - if set this will be the title in the CSV - * @param boolean $outputHeader - should we output the header row - * @param boolean $saveFile - + * @param string $fileName + * The name of the file that will be downloaded (this is sent to the browser). + * @param array $header + * An array of the headers. + * @param array $rows + * An array of arrays of the table contents. + * @param string $titleHeader + * If set this will be the title in the CSV. + * @param bool $outputHeader + * Should we output the header row. + * @param bool $saveFile + * -. * * @return void * @static diff --git a/CRM/Core/Resources.php b/CRM/Core/Resources.php index ca6d0f003a..3e8de7b627 100644 --- a/CRM/Core/Resources.php +++ b/CRM/Core/Resources.php @@ -102,7 +102,8 @@ class CRM_Core_Resources { /** * Get or set the single instance of CRM_Core_Resources * - * @param $instance CRM_Core_Resources, new copy of the manager + * @param $instance + * CRM_Core_Resources, new copy of the manager. * @return CRM_Core_Resources */ static public function singleton(CRM_Core_Resources $instance = NULL) { @@ -127,8 +128,10 @@ class CRM_Core_Resources { /** * Construct a resource manager * - * @param CRM_Extension_Mapper $extMapper Map extension names to their base path or URLs. - * @param CRM_Utils_Cache_Interface $cache JS-localization cache + * @param CRM_Extension_Mapper $extMapper + * Map extension names to their base path or URLs. + * @param CRM_Utils_Cache_Interface $cache + * JS-localization cache. * @param string|null $cacheCodeKey Random code to append to resource URLs; changing the code forces clients to reload resources */ public function __construct($extMapper, $cache, $cacheCodeKey = NULL) { @@ -149,10 +152,14 @@ class CRM_Core_Resources { /** * Add a JavaScript file to the current page using