* check if the user has access to this group for operation $type
*
* @param int $type the type of permission needed
- * @param int $contactID the contactID for whom the check is made
+ * @param $groupID
+ * @param int $contactID the contactID for whom the check is made
+ *
+ * @param string $tableName
+ * @param null $allGroups
+ * @param null $includedGroups
+ * @param bool $flush
*
* @return array the ids of the groups for which the user has permissions
* @access public
* Given a list of conditions in query generate the required
* where clause
*
+ * @param $query
+ *
* @return void
* @access public
*/
/**
* where clause for a single field
*
+ * @param $values
+ * @param $query
* @return void
* @access public
*/
/**
* getter for array of the parameters required for creating pager.
*
- * @param
+ * @param $action
+ * @param $params
+ *
+ * @internal param $
* @access public
*/
function getPagerParams($action, &$params) {
/**
* getter for array of the parameters required for creating pager.
*
- * @param
+ * @param $action
+ * @param $params
+ *
+ * @internal param $
* @access public
*/
function getPagerParams($action, &$params) {
/**
* Get user context.
*
+ * @param null $mode
+ *
* @return string user context.
*/
function userContext($mode = NULL) {
/**
* Get user context.
*
+ * @param null $mode
+ *
* @return string user context.
*/
function userContext($mode = NULL) {
*
* The result format resembles the old CRM_Core_Extensions_Extension.
*
+ * @param CRM_Extension_Info $obj
+ *
* @return array
*/
public static function createExtendedInfo(CRM_Extension_Info $obj) {
/**
* Browse all jobs.
*
+ * @param null $action
+ *
* @return void
* @access public
* @static
/**
* Get user context.
*
+ * @param null $mode
+ *
* @return string user context.
*/
function userContext($mode = NULL) {
class CRM_Admin_Page_MailSettings extends CRM_Core_Page_Basic {
public $useLivePageJS = TRUE;
-
+
/**
* The action links that we need to display for the browse screen
*
/**
* Get user context.
*
+ * @param null $mode
+ *
* @return string user context.
*/
function userContext($mode = NULL) {
/**
* Get user context.
*
+ * @param null $mode
+ *
* @return string user context.
*/
function userContext($mode = NULL) {
* This function is used to add the rules (mainly global rules) for form.
* All local rules are added near the element
*
+ * @param $fields
+ * @param $files
+ * @param $errors
+ *
* @return void
* @access public
* @see valid_date
* the form with a customized title for the main Submit
*
* @param string $title title of the main button
- * @param string $type button type for the form after processing
+ * @param string $nextType
+ * @param string $backType
+ * @param bool $submitOnce
+ *
+ * @internal param string $type button type for the form after processing
*
* @return void
* @access public
*
* @param array $fields posted values of the form
*
+ * @param $files
+ * @param $self
+ *
* @return array list of errors to be posted back to the form
* @static
* @access public
/**
* Get user context.
*
+ * @param null $mode
+ *
* @return string user context.
*/
function userContext($mode = NULL) {
* @access public
* @static
*
- * @param boolean $name pseudoconstant to be flushed
- *
+ * @param bool|string $name pseudoconstant to be flushed
*/
public static function flush($name = 'cache') {
if (isset(self::$$name)) {
/**
* getter for array of the parameters required for creating pager.
*
- * @param
+ * @param $action
+ * @param $params
+ *
+ * @internal param $
* @access public
*/
function getPagerParams($action, &$params) {
* full featured over a period of time. This is the inverse function of
* create. It also stores all the retrieved values in the default array
*
- * @param array $params (reference ) an assoc array of name/value pairs
+ * @param array $params (reference ) an assoc array of name/value pairs
* @param array $defaults (reference ) an assoc array to hold the name / value pairs
* in a hierarchical manner
- * @param array $ids (reference) the array that holds all the db ids
+ *
+ * @internal param array $ids (reference) the array that holds all the db ids
*
* @return object CRM_Case_BAO_CaseType object
* @access public
*
* @access public
*
+ * @param $form
+ * @param $params
+ *
* @return void
*/
static function endPostProcess(&$form, &$params) {
*
* @param array $values posted values of the form
*
+ * @param $files
+ * @param $form
+ *
* @return array list of errors to be posted back to the form
* @static
* @access public
* - View
* - Edit
*
+ * @param bool $isDeleted
+ * @param null $key
+ *
* @return array
* @access public
- *
*/
static
function &links($isDeleted = FALSE, $key = NULL) {
/**
* function to get the information to map a contact
*
- * @param array $ids the list of ids for which we want map info
+ * @param array $ids the list of ids for which we want map info
* $param int $locationTypeID
*
+ * @param null $locationTypeID
+ * @param bool $imageUrlOnly
+ *
* @return null|string display name of the contact if found
* @static
* @access public
/**
* Function to check if there are any contacts in cache table
*
- * @param string $type the type of operation (view|edit)
- * @param int $contactID contact id
+ * @param int|string $type the type of operation (view|edit)
+ * @param int $contactID contact id
*
* @return boolean
* @access public
/**
* Create Current employer relationship for a individual
*
- * @param int $contactID contact id of the individual
- * @param string $organization it can be name or id of organization
+ * @param int $contactID contact id of the individual
+ * @param $organizationId
+ * @param null $previousEmployerID
+ *
+ * @internal param string $organization it can be name or id of organization
*
* @access public
* @static
*
*function to retrieve all basic contact types.
*
- *@return array of basic contact types
- *@static
+ * @param bool $all
*
+ * @return array of basic contact types
+ * @static
*/
static function basicTypes($all = FALSE) {
return array_keys(self::basicTypeInfo($all));
*
* @param int $contactId contact id
*
+ * @param bool $visibility
+ *
* @access public
*
* @return array $values this array has key-> group id and value group title
*
* @param array $fields posted values of the form
*
+ * @param $files
+ * @param $self
+ *
* @return array list of errors to be posted back to the form
* @static
* @access public
/**
* global validation rules for the form
*
- * @param array $fields posted values of the form
+ * @param $params
+ *
+ * @internal param array $fields posted values of the form
*
* @return array list of errors to be posted back to the form
* @static
/**
* This function is to get the result of the search for Add to * forms
*
- * @param array $params This contains elements for search criteria
+ * @param $form
+ * @param array $params This contains elements for search criteria
*
* @access public
*
* @return void
- *
*/
function search(&$form, &$params) {
//max records that will be listed
*
* @access public
*
+ * @param $form
+ *
* @return void
*/
static function buildQuickForm(&$form) {
*
* @access protected
*
+ * @param $form
+ *
* @return array the default array reference
*/
function setDefaultValues($form) {
*
* @param array $fields posted values of the form
*
+ * @param $files
+ * @param $self
+ *
* @return array list of errors to be posted back to the form
* @static
* @access public
/**
* Get user context
*
+ * @param null $mode
+ *
* @return string user context
*/
function userContext($mode = NULL) {
/**
* getter for array of the parameters required for creating pager.
*
- * @param
+ * @param $action
+ * @param $params
+ *
+ * @internal param $
* @access public
*/
function getPagerParams($action, &$params) {
/**
* Delete Recurring contribution.
*
+ * @param $recurId
+ *
* @return true / false.
* @access public
* @static
*
* @access public
*
- * @return void
+ * @param $form
*
+ * @return void
*/
static function buildPaymentReminders(&$form) {
//PaymentReminders section
*
* @access public
*
+ * @param $params
+ * @param $contributionID
+ * @param null $premiumID
+ * @param null $options
* @return void
*/
static function processPremium(&$params, $contributionID, $premiumID = NULL, &$options = NULL) {
*
* @access public
*
+ * @param $params
+ * @param $formatted
+ * @param $form
* @return void
*/
static function postProcessCommon(&$params, &$formatted, &$form) {
*
* @form object of Contribution form.
*
- * @param array $params (reference ) an assoc array of name/value pairs.
+ * @param $form
+ * @param array $params (reference ) an assoc array of name/value pairs.
* @$ccContribution boolen, is it credit card contribution.
+ * @param bool $ccContribution
* @access public.
*
* @return void.
* Function to build form for related contacts / on behalf of organization.
*
* @param $form object invoking Object
- * @param $contactType string contact type
- * @param $title string fieldset title
+ *
+ * @internal param string $contactType contact type
+ * @internal param string $title fieldset title
*
* @static
*/
if (empty($defaults['amount_label'])) {
$defaults['amount_label'] = ts('Contribution Amount');
}
-
+
if (!empty($defaults['value']) && is_array($defaults['value'])) {
// CRM-4038: fix value display
/**
* global form rule
*
- * @param array $fields the input form values
- * @param array $files the uploaded files if any
- * @param array $options additional user data
+ * @param array $fields the input form values
+ * @param array $files the uploaded files if any
+ * @param $self
+ *
+ * @internal param array $options additional user data
*
* @return true if no errors, else array of errors
* @access public
}
}
}
-
+
if (!empty($fields['payment_processor']) && $financialType = CRM_Contribute_BAO_Contribution::validateFinancialType($self->_defaultValues['financial_type_id'])) {
- $errors['payment_processor'] = ts("Financial Account of account relationship of 'Expense Account is' is not configured for Financial Type : ") . $financialType;
+ $errors['payment_processor'] = ts("Financial Account of account relationship of 'Expense Account is' is not configured for Financial Type : ") . $financialType;
}
-
+
if (!empty($fields['is_recur_interval'])) {
foreach(array_keys($fields['payment_processor']) as $paymentProcessorID) {
$paymentProcessorTypeId = CRM_Core_DAO::getFieldValue(
$editedResults = array();
CRM_Price_BAO_PriceField::retrieve($editedFieldParams, $editedResults);
-
+
if (!$priceFieldID = CRM_Utils_Array::value('id', $editedResults)) {
$fieldParams = array(
'name' => 'other_amount',
if (!$noContriAmount) {
$fieldParams['is_required'] = 1;
$fieldParams['option_label'][1] = $fieldParams['label'] = $params['amount_label'];
- }
+ }
else {
$fieldParams['is_required'] = 0;
$fieldParams['option_label'][1] = $fieldParams['label'] = 'Other Amount';
}
$priceField = CRM_Price_BAO_PriceField::create($fieldParams);
- }
+ }
else {
if (empty($editedResults['is_active'])) {
if (!$noContriAmount) {
$priceField = CRM_Price_BAO_PriceField::add($fieldParams);
}
}
- }
+ }
elseif (empty($params['is_allow_other_amount']) && !empty($params['price_field_other'])) {
CRM_Price_BAO_PriceField::setIsActive($params['price_field_other'], '0');
- }
+ }
elseif ($priceFieldID = CRM_Utils_Array::value('price_field_other', $params)) {
$priceFieldValueID = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceFieldValue', $priceFieldID, 'id', 'price_field_id');
if (!$noContriAmount) {
);
CRM_Price_BAO_PriceField::add($fieldParams);
CRM_Core_DAO::setFieldValue('CRM_Price_DAO_PriceFieldValue', $priceFieldValueID, 'label', $params['amount_label']);
- }
+ }
else {
CRM_Core_DAO::setFieldValue('CRM_Price_DAO_PriceField', $priceFieldID, 'is_required', 0 );
CRM_Core_DAO::setFieldValue('CRM_Price_DAO_PriceFieldValue', $priceFieldValueID, 'label', 'Other Amount');
/**
* global form rule
*
- * @param array $fields the input form values
+ * @param array $fields the input form values
+ *
+ * @param $files
+ * @param $contributionPageId
*
* @return true if no errors, else array of errors
* @access public
*
* @param array $params (ref.) an assoc array of name/value pairs
*
+ * @param $files
+ * @param $self
+ *
* @return mixed true or array of errors
* @access public
* @static
/**
* global form rule
*
- * @param array $fields the input form values
+ * @param array $fields the input form values
+ *
+ * @param $errors
+ * @param $self
*
* @return true if no errors, else array of errors
* @access public
* the form with a customized title for the main Submit
*
* @param string $title title of the main button
- * @param string $type button type for the form after processing
+ * @param string $nextType
+ * @param string $backType
+ * @param bool $submitOnce
+ *
+ * @internal param string $type button type for the form after processing
*
* @return void
* @access public
/**
* global form rule
*
- * @param array $fields the input form values
- * @param array $files the uploaded files if any
- * @param array $options additional user data
+ * @param array $fields the input form values
+ * @param array $files the uploaded files if any
+ * @param $self
+ *
+ * @internal param array $options additional user data
*
* @return true if no errors, else array of errors
* @access public
/**
* Get user context.
*
+ * @param null $mode
+ *
* @return string user context.
*/
function userContext($mode = NULL) {
*
* @access public
*
+ * @param null $id
+ *
* @return array - array reference of all financial types if any
* @static
*/
* @access public
* @static
*
- * @param boolean $name pseudoconstant to be flushed
- *
+ * @param bool|string $name pseudoconstant to be flushed
*/
public static function flush($name = 'cache') {
if (isset(self::$$name)) {
*
* @access public
*
+ * @param null $pageID
* @return array - array of all Premiums if any
* @static
*/
*
* @access public
*
+ * @param null $id
+ * @param string $columnName
* @return array - array reference of all contribution statuses
* @static
*/
* Class constructor
*
* @param array $queryParams array of parameters for query
- * @param int $action - action of search basic or advanced.
- * @param string $contributionClause if the caller wants to further restrict the search (used in contributions)
+ * @param \const|int $action - action of search basic or advanced.
+ * @param string $contributionClause if the caller wants to further restrict the search (used in contributions)
* @param boolean $single are we dealing only with one contact?
- * @param int $limit how many contributions do we want returned
+ * @param int $limit how many contributions do we want returned
*
- * @return CRM_Contact_Selector
- * @access public
+ * @param string $context
+ * @param null $compContext
+ *
+ * @return \CRM_Contribute_Selector_Search
+ @access public
*/
function __construct(&$queryParams,
$action = CRM_Core_Action::NONE,
/**
* getter for array of the parameters required for creating pager.
*
- * @param
+ * @param $action
+ * @param $params
+ * @internal param $
* @access public
*/
function getPagerParams($action, &$params) {
* 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 $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 string $extraULName enclosed extra links in this UL.
+ * @param boolean $enclosedAllInSingleUL force to enclosed all links in single UL.
+ *
+ * @param null $op
+ * @param null $objectName
+ * @param null $objectId
*
* @return string the html string
* @access public
/**
* 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 null $id
*
* @return array (reference) reminder list
* @static
/**
* 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 array $requiredFields fields that's are required in a block
+ * @param string $blockName block name
+ * @param array $params (reference ) an assoc array of name/value pairs
+ * @param null $entity
+ * @param null $contactId
+ *
+ * @internal param array $requiredFields fields that's are required in a block
*
* @return object CRM_Core_BAO_Block object on success, null otherwise
* @access public
/**
* Function to retrieve the settings values from db
*
+ * @param $defaults
+ *
* @return array $defaults
* @static
*/
/**
* Function to check dashlet permission for current user
*
- * @param string permission string
+ * @param $permission
+ * @param $operator
+ *
+ * @internal param \permission $string string
*
* @return boolean true if use has permission else false
*/
/**
* Save the values of a domain
*
+ * @param $params
+ * @param $id
+ *
* @return domain array
* @access public
*/
/**
* 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 array $entityIds (reference ) the array of entity ids to be added
+ * @param int $tagId the id of the tag
+ * @param string $entityTable
* @params string $entityTable name of entity table default:civicrm_contact
*
* @return array (total, added, notAdded) count of enities added to tag
/**
* 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 array $entityIds (reference ) the array of entity ids to be removed
+ * @param int $tagId the id of the tag
+ * @param string $entityTable
* @params string $entityTable name of entity table default:civicrm_contact
*
* @return array (total, removed, notRemoved) count of entities removed from tags
* 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 string $entityTable name of the entity table usually 'civicrm_contact'
- * @param int $entityID id of the entity usually the contactID.
+ * @param $entity_id
+ *
+ * @internal param string $entityTable name of the entity table usually 'civicrm_contact'
+ * @internal param int $entityID id of the entity usually the contactID.
*
* @return array( ) reference $tag array of catagory id's the contact belongs to.
*
/**
* Delete financial transaction
*
+ * @param $entity_id
* @return true on success, false otherwise
* @access public
* @static
*
* @params $mapTypeId string mapping Type
*
- * @return boolean
+ * @param $nameField
+ * @param $mapTypeId
*
+ * @return boolean
*/
static function checkMapping($nameField, $mapTypeId) {
$mapping = new CRM_Core_DAO_Mapping();
* @param $parentID parent_id of a menu
* @param $menuID menu id
*
- * @return $weight string
- * @static
+ * @return int $weight string@static
*/
static function calculateWeight($parentID = NULL, $menuID = NULL) {
$domainID = CRM_Core_Config::domainID();
/**
* Function to delete the notes
*
- * @param int $id note id
+ * @param int $id note id
* @param boolean $showStatus do we need to set status or not
*
- * @return $return no of deleted notes on success, false otherwise
- *
- * @access public
+ * @return mixed|null $return no of deleted notes on success, false otherwise@access public
* @static
*/
static function del($id, $showStatus = TRUE) {
/**
* Get Paper Size field from associative array
*
- * @param string $field name of a Paper Size field
- * @param array (reference) $values associative array of name/value pairs containing
+ * @param string $field name of a Paper Size field
+ * @param array (reference) $values associative array of name/value pairs containing
* Paper Size field selections
*
+ * @param null $default
+ *
* @return value
* @access public
* @static
* @param array $entityElements the array containing entity_id and
* entity_table name
*
+ * @param null $type
+ *
* @return array the array of phone ids which are potential numbers
* @access public
* @static
* 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 $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 $contactID If set, this is a contactID specific setting, else its a global setting
+ *
+ * @param null $domainID
*
* @return object The data if present in the setting table, else null
* @static
/**
* 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
*
* @return array the fields that are needed for registration
* @static
/**
* 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 array $ufGroupIds
+ * @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 null $restrict
+ * @param bool $skipPermission
+ * @param int $permissionType
* @return array the fields that are listings related
* @static
* @access public
*
* @param int $id the contact id
*
+ * @param bool $updateBlankLocInfo
+ *
* @return array the array of website details
* @access public
* @static
* @params int $id one of the class constants (ADD, SEARCH, etc.)
* @params string $property the desired property
*
+ * @param $id
+ * @param $property
+ *
* @return string the value of the desired property
*/
static function getProperty($id, $property) {
* @params string $property the desired property
* @params string $value the value of the desired property
*
+ * @param $id
+ * @param $property
+ * @param $value
* @return void
*/
static function setProperty($id, $property, $value) {
/**
* All CRM single or multi page pages should inherit from this class.
*
- * @param string title descriptive title of the controller
- * @param boolean whether controller is modal
- * @param string scope name of session if we want unique scope, used only by Controller_Simple
- * @param boolean addSequence should we add a unique sequence number to the end of the key
- * @param boolean ignoreKey should we not set a qfKey for this controller (for standalone forms)
+ * @param null $title
+ * @param bool $modal
+ * @param null $mode
+ * @param null $scope
+ * @param bool $addSequence
+ * @param bool $ignoreKey
+ *
+ * @internal param \title $string descriptive title of the controller
+ * @internal param \whether $boolean controller is modal
+ * @internal param \scope $string name of session if we want unique scope, used only by Controller_Simple
+ * @internal param \addSequence $boolean should we add a unique sequence number to the end of the key
+ * @internal param \ignoreKey $boolean should we not set a qfKey for this controller (for standalone forms)
*
* @access public
*
- * @return void
- *
+ * @return \CRM_Core_Controller
*/
function __construct(
$title = NULL,
/**
* Factory method to instantiate a new object from a table name.
*
+ * @param string $table
+ *
* @return void
* @access public
*/
/**
* 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 integer $count
- * @param string $from
- * @param stringe $to
* @param string $from Label
+ * @param string|\stringe $to
+ * @param string $fromLabel
* @param boolean $required
* @param string $dateFormat
* @param boolean $displayTime
+ *
+ * @internal param int $count
* @return null
*/
static function addDateRangeToForm(&$form, $fieldName, $selector, $from = '_from', $to = '_to', $fromLabel = 'From:', $required = FALSE, $dateFormat = 'searchDate', $displayTime = FALSE) {
* @param $table string the table containing the column
* @param $class string schema structure class to use to recreate indices
*
+ * @param array $triggers
+ *
* @return void
*/
static function makeSinglelingualTable(
* @param $condition
* @param $labelColumnName
* @param $onlyActive
+ * @param string $keyColumnName
*/
protected static function flushValues($name, $flip, $grouping, $localize, $condition, $labelColumnName, $onlyActive, $keyColumnName = 'value') {
$cacheKey = self::createCacheKey($name, $flip, $grouping, $localize, $condition, $labelColumnName, $onlyActive, $keyColumnName);
* @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
+ *
* @return array the values as specified by the above params
* @static
* @void
/**
* 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 $optionGroupID
* @param string $fieldName the name of the field in the DAO
*
* @return boolean true if object exists
/**
* 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 $mode
+ * @param string $contactType
+ *
+ * @internal param string $value the value of the field we are checking
+ * @internal param string $daoName the dao object name
+ * @internal 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
+ * @internal param string $fieldName the name of the field in the DAO
*
* @return boolean true if object exists
* @access public
/**
* assign value to name in template by reference
*
- * @param array|string $name name of variable
+ * @param $var
* @param mixed $value (reference) value of varaible
*
+ * @internal param array|string $name name of variable
* @return void
* @access public
*/
/**
* browse all entities.
*
- * @param int $action
+ * @internal param int $action
*
* @return void
* @access public
* 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 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
*
* @return void
* @access private
/**
* create all fields needed for direct debit transaction
*
+ * @param $form
+ *
* @return void
* @access public
*/
/**
* Function to add all the direct debit fields
*
+ * @param $form
+ * @param bool $useRequired
* @return void
* @access public
*/
/**
* do the express checkout at paypal. Check PayPal documentation for more information
*
- * @param string $token the key associated with this transaction
+ * @param $params
+ *
+ * @internal param string $token the key associated with this transaction
*
* @return array the result in an nice formatted array (or an error object)
* @public
*
* @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)
* @public
*/
* Get all groups from database, filtered by permissions
* for this user
*
- * @param string $groupType type of group(Access/Mailing)
- * @param boolen $excludeHidden exclude hidden groups.
+ * @param string $groupType type of group(Access/Mailing)
+ * @param bool|\boolen $excludeHidden exclude hidden groups.
*
* @access public
* @static
*
* @return array - array reference of all groups.
- *
*/
public static function group($groupType, $excludeHidden = TRUE) {
$config = CRM_Core_Config::singleton();
* Get the permissions defined in the hook_civicrm_permission implementation
* of the given module.
*
+ * @param $module
+ *
* @return Array of permissions, in the same format as CRM_Core_Permission::getCorePermissions().
*/
static function getModulePermissions($module) {
/**
* Class constructor
*
- * @param CRM_Core_Selector_API $object an object that implements the selector API
- * @param int $pageID default pageID
- * @param int $sortID default sortID
- * @param int $action the actions to potentially support
- * @param CRM_Core_Page|CRM_Core_Form $store place in session to store some values
- * @param int $output what do we so with the output, session/template//both
- *
- * @return Object
- * @access public
- */ function __construct($object, $pageID, $sortID, $action, $store = NULL, $output = self::TEMPLATE, $prefix = NULL, $case = NULL) {
+ * @param CRM_Core_Selector_API $object an object that implements the selector API
+ * @param int $pageID default pageID
+ * @param int $sortID default sortID
+ * @param int $action the actions to potentially support
+ * @param CRM_Core_Page|CRM_Core_Form $store place in session to store some values
+ * @param int $output what do we so with the output, session/template//both
+ *
+ * @param null $prefix
+ * @param null $case
+ *
+ * @return \CRM_Core_Selector_Controller
+ @access public
+ */
+ function __construct($object, $pageID, $sortID, $action, $store = NULL, $output = self::TEMPLATE, $prefix = NULL, $case = NULL) {
$this->_object = $object;
$this->_pageID = $pageID ? $pageID : 1;
*
* @param CRM_Core_Session $store
*
+ * @param int $mode
+ *
* @return void
* @access public
*/
/**
* function to create labels (pdf)
*
- * @param array $contactRows assciated array of contact data
- * @param string $format format in which labels needs to be printed
+ * @param $participants
+ *
+ * @internal param array $contactRows assciated array of contact data
+ * @internal param string $format format in which labels needs to be printed
*
* @return null
* @access public
/**
* global validation rules for the form
*
- * @param array $fields posted values of the form
+ * @param $values
+ *
+ * @internal param array $fields posted values of the form
*
* @return array list of errors to be posted back to the form
* @static
/**
* Function to build Registration Block
*
- * @param int $pageId
+ * @param $form
+ *
+ * @internal param int $pageId
* @static
*/
function buildRegistrationBlock(&$form) {
* the form with a customized title for the main Submit
*
* @param string $title title of the main button
- * @param string $type button type for the form after processing
+ * @param string $nextType
+ * @param string $backType
+ * @param bool $submitOnce
+ *
+ * @internal param string $type button type for the form after processing
*
* @return void
* @access public
*
* @param array $fields posted values of the form
*
+ * @param $files
+ * @param $self
+ *
* @return array list of errors to be posted back to the form
* @static
* @access public
*
* @access public
*
+ * @param null $id
+ * @param null $cond
+ *
* @return array - array reference of all participant roles if any
* @static
*/
*
* @access public
*
+ * @param null $id
* @return array - array reference of all event types.
* @static
*/
* @access public
* @static
*
- * @param boolean $name pseudoconstant to be flushed
- *
+ * @param bool|string $name pseudoconstant to be flushed
*/
public static function flush($name = 'cache') {
if (isset(self::$$name)) {
*
* @access public
*
+ * @param null $id
* @return array - array reference of all pcp if any
* @static
*/
/**
* Class constructor
*
- * @param array $queryParams array of parameters for query
- * @param int $action - action of search basic or advanced.
- * @param string $eventClause if the caller wants to further restrict the search (used in participations)
+ * @param array $queryParams array of parameters for query
+ * @param \const|int $action - action of search basic or advanced.
+ * @param string $eventClause if the caller wants to further restrict the search (used in participations)
* @param boolean $single are we dealing only with one contact?
- * @param int $limit how many participations do we want returned
+ * @param int $limit how many participations do we want returned
*
- * @return CRM_Contact_Selector
- * @access public
+ * @param string $context
+ * @param null $compContext
+ *
+ * @return \CRM_Event_Selector_Search
+ @access public
*/
function __construct(&$queryParams,
$action = CRM_Core_Action::NONE,
/**
* Validate that $extractedZipPath contains valid for extension $key
*
+ * @param $key
+ * @param $extractedZipPath
+ *
* @return bool
*/
function validateFiles($key, $extractedZipPath) {
* Function to run hooks in the payment processor class
* Load requested payment processor and call the method specified.
*
+ * @param CRM_Extension_Info $info
* @param string $method - the method to call in the payment processor class
+ *
* @private
*/
private function _runPaymentHook(CRM_Extension_Info $info, $method) {
*
* @financialTypeId int Financial Type Id
*
+ * @param $financialTypeId
+ *
* @return accounting code
* @static
*/
*
* @param $financialAccountTypeId financial account type id
*
- * @param $accountTypeCode account type code
+ * @param \account|string $accountTypeCode account type code
*
* @return integer count
* @static
/**
* retrive entity financial trxn details
*
- * @param array $params (reference ) an assoc array of name/value pairs
+ * @param array $params (reference ) an assoc array of name/value pairs
+ *
+ * @param bool $maxId
*
- * @param boolean $maxID to retrive max id
+ * @internal param bool $maxID to retrive max id
*
* @return array
* @access public
/**
* Function to retrieve payment processor id / info/ object based on component-id.
*
- * @param int $componentID id of a component
- * @param string $component component
- * @param string $type type of payment information to be retrieved
+ * @param $entityID
+ * @param string $component component
+ * @param string $type type of payment information to be retrieved
*
+ * @internal param int $componentID id of a component
* @return id / array / object based on type
* @static
* @access public
/**
* global validation rules for the form
*
- * @param array $fields posted values of the form
+ * @param $values
+ * @param $files
+ * @param $self
+ *
+ * @internal param array $fields posted values of the form
*
* @return array list of errors to be posted back to the form
* @static
/**
* global validation rules for the form
*
- * @param array $fields posted values of the form
+ * @param $action
+ * @param $permissions
+ * @param $createdID
+ * @param $userContactID
+ * @param $actionName
+ *
+ * @internal param array $fields posted values of the form
*
* @return array list of errors to be posted back to the form
* @static
/**
* Get user context.
*
+ * @param null $mode
+ *
* @return string user context.
*/
function userContext($mode = null) {
/**
* Get rows for the event browser
*
- * @param int $mailing_id ID of the mailing
- * @param int $job_id optional ID of the job
- * @param boolean $is_distinct Group by queue id?
- * @param int $offset Offset
- * @param int $rowCount Number of rows
- * @param array $sort sort array
+ * @param int $mailing_id ID of the mailing
+ * @param int $job_id optional ID of the job
+ * @param boolean $is_distinct Group by queue id?
+ * @param int $offset Offset
+ * @param int $rowCount Number of rows
+ * @param array $sort sort array
+ *
+ * @param null $contact_id
*
* @return array Result set
* @access public
* CRM-12814
* Get tracked url count for each mailing for a given set of mailing IDs
*
- * @param int $contactID ID of the mailing
+ * @param $mailingIDs
+ *
+ * @internal param int $contactID ID of the mailing
*
* @return array trackable url count per mailing ID
* @access public
* Warning: if you make changes here, be sure to also make them in
* Retry.php
*
- * @param array $params The form values
+ * @param array $params The form values
+ *
+ * @param $files
+ * @param $self
*
* @return boolean True if either we deliver immediately, or the
* date is properly set.
*
* @access public
*
+ * @param null $mode
+ *
* @return array - array reference of all mailing templates if any
* @static
*/
* @access public
* @static
*
- * @param boolean $name pseudoconstant to be flushed
- *
+ * @param bool|string $name pseudoconstant to be flushed
*/
public static function flush($name = 'template') {
if (isset(self::$$name)) {
/**
* getter for array of the parameters required for creating pager.
*
- * @param
+ * @param $action
+ * @param $params
+ *
+ * @internal param $
* @access public
*/
function getPagerParams($action, &$params) {
* Class constructor
*
* @param array $queryParams array of parameters for query
- * @param int $action - action of search basic or advanced.
- * @param string $mailingClause if the caller wants to further restrict the search
+ * @param \const|int $action - action of search basic or advanced.
+ * @param string $mailingClause if the caller wants to further restrict the search
* @param boolean $single are we dealing only with one contact?
- * @param int $limit how many mailing do we want returned
+ * @param int $limit how many mailing do we want returned
*
- * @return CRM_Contact_Selector
- * @access public
+ * @param string $context
+ * @param null $compContext
+ *
+ * @return \CRM_Mailing_Selector_Search
+ @access public
*/
function __construct(&$queryParams,
$action = CRM_Core_Action::NONE,
/**
* Function to find the membership status based on start date, end date, join date & status date.
*
- * @param date $startDate start date of the member whose membership status is to be calculated.
- * @param date $endDate end date of the member whose membership status is to be calculated.
- * @param date $joinDate join date of the member whose membership status is to be calculated.
- * @param date $statusDate status date of the member whose membership status is to be calculated.
+ * @param date $startDate start date of the member whose membership status is to be calculated.
+ * @param date $endDate end date of the member whose membership status is to be calculated.
+ * @param date $joinDate join date of the member whose membership status is to be calculated.
+ * @param \date|string $statusDate status date of the member whose membership status is to be calculated.
* @param boolean $excludeIsAdmin exclude the statuses those having is_admin = 1
- * @param integer $membershipType membership type id - passed to the hook
+ * @param $membershipTypeID
* @param array $membership membership params as available to calling function - passed to the hook
*
- * @return
- * @static
+ * @internal param int $membershipType membership type id - passed to the hook
+ * @return array
+ @static
*/
static function getMembershipStatusByDate($startDate, $endDate, $joinDate,
$statusDate = 'today', $excludeIsAdmin = FALSE, $membershipTypeID, $membership = array()
/**
* Function to calculate start date and end date for new membership
*
- * @param int $membershipTypeId membership type id
+ * @param int $membershipTypeId membership type id
* @param date $joinDate member since ( in mysql date format )
* @param date $startDate start date ( in mysql date format )
- * @param int $numRenewTerms how many membership terms are being added to end date (default is 1)
+ * @param null $endDate
+ * @param int $numRenewTerms how many membership terms are being added to end date (default is 1)
*
* @return array associated array with start date, end date and join date for the membership
* @static
*
* @param array $params (ref.) an assoc array of name/value pairs
*
+ * @param $files
+ * @param null $contributionPageId
+ *
* @return mixed true or array of errors
* @access public
* @static
* the form with a customized title for the main Submit
*
* @param string $title title of the main button
- * @param string $type button type for the form after processing
+ * @param string $nextType
+ * @param string $backType
+ * @param bool $submitOnce
+ *
+ * @internal param string $type button type for the form after processing
*
* @return void
* @access public
/**
* Get user context.
*
+ * @param null $mode
+ *
* @return string user context.
*/
function userContext($mode = NULL) {
* @access public
* @static
*
- * @param boolean $name pseudoconstant to be flushed
- *
+ * @param bool|string $name pseudoconstant to be flushed
*/
public static function flush($name = 'cache') {
if (isset(self::$$name)) {
* - View
* - Edit
*
+ * @param string $status
+ * @param null $isPaymentProcessor
+ * @param null $accessContribution
+ * @param null $qfKey
+ * @param null $context
+ * @param bool $isCancelSupported
+ *
* @return array
* @access public
- *
*/
static
function &links($status = 'all',
/**
* getter for array of the parameters required for creating pager.
*
- * @param
+ * @param $action
+ * @param $params
+ * @internal param $
* @access public
*/
function getPagerParams($action, &$params) {
*
* @param array $fields posted values of the form
*
+ * @param $files
+ * @param $form
+ *
* @return array list of errors to be posted back to the form
* @static
* @access public
* Browse all custom data groups.
*
*
+ * @param null $action
+ *
* @return void
* @access public
* @static
/**
* getter for array of the parameters required for creating pager.
*
- * @param
+ * @param $action
+ * @param $params
+ *
+ * @internal param $
* @access public
*/
function getPagerParams($action, &$params) {
/**
* Return a list of all forms which use this price set.
*
- * @param int $id id of price set
- * @param str $simpleReturn - get raw data. Possible values: 'entity', 'table'
+ * @param int $id id of price set
+ * @param bool|\str $simpleReturn - get raw data. Possible values: 'entity', 'table'
*
* @return array
*/
/**
* Return an item that could not be processed
*
- * @param $dao object The item returned by claimItem
+ * @param The $item
+ *
+ * @internal param object $dao The item returned by claimItem
*
* @return bool
*/
/**
* Get user context.
*
+ * @param null $mode
+ *
* @return string user context.
*/
function userContext($mode = NULL) {
/**
* Get user context.
*
+ * @param null $mode
+ *
* @return string user context.
*/
function userContext($mode = NULL) {
projects / civicrm-core.git / commitdiff