/**
* Retrieve assignee_id by activity_id
*
- * @param int $id ID of the activity
+ * @param $activity_id
+ *
+ * @internal param int $id ID of the activity
*
* @return void
*
* @access public
- *
*/
static function retrieveAssigneeIdsByActivityId($activity_id) {
$assigneeArray = array();
/**
* function to retrieve names of contact by activity_id
*
- * @param int $id ID of the activity
- * @param string $type type of interaction
+ * @param $activityID
+ * @param $recordTypeID
+ * @param bool $alsoIDs
+ *
+ * @internal param int $id ID of the activity
+ * @internal param string $type type of interaction
*
* @return array
*
* @access public
- *
*/
static function getNames($activityID, $recordTypeID, $alsoIDs = FALSE) {
$names = array();
/**
* function to retrieve id of target contact by activity_id
*
- * @param int $id ID of the activity
+ * @param $activity_id
+ *
+ * @internal param int $id ID of the activity
*
* @return mixed
*
* @access public
- *
*/
static function retrieveTargetIdsByActivityId($activity_id) {
$targetArray = array();
*
* @param CRM_Core_Controller $controller the controller object
*
+ * @param string $formName
+ *
* @return string the name of the form that will handle the task
* @access protected
*/
/**
* 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) {
/**
* Confirm email verification
*
- * @param int $contact_id The id of the contact
- * @param int $subscribe_id The id of the subscription event
- * @param string $hash The hash
+ * @param int $contact_id The id of the contact
+ * @param int $subscribe_id The id of the subscription event
+ * @param string $hash The hash
+ *
+ * @param $activity_id
+ * @param $petition_id
*
* @return boolean True on success
* @access public
*
* @access public
*
+ * @param $form
+ * @param $params
+ *
* @return void
*/
static function beginPostProcess(&$form, &$params) {
*
* @access public
*
+ * @param $form
+ * @param $params
+ *
* @return void
*/
static function beginPostProcess(&$form, &$params) {
*
* @access public
*
+ * @param $form
+ * @param $params
+ * @param $activity
+ *
* @return void
*/
static function endPostProcess(&$form, &$params, &$activity) {
/**
* function to get the sms number and display name of a contact
*
- * @param int $id id of the contact
+ * @param int $id id of the contact
+ *
+ * @param null $type
*
* @return array tuple of display_name and sms if found, or (null,null)
* @static
* Given the list of params in the params array, fetch the object
* and store the values in the values array
*
- * @param array $params input parameters to find object
- * @param array $values output values of the object
- * @param array $ids the array that holds all the db ids
+ * @param array $params input parameters to find object
+ * @param array $values output values of the object
+ *
+ * @internal param array $ids the array that holds all the db ids
*
* @return array (reference) the values that could be potentially assigned to smarty
* @access public
/**
* Method to check group organization relationship exist
*
- * @param int $contactId
+ * @param $contactID
+ *
+ * @internal param int $contactId
*
* @return boolean
* @access public
/**
* class constructor
*
- * @return object CRM_Contact_BAO_SavedSearch
+ * @return \CRM_Contact_BAO_SavedSearch CRM_Contact_BAO_SavedSearch
*/
function __construct() {
parent::__construct();
* This function provides the HTML form elements
*
* @param object $form form object
- * @param int $inlineEditMode ( 1 for contact summary
+ *
+ * @internal param int $inlineEditMode ( 1 for contact summary
* top bar form and 2 for display name edit )
*
* @access public
/**
* Ensure that modified_date 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 validation rules for the form
*
- * @param array $fields posted values of the form
- * @param array $errors list of errors to be posted back to the form
+ * @param array $fields posted values of the form
+ * @param array $errors list of errors to be posted back to the form
*
- * @return $errors
- * @static
+ * @return array $errors@static
* @access public
*/
static function formRule($fields, $errors) {
/**
* global validation rules for the form
*
- * @param array $fields posted values of the form
- * @param array $errors list of errors to be posted back to the form
+ * @param array $fields posted values of the form
+ * @param array $errors list of errors to be posted back to the form
*
- * @return $errors
- * @static
+ * @return array $errors@static
* @access public
*/
static function formRule($fields, $errors) {
* This function provides the HTML form elements
*
* @param object $form form object
- * @param int $inlineEditMode ( 1 for contact summary
+ * @param $contactID
+ *
+ * @internal param int $inlineEditMode ( 1 for contact summary
* top bar form and 2 for display name edit )
*
* @access public
/**
* global validation rules for the form
*
- * @param array $fields posted values of the form
- * @param array $errors list of errors to be posted back to the form
+ * @param array $fields posted values of the form
+ * @param array $errors list of errors to be posted back to the form
*
- * @return $errors
- * @static
+ * @return array $errors@static
* @access public
*/
static function formRule($fields, $errors) {
/**
* global validation rules for the form
*
- * @param array $fields posted values of the form
- * @param array $errors list of errors to be posted back to the form
+ * @param array $fields posted values of the form
+ * @param array $errors list of errors to be posted back to the form
*
- * @return $errors
- * @static
+ * @return array $errors@static
* @access public
*/
static function formRule($fields, $errors) {
/**
* Function to build the form
*
+ * @param $form
+ *
* @return void
* @access public
*/
/**
* function to get the rows for the labels
*
- * @param array $contactIds Contact IDS to do labels for
+ * @param $contactIDs
* @param integer $locationTypeID
* @param boolean $respectDoNotMail
+ * @param $mergeSameAddress
+ * @param $mergeSameHousehold
+ *
+ * @internal param array $contactIds Contact IDS to do labels for
* @return array of rows for labels
* @access public
*/
/**
* build all the data structures needed to build the form
*
+ * @param $form
+ *
* @return void
* @access public
*/
*
* @access public
*
+ * @param $form
+ * @param $proxSearch
+ *
* @return void
*/
function buildQuickForm($form, $proxSearch) {
*
* @access public
*
- * @param object $page - the view page which created this one
+ * @internal param object $page - the view page which created this one
*
* @return void
* @static
- *
*/
function run() {
$this->preProcess();
}
return parent::run();
}
-}
\ No newline at end of file
+}
/**
* Class constructor
*
+ * @param $customSearchClass
* @param array $formValues array of form values imported
- * @param array $params array of parameters for query
- * @param int $action - action of search basic or advanced.
+ * @param array $params array of parameters for query
+ * @param null $returnProperties
+ * @param \const|int $action - action of search basic or advanced.
*
- * @return CRM_Contact_Selector
- * @access public
+ * @param bool $includeContactIds
+ * @param bool $searchChildGroups
+ * @param string $searchContext
+ * @param null $contextMenu
+ *
+ * @return \CRM_Contact_Selector_Custom
+ @access public
*/
function __construct(
$customSearchClass,
/**
* Function to delete soft credits
*
- * @param int $contributionTypeId
+ * @param $params
+ *
+ * @internal param int $contributionTypeId
* @static
*/
static function del($params) {
*
* @access public
*
+ * @param $form
+ *
* @return void
*/
static function buildAdditionalDetail(&$form) {
* - Edit
* - Cancel
*
+ * @param bool $recurID
+ * @param string $context
+ *
* @return array
* @access public
- *
*/
static function &recurLinks($recurID = FALSE, $context = 'contribution') {
if (!(self::$_links)) {
/**
* class constructor
*
- * @param object CRM_Contact_Import_Controller
- * @param int $action
+ * @param object $controller
+ * @param \const|int $action
*
- * @return object CRM_Contact_Import_StateMachine
+ * @internal param \CRM_Contact_Import_Controller $object
+ * @return \CRM_Contribute_StateMachine_Contribution CRM_Contact_Import_StateMachine
*/
function __construct($controller, $action = CRM_Core_Action::NONE) {
parent::__construct($controller, $action);
/**
* class constructor
*
- * @param object CRM_Contribute_Controller_ContributionPage
- * @param int $action
+ * @param object $controller
+ * @param \const|int $action
*
- * @return object CRM_Contribute_StateMachine_ContributionPage
+ * @internal param \CRM_Contribute_Controller_ContributionPage $object
+ * @return \CRM_Contribute_StateMachine_ContributionPage CRM_Contribute_StateMachine_ContributionPage
*/
function __construct($controller, $action = CRM_Core_Action::NONE) {
parent::__construct($controller, $action);
*
* @param CRM_Core_Controller $controller the controller object
*
+ * @param string $formName
+ *
* @return string the name of the form that will handle the task
* @access protected
*/
/**
* Sets appropriate parameters for checking out to google
*
- * @param array $params name value pair of contribution datat
+ * @param array $params name value pair of contribution datat
+ *
+ * @param $component
*
* @return void
* @access public
- *
*/
function doTransferCheckout(&$params, $component) {
$component = strtolower($component);
/**
* Main transaction function
*
- * @param array $params name value pair of contribution data
+ * @param array $params name value pair of contribution data
+ *
+ * @param $component
*
* @return void
* @access public
- *
*/
function doTransferCheckout(&$params, $component) {
$component = strtolower($component);
/**
* Function to get the list the export fields
*
- * @param int $selectAll user preference while export
- * @param array $ids contact ids
- * @param array $params associated array of fields
+ * @param int $selectAll user preference while export
+ * @param array $ids contact ids
+ * @param array $params associated array of fields
* @param string $order order by clause
- * @param array $fields associated array of fields
- * @param array $moreReturnProperties additional return fields
- * @param int $exportMode export mode
+ * @param array $fields associated array of fields
+ * @param array $moreReturnProperties additional return fields
+ * @param int $exportMode export mode
* @param string $componentClause component clause
* @param string $componentTable component table
- * @param bool $mergeSameAddress merge records if they have same address
- * @param bool $mergeSameHousehold merge records if they belong to the same household
+ * @param bool $mergeSameAddress merge records if they have same address
+ * @param bool $mergeSameHousehold merge records if they belong to the same household
+ *
+ * @param array $exportParams
+ * @param string $queryOperator
*
* @static
* @access public
$componentReturnProperties = CRM_Contact_BAO_Query::defaultReturnProperties($queryMode);
if ($queryMode == CRM_Contact_BAO_Query::MODE_CONTRIBUTE) {
// soft credit columns are not automatically populated, because contribution search doesn't require them by default
- $componentReturnProperties =
+ $componentReturnProperties =
array_merge(
- $componentReturnProperties,
+ $componentReturnProperties,
CRM_Contribute_BAO_Query::softCreditReturnProperties(TRUE));
}
$returnProperties = array_merge($returnProperties, $componentReturnProperties);
/**
* Load extension info an XML file
*
- * @param string $string XML content
+ * @param $file
+ *
+ * @throws CRM_Extension_Exception_ParseException
+ * @internal param string $string XML content
* @return CRM_Extension_Info
- * @throws CRM_Extension_Exception
*/
public static function loadFromFile($file) {
list ($xml, $error) = CRM_Utils_XML::parseFile($file);
public $statuses;
/**
+ * @param CRM_Extension_Container_Interface $fullContainer
* @param CRM_Extension_Container_Basic|FALSE $defaultContainer
+ * @param CRM_Extension_Mapper $mapper
+ * @param $typeManagers
*/
function __construct(CRM_Extension_Container_Interface $fullContainer, $defaultContainer, CRM_Extension_Mapper $mapper, $typeManagers) {
$this->fullContainer = $fullContainer;
*
* @access public
*
- * @param string $key extension key
+ * @param $clazz
+ *
+ * @internal param string $key extension key
*
* @return string full path the extension .php file
*/
private $_repoUrl = NULL;
/**
+ * @param bool $fresh
+ *
* @return CRM_Extension_System
*/
public static function singleton($fresh = FALSE) {
* 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 flattened values
*
+ * @param array $allValues
+ *
* @return object CRM_Contribute_BAO_ContributionType object
* @access public
* @static
/**
* Get user context.
*
+ * @param null $mode
+ *
* @return string user context.
*/
function userContext($mode = NULL) {
*
* Redirect to civicrm home page when clicked on cancel button
*
+ * @param null $mode
+ *
* @return string user context.
*/
function userContext($mode = null) {
* Given a list of conditions in params generate the required
* where clause
*
+ * @param $query
+ *
* @return void
* @access public
*/
/**
* make sure that the user has permission to access this group
*
- * @param int $id the id of the object
- * @param int $name the name or title of the object
+ * @param int $id the id of the object
+ * @param int $title
+ *
+ * @internal param int $name the name or title of the object
*
* @return string the permission that the user has (or null)
* @access public
* form snippet. It should add all fields necesarry to get the data
* uploaded to the temporary table in the DB.
*
+ * @param $form
+ *
* @return void (operates directly on form argument)
* @access public
*/
/**
* Class constructor
*
- * @param object CRM_*_Import_Controller
- * @param int $action
+ * @param object $controller
+ * @param \const|int $action
*
+ * @internal param \CRM_ $object *_Import_Controller
*/
function __construct($controller, $action = CRM_Core_Action::NONE) {
parent::__construct($controller, $action);
* Register a subscription event. Create a new contact if one does not
* already exist.
*
- * @param int $group_id The group id to subscribe to
- * @param string $email The email address of the (new) contact
+ * @param int $group_id The group id to subscribe to
+ * @param string $email The email address of the (new) contact
+ * @param null $contactId
+ * @param null $context
* @params int $contactId Currently used during event registration/contribution.
* Specifically to avoid linking group to wrong duplicate contact
* during event registration.
/**
* Get user context.
*
+ * @param null $mode
+ *
* @return string user context.
*/
function userContext($mode = NULL) {
/**
* Class constructor
*
- * @param
+ * @internal param $
*
- * @return CRM_Contact_Selector_Profile
- * @access public
+ * @return \CRM_Mailing_Selector_Browse
+ @access public
*/
function __construct() {
}
/**
* Class constructor
*
- * @param string $event The event type (queue/delivered/open...)
- * @param boolean $distinct Count only distinct contact events?
- * @param int $mailing ID of the mailing to query
- * @param int $job ID of the job to query. If null, all jobs from $mailing are queried.
- * @param int $url If the event type is a click-through, do we want only those from a specific url?
+ * @param string $event The event type (queue/delivered/open...)
+ * @param boolean $distinct Count only distinct contact events?
+ * @param int $mailing ID of the mailing to query
+ * @param int $job ID of the job to query. If null, all jobs from $mailing are queried.
+ * @param int $url If the event type is a click-through, do we want only those from a specific url?
*
- * @return CRM_Contact_Selector_Profile
- * @access public
+ * @return \CRM_Mailing_Selector_Event
+ @access public
*/
function __construct($event, $distinct, $mailing, $job = NULL, $url = NULL) {
$this->_event_type = $event;
/**
* class constructor
*
- * @param object CRM_Mailing_Controller
- * @param int $action
+ * @param object $controller
+ * @param \const|int $action
*
- * @return object CRM_Mailing_StateMachine
+ * @internal param \CRM_Mailing_Controller $object
+ * @return \CRM_Mailing_StateMachine_Send CRM_Mailing_StateMachine
*/
function __construct($controller, $action = CRM_Core_Action::NONE) {
parent::__construct($controller, $action);
/**
* if membership are involved, add the specific membership fields
*
+ * @param $query
+ *
* @return void
* @access public
*/
*
* @access public
*
+ * @param null $id
+ * @param bool $force
+ *
* @return array - array reference of all membership types if any
* @static
*/
*
* @access public
*
+ * @param null $id
+ * @param null $cond
+ * @param string $column
+ * @param bool $force
+ *
* @return array - array reference of all membership statuss if any
* @static
*/
/**
* build select for Pledge
*
+ * @param $query
+ *
* @return void
* @access public
*/
/**
* 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 $isActive
+ *
+ * @internal param bool $is_active value we want to set the is_active field
*
* @return Object DAO object on sucess, null otherwise
* @static
/**
* Get and remove the next item
*
- * @param $leaseTime seconds
+ * @param int|\seconds $leaseTime seconds
*
* @return object with key 'data' that matches the inputted data
*/
* 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 $ids the array that holds all the db ids
+ * @param array $params (reference ) an assoc array of name/value pairs
+ *
+ * @internal param array $ids the array that holds all the db ids
*
* @return object CRM_Upgrade_Snapshot_V4p2_Price_BAO_Field object
* @access public
*
* @param array $params (reference), array $ids
*
+ * @param $ids
+ *
* @return object CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue object
* @access public
* @static
*
* @param array $params (reference), array $ids
*
+ * @param $ids
+ *
* @return object CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue object
* @access public
* @static
projects / civicrm-core.git / commitdiff