* scheme. Adding weight is super important and should be done in the
* next week or so, before this can be called complete.
*
- * @param NULL
+ * @param bool $status
+ *
+ * @internal param $NULL
*
* @return array array of importable Fields
* @access public
* @param int $contactId - contact whose activities we want to display
* @param int $permission - the permission we have for this contact
*
- * @return CRM_Contact_Selector_Activity
- * @access public
+ * @param bool $admin
+ * @param string $context
+ * @param null $activityTypeIDs
+ *
+ * @return \CRM_Activity_Selector_Activity
+ @access public
*/
function __construct($contactId,
$permission,
/**
* Class constructor
*
- * @param array $queryParams array of parameters for query
- * @param int $action - action of search basic or advanced.
- * @param string $activityClause if the caller wants to further restrict the search (used in activities)
+ * @param array $queryParams array of parameters for query
+ * @param \const|int $action - action of search basic or advanced.
+ * @param string $activityClause if the caller wants to further restrict the search (used in activities)
* @param boolean $single are we dealing only with one contact?
- * @param int $limit how many activities do we want returned
+ * @param int $limit how many activities do we want returned
*
- * @return CRM_Contact_Selector
- * @access public
+ * @param string $context
+ * @param null $compContext
+ *
+ * @return \CRM_Activity_Selector_Search
+ @access public
*/
function __construct(&$queryParams,
$action = CRM_Core_Action::NONE,
$assigneeID = CRM_Utils_Array::key('Activity Assignees', $activityContacts);
$targetID = CRM_Utils_Array::key('Activity Targets', $activityContacts);
//get all activity types
- $activityTypes = CRM_Core_PseudoConstant::activityType(TRUE, TRUE, FALSE, 'name', TRUE);
+ $activityTypes = CRM_Core_PseudoConstant::activityType(TRUE, TRUE, FALSE, 'name', TRUE);
while ($result->fetch()) {
$row = array();
/**
* Function to build the form
*
+ * @param bool $check
+ *
* @return void
* @access public
*/
/**
* Get user context.
*
+ * @param null $mode
+ *
* @return string user context.
*/
function userContext($mode = NULL) {
/**
* Browse all jobs.
*
+ * @param null $action
+ *
* @return void
* @access public
* @static
/**
* Browse all Label Format settings.
*
+ * @param null $action
+ *
* @return void
* @access public
* @static
/**
* 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) {
/**
* 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) {
/**
* Get user context.
*
+ * @param null $mode
+ *
* @return string user context.
*/
function userContext($mode = NULL) {
/**
* Browse all PDF Page Formats
*
+ * @param null $action
+ *
* @return void
* @access public
* @static
/**
* Get user context.
*
+ * @param null $mode
+ *
* @return string user context.
*/
function userContext($mode = NULL) {
/**
* function to build badges parameters before actually creating badges.
*
- * @param array $params associated array of submitted values
+ * @param array $params associated array of submitted values
+ * @param $form
* @params object $form form/controller object
*
* @return void
/**
* if survey, campaign are involved, add the specific fields.
*
+ * @param $query
+ *
* @return void
* @access public
*/
/**
* Check and update the survey respondents.
*
+ * @param $params
+ *
* @return array success message
*/
public function releaseRespondent($params) {
*
* @access public
*
+ * @param string $returnColumn
+ *
* @return array - array reference of all survey activity types.
* @static
*/
/**
* Class constructor
*
- * @param array $queryParams array of parameters for query
- * @param int $action - action of search basic or advanced.
- * @param string $surveyClause if the caller wants to further restrict the search.
- * @param boolean $single are we dealing only with one contact?
- * @param int $limit how many voters do we want returned
+ * @param array $queryParams array of parameters for query
+ * @param \const|int $action - action of search basic or advanced.
+ * @param string $surveyClause if the caller wants to further restrict the search.
+ * @param boolean $single are we dealing only with one contact?
+ * @param int $limit how many voters do we want returned
*
- * @return CRM_Contact_Selector
- * @access public
- */ function __construct(&$queryParams,
+ * @param string $context
+ *
+ * @return \CRM_Campaign_Selector_Search
+ @access public
+ */
+ function __construct(&$queryParams,
$action = CRM_Core_Action::NONE,
$surveyClause = NULL,
$single = FALSE,
*
* @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
*
* @access public
*
+ * @param $form
+ * @param $params
+ * @param $activity
+ *
* @return void
*/
static function endPostProcess(&$form, &$params, $activity) {
*
* @access public
*
+ * @param $form
+ * @param $params
+ *
* @return void
*/
static function beginPostProcess(&$form, &$params) {}
*
* @access public
*
+ * @param $form
+ *
* @return void
*/
static function setDefaultValues(&$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
/**
* Class constructor
*
- * @param array $queryParams array of parameters for query
- * @param int $action - action of search basic or advanced.
- * @param string $additionalClause 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 $additionalClause 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 signers do we want returned
+ * @param int $limit how many signers do we want returned
*
- * @return CRM_Contact_Selector
- * @access public
- */ function __construct(&$queryParams,
+ * @param string $context
+ *
+ * @return \CRM_Case_Selector_Search
+ @access public
+ */
+ function __construct(&$queryParams,
$action = CRM_Core_Action::NONE,
$additionalClause = NULL,
$single = FALSE,
*
* @param int $id - id of the contact whose contact sub type is needed
*
+ * @param null $implodeDelimiter
+ *
* @return string contact_sub_type if $id found else null ""
*
* @access public
*
* @static
- *
*/
public static function getContactSubType($id, $implodeDelimiter = NULL) {
$subtype = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $id, 'contact_sub_type');
* The ordering is important, since currently we do not have a weight
* scheme. Adding weight is super important
*
- * @param int $contactType contact Type
- * @param boolean $status status is used to manipulate first title
- * @param boolean $showAll if true returns all fields (includes disabled fields)
- * @param boolean $isProfile if its profile mode
+ * @param int|string $contactType contact Type
+ * @param boolean $status status is used to manipulate first title
+ * @param boolean $showAll if true returns all fields (includes disabled fields)
+ * @param boolean $isProfile if its profile mode
* @param boolean $checkPermission if false, do not include permissioning clause (for custom data)
*
+ * @param bool $withMultiCustomFields
+ *
* @return array array of importable Fields
* @access public
* @static
/**
* fill the acl contact cache for this contact id if empty
*
- * @param int $id contact id
- * @param string $type the type of operation (view|edit)
- * @param boolean $force should we force a recompute
+ * @param $userID
+ * @param int|string $type the type of operation (view|edit)
+ * @param boolean $force should we force a recompute
*
+ * @internal param int $id contact id
* @return void
* @access public
* @static
*
*function to retrieve basic contact type information.
*
- *@return array of basic contact types information.
- *@static
+ * @param bool $all
*
+ * @return array of basic contact types information.
+ * @static
*/
static function &basicTypeInfo($all = FALSE) {
static $_cache = NULL;
* identified by $groupId; does not delete child group, just the
* association between the two
*
- * @param $parentID The id of the group to remove the child from
* @param $childID The id of the child group being removed
*
+ * @internal param \The $parentID id of the group to remove the child from
* @return void
*
* @access public
* @param $contactId Int contact id
* @param $params array array of values submitted by POST
* @param $ids array array of ids
- * @param $action which action called this function
+ * @param \const|\which $action which action called this function
*
- * @static
+ * @param bool $active
*
+ * @static
*/
static function relatedMemberships($contactId, &$params, $ids, $action = CRM_Core_Action::ADD, $active = TRUE) {
// Check the end date and set the status of the relationship
/**
* check for correct state / country mapping.
*
- * @param array reference $fields - submitted form values.
- * @param array reference $errors - if any errors found add to this array. please.
+ * @param $fields
+ * @param $files
+ * @param $self
+ *
+ * @internal param \reference $array $fields - submitted form values.
+ * @internal param \reference $array $errors - if any errors found add to this array. please.
*
* @return true if no errors
* array of errors if any present.
/**
* Ensure that oplock_ts hasn't changed in the underlying DB
*
- * @param array $fields the input form values
- * @param array $files the uploaded files if any
- * @param array $options additional user data
+ * @param array $fields the input form values
+ * @param array $files the uploaded files if any
+ * @param null $contactID
+ *
+ * @internal param array $options additional user data
*
* @return true if no errors, else array of errors
* @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 $form
+ *
+ * @internal param array $options additional user data
*
* @return true if no errors, else array of errors
* @access public
*
* @access public
*
+ * @param $form
+ *
* @return void
*/
static function buildQuickForm(&$form) {
* format custom field name.
* combine group and field name to avoid conflict.
*
+ * @param $fields
+ *
* @return void
* @access public
*/
/**
* Cancel Recurring contribution.
*
- * @param integer $recurId recur contribution id.
- * @param array $objects an array of objects that is to be cancelled like
+ * @param integer $recurId recur contribution id.
+ * @param array $objects an array of objects that is to be cancelled like
* contribution, membership, event. At least contribution object is a must.
*
+ * @param array $activityParams
+ *
* @return true / false.
* @access public
* @static
/**
* Function to retrieve soft contributions for contribution record.
- * @param array $params an associated array
- * @param boolean $all include PCP data
*
- * @return array of soft contribution ids, amounts, and associated contact ids
- * @static
+ * @param $contributionID
+ * @param boolean $all include PCP data
+ *
+ * @internal param array $params an associated array
+ * @return array of soft contribution ids, amounts, and associated contact ids
+ * @static
*/
static function getSoftContribution($contributionID, $all = FALSE) {
$pcpFields = array(
/**
* Function to retrieve the list of soft contributions for given contact.
- * @param int $contact_id contact id
*
- * @return array
- * @static
+ * @param int $contact_id contact id
+ *
+ * @param int $isTest
+ *
+ * @return array
+ * @static
*/
static function getSoftContributionList($contact_id, $isTest = 0) {
$query = '
/**
* if contributions are involved, add the specific contribute fields
*
+ * @param $query
+ *
* @return void
* @access public
*/
*
* @access public
*
+ * @param $form
+ *
* @return void
*/
static function buildPremium(&$form) {
/**
* Function to set variables up before form is built
*
+ * @param $form
+ *
* @return void
* @access public
*/
*
* @param array $values posted values of the form
*
+ * @param $files
+ * @param $self
+ *
* @return array list of errors to be posted back to the form
* @static
* @access public
if (! CRM_Core_BAO_UFField::checkValidProfileType($id, $required, $optional)
&& ! CRM_Core_BAO_UFGroup::checkValidProfile($id, $requiredProfileFields) ) {
$errors['onbehalf_profile_id'] = ts('Profile does not contain the minimum required fields for an On Behalf Of Organization');
- }
+ }
}
}
*
* @param array $params (ref.) an assoc array of name/value pairs
*
+ * @param $files
+ *
* @return mixed true or array of errors
* @access public
* @static
/**
* Function to set variables up before form is built
*
+ * @param $form
+ *
* @return void
* @access static
*/
/**
* Get user context.
*
+ * @param null $mode
+ *
* @return string user context.
*/
function userContext($mode = NULL) {
* Get all the financial Accounts
*
* @access public
+ *
+ * @param null $id
+ * @param null $financialAccountTypeId
+ * @param string $retrieveColumn
+ * @param string $key
+ *
* @return array - array reference of all financial accounts if any
* @static
*/
*
* @param int $permission
*
+ * @param bool $softCreditFiltering
+ *
* @return array set of tasks that are valid for the user
* @access public
*/
*
* @params array $params associated array of civicrm variables
*
+ * @param $params
+ *
* @return null
* @static
*/
*
* @params array $params associated array of civicrm variables
*
+ * @param $params
+ *
* @return null
* @static
*/
*
* @param string $entityType - of the contact whose contact type is needed
* @param object $form - not used but required
- * @param int $entityId - optional - id of entity if we need to populate the tree with custom values.
- * @param int $groupId - optional group id (if we need it for a single group only)
- * - if groupId is 0 it gets for inline groups only
- * - if groupId is -1 we get for all groups
+ * @param null $entityID
+ * @param null $groupID
* @param string $subType
* @param string $subName
* @param boolean $fromCache
*
+ * @param null $onlySubType
+ *
+ * @internal param int $entityId - optional - id of entity if we need to populate the tree with custom values.
+ * @internal param int $groupId - optional group id (if we need it for a single group only)
+ * - if groupId is 0 it gets for inline groups only
+ * - if groupId is -1 we get for all groups
* @return array $groupTree - array The returned array is keyed by group id and has the custom group table fields
* and a subkey 'fields' holding the specific custom fields.
* If entityId is passed in the fields keys have a subkey 'customValue' which holds custom data
* @access public
*
* @static
- *
*/
public static function &getTree(
$entityType,
*
* An array containing custom group details (including their custom field) is returned.
*
- * @param int $groupId - group id whose details are needed
+ * @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 array $extends - which table does it extend if any
+ *
+ * @param null $inSelector
*
* @return array $groupTree - array consisting of all group and field details
*
* @access public
*
* @static
- *
*/
public static function &getGroupDetail($groupId = NULL, $searchable = NULL, &$extends = NULL, $inSelector = NULL) {
// create a new tree
*
* @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)
*
/**
* Determine in which discount set the registration date falls
*
- * @param integer $entityId entity id to be searched
- * @param string $entityTable entity table to be searched
+ * @param $entityID
+ * @param string $entityTable entity table to be searched
*
+ * @internal param int $entityId entity id to be searched
* @return integer $dao->id discount id of the set which matches
* the date criteria
*/
*
* @param int $id the contact id
*
+ * @param bool $updateBlankLocInfo
+ *
* @return array the array of email id's
* @access public
* @static
*
* @params array $params (reference ) an assoc array of name/value pairs
*
+ * @param $params
+ *
* @return boolean
* @access public
* @static
* 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 $contactId contact id
+ * @param $entityTable
+ * @param $entityID
+ *
+ * @internal param array $contactId contact id
*
* @return void
* @access public
* 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 string $orderBy to get single trxn id for a entity table i.e last or first.
+ * @param $entity_id
+ * @param string $orderBy to get single trxn id for a entity table i.e last or first.
*
+ * @param bool $newTrxn
+ *
+ * @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.
*
* @access public
* Function to add a Location Type
*
* @param array $params reference array contains the values submitted by the form
- * @param array $ids reference array contains the id
+ *
+ * @internal param array $ids reference array contains the id
*
* @access public
* @static
/**
* Function to get log record count for a Contact
*
- * @param int $contactId Contact ID
+ * @param $contactID
+ *
+ * @internal param int $contactId Contact ID
*
* @return int count of log records
* @access public
* @access public
* @static
*
+ * @param bool $all
+ *
* @return object
*/
static function getMessageTemplates($all = TRUE) {
/**
* Function to delete Option Value
*
- * @param int $optionGroupId Id of the Option Group to be deleted.
+ * @param $optionValueId
+ *
+ * @internal param int $optionGroupId Id of the Option Group to be deleted.
*
* @return boolean
*
*
* @param int $id the contact id
*
+ * @param bool $updateBlankLocInfo
+ * @param null $type
+ * @param array $filters
+ *
* @return array the array of phone ids which are potential numbers
* @access public
* @static
* Store multiple items in the setting table
*
* @param array $params (required) An api formatted array of keys and values
+ * @param null $domains
+ * @param $settingsToReturn
+ *
* @domains array an array of domains to get settings for. Default is the current domain
* @return void
* @static
* Determine what, if any, overrides have been provided
* for a setting.
*
+ * @param $group
+ * @param $name
+ * @param $default
+ *
* @return mixed, NULL or an overriden value
*/
protected static function getOverride($group, $name, $default) {
* 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 $params
+ * @param $values
+ *
+ * @internal param \entityBlock $array input parameters to find object
*
* @return boolean
* @access public
/**
* Create a new WordReplacement
*
+ * @param $params
+ *
* @return WordReplacement array
* @access public
*/
* php is lame and u cannot call functions from static initializers
* hence this hack
*
+ * @param $id
+ *
* @return void
* @access private
*/
*
* NOTE: if using conditionally permission return,
* implementation of $getAllUnconditionally is required.
+ *
+ * @param bool $getAllUnconditionally
+ *
* @return array|null collection of permissions, null if none
* @access public
- *
*/
abstract public function getPermissions($getAllUnconditionally = FALSE);
/**
* Function to set the default values
*
- * @param array $defaults associated array of form elements
- * @param boolena $formMode this funtion is called to set default
+ * @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
* mode (eg: Global setting >> Components)
* of time. This is the inverse function of create. It also stores all the retrieved
* values in the default array
*
- * @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 string $fieldIdName
+ * @param $fieldId
+ * @param $details
+ * @param array $returnProperities an assoc array of fields that need to be returned, eg array( 'first_name', 'last_name')
+ *
+ * @internal param array $params (reference ) an assoc array of name/value pairs
+ * @internal param array $defaults (reference ) an assoc array to hold the flattened values
* @return object an object of type referenced by daoName
* @access public
* @static
/**
* singleton function used to manage this object.
*
+ * @param null $package
+ * @param bool $msgCallback
+ * @param bool $contextCallback
+ * @param bool $throwPEAR_Error
+ * @param string $stackClass
+ *
* @return object
* @static
*/
* 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 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 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
*
- * @return object
- * @access public
+ * @return \CRM_Core_Form
+ @access public
*/
function __construct(
$state = NULL,
* Load objects related to contribution
*
* @input array information from Payment processor
+ *
+ * @param $input
* @param array $ids
* @param array $objects
* @param boolean $required
* @param integer $paymentProcessorID
* @param array $error_handling
+ *
* @return multitype:number NULL |boolean
*/
function loadObjects(&$input, &$ids, &$objects, $required, $paymentProcessorID, $error_handling = NULL) {
*
* @param string $mode the mode of operation: live or test
*
+ * @param object $paymentProcessor
+ * @param null $paymentForm
+ * @param bool $force
+ *
* @return object
* @static
- *
*/
static function &singleton($mode, &$paymentProcessor, &$paymentForm = NULL, $force = FALSE) {
$processorName = $paymentProcessor['name'];
*
* @param string $mode the mode of operation: live or test
*
+ * @param object $paymentProcessor
+ *
* @return object
* @static
- *
*/
static function &singleton($mode, &$paymentProcessor) {
$processorName = $paymentProcessor['name'];
/**
* create all fields needed for a credit card transaction
*
+ * @param $form
+ *
* @return void
* @access public
*/
/**
* The function gets called when a new order takes place.
*
- * @param xml $dataRoot response send by google in xml format
+ * @param xml $dataRoot response send by google in xml format
* @param array $privateData contains the name value pair of <merchant-private-data>
*
- * @return void
+ * @param $component
*
+ * @return void
*/
function newOrderNotify($dataRoot, $privateData, $component) {
$ids = $input = $params = array();
*
* @param string $mode the mode of operation: live or test
*
+ * @param object $paymentProcessor
+ * @param null $paymentForm
+ * @param bool $force
+ *
* @return object
* @static
- *
*/
static function &singleton($mode, &$paymentProcessor, &$paymentForm = NULL, $force = false) {
$processorName = $paymentProcessor['name'];
*
* @param string $mode the mode of operation: live or test
*
+ * @param object $paymentProcessor
+ * @param null $paymentForm
+ * @param bool $force
+ *
* @return object
* @static
- *
*/
static function &singleton($mode = 'test', &$paymentProcessor, &$paymentForm = NULL, $force = FALSE) {
$processorName = $paymentProcessor['name'];
*
* @param string $mode the mode of operation: live or test
*
+ * @param $paymentProcessor
+ * @param null $paymentForm
+ * @param bool $force
+ *
* @return object
* @static
*/
/**
* The function gets called when a new order takes place.
*
- * @param xml $dataRoot response send by google in xml format
+ * @param $success
* @param array $privateData contains the name value pair of <merchant-private-data>
*
- * @return void
+ * @param $component
+ * @param $amount
+ * @param $transactionReference
*
+ * @internal param \xml $dataRoot response send by google in xml format
+ * @return void
*/
function newOrderNotify($success, $privateData, $component, $amount, $transactionReference) {
$ids = $input = $params = array();
*
* @param string $mode the mode of operation: live or test
*
- * @return void
- **********************************************************/
+ * @param $paymentProcessor
+ *
+ * @return \CRM_Core_Payment_eWAY *******************************************************
+ */
function __construct($mode, &$paymentProcessor) {
// require Standaard eWAY API libraries
require_once 'eWAY/eWAY_GatewayRequest.php';
*
* @param string $mode the mode of operation: live or test
*
+ * @param object $paymentProcessor
+ * @param null $paymentForm
+ * @param bool $force
+ *
* @return object
* @static
- *
*/
static function &singleton($mode, &$paymentProcessor, &$paymentForm = NULL, $force = false) {
$processorName = $paymentProcessor['name'];
* @access public
* @static
*
- * @param int $id - Optional id to return
+ * @param bool|int $id - Optional id to return
*
- * @return array - array reference of all countries.
+ * @param bool $applyLimit
*
+ * @return array - array reference of all countries.
*/
public static function country($id = FALSE, $applyLimit = TRUE) {
if (($id && !CRM_Utils_Array::value($id, self::$country)) || !self::$country || !$id) {
* @access public
* @static
*
- * @return mixed - instance of CRM_Contact_BAO_GroupNesting
+ * @param bool $styledLabels
*
+ * @return mixed - instance of CRM_Contact_BAO_GroupNesting
*/
public static function &groupIterator($styledLabels = FALSE) {
if (!self::$groupIterator) {
*
* Note: any database errors will be trapped by the DAO.
*
- * @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 = NULL, $excludeHidden = TRUE) {
return CRM_Core_Permission::group($groupType, $excludeHidden);
* @access public
* @static
*
- * @return array - array reference of all groups.
+ * @param bool $onlyPublic
+ * @param null $groupType
+ * @param bool $excludeHidden
*
+ * @return array - array reference of all groups.
*/
public static function &staticGroup($onlyPublic = FALSE, $groupType = NULL, $excludeHidden = TRUE) {
if (!self::$staticGroup) {
* render the page using a custom templating
* system
*
- * @param object $page the CRM_Core_Form page
- * @param boolean $ret should we echo or return output
+ * @param object $page the CRM_Core_Form page
+ *
+ * @internal param bool $ret should we echo or return output
*
* @return void
* @access public
* Construct a resource manager
*
* @param CRM_Extension_Mapper $extMapper Map extension names to their base path or URLs.
+ * @param $cache
+ * @param null $cacheCodeKey
*/
public function __construct($extMapper, $cache, $cacheCodeKey = NULL) {
$this->extMapper = $extMapper;
*/
function addLocalization(&$js) {
$config = CRM_Core_Config::singleton();
-
+
// Localize select2 strings
$contactSearch = json_encode($config->includeEmailInName ? ts('Start typing a name or email...') : ts('Start typing a name...'));
$otherSearch = json_encode(ts('Enter search term...'));
*
* @access public
*
+ * @param int $all
+ *
* @return void
*/
function reset($all = 1) {
*
* @param object $controller the controller for this state machine
*
- * @return object
- * @access public
+ * @param const $action
+ *
+ * @return \CRM_Core_StateMachine
+ @access public
*/
function __construct(&$controller, $action = CRM_Core_Action::NONE) {
$this->_controller = &$controller;
/**
* 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
* Function to delete the location block associated with an event,
* if not being used by any other event.
*
- * @param int $loc_block_id location block id to be deleted
- * @param int $eventid event id with which loc block is associated
+ * @param $locBlockId
+ * @param null $eventId
+ *
+ * @internal param int $loc_block_id location block id to be deleted
+ * @internal param int $eventid event id with which loc block is associated
*
* @access public
* @static
- *
*/
static function deleteEventLocBlock($locBlockId, $eventId = NULL) {
$query = "SELECT count(ce.id) FROM civicrm_event ce WHERE ce.loc_block_id = $locBlockId";
/**
* Process that send e-mails
*
+ * @param $contactID
+ * @param $values
+ * @param $participantId
+ * @param bool $isTest
+ * @param bool $returnMessageText
+ *
* @return void
* @access public
*/
* Function to add the custom fields OR array of participant's
* profile info
*
+ * @param $id
+ * @param $name
+ * @param $cid
+ * @param $template
+ * @param $participantId
+ * @param $isTest
+ * @param bool $isCustomProfile
+ * @param array $participantParams
+ *
* @return void
* @access public
*/
*
* @access public
*
+ * @param $form
+ *
* @return void
*/
static function setDefaultValues(&$form) {
/**
* Process the participant
*
+ * @param $params
+ * @param $contactID
+ *
* @return void
* @access public
*/
/**
* Process the contribution
*
+ * @param $form
+ * @param $params
+ * @param $result
+ * @param $contactID
+ * @param bool $pending
+ * @param bool $isAdditionalAmount
+ *
* @return void
* @access public
*/
/**
* Fix the Location Fields
*
+ * @param $params
+ * @param $fields
+ * @param $form
+ *
* @return void
* @access public
*/
/**
* function to update contact fields
*
+ * @param $contactID
+ * @param $params
+ * @param $fields
+ * @param $form
+ *
* @return void
* @access public
*/
*
* @param CRM_Core_Session $store
*
+ * @param int $mode
+ *
* @return void
* @access public
*/
/**
* Get tab Links for events
*
+ * @param $enableCart
+ *
* @return array (reference) of tab links
*/
static function &tabs($enableCart) {
$manageEvent[$dao->id]['reminder'] = CRM_Core_BAO_ActionSchedule::isConfigured($dao->id, $mappingID);
$manageEvent[$dao->id]['is_pcp_enabled'] = CRM_Utils_Array::value($dao->id, $eventPCPS);
$manageEvent[$dao->id]['event_type'] = CRM_Utils_Array::value($manageEvent[$dao->id]['event_type_id'], $eventType);
-
+
// allow hooks to set 'field' value which allows configuration pop-up to show a tab as enabled/disabled
CRM_Utils_Hook::tabset('civicrm/event/manage/rows', $manageEvent, array('event_id' => $dao->id));
}
*
* @param array $fields posted values of the form
*
+ * @param $values
+ * @param $mappingTypeId
+ *
* @return array list of errors to be posted back to the form
* @static
* @access public
/**
* Scan $basedir for a list of extension-keys
*
- * @param string $dirSep the local system's directory separator
+ * @internal param string $dirSep the local system's directory separator
* @return array($key => $relUrl)
*/
protected function getRelUrls() {
/**
* Get the container which defines a particular key
*
+ * @param $key
+ *
+ * @throws CRM_Extension_Exception_MissingException
* @return CRM_Extension_Container_Interface
- * @throws CRM_Extension_Exception
*/
public function getContainer($key) {
$k2c = $this->getKeysToContainer();
/**
* Get user context.
*
+ * @param null $mode
+ *
* @return string user context.
*/
function userContext($mode = null) {
* CRM-12814
* Get opened 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 Opened count per mailing ID
* @access public
/**
* Connect to the supplied IMAP server and make sure the two mailboxes exist
*
- * @param string $host host to connect to
- * @param string $username authentication username
- * @param string $password authentication password
- * @param bool $ssl whether to use IMAP or IMAPS
- * @param string $folder name of the inbox folder
+ * @param string $host host to connect to
+ * @param string $username authentication username
+ * @param string $password authentication password
+ * @param bool $ssl whether to use IMAP or IMAPS
+ * @param string $folder name of the inbox folder
*
- * @return void
+ * @return \CRM_Mailing_MailStore_Imap
*/
function __construct($host, $username, $password, $ssl = TRUE, $folder = 'INBOX') {
// default to INBOX if an empty string
/**
* Connect to the supplied dir and make sure the two mail dirs exist
*
- * @param string $dir dir to operate upon
+ * @param string $dir dir to operate upon
*
- * @return void
+ * @return \CRM_Mailing_MailStore_Localdir
*/
function __construct($dir) {
$this->_dir = $dir;
/**
* Connect to the supplied dir and make sure the two mail dirs exist
*
- * @param string $dir dir to operate upon
+ * @param string $dir dir to operate upon
*
- * @return void
+ * @return \CRM_Mailing_MailStore_Maildir
*/
function __construct($dir) {
$this->_dir = $dir;
/**
* Connect to and lock the supplied file and make sure the two mail dirs exist
*
- * @param string $file mbox to operate upon
+ * @param string $file mbox to operate upon
*
- * @return void
+ * @return \CRM_Mailing_MailStore_Mbox
*/
function __construct($file) {
$this->_transport = new ezcMailMboxTransport($file);
/**
* Connect to the supplied POP3 server and make sure the two mail dirs exist
*
- * @param string $host host to connect to
- * @param string $username authentication username
- * @param string $password authentication password
- * @param bool $ssl whether to use POP3 or POP3S
+ * @param string $host host to connect to
+ * @param string $username authentication username
+ * @param string $password authentication password
+ * @param bool $ssl whether to use POP3 or POP3S
*
- * @return void
+ * @return \CRM_Mailing_MailStore_Pop3
*/
function __construct($host, $username, $password, $ssl = TRUE) {
if ($this->_debug) {
/**
* 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) {
}
}
- if (in_array($row['status'], array('Complete', 'Canceled')) &&
+ if (in_array($row['status'], array('Complete', 'Canceled')) &&
!$row['archived']) {
if ($allAccess || $showCreateLinks) {
$actionMask |= CRM_Core_Action::RENEW;
/**
* getter for array of the parameters required for creating pager.
*
- * @param
+ * @param $action
+ * @param $params
+ *
+ * @internal param $
* @access public
*/
function getPagerParams($action, &$params) {
$row['action'] = CRM_Core_Action::formLink(
self::links($qfKey, $this->_context),
- $mask,
+ $mask,
$actions,
ts('more'),
FALSE,
function getExportFileName($output = 'csv') {
return ts('CiviCRM Mailing Search');
}
-}
\ No newline at end of file
+}
/**
* Function to return PCP Block info for dashboard
*
+ * @param $contactId
+ *
* @return array array of Pcp if found
* @access public
* @static
/**
* Function to get email is enabled for supporter's profile
*
- * @param int $id supporter's profile id
+ * @param $profileId
+ *
+ * @internal param int $id supporter's profile id
*
* @return boolean
* @access public
* @static
- *
*/
static function checkEmailProfile($profileId) {
$query = "
/**
* Function to obtain the title of page associated with a pcp
*
- * @param int $id campaign page id
+ * @param $pcpId
+ * @param $component
+ *
+ * @internal param int $id campaign page id
*
* @return int
* @access public
* @static
- *
*/
static function getPcpPageTitle($pcpId, $component) {
if ($component == 'contribute') {
/**
* Function to get pcp block & entity id given pcp id
*
- * @param int $id campaign page id
+ * @param $pcpId
+ * @param $component
+ *
+ * @internal param int $id campaign page id
*
* @return String
* @access public
* @static
- *
*/
static function getPcpBlockEntityId($pcpId, $component) {
$entity_table = self::getPcpEntityTable($component);
/**
* 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
*
* @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
*
* @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
* 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 $entityId int participant/contribution id
* @param $entity string participant/contribution.
*
+ * @param null $isQuick
+ * @param bool $isQtyZero
+ *
* @return array of line items
*/
static function getLineItems($entityId, $entity = 'participant', $isQuick = NULL , $isQtyZero = TRUE) {
/**
* Function to process price set and line items.
- * @param int $contributionId contribution id
+ *
+ * @param $entityId
* @param array $lineItem line item array
* @param object $contributionDetails
- * @param decimal $initAmount amount
* @param string $entityTable entity table
*
+ * @param bool $update
+ *
+ * @internal param int $contributionId contribution id
+ * @internal param \decimal $initAmount amount
* @access public
* @return void
* @static
* @param int $fieldId price_field_id
* @param array $values (reference ) to hold the values
* @param string $orderBy for order by, default weight
- * @param int $isActive is_active, default false
+ * @param bool|int $isActive is_active, default false
*
* @return array $values
*
/**
* Function to build the price set form.
*
+ * @param $form
+ *
* @return void
* @access public
*/
/**
* Get the next item
*
- * @param $leaseTime seconds
+ * @param int|\seconds $leaseTime seconds
*
* @return object with key 'data' that matches the inputted data
*/
/**
* Delete the instance of the Report
*
- * @return $results no of deleted Instance on success, false otherwise
- * @access public
+ * @param null $id
*
+ * @return mixed $results no of deleted Instance on success, false otherwise@access public
*/
static function del($id = NULL) {
$dao = new CRM_Report_DAO_ReportInstance();
/**
* Constructor
*
- * @param array $config an array of configuration params
- * @return void
+ * @param array $config an array of configuration params
+ *
+ * @return \CRM_Utils_Cache_Memcached
*/
function __construct($config) {
if (isset($config['host'])) {
<?php
/**
- * Test Generated example of using survey_respondant get API
+ * Test Generated example of using survey_respondent get API
* *
*/
function survey_respondant_get_example(){
/**
* Construct a full SQL query which returns one page worth of results
*
+ * @param int $offset
+ * @param int $rowcount
+ * @param null $sort
+ * @param bool $includeContactIDs
+ *
* @return string, sql
*/
function all($offset = 0, $rowcount = 0, $sort = NULL, $includeContactIDs = FALSE) {
projects / civicrm-core.git / commitdiff