* 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 $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
@access public
/**
* Fill the queue with upgrade tasks
*
- * @param $currentVer string, the original revision
- * @param $latestVer string, the target (final) revision
- * @param $postUpgradeMessageFile string, path of a modifiable file which lists the post-upgrade messages
+ * @param $currentVer
+ * String, the original revision.
+ * @param $latestVer
+ * String, the target (final) revision.
+ * @param $postUpgradeMessageFile
+ * String, path of a modifiable file which lists the post-upgrade messages.
*
* @return CRM_Queue
*/
* Perform an incremental version update
*
* @param CRM_Queue_TaskContext $ctx
- * @param $rev string, the target (intermediate) revision e.g '3.2.alpha1'
+ * @param $rev
+ * String, the target (intermediate) revision e.g '3.2.alpha1'.
*
* @return bool
*/
* Perform an incremental version update
*
* @param CRM_Queue_TaskContext $ctx
- * @param $rev string, the target (intermediate) revision e.g '3.2.alpha1'
- * @param $originalVer string, the original revision
- * @param $latestVer string, the target (final) revision
- * @param $postUpgradeMessageFile string, path of a modifiable file which lists the post-upgrade messages
+ * @param $rev
+ * String, the target (intermediate) revision e.g '3.2.alpha1'.
+ * @param $originalVer
+ * String, the original revision.
+ * @param $latestVer
+ * String, the target (final) revision.
+ * @param $postUpgradeMessageFile
+ * String, path of a modifiable file which lists the post-upgrade messages.
*
* @return bool
*/
* Perform an incremental version update
*
* @param CRM_Queue_TaskContext $ctx
- * @param $rev string, the target (intermediate) revision e.g '3.2.alpha1'
- * @param $currentVer string, the original revision
- * @param $latestVer string, the target (final) revision
- * @param $postUpgradeMessageFile string, path of a modifiable file which lists the post-upgrade messages
+ * @param $rev
+ * String, the target (intermediate) revision e.g '3.2.alpha1'.
+ * @param $currentVer
+ * String, the original revision.
+ * @param $latestVer
+ * String, the target (final) revision.
+ * @param $postUpgradeMessageFile
+ * String, path of a modifiable file which lists the post-upgrade messages.
*
* @return bool
*/
* by calling the 'setPreUpgradeMessage' on each incremental upgrade
* object.
*
- * @param $preUpgradeMessage string, alterable
+ * @param $preUpgradeMessage
+ * String, alterable.
* @param $currentVer
* @param $latestVer
*/
/**
* Compute any messages which should be displayed before upgrade
*
- * @param $preUpgradeMessage string, alterable
+ * @param $preUpgradeMessage
+ * String, alterable.
* @param $currentVer
* @param $latestVer
*/
/**
* Compute any messages which should be displayed after upgrade
*
- * @param $postUpgradeMessage string, alterable
- * @param $rev string, an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs
+ * @param $postUpgradeMessage
+ * String, alterable.
+ * @param $rev
+ * String, an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs.
* @return void
*/
public static function setPostUpgradeMessage(&$postUpgradeMessage, $rev) {
/**
* Perform an incremental upgrade
*
- * @param $rev string, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final)
+ * @param $rev
+ * String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
*/
public static function upgrade_2_2_alpha1($rev) {
for ($stepID = 1; $stepID <= 4; $stepID++) {
/**
* Perform an incremental upgrade
*
- * @param $rev string, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final)
+ * @param $rev
+ * String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
*/
public static function upgrade_2_1_2($rev) {
$formName = "CRM_Upgrade_TwoOne_Form_TwoOneTwo";
/**
* Perform an incremental upgrade
*
- * @param $rev string, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final)
+ * @param $rev
+ * String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
*/
public static function upgrade_2_2_beta1($rev) {
if (!CRM_Core_DAO::checkFieldExists('civicrm_pcp_block', 'notify_email')) {
/**
* Perform an incremental upgrade
*
- * @param $rev string, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final)
+ * @param $rev
+ * String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
*/
public static function upgrade_2_2_beta2($rev) {
$template = CRM_Core_Smarty::singleton();
/**
* Perform an incremental upgrade
*
- * @param $rev string, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final)
+ * @param $rev
+ * String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
*/
public static function upgrade_2_2_beta3($rev) {
$template = CRM_Core_Smarty::singleton();
/**
* Perform an incremental upgrade
*
- * @param $rev string, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final)
+ * @param $rev
+ * String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
*/
public static function upgrade_3_0_alpha1($rev) {
/**
* Perform an incremental upgrade
*
- * @param $rev string, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final)
+ * @param $rev
+ * String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
*/
public static function upgrade_3_1_alpha1($rev) {
/**
* Perform an incremental upgrade
*
- * @param $rev string, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final)
+ * @param $rev
+ * String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
*/
public static function upgrade_2_2_7($rev) {
$upgrade = new CRM_Upgrade_Form();
/**
* Perform an incremental upgrade
*
- * @param $rev string, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final)
+ * @param $rev
+ * String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
*/
public static function upgrade_3_0_2($rev) {
/**
* Perform an incremental upgrade
*
- * @param $rev string, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final)
+ * @param $rev
+ * String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
*/
public static function upgrade_3_0_4($rev) {
//make sure 'Deceased' membership status present in db,CRM-5636
/**
* Perform an incremental upgrade
*
- * @param $rev string, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final)
+ * @param $rev
+ * String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
*/
public static function upgrade_3_1_0($rev) {
// upgrade all roles who have 'access CiviEvent' permission, to also have
/**
* Perform an incremental upgrade
*
- * @param $rev string, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final)
+ * @param $rev
+ * String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
*/
public static function upgrade_3_1_3($rev) {
$threeOne = new CRM_Upgrade_ThreeOne_ThreeOne();
/**
* Perform an incremental upgrade
*
- * @param $rev string, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final)
+ * @param $rev
+ * String, the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
*/
public static function upgrade_3_1_4($rev) {
$threeOne = new CRM_Upgrade_ThreeOne_ThreeOne();
* revision to the database.
*
* @param $preUpgradeMessage
- * @param $rev string, a version number, e.g. '4.4.alpha1', '4.4.beta3', '4.4.0'
+ * @param $rev
+ * String, a version number, e.g. '4.4.alpha1', '4.4.beta3', '4.4.0'.
* @param null $currentVer
*
* @return void
/**
* Compute any messages which should be displayed after upgrade
*
- * @param $postUpgradeMessage string, alterable
- * @param $rev string, an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs
+ * @param $postUpgradeMessage
+ * String, alterable.
+ * @param $rev
+ * String, an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs.
* @return void
*/
public function setPostUpgradeMessage(&$postUpgradeMessage, $rev) {
*
*
* @param CRM_Queue_TaskContext $ctx
- * @param $startId int, the first/lowest entity ID to convert
- * @param $endId int, the last/highest entity ID to convert
+ * @param $startId
+ * Int, the first/lowest entity ID to convert.
+ * @param $endId
+ * Int, the last/highest entity ID to convert.
* @param
*
* @return bool
* revision to the database.
*
* @param $preUpgradeMessage
- * @param $rev string, a version number, e.g. '4.4.alpha1', '4.4.beta3', '4.4.0'
+ * @param $rev
+ * String, a version number, e.g. '4.4.alpha1', '4.4.beta3', '4.4.0'.
* @param null $currentVer
*
* @return void
/**
* Compute any messages which should be displayed after upgrade
*
- * @param $postUpgradeMessage string, alterable
- * @param $rev string, an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs
+ * @param $postUpgradeMessage
+ * String, alterable.
+ * @param $rev
+ * String, an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs.
* @return void
*/
public function setPostUpgradeMessage(&$postUpgradeMessage, $rev) {
* 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
*/
/**
* Compute any messages which should be displayed after upgrade
*
- * @param $postUpgradeMessage string, alterable
- * @param $rev string, an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs
+ * @param $postUpgradeMessage
+ * String, alterable.
+ * @param $rev
+ * String, an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs.
*
* @return void
*/
* revision to the database.
*
* @param $preUpgradeMessage
- * @param $rev string, a version number, e.g. '4.4.alpha1', '4.4.beta3', '4.4.0'
+ * @param $rev
+ * String, a version number, e.g. '4.4.alpha1', '4.4.beta3', '4.4.0'.
* @param null $currentVer
*
* @return void
/**
* Compute any messages which should be displayed after upgrade
*
- * @param $postUpgradeMessage string, alterable
- * @param $rev string, an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs
+ * @param $postUpgradeMessage
+ * String, alterable.
+ * @param $rev
+ * String, an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs.
* @return void
*/
public function setPostUpgradeMessage(&$postUpgradeMessage, $rev) {
* revision to the database.
*
* @param $preUpgradeMessage
- * @param $rev string, a version number, e.g. '4.3.alpha1', '4.3.beta3', '4.3.0'
+ * @param $rev
+ * String, a version number, e.g. '4.3.alpha1', '4.3.beta3', '4.3.0'.
* @param null $currentVer
*
* @return void|bool
/**
* Compute any messages which should be displayed after upgrade
*
- * @param $postUpgradeMessage string, alterable
- * @param $rev string, an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs
+ * @param $postUpgradeMessage
+ * String, alterable.
+ * @param $rev
+ * String, an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs.
* @return void
*/
public function setPostUpgradeMessage(&$postUpgradeMessage, $rev) {
* revision to the database.
*
* @param $preUpgradeMessage
- * @param $rev string, a version number, e.g. '4.2.alpha1', '4.2.beta3', '4.2.0'
+ * @param $rev
+ * String, a version number, e.g. '4.2.alpha1', '4.2.beta3', '4.2.0'.
* @param null $currentVer
*
* @return void
/**
* Compute any messages which should be displayed after upgrade
*
- * @param $postUpgradeMessage string, alterable
- * @param $rev string, an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs
+ * @param $postUpgradeMessage
+ * String, alterable.
+ * @param $rev
+ * String, an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs.
* @return void
*/
public function setPostUpgradeMessage(&$postUpgradeMessage, $rev) {
* records.
*
* @param CRM_Queue_TaskContext $ctx
- * @param $startId int, the first/lowest contribution ID to convert
- * @param $endId int, the last/highest contribution ID to convert
+ * @param $startId
+ * Int, the first/lowest contribution ID to convert.
+ * @param $endId
+ * Int, the last/highest contribution ID to convert.
*
* @return bool
*/
* records.
*
* @param CRM_Queue_TaskContext $ctx
- * @param $startId int, the first/lowest participant ID to convert
- * @param $endId int, the last/highest participant ID to convert
+ * @param $startId
+ * Int, the first/lowest participant ID to convert.
+ * @param $endId
+ * Int, the last/highest participant ID to convert.
*
* @return bool
*/
* price field 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_Upgrade_Snapshot_V4p2_Price_BAO_Field object
* @static
*
* This function is invoked from within the web form layer and also from the api layer
*
- * @param array $params (reference) an assoc array of name/value pairs
+ * @param array $params
+ * (reference) an assoc array of name/value pairs.
*
* @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_Field object
* @static
/**
* Fetch object based on array of properties
*
- * @param array $params (reference ) an assoc array of name/value pairs
- * @param array $defaults (reference ) an assoc array to hold the 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_Upgrade_Snapshot_V4p2_Price_DAO_Field object
* @static
/**
* Update the is_active flag in the db
*
- * @param int $id Id of the database record
- * @param boolean $is_active Value we want to set the is_active field
+ * @param int $id
+ * Id of the database record.
+ * @param bool $is_active
+ * Value we want to set the is_active field.
*
* @return Object DAO object on sucess, null otherwise
*
/**
* Get the field title.
*
- * @param int $id id of field.
+ * @param int $id
+ * Id of field.
*
* @return string name
*
/**
* 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
- * @param boolean $useRequired true if required else false
- * @param string $label label for custom field
+ * @param bool $inactiveNeeded
+ * @param bool $useRequired
+ * True if required else false.
+ * @param string $label
+ * Label for custom field.
* @param null $fieldOptions
* @param array $freezeOptions
*
/**
* Retrieve a list of options for the specified field
*
- * @param int $fieldId price field ID
- * @param bool $inactiveNeeded include inactive options
- * @param bool $reset ignore stored values\
+ * @param int $fieldId
+ * Price field ID.
+ * @param bool $inactiveNeeded
+ * Include inactive options.
+ * @param bool $reset
+ * Ignore stored values\.
*
* @return array array of options
*/
/**
* Delete the price set field.
*
- * @param int $id Field Id
+ * @param int $id
+ * Field Id.
*
* @return boolean
*
/**
* Validate the priceset
*
- * @param int $priceSetId , array $fields
+ * @param int $priceSetId
+ * , array $fields.
*
* retrun the error string
*
/**
* Insert/update a new entry in the database.
*
- * @param array $params (reference), array $ids
+ * @param array $params
+ * (reference), array $ids.
*
* @param $ids
*
/**
* Creates a new entry in the database.
*
- * @param array $params (reference), array $ids
+ * @param array $params
+ * (reference), array $ids.
*
* @param $ids
*
* Takes a bunch of params that are needed to match certain criteria and
* retrieves the relevant objects.
*
- * @param array $params (reference ) an assoc array
- * @param array $defaults (reference ) an assoc array to hold the flattened values
+ * @param array $params
+ * (reference ) an assoc array.
+ * @param array $defaults
+ * (reference ) an assoc array to hold the flattened values.
*
* @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue object
* @static
/**
* Retrive the all values for given field id
*
- * @param int $fieldId price_field_id
- * @param array $values (reference ) to hold the values
- * @param string $orderBy for order by, default weight
+ * @param int $fieldId
+ * Price_field_id.
+ * @param array $values
+ * (reference ) to hold the values.
+ * @param string $orderBy
+ * For order by, default weight.
* @param bool|int $isActive is_active, default false
*
* @return array $values
/**
* Get the price field option label.
*
- * @param int $id id of field option.
+ * @param int $id
+ * Id of field option.
*
* @return string name
*
/**
* 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
*
/**
* Delete all values of the given field id
*
- * @param int $fieldId Price field id
+ * @param int $fieldId
+ * Price field id.
*
* @return boolean
*
/**
* Delete the value.
*
- * @param int $id Id
+ * @param int $id
+ * Id.
*
* @return boolean
*
/**
* Creates a new entry in the database.
*
- * @param array $params (reference) an assoc array of name/value pairs
+ * @param array $params
+ * (reference) an assoc array of name/value pairs.
*
* @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_LineItem object
* @static
* price_field_id. This is the inverse function of create. It also
* stores all of 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_Upgrade_Snapshot_V4p2_Price_BAO_LineItem object
* @static
* Given a participant id/contribution id,
* return contribution/fee line items
*
- * @param $entityId int participant/contribution id
- * @param $entity string participant/contribution.
+ * @param $entityId
+ * Int participant/contribution id.
+ * @param $entity
+ * String participant/contribution.
*
* @param null $isQuick
*
* This method will create the lineItem array required for
* processAmount method
*
- * @param int $fid price set field id
- * @param array $params reference to form values
- * @param array $fields reference to array of fields belonging
+ * @param int $fid
+ * Price set field id.
+ * @param array $params
+ * Reference to form values.
+ * @param array $fields
+ * Reference to array of fields belonging.
* to the price set used for particular event
- * @param array $values reference to the values array(
+ * @param array $values
+ * Reference to the values array(.
this is
* lineItem array)
*
/**
* Takes an associative array and creates a price set 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_Upgrade_Snapshot_V4p2_Price_DAO_Set object
* @static
/**
* Fetch object based on array of properties
*
- * @param array $params (reference ) an assoc array of name/value pairs
- * @param array $defaults (reference ) an assoc array to hold the 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_Upgrade_Snapshot_V4p2_Price_DAO_Set object
* @static
/**
* Update the is_active flag in the db
*
- * @param int $id id of the database record
- * @param bool $isActive value we want to set the is_active field
+ * @param int $id
+ * Id of the database record.
+ * @param bool $isActive
+ * Value we want to set the is_active field.
*
* @return Object DAO object on sucess, null otherwise
* @static
/**
* Get the price set title.
*
- * @param int $id id of price set
+ * @param int $id
+ * Id of price set.
*
* @return string title
*
/**
* Return a list of all forms which use this price set.
*
- * @param int $id id of price set
+ * @param int $id
+ * Id of price set.
* @param bool|\str $simpleReturn - get raw data. Possible values: 'entity', 'table'
*
* @return array
/**
* Delete the price set
*
- * @param int $id Price Set id
+ * @param int $id
+ * Price Set id.
*
* @return boolean false if fields exist for this set, true if the
* set could be deleted
* Link the price set with the specified table and id
*
* @param string $entityTable
- * @param integer $entityId
- * @param integer $priceSetId
+ * @param int $entityId
+ * @param int $priceSetId
*
* @return bool
*/
* Delete price set for the given entity and id
*
* @param string $entityTable
- * @param integer $entityId
+ * @param int $entityId
*
* @return mixed
*/
*
* @param string $entityTable
* @param int $entityId
- * @param int $usedFor ( price set that extends/used for particular component )
+ * @param int $usedFor
+ * ( price set that extends/used for particular component ).
*
* @param null $isQuickConfig
* @param null $setName
/**
* Find a price_set_id associatied with the given option value or field ID
*
- * @param array $params (reference) an assoc array of name/value pairs
+ * @param array $params
+ * (reference) an assoc array of name/value pairs.
* array may contain either option id or
* price field id
*
/**
* Return an associative array of all price sets
*
- * @param bool $withInactive whether or not to include inactive entries
+ * @param bool $withInactive
+ * Whether or not to include inactive entries.
* @param bool|string $extendComponentName name of the component like 'CiviEvent','CiviContribute'
*
* @return array associative array of id => name
*
* An array containing price set details (including price fields) is returned
*
- * @param int $setID price set id whose details are needed
+ * @param int $setID
+ * Price set id whose details are needed.
* @param bool $required
* @param bool $validOnly
*
* This function is to make a copy of a price set, including
* all the fields
*
- * @param int $id the price set id to copy
+ * @param int $id
+ * The price set id to copy.
*
* @return the copy object
* @static
/**
* This function is to check price set permission
*
- * @param int $sid the price set id
+ * @param int $sid
+ * The price set id.
*
* @return bool
*/
* Get the sum of participant count
* for all fields of given price set.
*
- * @param int $sid the price set id
+ * @param int $sid
+ * The price set id.
*
* @param bool $onlyActive
*
/**
* Function to check if auto renew option should be shown
*
- * @param int $priceSetId price set id
+ * @param int $priceSetId
+ * Price set id.
*
* @return int $autoRenewOption ( 0:hide, 1:optional 2:required )
*/
/**
* Retrieve auto renew frequency and interval
*
- * @param int $priceSetId price set id
+ * @param int $priceSetId
+ * Price set id.
*
* @return array associate array of frequency interval and unit
* @static
/**
* Update the is_quick_config flag in the db
*
- * @param int $id id of the database record
- * @param boolean $isQuickConfig value we want to set the is_quick_config field
+ * @param int $id
+ * Id of the database record.
+ * @param boolean $isQuickConfig
+ * Value we want to set the is_quick_config field.
*
* @return Object DAO object on sucess, null otherwise
* @static
/**
* returns a ts()-translated enum value for display purposes
*
- * @param string $field the enum field in question
- * @param string $value the enum value up for translation
+ * @param string $field
+ * The enum field in question.
+ * @param string $value
+ * The enum value up for translation.
*
* @return string the display value of the enum
*/
/**
* adds $value['foo_display'] for each $value['foo'] enum from civicrm_price_field
*
- * @param array $values (reference) the array up for enhancing
+ * @param array $values
+ * (reference) the array up for enhancing.
* @return void
*/
public static function addDisplayEnums(&$values)
projects / civicrm-core.git / commitdiff