CONST ALL = 6;
/**
- * given a permission string, check for access requirements
+ * Given a permission string, check for access requirements
*
* @param string $str the permission to check
* @param int $contactID the contactID for whom the check is made
}
/**
- * get all the groups the user has access to for the given operation
+ * Get all the groups the user has access to for the given operation
*
* @param int $type the type of permission needed
* @param int $contactID the contactID for whom the check is made
}
/**
- * check if the user has access to this group for operation $type
+ * Check if the user has access to this group for operation $type
*
* @param int $type the type of permission needed
- * @param $groupID
+ * @param int $groupID
* @param int $contactID the contactID for whom the check is made
*
* @param string $tableName
}
/**
- * update the is_active flag in the db
+ * 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 $str
- * @param $contactID
+ * @param int $contactID
*
* @return bool
*/
* @param $type
* @param $tables
* @param $whereTables
- * @param null $contactID
+ * @param int $contactID
*
* @return null|string
*/
/**
* @param int $type
- * @param null $contactID
+ * @param int $contactID
* @param string $tableName
* @param null $allGroups
* @param null $includedGroups
}
/**
- * delete ACL records
+ * Delete ACL records
*
* @param int $aclId ID of the ACL record to be deleted.
*
static $_cache = NULL;
/**
- * @param $id
+ * @param int $id
*
* @return mixed
*/
}
/**
- * @param $id
+ * @param int $id
*
* @return array
*/
}
/**
- * @param $id
- * @param $cache
+ * @param int $id
+ * @param array $cache
*/
static function store($id, &$cache) {
foreach ($cache as $aclID => $data) {
}
/**
- * @param $id
+ * @param int $id
*/
static function deleteEntry($id) {
if (self::$_cache &&
}
/**
- * @param $id
+ * @param int $id
*/
static function updateEntry($id) {
// rebuilds civicrm_acl_cache
}
/**
- * update the is_active flag in the db
+ * 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
}
/**
- * delete Entity Role records
+ * Delete Entity Role records
*
* @param int $entityRoleId ID of the EntityRole record to be deleted.
*
class CRM_Activity_BAO_Activity extends CRM_Activity_DAO_Activity {
/**
- * static field for all the activity information that we can potentially export
+ * Static field for all the activity information that we can potentially export
*
* @var array
* @static
static $_exportableFields = NULL;
/**
- * static field for all the activity information that we can potentially import
+ * Static field for all the activity information that we can potentially import
*
* @var array
* @static
* @param array $params (reference ) an assoc array of name/value pairs
* @param array $defaults (reference ) an assoc array to hold the flattened values
*
- * @return CRM_Core_BAO_Meeting object
+ * @return CRM_Activity_DAO_Activity object
* @access public
*/
public static function retrieve(&$params, &$defaults) {
}
/**
- * delete the activity
+ * Delete the activity
*
* @param array $params associated array
* @param bool $moveToTrash
* Delete activity assignment record
*
* @param int $activityId
- * @param null $recordTypeID
+ * @param int $recordTypeID
*
* @return null
* @access public
}
/**
- * process the activities
+ * Process the activities
*
* @param array $params associated array of the submitted values
*
}
/**
- * get the list Activities
+ * Get the list Activities
*
* @param array $input array of parameters
* Keys include
}
/**
- * get the activity Count
+ * Get the activity Count
*
* @param array $input array of parameters
* Keys include
}
/**
- * function to get the activity sql clause to pick activities
+ * Get the activity sql clause to pick activities
*
* @param array $input array of parameters
* Keys include
}
/**
- * send the message to all the contacts and also insert a
+ * Send the message to all the contacts and also insert a
* contact activity in each contacts record
*
* @param array $contactDetails the array of contact details to send the email
}
/**
- * @param $contactDetails
- * @param $activityParams
+ * @param array $contactDetails
+ * @param array $activityParams
* @param array $smsParams
* @param $contactIds
- * @param null $userID
+ * @param int $userID
*
* @return array
* @throws CRM_Core_Exception
}
/**
- * send the sms message to a specific contact
+ * Send the sms message to a specific contact
*
* @param int $toID the contact id of the recipient
* @param $tokenText
* @param $tokenHtml
* @param array $smsParams the params used for sending sms
* @param int $activityID the activity ID that tracks the message
- * @param null $userID
+ * @param int $userID
*
* @return mixed true on success or PEAR_Error object
* @access public
}
/**
- * send the message to a specific contact
+ * Send the message to a specific contact
*
* @param string $from the name and email of the sender
- * @param $fromID
+ * @param int $fromID
* @param int $toID the contact id of the recipient
* @param string $subject the subject of the message
* @param $text_message
}
/**
- * combine all the importable fields from the lower levels object
+ * Combine all the importable fields from the lower levels object
*
* The ordering is important, since currently we do not have a weight
* scheme. Adding weight is super important and should be done in the
}
/**
- * Function to add activity for Membership/Event/Contribution
+ * Add activity for Membership/Event/Contribution
*
* @param object $activity (reference) particular component object
* @param string $activityType for Membership Signup or Renewal
}
/**
- * Function to find the latest revision of a given activity
+ * Find the latest revision of a given activity
*
- * @param $activityID prior activity id
+ * @param int $activityID prior activity id
*
- * @return int $params current activity id.
+ * @return int current activity id.
* @access public
*/
static function getLatestActivityId($activityID) {
}
/**
- * Function to create a follow up a given activity
+ * Create a follow up a given activity
*
* @param $activityId int activity id of parent activity
* @param array $params
}
/**
- * Function to get Activity specific File according activity type Id.
+ * Get Activity specific File according activity type Id.
*
* @param int $activityTypeId activity id
* @param string $crmDir
}
/**
- * Function to restore the activity
+ * Restore the activity
*
* @param array $params associated array
*
}
/**
- * @param $activityId
- * @param null $recordTypeID
+ * @param int $activityId
+ * @param int $recordTypeID
* @param string $column
*
* @return null
}
/**
- * @param $activityId
+ * @param int $activityId
*
* @return null
*/
class CRM_Activity_BAO_ActivityAssignment extends CRM_Activity_DAO_ActivityContact {
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
class CRM_Activity_BAO_ActivityContact extends CRM_Activity_DAO_ActivityContact {
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
}
/**
- * funtion to add activity contact
+ * Funtion to add activity contact
*
* @param array $params the values for this table: activity id, contact id, record type
*
}
/**
- * retrieve names of contact by activity_id
+ * Retrieve names of contact by activity_id
*
* @param int $activityID
* @param int $recordTypeID
}
/**
- * retrieve id of target contact by activity_id
+ * Retrieve id of target contact by activity_id
*
- * @param $activityID
- * @param $recordTypeID
+ * @param int $activityID
+ * @param int $recordTypeID
*
* @return mixed
*
class CRM_Activity_BAO_ActivityTarget extends CRM_Activity_DAO_ActivityContact {
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
}
/**
- * add activity target
+ * Add activity target
*
* @param array $params
*
}
/**
- * retrieve id of target contact by activity_id
+ * Retrieve id of target contact by activity_id
*
* @param int $activity_id
*
}
/**
- * retrieve names of target contact by activity_id
+ * Retrieve names of target contact by activity_id
*
* @param int $activityID
*
class CRM_Activity_BAO_Query {
/**
- * build select for Case
+ * Build select for Case
*
* @param $query
*
}
/**
- * where clause for a single field
+ * Where clause for a single field
*
* @param $values
* @param $query
}
/**
- * @param $name
+ * @param string $name
* @param $mode
* @param $side
*
}
/**
- * getter for the qill object
+ * Getter for the qill object
*
* @return string
* @access public
}
/**
- * add all the elements shared between case activity search and advanaced search
+ * Add all the elements shared between case activity search and advanced search
*
* @access public
*
- * @param $form CRM_Core_Form
+ * @param CRM_Core_Form $form
* @return void
* @static
*/
class CRM_Activity_Controller_Search extends CRM_Core_Controller {
/**
- * class constructor
+ * Class constructor
*/
function __construct($title = NULL, $modal = TRUE, $action = CRM_Core_Action::NONE) {
public $_activityId;
/**
- * store activity ids when multiple activities are created
+ * Store activity ids when multiple activities are created
*
* @var int
*/
}
/**
- * global form rule
+ * Global form rule
*
* @param array $fields the input form values
* @param array $files the uploaded files if any
*
* @access public
*
- * @param null $params
- * @return void
+ * @param array $params
+ * @return array|null
*/
public function postProcess($params = NULL) {
if ($this->_action & CRM_Core_Action::DELETE) {
}
/**
- * let injecting activity type file do any processing
+ * Let injecting activity type file do any processing
* needed, before the activity is added/updated
*
+ * @param array $params
*/
function beginPostProcess(&$params) {
if ($this->_activityTypeFile) {
}
/**
- * let injecting activity type file do any processing
+ * Let injecting activity type file do any processing
* needed, after the activity has been added/updated
*
+ * @param array $params
+ * @param $activity
*/
function endPostProcess(&$params, &$activity) {
if ($this->_activityTypeFile) {
$className = "CRM_{$this->_crmDir}_Form_Activity_{$this->_activityTypeFile}";
- $className::endPostProcess($this, $params, $activity );
+ $className::endPostProcess($this, $params, $activity);
}
}
}
class CRM_Activity_Form_ActivityView extends CRM_Core_Form {
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
class CRM_Activity_Form_Search extends CRM_Core_Form_Search {
/**
- * the params that are sent to the query
+ * The params that are sent to the query
*
* @var array
* @access protected
protected $_queryParams;
/**
- * are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact
*
* @access protected
* @var boolean
protected $_single = FALSE;
/**
- * are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact
*
* @access protected
* @var boolean
protected $_limit = NULL;
/**
- * prefix for the controller
+ * Prefix for the controller
*
*/
protected $_prefix = "activity_";
protected $_defaults;
/**
- * the saved search ID retrieved from the GET vars
+ * The saved search ID retrieved from the GET vars
*
* @var int
* @access protected
protected $_ssID;
/**
- * processing needed for buildForm and later
+ * Processing needed for buildForm and later
*
* @return void
* @access public
class CRM_Activity_Form_Task extends CRM_Core_Form {
/**
- * the task being performed
+ * The task being performed
*
* @var int
*/
public $_activityHolderIds;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @param
*
}
/**
- * simple shell that derived classes can call to add buttons to
+ * Simple shell that derived classes can call to add buttons to
* the form with a customized title for the main Submit
*
* @param string $title title of the main button
class CRM_Activity_Form_Task_AddToTag extends CRM_Activity_Form_Task {
/**
- * name of the tag
+ * Name of the tag
*
* @var string
*/
protected $_name;
/**
- * all the tags in the system
+ * All the tags in the system
*
* @var array
*/
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
class CRM_Activity_Form_Task_Batch extends CRM_Activity_Form_Task {
/**
- * the title of the group
+ * The title of the group
*
* @var string
*/
protected $_title;
/**
- * maximum profile fields that will be displayed
+ * Maximum profile fields that will be displayed
*
*/
protected $_maxFields = 9;
/**
- * variable to store redirect path
+ * Variable to store redirect path
*
*/
protected $_userContext;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
protected $_single = FALSE;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
public $_noEmails = FALSE;
/**
- * all the existing templates in the system
+ * All the existing templates in the system
*
* @var array
*/
public $_templates = NULL;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
class CRM_Activity_Form_Task_FileOnCase extends CRM_Activity_Form_Task {
/**
- * the title of the group
+ * The title of the group
*
* @var string
*/
protected $_title;
/**
- * variable to store redirect path
+ * Variable to store redirect path
*
*/
protected $_userContext;
/**
- * variable to store contact Ids
+ * Variable to store contact Ids
*
*/
public $_contacts;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
function addRules() {}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
class CRM_Activity_Form_Task_PickOption extends CRM_Activity_Form_Task {
/**
- * the title of the group
+ * The title of the group
*
* @var string
*/
protected $_title;
/**
- * maximum Activities that should be allowed to update
+ * Maximum Activities that should be allowed to update
*
*/
protected $_maxActivities = 100;
/**
- * variable to store redirect path
+ * Variable to store redirect path
*
*/
protected $_userContext;
/**
- * variable to store contact Ids
+ * Variable to store contact Ids
*
*/
public $_contacts;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $fields posted values of the form
*
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
class CRM_Activity_Form_Task_PickProfile extends CRM_Activity_Form_Task {
/**
- * the title of the group
+ * The title of the group
*
* @var string
*/
protected $_title;
/**
- * maximum Activities that should be allowed to update
+ * Maximum Activities that should be allowed to update
*
*/
protected $_maxActivities = 100;
/**
- * variable to store redirect path
+ * Variable to store redirect path
*
*/
protected $_userContext;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $fields posted values of the form
*
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
class CRM_Activity_Form_Task_Print extends CRM_Activity_Form_Task {
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
class CRM_Activity_Form_Task_RemoveFromTag extends CRM_Activity_Form_Task {
/**
- * name of the tag
+ * Name of the tag
*
* @var string
*/
protected $_name;
/**
- * all the tags in the system
+ * All the tags in the system
*
* @var array
*/
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
public $_single = FALSE;
/**
- * all the existing templates in the system
+ * All the existing templates in the system
*
* @var array
*/
public $_templates = NULL;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
class CRM_Activity_Form_Task_SearchTaskHookSample extends CRM_Activity_Form_Task {
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
class CRM_Activity_Import_Controller extends CRM_Core_Controller {
/**
- * class constructor
+ * Class constructor
*/
function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) {
parent::__construct($title, $modal);
*/
/**
- * name of the field
+ * Name of the field
*/
public $_name;
/**
- * title of the field to be used in display
+ * Title of the field to be used in display
*/
public $_title;
/**
- * type of field
+ * Type of field
* @var enum
*/
public $_type;
/**
- * is this field required
+ * Is this field required
* @var boolean
*/
public $_required;
/**
- * data to be carried for use by a derived class
+ * Data to be carried for use by a derived class
* @var object
*/
public $_payload;
/**
- * regexp to match the CSV header of this column/field
+ * Regexp to match the CSV header of this column/field
* @var string
*/
public $_headerPattern;
/**
- * regexp to match the pattern of data from various column/fields
+ * Regexp to match the pattern of data from various column/fields
* @var string
*/
public $_dataPattern;
/**
- * value of this field
+ * Value of this field
* @var object
*/
public $_value;
/**
- * @param $name
+ * @param string $name
* @param $title
* @param int $type
* @param string $headerPattern
}
/**
- * the value is in string format. convert the value to the type of this field
+ * The value is in string format. convert the value to the type of this field
* and set the field value with the appropriate type
*/
function setValue($value) {
class CRM_Activity_Import_Form_DataSource extends CRM_Core_Form {
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $fields posted values of the form
*
class CRM_Activity_Import_Form_Preview extends CRM_Import_Form_Preview {
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
class CRM_Activity_Import_Form_Summary extends CRM_Import_Form_Summary {
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
*/
/**
- * imported file size
+ * Imported file size
*/
protected $_fileSize;
/**
- * seperator being used
+ * Seperator being used
*/
protected $_seperator;
/**
- * total number of lines in file
+ * Total number of lines in file
*/
protected $_lineCount;
/**
- * whether the file has a column header or not
+ * Whether the file has a column header or not
*
* @var boolean
*/
protected $_haveColumnHeader;
/**
- * @param $fileName
+ * @param string $fileName
* @param string $seperator
* @param $mapper
* @param bool $skipColumnHeader
}
/**
- * format the field values for input to the api
+ * Format the field values for input to the api
*
* @return array (reference ) associative array of name/value pairs
* @access public
}
/**
- * @param $name
+ * @param string $name
* @param $title
* @param int $type
* @param string $headerPattern
protected $_newActivity;
/**
- * class constructor
+ * Class constructor
*/
function __construct(&$mapperKeys, $mapperLocType = NULL, $mapperPhoneType = NULL) {
parent::__construct();
}
/**
- * the initializer code, called before the processing
+ * The initializer code, called before the processing
*
* @return void
* @access public
}
/**
- * handle the values in mapField mode
+ * Handle the values in mapField mode
*
* @param array $values the array of values belonging to this line
*
}
/**
- * handle the values in preview mode
+ * Handle the values in preview mode
*
* @param array $values the array of values belonging to this line
*
}
/**
- * handle the values in summary mode
+ * Handle the values in summary mode
*
* @param array $values the array of values belonging to this line
*
}
/**
- * handle the values in import mode
+ * Handle the values in import mode
*
* @param int $onDuplicate the code for what action to take on duplicates
* @param array $values the array of values belonging to this line
}
/**
- * the initializer code, called before the processing
+ * The initializer code, called before the processing
*
* @return void
* @access public
}
/**
- * perform actions and display for activities.
+ * Perform actions and display for activities.
*
* @return void
*
class CRM_Activity_Page_UserDashboard extends CRM_Contact_Page_View_UserDashBoard {
/**
- * list participations for the UF user
+ * List participations for the UF user
*
* return null
* @access public
class CRM_Activity_Selector_Activity extends CRM_Core_Selector_Base implements CRM_Core_Selector_API {
/**
- * we use desc to remind us what that column is, name is used in the tpl
+ * We use desc to remind us what that column is, name is used in the tpl
*
* @var array
* @static
static $_columnHeaders;
/**
- * contactId - contact id of contact whose activies are displayed
+ * ContactId - contact id of contact whose activies are displayed
*
* @var int
* @access protected
* - View
*
* @param int $activityTypeId
- * @param null $sourceRecordId
+ * @param int $sourceRecordId
* @param bool $accessMailingReport
- * @param null $activityId
+ * @param int $activityId
* @param null $key
* @param null $compContext
*
}
/**
- * getter for array of the parameters required for creating pager.
+ * Getter for array of the parameters required for creating pager.
*
* @param $action
* @param array $params
}
/**
- * returns the column headers as an array of tuples:
+ * Returns the column headers as an array of tuples:
* (name, sortName (key to the sort array))
*
* @param string $action the action being performed
}
/**
- * returns all the rows in the given offset and rowCount
+ * Returns all the rows in the given offset and rowCount
*
* @param enum $action the action being performed
* @param int $offset the row number to start from
}
/**
- * name of export file.
+ * Name of export file.
*
* @param string $output type of output
*
}
/**
- * get colunmn headers for search selector
+ * Get colunmn headers for search selector
*
*
* @return array $_columnHeaders
static $_links = NULL;
/**
- * we use desc to remind us what that column is, name is used in the tpl
+ * We use desc to remind us what that column is, name is used in the tpl
*
* @var array
* @static
);
/**
- * are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact
*
* @access protected
* @var boolean
protected $_single = FALSE;
/**
- * are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact
*
* @access protected
* @var boolean
protected $_limit = NULL;
/**
- * what context are we being invoked from
+ * What context are we being invoked from
*
* @access protected
* @var string
protected $_context = NULL;
/**
- * what component context are we being invoked from
+ * What component context are we being invoked from
*
* @access protected
* @var string
protected $_compContext = NULL;
/**
- * queryParams is the array returned by exportValues called on
+ * QueryParams is the array returned by exportValues called on
* the HTML_QuickForm_Controller for that page.
*
* @var array
public $_queryParams;
/**
- * represent the type of selector
+ * Represent the type of selector
*
* @var int
* @access protected
}
/**
- * getter for array of the parameters required for creating pager.
+ * Getter for array of the parameters required for creating pager.
*
* @param $action
* @param array $params
}
/**
- * returns all the rows in the given offset and rowCount
+ * Returns all the rows in the given offset and rowCount
*
* @param enum $action the action being performed
* @param int $offset the row number to start from
}
/**
- * returns the column headers as an array of tuples:
+ * Returns the column headers as an array of tuples:
* (name, sortName (key to the sort array))
*
* @param string $action the action being performed
}
/**
- * name of export file.
+ * Name of export file.
*
* @param string $output type of output
*
protected $_task;
/**
- * class constructor
+ * Class constructor
*/
function __construct($controller, $action = CRM_Core_Action::NONE) {
parent::__construct($controller, $action);
}
/**
- * return the form name of the task
+ * Return the form name of the task
*
* @return string
* @access public
EMAIL_SMS = 6;
/**
- * the task array
+ * The task array
*
* @var array
* @static
static $_tasks = NULL;
/**
- * the optional task array
+ * The optional task array
*
* @var array
* @static
}
/**
- * show tasks selectively based on the permission level
+ * Show tasks selectively based on the permission level
* of the user
*
* @param int $permission
}
/**
- * global form rule
+ * Global form rule
*
* @param array $fields the input form values
*
class CRM_Admin_Form_Extensions extends CRM_Admin_Form {
/**
- * for pre-processing
+ * For pre-processing
*
* @return void
* @access public
}
/**
- * global form rule
+ * Global form rule
*
* @param array $fields the input form values
* @param array $files the uploaded files if any
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $fields posted values of the form
*
protected $_gLabel;
/**
- * pre-process
+ * Pre-process
*
* @return void
* @access public
}
/**
- * global form rule
+ * Global form rule
*
* @param array $fields the input form values
* @param array $files the uploaded files if any
* Save a payment processor
*
* @param $values
- * @param $domainID
+ * @param int $domainID
* @param $test
*
* @return Void
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $fields posted values of the form
*
$this->setPageTitle(ts('Scheduled Reminder'));
}
/**
- * global form rule
+ * Global form rule
*
* @param array $fields the input form values
*
}
/**
- * global form rule
+ * Global form rule
*
* @param array $fields the input form values
* @param array $files the uploaded files if any
/**
* @param $dsn
- * @param $fileName
+ * @param string $fileName
* @param bool $lineMode
*/
public static function loadCaseSampleData($dsn, $fileName, $lineMode = FALSE) {
}
/**
- * global form rule
+ * Global form rule
*
* @param array $fields the input form values
*
}
/**
- * global form rule
+ * Global form rule
*
* @param array $fields the input form values
* @param array $files the uploaded files if any
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $fields posted values of the form
*
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $values posted values of the form
*
}
/**
- * process drag/move action for menu tree
+ * Process drag/move action for menu tree
*/
static function menuTree() {
CRM_Core_BAO_Navigation::processNavigation($_GET);
}
/**
- * build status message while
+ * Build status message while
* enabling/ disabling various objects
*/
static function getStatusMsg() {
}
/**
- * get userContext params
+ * Get userContext params
*
* @param int $mode mode that we are in
*
}
/**
- * browse all entities.
+ * Browse all entities.
*
* @return void
* @access public
}
/**
- * override function browse()
+ * Override function browse()
+ *
+ * @param null $action
+ * @param null $sort
*/
function browse($action = NULL, $sort = NULL) {
$adminTagSet = FALSE;
}
/**
- * build badges parameters before actually creating badges.
+ * Build badges parameters before actually creating badges.
*
* @param array $params associated array of submitted values
* @param CRM_Core_Form $form
class CRM_Badge_BAO_Layout extends CRM_Core_DAO_PrintLabel {
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
}
/**
- * update the is_active flag in the db
+ * 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
}
/**
- * add a name label
+ * Add a name label
*
* @param array $params reference array contains the values submitted by the form
*
}
/**
- * delete name labels
+ * Delete name labels
*
* @param int $printLabelId ID of the name label to be deleted.
*
}
/**
- * build layout structure
+ * Build layout structure
*
* @param array $params associated array of submitted values
*
}
/**
- * decode encoded data and return as an array
+ * Decode encoded data and return as an array
*
* @param json $jsonData json object
*
}
/**
- * generate batch name
+ * Generate batch name
*
* @return batch name
* @static
}
/**
- * create entity batch entry
+ * Create entity batch entry
* @param array $params associated array
* @return batch array
* @access public
}
/**
- * delete batch entry
+ * Delete batch entry
*
* @param int $batchId batch id
*
}
/**
- * define action links
+ * Define action links
*
* @param null $context
*
}
/**
- * get batch list
+ * Get batch list
*
* @return array array of all batches
* excluding batches with data entry in progress
}
/**
- * Function to retrieve financial items assigned for a batch
+ * Retrieve financial items assigned for a batch
*
* @param int $entityID
* @param array $returnValues
* @param null $notPresent
- * @param null $params
+ * @param array $params
* @param bool $getCount
*
* @return Object
}
/**
- * function to get batch names
+ * Get batch names
* @param string $batchIds
*
* @return array array of batches
class CRM_Batch_Form_Entry extends CRM_Core_Form {
/**
- * maximum profile fields that will be displayed
+ * Maximum profile fields that will be displayed
*
*/
protected $_rowCount = 1;
protected $_batchInfo = array();
/**
- * store the profile id associated with the batch type
+ * Store the profile id associated with the batch type
*/
protected $_profileId;
public $_membershipId = null;
/**
- * when not to reset sort_name
+ * When not to reset sort_name
*/
protected $_preserveDefault = TRUE;
*/
public $_fields = array();
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * form validations
+ * Form validations
*
* @param array $params posted values of the form
* @param array $files list of errors to be posted back to the form
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
}
/**
- * process contribution records
+ * Process contribution records
*
* @param array $params associated array of submitted values
*
}
/**
- * process membership records
+ * Process membership records
*
* @param array $params associated array of submitted values
*
}
/**
- * update contact information
+ * Update contact information
*
* @param array $value associated array of submitted values
*
}
/**
- * browse all entities.
+ * Browse all entities.
*
* @return void
* @access public
class CRM_Bridge_OG_CiviCRM {
/**
- * @param $groupID
+ * @param int $groupID
* @param $group
* @param $op
*/
}
/**
- * @param $groupID
+ * @param int $groupID
* @param $group
*/
static function groupAdd($groupID, $group) {
}
/**
- * @param $groupID
+ * @param int $groupID
* @param $group
*/
static function groupDelete($groupID, $group) {
}
/**
- * @param $groupID
+ * @param int $groupID
* @param $contactIDs
* @param $op
*/
}
/**
- * @param $aclParams
+ * @param array $aclParams
* @param $op
*/
static function updateCiviACLTables($aclParams, $op) {
}
/**
- * @param $ogID
+ * @param int $ogID
*
* @return string
*/
}
/**
- * @param $ogID
+ * @param int $ogID
*
* @return string
*/
}
/**
- * @param $groupID
+ * @param int $groupID
* @param bool $abort
*
* @return int|null|string
}
/**
- * @param $ufID
+ * @param int $ufID
*
* @return int
* @throws Exception
Class CRM_Campaign_BAO_Campaign extends CRM_Campaign_DAO_Campaign {
/**
- * takes an associative array and creates a campaign object
+ * Takes an associative array and creates a campaign object
*
* the function extract all the params it needs to initialize the create a
* contact object. the params array could contain additional unused name/value
}
/**
- * delete the campaign
+ * Delete the campaign
*
* @param int $id id of the campaign
*
}
/**
- * retrieve campaigns for dashboard.
+ * Retrieve campaigns for dashboard.
*
* @static
*/
}
/**
- * get Campaigns groups
+ * Get Campaigns groups
*
* @param int $campaignId campaign id
*
}
/**
- * update the is_active flag in the db
+ * 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 CRM_Core_Form $form
- * @param null $connectedCampaignId
+ * @param int $connectedCampaignId
*/
public static function addCampaign(&$form, $connectedCampaignId = NULL) {
//some forms do set default and freeze.
}
/**
- * get Petition Details for dashboard.
+ * Get Petition Details for dashboard.
*
* @static
*/
}
/**
- * takes an associative array and creates a petition signature activity
+ * Takes an associative array and creates a petition signature activity
*
* @param array $params (reference ) an assoc array of name/value pairs
*
}
/**
- * @param $activity_id
- * @param $contact_id
- * @param $petition_id
+ * @param int $activity_id
+ * @param int $contact_id
+ * @param int $petition_id
*
* @return bool
*/
}
/**
- * get Petition Signature Total
+ * Get Petition Signature Total
*
* @param int $surveyId
*
}
/**
- * get Petition Signature Total
+ * Get Petition Signature Total
*
* @param int $surveyId
*
/**
- * @param null $surveyId
+ * @param int $surveyId
*
* @return array
*/
}
/**
- * Function to get Petition Signature Details
+ * Get Petition Signature Details
*
* @param int $surveyId
* @param int $status_id
}
/**
- * Function to check if contact has signed this petition
+ * Check if contact has signed this petition
*
* @param int $surveyId
* @param int $contactId
}
/**
- * takes an associative array and sends a thank you or email verification email
+ * Takes an associative array and sends a thank you or email verification email
*
* @param array $params (reference ) an assoc array of name/value pairs
*
CIVICRM_ACTIVITY_ASSIGNMENT = 'civicrm_survey_activity_assignment';
/**
- * static field for all the campaign fields
+ * Static field for all the campaign fields
*
* @var array
* @static
}
/**
- * if survey, campaign are involved, add the specific fields.
+ * If survey, campaign are involved, add the specific fields.
*
* @param $query
*
}
/**
- * @param $name
+ * @param string $name
* @param $mode
* @param $side
*
/**
* @param $row
- * @param $id
+ * @param int $id
*/
static function searchAction(&$row, $id) {}
}
/**
- * add all the elements shared between,
+ * Add all the elements shared between,
* normal voter search and voter listing (GOTV form)
*
* @access public
}
/**
- * takes an associative array and creates a Survey object
+ * Takes an associative array and creates a Survey object
*
* the function extract all the params it needs to initialize the create a
* survey object.
}
/**
- * retrieve surveys for dashboard.
+ * Retrieve surveys for dashboard.
*
* @static
*/
}
/**
- * get Surveys
+ * Get Surveys
*
* @param boolean $onlyActive retrieve only active surveys.
* @param boolean $onlyDefault retrieve only default survey.
}
/**
- * get Surveys activity types
+ * Get Surveys activity types
*
*
* @static
}
/**
- * Function to get Surveys custom groups
+ * Get Surveys custom groups
*
* @param $surveyTypes array an array of survey type id.
*
}
/**
- * update the is_active flag in the db
+ * 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
}
/**
- * Function to delete the survey
+ * Delete the survey
*
* @param int $id survey id
*
* @param int $surveyId survey id.
* @param array $voterIds voterIds.
*
- * @param null $interviewerId
+ * @param int $interviewerId
* @param array $statusIds
*
* @return array $activityDetails array of survey activity.@static
*
* @param int $surveyId survey id.
*
- * @param null $interviewerId
+ * @param int $interviewerId
* @param null $statusIds
* @param null $voterIds
* @param bool $onlyCount
/**
* This function return all voter links with respecting permissions
*
- * @param $surveyId
+ * @param int $surveyId
* @param bool $enclosedInUL
* @param string $extraULName
* @return array|string $url array of permissioned links@static
}
/**
- * Function to retrieve survey associated profile id.
+ * Retrieve survey associated profile id.
*
*/
public static function getSurveyProfileId($surveyId) {
}
/**
- * @param $surveyId
+ * @param int $surveyId
*
* @return mixed
*/
}
/**
- * Function to decides the contact type for given survey.
+ * Decides the contact type for given survey.
*
*/
public static function getSurveyContactType($surveyId) {
}
/**
- * Function to get survey supportable profile types
+ * Get survey supportable profile types
*
*/
public static function surveyProfileTypes() {
class CRM_Campaign_Controller_Search extends CRM_Core_Controller {
/**
- * class constructor
+ * Class constructor
*/
function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) {
class CRM_Campaign_Form_Campaign extends CRM_Core_Form {
/**
- * action
+ * Action
*
* @var int
*/
protected $_action;
/**
- * context
+ * Context
*
* @var string
*/
protected $_context;
/**
- * object values.
+ * Object values.
*
* @var array
*/
protected $_values;
/**
- * the id of the campaign we are proceessing
+ * The id of the campaign we are proceessing
*
* @var int
* @protected
protected $_searchVoterFor;
/**
- * processing needed for buildForm and later
+ * Processing needed for buildForm and later
*
* @return void
* @access public
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
*/
static function formRule($fields, $files, $form) {
protected $_mode;
/**
- * the id of the contact associated with this signature
+ * The id of the contact associated with this signature
*
* @var int
* @public
protected $_contactProfileId;
/**
- * the contact profile fields used for this petition
+ * The contact profile fields used for this petition
*
* @var array
*/
protected $_activityProfileId;
/**
- * the activity profile fields used for this petition
+ * The activity profile fields used for this petition
*
* @var array
*/
public $_activityProfileFields;
/**
- * the id of the survey (petition) we are proceessing
+ * The id of the survey (petition) we are proceessing
*
* @var int
* @protected
protected $_tagId;
/**
- * values to use for custom profiles
+ * Values to use for custom profiles
*
* @var array
* @protected
protected $_params;
/**
- * which email send mode do we use
+ * Which email send mode do we use
*
* @var int
* EMAIL_THANK = 1,
}
/**
- * build the petition profile form
+ * Build the petition profile form
*
- * @param $id
- * @param $name
+ * @param int $id
+ * @param string $name
* @param bool $viewOnly
*
* @return void
class CRM_Campaign_Form_Search extends CRM_Core_Form_Search {
/**
- * the params that are sent to the query
+ * The params that are sent to the query
*
* @var array
* @access protected
protected $_queryParams;
/**
- * are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact
*
* @access protected
* @var boolean
protected $_single = FALSE;
/**
- * are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact
*
* @access protected
* @var boolean
protected $_defaults;
/**
- * prefix for the controller
+ * Prefix for the controller
*
*/
protected $_prefix = "survey_";
private $_operation = 'reserve';
/**
- * processing needed for buildForm and later
+ * Processing needed for buildForm and later
*
* @return void
* @access public
protected $_force;
/**
- * processing needed for buildForm and later
+ * Processing needed for buildForm and later
*
* @return void
* @access public
protected $_force;
/**
- * processing needed for buildForm and later
+ * Processing needed for buildForm and later
*
* @return void
* @access public
protected $_force;
/**
- * processing needed for buildForm and later
+ * Processing needed for buildForm and later
*
* @return void
* @access public
protected $_surveyId;
/**
- * action
+ * Action
*
* @var int
*/
protected $_action;
/**
- * surveyTitle
+ * SurveyTitle
*
* @var string
*/
protected $_surveyId;
/**
- * surveyTitle
+ * SurveyTitle
*
* @var string
*/
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
public $_values;
/**
- * context
+ * Context
*
* @var string
*/
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
*/
static function formRule($fields, $files, $form) {
protected $_gName;
/**
- * id
+ * Id
*
* @var int
*/
protected $_id;
/**
- * action
+ * Action
*
* @var int
*/
protected $_action;
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @param null
*
protected $_componentClause = NULL;
/**
- * the task being performed
+ * The task being performed
*
* @var int
*/
protected $_voterIds;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @param
*
}
/**
- * simple shell that derived classes can call to add buttons to
+ * Simple shell that derived classes can call to add buttons to
* the form with a customized title for the main Submit
*
* @param string $title title of the main button
class CRM_Campaign_Form_Task_Interview extends CRM_Campaign_Form_Task {
/**
- * the title of the group
+ * The title of the group
*
* @var string
*/
protected $_title;
/**
- * variable to store redirect path
+ * Variable to store redirect path
*
*/
private $_userContext;
private $_allowAjaxReleaseButton;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
class CRM_Campaign_Form_Task_Print extends CRM_Campaign_Form_Task {
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
class CRM_Campaign_Form_Task_Release extends CRM_Campaign_Form_Task {
/**
- * survet id
+ * Survet id
*
* @var int
*/
protected $_surveyId;
/**
- * number of voters
+ * Number of voters
*
* @var int
*/
protected $_interviewerId;
/**
- * survey details
+ * Survey details
*
* @var object
*/
protected $_surveyActivities;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
class CRM_Campaign_Form_Task_Reserve extends CRM_Campaign_Form_Task {
/**
- * survet id`
+ * Survet id`
*
* @var int
*/
protected $_surveyId;
/**
- * interviewer id
+ * Interviewer id
*
* @var int
*/
protected $_interviewerId;
/**
- * survey details
+ * Survey details
*
* @var object
*/
protected $_surveyDetails;
/**
- * number of voters
+ * Number of voters
*
* @var int
*/
protected $_numVoters;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $fields posted values of the form
*
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
class CRM_Campaign_Form_Task_Result extends CRM_Campaign_Form_Task {
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
* @param int $subscribe_id The id of the subscription event
* @param string $hash The hash
*
- * @param $activity_id
- * @param $petition_id
+ * @param int $activity_id
+ * @param int $petition_id
*
* @return boolean True on success
* @access public
}
/**
- * get userContext params
+ * Get userContext params
*
* @param int $mode mode that we are in
*
static $_links = NULL;
/**
- * we use desc to remind us what that column is, name is used in the tpl
+ * We use desc to remind us what that column is, name is used in the tpl
*
* @var array
* @static
);
/**
- * are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact
*
* @access protected
* @var boolean
protected $_single = FALSE;
/**
- * are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact
*
* @access protected
* @var boolean
protected $_limit = NULL;
/**
- * what context are we being invoked from
+ * What context are we being invoked from
*
* @access protected
* @var string
protected $_context = NULL;
/**
- * queryParams is the array returned by exportValues called on
+ * QueryParams is the array returned by exportValues called on
* the HTML_QuickForm_Controller for that page.
*
* @var array
public $_queryParams;
/**
- * represent the type of selector
+ * Represent the type of selector
*
* @var int
* @access protected
}
/**
- * getter for array of the parameters required for creating pager.
+ * Getter for array of the parameters required for creating pager.
*
* @param $action
* @param array $params
}
/**
- * returns all the rows in the given offset and rowCount
+ * Returns all the rows in the given offset and rowCount
*
* @param enum $action the action being performed
* @param int $offset the row number to start from
}
/**
- * returns the column headers as an array of tuples:
+ * Returns the column headers as an array of tuples:
* (name, sortName (key to the sort array))
*
* @param string $action the action being performed
}
/**
- * name of export file.
+ * Name of export file.
*
* @param string $output type of output
*
protected $_task;
/**
- * class constructor
+ * Class constructor
*/ function __construct($controller, $action = CRM_Core_Action::NONE) {
parent::__construct($controller, $action);
}
/**
- * return the form name of the task
+ * Return the form name of the task
*
* @return string
* @access public
CONST INTERVIEW = 1, RESERVE = 2, RELEASE = 3, PRINT_VOTERS = 4;
/**
- * the task array
+ * The task array
*
* @var array
* @static
static $_tasks = NULL;
/**
- * the optional task array
+ * The optional task array
*
* @var array
* @static
}
/**
- * show tasks selectively based on the permission level
+ * Show tasks selectively based on the permission level
* of the user
*
* @param int $permission
/**
* @param $xmlString
- * @param $confFilename
+ * @param string $confFilename
*/
public function __construct($xmlString, $confFilename) {
$this->xmlString = $xmlString;
/**
* @param $xmlString
- * @param $clientID
- * @param $caseID
+ * @param int $clientID
+ * @param int $caseID
* @param bool $printReport
*
* @return mixed
private $ifBlanks;
/**
- * @param $filename
+ * @param string $filename
*/
public function __construct($filename) {
$this->filename = $filename;
class CRM_Case_BAO_Case extends CRM_Case_DAO_Case {
/**
- * static field for all the case information that we can potentially export
+ * Static field for all the case information that we can potentially export
*
* @var array
* @static
}
/**
- * takes an associative array and creates a case object
+ * Takes an associative array and creates a case object
*
* the function extract all the params it needs to initialize the create a
* case object. the params array could contain additional unused name/value
}
/**
- * takes an associative array and creates a case object
+ * Takes an associative array and creates a case object
*
* @param array $params (reference ) an assoc array of name/value pairs
*
}
/**
- * process case activity add/delete
+ * Process case activity add/delete
* takes an associative array and
*
* @param array $params (reference ) an assoc array of name/value pairs
}
/**
- * get the case subject for Activity
+ * Get the case subject for Activity
*
* @param int $activityId activity id
*
}
/**
- * get the case type.
+ * Get the case type.
*
* @param int $caseId
*
}
/**
- * Function to enable disable case related relationships
+ * Enable disable case related relationships
*
* @param int $caseId case id
* @param boolean $enable action
*
* @param int $caseId ID of the case
*
- * @param null $contactID
+ * @param int $contactID
*
* @return array
* @access public
/**
* Look up a case using an activity ID
*
- * @param $activityId
+ * @param int $activityId
*
* @return int, case ID
*/
/**
* Retrieve case_id by contact_id
*
- * @param $contactID
+ * @param int $contactID
* @param boolean $includeDeleted include the deleted cases in result
* @param null $caseType
*
/**
* @param string $type
- * @param null $userID
+ * @param int $userID
* @param null $condition
* @param int $isDeleted
*
}
/**
- * Function to get the summary of cases counts by type and status.
+ * Get the summary of cases counts by type and status.
+ *
+ * @param bool $allCases
+ * @param int $userID
+ * @return array
*/
static function getCasesSummary($allCases = TRUE, $userID) {
$caseSummary = array();
}
/**
- * Function to get Case roles
+ * Get Case roles
*
* @param int $contactID contact id
* @param int $caseID case id
- * @param null $relationshipID
+ * @param int $relationshipID
*
- * @return returns case role / relationships
+ * @return array case role / relationships
*
* @static
*/
}
/**
- * Function to get Case Activities
+ * Get Case Activities
*
* @param int $caseID case id
* @param array $params posted params
* @param int $contactID contact id
*
* @param null $context
- * @param null $userID
+ * @param int $userID
* @param null $type
*
- * @return returns case activities
+ * @return array of case activities
*
* @static
*/
}
/**
- * Function to get Case Related Contacts
+ * Get Case Related Contacts
*
* @param int $caseID case id
* @param boolean $skipDetails if true include details of contacts
}
/**
- * Function that sends e-mail copy of activity
+ * Send e-mail copy of activity
*
- * @param $clientId
+ * @param int $clientId
* @param int $activityId activity Id
* @param array $contacts array of related contact
*
* @param null $attachments
- * @param $caseId
+ * @param int $caseId
*
* @return void
* @access public
}
/**
- * Function to retrieve the scheduled activity type and date
+ * Retrieve the scheduled activity type and date
*
* @param array $cases Array of contact and case id
*
}
/**
- * combine all the exportable fields from the lower levels object
+ * Combine all the exportable fields from the lower levels object
*
* @return array array of exportable Fields
* @access public
return $globalContacts;
}
- /*
- * Convenience function to get both case contacts and global in one array
- */
/**
- * @param $caseId
+ * Convenience function to get both case contacts and global in one array
+ * @param int $caseId
*
* @return array
*/
}
/**
- * Function to get Case ActivitiesDueDates with given criteria.
+ * Get Case ActivitiesDueDates with given criteria.
*
* @param int $caseID case id
* @param array $criteriaParams given criteria
}
/**
- * Function to create activities when Case or Other roles assigned/modified/deleted.
+ * Create activities when Case or Other roles assigned/modified/deleted.
*
- * @param $caseId
+ * @param int $caseId
* @param int $relationshipId relationship id
* @param int $relContactId case role assignee contactId.
- * @param null $contactId
+ * @param int $contactId
*
* @return void on success creates activity and case activity
*
}
/**
- * Function to get case manger
+ * Get case manger
* contact which is assigned a case role of case manager.
*
* @param int $caseType case type
}
/**
- * @param null $contactId
+ * @param int $contactId
* @param bool $excludeDeleted
*
* @return null|string
}
/**
- * since we drop 'access CiviCase', allow access
+ * Since we drop 'access CiviCase', allow access
* if user has 'access my cases and activities'
* or 'access all cases and activities'
*/
}
/**
- * Function to check whether activity is a case Activity
+ * Check whether activity is a case Activity
*
* @param int $activityID activity id
*
}
/**
- * Function to get all the case type ids currently in use
+ * Get all the case type ids currently in use
*
*
* @return array $caseTypeIds
}
/**
- * Function to get all the case status ids currently in use
+ * Get all the case status ids currently in use
*
*
* @return array $caseStatusIds
}
/**
- * Function to get all the encounter medium ids currently in use
+ * Get all the encounter medium ids currently in use
* @return array
*/
static function getUsedEncounterMediums() {
}
/**
- * Function to check case configuration.
+ * Check case configuration.
*
- * @param null $contactId
+ * @param int $contactId
*
* @return array $configured
*/
}
/**
- * helper function, also used by the upgrade in case of error
+ * Helper function, also used by the upgrade in case of error
*/
static function createCaseViewsQuery($section = 'upcoming') {
$sql = "";
}
/**
- * Function to add/copy relationships, when new client is added for a case
+ * Add/copy relationships, when new client is added for a case
*
* @param int $caseId case id
* @param int $contactId contact id / new client id
}
/**
- * Function to get the list of clients for a case
+ * Get the list of clients for a case
*
* @param int $caseId
*
class CRM_Case_BAO_CaseType extends CRM_Case_DAO_CaseType {
/**
- * static field for all the case information that we can potentially export
+ * Static field for all the case information that we can potentially export
*
* @var array
* @static
/**
- * format / convert submitted array to xml for case type definition
+ * Format / convert submitted array to xml for case type definition
*
* @param string $name
* @param array $definition the case-type defintion expressed as an array-tree
}
/**
- * get the case definition either from db or read from xml file
+ * Get the case definition either from db or read from xml file
*
* @param SimpleXmlElement $xml a single case-type record
*
}
/**
- * takes an associative array and creates a case type object
+ * Takes an associative array and creates a case type object
*
* @param array $params (reference ) an assoc array of name/value pairs
*
}
/**
- * @param $caseTypeId
+ * @param int $caseTypeId
*
* @throws CRM_Core_Exception
* @return mixed
}
/**
- * build select for Case
+ * Build select for Case
*
* @param $query
*
}
/**
- * where clause for a single field
+ * Where clause for a single field
*
* @param $values
* @param $query
}
/**
- * @param $name
+ * @param string $name
* @param $mode
* @param $side
*
}
/**
- * getter for the qill object
+ * Getter for the qill object
*
* @return string
* @access public
}
/**
- * add all the elements shared between case search and advanaced search
+ * Add all the elements shared between case search and advanaced search
*
* @access public
*
/**
* @param $row
- * @param $id
+ * @param int $id
*/
static function searchAction(&$row, $id) {}
}
class CRM_Case_Controller_Search extends CRM_Core_Controller {
/**
- * class constructor
+ * Class constructor
*/
function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) {
}
/**
- * global form rule
+ * Global form rule
*
* @param array $fields the input form values
* @param array $files the uploaded files if any
*
* @access public
*
- * @param null $params
+ * @param array $params
*
* @return void
*/
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $values posted values of the form
*
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $values posted values of the form
*
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $values posted values of the form
*
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $values posted values of the form
*
class CRM_Case_Form_Activity_OpenCase {
/**
- * the id of the client associated with this case
+ * The id of the client associated with this case
*
* @var int
* @public
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param $fields
* @param $files
class CRM_Case_Form_ActivityToCase extends CRM_Core_Form {
/**
- * build all the data structures needed to build the form.
+ * Build all the data structures needed to build the form.
*
* @return void
* @access public
class CRM_Case_Form_ActivityView extends CRM_Core_Form {
/**
- * process the view
+ * Process the view
*
* @access public
*
public $_activityTypeFile = NULL;
/**
- * logged in contact Id
+ * Logged in contact Id
*/
public $_currentUserId = NULL;
/**
- * activity type Id
+ * Activity type Id
*/
public $_activityTypeId = NULL;
/**
- * activity type Id
+ * Activity type Id
*/
public $_activityId = NULL;
/**
- * action
+ * Action
*/
public $_action;
/**
- * case type id
+ * Case type id
*/
public $_caseTypeId = NULL;
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $values posted values of the form
*
*/
class CRM_Case_Form_CaseView extends CRM_Core_Form {
/**
- * check for merge cases.
+ * Check for merge cases.
* @var bool
*/
private $_mergeCases = FALSE;
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
protected $_cdType;
/**
- * entity sub type of the table id
+ * Entity sub type of the table id
*
* @var string
* @access protected
protected $_subTypeID;
/**
- * pre processing work done here.
+ * Pre processing work done here.
*
* gets session variables for table name, id of entity in table, type of entity and stores them.
*
class CRM_Case_Form_EditClient extends CRM_Core_Form {
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
public $_clientID = NULL;
/**
- * activity set name
+ * Activity set name
*/
public $_activitySetName = NULL;
class CRM_Case_Form_Search extends CRM_Core_Form_Search {
/**
- * the params that are sent to the query
+ * The params that are sent to the query
*
* @var array
* @access protected
protected $_queryParams;
/**
- * are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact
*
* @access protected
* @var boolean
protected $_single = FALSE;
/**
- * are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact
*
* @access protected
* @var boolean
protected $_limit = NULL;
/**
- * prefix for the controller
+ * Prefix for the controller
*
*/
protected $_prefix = 'case_';
protected $_defaults;
/**
- * processing needed for buildForm and later
+ * Processing needed for buildForm and later
*
* @return void
* @access public
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $fields posted values of the form
*
class CRM_Case_Form_Task extends CRM_Core_Form {
/**
- * the task being performed
+ * The task being performed
*
* @var int
*/
protected $_caseIds;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @param
*
}
/**
- * simple shell that derived classes can call to add buttons to
+ * Simple shell that derived classes can call to add buttons to
* the form with a customized title for the main Submit
*
* @param string $title title of the main button
public $_moveToTrash = TRUE;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
class CRM_Case_Form_Task_Print extends CRM_Case_Form_Task {
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
protected $_single = FALSE;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
class CRM_Case_Form_Task_Result extends CRM_Case_Form_Task {
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
class CRM_Case_Form_Task_SearchTaskHookSample extends CRM_Case_Form_Task {
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * delete relationships specific to case and relationship type
+ * Delete relationships specific to case and relationship type
*/
static function deleteCaseRoles() {
$caseId = CRM_Utils_Type::escape($_POST['case_id'], 'Integer');
class CRM_Case_PseudoConstant extends CRM_Core_PseudoConstant {
/**
- * case statues
+ * Case statues
* @var array
* @static
*/
static $caseStatus = array();
/**
- * redaction rules
+ * Redaction rules
* @var array
* @static
*/
static $redactionRule;
/**
- * case type
+ * Case type
* @var array
* @static
*/
static $encounterMedium = array();
/**
- * activity type
+ * Activity type
* @var array
* @static
*/
static $_links = NULL;
/**
- * we use desc to remind us what that column is, name is used in the tpl
+ * We use desc to remind us what that column is, name is used in the tpl
*
* @var array
* @static
);
/**
- * are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact
*
* @access protected
* @var boolean
protected $_single = FALSE;
/**
- * are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact
*
* @access protected
* @var boolean
protected $_limit = NULL;
/**
- * what context are we being invoked from
+ * What context are we being invoked from
*
* @access protected
* @var string
protected $_context = NULL;
/**
- * queryParams is the array returned by exportValues called on
+ * QueryParams is the array returned by exportValues called on
* the HTML_QuickForm_Controller for that page.
*
* @var array
public $_queryParams;
/**
- * represent the type of selector
+ * Represent the type of selector
*
* @var int
* @access protected
}
/**
- * getter for array of the parameters required for creating pager.
+ * Getter for array of the parameters required for creating pager.
*
* @param $action
* @param array $params
}
/**
- * returns all the rows in the given offset and rowCount
+ * Returns all the rows in the given offset and rowCount
*
* @param enum $action the action being performed
* @param int $offset the row number to start from
}
/**
- * returns the column headers as an array of tuples:
+ * Returns the column headers as an array of tuples:
* (name, sortName (key to the sort array))
*
* @param string $action the action being performed
}
/**
- * name of export file.
+ * Name of export file.
*
* @param string $output type of output
*
protected $_task;
/**
- * class constructor
+ * Class constructor
*/ function __construct($controller, $action = CRM_Core_Action::NONE) {
parent::__construct($controller, $action);
}
/**
- * return the form name of the task
+ * Return the form name of the task
*
* @return string
* @access public
CONST DELETE_CASES = 1, PRINT_CASES = 2, EXPORT_CASES = 3, RESTORE_CASES = 4;
/**
- * the task array
+ * The task array
*
* @var array
* @static
static $_tasks = NULL;
/**
- * the optional task array
+ * The optional task array
*
* @var array
* @static
}
/**
- * show tasks selectively based on the permission level
+ * Show tasks selectively based on the permission level
* of the user
*
* @param int $permission
}
/**
- * @param $relationshipTypeName
+ * @param string $relationshipTypeName
* @param array $params
*
* @return bool
public function __construct() {}
/**
- * @param $clientID
- * @param $caseID
- * @param $activitySetName
+ * @param int $clientID
+ * @param int $caseID
+ * @param string $activitySetName
* @param array $params
*
* @return mixed
}
/**
- * @param $clientID
- * @param $caseID
+ * @param int $clientID
+ * @param int $caseID
*
* @return array
*/
/**
* @param $xml
- * @param $activitySetName
+ * @param string $activitySetName
*
* @return array|bool
*/
/**
* @param $xml
- * @param $activitySetName
+ * @param string $activitySetName
*
* @return null|string
*/
}
/**
- * @param $clientID
- * @param $caseID
+ * @param int $clientID
+ * @param int $caseID
* @param $activityTypes
* @param $activities
*/
}
/**
- * @param $clientID
- * @param $activityID
+ * @param int $clientID
+ * @param int $activityID
* @param bool $anyActivity
* @param int $redact
*
}
/**
- * @param $clientID
+ * @param int $clientID
* @param $activityDAO
* @param $activityTypeInfo
*
}
/**
- * @param $clientID
+ * @param int $clientID
* @param $activityDAO
* @param $activityTypeInfo
*
}
/**
- * @param $activityTypeID
+ * @param int $activityTypeID
* @param null $dateFormat
*
* @return mixed
}
/**
- * @param $activityID
+ * @param int $activityID
*
* @return null|string
*/
}
/**
- * @param $clientID
- * @param $caseID
- * @param $activitySetName
+ * @param int $clientID
+ * @param int $caseID
+ * @param string $activitySetName
* @param array $params
* @param CRM_Core_Form $form
*
END";
/**
- * the types of communication preferences
+ * The types of communication preferences
*
* @var array
*/
static $_commPrefs = array('do_not_phone', 'do_not_email', 'do_not_mail', 'do_not_sms', 'do_not_trade');
/**
- * types of greetings
+ * Types of greetings
*
* @var array
*/
static $_greetingTypes = array('addressee', 'email_greeting', 'postal_greeting');
/**
- * static field for all the contact information that we can potentially import
+ * Static field for all the contact information that we can potentially import
*
* @var array
* @static
static $_importableFields = array();
/**
- * static field for all the contact information that we can potentially export
+ * Static field for all the contact information that we can potentially export
*
* @var array
* @static
static $_exportableFields = NULL;
/**
- * class constructor
+ * Class constructor
*
* @access public
* @return \CRM_Contact_DAO_Contact
}
/**
- * takes an associative array and creates a contact object
+ * Takes an associative array and creates a contact object
*
* the function extract all the params it needs to initialize the create a
* contact object. the params array could contain additional unused name/value
}
/**
- * create contact
+ * Create contact
* takes an associative array and creates a contact object and all the associated
* derived objects (i.e. individual, location, email, phone etc)
*
}
/**
- * get the display name of a contact
+ * Get the display name of a contact
*
* @param int $id id of the contact
*
}
/**
- * delete the image of a contact
+ * Delete the image of a contact
*
* @param int $id id of the contact
*
}
/**
- * function to return proportional height and width of the image
+ * Return proportional height and width of the image
*
* @param Integer $imageWidth width of image
*
}
/**
- * function to extract contact id from url for deleting contact image
+ * Extract contact id from url for deleting contact image
*/
public static function processImage() {
}
/**
- * combine all the importable fields from the lower levels object
+ * Combine all the importable fields from the lower levels object
*
* The ordering is important, since currently we do not have a weight
* scheme. Adding weight is super important
}
/**
- * combine all the exportable fields from the lower levels object
+ * Combine all the exportable fields from the lower levels object
*
* currentlty we are using importable fields as exportable fields
*
}
/**
- * Function to get the all contact details(Hierarchical)
+ * Get the all contact details(Hierarchical)
*
* @param int $contactId contact id
* @param array $fields fields array
}
/**
- * given a set of flat profile style field names, create a hierarchy
+ * Given a set of flat profile style field names, create a hierarchy
* for query to use and crete the right sql
*
* @param $fields
}
/**
- * Function to return the primary location type of a contact
+ * Return the primary location type of a contact
*
* $params int $contactId contact_id
* $params boolean $isPrimaryExist if true, return primary contact location type otherwise null
* $params boolean $skipDefaultPriamry if true, return primary contact location type otherwise null
*
- * @param $contactId
+ * @param int $contactId
* @param bool $skipDefaultPriamry
* @param null $block
*
}
/**
- * function to get the display name, primary email and location type of a contact
+ * Get the display name, primary email and location type of a contact
*
* @param int $id id of the contact
*
}
/**
- * function to add/edit/register contacts through profile.
+ * Add/edit/register contacts through profile.
*
* @param array $params Array of profile fields to be edited/added.
* @param array $fields Array of fields from UFGroup
/**
* @param array $params
* @param $fields
- * @param null $contactID
- * @param null $ufGroupId
+ * @param int $contactID
+ * @param int $ufGroupId
* @param null $ctype
* @param bool $skipCustom
*
}
/**
- * Function to find the get contact details
+ * Find the get contact details
* does not respect ACLs for now, which might need to be rectified at some
* stage based on how its used
*
}
/**
- * Function to find the contact details associated with an OpenID
+ * Find the contact details associated with an OpenID
*
* @param string $openId openId of the contact
* @param string $ctype contact type
}
/**
- * Function to process greetings and cache
+ * Process greetings and cache
*
* @param object $contact contact object after save
* @param boolean $useDefaults use default greeting values
}
/**
- * Function to retrieve loc block ids w/ given condition.
+ * Retrieve loc block ids w/ given condition.
*
* @param int $contactId contact id.
* @param array $criteria key => value pair which should be
}
/**
- * Function to build context menu items.
+ * Build context menu items.
*
- * @param null $contactId
+ * @param int $contactId
*
* @return array of context menu for logged in user.
* @static
}
/**
- * Function to retrieve display name of contact that address is shared
+ * Retrieve display name of contact that address is shared
* based on $masterAddressId or $contactId .
*
* @param int $masterAddressId master id.
/**
* Get the creation/modification times for a contact
*
- * @param $contactId
+ * @param int $contactId
*
* @return array('created_date' => $, 'modified_date' => $)
*/
}
/**
- * Function to check if contact is being used in civicrm_domain
+ * Check if contact is being used in civicrm_domain
* based on $contactId
*
* @param int $contactId contact id.
class CRM_Contact_BAO_Contact_Location {
/**
- * get the display name, primary email, location type and location id of a contact
+ * Get the display name, primary email, location type and location id of a contact
*
* @param int $id id of the contact
*
* @param bool $isPrimary
- * @param null $locationTypeID
+ * @param int $locationTypeID
*
* @return array of display_name, email, location type and location id if found, or (null,null,null, null)
* @static
}
/**
- * get the sms number and display name of a contact
+ * Get the sms number and display name of a contact
*
* @param int $id id of the contact
*
}
/**
- * get the information to map a contact
+ * Get the information to map a contact
*
* @param array $ids the list of ids for which we want map info
* $param int $locationTypeID
*
- * @param null $locationTypeID
+ * @param int $locationTypeID
* @param bool $imageUrlOnly
*
* @return null|string display name of the contact if found
class CRM_Contact_BAO_Contact_Permission {
/**
- * check if the logged in user has permissions for the operation type
+ * Check if the logged in user has permissions for the operation type
*
* @param int $id contact id
* @param int|string $type the type of operation (view|edit)
}
/**
- * fill the acl contact cache for this contact id if empty
+ * Fill the acl contact cache for this contact id if empty
*
* @param int $userID
* @param int|string $type the type of operation (view|edit)
}
/**
- * check if there are any contacts in cache table
+ * Check if there are any contacts in cache table
*
* @param int|string $type the type of operation (view|edit)
* @param int $contactID contact id
/**
* @param string $contactAlias
- * @param null $contactID
+ * @param int $contactID
*
* @return array
*/
}
/**
- * get the permission base on its relationship
+ * Get the permission base on its relationship
*
* @param int $selectedContactID contact id of selected contact
* @param int $contactID contact id of the current contact
/**
- * @param $contactID
+ * @param int $contactID
* @param CRM_Core_Form $form
* @param bool $redirect
*
}
/**
- * @param $contactID
+ * @param int $contactID
* @param CRM_Core_Form $form
* @param bool $redirect
*
class CRM_Contact_BAO_Contact_Utils {
/**
- * given a contact type, get the contact image
+ * Given a contact type, get the contact image
*
* @param string $contactType contact type
* @param boolean $urlOnly if we need to return only image url
}
/**
- * function check for mix contact ids(individual+household etc...)
+ * Function check for mix contact ids(individual+household etc...)
*
* @param array $contactIds array of contact ids
*
}
/**
- * get the count of contact loctions
+ * Get the count of contact loctions
*
* @param int $contactId contact id
*
}
/**
- * create related memberships for current employer
+ * Create related memberships for current employer
*
* @param int $contactID contact id of the individual
* @param int $employerID contact id of the organization.
* @param array $relationshipParams relationship params.
* @param boolean $duplicate are we triggered existing relationship.
*
- * @param null $previousEmpID
+ * @param int $previousEmpID
*
* @throws CiviCRM_API3_Exception
* @access public
}
/**
- * set current employer id and organization name
+ * Set current employer id and organization name
*
* @param array $currentEmployerParams associated array of contact id and its employer id
*
}
/**
- * update cached current employer name
+ * Update cached current employer name
*
* @param int $organizationId current employer id
*
}
/**
- * Function to clear cached current employer name
+ * Clear cached current employer name
*
* @param int $contactId contact id ( mostly individual contact id)
* @param int $employerId contact id ( mostly organization contact id)
}
/**
- * Function to build form for related contacts / on behalf of organization.
+ * Build form for related contacts / on behalf of organization.
*
* @param CRM_Core_Form $form
* @param $contactType string contact type
- * @param $countryID
- * @param $stateID
+ * @param int $countryID
+ * @param int $stateID
* @param $title string fieldset title
*
* @static
}
/**
- * Function to clear cache employer name and employer id
+ * Clear cache employer name and employer id
* of all employee when employer get deleted.
*
* @param int $employerId contact id of employer ( organization id )
* This function retrieve component related contact information.
*
* @param array $componentIds array of component Ids.
- * @param $componentName
+ * @param string $componentName
* @param array $returnProperties array of return elements.
*
* @return array $contactDetails array of contact info.@static
}
/**
- * Function to get the list of contact name give address associated array
+ * Get the list of contact name give address associated array
*
* @param array $addresses associated array of
*
* @param string $templateString the greeting template string with contact tokens + Smarty syntax
*
* @param $contactDetails
- * @param $contactID
- * @param $className
+ * @param int $contactID
+ * @param string $className
*
* @return void
* @static
}
/**
- * check if a given type is a subtype
+ * Check if a given type is a subtype
*
* @param string $subType contact subType.
* @param bool $ignoreCache
}
/**
- * retrieve the basic contact type associated with given subType.
+ * Retrieve the basic contact type associated with given subType.
*
*@param array/string $subType contact subType.
*@return array/string of basicTypes.
}
/**
- * verify if a given subtype is associated with a given basic contact type.
+ * Verify if a given subtype is associated with a given basic contact type.
*
* @param string $subType contact subType
* @param string $contactType contact Type
}
/**
- * create shortcuts menu for contactTypes
+ * Create shortcuts menu for contactTypes
*
* @return array of contactTypes
* @static
}
/**
- * delete Contact SubTypes
+ * Delete Contact SubTypes
*
* @param int $contactTypeId ID of the Contact Subtype to be deleted.
*
}
/**
- * Function to add or update Contact SubTypes
+ * Add or update Contact SubTypes
*
* @param array $params an assoc array of name/value pairs
*
}
/**
- * update the is_active flag in the db
+ * 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 $typeName
+ * @param string $typeName
*
* @return mixed
*/
}
/**
- * Function to check whether allow to change any contact's subtype
+ * Check whether allow to change any contact's subtype
* on the basis of custom data and relationship of specific subtype
* currently used in contact/edit form amd in import validation
*
/**
* @param $contactType
- * @param null $contactId
+ * @param int $contactId
*
* @return bool
*/
/**
* @todo what does this function do?
- * @param $contactId
+ * @param int $contactId
* @param $contactType
*
* @return bool
* Function that does something
* @todo what does this function do?
*
- * @param $contactID
+ * @param int $contactID
* @param $contactType
* @param array $oldSubtypeSet
* @param array $newSubtypeSet
class CRM_Contact_BAO_Group extends CRM_Contact_DAO_Group {
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
}
/**
- * delete the group and all the object that connect to
+ * Delete the group and all the object that connect to
* this group. Incredibly destructive
*
* @param int $id group id
/**
* Get the list of member for a group id
*
- * @param $groupID
+ * @param int $groupID
* @param bool $useCache
*
* @return array $aMembers this array contains the list of members for this group id
}
/**
- * make sure that the user has permission to access this group
+ * Make sure that the user has permission to access this group
*
* @param int $id the id of the object
*
}
/**
- * given a saved search compute the clause and the tables
+ * Given a saved search compute the clause and the tables
* and store it for future use
*/
function buildClause() {
}
/**
- * update the is_active flag in the db
+ * Update the is_active flag in the db
*
* @param int $id id of the database record
* @param boolean $isActive value we want to set the is_active field
}
/**
- * build the condition to retrieve groups.
+ * Build the condition to retrieve groups.
*
* @param string $groupType type of group(Access/Mailing) OR the key of the group
* @param bool|\boolen $excludeHidden exclude hidden groups.
}
/**
- * get permission relevant clauses
+ * Get permission relevant clauses
* CRM-12209
*
* @param bool $force
}
/**
- * define action links
+ * Define action links
*
* @return array $links array of action links
* @access public
/**
* @param $whereClause
- * @param $whereParams
+ * @param array $whereParams
*
* @return string
*/
class CRM_Contact_BAO_GroupContact extends CRM_Contact_DAO_GroupContact {
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
}
/**
- * takes an associative array and creates a groupContact object
+ * Takes an associative array and creates a groupContact object
*
* the function extract all the params it needs to initialize the create a
* group object. the params array could contain additional unused name/value
}
/**
- * get list of all the groups and groups for a contact
+ * Get list of all the groups and groups for a contact
*
* @param int $contactId contact id
*
}
/**
- * get the list of groups for contact based on status of group membership
+ * Get the list of groups for contact based on status of group membership
*
* @param int $contactId contact id
* @param string $status state of membership
}
/**
- * takes an associative array and creates / removes
+ * Takes an associative array and creates / removes
* contacts from the groups
*
*
}
/**
- * @param $contactID
- * @param $groupID
+ * @param int $contactID
+ * @param int $groupID
*
* @return bool
*/
}
/**
- * @param $groupID
+ * @param int $groupID
*/
static function add($groupID) {
// first delete the current cache
}
/**
- * @param $groupID
+ * @param int $groupID
* @param $values
*/
static function store(&$groupID, &$values) {
}
/**
- * load the smart group cache for a saved search
+ * Load the smart group cache for a saved search
*
* @param object $group - the smart group that needs to be loaded
* @param boolean $force - should we force a search through
private $_alreadyStyled = FALSE;
/**
- * class constructor
+ * Class constructor
*/
function __construct($styleLabels = FALSE, $styleIndent = " -- ") {
parent::__construct();
}
/**
- * @param $contactId
- * @param $parentGroupId
+ * @param int $contactId
+ * @param int $parentGroupId
*
* @return array
*/
/**
* @param $tree
- * @param $id
+ * @param int $id
*
* @return bool
*/
}
/**
- * @param $id
+ * @param int $id
* @param $groups
*
* @return array
/**
* @param $potential
* @param $tree
- * @param $id
+ * @param int $id
* @param $token
*/
static function invalidate(&$potential, &$tree, $id, $token) {
/**
* @param $all
* @param $tree
- * @param $id
+ * @param int $id
* @param $token
*/
static function getAll(&$all, &$tree, $id, $token) {
class CRM_Contact_BAO_GroupOrganization extends CRM_Contact_DAO_GroupOrganization {
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
}
/**
- * takes an associative array and creates a groupOrganization object
+ * Takes an associative array and creates a groupOrganization object
*
* @param array $params (reference ) an assoc array of name/value pairs
*
}
/**
- * @param $groupID
+ * @param int $groupID
* @param $defaults
*/
static function retrieve($groupID, &$defaults) {
}
/**
- * delete Group Organization
+ * Delete Group Organization
*
* @param int $groupOrganizationID group organization id that needs to be deleted
*
}
/**
- * update the household with primary contact id
+ * Update the household with primary contact id
*
* @param integer $primaryContactId null if deleting primary contact
* @param integer $contactId contact id
}
/**
- * regenerates display_name for contacts with given prefixes/suffixes
+ * Regenerates display_name for contacts with given prefixes/suffixes
*
* @param array $ids the array with the prefix/suffix id governing which contacts to regenerate
* @param int $action the action describing whether prefix/suffix was UPDATED or DELETED
}
/**
- * creates display name
+ * Creates display name
*
* @return string the constructed display name
*/
MODE_MAILING = 16384;
/**
- * the default set of return properties
+ * The default set of return properties
*
* @var array
* @static
static $_defaultReturnProperties = NULL;
/**
- * the default set of hier return properties
+ * The default set of hier return properties
*
* @var array
* @static
static $_defaultHierReturnProperties;
/**
- * the set of input params
+ * The set of input params
*
* @var array
*/
public $_sort;
/**
- * the set of output params
+ * The set of output params
*
* @var array
*/
public $_returnProperties;
/**
- * the select clause
+ * The select clause
*
* @var array
*/
public $_select;
/**
- * the name of the elements that are in the select clause
+ * The name of the elements that are in the select clause
* used to extract the values
*
* @var array
public $_element;
/**
- * the tables involved in the query
+ * The tables involved in the query
*
* @var array
*/
public $_tables;
/**
- * the table involved in the where clause
+ * The table involved in the where clause
*
* @var array
*/
public $_whereTables;
/**
- * the where clause
+ * The where clause
*
* @var array
*/
public $_where;
/**
- * the where string
+ * The where string
*
* @var string
*
public $_whereClause;
/**
- * additional permission Where Clause
+ * Additional permission Where Clause
*
* @var string
*
public $_permissionWhereClause;
/**
- * the from string
+ * The from string
*
* @var string
*
public $_fromClause;
/**
- * additional permission from clause
+ * Additional permission from clause
*
* @var string
*
public $_permissionFromClause;
/**
- * the from clause for the simple select and alphabetical
+ * The from clause for the simple select and alphabetical
* select
*
* @var string
public $_simpleFromClause;
/**
- * the having values
+ * The having values
*
* @var string
*
public $_options;
/**
- * are we in search mode
+ * Are we in search mode
*
* @var boolean
*/
public $_search = TRUE;
/**
- * should we skip permission checking
+ * Should we skip permission checking
*
* @var boolean
*/
public $_skipPermission = FALSE;
/**
- * should we skip adding of delete clause
+ * Should we skip adding of delete clause
*
* @var boolean
*/
public $_skipDeleteClause = FALSE;
/**
- * are we in strict mode (use equality over LIKE)
+ * Are we in strict mode (use equality over LIKE)
*
* @var boolean
*/
public $_primaryLocation = TRUE;
/**
- * are contact ids part of the query
+ * Are contact ids part of the query
*
* @var boolean
*/
public $_displayRelationshipType = NULL;
/**
- * reference to the query object for custom values
+ * Reference to the query object for custom values
*
* @var Object
*/
public $_customQuery;
/**
- * should we enable the distinct clause, used if we are including
+ * Should we enable the distinct clause, used if we are including
* more than one group
*
* @var boolean
public $_useGroupBy = FALSE;
/**
- * the relationship type direction
+ * The relationship type direction
*
* @var array
* @static
static $_relType;
/**
- * the activity role
+ * The activity role
*
* @var array
* @static
static $_withContactActivitiesOnly;
/**
- * use distinct component clause for component searches
+ * Use distinct component clause for component searches
*
* @var string
*/
public $_rowCountClause;
/**
- * use groupBy component clause for component searches
+ * Use groupBy component clause for component searches
*
* @var string
*/
public $_pseudoConstantsSelect = array();
/**
- * class constructor which also does all the work
+ * Class constructor which also does all the work
*
* @param array $params
* @param array $returnProperties
}
/**
- * function which actually does all the work for the constructor
+ * Function which actually does all the work for the constructor
*
* @return void
* @access private
}
/**
- * generate the query based on what type of query we need
+ * Generate the query based on what type of query we need
*
* @param boolean $count
* @param boolean $sortByChar
}
/**
- * @param $name
+ * @param string $name
* @param $grouping
*
* @return null
}
/**
- * @param $id
+ * @param int $id
* @param $values
* @param int $wildcard
* @param bool $useEquals
}
/**
- * getter for tables array
+ * Getter for tables array
*
* @return array
* @access public
}
/**
- * generate the where clause (used in match contacts and permissions)
+ * Generate the where clause (used in match contacts and permissions)
*
* @param array $params
* @param array $fields
}
/**
- * create the from clause
+ * Create the from clause
*
* @param array $tables tables that need to be included in this from clause
* if null, return mimimal from clause (i.e. civicrm_contact)
}
/**
- * where / qill clause for contact_type
+ * Where / qill clause for contact_type
*
* @param $values
*
}
/**
- * where / qill clause for contact_sub_type
+ * Where / qill clause for contact_sub_type
*
* @param $values
*
}
/**
- * where / qill clause for groups
+ * Where / qill clause for groups
*
* @param $values
*
}
/**
- * where / qill clause for smart groups
+ * Where / qill clause for smart groups
*
* @param $values
*
}
/**
- * where / qill clause for cms users
+ * Where / qill clause for cms users
*
* @param $values
*
}
/**
- * all tag search specific
+ * All tag search specific
*
* @param $values
*
}
/**
- * where / qill clause for tag
+ * Where / qill clause for tag
*
* @param $values
*
}
/**
- * where/qill clause for notes
+ * Where/qill clause for notes
*
* @param $values
*
}
/**
- * @param $name
+ * @param string $name
* @param $op
* @param $grouping
*
}
/**
- * where / qill clause for sort_name
+ * Where / qill clause for sort_name
*
* @param $values
*
}
/**
- * where / qill clause for email
+ * Where / qill clause for email
*
* @param $values
*
}
/**
- * where / qill clause for phone number
+ * Where / qill clause for phone number
*
* @param $values
*
}
/**
- * where / qill clause for phone type/location
+ * Where / qill clause for phone type/location
*
* @param $values
*
}
/**
- * where / qill clause for street_address
+ * Where / qill clause for street_address
*
* @param $values
*
}
/**
- * where / qill clause for street_unit
+ * Where / qill clause for street_unit
*
* @param $values
*
}
/**
- * where / qill clause for sorting by character
+ * Where / qill clause for sorting by character
*
* @param $values
*
}
/**
- * where / qill clause for including contact ids
+ * Where / qill clause for including contact ids
*
* @return void
* @access public
}
/**
- * where / qill clause for postal code
+ * Where / qill clause for postal code
*
* @param $values
*
}
/**
- * where / qill clause for location type
+ * Where / qill clause for location type
*
* @param $values
* @param null $status
}
/**
- * where / qill clause for county (if present)
+ * Where / qill clause for county (if present)
*
* @param $values
* @param null $status
}
/**
- * where / qill clause for state/province AND country (if present)
+ * Where / qill clause for state/province AND country (if present)
*
* @param $values
* @param null $status
}
/**
- * where / qill clause for change log
+ * Where / qill clause for change log
*
* @param $values
*
}
/**
- * where / qill clause for relationship
+ * Where / qill clause for relationship
*
* @param $values
*
}
/**
- * default set of return properties
+ * Default set of return properties
*
* @param int $mode
*
}
/**
- * get primary condition for a sql clause
+ * Get primary condition for a sql clause
*
* @param int $value
*
}
/**
- * wrapper for a simple search query
+ * Wrapper for a simple search query
*
* @param array $params
* @param array $returnProperties
}
/**
- * create and query the db for an contact search
+ * Create and query the db for an contact search
*
* @param int $offset the offset for the query
* @param int $rowCount the number of rows to return
}
/**
- * getter for the qill object
+ * Getter for the qill object
*
* @return string
* @access public
}
/**
- * default set of return default hier return properties
+ * Default set of return default hier return properties
*
* @return array
* @access public
/**
* @param $values
- * @param $tableName
- * @param $fieldName
- * @param $dbFieldName
+ * @param string $tableName
+ * @param string $fieldName
+ * @param string $dbFieldName
* @param $fieldTitle
* @param bool $appendTimeStamp
*/
/**
* @param $values
- * @param $tableName
- * @param $fieldName
- * @param $dbFieldName
+ * @param string $tableName
+ * @param string $fieldName
+ * @param string $dbFieldName
* @param $fieldTitle
* @param null $options
*/
}
/**
- * check and explode a user defined numeric string into an array
+ * Check and explode a user defined numeric string into an array
* this was the protocol used by search builder in the old old days before we had
* super nice js widgets to do the hard work
*
}
/**
- * convert the pseudo constants id's to their names
+ * Convert the pseudo constants id's to their names
*
* @param CRM_Core_DAO dao
* @param bool $return
}
/**
- * include pseudo fields LEFT JOIN
+ * Include pseudo fields LEFT JOIN
* @param string|array $sort can be a object or string
*
* @return array
protected $_queryObjects = NULL;
/**
- * singleton function used to manage this object
+ * Singleton function used to manage this object
*
* @return object
* @static
/**
* @param $query
- * @param $fnName
+ * @param string $fnName
*/
public function alterSearchQuery(&$query, $fnName) {
foreach (self::getSearchQueryObjects() as $obj) {
}
/**
- * @param $fieldName
+ * @param string $fieldName
* @param $mode
* @param $side
*
abstract public function &getFields();
/**
- * @param $fieldName
+ * @param string $fieldName
* @param $mode
* @param $side
*
class CRM_Contact_BAO_Relationship extends CRM_Contact_DAO_Relationship {
/**
- * various constants to indicate different type of relationships
+ * Various constants to indicate different type of relationships
*
* @var int
*/
CONST PAST = 1, DISABLED = 2, CURRENT = 4, INACTIVE = 8;
/**
- * takes an associative array and creates a relationship object
+ * Takes an associative array and creates a relationship object
*
*
* @param array $params (reference ) an assoc array of name/value pairs
}
/**
- * get get list of relationship type based on the contact type.
+ * Get get list of relationship type based on the contact type.
*
* @param int $contactId this is the contact id of the current contact.
* @param null $contactSuffix
}
/**
- * @param $id
+ * @param int $id
* @param $action
*
* @return CRM_Contact_DAO_Relationship
}
/**
- * delete the relationship
+ * Delete the relationship
*
* @param int $id relationship id
*
}
/**
- * disable/enable the relationship
+ * Disable/enable the relationship
*
* @param int $id relationship id
*
}
/**
- * Function to get the other contact in a relationship
+ * Get the other contact in a relationship
*
* @param int $id relationship id
*
}
/**
- * Function to check if the relationship type selected between two contacts is correct
+ * Check if the relationship type selected between two contacts is correct
*
* @param int $contact_a 1st contact id
* @param int $contact_b 2nd contact id
}
/**
- * this function does the validtion for valid relationship
+ * This function does the validtion for valid relationship
*
* @param array $params this array contains the values there are subitted by the form
* @param array $ids the array that holds all the db ids
}
/**
- * this function checks for duplicate relationship
+ * This function checks for duplicate relationship
*
* @param array $params (reference ) an assoc array of name/value pairs
* @param integer $id this the id of the contact whom we are adding relationship
}
/**
- * update the is_active flag in the db
+ * 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
}
/**
- * helper function to form the sql for relationship retrieval
+ * Helper function to form the sql for relationship retrieval
*
* @param int $contactId contact id
* @param int $status (check const at top of file)
* @param int $numRelationship no of relationships to display (limit)
* @param int $count get the no of relationships
* $param int $relationshipId relationship id
- * @param $relationshipId
+ * @param int $relationshipId
* @param string $direction the direction we are interested in a_b or b_a
* @param array $params array of extra values including relationship_type_id per api spec
*
}
/**
- * Function to get get list of relationship type based on the target contact type.
+ * Get get list of relationship type based on the target contact type.
*
* @param string $targetContactType it's valid contact tpye(may be Individual , Organization , Household)
*
}
/**
- * Function to create / update / delete membership for related contacts.
+ * Create / update / delete membership for related contacts.
*
* This function will create/update/delete membership for related
* contact based on 1) contact have active membership 2) that
}
/**
- * Function to get Current Employer for Contact
+ * Get Current Employer for Contact
*
* @param $contactIds Contact Ids
*
}
/**
- * Function to return list of permissioned employer for a given contact.
+ * Return list of permissioned employer for a given contact.
*
* @param $contactID int contact id whose employers
* are to be found.
class CRM_Contact_BAO_RelationshipType extends CRM_Contact_DAO_RelationshipType {
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
}
/**
- * update the is_active flag in the db
+ * 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
}
/**
- * add the relationship type in the db
+ * Add the relationship type in the db
*
* @param array $params (reference ) an assoc array of name/value pairs
* @param array $ids the array that holds all the db ids
}
/**
- * delete Relationship Types
+ * Delete Relationship Types
*
* @param int $relationshipTypeId
*
class CRM_Contact_BAO_SavedSearch extends CRM_Contact_DAO_SavedSearch {
/**
- * class constructor
+ * Class constructor
*
* @return \CRM_Contact_BAO_SavedSearch CRM_Contact_BAO_SavedSearch
*/
}
/**
- * query the db for all saved searches.
+ * Query the db for all saved searches.
*
* @return array $aSavedSearch - contains the search name as value and and id as key
*
}
/**
- * given an id, extract the formValues of the saved search
+ * Given an id, extract the formValues of the saved search
*
* @param int $id the id of the saved search
*
}
/**
- * @param $id
+ * @param int $id
*
* @return array
*/
}
/**
- * get the where clause for a saved search
+ * Get the where clause for a saved search
*
* @param int $id saved search id
* @param array $tables (reference ) add the tables that are needed for the select clause
}
/**
- * @param $id
+ * @param int $id
*
* @return string
*/
}
/**
- * @param $id
+ * @param int $id
*
* @return array
*/
}
/**
- * given a saved search compute the clause and the tables
+ * Given a saved search compute the clause and the tables
* and store it for future use
*/
function buildClause() {
}
/**
- * given an id, get the name of the saved search
+ * Given an id, get the name of the saved search
*
* @param int $id the id of the saved search
*
class CRM_Contact_BAO_SearchCustom {
/**
- * @param $csID
- * @param null $ssID
- * @param null $gID
+ * @param int $csID
+ * @param int $ssID
+ * @param int $gID
*
* @return array
* @throws Exception
}
/**
- * @param $csID
- * @param $ssID
+ * @param int $csID
+ * @param int $ssID
*
* @return mixed
* @throws Exception
}
/**
- * @param $csID
- * @param $ssID
+ * @param int $csID
+ * @param int $ssID
*
* @return mixed
*/
}
/**
- * @param $csID
- * @param $ssID
+ * @param int $csID
+ * @param int $ssID
*
* @return array
*/
*/
class CRM_Contact_BAO_SubscriptionHistory extends CRM_Contact_DAO_SubscriptionHistory {
/**
- * class constructor
+ * Class constructor
*
* @access public
* @return \CRM_Contact_DAO_SubscriptionHistory
class CRM_Contact_Controller_Search extends CRM_Core_Controller {
/**
- * class constructor
+ * Class constructor
*/
function __construct($title = NULL, $modal = TRUE, $action = CRM_Core_Action::NONE) {
parent::__construct($title, $modal);
static $_suffix = '.php';
/**
- * @param $className
+ * @param string $className
*
* @return mixed
*/
public $_contactId;
/**
- * the default group id passed in via the url
+ * The default group id passed in via the url
*
* @var int
*/
public $_gid;
/**
- * the default tag id passed in via the url
+ * The default tag id passed in via the url
*
* @var int
*/
public $_tid;
/**
- * name of de-dupe button
+ * Name of de-dupe button
*
* @var string
* @access protected
protected $_dedupeButtonName;
/**
- * name of optional save duplicate button
+ * Name of optional save duplicate button
*
* @var string
* @access protected
public $_parseStreetAddress;
/**
- * check contact has a subtype or not
+ * Check contact has a subtype or not
*/
public $_isContactSubType;
public $_preEditValues;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * do the set default related to location type id,
+ * Do the set default related to location type id,
* primary location, default country
*
*/
}
/**
- * global validation rules for the form
+ * 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
}
/**
- * is there any real significant data in the hierarchical location array
+ * Is there any real significant data in the hierarchical location array
*
* @param array $fields the hierarchical value representation of this location
*
}
/**
- * that checks for duplicate contacts
+ * That checks for duplicate contacts
*
* @param array $fields fields array which are submitted
* @param $errors
}
/**
- * check parse result and if some address block fails then this
+ * Check parse result and if some address block fails then this
* function return the status message for all address blocks.
*
* @param $parseResult an array of address blk instance and its status.
protected $_tableId;
/**
- * entity type of the table id
+ * Entity type of the table id
*
* @var string
*/
protected $_entityType;
/**
- * entity sub type of the table id
+ * Entity sub type of the table id
*
* @var string
* @access protected
protected $_entitySubType;
/**
- * the group tree data
+ * The group tree data
*
* @var array
*/
protected $_groupCollapseDisplay;
/**
- * custom group id
+ * Custom group id
*
* @int
* @access public
public $_copyValueId;
/**
- * pre processing work done here.
+ * Pre processing work done here.
*
* gets session variables for table name, id of entity in table, type of entity and stores them.
*
class CRM_Contact_Form_DedupeFind extends CRM_Admin_Form {
/**
- * defined defaults
+ * Defined defaults
*
*/
public $_defaults;
/**
- * pre processing
+ * Pre processing
*
* @return void
* @access public
protected $_rgid;
/**
- * pre processing
+ * Pre processing
*
* @return void
* @access public
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $fields posted values of the form
*
class CRM_Contact_Form_Domain extends CRM_Core_Form {
/**
- * the group id, used when editing a group
+ * The group id, used when editing a group
*
* @var int
*/
protected $_id;
/**
- * the contact_id of domain
+ * The contact_id of domain
*
* @var int
*/
protected $_contactId;
/**
- * default from email address option value id.
+ * Default from email address option value id.
*
* @var int
*/
protected $_fromEmailId = NULL;
/**
- * default location type fields
+ * Default location type fields
*
* @var array
*/
protected $_locationDefaults = array();
/**
- * how many locationBlocks should we display?
+ * How many locationBlocks should we display?
*
* @var int
* @const
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $fields posted values of the form
*
class CRM_Contact_Form_Edit_Address {
/**
- * build form for address input fields
+ * Build form for address input fields
*
* @param CRM_Core_Form $form
* @param int $addressBlockCount - the index of the address array (if multiple addresses on a page)
}
/**
- * check for correct state / country mapping.
+ * Check for correct state / country mapping.
*
* @param $fields
* @param $files
}
/**
- * set default values for address block
+ * Set default values for address block
*
* @param array $defaults defaults associated array
* @param CRM_Core_Form $form form object
class CRM_Contact_Form_Edit_CommunicationPreferences {
/**
- * greetings
+ * Greetings
* @var array
* @static
*/
}
/**
- * global form rule
+ * Global form rule
*
* @param array $fields the input form values
* @param array $files the uploaded files if any
class CRM_Contact_Form_Edit_CustomData {
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @param CRM_Core_Form $form
*
}
/**
- * add rule for household
+ * Add rule for household
*
* @param array $fields array of form values
* @param array $files - unused
}
/**
- * global form rule
+ * Global form rule
*
* @param array $fields the input form values
* @param array $files the uploaded files if any
- * @param null $contactID
+ * @param int $contactID
*
* @return true if no errors, else array of errors
* @access public
*
* @param array $fields the input form values
* @param array $files the uploaded files if any
- * @param null $contactID
+ * @param int $contactID
*
* @return true if no errors, else array of errors
* @access public
/**
* @param $fields
* @param $files
- * @param null $contactID
+ * @param int $contactID
*
* @return array|bool
*/
class CRM_Contact_Form_Edit_TagsAndGroups {
/**
- * constant to determine which forms we are generating
+ * Constant to determine which forms we are generating
*
* Used by both profile and edit contact
*/
}
/**
- * set defaults for relevant form elements
+ * Set defaults for relevant form elements
*
* @param int $id the contact id
* @param array $defaults the defaults array to store the values in
class CRM_Contact_Form_Inline_Address extends CRM_Contact_Form_Inline {
/**
- * location block no
+ * Location block no
*/
private $_locBlockNo;
public $_parseStreetAddress;
/**
- * store address values
+ * Store address values
*/
public $_values;
/**
- * form action
+ * Form action
*/
public $_action;
/**
- * address id
+ * Address id
*/
public $_addressId;
}
/**
- * call preprocess
+ * Call preprocess
*/
public function preProcess() {
parent::preProcess();
}
/**
- * set defaults for the form
+ * Set defaults for the form
*
* @return array
* @access public
}
/**
- * process the form
+ * Process the form
*
* @return void
* @access public
}
/**
- * set defaults for the form
+ * Set defaults for the form
*
* @return array
* @access public
}
/**
- * process the form
+ * Process the form
*
* @return void
* @access public
}
/**
- * set defaults for the form
+ * Set defaults for the form
*
* @return array
* @access public
}
/**
- * process the form
+ * Process the form
*
* @return void
* @access public
}
/**
- * process the form
+ * Process the form
*
* @return void
* @access public
class CRM_Contact_Form_Inline_CustomData extends CRM_Contact_Form_Inline {
/**
- * custom group id
+ * Custom group id
*
* @int
* @access public
public $_groupID;
/**
- * entity type of the table id
+ * Entity type of the table id
*
* @var string
*/
protected $_entityType;
/**
- * call preprocess
+ * Call preprocess
*/
public function preProcess() {
parent::preProcess();
}
/**
- * set defaults for the form
+ * Set defaults for the form
*
* @return array
* @access public
}
/**
- * process the form
+ * Process the form
*
* @return void
* @access public
}
/**
- * process the form
+ * Process the form
*
* @return void
* @access public
class CRM_Contact_Form_Inline_Email extends CRM_Contact_Form_Inline {
/**
- * email addresses of the contact that is been viewed
+ * Email addresses of the contact that is been viewed
*/
private $_emails = array();
private $_blockCount = 6;
/**
- * call preprocess
+ * Call preprocess
*/
public function preProcess() {
parent::preProcess();
}
/**
- * global validation rules for the form
+ * 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
}
/**
- * set defaults for the form
+ * Set defaults for the form
*
* @return array
* @access public
}
/**
- * process the form
+ * Process the form
*
* @return void
* @access public
class CRM_Contact_Form_Inline_IM extends CRM_Contact_Form_Inline {
/**
- * ims of the contact that is been viewed
+ * Ims of the contact that is been viewed
*/
private $_ims = array();
private $_blockCount = 6;
/**
- * call preprocess
+ * Call preprocess
*/
public function preProcess() {
parent::preProcess();
}
/**
- * global validation rules for the form
+ * 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
}
/**
- * set defaults for the form
+ * Set defaults for the form
*
* @return array
* @access public
}
/**
- * process the form
+ * Process the form
*
* @return void
* @access public
*
* @param array $fields the input form values
* @param array $files the uploaded files if any
- * @param null $contactID
+ * @param int $contactID
*
* @return true if no errors, else array of errors
* @access public
/**
* Return any post-save data
*
- * @param $contactID
+ * @param int $contactID
*
* @return array extra options to return in JSON
*/
class CRM_Contact_Form_Inline_OpenID extends CRM_Contact_Form_Inline {
/**
- * ims of the contact that is been viewed
+ * Ims of the contact that is been viewed
*/
private $_openids = array();
private $_blockCount = 6;
/**
- * call preprocess
+ * Call preprocess
*/
public function preProcess() {
parent::preProcess();
}
/**
- * global validation rules for the form
+ * 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
}
/**
- * set defaults for the form
+ * Set defaults for the form
*
* @return array
* @access public
}
/**
- * process the form
+ * Process the form
*
* @return void
* @access public
class CRM_Contact_Form_Inline_Phone extends CRM_Contact_Form_Inline {
/**
- * phones of the contact that is been viewed
+ * Phones of the contact that is been viewed
*/
private $_phones = array();
private $_blockCount = 6;
/**
- * call preprocess
+ * Call preprocess
*/
public function preProcess() {
parent::preProcess();
}
/**
- * global validation rules for the form
+ * 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
}
/**
- * set defaults for the form
+ * Set defaults for the form
*
* @return array
* @access public
}
/**
- * process the form
+ * Process the form
*
* @return void
* @access public
class CRM_Contact_Form_Inline_Website extends CRM_Contact_Form_Inline {
/**
- * websitess of the contact that is been viewed
+ * Websitess of the contact that is been viewed
*/
private $_websites = array();
private $_blockCount = 6;
/**
- * call preprocess
+ * Call preprocess
*/
public function preProcess() {
parent::preProcess();
}
/**
- * set defaults for the form
+ * Set defaults for the form
*
* @return array
* @access public
}
/**
- * process the form
+ * Process the form
*
* @return void
* @access public
class CRM_Contact_Form_Location {
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @param CRM_Core_Form $form
*
protected $_mode;
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @param CRM_Core_Form $form
*
}
/**
- * build form for honoree contact / on behalf of organization.
+ * Build form for honoree contact / on behalf of organization.
*
* @param CRM_Core_Form $form
*
public $_contactId;
/**
- * form defaults
+ * Form defaults
*
* @var array
*/
protected $_defaults = array();
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
public $_relationshipTypeId;
/**
- * an array of all relationship names
+ * An array of all relationship names
*
* @var array
*/
public $_values;
/**
- * casid if it called from case context
+ * Casid if it called from case context
*/
public $_caseId;
}
/**
- * date validation
+ * Date validation
*
* @param array $params (reference ) an assoc array of name/value pairs
*
static $_validContext = NULL;
/**
- * list of values used when we want to display other objects
+ * List of values used when we want to display other objects
*
* @var array
* @static
protected $_contextMenu;
/**
- * the groupId retrieved from the GET vars
+ * The groupId retrieved from the GET vars
*
* @var int
* @access public
public $_groupID;
/**
- * the Group ID belonging to Add Member to group ID
+ * The Group ID belonging to Add Member to group ID
* retrieved from the GET vars
*
* @var int
protected $_amtgID;
/**
- * the saved search ID retrieved from the GET vars
+ * The saved search ID retrieved from the GET vars
*
* @var int
* @access protected
protected $_ssID;
/**
- * the group elements
+ * The group elements
*
* @var array
* @access public
public $_groupIterator;
/**
- * the tag elements
+ * The tag elements
*
* @var array
* @access protected
protected $_ufGroupID;
/**
- * csv - common search values
+ * Csv - common search values
*
* @var array
* @access protected
protected $_modeValue;
/**
- * name of the selector to use
+ * Name of the selector to use
*/
static $_selectorName = 'CRM_Contact_Selector';
protected $_customSearchID = NULL;
protected $_openedPanes = array();
/**
- * define the set of valid contexts that the search form operates on
+ * Define the set of valid contexts that the search form operates on
*
* @return array the valid context set and the titles
* @access protected
}
/**
- * processing needed for buildForm and later
+ * Processing needed for buildForm and later
*
* @return void
* @access public
class CRM_Contact_Form_Search_Advanced extends CRM_Contact_Form_Search {
/**
- * processing needed for buildForm and later
+ * Processing needed for buildForm and later
*
* @return void
* @access public
}
/**
- * normalize the form values to make it look similar to the advanced form values
+ * Normalize the form values to make it look similar to the advanced form values
* this prevents a ton of work downstream and allows us to use the same code for
* multiple purposes (queries, save/edit etc)
*
}
/**
- * normalize default values for multiselect plugins
+ * Normalize default values for multiselect plugins
*
* @param $defaults array
* @return array
}
/**
- * processing needed for buildForm and later
+ * Processing needed for buildForm and later
*
* @return void
* @access public
}
/**
- * this method is called for processing a submitted search form
+ * This method is called for processing a submitted search form
*
* @return void
* @access public
}
/**
- * normalize the form values to make it look similar to the advanced form values
+ * Normalize the form values to make it look similar to the advanced form values
* this prevents a ton of work downstream and allows us to use the same code for
* multiple purposes (queries, save/edit etc)
*
class CRM_Contact_Form_Search_Builder extends CRM_Contact_Form_Search {
/**
- * number of columns in where
+ * Number of columns in where
*
* @var int
* @access public
public $_columnCount;
/**
- * number of blocks to be shown
+ * Number of blocks to be shown
*
* @var int
* @access public
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param $values
* @param $files
*/
class CRM_Contact_Form_Search_Criteria {
/**
- * @param $form CRM_Core_Form
+ * @param CRM_Core_Form $form
*/
static function basic(&$form) {
$form->addElement('hidden', 'hidden_basic', 1);
}
/**
- * normalize the form values to make it look similar to the advanced form values
+ * Normalize the form values to make it look similar to the advanced form values
* this prevents a ton of work downstream and allows us to use the same code for
* multiple purposes (queries, save/edit etc)
*
}
/**
- * get contribution ids in entity tables.
+ * Get contribution ids in entity tables.
*
* @param string $queryText
* @param string $entityIDTableName
}
/**
- * get membership ids in entity tables.
+ * Get membership ids in entity tables.
*
* @param string $queryText
* @param string $entityIDTableName
}
/**
- * get participant ids in entity tables.
+ * Get participant ids in entity tables.
*
* @param string $queryText
* @param string $entityIDTableName
}
/**
- * @param null $eventID
+ * @param int $eventID
*
* @return Object
*/
class CRM_Contact_Form_Task extends CRM_Core_Form {
/**
- * the task being performed
+ * The task being performed
*
* @var int
*/
static protected $_searchFormValues;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @param
*
}
/**
- * get the contact id for custom search
+ * Get the contact id for custom search
* we are not using prev/next table incase of custom search
*/
public function getContactIds() {
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
}
/**
- * simple shell that derived classes can call to add buttons to
+ * Simple shell that derived classes can call to add buttons to
* the form with a customized title for the main Submit
*
* @param string $title title of the main button
}
/**
- * replace ids of household members in $this->_contactIds with the id of their household.
+ * Replace ids of household members in $this->_contactIds with the id of their household.
* CRM-8338
*
* @access public
protected $_context;
/**
- * the groupId retrieved from the GET vars
+ * The groupId retrieved from the GET vars
*
* @var int
*/
protected $_id;
/**
- * the title of the group
+ * The title of the group
*
* @var string
*/
protected $_title;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $params
*
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
class CRM_Contact_Form_Task_AddToTag extends CRM_Contact_Form_Task {
/**
- * name of the tag
+ * Name of the tag
*
* @var string
*/
protected $_name;
/**
- * all the tags in the system
+ * All the tags in the system
*
* @var array
*/
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
class CRM_Contact_Form_Task_Batch extends CRM_Contact_Form_Task {
/**
- * the title of the group
+ * The title of the group
*
* @var string
*/
protected $_title;
/**
- * maximum contacts that should be allowed to update
+ * Maximum contacts that should be allowed to update
*
*/
protected $_maxContacts = 100;
/**
- * maximum profile fields that will be displayed
+ * Maximum profile fields that will be displayed
*
*/
protected $_maxFields = 9;
/**
- * variable to store redirect path
+ * Variable to store redirect path
*
*/
protected $_userContext;
/**
- * when not to reset sort_name
+ * When not to reset sort_name
*/
protected $_preserveDefault = TRUE;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * global form rule
+ * Global form rule
*
* @param array $fields the input form values
*
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
}
/**
- * parse street address
+ * Parse street address
* @param array $contactValues contact values
* @param CRM_Core_Form $form form object
*/
protected $_single = FALSE;
/**
- * cache shared address message so we don't query twice
+ * Cache shared address message so we don't query twice
*/
protected $_sharedAddressMessage = NULL;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * global form rule
+ * Global form rule
*
* @param array $fields the input form values
* @param array $files the uploaded files if any
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
public $_noEmails = FALSE;
/**
- * all the existing templates in the system
+ * All the existing templates in the system
*
* @var array
*/
public $_templates = NULL;
/**
- * store "to" contact details
+ * Store "to" contact details
* @var array
*/
public $_toContactDetails = array();
/**
- * store all selected contact id's, that includes to, cc and bcc contacts
+ * Store all selected contact id's, that includes to, cc and bcc contacts
* @var array
*/
public $_allContactIds = array();
/**
- * store only "to" contact ids
+ * Store only "to" contact ids
* @var array
*/
public $_toContactIds = array();
/**
- * store only "cc" contact ids
+ * Store only "cc" contact ids
* @var array
*/
public $_ccContactIds = array();
/**
- * store only "bcc" contact ids
+ * Store only "bcc" contact ids
* @var array
*/
public $_bccContactIds = array();
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
}
/**
- * form rule
+ * Form rule
*
* @param array $fields the input form values
* @param array $dontCare
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
class CRM_Contact_Form_Task_HookSample extends CRM_Contact_Form_Task {
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
class CRM_Contact_Form_Task_Label extends CRM_Contact_Form_Task {
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
return FALSE;
}
/**
- * create labels (pdf)
+ * Create labels (pdf)
*
* @param array $contactRows assciated array of contact data
* @param string $format format in which labels needs to be printed
}
/**
- * create the array of returnProperties
+ * Create the array of returnProperties
*
* @param string $format format for which return properties build
*
return FALSE;
}
/**
- * create labels (pdf)
+ * Create labels (pdf)
*
* @param array $contactRows assciated array of contact data
* @param string $format format in which labels needs to be printed
/**
- * get the rows for the labels
+ * Get the rows for the labels
*
* @param $contactIDs
* @param integer $locationTypeID
}
/**
- * extract the return properties from the mailing format
+ * Extract the return properties from the mailing format
* @todo I'm placing bets this is a duplicate of code elsewhere - find & merge
* @param unknown_type $format
* @return multitype:number
protected $_single = FALSE;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
public function postProcess() {}
/**
- * assign smarty variables to the template that will be used by google api to plot the contacts
+ * Assign smarty variables to the template that will be used by google api to plot the contacts
*
* @param $ids
* @param int $locationId location_id
class CRM_Contact_Form_Task_Map_Event extends CRM_Contact_Form_Task_Map {
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
class CRM_Contact_Form_Task_Merge extends CRM_Contact_Form_Task {
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
class CRM_Contact_Form_Task_PDF extends CRM_Contact_Form_Task {
/**
- * all the existing templates in the system
+ * All the existing templates in the system
*
* @var array
*/
public $_activityId = NULL;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
class CRM_Contact_Form_Task_PDFLetterCommon {
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @param CRM_Core_Form $form
*
/**
* @param CRM_Core_Form $form
- * @param $cid
+ * @param int $cid
*/
static function preProcessSingle(&$form, $cid) {
$form->_contactIds = array($cid);
}
/**
- * form rule
+ * Form rule
*
* @param array $fields the input form values
* @param array $dontCare
}
/**
- * part of the post process which prepare and extract information from the template
+ * Part of the post process which prepare and extract information from the template
*
* @access protected
*
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
class CRM_Contact_Form_Task_PickProfile extends CRM_Contact_Form_Task {
/**
- * the title of the group
+ * The title of the group
*
* @var string
*/
protected $_title;
/**
- * maximum contacts that should be allowed to update
+ * Maximum contacts that should be allowed to update
*
*/
protected $_maxContacts = 100;
/**
- * maximum profile fields that will be displayed
+ * Maximum profile fields that will be displayed
*
*/
protected $_maxFields = 9;
/**
- * variable to store redirect path
+ * Variable to store redirect path
*
*/
protected $_userContext;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $fields posted values of the form
*
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
class CRM_Contact_Form_Task_Print extends CRM_Contact_Form_Task {
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
protected $_context;
/**
- * the groupId retrieved from the GET vars
+ * The groupId retrieved from the GET vars
*
* @var int
*/
protected $_id;
/**
- * the title of the group
+ * The title of the group
*
* @var string
*/
protected $_title;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * global form rule
+ * Global form rule
*
* @param array $fields the input form values
* @param array $files the uploaded files if any
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
class CRM_Contact_Form_Task_RemoveFromTag extends CRM_Contact_Form_Task {
/**
- * name of the tag
+ * Name of the tag
*
* @var string
*/
protected $_name;
/**
- * all the tags in the system
+ * All the tags in the system
*
* @var array
*/
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
class CRM_Contact_Form_Task_Result extends CRM_Contact_Form_Task {
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
public $_single = FALSE;
/**
- * all the existing templates in the system
+ * All the existing templates in the system
*
* @var array
*/
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
}
/**
- * form rule
+ * Form rule
*
* @param array $fields the input form values
* @param array $dontCare
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
class CRM_Contact_Form_Task_SaveSearch extends CRM_Contact_Form_Task {
/**
- * saved search id if any
+ * Saved search id if any
*
* @var int
*/
protected $_id;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
class CRM_Contact_Form_Task_SaveSearch_Update extends CRM_Contact_Form_Task_SaveSearch {
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
class CRM_Contact_Form_Task_Unhold extends CRM_Contact_Form_Task {
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
protected $_contactId;
/**
- * contact.display_name of contact for whom we are adding user
+ * Contact.display_name of contact for whom we are adding user
*
* @var int
* @public
public $_displayName;
/**
- * primary email of contact for whom we are adding user
+ * Primary email of contact for whom we are adding user
*
* @var int
* @public
class CRM_Contact_Import_Controller extends CRM_Core_Controller {
/**
- * class constructor
+ * Class constructor
*/
function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) {
parent::__construct($title, $modal);
*/
/**
- * name of the field
+ * Name of the field
*/
public $_name;
/**
- * title of the field to be used in display
+ * Title of the field to be used in display
*/
public $_title;
/**
- * type of field
+ * Type of field
* @var enum
*/
public $_type;
/**
- * is this field required
+ * Is this field required
* @var boolean
*/
public $_required;
/**
- * data to be carried for use by a derived class
+ * Data to be carried for use by a derived class
* @var object
*/
public $_payload;
/**
- * regexp to match the CSV header of this column/field
+ * Regexp to match the CSV header of this column/field
* @var string
*/
public $_columnPattern;
/**
- * regexp to match the pattern of data from various column/fields
+ * Regexp to match the pattern of data from various column/fields
* @var string
*/
public $_dataPattern;
/**
- * regexp to match the pattern of header from various column/fields
+ * Regexp to match the pattern of header from various column/fields
* @var string
*/
public $_headerPattern;
/**
- * location type
+ * Location type
* @var int
*/
public $_hasLocationType;
/**
- * does this field have a phone type
+ * Does this field have a phone type
* @var string
*/
public $_phoneType;
/**
- * value of this field
+ * Value of this field
* @var object
*/
public $_value;
/**
- * does this field have a relationship info
+ * Does this field have a relationship info
* @var string
*/
public $_related;
/**
- * does this field have a relationship Contact Type
+ * Does this field have a relationship Contact Type
* @var string
*/
public $_relatedContactType;
/**
- * does this field have a relationship Contact Details
+ * Does this field have a relationship Contact Details
* @var string
*/
public $_relatedContactDetails;
/**
- * does this field have a related Contact info of Location Type
+ * Does this field have a related Contact info of Location Type
* @var int
*/
public $_relatedContactLocType;
/**
- * does this field have a related Contact info of Phone Type
+ * Does this field have a related Contact info of Phone Type
* @var string
*/
public $_relatedContactPhoneType;
/**
- * @param $name
+ * @param string $name
* @param $title
* @param int $type
* @param string $columnPattern
}
/**
- * the value is in string format. convert the value to the type of this field
+ * The value is in string format. convert the value to the type of this field
* and set the field value with the appropriate type
*/
function setValue($value) {
private $_dataSourceClass;
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
* Returns the name of the primary key and status columns
*
* @param $db
- * @param $importTableName
+ * @param string $importTableName
*
* @return array
* @access private
/**
- * an array of all contact fields with
+ * An array of all contact fields with
* formatted custom field names.
*
* @var array
protected $_formattedFieldNames;
/**
- * on duplicate
+ * On duplicate
*
* @var int
*/
}
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $fields posted values of the form
*
}
/**
- * format custom field name.
+ * Format custom field name.
* combine group and field name to avoid conflict.
*
* @param $fields
class CRM_Contact_Import_Form_Preview extends CRM_Import_Form_Preview {
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $fields posted values of the form
*
class CRM_Contact_Import_Form_Summary extends CRM_Import_Form_Summary {
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
/**
* @param $contactIds
- * @param $newGroupName
+ * @param string $newGroupName
* @param $newGroupDesc
*
* @return array|bool
/**
* @param $contactIds
- * @param $newTagName
+ * @param string $newTagName
* @param $newTagDesc
*
* @return array|bool
class CRM_Contact_Import_Page_AJAX {
/**
- * show import status
+ * Show import status
*/
static function status() {
// make sure we get an id
*/
/**
- * total number of lines in file
+ * Total number of lines in file
*/
protected $_rowCount;
/**
- * running total number of un matched Conact
+ * Running total number of un matched Conact
*/
protected $_unMatchCount;
/**
- * array of unmatched lines
+ * Array of unmatched lines
*/
protected $_unMatch;
/**
- * total number of contacts with unparsed addresses
+ * Total number of contacts with unparsed addresses
*/
protected $_unparsedAddressCount;
/**
- * filename of mismatch data
+ * Filename of mismatch data
*
* @var string
*/
protected $_statusFieldName;
/**
- * on duplicate
+ * On duplicate
*
* @var int
*/
public $_onDuplicate;
/**
- * dedupe rule group id to use if set
+ * Dedupe rule group id to use if set
*
* @var int
*/
public $_dedupeRuleGroupID = NULL;
/**
- * @param $tableName
+ * @param string $tableName
* @param $mapper
* @param int $mode
* @param int $contactType
* @param string $primaryKeyName
* @param string $statusFieldName
* @param int $onDuplicate
- * @param null $statusID
+ * @param int $statusID
* @param null $totalRowCount
* @param bool $doGeocodeAddress
* @param int $timeout
* @param null $contactSubType
- * @param null $dedupeRuleGroupID
+ * @param int $dedupeRuleGroupID
*
* @return mixed
*/
}
/**
- * set IM Service Provider type fields
+ * Set IM Service Provider type fields
*
* @param array $elements IM service provider type ids
*
}
/**
- * set IM Service Provider type fields for related contacts
+ * Set IM Service Provider type fields for related contacts
*
* @param array $elements IM service provider type ids of related contact
*
}
/**
- * format the field values for input to the api
+ * Format the field values for input to the api
*
* @return array (reference ) associative array of name/value pairs
* @access public
}
/**
- * @param $name
+ * @param string $name
* @param $title
* @param int $type
* @param string $headerPattern
/**
* Export data to a CSV file
*
- * @param $fileName
+ * @param string $fileName
* @param array $header
* @param array $data
*
protected $_newContacts;
/**
- * line count id
+ * Line count id
*
* @var int
*/
protected $_newRelatedContacts;
/**
- * array of all the contacts whose street addresses are not parsed
+ * Array of all the contacts whose street addresses are not parsed
* of this import process
* @var array
*/
protected $_unparsedStreetAddressContacts;
/**
- * class constructor
+ * Class constructor
*/
function __construct(&$mapperKeys, $mapperLocType = NULL, $mapperPhoneType = NULL, $mapperImProvider = NULL, $mapperRelated = NULL, $mapperRelatedContactType = NULL, $mapperRelatedContactDetails = NULL, $mapperRelatedContactLocType = NULL, $mapperRelatedContactPhoneType = NULL, $mapperRelatedContactImProvider = NULL,
$mapperWebsiteType = NULL, $mapperRelatedContactWebsiteType = NULL
}
/**
- * the initializer code, called before the processing
+ * The initializer code, called before the processing
*
* @return void
* @access public
}
/**
- * handle the values in mapField mode
+ * Handle the values in mapField mode
*
* @param array $values the array of values belonging to this line
*
}
/**
- * handle the values in preview mode
+ * Handle the values in preview mode
*
* @param array $values the array of values belonging to this line
*
}
/**
- * handle the values in summary mode
+ * Handle the values in summary mode
*
* @param array $values the array of values belonging to this line
*
}
/**
- * handle the values in import mode
+ * Handle the values in import mode
*
* @param int $onDuplicate the code for what action to take on duplicates
* @param array $values the array of values belonging to this line
}
/**
- * the initializer code, called before the processing
+ * The initializer code, called before the processing
*
* @return void
* @access public
function fini() {}
/**
- * check if an error in custom data
+ * Check if an error in custom data
*
* @param array $params
* @param String $errorMessage A string containing all the error-fields.
}
/**
- * check if an error in Core( non-custom fields ) field
+ * Check if an error in Core( non-custom fields ) field
*
* @param array $params
* @param String $errorMessage A string containing all the error-fields.
}
/**
- * ckeck a value present or not in a array
+ * Ckeck a value present or not in a array
*
* @param $value
* @param $valueArray
}
/**
- * function to build error-message containing error-fields
+ * Build error-message containing error-fields
*
* @param String $errorName A string containing error-field name.
* @param String $errorMessage A string containing all the error-fields, where the new errorName is concatenated.
}
/**
- * method for creating contact
+ * Method for creating contact
*
*
*/
}
/**
- * format params for update and fill mode
+ * Format params for update and fill mode
*
* @param $params array reference to an array containing all the
* values for import
}
/**
- * convert any given date string to default date array.
+ * Convert any given date string to default date array.
*
* @param array $params has given date-format
* @param array $formatted store formatted date in this array
}
/**
- * format common params data to proper format to store.
+ * Format common params data to proper format to store.
*
* @param array $params contain record values.
* @param array $formatted array of formatted data.
}
/**
- * Function to generate status and error message for unparsed street address records.
+ * Generate status and error message for unparsed street address records.
*
* @param array $values the array of values belonging to each row
* @param array $statusFieldName store formatted date in this array
}
/**
- * fetch PCP ID by PCP Supporter sort_name, also displays PCP title and associated Contribution Page title
+ * Fetch PCP ID by PCP Supporter sort_name, also displays PCP title and associated Contribution Page title
*/
static function getPCPList() {
$name = CRM_Utils_Array::value('s', $_GET);
}
/**
- * fetch the custom field help
+ * Fetch the custom field help
*/
static function customField() {
$fieldId = CRM_Utils_Type::escape($_REQUEST['id'], 'Integer');
}
/**
- * delete custom value
+ * Delete custom value
*
*/
static function deleteCustomValue() {
}
/**
- * Function to perform enable / disable actions on record.
+ * Perform enable / disable actions on record.
*
*/
static function enableDisable() {
}
/**
- * Function to retrieve signature based on email id
+ * Retrieve signature based on email id
*/
static function getSignature() {
$emailID = CRM_Utils_Type::escape($_REQUEST['emailID'], 'Positive');
}
/**
- * Function to process dupes.
+ * Process dupes.
*
*/
static function processDupes() {
}
/**
- * Function to retrieve a PDF Page Format for the PDF Letter form
+ * Retrieve a PDF Page Format for the PDF Letter form
*/
function pdfFormat() {
$formatId = CRM_Utils_Type::escape($_REQUEST['formatId'], 'Integer');
}
/**
- * Function to retrieve Paper Size dimensions
+ * Retrieve Paper Size dimensions
*/
static function paperSize() {
$paperSizeName = CRM_Utils_Type::escape($_REQUEST['paperSizeName'], 'String');
}
/**
- * @param $name
+ * @param string $name
*
* @return string
*/
}
/**
- * Function to retrieve contact relationships
+ * Retrieve contact relationships
*/
public static function getContactRelationships() {
$contactID = CRM_Utils_Type::escape($_GET['cid'], 'Integer');
}
/**
- * run this page (figure out the action needed and perform it).
+ * Run this page (figure out the action needed and perform it).
*
* @return void
*/
}
/**
- * @param $id
+ * @param int $id
*/
function delete($id) {
$ruleDao = new CRM_Dedupe_DAO_Rule();
static $_links = NULL;
/**
- * delete a saved search.
+ * Delete a saved search.
*
* @param int $id - id of saved search
*
}
/**
- * run this page (figure out the action needed and perform it).
+ * Run this page (figure out the action needed and perform it).
*
* @return void
*/
class CRM_Contact_Page_Task extends CRM_Core_Page {
/**
- * returns the page title
+ * Returns the page title
*
* @return string the title of the page
* @access public
class CRM_Contact_Page_View extends CRM_Core_Page {
/**
- * the id of the object being viewed (note/relationship etc)
+ * The id of the object being viewed (note/relationship etc)
*
* @int
* @access protected
protected $_id;
/**
- * the contact id of the contact being viewed
+ * The contact id of the contact being viewed
*
* @int
* @access protected
/**
* Get meta details of the contact.
*
- * @param $contactId
+ * @param int $contactId
*
* @return array contact fields in fixed order
* @access public
/**
* @param $page
- * @param null $contactID
+ * @param int $contactID
*/
static function checkUserPermission($page, $contactID = NULL) {
// check for permissions
}
/**
- * @param $contactId
+ * @param int $contactId
* @param bool $isDeleted
*
* @return string
class CRM_Contact_Page_View_CustomData extends CRM_Core_Page {
/**
- * the id of the object being viewed (note/relationship etc)
+ * The id of the object being viewed (note/relationship etc)
*
* @int
* @access protected
public $_groupId;
/**
- * class constructor
+ * Class constructor
*
* @return CRM_Contact_Page_View_CustomData
*/
}
/**
- * add a few specific things to view contact
+ * Add a few specific things to view contact
*
* @return void
* @access public
}
/**
- * remove/ rejoin the group
+ * Remove/ rejoin the group
*
* @param int $groupContactId id of crm_group_contact
* @param string $status this is the status that should be updated.
*
* $access public
- * @param $contactID
+ * @param int $contactID
*
* @return bool
*/
}
/**
- * delete the note object from the db
+ * Delete the note object from the db
*
* @return void
* @access public
static $_links = NULL;
/**
- * casid set if called from case context
+ * Casid set if called from case context
*
* @var int
*/
public $_contactId = NULL;
/**
- * always show public groups
+ * Always show public groups
* @var bool
*/
public $_onlyPublicGroups = TRUE;
}
/**
- * build user dashboard
+ * Build user dashboard
*
* @return void
* @access public
}
/**
- * perform actions and display for user dashboard
+ * Perform actions and display for user dashboard
*
* @return void
*
static $_links = NULL;
/**
- * we use desc to remind us what that column is, name is used in the tpl
+ * We use desc to remind us what that column is, name is used in the tpl
*
* @var array
* @static
);
/**
- * formValues is the array returned by exportValues called on
+ * FormValues is the array returned by exportValues called on
* the HTML_QuickForm_Controller for that page.
*
* @var array
protected $_contextMenu;
/**
- * params is the array in a value used by the search query creator
+ * Params is the array in a value used by the search query creator
*
* @var array
* @access protected
protected $_returnProperties;
/**
- * represent the type of selector
+ * Represent the type of selector
*
* @var int
* @access protected
protected $_query;
/**
- * group id
+ * Group id
*
* @var int
*/
protected $_ufGroupID;
/**
- * the public visible fields to be shown to the user
+ * The public visible fields to be shown to the user
*
* @var array
* @access protected
}
/**
- * getter for array of the parameters required for creating pager.
+ * Getter for array of the parameters required for creating pager.
*
* @param $action
* @param array $params
}
/**
- * returns the column headers as an array of tuples:
+ * Returns the column headers as an array of tuples:
* (name, sortName (key to the sort array))
*
* @param string $action the action being performed
}
/**
- * returns all the rows in the given offset and rowCount
+ * Returns all the rows in the given offset and rowCount
*
* @param enum $action the action being performed
* @param int $offset the row number to start from
}
/**
- * name of export file.
+ * Name of export file.
*
* @param string $output type of output
*
}
/**
- * get colunmn headers for search selector
+ * Get colunmn headers for search selector
*
*
* @return array $_columnHeaders
/**
* @param array $params
* @param $action
- * @param $sortID
+ * @param int $sortID
* @param null $displayRelationshipType
* @param string $queryOperator
*
*/
class CRM_Contact_Selector_Controller extends CRM_Core_Selector_Controller {
/**
- * default function for qill, if needed to be implemented, we
+ * Default function for qill, if needed to be implemented, we
* expect the subclass to do it
*
* @return string the status message
static $_links = NULL;
/**
- * we use desc to remind us what that column is, name is used in the tpl
+ * We use desc to remind us what that column is, name is used in the tpl
*
* @var array
* @static
static $_properties = array('contact_id', 'contact_type', 'display_name');
/**
- * formValues is the array returned by exportValues called on
+ * FormValues is the array returned by exportValues called on
* the HTML_QuickForm_Controller for that page.
*
* @var array
public $_formValues;
/**
- * params is the array in a value used by the search query creator
+ * Params is the array in a value used by the search query creator
*
* @var array
* @access protected
public $_params;
/**
- * represent the type of selector
+ * Represent the type of selector
*
* @var int
* @access protected
protected $_query;
/**
- * the public visible fields to be shown to the user
+ * The public visible fields to be shown to the user
*
* @var array
* @access protected
}
/**
- * getter for array of the parameters required for creating pager.
+ * Getter for array of the parameters required for creating pager.
*
* @param $action
* @param array $params
}
/**
- * returns the column headers as an array of tuples:
+ * Returns the column headers as an array of tuples:
* (name, sortName (key to the sort array))
*
* @param string $action the action being performed
}
/**
- * returns all the rows in the given offset and rowCount
+ * Returns all the rows in the given offset and rowCount
*
* @param enum $action the action being performed
* @param int $offset the row number to start from
}
/**
- * name of export file.
+ * Name of export file.
*
* @param string $output type of output
*
/**
* @param array $params
* @param $action
- * @param $sortID
+ * @param int $sortID
* @param null $displayRelationshipType
* @param string $queryOperator
*
protected $_task;
/**
- * class constructor
+ * Class constructor
*/ function __construct($controller, $action = CRM_Core_Action::NONE) {
parent::__construct($controller, $action);
}
/**
- * return the form name of the task
+ * Return the form name of the task
*
* @return string
* @access public
COMMUNICATION_PREFS = 25;
/**
- * the task array
+ * The task array
*
* @var array
* @static
static $_tasks = NULL;
/**
- * the optional task array
+ * The optional task array
*
* @var array
* @static
}
/**
- * show tasks selectively based on the permission level
+ * Show tasks selectively based on the permission level
* of the user
*
* @param int $permission
class CRM_Contribute_BAO_Contribution extends CRM_Contribute_DAO_Contribution {
/**
- * static field for all the contribution information that we can potentially import
+ * Static field for all the contribution information that we can potentially import
*
* @var array
* @static
static $_importableFields = NULL;
/**
- * static field for all the contribution information that we can potentially export
+ * Static field for all the contribution information that we can potentially export
*
* @var array
* @static
static $_exportableFields = NULL;
/**
- * field for all the objects related to this contribution
+ * Field for all the objects related to this contribution
* @var array of objects (e.g membership object, participant object)
*/
public $_relatedObjects = array();
/**
- * field for the component - either 'event' (participant) or 'contribute'
+ * Field for the component - either 'event' (participant) or 'contribute'
* (any item related to a contribution page e.g. membership, pledge, contribution)
* This is used for composing messages because they have dependency on the
* contribution_page or event page - although over time we may eliminate that
* construct method
*/
/**
- * class constructor
+ * Class constructor
*
* @access public
* @return \CRM_Contribute_DAO_Contribution
}
/**
- * takes an associative array and creates a contribution object
+ * Takes an associative array and creates a contribution object
*
* the function extract all the params it needs to initialize the create a
* contribution object. the params array could contain additional unused name/value
}
/**
- * takes an associative array and creates a contribution object
+ * Takes an associative array and creates a contribution object
*
* @param array $params (reference ) an assoc array of name/value pairs
* @param array $ids the array that holds all the db ids
}
/**
- * combine all the importable fields from the lower levels object
+ * Combine all the importable fields from the lower levels object
*
* The ordering is important, since currently we do not have a weight
* scheme. Adding weight is super important and should be done in the
/**
* Delete the indirect records associated with this contribution first
*
- * @param $id
+ * @param int $id
*
* @return mixed|null $results no of deleted Contribution on success, false otherwise@access public
* @static
* @param array $input an assoc array of name/value pairs
* @param array $duplicates (reference ) store ids of duplicate contribs
*
- * @param null $id
+ * @param int $id
*
* @return boolean true if duplicate, false otherwise
* @access public
}
/**
- * takes an associative array and creates a contribution_product object
+ * Takes an associative array and creates a contribution_product object
*
* the function extract all the params it needs to initialize the create a
* contribution_product object. the params array could contain additional unused name/value
}
/**
- * get list of contribution fields for profile
+ * Get list of contribution fields for profile
* For now we only allow custom contribution fields to be in
* profile
*
}
/**
- * add extra fields specific to contribtion
+ * Add extra fields specific to contribtion
*
* @static
*/
}
/**
- * @param $pageID
+ * @param int $pageID
*
* @return array
*/
}
/**
- * get list of contribution In Honor of contact Ids
+ * Get list of contribution In Honor of contact Ids
*
* @param int $honorId In Honor of Contact ID
*
}
/**
- * function to get the sort name of a contact for a particular contribution
+ * Get the sort name of a contact for a particular contribution
*
* @param int $id id of the contribution
*
}
/**
- * @param $contactID
+ * @param int $contactID
*
* @return array
*/
}
/**
- * Function to get the contribution details for component export
+ * Get the contribution details for component export
*
* @param int $exportMode export mode
* @param string $componentIds component ids
}
/**
- * @param $contactId
+ * @param int $contactId
* @param bool $includeSoftCredit
*
* @return null|string
}
/**
- * Function to get individual id for onbehalf contribution
+ * Get individual id for onbehalf contribution
*
* @param int $contributionId contribution id
* @param int $contributorId contributor id
}
/**
- * Function to check whether payment processor supports
+ * Check whether payment processor supports
* cancellation of contribution subscription
*
* @param int $contributionId contribution id
}
/**
- * Function to check whether subscription is already cancelled
+ * Check whether subscription is already cancelled
*
* @param int $contributionId contribution id
*
}
/**
- * Function to create all financial accounts entry
+ * Create all financial accounts entry
*
* @param array $params contribution object, line item array and params for trxn
*
}
/**
- * Function to update all financial accounts entry
+ * Update all financial accounts entry
*
* @param array $params contribution object, line item array and params for trxn
*
}
/**
- * Function to check status validation on update of a contribution
+ * Check status validation on update of a contribution
*
* @param array $values previous form values before submit
*
}
/**
- * Function to delete contribution of contact
+ * Delete contribution of contact
*
* CRM-12155
*
}
/**
- * Function to validate financial type
+ * Validate financial type
*
* CRM-13231
*
* @param string $paymentType 'owed' for purpose of recording partial payments, 'refund' for purpose of recording refund payments
*/
/**
- * @param $contributionId
+ * @param int $contributionId
* @param $trxnsData
* @param string $paymentType
- * @param null $participantId
+ * @param int $participantId
*
* @return null|object
*/
* @param $trxnObj
* @param $activityType
* @param $component
- * @param $contributionId
+ * @param int $contributionId
*
* @throws CRM_Core_Exception
*/
}
/**
- * function to get list of payments displayed by Contribute_Page_PaymentInfo
+ * Get list of payments displayed by Contribute_Page_PaymentInfo
*
- * @param $id
+ * @param int $id
* @param $component
* @param bool $getTrxnInfo
* @param bool $usingLineTotal
}
/**
- * Function to get financial account id has 'Sales Tax Account is'
+ * Get financial account id has 'Sales Tax Account is'
* account relationship with financial type
*
- * @param $financialTypeId
+ * @param int $financialTypeId
*
* @return FinancialAccountId
*/
class CRM_Contribute_BAO_Contribution_Utils {
/**
- * process payment after confirmation
+ * Process payment after confirmation
*
* @param CRM_Core_Form $form form object
* @param array $paymentParams array with payment related key
}
/**
- * get the contribution details by month
+ * Get the contribution details by month
* of the year
*
* @param int $param year
}
/**
- * get the contribution details by year
+ * Get the contribution details by year
*
* @return array associated array
*
/**
* @param array $params
- * @param $contactID
+ * @param int $contactID
* @param $mail
*/
static function createCMSUser(&$params, $contactID, $mail) {
}
/**
- * @param $apiParams
+ * @param array $apiParams
* @param $mapper
* @param string $type
* @param bool $category
}
/**
- * @param $contactID
+ * @param int $contactID
*
* @return mixed
*/
class CRM_Contribute_BAO_ContributionPage extends CRM_Contribute_DAO_ContributionPage {
/**
- * takes an associative array and creates a contribution page object
+ * Takes an associative array and creates a contribution page object
*
* @param array $params (reference ) an assoc array of name/value pairs
*
}
/**
- * update the is_active flag in the db
+ * 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 $id
+ * @param int $id
* @param $values
*/
static function setValues($id, &$values) {
}
/**
- * send the emails
+ * Send the emails
*
* @param int $contactID contact id
* @param array $values associated array of fields
/**
* Construct the message to be sent by the send function
*
- * @param $tplParams
- * @param $contactID
+ * @param array $tplParams
+ * @param int $contactID
* @param $isTest
*
* @return array
}
/**
- * send the emails for Recurring Contribution Notication
+ * Send the emails for Recurring Contribution Notication
*
* @param string $type txnType
* @param int $contactID contact id for contributor
}
/**
- * add the custom fields for contribution page (ie profile)
+ * Add the custom fields for contribution page (ie profile)
*
* @param int $gid uf group id
* @param string $name
}
/**
- * Function to check if contribution page contains payment
+ * Check if contribution page contains payment
* processor that supports recurring payment
*
* @param int $contributionPageId Contribution Page Id
}
/**
- * Function to get info for all sections enable/disable.
+ * Get info for all sections enable/disable.
*
* @param array $contribPageIds
* @return array $info info regarding all sections.
}
/**
- * helper to determine if the page supports separate membership payments
+ * Helper to determine if the page supports separate membership payments
* @param integer id form id
*
* @return bool isSeparateMembershipPayment
class CRM_Contribute_BAO_ContributionRecur extends CRM_Contribute_DAO_ContributionRecur {
/**
- * create recurring contribution
+ * Create recurring contribution
*
* @param array $params (reference ) an assoc array of name/value pairs
*
}
/**
- * @param $id
+ * @param int $id
* @param $mode
*
* @return array|null
}
/**
- * get the number of installment done/completed for each recurring contribution
+ * Get the number of installment done/completed for each recurring contribution
*
* @param array $ids (reference ) an array of recurring contribution ids
*
/**
* Delete Recurring contribution.
*
- * @param $recurId
+ * @param int $recurId
*
* @return bool
* @access public
}
/**
- * get list of recurring contribution of contact Ids
+ * Get list of recurring contribution of contact Ids
*
* @param int $contactId Contact ID
*
}
/**
- * @param $entityID
+ * @param int $entityID
* @param string $entity
*
* @return null|Object
class CRM_Contribute_BAO_ContributionSoft extends CRM_Contribute_DAO_ContributionSoft {
/**
- * construct method
+ * Construct method
*/
function __construct() {
parent::__construct();
}
/**
- * add contribution soft credit record
+ * Add contribution soft credit record
*
* @param array $params (reference ) an assoc array of name/value pairs
*
}
/**
- * delete soft credits
+ * Delete soft credits
*
* @param array $params
*
}
/**
- * @param $contact_id
+ * @param int $contact_id
* @param int $isTest
*
* @return array
}
/**
- * retrieve soft contributions for contribution record.
+ * Retrieve soft contributions for contribution record.
*
- * @param $contributionID
+ * @param int $contributionID
* @param boolean $all include PCP data
*
* @return array of soft contribution ids, amounts, and associated contact ids
}
/**
- * @param $contributionID
+ * @param int $contributionID
* @param bool $isPCP
*
* @return array
/**
* @param CRM_Core_Form $form
* @param array $params
- * @param $honoreeprofileId
- * @param null $honorId
+ * @param int $honoreeprofileId
+ * @param int $honorId
*/
static function formatHonoreeProfileFields($form, $params, $honoreeprofileId, $honorId = NULL) {
$profileContactType = CRM_Core_BAO_UFGroup::getContactType($honoreeprofileId);
class CRM_Contribute_BAO_ManagePremiums extends CRM_Contribute_DAO_Product {
/**
- * static holder for the default LT
+ * Static holder for the default LT
*/
static $_defaultContributionType = NULL;
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
}
/**
- * update the is_active flag in the db
+ * 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
}
/**
- * delete premium Types
+ * Delete premium Types
*
* @param int $productID
* @static
class CRM_Contribute_BAO_Premium extends CRM_Contribute_DAO_Premium {
/**
- * product information
+ * Product information
* @var array
* @static
*/
private static $productInfo;
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
}
/**
- * update the is_active flag in the db
+ * 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
}
/**
- * delete financial Types
+ * Delete financial Types
*
- * @param $premiumID
+ * @param int $premiumID
*
* @static
*/
}
/**
- * build Premium Block im Contribution Pages
+ * Build Premium Block im Contribution Pages
*
- * @param $form CRM_Core_Form
- * @param $pageID
+ * @param CRM_Core_Form $form
+ * @param int $pageID
* @param bool $formItems
- * @param null $selectedProductID
+ * @param int $selectedProductID
* @param null $selectedOption
*
* @static
}
/**
- * build Premium B im Contribution Pages
+ * Build Premium B im Contribution Pages
*
* @param CRM_Core_Form $form
* @param int $productID
}
/**
- * Function to delete premium associated w/ contribution page.
+ * Delete premium associated w/ contribution page.
*
- * @param $contributionPageID
+ * @param int $contributionPageID
*
* @static
*/
}
/**
- * Function to retrieve premium product and their options
+ * Retrieve premium product and their options
*
* @return array product and option arrays
* @static
class CRM_Contribute_BAO_Query {
/**
- * static field for all the export/import contribution fields
+ * Static field for all the export/import contribution fields
*
* @var array
* @static
}
/**
- * if contributions are involved, add the specific contribute fields
+ * If contributions are involved, add the specific contribute fields
*
* @param $query
*
}
/**
- * @param $name
+ * @param string $name
* @param $mode
* @param $side
*
}
/**
- * add all the elements shared between contribute search and advnaced search
+ * Add all the elements shared between contribute search and advnaced search
*
* @access public
*
/**
* @param $row
- * @param $id
+ * @param int $id
*/
static function searchAction(&$row, $id) {
}
class CRM_Contribute_Controller_Contribution extends CRM_Core_Controller {
/**
- * class constructor
+ * Class constructor
*/
function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) {
parent::__construct($title, $modal);
class CRM_Contribute_Controller_ContributionPage extends CRM_Core_Controller {
/**
- * class constructor
+ * Class constructor
*/
function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) {
class CRM_Contribute_Controller_Search extends CRM_Core_Controller {
/**
- * class constructor
+ * Class constructor
*/
function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) {
public $_recurPaymentProcessors;
/**
- * array of processor options in the format id => array($id => $label)
+ * Array of processor options in the format id => array($id => $label)
* WARNING it appears that the format used to differ to this and there are places in the code that
* expect the old format. $this->_paymentProcessors provides the additional data which this
* array seems to have provided in the past
public $_processors;
/**
- * available payment processors with full details including the key 'object' indexed by their id
+ * Available payment processors with full details including the key 'object' indexed by their id
* @var array
*/
protected $_paymentProcessors = array();
/**
- * the id of the contribution that we are processing
+ * The id of the contribution that we are processing
*
* @var int
* @public
public $_id;
/**
- * the id of the premium that we are proceessing
+ * The id of the premium that we are proceessing
*
* @var int
* @public
public $_productDAO = NULL;
/**
- * the id of the note
+ * The id of the note
*
* @var int
* @public
public $_noteID;
/**
- * the id of the contact associated with this contribution
+ * The id of the contact associated with this contribution
*
* @var int
* @public
public $_contactID;
/**
- * the id of the pledge payment that we are processing
+ * The id of the pledge payment that we are processing
*
* @var int
* @public
public $_ppID;
/**
- * the id of the pledge that we are processing
+ * The id of the pledge that we are processing
*
* @var int
* @public
public $_pledgeID;
/**
- * is this contribution associated with an online
+ * Is this contribution associated with an online
* financial transaction
*
* @var boolean
public $_options;
/**
- * stores the honor id
+ * Stores the honor id
*
* @var int
* @public
protected $_cdType;
/**
- * array of fields to display on billingBlock.tpl - this is not fully implemented but basically intent is the panes/fieldsets on this page should
+ * Array of fields to display on billingBlock.tpl - this is not fully implemented but basically intent is the panes/fieldsets on this page should
* be all in this array in order like
* 'credit_card' => array('credit_card_number' ...
* 'billing_details' => array('first_name' ...
public $billingFieldSets = array();
/**
- * @param $id
+ * @param int $id
*/
public function showRecordLinkMesssage($id) {
$statusId = CRM_Core_DAO::getFieldValue('CRM_Contribute_BAO_Contribution', $id, 'contribution_status_id');
}
/**
- * @param $id
+ * @param int $id
* @param $values
*/
public function buildValuesAndAssignOnline_Note_Type($id, &$values) {
}
/**
- * @param $id
+ * @param int $id
* @todo - this function is a long way, non standard of saying $dao = new CRM_Contribute_DAO_ContributionProduct(); $dao->id = $id; $dao->find();
*/
public function assignPremiumProduct($id) { //to get Premium id
}
/**
- * @param $financialTypeId
+ * @param int $financialTypeId
*
* @return array
*/
}
/**
- * @param $financialTypeId
- * @param $relationTypeId
+ * @param int $financialTypeId
+ * @param int $relationTypeId
*
* @return mixed
*/
}
/**
- * common block for setting up the parts of a form that relate to credit / debit card
+ * Common block for setting up the parts of a form that relate to credit / debit card
* @throws Exception
*/
protected function assignPaymentRelatedVariables() {
}
/**
- * process the Premium Information
+ * Process the Premium Information
*
* @access public
*
* @param array $params
- * @param $contributionID
- * @param null $premiumID
+ * @param int $contributionID
+ * @param int $premiumID
* @param null $options
* @return void
*/
}
/**
- * process the Note
+ * Process the Note
*
* @access public
*
* @param array $params
- * @param $contactID
- * @param $contributionID
- * @param null $contributionNoteID
+ * @param int $contactID
+ * @param int $contributionID
+ * @param int $contributionNoteID
*
* @return void
*/
}
/**
- * process the Common data
+ * Process the Common data
*
* @access public
*
}
/**
- * Function to send email receipt.
+ * Send email receipt.
*
* @form object of Contribution form.
*
public $_contributeMode = 'direct';
/**
- * related component whose financial payment is being processed
+ * Related component whose financial payment is being processed
*
* @var string
* @public
protected $_component = NULL;
/**
- * id of the component entity
+ * Id of the component entity
*/
public $_id = NULL;
protected $_selfService = FALSE;
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
*/
class CRM_Contribute_Form_Contribution extends CRM_Contribute_Form_AbstractEditPayment {
/**
- * the id of the contribution that we are processing
+ * The id of the contribution that we are processing
*
* @var int
* @public
public $_id;
/**
- * the id of the premium that we are processing
+ * The id of the premium that we are processing
*
* @var int
* @public
public $_productDAO = NULL;
/**
- * the id of the note
+ * The id of the note
*
* @var int
* @public
public $_noteID;
/**
- * the id of the contact associated with this contribution
+ * The id of the contact associated with this contribution
*
* @var int
* @public
public $_contactID;
/**
- * the id of the pledge payment that we are processing
+ * The id of the pledge payment that we are processing
*
* @var int
* @public
public $_ppID;
/**
- * the id of the pledge that we are processing
+ * The id of the pledge that we are processing
*
* @var int
* @public
public $_pledgeID;
/**
- * is this contribution associated with an online
+ * Is this contribution associated with an online
* financial transaction
*
* @var boolean
public $_lineItems;
/**
- * line item
+ * Line item
* @todo explain why we use lineItem & lineItems
* @var array
*/
public $_honoreeProfileType;
/**
- * array of billing panes to be displayed by billingBlock.tpl - currently this is likely to look like
+ * Array of billing panes to be displayed by billingBlock.tpl - currently this is likely to look like
* array('Credit Card' => ts('Credit Card') or array('Direct Debit => ts('Direct Debit')
* @todo billing details (address stuff) to be added when we stop hard coding the panes in billingBlock.tpl
*
public $billingPane = array();
/**
- * array of the payment fields to be displayed in the payment fieldset (pane) in billingBlock.tpl
+ * Array of the payment fields to be displayed in the payment fieldset (pane) in billingBlock.tpl
* this contains all the information to describe these fields from quickform. See CRM_Core_Form_Payment getPaymentFormFieldsMetadata
*
* @var array
*/
public $_paymentFields = array();
/**
- * logged in user's email
+ * Logged in user's email
* @var string
*/
public $userEmail;
public $_priceSet;
/**
- * form defaults
+ * Form defaults
* @todo can we define this a as protected? can we define higher up the chain
* @var array
*/
*/
public $userDisplayName;
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
}
/**
- * global form rule
+ * Global form rule
*
* @param array $fields the input form values
* @param array $files the uploaded files if any
}
/**
- * @param $paymentParams
+ * @param array $paymentParams
*
* @return array
*/
class CRM_Contribute_Form_Contribution_Confirm extends CRM_Contribute_Form_ContributionBase {
/**
- * the id of the contact associated with this contribution
+ * The id of the contact associated with this contribution
*
* @var int
* @public
*
* @param array $params
* @param integer $contactID
- * @param $financialTypeID
+ * @param int $financialTypeID
* @param $online
- * @param $contributionPageId
+ * @param int $contributionPageId
* @param $nonDeductibleAmount
- * @param $campaignId
+ * @param int $campaignId
* @param $isMonetary
* @param $pending
* @param $paymentProcessorOutcome
* @param $receiptDate
- * @param $recurringContributionID
+ * @param int $recurringContributionID
* @param $isTest
- * @param $addressID
- * @param $softCreditToID
- * @param $lineItems
+ * @param int $addressID
+ * @param int $softCreditToID
+ * @param array $lineItems
*
* @return array
*/
}
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
}
/**
- * overwrite action, since we are only showing elements in frozen mode
+ * Overwrite action, since we are only showing elements in frozen mode
* no help display needed
*
* @return int
* Pledges are not relevant to the membership code so that portion will not go onto the membership form.
*
* Comments from previous refactor indicate doubt as to what was going on
- * @param $contributionTypeId
+ * @param int $contributionTypeId
*
* @return null|string
*/
/**
* Process the form
*
- * @param $premiumParams
+ * @param array $premiumParams
* @param $contribution
*
* @return void
}
/**
- * add on behalf of organization and it's location
+ * Add on behalf of organization and it's location
*
* @param $behalfOrganization array array of organization info
* @param $contactID int individual contact id. One
* And under certain circumstances sets
* $this->_params['amount'] = null;
*
- * @param $priceSetID
+ * @param int $priceSetID
*
*/
public function setFormAmountFields($priceSetID) {
/**
* Helper function for static submit function - set relevant params - help us to build up an array that we can pass in
- * @param $id
+ * @param int $id
* @param array $params
*
* @return array
public $_useForMember;
/**
- * array of payment related fields to potentially display on this form (generally credit card or debit card fields). This is rendered via billingBlock.tpl
+ * Array of payment related fields to potentially display on this form (generally credit card or debit card fields). This is rendered via billingBlock.tpl
* @var array
*/
public $_paymentFields = array();
protected $_snippet;
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
}
/**
- * set the default values
+ * Set the default values
*
* @return void
* @access public
}
/**
- * build elements to enable pay on behalf of an organization.
+ * Build elements to enable pay on behalf of an organization.
*
* @access public
*/
}
/**
- * build elements to collect information for recurring contributions
+ * Build elements to collect information for recurring contributions
*
* @access public
*
}
/**
- * global form rule
+ * Global form rule
*
* @param array $fields the input form values
* @param array $files the uploaded files if any
class CRM_Contribute_Form_Contribution_OnBehalfOf {
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @param CRM_Core_Form $form
*
}
/**
- * build form for related contacts / on behalf of organization.
+ * Build form for related contacts / on behalf of organization.
*
* @param CRM_Core_Form $form
*
class CRM_Contribute_Form_Contribution_ThankYou extends CRM_Contribute_Form_ContributionBase {
/**
- * membership price set status
+ * Membership price set status
*
*/
public $_useForMember;
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
}
/**
- * overwrite action, since we are only showing elements in frozen mode
+ * Overwrite action, since we are only showing elements in frozen mode
* no help display needed
*
* @return int
class CRM_Contribute_Form_ContributionBase extends CRM_Core_Form {
/**
- * the id of the contribution page that we are processsing
+ * The id of the contribution page that we are processsing
*
* @var int
* @public
public $_id;
/**
- * the mode that we are in
+ * The mode that we are in
*
* @var string
* @protect
public $_mode;
/**
- * the contact id related to a membership
+ * The contact id related to a membership
*
* @var int
* @public
public $_membershipContactID;
/**
- * the values for the contribution db object
+ * The values for the contribution db object
*
* @var array
* @protected
public $_values;
/**
- * the paymentProcessor attributes for this page
+ * The paymentProcessor attributes for this page
*
* @var array
* @protected
*/
protected $_separateMembershipPayment;
/**
- * the default values for the form
+ * The default values for the form
*
* @var array
* @protected
public $_amount;
/**
- * pcp id
+ * Pcp id
*
* @var integer
* @public
public $_pcpId;
/**
- * pcp block
+ * Pcp block
*
* @var array
* @public
public $_pcpBlock;
/**
- * pcp info
+ * Pcp info
*
* @var array
* @public
protected $_userID;
/**
- * the Membership ID for membership renewal
+ * The Membership ID for membership renewal
*
* @var int
* @public
public $_contributeMode;
/**
- * contribution page supports memberships
+ * Contribution page supports memberships
* @var boolean
*/
public $_useForMember;
public $_isBillingAddressRequiredForPayLater;
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
}
/**
- * set the default values
+ * Set the default values
*
* @return void
* @access public
}
/**
- * assign the minimal set of variables to the template
+ * Assign the minimal set of variables to the template
*
* @return void
* @access public
}
/**
- * add the custom fields
+ * Add the custom fields
*
- * @param $id
- * @param $name
+ * @param int $id
+ * @param string $name
* @param bool $viewOnly
* @param null $profileContactType
* @param null $fieldTypes
}
/**
- * authenticate pledge user during online payment.
+ * Authenticate pledge user during online payment.
*
* @access public
*
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
class CRM_Contribute_Form_ContributionPage extends CRM_Core_Form {
/**
- * the page id saved to the session for an update
+ * The page id saved to the session for an update
*
* @var int
* @access protected
protected $_id;
/**
- * the pledgeBlock id saved to the session for an update
+ * The pledgeBlock id saved to the session for an update
*
* @var int
* @access protected
protected $_pledgeBlockID;
/**
- * are we in single form mode or wizard mode?
+ * Are we in single form mode or wizard mode?
*
* @var boolean
* @access protected
protected $_single;
/**
- * is this the first page?
+ * Is this the first page?
*
* @var boolean
* @access protected
protected $_first = FALSE;
/**
- * store price set id.
+ * Store price set id.
*
* @var int
* @access protected
protected $_values;
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
protected $_pid;
/**
- * pre process the form
+ * Pre process the form
*
* @access public
*
class CRM_Contribute_Form_ContributionPage_Amount extends CRM_Contribute_Form_ContributionPage {
/**
- * contribution amount block.
+ * Contribution amount block.
*
* @var array
* @access protected
}
/**
- * global form rule
+ * Global form rule
*
* @param array $fields the input form values
* @param array $files the uploaded files if any
}
/**
- * global form rule
+ * Global form rule
*
* @param array $fields the input form values
*
* @param $files
- * @param $contributionPageId
+ * @param int $contributionPageId
*
* @return true if no errors, else array of errors
* @access public
class CRM_Contribute_Form_ContributionPage_Delete extends CRM_Contribute_Form_ContributionPage {
/**
- * page title
+ * Page title
*
* @var string
* @protected
protected $_relatedContributions;
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
}
/**
- * validation
+ * Validation
*
* @param array $params (ref.) an assoc array of name/value pairs
*
class CRM_Contribute_Form_ContributionPage_Settings extends CRM_Contribute_Form_ContributionPage {
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $values posted values of the form
*
}
/**
- * global form rule
+ * Global form rule
*
* @param array $fields the input form values
* @param array $files the uploaded files if any
}
/**
- * validation
+ * Validation
*
* @param array $params (ref.) an assoc array of name/value pairs
*
class CRM_Contribute_Form_ContributionView extends CRM_Core_Form {
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
class CRM_Contribute_Form_ManagePremiums extends CRM_Contribute_Form {
/**
- * pre process the form
+ * Pre process the form
*
* @access public
*
*
* @access private
*
- * @param $filename
- * @param $resizedName
+ * @param string $filename
+ * @param string $resizedName
* @param $width
* @param $height
*
class CRM_Contribute_Form_Search extends CRM_Core_Form_Search {
/**
- * the params that are sent to the query
+ * The params that are sent to the query
*
* @var array
* @access protected
protected $_queryParams;
/**
- * are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact
*
* @access protected
* @var boolean
protected $_single = FALSE;
/**
- * are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact
*
* @access protected
* @var boolean
protected $_defaults;
/**
- * prefix for the controller
+ * Prefix for the controller
*
*/
protected $_prefix = "contribute_";
/**
- * processing needed for buildForm and later
+ * Processing needed for buildForm and later
*
* @return void
* @access public
class CRM_Contribute_Form_SoftCredit {
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @param CRM_Core_Form $form
*
}
/**
- * global form rule
+ * Global form rule
*
* @param array $fields the input form values
*
class CRM_Contribute_Form_Task extends CRM_Core_Form {
/**
- * the task being performed
+ * The task being performed
*
* @var int
*/
public $_includesSoftCredits = FALSE;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @param
*
}
/**
- * simple shell that derived classes can call to add buttons to
+ * Simple shell that derived classes can call to add buttons to
* the form with a customized title for the main Submit
*
* @param string $title title of the main button
class CRM_Contribute_Form_Task_Batch extends CRM_Contribute_Form_Task {
/**
- * the title of the group
+ * The title of the group
*
* @var string
*/
protected $_title;
/**
- * maximum profile fields that will be displayed
+ * Maximum profile fields that will be displayed
*
*/
protected $_maxFields = 9;
/**
- * variable to store redirect path
+ * Variable to store redirect path
*
*/
protected $_userContext;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
protected $_single = FALSE;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
public $_noEmails = FALSE;
/**
- * all the existing templates in the system
+ * All the existing templates in the system
*
* @var array
*/
public $_templates = NULL;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
public $_single = FALSE;
/**
- * gives all the statues for conribution
+ * Gives all the statues for conribution
*
* @access public
*/
public $_contributionStatusId;
/**
- * gives the HTML template of PDF Invoice
+ * Gives the HTML template of PDF Invoice
*
* @access public
*/
public $_invoiceTemplate;
/**
- * selected output
+ * Selected output
*/
public $_selectedOutput;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $values
*
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
protected $_rows;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
}
/**
- * declaration of common variables for Invoice and PDF
+ * Declaration of common variables for Invoice and PDF
*
* @access public
*
class CRM_Contribute_Form_Task_PDFLetter extends CRM_Contribute_Form_Task {
/**
- * all the existing templates in the system
+ * All the existing templates in the system
*
* @var array
*/
public $_cid = NULL;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
class CRM_Contribute_Form_Task_PDFLetterCommon extends CRM_Contact_Form_Task_PDFLetterCommon {
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
}
/**
- * check that the token only appears in a table cell. The '</td><td>' separator cannot otherwise work
+ * Check that the token only appears in a table cell. The '</td><td>' separator cannot otherwise work
* Calculate the number of times it appears IN the cell & the number of times it appears - should be the same!
*
* @param $token
* @param array $contact
* @param array $contributions
* @param $groupBy
- * @param $groupByID
+ * @param int $groupByID
*/
static function assignCombinedContributionValues($contact, $contributions, $groupBy, $groupByID) {
if (!defined('CIVICRM_MAIL_SMARTY') || !CIVICRM_MAIL_SMARTY) {
class CRM_Contribute_Form_Task_PickProfile extends CRM_Contribute_Form_Task {
/**
- * the title of the group
+ * The title of the group
*
* @var string
*/
protected $_title;
/**
- * maximum contributions that should be allowed to update
+ * Maximum contributions that should be allowed to update
*
*/
protected $_maxContributions = 100;
/**
- * variable to store redirect path
+ * Variable to store redirect path
*
*/
protected $_userContext;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $fields posted values of the form
*
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
class CRM_Contribute_Form_Task_Print extends CRM_Contribute_Form_Task {
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
class CRM_Contribute_Form_Task_Result extends CRM_Contribute_Form_Task {
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
class CRM_Contribute_Form_Task_SearchTaskHookSample extends CRM_Contribute_Form_Task {
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
protected $_rows;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $fields posted values of the form
*
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
public $_paymentProcessorObj = NULL;
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
}
/**
- * global form rule
+ * Global form rule
*
* @param array $fields the input form values
* @param array $files the uploaded files if any
public $_paymentProcessorObj = NULL;
/**
- * the id of the contact associated with this recurring contribution
+ * The id of the contact associated with this recurring contribution
*
* @var int
* @public
}
/**
- * actually build the components of the form
+ * Actually build the components of the form
*
* @return void
* @access public
class CRM_Contribute_Import_Controller extends CRM_Core_Controller {
/**
- * class constructor
+ * Class constructor
*/
function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) {
parent::__construct($title, $modal);
*/
/**
- * name of the field
+ * Name of the field
*/
public $_name;
/**
- * title of the field to be used in display
+ * Title of the field to be used in display
*/
public $_title;
/**
- * type of field
+ * Type of field
* @var enum
*/
public $_type;
/**
- * is this field required
+ * Is this field required
* @var boolean
*/
public $_required;
/**
- * data to be carried for use by a derived class
+ * Data to be carried for use by a derived class
* @var object
*/
public $_payload;
/**
- * regexp to match the CSV header of this column/field
+ * Regexp to match the CSV header of this column/field
* @var string
*/
public $_headerPattern;
/**
- * regexp to match the pattern of data from various column/fields
+ * Regexp to match the pattern of data from various column/fields
* @var string
*/
public $_dataPattern;
/**
- * value of this field
+ * Value of this field
* @var object
*/
public $_value;
/**
- * this is soft credit field
+ * This is soft credit field
* @var string
*/
public $_softCreditField;
/**
- * @param $name
+ * @param string $name
* @param $title
* @param int $type
* @param string $headerPattern
}
/**
- * the value is in string format. convert the value to the type of this field
+ * The value is in string format. convert the value to the type of this field
* and set the field value with the appropriate type
*/
function setValue($value) {
class CRM_Contribute_Import_Form_DataSource extends CRM_Core_Form {
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $fields posted values of the form
*
class CRM_Contribute_Import_Form_Preview extends CRM_Import_Form_Preview {
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
class CRM_Contribute_Import_Form_Summary extends CRM_Import_Form_Summary {
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
protected $_fileName;
/**
- * imported file size
+ * Imported file size
*/
protected $_fileSize;
/**
- * seperator being used
+ * Seperator being used
*/
protected $_seperator;
/**
- * total number of lines in file
+ * Total number of lines in file
*/
protected $_lineCount;
/**
- * running total number of valid soft credit rows
+ * Running total number of valid soft credit rows
*/
protected $_validSoftCreditRowCount;
/**
- * running total number of invalid soft credit rows
+ * Running total number of invalid soft credit rows
*/
protected $_invalidSoftCreditRowCount;
/**
- * running total number of valid pledge payment rows
+ * Running total number of valid pledge payment rows
*/
protected $_validPledgePaymentRowCount;
/**
- * running total number of invalid pledge payment rows
+ * Running total number of invalid pledge payment rows
*/
protected $_invalidPledgePaymentRowCount;
/**
- * array of pledge payment error lines, bounded by MAX_ERROR
+ * Array of pledge payment error lines, bounded by MAX_ERROR
*/
protected $_pledgePaymentErrors;
/**
- * array of pledge payment error lines, bounded by MAX_ERROR
+ * Array of pledge payment error lines, bounded by MAX_ERROR
*/
protected $_softCreditErrors;
/**
- * filename of pledge payment error data
+ * Filename of pledge payment error data
*
* @var string
*/
protected $_pledgePaymentErrorsFileName;
/**
- * filename of soft credit error data
+ * Filename of soft credit error data
*
* @var string
*/
protected $_softCreditErrorsFileName;
/**
- * whether the file has a column header or not
+ * Whether the file has a column header or not
*
* @var boolean
*/
protected $_haveColumnHeader;
/**
- * @param $fileName
+ * @param string $fileName
* @param string $seperator
* @param $mapper
* @param bool $skipColumnHeader
}
/**
- * format the field values for input to the api
+ * Format the field values for input to the api
*
* @return array (reference ) associative array of name/value pairs
* @access public
}
/**
- * @param $name
+ * @param string $name
* @param $title
* @param int $type
* @param string $headerPattern
protected $_newContributions;
/**
- * class constructor
+ * Class constructor
*/
function __construct(&$mapperKeys, $mapperSoftCredit = NULL, $mapperPhoneType = NULL, $mapperSoftCreditType = NULL) {
parent::__construct();
}
/**
- * the initializer code, called before the processing
+ * The initializer code, called before the processing
*
* @return void
* @access public
}
/**
- * handle the values in mapField mode
+ * Handle the values in mapField mode
*
* @param array $values the array of values belonging to this line
*
}
/**
- * handle the values in preview mode
+ * Handle the values in preview mode
*
* @param array $values the array of values belonging to this line
*
}
/**
- * handle the values in summary mode
+ * Handle the values in summary mode
*
* @param array $values the array of values belonging to this line
*
}
/**
- * handle the values in import mode
+ * Handle the values in import mode
*
* @param int $onDuplicate the code for what action to take on duplicates
* @param array $values the array of values belonging to this line
}
/**
- * process pledge payments
+ * Process pledge payments
*/
function processPledgePayments(&$formatted) {
if (!empty($formatted['pledge_payment_id']) && !empty($formatted['pledge_id'])) {
}
/**
- * the initializer code, called before the processing
+ * The initializer code, called before the processing
*
* @return void
* @access public
/**
* @param $whereClause
- * @param $whereParams
+ * @param array $whereParams
*/
function pager($whereClause, $whereParams) {
/**
* @param $whereClause
- * @param $whereParams
+ * @param array $whereParams
*/
function pagerAtoZ($whereClause, $whereParams) {
class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant {
/**
- * financial types
+ * Financial types
* @var array
* @static
*/
private static $financialType;
/**
- * financial types
+ * Financial types
* @var array
* @static
*/
/**
- * financial types
+ * Financial types
* @var array
* @static
*/
private static $financialAccount;
/**
- * contribution pages
+ * Contribution pages
* @var array
* @static
*/
private static $contributionPageActive = NULL;
/**
- * contribution pages
+ * Contribution pages
* @var array
* @static
*/
private static $contributionPageAll = NULL;
/**
- * payment instruments
+ * Payment instruments
*
* @var array
* @static
private static $paymentInstrument;
/**
- * contribution status
+ * Contribution status
*
* @var array
* @static
private static $pcPage;
/**
- * status of personal campaign page
+ * Status of personal campaign page
* @var array
* @static
*/
private static $pcpStatus;
/**
- * contribution / financial batches
+ * Contribution / financial batches
* @var array
* @static
*/
*
* @access public
*
- * @param null $id
+ * @param int $id
*
* @return array - array reference of all financial types if any
* @static
*
* @access public
*
- * @param null $id
- * @param null $financialAccountTypeId
+ * @param int $id
+ * @param int $financialAccountTypeId
* @param string $retrieveColumn
* @param string $key
*
*
* @access public
*
- * @param null $pageID
+ * @param int $pageID
* @return array - array of all Premiums if any
* @static
*/
*
* @access public
*
- * @param null $id
+ * @param int $id
* @param string $columnName
* @return array - array reference of all contribution statuses
* @static
* @access public
*
* @param null $pageType
- * @param null $id
+ * @param int $id
*
* @return array - array reference of all pcp if any
* @static
* @access public
* @static
*
- * @param $financialTypeId
- * @param null $relationTypeId
+ * @param int $financialTypeId
+ * @param int $relationTypeId
* @return array - array reference of all financial accounts for a Financial type
*/
public static function financialAccountType($financialTypeId, $relationTypeId = NULL) {
*
* @access public
*
- * @param null $id
+ * @param int $id
* @return array - array reference of all batches if any
* @static
*/
static $_links = NULL;
/**
- * we use desc to remind us what that column is, name is used in the tpl
+ * We use desc to remind us what that column is, name is used in the tpl
*
* @var array
* @static
);
/**
- * are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact
*
* @access protected
* @var boolean
protected $_single = FALSE;
/**
- * are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact
*
* @access protected
* @var boolean
protected $_limit = NULL;
/**
- * what context are we being invoked from
+ * What context are we being invoked from
*
* @access protected
* @var string
protected $_context = NULL;
/**
- * what component context are we being invoked from
+ * What component context are we being invoked from
*
* @access protected
* @var string
protected $_compContext = NULL;
/**
- * queryParams is the array returned by exportValues called on
+ * QueryParams is the array returned by exportValues called on
* the HTML_QuickForm_Controller for that page.
*
* @var array
public $_queryParams;
/**
- * represent the type of selector
+ * Represent the type of selector
*
* @var int
* @access protected
* - View
* - Edit
*
- * @param null $componentId
+ * @param int $componentId
* @param null $componentAction
* @param null $key
* @param null $compContext
}
/**
- * getter for array of the parameters required for creating pager.
+ * Getter for array of the parameters required for creating pager.
*
* @param $action
* @param array $params
}
/**
- * returns all the rows in the given offset and rowCount
+ * Returns all the rows in the given offset and rowCount
*
* @param enum $action the action being performed
* @param int $offset the row number to start from
}
/**
- * returns the column headers as an array of tuples:
+ * Returns the column headers as an array of tuples:
* (name, sortName (key to the sort array))
*
* @param string $action the action being performed
}
/**
- * name of export file.
+ * Name of export file.
*
* @param string $output type of output
*
class CRM_Contribute_StateMachine_Contribution extends CRM_Core_StateMachine {
/**
- * class constructor
+ * Class constructor
*
* @param CRM_Contact_Import_Controller $controller
* @param \const|int $action
class CRM_Contribute_StateMachine_ContributionPage extends CRM_Core_StateMachine {
/**
- * class constructor
+ * Class constructor
*
* @param CRM_Contribute_Controller_ContributionPage $controller
* @param const|int $action
protected $_task;
/**
- * class constructor
+ * Class constructor
*/ function __construct($controller, $action = CRM_Core_Action::NONE) {
parent::__construct($controller, $action);
}
/**
- * return the form name of the task
+ * Return the form name of the task
*
* @return string
* @access public
CONST DELETE_CONTRIBUTIONS = 1, PRINT_CONTRIBUTIONS = 2, EXPORT_CONTRIBUTIONS = 3, BATCH_CONTRIBUTIONS = 4, EMAIL_CONTACTS = 5, UPDATE_STATUS = 6, PDF_RECEIPT = 7;
/**
- * the task array
+ * The task array
*
* @var array
* @static
static $_tasks = NULL;
/**
- * the optional task array
+ * The optional task array
*
* @var array
* @static
}
/**
- * show tasks selectively based on the permission level
+ * Show tasks selectively based on the permission level
* of the user
*
* @param int $permission
//make sure MAX_ACTION = 2^n - 1 ( n = total number of actions )
/**
- * map the action names to the relevant constant. We perform
+ * Map the action names to the relevant constant. We perform
* bit manipulation operations so we can perform multiple
* actions on the same object if needed
*
);
/**
- * the flipped version of the names array, initialized when used
+ * The flipped version of the names array, initialized when used
*
* @var array
* @static
static $_description;
/**
- * called by the request object to translate a string into a mask
+ * Called by the request object to translate a string into a mask
*
* @param string $str the action to be resolved
*
}
/**
- * given a set of links and a mask, return the html action string for
+ * 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 null $op
* @param null $objectName
- * @param null $objectId
+ * @param int $objectId
*
* @return string the html string
* @access public
}
/**
- * given a string and an array of values, substitute the real values
+ * Given a string and an array of values, substitute the real values
* in the placeholder in the str in the CiviCRM format
*
* @param string $str the string to be replaced
}
/**
- * get the mask for a permission (view, edit or null)
+ * Get the mask for a permission (view, edit or null)
*
* @param string the permission
*
class CRM_Core_BAO_ActionSchedule extends CRM_Core_DAO_ActionSchedule {
/**
- * @param null $id
+ * @param int $id
*
* @return array
*/
}
/**
- * @param null $id
+ * @param int $id
*
* @return array
*/
* @param bool $namesOnly return simple list of names
*
* @param null $entityValue
- * @param null $id
+ * @param int $id
*
* @return array (reference) reminder list
* @static
}
/**
- * @param $contactId
+ * @param int $contactId
* @param $to
- * @param $scheduleID
+ * @param int $scheduleID
* @param $from
- * @param $tokenParams
+ * @param array $tokenParams
*
* @return bool|null
* @throws CRM_Core_Exception
}
/**
- * add the schedules reminders in the db
+ * Add the schedules reminders in the db
*
* @param array $params (reference ) an assoc array of name/value pairs
* @param array $ids the array that holds all the db ids
}
/**
- * delete a Reminder
+ * Delete a Reminder
*
* @param int $id ID of the Reminder to be deleted.
*
}
/**
- * update the is_active flag in the db
+ * 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 $mappingID
+ * @param int $mappingID
* @param $now
*
* @throws CRM_Core_Exception
}
/**
- * @param $mappingID
+ * @param int $mappingID
* @param $now
* @param array $params
*
}
/**
- * @param $id
- * @param $mappingID
+ * @param int $id
+ * @param int $mappingID
*
* @return null|string
*/
}
/**
- * @param $mappingID
+ * @param int $mappingID
* @param $recipientType
*
* @return array
class CRM_Core_BAO_Address extends CRM_Core_DAO_Address {
/**
- * takes an associative array and creates a address
+ * Takes an associative array and creates a address
*
* @param array $params (reference ) an assoc array of name/value pairs
* @param boolean $fixAddress true if you need to fix (format) address values
}
/**
- * takes an associative array and adds address
+ * Takes an associative array and adds address
*
* @param array $params (reference ) an assoc array of name/value pairs
* @param boolean $fixAddress true if you need to fix (format) address values
}
/**
- * format the address params to have reasonable values
+ * Format the address params to have reasonable values
*
* @param array $params (reference ) an assoc array of name/value pairs
*
}
/**
- * get address sequence
+ * Get address sequence
*
* @return array of address sequence.
*/
}
/**
- * check if current address fields are shared with any other address
+ * Check if current address fields are shared with any other address
*
* @param array $fields address fields in profile
* @param int $contactId contact id
}
/**
- * update the shared addresses if master address is modified
+ * Update the shared addresses if master address is modified
*
* @param int $addressId address id
* @param array $params associated array of address params
}
/**
- * Function to create relationship between contacts who share an address
+ * Create relationship between contacts who share an address
*
* Note that currently we create relationship only for Individual contacts
* Individual + Household and Individual + Orgnization
}
/**
- * Function to check and set the status for shared address delete
+ * Check and set the status for shared address delete
*
* @param int $addressId address id
* @param int $contactId contact id
}
/**
- * check if the current block object has any valid data
+ * Check if the current block object has any valid data
*
* @param array $blockFields array of fields that are of interest for this object
* @param array $params associated array of submitted fields
}
/**
- * check if the current block exits
+ * Check if the current block exits
*
* @param string $blockName bloack name
* @param array $params associated array of submitted fields
}
/**
- * get all block ids for a contact
+ * Get all block ids for a contact
*
* @param string $blockName block name
* @param int $contactId contact id
}
/**
- * takes an associative array and creates a block
+ * Takes an associative array and creates a block
*
* @param string $blockName block name
* @param array $params (reference ) an assoc array of name/value pairs
* @param null $entity
- * @param null $contactId
+ * @param int $contactId
*
* @return object CRM_Core_BAO_Block object on success, null otherwise
* @access public
}
/**
- * delete block
+ * Delete block
*
* @param string $blockName block name
* @param int $params associates array
class CRM_Core_BAO_CMSUser {
/**
- * synchronizing cms users with CiviCRM contacts
+ * Synchronizing cms users with CiviCRM contacts
*
* @param bool $is_interactive whether to show statuses & perform redirects
* This behavior is misplaced in the BAO layer, but we'll preserve it to avoid
}
/**
- * create CMS user using Profile
+ * Create CMS user using Profile
*
* @param array $params associated array
* @param string $mail email id for cms user
}
/**
- * create Form for CMS user using Profile
+ * Create Form for CMS user using Profile
*
* @param CRM_Core_Form $form
* @param integer $gid id of group of profile
}
/**
- * Function to check if a cms user already exists.
+ * Check if a cms user already exists.
*
* @param Array $contact array of contact-details
*
*/
/**
- * @param $names
+ * @param string $names
*/
static function restoreSessionFromCache($names) {
foreach ($names as $key => $sessionName) {
class CRM_Core_BAO_ConfigSetting {
/**
- * create civicrm settings. This is the same as add but it clears the cache and
+ * Create civicrm settings. This is the same as add but it clears the cache and
* reloads the config object
*
* @param array $params associated array of civicrm variables
}
/**
- * add civicrm settings
+ * Add civicrm settings
*
* @param array $params associated array of civicrm variables
*
}
/**
- * fix civicrm setting variables
+ * Fix civicrm setting variables
*
* @param array $params associated array of civicrm variables
*
}
/**
- * Function to format the array containing before inserting in db
+ * Format the array containing before inserting in db
*
* @param array $params associated array of civicrm variables(submitted)
* @param array $values associated array of civicrm variables stored in db
}
/**
- * Function to retrieve the settings values from db
+ * Retrieve the settings values from db
*
* @param $defaults
*
}
/**
- * takes a componentName and enables it in the config
+ * Takes a componentName and enables it in the config
* Primarily used during unit testing
*
* @param string $componentName name of the component to be enabled, needs to be valid
}
/**
- * takes an associative array and creates a custom field object
+ * Takes an associative array and creates a custom field object
*
* This function is invoked from within the web form layer and also from the api layer
*
}
/**
- * update the is_active flag in the db
+ * 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 CRM_Core_Form $qf form object (reference)
* @param string $elementName name of the custom field
- * @param $fieldId
+ * @param int $fieldId
* @param boolean $inactiveNeeded -deprecated
* @param bool $useRequired true if required else false
* @param boolean $search true if used for search else false
* @param int $id the custom field id
* @param int $options the assoc array of option name/value pairs
*
- * @param null $contactID
- * @param null $fieldID
+ * @param int $contactID
+ * @param int $fieldID
*
* @return string the display value
*
* @param $html_type
* @param $data_type
* @param null $format
- * @param null $contactID
- * @param null $fieldID
+ * @param int $contactID
+ * @param int $fieldID
*
* @return array|mixed|null|string
*/
}
/**
- * set default values for custom data used in profile
+ * Set default values for custom data used in profile
*
* @param int $customFieldId custom field id
* @param string $elementName custom field name
}
/**
- * @param $contactID
- * @param $cfID
- * @param null $fileID
+ * @param int $contactID
+ * @param int $cfID
+ * @param int $fileID
* @param bool $absolute
*
* @return array
*/
/**
- * @param $contactID
- * @param $cfID
- * @param null $fileID
+ * @param int $contactID
+ * @param int $cfID
+ * @param int $fileID
* @param bool $absolute
*
* @return array
}
/**
- * get custom option groups
+ * Get custom option groups
*
* @param array $includeFieldIds ids of custom fields for which
* option groups must be included.
}
/**
- * fix orphan groups
+ * Fix orphan groups
*
* @param int $customFieldId custom field id
* @param int $optionGroupId option group id
}
/**
- * Function to check if option group is related to more than one
+ * Check if option group is related to more than one
* custom field
*
* @param int $optionGroupId option group id
}
/**
- * @param $optionGroupId
+ * @param int $optionGroupId
* @param $htmlType
*
* @return null|string
/**
* @param array $params
* @param $customFields
- * @param $entityID
+ * @param int $entityID
* @param $customFieldExtends
* @param bool $inline
*
}
/**
- * @param $customId
+ * @param int $customId
*
* @return bool
*/
class CRM_Core_BAO_CustomGroup extends CRM_Core_DAO_CustomGroup {
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
}
/**
- * takes an associative array and creates a custom group object
+ * Takes an associative array and creates a custom group object
*
* This function is invoked from within the web form layer and also from the api layer
*
}
/**
- * update the is_active flag in the db
+ * 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
}
/**
- * generic function to build all the form elements for a specific group tree
+ * Generic function to build all the form elements for a specific group tree
*
* @param CRM_Core_Form $form the form object
* @param array $groupTree the group tree object
}
/**
- * extract the get params from the url, validate
+ * Extract the get params from the url, validate
* and store it in session
*
* @param CRM_Core_Form $form the form object
}
/**
- * check the type of custom field type (eg: Used for Individual, Contribution, etc)
+ * Check the type of custom field type (eg: Used for Individual, Contribution, etc)
* this function is used to get the custom fields of a type (eg: Used for Individual, Contribution, etc )
*
* @param int $customFieldId custom field id
* @param CRM_Core_Form $form page object
* @param array $groupTree associated array
* @param boolean $returnCount true if customValue count needs to be returned
- * @param null $gID
+ * @param int $gID
* @param null $prefix
- * @param null $customValueId
+ * @param int $customValueId
*
* @return array|int
*/
}
/**
- * @param $customGroupId
- * @param $entityId
+ * @param int $customGroupId
+ * @param int $entityId
*
* @return bool
*/
}
/**
- * delete Option
+ * Delete Option
*
* param $optionId integer option id
*
}
/**
- * @param $customFieldID
- * @param null $optionGroupID
+ * @param int $customFieldID
+ * @param int $optionGroupID
*
* @return array
*/
CONST PREFIX = 'custom_value_';
/**
- * the set of custom field ids
+ * The set of custom field ids
*
* @var array
*/
protected $_ids;
/**
- * the select clause
+ * The select clause
*
* @var array
*/
public $_select;
/**
- * the name of the elements that are in the select clause
+ * The name of the elements that are in the select clause
* used to extract the values
*
* @var array
public $_element;
/**
- * the tables involved in the query
+ * The tables involved in the query
*
* @var array
*/
public $_whereTables;
/**
- * the where clause
+ * The where clause
*
* @var array
*/
);
/**
- * class constructor
+ * Class constructor
*
* Takes in a set of custom field ids andsets up the data structures to
* generate a query
}
/**
- * generate the select clause and the associated tables
+ * Generate the select clause and the associated tables
* for the from clause
*
* @param NULL
}
/**
- * generate the where clause and also the english language
+ * Generate the where clause and also the english language
* equivalent
*
* @param NULL
}
/**
- * function that does the actual query generation
+ * Function that does the actual query generation
* basically ties all the above functions together
*
* @param NULL
}
/**
- * @param $id
+ * @param int $id
* @param $label
* @param $type
- * @param $fieldName
+ * @param string $fieldName
* @param $value
* @param $grouping
*/
}
/**
- * given a 'civicrm' type string, return the mysql data store area
+ * Given a 'civicrm' type string, return the mysql data store area
*
* @param string $type the civicrm type string
*
}
/**
- * delet option value give an option value and custom group id
+ * Delet option value give an option value and custom group id
*
* @param int $customValueID custom value ID
* @param int $customGroupID custom group ID
class CRM_Core_BAO_CustomValueTable {
/**
- * @param $customParams
+ * @param array $customParams
*
* @throws Exception
*/
}
/**
- * given a field return the mysql data type associated with it
+ * Given a field return the mysql data type associated with it
*
* @param string $type the civicrm type string
*
/**
* @param array $params
* @param $entityTable
- * @param $entityID
+ * @param int $entityID
*/
static function store(&$params, $entityTable, $entityID) {
$cvParams = array();
* @param array $params
* @param $customFields
* @param $entityTable
- * @param $entityID
+ * @param int $entityID
* @param $customFieldExtends
*/
static function postProcess(&$params, &$customFields, $entityTable, $entityID, $customFieldExtends) {
}
/**
- * take in an array of entityID, custom_XXX => value
+ * Take in an array of entityID, custom_XXX => value
* and set the value in the appropriate table. Should also be able
* to set the value to null. Follows api parameter/return conventions
*
}
/**
- * take in an array of entityID, custom_ID
+ * Take in an array of entityID, custom_ID
* and gets the value from the appropriate table.
*
* To get the values of custom fields with IDs 13 and 43 for contact ID 1327, use:
*/
class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard {
/**
- * add Dashboard
+ * Add Dashboard
*
* @param array $params values
*
/**
- * check dashlet permission for current user
+ * Check dashlet permission for current user
*
* @param string $permission comma separated list
* @param string $operator
}
/**
- * get details of each dashlets
+ * Get details of each dashlets
*
* @param int $dashletID widget ID
*
}
/**
- * Function to save changes made by use to the Dashlet
+ * Save changes made by use to the Dashlet
*
* @param array $columns associated array
*
- * @param null $contactID
+ * @param int $contactID
*
* @throws RuntimeException
* @return void
}
/**
- * Function to add dashlets
+ * Add dashlets
*
* @param array $params associated array
*
}
/**
- * Function to reset dashlet cache
+ * Reset dashlet cache
*
* @param int $contactID reset cache only for specific contact
*
/**
* Delete Dashlet
*
- * @param $dashletID
+ * @param int $dashletID
*
* @return void
* @static
class CRM_Core_BAO_Discount extends CRM_Core_DAO_Discount {
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
}
/**
- * delete the discount
+ * Delete the discount
*
* @param int $entityId
* @param string $entityTable
* Save the values of a domain
*
* @param array $params
- * @param $id
+ * @param int $id
*
* @return array domain
* @access public
}
/**
- * @param $contactID
+ * @param int $contactID
*
* @return bool|null|object|string
*/
}
/**
- * @param $groupId
+ * @param int $groupId
*
* @return bool
*/
}
/**
- * retrieve a list of contact-ids that belongs to current domain/site.
+ * Retrieve a list of contact-ids that belongs to current domain/site.
*
* @return array
*/
}
/**
- * takes an associative array and adds email
+ * Takes an associative array and adds email
*
* @param array $params (reference ) an assoc array of name/value pairs
*
}
/**
- * set / reset hold status for an email
+ * Set / reset hold status for an email
*
* @param object $email email object
*
}
/**
- * takes an associative array and creates a entityTag object
+ * Takes an associative array and creates a entityTag object
*
* the function extract all the params it needs to initialize the create a
* group object. the params array could contain additional unused name/value
}
/**
- * delete the tag for a contact
+ * Delete the tag for a contact
*
* @param array $params (reference ) an assoc array of name/value pairs
*
}
/**
- * takes an associative array and creates tag entity record for all tag entities
+ * 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 $entityTable
- * @param $entityID
+ * @param int $entityID
*
* @return void
* @access public
}
/**
- * get contact tags
+ * Get contact tags
*/
static function getContactTags($contactID, $count = FALSE) {
$contactTags = array();
}
/**
- * get child contact tags given parentId
+ * Get child contact tags given parentId
*/
static function getChildEntityTags($parentId, $entityId, $entityTable = 'civicrm_contact') {
$entityTags = array();
}
/**
- * Function to merge two tags: tag B into tag A.
+ * Merge two tags: tag B into tag A.
*/
function mergeTags($tagAId, $tagBId) {
$queryParams = array(1 => array($tagBId, 'Integer'),
}
/**
- * delete an extension
+ * Delete an extension
*
* @param int $id Id of the extension to be deleted.
*
static $_signableFields = array('entityTable', 'entityID', 'fileID');
/**
- * @param $fileID
- * @param $entityID
+ * @param int $fileID
+ * @param int $entityID
* @param null $entityTable
*
* @return array
/**
* @param $data
- * @param $fileTypeID
+ * @param int $fileTypeID
* @param $entityTable
- * @param $entityID
+ * @param int $entityID
* @param $entitySubtype
* @param bool $overwrite
* @param null|array $fileParams
} */
/**
- * delete all the files and associated object associated with this
+ * Delete all the files and associated object associated with this
* combination
*/
static function deleteEntityFile($entityTable, $entityID, $fileTypeID = NULL, $fileID = NULL) {
}
/**
- * get all the files and associated object associated with this
+ * Get all the files and associated object associated with this
* combination
*/
static function getEntityFile($entityTable, $entityID, $addDeleteArgs = FALSE) {
/**
* @param string $entityTable table-name or "*" (to reference files directly by file-id)
* @param int $entityID
- * @param null $fileTypeID
- * @param null $fileID
+ * @param int $fileTypeID
+ * @param int $fileID
*
* @return array
*/
/**
* @param CRM_Core_Form $form
* @param string $entityTable
- * @param null $entityID
+ * @param int $entityID
* @param null $numAttachments
* @param bool $ajaxDelete
*/
}
/**
- * return a clean url string and the number of attachment for a
+ * Return a clean url string and the number of attachment for a
* given entityTable, entityID
*
* @param $entityTable string The entityTable to which the file is attached
* @param $formValues
* @param array $params
* @param $entityTable
- * @param null $entityID
+ * @param int $entityID
*/
static function formatAttachment(
&$formValues,
/**
* @param array $params
* @param $entityTable
- * @param $entityID
+ * @param int $entityID
*/
static function processAttachment(&$params, $entityTable, $entityID) {
$numAttachments = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'max_attachments');
*/
/**
* @param $oldEntityTable
- * @param $oldEntityId
+ * @param int $oldEntityId
* @param $newEntityTable
- * @param $newEntityId
+ * @param int $newEntityId
*/
static function copyEntityFile($oldEntityTable, $oldEntityId, $newEntityTable, $newEntityId) {
$oldEntityFile = new CRM_Core_DAO_EntityFile();
/**
* @param $entityTable
- * @param $entityID
- * @param $fileID
+ * @param int $entityID
+ * @param int $fileID
*
* @return string
*/
}
/**
- * delete a file attachment from an entity table / entity ID
+ * Delete a file attachment from an entity table / entity ID
*
* @static
* @access public
/**
- * function to display paper icon for a file attachment -- CRM-13624
+ * Display paper icon for a file attachment -- CRM-13624
*
* @param $entityTable string The entityTable to which the file is attached. eg "civicrm_contact", "civicrm_note", "civicrm_activity"
* If you have the ID of a specific row in civicrm_file, use $entityTable='*'
class CRM_Core_BAO_FinancialTrxn extends CRM_Financial_DAO_FinancialTrxn {
/**
- * class constructor
+ * Class constructor
*
* @access public
* @return \CRM_Financial_DAO_FinancialTrxn
}
/**
- * takes an associative array and creates a financial transaction object
+ * Takes an associative array and creates a financial transaction object
*
* @param array $params (reference ) an assoc array of name/value pairs
*
}
/**
- * @param $contributionId
- * @param null $contributionFinancialTypeId
+ * @param int $contributionId
+ * @param int $contributionFinancialTypeId
*
* @return array
*/
/**
* Delete financial transaction
*
- * @param $entity_id
+ * @param int $entity_id
* @return true on success, false otherwise
* @access public
* @static
}
/**
- * create financial transaction for premium
+ * Create financial transaction for premium
*
* @access public
* @static
}
/**
- * create financial trxn and items when fee is charged
+ * Create financial trxn and items when fee is charged
*
* @param array $params to create trxn entries
*
* payment type : 'amount_owed' or 'refund_due'
*/
/**
- * @param $entityId
+ * @param int $entityId
* @param string $entityName
* @param bool $returnType
* @param null $lineItemTotal
class CRM_Core_BAO_IM extends CRM_Core_DAO_IM {
/**
- * takes an associative array and adds im
+ * Takes an associative array and adds im
*
* @param array $params (reference ) an assoc array of name/value pairs
*
class CRM_Core_BAO_Job extends CRM_Core_DAO_Job {
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
}
/**
- * add the payment-processor type in the db
+ * Add the payment-processor type in the db
*
* @param array $params an assoc array of name/value pairs
*
}
/**
- * update the is_active flag in the db
+ * 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
class CRM_Core_BAO_LabelFormat extends CRM_Core_DAO_OptionValue {
/**
- * static holder for the Label Formats Option Group ID
+ * Static holder for the Label Formats Option Group ID
*/
private static $_gid = NULL;
}
/**
- * retrieve the default Label Format values
+ * Retrieve the default Label Format values
*
* @param string $groupName label format group name
*
}
/**
- * delete a Label Format
+ * Delete a Label Format
*
* @param int $id ID of the label format to be deleted.
* @param string $groupName group name
static $blocks = array('phone', 'email', 'im', 'openid', 'address');
/**
- * create various elements of location block
+ * Create various elements of location block
*
* @param array $params (reference ) an assoc array of name/value pairs
* @param boolean $fixAddress true if you need to fix (format) address values
}
/**
- * takes an entity array and finds the existing location block
+ * Takes an entity array and finds the existing location block
* @access public
* @static
*/
}
/**
- * takes an associative array and adds location block
+ * Takes an associative array and adds location block
*
* @param array $params (reference ) an assoc array of name/value pairs
*
class CRM_Core_BAO_LocationType extends CRM_Core_DAO_LocationType {
/**
- * static holder for the default LT
+ * Static holder for the default LT
*/
static $_defaultLocationType = NULL;
static $_billingLocationType = NULL;
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
}
/**
- * update the is_active flag in the db
+ * 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
}
/**
- * retrieve the default location_type
+ * Retrieve the default location_type
*
* @param NULL
*
}
/**
- * add a Location Type
+ * Add a Location Type
*
* @param array $params reference array contains the values submitted by the form
*
}
/**
- * delete location Types
+ * Delete location Types
*
* @param int $locationTypeId ID of the location type to be deleted.
*
static $_processed = NULL;
/**
- * @param $id
+ * @param int $id
* @param string $table
*
* @return array|null
}
/**
- * add log to civicrm_log table
+ * Add log to civicrm_log table
*
* @param array $params array of name-value pairs of log table.
*
}
/**
- * @param $contactID
- * @param $tableName
- * @param $tableID
- * @param null $userID
+ * @param int $contactID
+ * @param string $tableName
+ * @param int $tableID
+ * @param int $userID
*/
static function register($contactID,
$tableName,
}
/**
- * get log record count for a Contact
+ * Get log record count for a Contact
*
* @param int $contactID
*
class CRM_Core_BAO_MailSettings extends CRM_Core_DAO_MailSettings {
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
}
/**
- * add new mail Settings.
+ * Add new mail Settings.
*
* @param array $params reference array contains the values submitted by the form
*
}
/**
- * takes an associative array and creates a mail settings object
+ * Takes an associative array and creates a mail settings object
*
* @param array $params (reference ) an assoc array of name/value pairs
*
}
/**
- * delete the mail settings.
+ * Delete the mail settings.
*
* @param int $id mail settings id
*
class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping {
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
}
/**
- * delete the mapping
+ * Delete the mapping
*
* @param int $id mapping id
*
}
/**
- * takes an associative array and creates a contact object
+ * Takes an associative array and creates a contact object
*
* The function extract all the params it needs to initialize the create a
* contact object. the params array could contain additional unused name/value
}
/**
- * get the list of mappings
+ * Get the list of mappings
*
* @param string $mappingTypeId mapping type id
*
}
/**
- * get the mapping fields
+ * Get the mapping fields
*
* @param int $mappingId mapping id
*
}
/**
- * Function to build the mapping form
+ * Build the mapping form
*
* @param CRM_Core_Form $form
* @param string $mappingType (Export/Import/Search Builder)
}
/**
- * save the mapping field info for search builder / export given the formvalues
+ * Save the mapping field info for search builder / export given the formvalues
*
* @param array $params asscociated array of formvalues
* @param int $mappingId mapping id
}
/**
- * update the is_active flag in the db
+ * 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
}
/**
- * add the Message Templates
+ * Add the Message Templates
*
* @param array $params reference array contains the values submitted by the form
*
}
/**
- * delete the Message Templates
+ * Delete the Message Templates
*
* @access public
* @static
*
- * @param $messageTemplatesID
+ * @param int $messageTemplatesID
*
* @return object
*/
}
/**
- * get the Message Templates
+ * Get the Message Templates
*
* @access public
* @static
}
/**
- * @param $contactId
+ * @param int $contactId
* @param $email
- * @param $messageTemplateID
+ * @param int $messageTemplateID
* @param $from
*
* @return bool|null
const CACHE_KEY_STRLEN = 8;
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
}
/**
- * update the is_active flag in the db
+ * 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
}
/**
- * get existing / build navigation for CiviCRM Admin Menu
+ * Get existing / build navigation for CiviCRM Admin Menu
*
* @static
* @return array associated array
}
/**
- * add/update navigation record
+ * Add/update navigation record
*
* @param array associated array of submitted values
*
}
/**
- * helper function for getNavigationList( )
+ * Helper function for getNavigationList( )
*
* @param array $list menu info
* @param array $navigations navigation menus
}
/**
- * helper function for getNavigationList( )
+ * Helper function for getNavigationList( )
*
* @param string $val menu name
* @param array $pidGroups parent menus
}
/**
- * build navigation tree
+ * Build navigation tree
*
* @param array $navigationTree nested array of menus
* @param int $parentID parent id
}
/**
- * Function to build menu
+ * Build menu
*
* @param boolean $json by default output is html
* @param boolean $navigationMenu true when called for building top navigation menu
* Get Menu name
*
* @param $value
- * @param $skipMenuItems
+ * @param array $skipMenuItems
* @return bool|string
*/
static function getMenuName(&$value, &$skipMenuItems) {
}
/**
- * Function to create navigation for CiviCRM Admin Menu
+ * Create navigation for CiviCRM Admin Menu
*
* @param int $contactID contact id
*
}
/**
- * Function to process navigation
+ * Process navigation
*
* @param array $params associated array, $_GET
*
}
/**
- * Function to process move action
+ * Process move action
*
* @param $nodeID node that is being moved
* @param $referenceID parent id where node is moved. 0 mean no parent
/**
* Function to process rename action for tree
*
- * @param $nodeID
+ * @param int $nodeID
* @param $label
*/
static function processRename($nodeID, $label) {
}
/**
- * Function to process delete action for tree
+ * Process delete action for tree
*
- * @param $nodeID
+ * @param int $nodeID
*/
static function processDelete($nodeID) {
$query = "DELETE FROM civicrm_navigation WHERE id = {$nodeID}";
}
/**
- * Function to get the info on navigation item
+ * Get the info on navigation item
*
* @param int $navigationID navigation id
*
}
/**
- * Function to update menu
+ * Update menu
*
* @param array $params
* @param array $newParams new value of params
}
/**
- * @param $cid
+ * @param int $cid
*
* @return object|string
*/
class CRM_Core_BAO_Note extends CRM_Core_DAO_Note {
/**
- * const the max number of notes we display at any given time
+ * Const the max number of notes we display at any given time
* @var int
*/
CONST MAX_NOTES = 3;
/**
- * given a note id, retrieve the note text
+ * Given a note id, retrieve the note text
*
* @param int $id id of the note to retrieve
*
}
/**
- * given a note id, retrieve the note subject
+ * Given a note id, retrieve the note subject
*
* @param int $id id of the note to retrieve
*
}
/**
- * given a note id, decide if the note should be displayed based on privacy setting
+ * Given a note id, decide if the note should be displayed based on privacy setting
*
* @param object $note Either the id of the note to retrieve, or the CRM_Core_DAO_Note object itself
*
}
/**
- * takes an associative array and creates a note object
+ * Takes an associative array and creates a note object
*
* the function extract all the params it needs to initialize the create a
* note object. the params array could contain additional unused name/value
}
/**
- * delete the notes
+ * Delete the notes
*
* @param int $id note id
* @param boolean $showStatus do we need to set status or not
}
/**
- * delete all records for this contact id
+ * Delete all records for this contact id
*
* @param int $id ID of the contact for which note needs to be deleted.
*
}
/**
- * retrieve all records for this entity-id
+ * Retrieve all records for this entity-id
*
* @param int $id ID of the relationship for which records needs to be retrieved.
*
}
/**
- * get log record count for a Contact
+ * Get log record count for a Contact
*
* @param int $contactID
*
}
/**
- * get all descendent notes of the note with given ID
+ * Get all descendent notes of the note with given ID
*
* @param int $parentId ID of the note to start from
* @param int $maxDepth Maximum number of levels to descend into the tree; if not given, will include all descendents.
}
/**
- * given a note id, get a list of the ids of all notes that are descendents of that note
+ * Given a note id, get a list of the ids of all notes that are descendents of that note
*
* @param int $parentId Id of the given note
* @param array $ids (reference) one-dimensional array to store found descendent ids
}
/**
- * function to delete all note related to contact when contact is deleted
+ * Delete all note related to contact when contact is deleted
*
* @param int $contactID contact id whose notes to be deleted
*
class CRM_Core_BAO_OpenID extends CRM_Core_DAO_OpenID {
/**
- * takes an associative array and adds OpenID
+ * Takes an associative array and adds OpenID
*
* @param array $params (reference ) an assoc array of name/value pairs
*
class CRM_Core_BAO_OptionGroup extends CRM_Core_DAO_OptionGroup {
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
}
/**
- * update the is_active flag in the db
+ * 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
}
/**
- * add the Option Group
+ * Add the Option Group
*
* @param array $params reference array contains the values submitted by the form
* @param array $ids reference array contains the id
}
/**
- * delete Option Group
+ * Delete Option Group
*
* @param int $optionGroupId Id of the Option Group to be deleted.
*
}
/**
- * get title of the option group
+ * Get title of the option group
*
* @param int $optionGroupId Id of the Option Group.
*
class CRM_Core_BAO_OptionValue extends CRM_Core_DAO_OptionValue {
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
}
/**
- * update the is_active flag in the db
+ * 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
}
/**
- * add an Option Value
+ * Add an Option Value
*
* @param array $params reference array contains the values submitted by the form
* @param array $ids reference array contains the id
}
/**
- * delete Option Value
+ * Delete Option Value
*
* @param int $optionValueId
*
}
/**
- * retrieve activity type label and description
+ * Retrieve activity type label and description
*
* @param int $activityTypeId activity type id
*
}
/**
- * updates contacts affected by the option value passed.
+ * Updates contacts affected by the option value passed.
*
* @param Integer $optionValueId the option value id.
* @param int $action the action describing whether prefix/suffix was UPDATED or DELETED
}
/**
- * updates options values weights.
+ * Updates options values weights.
*
* @param int $opGroupId
* @param array $opWeights options value , weight pair
class CRM_Core_BAO_PaperSize extends CRM_Core_DAO_OptionValue {
/**
- * static holder for the Paper Size Option Group ID
+ * Static holder for the Paper Size Option Group ID
*/
private static $_gid = NULL;
}
/**
- * retrieve the default Paper Size values
+ * Retrieve the default Paper Size values
*
* @param NULL
*
}
/**
- * delete a Paper Size
+ * Delete a Paper Size
*
* @param int $id ID of the Paper Size to be deleted.
*
class CRM_Core_BAO_PdfFormat extends CRM_Core_DAO_OptionValue {
/**
- * static holder for the PDF Page Formats Option Group ID
+ * Static holder for the PDF Page Formats Option Group ID
*/
private static $_gid = NULL;
}
/**
- * delete a PDF Page Format
+ * Delete a PDF Page Format
*
* @param int $id ID of the PDF Page Format to be deleted.
*
}
/**
- * add the Persistent Record
+ * Add the Persistent Record
*
* @param array $params reference array contains the values submitted by the form
* @param array $ids reference array contains the id
}
/**
- * takes an associative array and adds phone
+ * Takes an associative array and adds phone
*
* @param array $params (reference ) an assoc array of name/value pairs
*
class CRM_Core_BAO_PreferencesDate extends CRM_Core_DAO_PreferencesDate {
/**
- * static holder for the default LT
+ * Static holder for the default LT
*/
static $_defaultPreferencesDate = NULL;
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
}
/**
- * update the is_active flag in the db
+ * 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
}
/**
- * delete preference dates
+ * Delete preference dates
*
* @param int $id
*
* @param $cacheKey
* @param $id1
* @param $id2
- * @param null $mergeId
+ * @param int $mergeId
* @param null $join
* @param null $where
* @param bool $flip
}
/**
- * @param null $id
+ * @param int $id
* @param null $cacheKey
* @param string $entityTable
*/
}
/**
- * @param null $rgid
- * @param null $gid
+ * @param int $rgid
+ * @param int $gid
* @param null $cacheKeyString
*/
static function refillCache($rgid = NULL, $gid = NULL, $cacheKeyString = NULL) {
}
/**
- * get the selections
+ * Get the selections
*
* @param string $cacheKey cache key
* @param string $action action
self::$status = $status;\r
}\r
/**\r
- * save records in civicrm_recujrring_entity table\r
+ * Save records in civicrm_recujrring_entity table\r
*\r
* @param array $params reference array contains the values submitted by the form\r
*\r
}
/**
- * @param $tableName
- * @param $fkTableName
+ * @param string $tableName
+ * @param string $fkTableName
*
* @return bool
*/
* @param array $params
* @param $separator
* @param $prefix
- * @param $tableName
+ * @param string $tableName
*
* @return null|string
*/
}
/**
- * delete a civiCRM-table
+ * Delete a civiCRM-table
*
* @param String $tableName name of the table to be created.
*
}
/**
- * @param $tableName
- * @param $columnName
+ * @param string $tableName
+ * @param string $columnName
*/
static function dropColumn($tableName, $columnName) {
$sql = "ALTER TABLE $tableName DROP COLUMN $columnName";
}
/**
- * @param $tableName
+ * @param string $tableName
* @param bool $dropUnique
*/
static function changeUniqueToIndex($tableName, $dropUnique = TRUE) {
}
/**
- * @param $customFieldID
- * @param $tableName
- * @param $columnName
+ * @param int $customFieldID
+ * @param string $tableName
+ * @param string $columnName
* @param $length
*
* @throws Exception
class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting {
/**
- * various predefined settings that have been migrated to the setting table
+ * Various predefined settings that have been migrated to the setting table
*/
CONST
ADDRESS_STANDARDIZATION_PREFERENCES_NAME = 'Address Standardization Preferences',
* @param int $contactID If set, this is a contactID specific setting, else its a global setting
* @param bool|int $load if true, load from local cache (typically memcache)
*
- * @param null $domainID
+ * @param int $domainID
* @param bool $force
*
* @return boolean true if item is already in cache
/**
* @param $values
* @param $group
- * @param null $componentID
- * @param null $contactID
- * @param null $domainID
+ * @param int $componentID
+ * @param int $contactID
+ * @param int $domainID
*
* @return string
*/
/**
* @param $group
* @param null $name
- * @param null $componentID
- * @param null $contactID
- * @param null $domainID
+ * @param int $componentID
+ * @param int $contactID
+ * @param int $domainID
*
* @return CRM_Core_DAO_Domain|CRM_Core_DAO_Setting
*/
* @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 null $domainID
+ * @param int $domainID
*
* @return mixed The data if present in the setting table, else null
* @static
* @param string $group (required) The group name of the item
* @param string $name (required) The name of the setting
* @param int $componentID The optional component ID (so componenets can share the same name space)
- * @param null $contactID
+ * @param int $contactID
* @param int $createdID An optional ID to assign the creator to. If not set, retrieved from session
*
- * @param null $domainID
+ * @param int $domainID
*
* @return void
* @static
* @param array $metadata metadata describing this field
* @param $value
* @param $group
- * @param $name
- * @param null $componentID
- * @param null $contactID
- * @param null $createdID
- * @param null $domainID
+ * @param string $name
+ * @param int $componentID
+ * @param int $contactID
+ * @param int $createdID
+ * @param int $domainID
*/
static function _setItem(
$metadata,
}
/**
- * gets metadata about the settings fields (from getfields) based on the fields being passed in
+ * Gets metadata about the settings fields (from getfields) based on the fields being passed in
*
* This function filters on the fields like 'version' & 'debug' that are not settings
*
}
/**
- * move an item from being in the config array to being stored as a setting
+ * Move an item from being in the config array to being stored as a setting
* remove from config - as appropriate based on metadata
*
* Note that where the key name is being changed the 'legacy_key' will give us the old name
/**
* @param $group
- * @param $name
+ * @param string $name
* @param bool $system
- * @param null $userID
+ * @param int $userID
* @param bool $localize
* @param string $returnField
* @param bool $returnNameANDLabels
/**
* @param $group
- * @param $name
+ * @param string $name
* @param $value
* @param bool $system
- * @param null $userID
+ * @param int $userID
* @param string $keyField
*/
static function setValueOption($group,
/**
* @param array $params
- * @param null $domainID
+ * @param int $domainID
*/
static function fixAndStoreDirAndURL(&$params, $domainID = NULL) {
if (self::isUpgradeFromPreFourOneAlpha1()) {
* for a setting.
*
* @param $group
- * @param $name
+ * @param string $name
* @param $default
*
* @return mixed, NULL or an overriden value
}
/**
- * civicrm_setting didn't exist before 4.1.alpha1 and this function helps taking decisions during upgrade
+ * Civicrm_setting didn't exist before 4.1.alpha1 and this function helps taking decisions during upgrade
*
* @return boolean
*/
class CRM_Core_BAO_Tag extends CRM_Core_DAO_Tag {
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
* @param array $usedFor
* @param bool $buildSelect
* @param bool $all
- * @param null $parentId
+ * @param int $parentId
*
* @return array
*/
/**
* @param string $usedFor
* @param array $tags
- * @param null $parentId
+ * @param int $parentId
* @param string $separator
*
* @return array
}
/**
- * delete the tag
+ * Delete the tag
*
* @param int $id tag id
*
}
/**
- * takes an associative array and creates a contact object
+ * Takes an associative array and creates a contact object
*
* The function extract all the params it needs to initialize the create a
* contact object. the params array could contain additional unused name/value
}
/**
- * get the tag sets for a entity object
+ * Get the tag sets for a entity object
*
* @param string $entityTable entity_table
*
}
/**
- * get the tags that are not children of a tagset.
+ * Get the tags that are not children of a tagset.
*
* @return array $tags associated array of tag name and id@access public
* @static
}
/**
- * update the is_active flag in the db
+ * 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
}
/**
- * check duplicate for duplicate field in a group
+ * Check duplicate for duplicate field in a group
*
* @param array $params an associative array with field and values
* @param $ids
}
/**
- * add the UF Field
+ * Add the UF Field
*
* @param array $params (reference) array containing the values submitted by the form
* @param array $ids array containing the id
}
/**
- * enable/disable profile field given a custom field id
+ * Enable/disable profile field given a custom field id
*
* @param int $customFieldId custom field id
* @param boolean $is_active set the is_active field
}
/**
- * Function to copy existing profile fields to
+ * Copy existing profile fields to
* new profile from the already built profile
*
* @param int $old_id from which we need to copy
}
/**
- * Function to delete profile field given a custom field
+ * Delete profile field given a custom field
*
* @param int $customFieldId ID of the custom field to be deleted
*
}
/**
- * Function to enable/disable profile field given a custom group id
+ * Enable/disable profile field given a custom group id
*
* @param int $customGroupId custom group id
* @param boolean $is_active value we want to set the is_active field
}
/**
- * Function to check the status of custom field used in uf fields
+ * Check the status of custom field used in uf fields
*
* @param int $UFFieldId
*
}
/**
- * Function to find out whether given profile group using Activity
+ * Find out whether given profile group using Activity
* Profile fields with contact fields
*/
static function checkContactActivityProfileType($ufGroupId) {
}
/**
- * Function to find out whether given profile group uses $required
+ * Find out whether given profile group uses $required
* and/or $optional profile types
*
* @param integer $ufGroupId profile id
}
/**
- * function to get the profile type (eg: individual/organization/household)
+ * Get the profile type (eg: individual/organization/household)
*
* @param int $ufGroupId uf group id
* @param boolean $returnMixType this is true, then field type of mix profile field is returned
}
/**
- * function to get the profile type (eg: individual/organization/household)
+ * Get the profile type (eg: individual/organization/household)
*
* @param string $ufGroupType
* @param boolean $returnMixType this is true, then field type of mix profile field is returned
}
/**
- * function to check for mix profiles groups (eg: individual + other contact types)
+ * Check for mix profiles groups (eg: individual + other contact types)
*
* @param $ctype
*
LISTINGS_VISIBILITY = 4;
/**
- * cache the match clause used in this transaction
+ * Cache the match clause used in this transaction
*
* @var string
*/
}
/**
- * update the is_active flag in the db
+ * 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
}
/**
- * get all the registration fields
+ * Get all the registration fields
*
* @param int $action what action are we doing
* @param int $mode mode
}
/**
- * get all the listing fields
+ * Get all the listing fields
*
* @param int $action what action are we doing
* @param int $visibility visibility of fields we are interested in
}
/**
- * check the data validity
+ * Check the data validity
*
* @param int $userID the user id that we are actually editing
* @param string $title the title of the group we are interested in
}
/**
- * get the html for the form that represents this particular group
+ * Get the html for the form that represents this particular group
*
* @param int $userID the user id that we are actually editing
* @param string $title the title of the group we are interested in
}
/**
- * searches for a contact in the db with similar attributes
+ * Searches for a contact in the db with similar attributes
*
* @param array $params the list of values to be used in the where clause
* @param int $id the current contact id (hence excluded from matching)
* Given a contact id and a field set, return the values from the db
* for this contact
*
- * @param $cid
+ * @param int $cid
* @param array $fields the profile fields of interest
* @param array $values the values for the above fields
* @param boolean $searchable searchable or not
}
/**
- * add the UF Group
+ * Add the UF Group
*
* @param array $params reference array contains the values submitted by the form
* @param array $ids reference array contains the id
}
/**
- * make uf join entries for an uf group
+ * Make uf join entries for an uf group
*
* @param array $params (reference) an assoc array of name/value pairs
* @param int $ufGroupId ufgroup id
}
/**
- * get the UF Join records for an ufgroup id
+ * Get the UF Join records for an ufgroup id
*
* @param int $ufGroupId uf group id
* @param int $displayName if set return display name in array
}
/**
- * Function to delete the uf join record for an uf group
+ * Delete the uf join record for an uf group
*
* @param array $params (reference) an assoc array of name/value pairs
*
}
/**
- * Function to get the weight for ufjoin record
+ * Get the weight for ufjoin record
*
* @param int $ufGroupId if $ufGroupId get update weight or add weight
*
}
/**
- * Function to get the uf group for a module
+ * Get the uf group for a module
*
* @param string $moduleName module name
* @param int $count no to increment the weight
}
/**
- * Function to filter ufgroups based on logged in user contact type
+ * Filter ufgroups based on logged in user contact type
*
* @param int $ufGroupId uf group id (profile id)
* @param int $contactID
}
/**
- * Function to add profile field to a form
+ * Add profile field to a form
*
* @param CRM_Core_Form $form
* @param array $field properties
}
/**
- * Function to set profile defaults
+ * Set profile defaults
*
* @param int $contactId contact id
* @param array $fields associative array of fields
}
/**
- * Function to get profiles by type eg: pure Individual etc
+ * Get profiles by type eg: pure Individual etc
*
* @param array $types associative array of types eg: types('Individual')
* @param boolean $onlyPure true if only pure profiles are required
}
/**
- * Function to check whether a profile is valid combination of
+ * Check whether a profile is valid combination of
* required and/or optional profile types
*
* @param array $required array of types those are required
}
/**
- * Function to check whether a profile is valid combination of
+ * Check whether a profile is valid combination of
* required profile fields
*
* @param array $ufId integer id of the profile
}
/**
- * Function to get default value for Register.
+ * Get default value for Register.
*
* @param $fields
* @param $defaults
}
/**
- * Function to assign uf fields to template
+ * Assign uf fields to template
*
* @param int $gid group id
* @param array $values
*
* @param array $params associated array
*
- * @param null $contactId
+ * @param int $contactId
*
* @return array $data assoicated formatted array
* @access public
}
/**
- * calculate the profile type 'group_type' as per profile fields.
+ * Calculate the profile type 'group_type' as per profile fields.
*
* @param int $gId profile id
* @param bool $includeTypeValues
}
/**
- * calculate the profile type 'group_type' as per profile fields.
+ * Calculate the profile type 'group_type' as per profile fields.
*
* @param $ufFields
* @param bool $includeTypeValues
}
/**
- * Function to retrieve groups of profiles
+ * Retrieve groups of profiles
*
* @param integer $profileID id of the profile
*
}
/**
- * Function to alter contact params by filtering existing subscribed groups and returns
+ * Alter contact params by filtering existing subscribed groups and returns
* unsubscribed groups array for subscription.
*
* @param array $params contact params
}
/**
- * Function to check if we are rendering mixed profiles
+ * Check if we are rendering mixed profiles
*
* @param array $profileIds associated array of profile ids
*
}
/**
- * Function to determine of we show overlay profile or not
+ * Determine of we show overlay profile or not
*
* @return boolean true if profile should be shown else false
* @static
}
/**
- * function to get group type values of the profile
+ * Get group type values of the profile
*
* @param int $profileId
* @param string $groupType
}
/**
- * get profiles used for batch entry
+ * Get profiles used for batch entry
*
* @return array profileIds profile ids
* @static
class CRM_Core_BAO_UFJoin extends CRM_Core_DAO_UFJoin {
/**
- * takes an associative array and creates a uf join object
+ * Takes an associative array and creates a uf join object
*
* @param array $params (reference) an assoc array of name/value pairs
*
}
/**
- * update the uf_name in the user object
+ * Update the uf_name in the user object
*
* @param int $contactId id of the contact to update
*
}
/**
- * get the contact_id given a uf_id
+ * Get the contact_id given a uf_id
*
* @param int $ufID Id of UF for which related contact_id is required
*
}
/**
- * get the uf_id given a contact_id
+ * Get the uf_id given a contact_id
*
* @param int $contactID ID of the contact for which related uf_id is required
*
}
/**
- * get the list of contact_id
+ * Get the list of contact_id
*
*
* @return int contact_id on success, null otherwise
}
/**
- * see if this user exists, and if so, if they're allowed to login
+ * See if this user exists, and if so, if they're allowed to login
*
*
- * @param $openId
+ * @param int $openId
*
* @return bool true if allowed to login, false otherwise
* @access public
}
/**
- * get the next unused uf_id value, since the standalone UF doesn't
+ * Get the next unused uf_id value, since the standalone UF doesn't
* have id's (it uses OpenIDs, which go in a different field)
*
*
class CRM_Core_BAO_Website extends CRM_Core_DAO_Website {
/**
- * takes an associative array and adds im
+ * Takes an associative array and adds im
*
* @param array $params (reference ) an assoc array of name/value pairs
*
}
/**
- * process website
+ * Process website
*
* @param array $params associated array
* @param int $contactID contact id
class CRM_Core_BAO_WordReplacement extends CRM_Core_DAO_WordReplacement {
/**
- * class constructor
+ * Class constructor
*
* @access public
* @return \CRM_Core_DAO_WordReplacement
* Save the values of a WordReplacement
*
* @param array $params
- * @param $id
+ * @param int $id
*
* @return WordReplacement array
* @access public
class CRM_Core_Base {
/**
- * constructor
+ * Constructor
*/
function __construct() {}
}
class CRM_Core_Block {
/**
- * the following blocks are supported
+ * The following blocks are supported
*
* @var int
*/
FULLTEXT_SEARCH = 7;
/**
- * template file names for the above blocks
+ * Template file names for the above blocks
*/
static $_properties = NULL;
/**
- * class constructor
+ * Class constructor
*
*/
function __construct() {}
/**
- * initialises the $_properties array
+ * Initialises the $_properties array
*
* @return void
*/
}
/**
- * returns the desired property from the $_properties array
+ * Returns the desired property from the $_properties array
*
* @param int $id one of the class constants (ADD, SEARCH, etc.)
* @param string $property the desired property
}
/**
- * sets the desired property in the $_properties array
+ * Sets the desired property in the $_properties array
*
* @param int $id one of the class constants (ADD, SEARCH, etc.)
* @param string $property the desired property
}
/**
- * returns the whole $_properties array
+ * Returns the whole $_properties array
*
* @return array the $_properties array
*/
}
/**
- * set the post action values for the block.
+ * Set the post action values for the block.
*
* php is lame and u cannot call functions from static initializers
* hence this hack
*
- * @param $id
+ * @param int $id
*
* @return void
* @access private
}
/**
- * create the list of options to create New objects for the application and format is as a block
+ * Create the list of options to create New objects for the application and format is as a block
*
* @return void
* @access private
}
/**
- * create the list of dashboard links
+ * Create the list of dashboard links
*
* @return void
* @access private
}
/**
- * create the list of mail urls for the application and format is as a block
+ * Create the list of mail urls for the application and format is as a block
*
* @return void
* @access private
}
/**
- * create the list of shortcuts for the application and format is as a block
+ * Create the list of shortcuts for the application and format is as a block
*
* @return void
* @access private
}
/**
- * create the event blocks for upcoming events
+ * Create the event blocks for upcoming events
*
* @return void
* @access private
/**
* @param $tables
- * @param $classNames
+ * @param string $classNames
*/
function resolveForeignKeys(&$tables, &$classNames) {
foreach (array_keys($tables) as $name) {
/**
* @param $tables
- * @param $classNames
- * @param $name
+ * @param string $classNames
+ * @param string $name
*/
function resolveForeignKey(&$tables, &$classNames, $name) {
if (!array_key_exists('foreignKey', $tables[$name])) {
/**
* @param $tables
- * @param $valid
- * @param $name
+ * @param int $valid
+ * @param string $name
*
* @return bool
*/
}
/**
- * @param $name
+ * @param string $name
*
* @return string
*/
* @param $foreignXML
* @param $fields
* @param $foreignKeys
- * @param $currentTableName
+ * @param string $currentTableName
*/
function getForeignKey(&$foreignXML, &$fields, &$foreignKeys, &$currentTableName) {
$name = trim((string ) $foreignXML->name);
/**
* @param $attributes
* @param $object
- * @param $name
+ * @param string $name
* @param null $pre
* @param null $post
*/
}
/**
- * @param $name
+ * @param string $name
* @param null $attribute
*
* @return mixed
}
/**
- * @param $componentName
+ * @param string $componentName
*
* @return mixed
*/
}
/**
- * @param $componentID
+ * @param int $componentID
*
* @return int|null|string
*/
/**
* @param $query
- * @param $fnName
+ * @param string $fnName
*/
static function alterQuery(&$query, $fnName) {
$info = self::_info();
}
/**
- * @param $fieldName
+ * @param string $fieldName
* @param $mode
* @param $side
*
/**
* @param $row
- * @param $id
+ * @param int $id
*/
static function searchAction(&$row, $id) {
$info = self::_info();
}
/**
- * handle table dependencies of components
+ * Handle table dependencies of components
*
* @param array $tables array of tables
*
}
/**
- * get components info from info file
+ * Get components info from info file
*
*/
static function getComponentsFromFile($crmFolderDir) {
///
/**
- * the dsn of the database connection
+ * The dsn of the database connection
*
* @var string
*/
public $dsn;
/**
- * the name of user framework
+ * The name of user framework
*
* @var string
*/
public $userFramework = 'Drupal';
/**
- * the name of user framework url variable name
+ * The name of user framework url variable name
*
* @var string
*/
public $userFrameworkURLVar = 'q';
/**
- * the dsn of the database connection for user framework
+ * The dsn of the database connection for user framework
*
* @var string
*/
///
/**
- * are we initialized and in a proper state
+ * Are we initialized and in a proper state
*
* @var string
*/
public $customPHPPathDir;
/**
- * the factory class used to instantiate our DB objects
+ * The factory class used to instantiate our DB objects
*
* @var string
*/
private static $_log = NULL;
/**
- * the handle on the mail handler that we are using
+ * The handle on the mail handler that we are using
*
* @var object
*/
}
/**
- * initialize the DataObject framework
+ * Initialize the DataObject framework
*
* @return void
* @access private
}
/**
- * returns the singleton logger for the application
+ * Returns the singleton logger for the application
*
* @param
* @access private
}
/**
- * initialize the config variables
+ * Initialize the config variables
*
* @return void
* @access private
}
/**
- * verify that the needed parameters are not null in the config
+ * Verify that the needed parameters are not null in the config
*
* @param CRM_Core_Config (reference ) the system config object
* @param array (reference ) the parameters that need a value
}
/**
- * reset the serialized array and recompute
+ * Reset the serialized array and recompute
* use with care
*/
function reset() {
}
/**
- * one function to get domain ID
+ * One function to get domain ID
*/
static function domainID($domainID = NULL, $reset = FALSE) {
static $domain;
}
/**
- * do general cleanup of caches, temp directories and temp tables
+ * Do general cleanup of caches, temp directories and temp tables
* CRM-8739
*/
function cleanupCaches($sessionReset = TRUE) {
}
/**
- * clear db cache
+ * Clear db cache
*/
public static function clearDBCache() {
$queries = array(
}
/**
- * clear leftover temporary tables
+ * Clear leftover temporary tables
*/
public static function clearTempTables() {
// CRM-5645
}
/**
- * check if running in upgrade mode
+ * Check if running in upgrade mode
*/
static function isUpgradeMode($path = NULL) {
if (defined('CIVICRM_UPGRADE_ACTIVE')) {
}
/**
- * format size
+ * Format size
*
* @access public
* @static
}
/**
- * set the default values
+ * Set the default values
*
* @param array $defaults associated array of form elements
* @param bool|\boolena $formMode this funtion is called to set default
class CRM_Core_Config_Variables extends CRM_Core_Config_Defaults {
/**
- * the debug level for civicrm
+ * The debug level for civicrm
* @var int
*/
public $debug = 0;
public $backtrace = 0;
/**
- * the directory where Smarty and plugins are installed
+ * The directory where Smarty and plugins are installed
* @var string
*/
public $smartyDir = NULL;
public $pluginsDir = NULL;
/**
- * the root directory of our template tree
+ * The root directory of our template tree
* @var string
*/
public $templateDir = NULL;
public $userFrameworkLogging = FALSE;
/**
- * the handle for import file size
+ * The handle for import file size
* @var int
*/
public $maxImportFileSize = 1048576;
public $enableSSL = FALSE;
/**
- * error template to use for fatal errors
+ * Error template to use for fatal errors
*
* @var string
*/
public $fatalErrorTemplate = 'CRM/common/fatal.tpl';
/**
- * fatal error handler
+ * Fatal error handler
*
* @var string
*/
public $fatalErrorHandler = NULL;
/**
- * legacy encoding for file encoding conversion
+ * Legacy encoding for file encoding conversion
*
* @var string
*/
public $legacyEncoding = 'Windows-1252';
/**
- * field separator for import/export csv file
+ * Field separator for import/export csv file
*
* @var string
*/
public $fieldSeparator = ',';
/**
- * max location blocks in address
+ * Max location blocks in address
*
* @var integer
*/
public $maxLocationBlocks = 2;
/**
- * the font path where captcha fonts are stored
+ * The font path where captcha fonts are stored
*
* @var string
*/
public $captchaFontPath = '/usr/X11R6/lib/X11/fonts/';
/**
- * the font to use for captcha
+ * The font to use for captcha
*
* @var string
*/
public $dashboardCacheTimeout = 1440;
/**
- * flag to indicate if acl cache is NOT to be reset
+ * Flag to indicate if acl cache is NOT to be reset
*/
public $doNotResetCache = 0;
public $oldInputStyle = 1;
/**
- * should we disable key generation for forms
+ * Should we disable key generation for forms
*
* @var boolean
*/
public $formKeyDisable = FALSE;
/**
- * to determine whether the call is from cms or civicrm
+ * To determine whether the call is from cms or civicrm
*/
public $inCiviCRM = FALSE;
/**
- * component registry object (of CRM_Core_Component type)
+ * Component registry object (of CRM_Core_Component type)
*/
public $componentRegistry = NULL;
class CRM_Core_Controller extends HTML_QuickForm_Controller {
/**
- * the title associated with this controller
+ * The title associated with this controller
*
* @var string
*/
public $_key;
/**
- * the name of the session scope where values are stored
+ * The name of the session scope where values are stored
*
* @var object
*/
protected $_scope;
/**
- * the state machine associated with this controller
+ * The state machine associated with this controller
*
* @var object
*/
public $_QFResponseType = 'html';
/**
- * cache the smarty template for efficiency reasons
+ * Cache the smarty template for efficiency reasons
*
* @var CRM_Core_Smarty
*/
static protected $_template;
/**
- * cache the session for efficiency reasons
+ * Cache the session for efficiency reasons
*
* @var CRM_Core_Session
*/
}
/**
- * @param $name
+ * @param string $name
* @param bool $addSequence
* @param bool $ignoreKey
*
}
/**
- * getter method for stateMachine
+ * Getter method for stateMachine
*
* @return CRM_Core_StateMachine
* @access public
}
/**
- * setter method for stateMachine
+ * Setter method for stateMachine
*
* @param CRM_Core_StateMachine $stateMachine
*
}
/**
- * add pages to the controller. Note that the controller does not really care
+ * Add pages to the controller. Note that the controller does not really care
* the order in which the pages are added
*
* @param CRM_Core_StateMachine $stateMachine
}
/**
- * destroy all the session state of the controller.
+ * Destroy all the session state of the controller.
*
* @access public
*
}
/**
- * virtual function to do any processing of data.
+ * Virtual function to do any processing of data.
* Sometimes it is useful for the controller to actually process data.
* This is typically used when we need the controller to figure out
* what pages are potentially involved in this wizard. (this is dynamic
}
/**
- * assign value to name in template
+ * Assign value to name in template
*
* @param string $var
* @param mixed $value value of varaible
}
/**
- * assign value to name in template by reference
+ * Assign value to name in template by reference
*
* @param string $var
* @param mixed $value (reference) value of varaible
}
/**
- * appends values to template variables
+ * Appends values to template variables
*
* @param array|string $tpl_var the template variable name(s)
* @param mixed $value the value to append
}
/**
- * setter for embedded
+ * Setter for embedded
*
* @param boolean $embedded
*
}
/**
- * getter for embedded
+ * Getter for embedded
*
* @return boolean return the embedded value
* @access public
}
/**
- * setter for skipRedirection
+ * Setter for skipRedirection
*
* @param boolean $skipRedirection
*
}
/**
- * getter for skipRedirection
+ * Getter for skipRedirection
*
* @return boolean return the skipRedirection value
* @access public
}
/**
- * setter for print
+ * Setter for print
*
* @param boolean $print
*
}
/**
- * getter for print
+ * Getter for print
*
* @return boolean return the print value
* @access public
class CRM_Core_Controller_Simple extends CRM_Core_Controller {
/**
- * constructor
+ * Constructor
*
* @param null $path
* @param bool $title
class CRM_Core_DAO extends DB_DataObject {
/**
- * a null object so we can pass it as reference if / when needed
+ * A null object so we can pass it as reference if / when needed
*/
static $_nullObject = NULL;
static $_nullArray = array();
*/
static $_testEntitiesToSkip = array();
/**
- * the factory class for this application
+ * The factory class for this application
* @var object
*/
static $_factory = NULL;
}
/**
- * empty definition for virtual function
+ * Empty definition for virtual function
*/
static function getTableName() {
return NULL;
}
/**
- * initialize the DAO object
+ * Initialize the DAO object
*
* @param string $dsn the database connection string
*
}
/**
- * @param $fieldName
+ * @param string $fieldName
* @param $fieldDef
* @param array $params
*
}
/**
- * reset the DAO object. DAO is kinda crappy in that there is an unwritten
+ * Reset the DAO object. DAO is kinda crappy in that there is an unwritten
* rule of one query per DAO. We attempt to get around this crappy restricrion
* by resetting some of DAO's internal fields. Use this with caution
*
}
/**
- * @param $tableName
+ * @param string $tableName
*
* @return string
*/
}
/**
- * returns list of FK relationships
+ * Returns list of FK relationships
*
* @static
* @access public
}
/**
- * returns all the column names of this table
+ * Returns all the column names of this table
*
* @access public
*
}
/**
- * get/set an associative array of table columns
+ * Get/set an associative array of table columns
*
* @access public
* @param array key=>type array
}
/**
- * create an attribute for this specific field. We only do this for strings and text
+ * Create an attribute for this specific field. We only do this for strings and text
*
* @param array $field the field under task
*
}
/**
- * execute a query
+ * Execute a query
*
* @param string $query query to be executed
*
}
/**
- * execute a query and get the single result
+ * Execute a query and get the single result
*
* @param string $query query to be executed
* @param array $params
* since its used for things like send email
*
* @param $componentIDs
- * @param $tableName
+ * @param string $tableName
*
* @return array
*/
*
* @param string $daoName name of the dao object
* @param string $fieldIdName
- * @param $fieldId
+ * @param int $fieldId
* @param $details
* @param array $returnProperities an assoc array of fields that need to be returned, eg array( 'first_name', 'last_name')
*
}
/**
- * deletes the this object plus any dependent objects that are associated with it
+ * Deletes the this object plus any dependent objects that are associated with it
* ONLY USE FOR TESTING
*
* @param string $daoName
}
/**
- * @param $fieldName
+ * @param string $fieldName
* @return bool|array
*/
function getFieldSpec($fieldName) {
static $_suffix = '.php';
/**
- * @param $className
+ * @param string $className
*
* @return mixed
* @throws Exception
class CRM_Core_Error extends PEAR_ErrorStack {
/**
- * status code of various types of errors
+ * Status code of various types of errors
* @var const
*/
CONST FATAL_ERROR = 2;
public static $modeException = NULL;
/**
- * singleton function used to manage this object.
+ * Singleton function used to manage this object.
*
* @param null $package
* @param bool $msgCallback
}
/**
- * constructor
+ * Constructor
*/
function __construct() {
parent::__construct('CiviCRM');
}
/**
- * create the main callback method. this method centralizes error processing.
+ * Create the main callback method. this method centralizes error processing.
*
* the errors we expect are from the pear modules DB, DB_DataObject
* which currently use PEAR::raiseError to notify of error messages.
}
/**
- * display an error page with an error message describing what happened
+ * Display an error page with an error message describing what happened
*
* @param string $message the error message
* @param string $code the error code if any
}
/**
- * display an error page with an error message describing what happened
+ * Display an error page with an error message describing what happened
*
* This function is evil -- it largely replicates fatal(). Hopefully the
* entire CRM_Core_Error system can be hollowed out and replaced with
}
/**
- * outputs pre-formatted debug information. Flushes the buffers
+ * Outputs pre-formatted debug information. Flushes the buffers
* so we can interrupt a potential POST/redirect
*
* @param string name of debug section
}
/**
- * display the error message on terminal
+ * Display the error message on terminal
*
* @param $message
* @param bool $out should we log or return the output
* @param $message
* @param int $code
* @param string $level
- * @param null $params
+ * @param array $params
*
* @return object
*/
}
/**
- * reset the error stack
+ * Reset the error stack
*
* @access public
* @static
protected $_action;
/**
- * the renderer used for this form
+ * The renderer used for this form
*
* @var object
*/
protected $_dateFields = array();
/**
- * cache the smarty template for efficiency reasons
+ * Cache the smarty template for efficiency reasons
*
* @var CRM_Core_Smarty
*/
public $controller;
/**
- * constants for attributes for various form elements
+ * Constants for attributes for various form elements
* attempt to standardize on the number of variations that we
* use of the below form elements
*
/**
* Add one or more css classes to the form
- * @param $className
+ * @param string $className
*/
public function addClass($className) {
$classes = $this->getAttribute('class');
}
/**
- * register all the standard rules that most forms potentially use
+ * Register all the standard rules that most forms potentially use
*
* @return void
* @access private
}
/**
- * getter function for Name
+ * Getter function for Name
*
* @return string
* @access public
}
/**
- * getter function for State
+ * Getter function for State
*
* @return object
* @access public
}
/**
- * getter function for StateType
+ * Getter function for StateType
*
* @return int
* @access public
}
/**
- * getter function for title. Should be over-ridden by derived class
+ * Getter function for title. Should be over-ridden by derived class
*
* @return string
* @access public
}
/**
- * setter function for title.
+ * Setter function for title.
*
* @param string $title the title of the form
*
}
/**
- * getter function for link.
+ * Getter function for link.
*
* @return string
* @access public
}
/**
- * boolean function to determine if this is a one form page
+ * Boolean function to determine if this is a one form page
*
* @return boolean
* @access public
}
/**
- * getter function for Form Action
+ * Getter function for Form Action
*
* @return string
* @access public
}
/**
- * setter function for Form Action
+ * Setter function for Form Action
*
* @param string
*
}
/**
- * render form and return contents
+ * Render form and return contents
*
* @return string
* @access public
}
/**
- * getter function for renderer. If renderer is not set
+ * Getter function for renderer. If renderer is not set
* create one and initialize it
*
* @return object
}
/**
- * getter for action
+ * Getter for action
*
* @return int
* @access public
}
/**
- * setter for action
+ * Setter for action
*
* @param int $action the mode we want to set the form
*
}
/**
- * assign value to name in template
+ * Assign value to name in template
*
* @param string $var name of variable
* @param mixed $value value of variable
}
/**
- * assign value to name in template by reference
+ * Assign value to name in template by reference
*
* @param string $var name of variable
* @param mixed $value value of varaible
}
/**
- * appends values to template variables
+ * Appends values to template variables
*
* @param array|string $tpl_var the template variable name(s)
* @param mixed $value the value to append
}
/**
- * @param $name
+ * @param string $name
* @param $title
* @param $values
* @param array $attributes
}
/**
- * @param $id
+ * @param int $id
* @param $title
* @param bool $allowClear
* @param null $required
}
/**
- * @param $id
+ * @param int $id
* @param $title
* @param $values
* @param null $other
}
/**
- * simple shell that derived classes can call to add buttons to
+ * Simple shell that derived classes can call to add buttons to
* the form with a customized title for the main Submit
*
* @param string $title title of the main button
}
/**
- * @param $name
+ * @param string $name
* @param string $from
* @param string $to
* @param string $label
}
/**
- * @param $name
+ * @param string $name
* @param $label
* @param $attributes
* @param bool $forceTextarea
}
/**
- * @param $id
+ * @param int $id
* @param $title
* @param null $required
* @param null $extra
}
/**
- * @param $name
+ * @param string $name
* @param $label
* @param $options
* @param $attributes
}
/**
- * add a currency and money element to the form
+ * Add a currency and money element to the form
*/
function addMoney($name,
$label,
}
/**
- * add currency element to the form
+ * Add currency element to the form
*/
function addCurrency($name = 'currency',
$label = NULL,
}
/**
- * add autoselector field -if user has permission to view contacts
+ * Add autoselector field -if user has permission to view contacts
* If adding this to a form you also need to add to the tpl e.g
*
* {if !empty($selectable)}
Class CRM_Core_Form_Date {
/**
- * various Date Formats
+ * Various Date Formats
*/
CONST DATE_yyyy_mm_dd = 1, DATE_mm_dd_yy = 2, DATE_mm_dd_yyyy = 4, DATE_Month_dd_yyyy = 8, DATE_dd_mon_yy = 16, DATE_dd_mm_yyyy = 32;
}\r
\r
/**\r
- * global validation rules for the form\r
+ * Global validation rules for the form\r
*\r
* @param array $fields posted values of the form\r
*\r
static private $_singleton = NULL;
/**
- * the converter from array size to css class
+ * The converter from array size to css class
*
* @var array
* @static
protected $_force;
/**
- * name of search button
+ * Name of search button
*
* @var string
* @access protected
protected $_searchButtonName;
/**
- * name of action button
+ * Name of action button
*
* @var string
* @access protected
protected $_actionButtonName;
/**
- * form values that we will be using
+ * Form values that we will be using
*
* @var array
* @access public
public $_formValues;
/**
- * have we already done this search
+ * Have we already done this search
*
* @access protected
* @var boolean
protected $_done;
/**
- * what context are we being invoked from
+ * What context are we being invoked from
*
* @access protected
* @var string
public $_entityTagValues;
/**
- * build tag widget if correct parent is passed
+ * Build tag widget if correct parent is passed
*
* @param CRM_Core_Form $form form object
* @param string $parentNames parent name ( tag name)
}
/**
- * save entity tags when it is not save used AJAX
+ * Save entity tags when it is not save used AJAX
*
* @param array $params associated array
* @param int $entityId entity id, eg: contact id, activity id, case id, file id
class CRM_Core_IDS {
/**
- * define the threshold for the ids reactions
+ * Define the threshold for the ids reactions
*/
private $threshold = array(
'log' => 25,
);
/**
- * the init object
+ * The init object
*/
private $init = NULL;
}
/**
- * @param $id
+ * @param int $id
*/
public function executeJobById($id) {
$job = $this->_getJob($id);
*
*/
/**
- * @param null $id
+ * @param int $id
* @param null $entity
* @param null $action
*
class CRM_Core_Menu {
/**
- * the list of menu items
+ * The list of menu items
*
* @var array
* @static
static $_items = NULL;
/**
- * the list of permissioned menu items
+ * The list of permissioned menu items
*
* @var array
* @static
}
/**
- * @param $name
+ * @param string $name
* @param $menu
*
* @throws Exception
public $is_active;
/**
- * @param $name
+ * @param string $name
* @param $is_active
*/
public function __construct($name, $is_active) {
/**
* Counterpart to values() which removes the item from the cache
*
- * @param $name
+ * @param string $name
* @param $flip
* @param $grouping
* @param $localize
* @param $condition
- * @param $labelColumnName
+ * @param string $labelColumnName
* @param $onlyActive
* @param string $keyColumnName
*/
}
/**
- * lookup titles OR ids for a set of option_value populated fields. The retrieved value
+ * Lookup titles OR ids for a set of option_value populated fields. The retrieved value
* is assigned a new fieldname by id or id's by title
* (each within a specificied option_group)
*
}
/**
- * @param $groupName
+ * @param string $groupName
* @param $value
* @param bool $onlyActiveValue
*
}
/**
- * @param $groupName
+ * @param string $groupName
* @param $label
* @param string $labelField
* @param string $labelType
}
/**
- * @param $groupName
+ * @param string $groupName
* @param $values
* @param bool $flip
* @param string $field
}
/**
- * @param $groupName
+ * @param string $groupName
* @param string $operator
*/
static function deleteAssoc($groupName, $operator = "=") {
}
/**
- * @param $groupName
+ * @param string $groupName
* @param $value
*
* @return null|string
}
/**
- * @param $groupName
+ * @param string $groupName
* @param $fieldValue
* @param string $field
* @param string $fieldType
class CRM_Core_OptionValue {
/**
- * static field for all the option value information that we can potentially export
+ * Static field for all the option value information that we can potentially export
*
* @var array
* @static
static $_exportableFields = NULL;
/**
- * static field for all the option value information that we can potentially export
+ * Static field for all the option value information that we can potentially export
*
* @var array
* @static
static $_importableFields = NULL;
/**
- * static field for all the option value information that we can potentially export
+ * Static field for all the option value information that we can potentially export
*
* @var array
* @static
static $_fields = NULL;
/**
- * return option-values of a particular group
+ * Return option-values of a particular group
*
* @param array $groupParams Array containing group fields whose option-values is to retrieved.
* @param string $orderBy for orderBy clause
}
/**
- * add/edit option-value of a particular group
+ * Add/edit option-value of a particular group
*
* @param array $params Array containing exported values from the invoking form.
* @param array $groupParams Array containing group fields whose option-values is to retrieved/saved.
* @param 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 int $optionGroupID
* @param string $fieldName the name of the field in the DAO
*
* @return boolean true if object exists
}
/**
- * build select query in case of option-values
+ * Build select query in case of option-values
*
* @param $query
*
}
/**
- * return option-values of a particular group
+ * Return option-values of a particular group
*
* @param array $groupParams Array containing group fields
* whose option-values is to retrieved.
protected $_name;
/**
- * the title associated with this page
+ * The title associated with this page
*
* @var object
* @access protected
protected $_print = FALSE;
/**
- * cache the smarty template for efficiency reasons
+ * Cache the smarty template for efficiency reasons
*
* @var CRM_Core_Smarty
* @access protected
static protected $_template;
/**
- * cache the session for efficiency reasons
+ * Cache the session for efficiency reasons
*
* @var CRM_Core_Session
* @access protected
public $useLivePageJS;
/**
- * class constructor
+ * Class constructor
*
* @param string $title title of the page
* @param int $mode mode of the page
}
/**
- * assign value to name in template
+ * Assign value to name in template
*
* @param string $var
* @param mixed $value value of varaible
}
/**
- * assign value to name in template by reference
+ * Assign value to name in template by reference
*
* @param string $var
* @param mixed $value (reference) value of varaible
}
/**
- * appends values to template variables
+ * Appends values to template variables
*
* @param array|string $tpl_var the template variable name(s)
* @param mixed $value the value to append
}
/**
- * destroy all the session state of this page.
+ * Destroy all the session state of this page.
*
* @access public
*
}
/**
- * setter for embedded
+ * Setter for embedded
*
* @param boolean $embedded
*
}
/**
- * getter for embedded
+ * Getter for embedded
*
* @return boolean return the embedded value
* @access public
}
/**
- * setter for print
+ * Setter for print
*
* @param boolean $print
*
}
/**
- * getter for print
+ * Getter for print
*
* @return boolean return the print value
* @access public
}
/**
- * @param $name
+ * @param string $name
*
* @return null
*/
}
/**
- * @param $name
+ * @param string $name
* @param $value
*/
function setVar($name, $value) {
class CRM_Core_Page_AJAX {
/**
- * call generic ajax forms
+ * Call generic ajax forms
*
* @static
* @access public
}
/**
- * change is_quick_config priceSet to complex
+ * Change is_quick_config priceSet to complex
*
* @static
* @access public
protected $_action;
/**
- * define all the abstract functions here
+ * Define all the abstract functions here
*/
/**
- * name of the BAO to perform various DB manipulations
+ * Name of the BAO to perform various DB manipulations
*
* @return string
* @access public
abstract function getBAOName();
/**
- * an array of action links
+ * An array of action links
*
* @return array (reference)
* @access public
abstract function &links();
/**
- * name of the edit form class
+ * Name of the edit form class
*
* @return string
* @access public
abstract function editForm();
/**
- * name of the form
+ * Name of the form
*
* @return string
* @access public
abstract function editName();
/**
- * userContext to pop back to
+ * UserContext to pop back to
*
* @param int $mode mode that we are in
*
abstract function userContext($mode = NULL);
/**
- * get userContext params
+ * Get userContext params
*
* @param int $mode mode that we are in
*
}
/**
- * allow objects to be added based on permission
+ * Allow objects to be added based on permission
*
* @param int $id the id of the object
* @param int $name the name or title of the object
}
/**
- * allows the derived class to add some more state variables to
+ * Allows the derived class to add some more state variables to
* the controller. By default does nothing, and hence is abstract
*
* @param CRM_Core_Controller $controller the controller object
function addValues($controller) {}
/**
- * class constructor
+ * Class constructor
*
* @param string $title title of the page
* @param int $mode mode of the page
}
/**
- * browse all entities.
+ * Browse all entities.
*
* @return void
* @access public
abstract class CRM_Core_Payment {
/**
- * how are we getting billing information?
+ * How are we getting billing information?
*
* FORM - we collect it on the same page
* BUTTON - the processor collects it and sends it back to us via some protocol
BILLING_MODE_NOTIFY = 4;
/**
- * which payment type(s) are we using?
+ * Which payment type(s) are we using?
*
* credit card
* direct debit
protected $_paymentForm = NULL;
/**
- * singleton function used to manage this object
+ * Singleton function used to manage this object
*
* @param string $mode the mode of operation: live or test
* @param array $paymentProcessor the details of the payment processor being invoked
}
/**
- * check if capability is supported
+ * Check if capability is supported
* @param string $capability e.g BackOffice, LiveMode, FutureRecurStartDate
*
* @return bool
}
/**
- * are back office payments supported - e.g paypal standard won't permit you to enter a credit card associated with someone else's login
+ * Are back office payments supported - e.g paypal standard won't permit you to enter a credit card associated with someone else's login
* The intention is to support off-site (other than paypal) & direct debit but that is not all working yet so to reach a 'stable' point we disable
* @return bool
*/
}
/**
- * are back office payments supported - e.g paypal standard won't permit you to enter a credit card associated with someone else's login
+ * Are back office payments supported - e.g paypal standard won't permit you to enter a credit card associated with someone else's login
* @return bool
*/
protected function supportsLiveMode() {
}
/**
- * should the first payment date be configurable when setting up back office recurring payments
+ * Should the first payment date be configurable when setting up back office recurring payments
* We set this to false for historical consistency but in fact most new processors use tokens for recurring and can support this
* @return bool
*/
/**
* Getter for accessing member vars
*
- * @param $name
+ * @param string $name
*
* @return null
*/
}
/**
- * get name for the payment information type
+ * Get name for the payment information type
*
* @return string
*/
}
/**
- * get label for the payment information type
+ * Get label for the payment information type
*
* @return string
*/
}
/**
- * get array of fields that should be displayed on the payment form
+ * Get array of fields that should be displayed on the payment form
* @todo make payment type an option value & use it in the function name - currently on debit & credit card work
* @return array
* @throws CiviCRM_API3_Exception
}
/**
- * get array of fields that should be displayed on the payment form for credit cards
+ * Get array of fields that should be displayed on the payment form for credit cards
*
* @return array
*/
}
/**
- * get array of fields that should be displayed on the payment form for direct debits
+ * Get array of fields that should be displayed on the payment form for direct debits
*
* @return array
*/
}
/**
- * return an array of all the details about the fields potentially required for payment fields
+ * Return an array of all the details about the fields potentially required for payment fields
* Only those determined by getPaymentFormFields will actually be assigned to the form
*
* @return array field metadata
abstract function doDirectPayment(&$params);
/**
- * process payment - this function wraps around both doTransferPayment and doDirectPayment
+ * Process payment - this function wraps around both doTransferPayment and doDirectPayment
* it ensures an exception is thrown & moves some of this logic out of the form layer and makes the forms more agnostic
*
* @param array $params
}
/**
- * check whether a method is present ( & supported ) by the payment processor object.
+ * Check whether a method is present ( & supported ) by the payment processor object.
*
* @param string $method method to check for.
*
}
/**
- * @param null $entityID
+ * @param int $entityID
* @param null $entity
* @param string $action
*
}
/**
- * singleton function used to manage this object
+ * Singleton function used to manage this object
*
* @param string $mode the mode of operation: live or test
* @param object $paymentProcessor the details of the payment processor being invoked
}
/**
- * should the first payment date be configurable when setting up back office recurring payments
+ * Should the first payment date be configurable when setting up back office recurring payments
* In the case of Authorize.net this is an option
* @return bool
*/
class CRM_Core_Payment_AuthorizeNetIPN extends CRM_Core_Payment_BaseIPN {
/**
- * constructor function
+ * Constructor function
*
* @param $inputData array contents of HTTP REQUEST
*
// function to copy custom data of the
// initial contribution into its recurring contributions
/**
- * @param $recurId
- * @param $targetContributionId
+ * @param int $recurId
+ * @param int $targetContributionId
*/
function copyCustomValues($recurId, $targetContributionId) {
if ($recurId && $targetContributionId) {
// function to copy soft credit record of first recurring contribution
// and add new soft credit against $targetContributionId
/**
- * @param $recurId
- * @param $targetContributionId
+ * @param int $recurId
+ * @param int $targetContributionId
*/
function addrecurSoftCredit($recurId, $targetContributionId) {
$contriID = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $recurId, 'id', 'contribution_recur_id');
}
/**
- * singleton function used to manage this object
+ * Singleton function used to manage this object
*
* @param string $mode the mode of operation: live or test
*
}
/**
- * are back office payments supported - e.g paypal standard won't permit you to enter a credit card associated with someone else's login
+ * Are back office payments supported - e.g paypal standard won't permit you to enter a credit card associated with someone else's login
* @return bool
*/
protected function supportsLiveMode() {
}
/**
- * singleton function used to manage this object
+ * Singleton function used to manage this object
*
* @param string $mode the mode of operation: live or test
*
}
/**
- * singleton function used to manage this object
+ * Singleton function used to manage this object
*
* @param string $mode the mode of operation: live or test
*
}
/**
- * add general billing fields
+ * Add general billing fields
* @todo set these like processor fields & let payment processors alter them
*
* @param CRM_Core_Form $form
}
/**
- * billing mode button is basically synonymous with paypal express - this is probably a good example of 'odds & sods' code we
+ * Billing mode button is basically synonymous with paypal express - this is probably a good example of 'odds & sods' code we
* need to find a way for the payment processor to assign. A tricky aspect is that the payment processor may need to set the order
*
* @param $form
}
/**
- * map address fields
+ * Map address fields
*
- * @param $id
+ * @param int $id
* @param $src
* @param $dst
* @param bool $reverse
}
/**
- * get the credit card expiration month
+ * Get the credit card expiration month
* The date format for this field should typically be "M Y" (ex: Feb 2011) or "m Y" (02 2011)
* See CRM-9017
*
}
/**
- * get the credit card expiration year
+ * Get the credit card expiration year
* The date format for this field should typically be "M Y" (ex: Feb 2011) or "m Y" (02 2011)
* This function exists only to make it consistent with getCreditCardExpirationMonth
*
class CRM_Core_Payment_Google extends CRM_Core_Payment {
/**
- * mode of operation: live or test
+ * Mode of operation: live or test
*
* @var object
*/
}
/**
- * singleton function used to manage this object
+ * Singleton function used to manage this object
*
* @param string $mode the mode of operation: live or test
*
}
/**
- * hash_call: Function to perform the API call to PayPal using API signature
+ * Hash_call: Function to perform the API call to PayPal using API signature
* @paymentProcessor is the array of payment processor settings value.
* @searchParamsnvpStr is the array of search params.
* returns an associtive array containing the response from the server.
}
/**
- * @param $searchParams
+ * @param array $searchParams
*
* @return string
*/
static private $_singleton = NULL;
/**
- * mode of operation: live or test
+ * Mode of operation: live or test
*
* @var object
*/
protected $_mode = NULL;
/**
- * @param $name
+ * @param string $name
* @param $type
* @param $object
* @param bool $abort
}
/**
- * singleton function used to manage this object
+ * Singleton function used to manage this object
*
* @param string $mode the mode of operation: live or test
*
}
/**
- * @param $error_id
+ * @param int $error_id
*
* @return string
*/
}
/**
- * singleton function used to manage this object
+ * Singleton function used to manage this object
*
* @param string $mode the mode of operation: live or test
*
}
/**
- * singleton function used to manage this object
+ * Singleton function used to manage this object
*
* @param string $mode the mode of operation: live or test
*
}
/**
- * @param $name
+ * @param string $name
* @param $type
* @param string $location
* @param bool $abort
}
/**
- * singleton function used to manage this object
+ * Singleton function used to manage this object
*
* @param string $mode the mode of operation: live or test
*
}
/**
- * are back office payments supported - e.g paypal standard won't permit you to enter a credit card associated with someone else's login
+ * Are back office payments supported - e.g paypal standard won't permit you to enter a credit card associated with someone else's login
* @return bool
*/
protected function supportsBackOffice() {
return FALSE;
}
/**
- * express checkout code. Check PayPal documentation for more information
+ * Express checkout code. Check PayPal documentation for more information
*
* @param array $params assoc array of input parameters for this transaction
*
}
/**
- * get details from paypal. Check PayPal documentation for more information
+ * Get details from paypal. Check PayPal documentation for more information
*
* @param string $token the key associated with this transaction
*
}
/**
- * do the express checkout at paypal. Check PayPal documentation for more information
+ * Do the express checkout at paypal. Check PayPal documentation for more information
*
* @param array $params
*
}
/**
- * check whether a method is present ( & supported ) by the payment processor object.
+ * Check whether a method is present ( & supported ) by the payment processor object.
*
* @param string $method method to check for.
*
}
/**
- * hash_call: Function to perform the API call to PayPal using API signature
+ * Hash_call: Function to perform the API call to PayPal using API signature
* @methodName is name of API method.
* @nvpStr is nvp string.
* returns an associtive array containing the response from the server.
protected $_inputParameters = array();
/**
- * store for the variables from the invoice string
+ * Store for the variables from the invoice string
* @var array
*/
protected $_invoiceData = array();
protected $_component = 'contribute';
/**
- * constructor function
+ * Constructor function
*
* @param array $inputData contents of HTTP REQUEST
*
}
/**
- * function exists to get the values from the rp_invoice_id string
+ * Function exists to get the values from the rp_invoice_id string
*
* @param string $name e.g. i, values are stored in the string with letter codes
* @param boolean $abort fatal if not found?
}
/**
- * singleton function used to manage this object
+ * Singleton function used to manage this object
*
* @param string $mode the mode of operation: live or test
*
//end submit_transaction
/**
- * @param $recurringProfileID
- * @param $processorID
+ * @param int $recurringProfileID
+ * @param int $processorID
*
* @throws Exception
*/
}
/**
- * singleton function used to manage this object
+ * Singleton function used to manage this object
*
* @param string $mode the mode of operation: live or test
*
static private $_singleton = NULL;
/**
- * mode of operation: live or test
+ * Mode of operation: live or test
*
* @var object
*/
protected $_mode = NULL;
/**
- * @param $name
+ * @param string $name
* @param $type
* @param $object
* @param bool $abort
}
/**
- * singleton function used to manage this object
+ * Singleton function used to manage this object
*
* @param string $mode the mode of operation: live or test
*
/**
* @param $xml
- * @param $name
+ * @param string $name
*
* @return mixed
*/
/**
* @param $xml
- * @param $name
+ * @param string $name
*
* @return mixed|null
*/
}
/**
- * singleton function used to manage this object
+ * Singleton function used to manage this object
*
* @param string $mode the mode of operation: live or test
*
}
/**
- * singleton function used to manage this object
+ * Singleton function used to manage this object
*
* @param string $mode the mode of operation: live or test
*
CONST AUTH_SRC_UNKNOWN = 0, AUTH_SRC_CHECKSUM = 1, AUTH_SRC_SITEKEY = 2, AUTH_SRC_LOGIN = 4;
/**
- * get the current permission of this user
+ * Get the current permission of this user
*
* @return string the permission of the user (edit or view or null)
*/
}
/**
- * given a permission string or array, check for access requirements
+ * Given a permission string or array, check for access requirements
* @param mixed $permissions the permission to check as an array or string -see examples
* arrays
*
}
/**
- * @param $gid
+ * @param int $gid
* @param int $type
*
* @return bool
/**
* @param int $type
- * @param null $eventID
+ * @param int $eventID
* @param string $context
*
* @return array|null
}
/**
- * check permissions for delete and edit actions
+ * Check permissions for delete and edit actions
*
* @param string $module component name.
* @param integer $action action to be check across component
}
/**
- * get component name from given permission.
+ * Get component name from given permission.
*
* @param string $permission
*
}
/**
- * get the current permission of this user
+ * Get the current permission of this user
*
* @return string the permission of the user (edit or view or null)
*/
}
/**
- * given a permission string, check for access requirements
+ * Given a permission string, check for access requirements
*
* @param string $str the permission to check
*
class CRM_Core_Permission_Drupal extends CRM_Core_Permission_DrupalBase{
/**
- * is this user someone with access for the entire system
+ * Is this user someone with access for the entire system
*
* @var boolean
*/
protected $_editAdminUser = FALSE;
/**
- * am in in view permission or edit permission?
+ * Am in in view permission or edit permission?
* @var boolean
*/
protected $_viewPermission = FALSE;
protected $_editPermission = FALSE;
/**
- * the current set of permissioned groups for the user
+ * The current set of permissioned groups for the user
*
* @var array
*/
/**
- * given a permission string, check for access requirements
+ * Given a permission string, check for access requirements
*
* @param string $str the permission to check
*
- * @param null $contactID
+ * @param int $contactID
*
* @return boolean true if yes, else false
* @access public
class CRM_Core_Permission_Drupal6 extends CRM_Core_Permission_DrupalBase {
/**
- * is this user someone with access for the entire system
+ * Is this user someone with access for the entire system
*
* @var boolean
*/
protected $_editAdminUser = FALSE;
/**
- * am in in view permission or edit permission?
+ * Am in in view permission or edit permission?
* @var boolean
*/
protected $_viewPermission = FALSE;
protected $_editPermission = FALSE;
/**
- * the current set of permissioned groups for the user
+ * The current set of permissioned groups for the user
*
* @var array
*/
protected $_editPermissionedGroups;
/**
- * given a permission string, check for access requirements
+ * Given a permission string, check for access requirements
*
* @param string $str the permission to check
*
- * @param null $contactID
+ * @param int $contactID
*
* @return boolean true if yes, else false
* @access public
class CRM_Core_Permission_DrupalBase extends CRM_Core_Permission_Base {
/**
- * is this user someone with access for the entire system
+ * Is this user someone with access for the entire system
*
* @var boolean
*/
protected $_editAdminUser = FALSE;
/**
- * am in in view permission or edit permission?
+ * Am in in view permission or edit permission?
* @var boolean
*/
protected $_viewPermission = FALSE;
protected $_editPermission = FALSE;
/**
- * the current set of permissioned groups for the user
+ * The current set of permissioned groups for the user
*
* @var array
*/
}
/**
- * get the current permission of this user
+ * Get the current permission of this user
*
* @return string the permission of the user (edit or view or null)
*/
*/
class CRM_Core_Permission_Joomla extends CRM_Core_Permission_Base {
/**
- * given a permission string, check for access requirements
+ * Given a permission string, check for access requirements
*
* @param string $str the permission to check
*
class CRM_Core_Permission_Soap extends CRM_Core_Permission_Base {
/**
- * given a permission string, check for access requirements
+ * Given a permission string, check for access requirements
*
* @param string $str the permission to check
*
public $permissions = NULL;
/**
- * given a permission string, check for access requirements
+ * Given a permission string, check for access requirements
*
* @param string $str the permission to check
*
*/
class CRM_Core_Permission_WordPress extends CRM_Core_Permission_Base {
/**
- * given a permission string, check for access requirements
+ * Given a permission string, check for access requirements
*
* @param string $str the permission to check
*
class CRM_Core_PseudoConstant {
/**
- * static cache for pseudoconstant arrays
+ * Static cache for pseudoconstant arrays
* @var array
* @static
*/
private static $activityType;
/**
- * states, provinces
+ * States, provinces
* @var array
* @static
*/
private static $stateProvince;
/**
- * counties
+ * Counties
* @var array
* @static
*/
private static $county;
/**
- * states/provinces abbreviations
+ * States/provinces abbreviations
* @var array
* @static
*/
private static $stateProvinceAbbreviation;
/**
- * country
+ * Country
* @var array
* @static
*/
private static $country;
/**
- * countryIsoCode
+ * CountryIsoCode
* @var array
* @static
*/
private static $group;
/**
- * groupIterator
+ * GroupIterator
* @var mixed
* @static
*/
private static $groupIterator;
/**
- * relationshipType
+ * RelationshipType
* @var array
* @static
*/
private static $relationshipType;
/**
- * civicrm groups that are not smart groups
+ * Civicrm groups that are not smart groups
* @var array
* @static
*/
private static $staticGroup;
/**
- * currency codes
+ * Currency codes
* @var array
* @static
*/
private static $currencyCode;
/**
- * payment processor
+ * Payment processor
* @var array
* @static
*/
private static $paymentProcessor;
/**
- * payment processor types
+ * Payment processor types
* @var array
* @static
*/
}
/**
- * get all the ISO 4217 currency codes
+ * Get all the ISO 4217 currency codes
*
* so far, we use this for validation only, so there's no point of putting this into the database
*
*
* @param boolean $all - get payment processors - default is to get only active ones.
*
- * @param null $id
+ * @param int $id
* @param string $return
*
* @return array - array of all payment processor types
}
/**
- * @param $countryID
+ * @param int $countryID
* @param string $field
*
* @return array
}
/**
- * @param $stateID
+ * @param int $stateID
*
* @return array
*/
*
* @param boolean $optionGroupName - get All Option Group values- default is to get only active ones.
*
- * @param null $id
+ * @param int $id
* @param null $condition
*
* @return array - array reference of all Option Group Name
class CRM_Core_QuickForm_Action extends HTML_QuickForm_Action {
/**
- * reference to the state machine i belong to
+ * Reference to the state machine i belong to
* @var object
*/
protected $_stateMachine;
/**
- * constructor
+ * Constructor
*
* @param object $stateMachine reference to state machine object
*
}
/**
- * returns the user to the top of the user context stack.
+ * Returns the user to the top of the user context stack.
*
* @return void
* @access public
class CRM_Core_QuickForm_Action_Back extends CRM_Core_QuickForm_Action {
/**
- * class constructor
+ * Class constructor
*
* @param object $stateMachine reference to state machine object
*
class CRM_Core_QuickForm_Action_Cancel extends CRM_Core_QuickForm_Action {
/**
- * class constructor
+ * Class constructor
*
* @param object $stateMachine reference to state machine object
*
class CRM_Core_QuickForm_Action_Display extends CRM_Core_QuickForm_Action {
/**
- * the template to display the required "red" asterick
+ * The template to display the required "red" asterick
* @var string
*/
static $_requiredTemplate = NULL;
/**
- * the template to display error messages inline with the form element
+ * The template to display error messages inline with the form element
* @var string
*/
static $_errorTemplate = NULL;
/**
- * class constructor
+ * Class constructor
*
* @param object $stateMachine reference to state machine object
*
}
/**
- * set the various rendering templates
+ * Set the various rendering templates
*
* @param CRM_Core_Form $page the CRM_Core_Form page
*
}
/**
- * initialize the various templates
+ * Initialize the various templates
*
* @return void
* @access public
class CRM_Core_QuickForm_Action_Done extends CRM_Core_QuickForm_Action {
/**
- * class constructor
+ * Class constructor
*
* @param object $stateMachine reference to state machine object
*
class CRM_Core_QuickForm_Action_Jump extends CRM_Core_QuickForm_Action {
/**
- * class constructor
+ * Class constructor
*
* @param object $stateMachine reference to state machine object
*
class CRM_Core_QuickForm_Action_Next extends CRM_Core_QuickForm_Action {
/**
- * class constructor
+ * Class constructor
*
* @param object $stateMachine reference to state machine object
*
class CRM_Core_QuickForm_Action_Process extends CRM_Core_QuickForm_Action {
/**
- * class constructor
+ * Class constructor
*
* @param object $stateMachine reference to state machine object
*
class CRM_Core_QuickForm_Action_Refresh extends CRM_Core_QuickForm_Action {
/**
- * class constructor
+ * Class constructor
*
* @param object $stateMachine reference to state machine object
*
class CRM_Core_QuickForm_Action_Reload extends CRM_Core_QuickForm_Action {
/**
- * class constructor
+ * Class constructor
*
* @param object $stateMachine reference to state machine object
*
class CRM_Core_QuickForm_Action_Submit extends CRM_Core_QuickForm_Action {
/**
- * class constructor
+ * Class constructor
*
* @param object $stateMachine reference to state machine object
*
class CRM_Core_QuickForm_Action_Upload extends CRM_Core_QuickForm_Action {
/**
- * the array of uploaded file names
+ * The array of uploaded file names
* @var array
*/
protected $_uploadNames;
protected $_uploadDir;
/**
- * class constructor
+ * Class constructor
*
* @param object $stateMachine reference to state machine object
* @param string $uploadDir directory to store the uploaded files
}
/**
- * upload and move the file if valid to the uploaded directory
+ * Upload and move the file if valid to the uploaded directory
*
* @param CRM_Core_Form $page the CRM_Core_Form object
* @param object $data the QFC data container
/**
* @param CRM_Core_Form $page
- * @param $actionName
+ * @param string $actionName
*
* @return mixed
*/
var $_isSorted;
/**
- * @param $name
+ * @param string $name
*/
public function __construct($name) {
// Templates injected into regions should normally be file names, but sometimes inline notation is handy.
}
/**
- * @param $name
+ * @param string $name
* @param $snippet
*/
public function update($name, $snippet) {
}
/**
- * @param $name
+ * @param string $name
*
* @return mixed
*/
}
/**
- * @param $fileName
+ * @param string $fileName
* @param $header
* @param $rows
* @param null $titleHeader
class CRM_Core_SelectValues {
/**
- * preferred mail format
+ * Preferred mail format
* @static
*/
static function pmf() {
}
/**
- * privacy options
+ * Privacy options
* @static
*/
static function privacy() {
}
/**
- * various pre defined contact super types
+ * Various pre defined contact super types
* @static
*/
static function contactType() {
}
/**
- * various pre defined unit list
+ * Various pre defined unit list
* @static
*/
static function unitList($unitType = NULL) {
}
/**
- * membership type unit
+ * Membership type unit
* @static
*/
static function membershipTypeUnitList( ) {
}
/**
- * various pre defined period types
+ * Various pre defined period types
* @static
*/
static function periodType() {
}
/**
- * various pre defined email selection methods
+ * Various pre defined email selection methods
* @static
*/
static function emailSelectMethods() {
}
/**
- * various pre defined member visibility options
+ * Various pre defined member visibility options
* @static
*/
static function memberVisibility() {
}
/**
- * various pre defined event dates
+ * Various pre defined event dates
* @static
*/
static function eventDate() {
}
/**
- * various pre defined extensions for dynamic properties and groups
+ * Various pre defined extensions for dynamic properties and groups
*
* @static
*/
}
/**
- * styles for displaying the custom data group
+ * Styles for displaying the custom data group
*
* @static
*/
}
/**
- * for displaying the uf group types
+ * For displaying the uf group types
*
* @static
*/
}
/**
- * the status of a contact within a group
+ * The status of a contact within a group
*
* @static
*/
}
/**
- * list of Group Types
+ * List of Group Types
* @static
*/
static function groupType() {
}
/**
- * compose the parameters for a date select object
+ * Compose the parameters for a date select object
*
* @param string|NULL $type the type of date
* @param string|NULL $format date format ( QF format)
}
/**
- * values for UF form visibility options
+ * Values for UF form visibility options
*
* @static
*/
}
/**
- * values for group form visibility options
+ * Values for group form visibility options
*
* @static
*/
}
/**
- * different type of Mailing Components
+ * Different type of Mailing Components
*
* @static
* return array
}
/**
- * get hours
+ * Get hours
*
*
* @static
}
/**
- * get minutes
+ * Get minutes
*
*
* @static
}
/**
- * get the Map Provider
+ * Get the Map Provider
*
* @return array $map array of map providers
* @static
}
/**
- * Function to get the Geocoding Providers from available plugins
+ * Get the Geocoding Providers from available plugins
*
* @return array $geo array of geocoder providers
* @static
}
/**
- * Function to get the Address Standardization Providers from available
+ * Get the Address Standardization Providers from available
* plugins
*
* @return array $addr array of address standardization providers
}
/**
- * different type of Mailing Tokens
+ * Different type of Mailing Tokens
*
* @static
* return array
}
/**
- * different type of Activity Tokens
+ * Different type of Activity Tokens
*
* @static
* return array
}
/**
- * different type of Membership Tokens
+ * Different type of Membership Tokens
*
* @static
* return array
}
/**
- * different type of Event Tokens
+ * Different type of Event Tokens
*
* @static
* return array
}
/**
- * different type of Event Tokens
+ * Different type of Event Tokens
*
* @static
* return array
}
/**
- * different type of Contact Tokens
+ * Different type of Contact Tokens
*
* @static
* return array
}
/**
- * different type of Participant Tokens
+ * Different type of Participant Tokens
*
* @static
* return array
}
/**
- * Function to get numeric options
+ * Get numeric options
*
*
* @static
}
/**
- * barcode types
+ * Barcode types
* @static
*/
static function getBarcodeTypes() {
}
/**
- * dedupe rule types
+ * Dedupe rule types
*/
static function getDedupeRuleTypes() {
return array(
}
/**
- * campaign group types
+ * Campaign group types
*/
static function getCampaignGroupTypes() {
return array(
}
/**
- * subscription history method
+ * Subscription history method
*/
static function getSubscriptionHistoryMethods() {
return array(
}
/**
- * premium units
+ * Premium units
*/
static function getPremiumUnits() {
return array(
}
/**
- * extension types
+ * Extension types
*/
static function getExtensionTypes() {
return array(
}
/**
- * job frequency
+ * Job frequency
*/
static function getJobFrequency() {
return array(
}
/**
- * profile group types
+ * Profile group types
*
* @static
*/
/**
- * word replacement match type
+ * Word replacement match type
*/
static function getWordReplacementMatchType() {
return array(
}
/**
- * mailing group types
+ * Mailing group types
*/
static function getMailingGroupTypes() {
return array(
function getPagerParams($action, &$params);
/**
- * returns the sort order array for the given action
+ * Returns the sort order array for the given action
*
* @param string action the action being performed
*
function &getSortOrder($action);
/**
- * returns the column headers as an array of tuples:
+ * Returns the column headers as an array of tuples:
* (name, sortName (key to the sort array))
*
* @param string $action the action being performed
function &getColumnHeaders($action = NULL, $type = NULL);
/**
- * returns the number of rows for this action
+ * Returns the number of rows for this action
*
* @param string action the action being performed
*
function getTotalCount($action);
/**
- * returns all the rows in the given offset and rowCount
+ * Returns all the rows in the given offset and rowCount
*
* @param enum $action the action being performed
* @param int $offset the row number to start from
function &getRows($action, $offset, $rowCount, $sort, $type = NULL);
/**
- * return the template (.tpl) filename
+ * Return the template (.tpl) filename
*
* @param string $action the action being performed
*
function getTemplateFileName($action = NULL);
/**
- * return the filename for the exported CSV
+ * Return the filename for the exported CSV
*
* @param string type the type of export required: csv/xml/foaf etc
*
class CRM_Core_Selector_Base {
/**
- * the sort order which is computed from the columnHeaders
+ * The sort order which is computed from the columnHeaders
*
* @var array
*/
}
/**
- * compose the template file name from the class name
+ * Compose the template file name from the class name
*
* @param string $action the action being performed
*
}
/**
- * getter for the sorting direction for the fields which will be displayed on the form.
+ * Getter for the sorting direction for the fields which will be displayed on the form.
*
* @param string action the action being performed
*
}
/**
- * setter for permission
+ * Setter for permission
*
* @var string
* @access public
}
/**
- * get the display text in plain language for the search
+ * Get the display text in plain language for the search
* to display on the results page
*
* @return string
class CRM_Core_Selector_Controller {
/**
- * constants to determine if we should store
+ * Constants to determine if we should store
* the output in the session or template
* @var int
*/
TRANSFER = 4, EXPORT = 8, SCREEN = 16, PDF = 32;
/**
- * a CRM Object that implements CRM_Core_Selector_API
+ * A CRM Object that implements CRM_Core_Selector_API
* @var object
*/
protected $_object;
protected $_sort;
/**
- * the current column to sort on
+ * The current column to sort on
* @var int
*/
protected $_sortID;
/**
- * the sortOrder array
+ * The sortOrder array
* @var array
*/
protected $_sortOrder;
protected $_pager;
/**
- * the pageID
+ * The pageID
* @var int
*/
protected $_pageID;
/**
- * offset
+ * Offset
* @var int
*/
protected $_pagerOffset;
/**
- * number of rows to return
+ * Number of rows to return
* @var int
*/
protected $_pagerRowCount;
/**
- * total number of rows
+ * Total number of rows
* @var int
*/
protected $_total;
/**
- * the objectAction for the WebObject
+ * The objectAction for the WebObject
*/
protected $_action;
protected $_prefix;
/**
- * cache the smarty template for efficiency reasons
+ * Cache the smarty template for efficiency reasons
*
* @var CRM_Core_Smarty
*/
}
/**
- * have the GET vars changed, i.e. pageId or sortId that forces us to recompute the search values
+ * Have the GET vars changed, i.e. pageId or sortId that forces us to recompute the search values
*
* @param int $reset are we being reset
*
}
/**
- * retrieve rows.
+ * Retrieve rows.
*
* @param CRM_Core_Form $form
*
}
/**
- * default function for qill, if needed to be implemented, we
+ * Default function for qill, if needed to be implemented, we
* expect the subclass to do it
*
* @return string the status message
}
/**
- * getter for pager
+ * Getter for pager
*
* @return CRM_Utils_Pager
* @access public
}
/**
- * getter for sort
+ * Getter for sort
*
* @return CRM_Utils_Sort
* @access public
}
/**
- * setter for embedded
+ * Setter for embedded
*
* @param boolean $embedded
*
}
/**
- * getter for embedded
+ * Getter for embedded
*
* @return boolean return the embedded value
* @access public
}
/**
- * setter for print
+ * Setter for print
*
* @param boolean $print
*
}
/**
- * getter for print
+ * Getter for print
*
* @return boolean return the print value
* @access public
static $_managedNames = NULL;
/**
- * key is used to allow the application to have multiple top
+ * Key is used to allow the application to have multiple top
* level scopes rather than a single scope. (avoids naming
* conflicts). We also extend this idea further and have local
* scopes within a global scope. Allows us to do cool things
}
/**
- * singleton function used to manage this object
+ * Singleton function used to manage this object
*
* @return CRM_Core_Session
* @static
}
/**
- * creates a session local scope
+ * Creates a session local scope
*
* @param string prefix local scope name
* @param boolean isRead is this a read operation, in this case, the session will not be touched
}
/**
- * resets the session local scope
+ * Resets the session local scope
*
* @param string local scope name
* @access public
}
/**
- * adds a userContext to the stack
+ * Adds a userContext to the stack
*
* @param string $userContext the url to return to when done
* @param boolean $check should we do a dupe checking with the top element
}
/**
- * replace the userContext of the stack with the passed one
+ * Replace the userContext of the stack with the passed one
*
* @param string the url to return to when done
*
}
/**
- * pops the top userContext stack
+ * Pops the top userContext stack
*
* @param void
*
}
/**
- * reads the top userContext stack
+ * Reads the top userContext stack
*
* @param void
*
}
/**
- * dumps the session to the log
+ * Dumps the session to the log
*/
function debug($all = 1) {
$this->initialize();
}
/**
- * @param $names
+ * @param string $names
*/
static function registerAndRetrieveSessionObjects($names) {
if (!is_array($names)) {
protected $_hide;
/**
- * class constructor
+ * Class constructor
*
* @param array $show initial value of show array
* @param array $hide initial value of hide array
}
/**
- * load icon vars used in hide and show links
+ * Load icon vars used in hide and show links
*
* @return void
* @access public
}
/**
- * add the values from this class to the template
+ * Add the values from this class to the template
*
* @return void
* @access public
}
/**
- * create a well formatted html link from the smaller pieces
+ * Create a well formatted html link from the smaller pieces
*
* @param string $name name of the link
* @param string $href
private $backupFrames = array();
/**
- * class constructor
+ * Class constructor
*
* @return CRM_Core_Smarty
* @access private
}
/**
- * executes & returns or displays the template results
+ * Executes & returns or displays the template results
*
* @param string $resource_name
* @param string $cache_id
}
/**
- * @param $name
+ * @param string $name
* @param $value
*/
function appendValue($name, $value) {
}
/**
- * @param $tpl_name
+ * @param string $tpl_name
* @param $tpl_timestamp
* @param $smarty_obj
*
}
/**
- * @param $tpl_name
+ * @param string $tpl_name
* @param $smarty_obj
*
* @return bool
}
/**
- * @param $tpl_name
+ * @param string $tpl_name
* @param $smarty_obj
*/
function civicrm_smarty_resource_string_get_trusted($tpl_name, &$smarty_obj) {}
class CRM_Core_State {
/**
- * state name
+ * State name
* @var string
*/
protected $_name;
/**
- * this is a combination "OR" of the STATE_* constants defined below
+ * This is a combination "OR" of the STATE_* constants defined below
* @var int
*/
protected $_type;
/**
- * the state that precedes this state
+ * The state that precedes this state
* @var CRM_Core_State
*/
protected $_back;
/**
- * the state that succeeds this state
+ * The state that succeeds this state
* @var CRM_Core_State
*/
protected $_next;
CONST START = 1, FINISH = 2, SIMPLE = 4;
/**
- * constructor
+ * Constructor
*
* @param string $name internal name of the state
* @param int $type state type
}
/**
- * getter for name
+ * Getter for name
*
* @return string
* @access public
}
/**
- * setter for name
+ * Setter for name
*
* @param string
*
}
/**
- * getter for type
+ * Getter for type
*
* @return int
* @access public
class CRM_Core_StateMachine {
/**
- * the controller of this state machine
+ * The controller of this state machine
* @var object
*/
protected $_controller;
/**
- * the list of states that belong to this state machine
+ * The list of states that belong to this state machine
* @var array
*/
protected $_states;
/**
- * the list of pages that belong to this state machine. Note
+ * The list of pages that belong to this state machine. Note
* that a state and a form have a 1 <-> 1 relationship. so u
* can always derive one from the other
* @var array
protected $_pageNames;
/**
- * the mode that the state machine is operating in
+ * The mode that the state machine is operating in
* @var int
*/
protected $_action = NULL;
protected $_name = NULL;
/**
- * class constructor
+ * Class constructor
*
* @param object $controller the controller for this state machine
*
}
/**
- * getter for name
+ * Getter for name
*
* @return string
* @access public
}
/**
- * setter for name
+ * Setter for name
*
* @param string
*
}
/**
- * do a state transition jump. Currently only supported types are
+ * Do a state transition jump. Currently only supported types are
* Next and Back. The other actions (Cancel, Done, Submit etc) do
* not need the state machine to figure out where to go
*
}
/**
- * helper function to add a State to the state machine
+ * Helper function to add a State to the state machine
*
* @param string $name the internal name
* @param int $type the type of state (START|FINISH|SIMPLE)
}
/**
- * return the list of state objects
+ * Return the list of state objects
*
* @return array array of states in the state machine
* @access public
}
/**
- * return the state object corresponding to the name
+ * Return the state object corresponding to the name
*
* @param string $name name of page
*
}
/**
- * return the list of form objects
+ * Return the list of form objects
*
* @return array array of pages in the state machine
* @access public
}
/**
- * addSequentialStates: meta level function to create a simple
+ * AddSequentialStates: meta level function to create a simple
* wizard for a state machine that is completely sequential.
*
* @access public
}
/**
- * reset the state machine
+ * Reset the state machine
*
* @return void
* @access public
}
/**
- * getter for action
+ * Getter for action
*
* @return int
* @access public
}
/**
- * setter for content
+ * Setter for content
*
* @param string $content the content generated by this state machine
*
}
/**
- * getter for content
+ * Getter for content
*
* @return string
* @access public
class CRM_Custom_Form_ChangeFieldType extends CRM_Core_Form {
/**
- * the field id
+ * The field id
*
* @var int
* @access protected
protected $_id;
/**
- * array of custom field values
+ * Array of custom field values
*/
protected $_values;
/**
- * mapper array of valid field type
+ * Mapper array of valid field type
*/
protected $_htmlTypeTransitions;
/**
- * set up variables to build the form
+ * Set up variables to build the form
*
* @return void
* @acess protected
class CRM_Custom_Form_DeleteField extends CRM_Core_Form {
/**
- * the group id
+ * The group id
*
* @var int
*/
protected $_title;
/**
- * set up variables to build the form
+ * Set up variables to build the form
*
* @param null
*
class CRM_Custom_Form_DeleteGroup extends CRM_Core_Form {
/**
- * the group id
+ * The group id
*
* @var int
*/
protected $_title;
/**
- * set up variables to build the form
+ * Set up variables to build the form
*
* @return void
* @acess protected
CONST NUM_OPTION = 11;
/**
- * the custom group id saved to the session for an update
+ * The custom group id saved to the session for an update
*
* @var int
* @access protected
protected $_defaultDataType;
/**
- * array of custom field values if update mode
+ * Array of custom field values if update mode
*/
protected $_values;
private static $_dataToLabels = NULL;
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @param null
*
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $fields posted values of the form
*
class CRM_Custom_Form_Group extends CRM_Core_Form {
/**
- * the set id saved to the session for an update
+ * The set id saved to the session for an update
*
* @var int
* @access protected
protected $_isGroupEmpty = TRUE;
/**
- * array of existing subtypes set for a custom set
+ * Array of existing subtypes set for a custom set
*
* @var array
* @access protected
protected $_subtypes = array();
/**
- * array of default params
+ * Array of default params
*
* @var array
* @access protected
protected $_defaults = array();
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @param null
*
}
/**
- * global form rule
+ * Global form rule
*
* @param array $fields the input form values
* @param array $files the uploaded files if any
class CRM_Custom_Form_MoveField extends CRM_Core_Form {
/**
- * the src group id
+ * The src group id
*
* @var int
*/
protected $_srcGID;
/**
- * the src field id
+ * The src field id
*
* @var int
*/
protected $_srcFID;
/**
- * the dst group id
+ * The dst group id
*
* @var int
*/
protected $_dstGID;
/**
- * the dst field id
+ * The dst field id
*
* @var int
*/
protected $_srcFieldLabel;
/**
- * set up variables to build the form
+ * Set up variables to build the form
*
* @return void
* @acess protected
class CRM_Custom_Form_Option extends CRM_Core_Form {
/**
- * the custom field id saved to the session for an update
+ * The custom field id saved to the session for an update
*
* @var int
* @access protected
protected $_fid;
/**
- * the custom group id saved to the session for an update
+ * The custom group id saved to the session for an update
*
* @var int
* @access protected
protected $_id;
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @param null
*
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $fields posted values of the form
*
class CRM_Custom_Form_Preview extends CRM_Core_Form {
/**
- * the group tree data
+ * The group tree data
*
* @var array
*/
protected $_groupTree;
/**
- * pre processing work done here.
+ * Pre processing work done here.
*
* gets session variables for group or field id
*
*/
class CRM_Custom_Import_Controller extends CRM_Core_Controller {
/**
- * class constructor
+ * Class constructor
*/
function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) {
parent::__construct($title, $modal);
class CRM_Custom_Import_Form_DataSource extends CRM_Core_Form {
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
protected $_mappingType = 'Import Multi value custom data';
protected $_highlightedFields = array();
/**
- * entity being imported to
+ * Entity being imported to
* @var string
*/
protected $_entity;
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $fields posted values of the form
*
public $_parser = 'CRM_Custom_Import_Parser_Api';
protected $_importParserUrl = '&parser=CRM_Custom_Import_Parser';
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
*/
class CRM_Custom_Import_Form_Summary extends CRM_Contact_Import_Form_Summary {
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
*/
/**
- * imported file size
+ * Imported file size
*/
protected $_fileSize;
/**
- * separator being used
+ * Separator being used
*/
protected $_separator;
/**
- * total number of lines in file
+ * Total number of lines in file
*/
protected $_lineCount;
/**
- * whether the file has a column header or not
+ * Whether the file has a column header or not
*
* @var boolean
*/
protected $_haveColumnHeader;
/**
- * @param $fileName
+ * @param string $fileName
* @param string $separator
* @param int $mapper
* @param bool $skipColumnHeader
}
/**
- * format the field values for input to the api
+ * Format the field values for input to the api
*
* @return array (reference ) associative array of name/value pairs
* @access public
*/
protected $_params = array();
/**
- * class constructor
+ * Class constructor
*/
function __construct(&$mapperKeys, $mapperLocType = NULL, $mapperPhoneType = NULL) {
parent::__construct();
}
/**
- * the initializer code, called before the processing
+ * The initializer code, called before the processing
*
* @return void
* @access public
}
/**
- * handle the values in mapField mode
+ * Handle the values in mapField mode
*
* @param array $values the array of values belonging to this line
*
}
/**
- * handle the values in preview mode
+ * Handle the values in preview mode
*
* @param array $values the array of values belonging to this line
*
}
/**
- * handle the values in import mode
+ * Handle the values in import mode
*
* @param int $onDuplicate the code for what action to take on duplicates
* @param array $values the array of values belonging to this line
}
/**
- * the initializer code, called before the processing
+ * The initializer code, called before the processing
*
* @return void
* @access public
}
/**
- * edit custom data.
+ * Edit custom data.
*
* editing would involved modifying existing fields + adding data to new fields.
*
}
/**
- * edit custom group
+ * Edit custom group
*
* @param int $id custom group id
* @param string $action the action to be invoked
}
/**
- * edit custom Option.
+ * Edit custom Option.
*
* editing would involved modifying existing fields + adding data to new fields.
*
class CRM_Dedupe_BAO_Rule extends CRM_Dedupe_DAO_Rule {
/**
- * ids of the contacts to limit the SQL queries (whole-database queries otherwise)
+ * Ids of the contacts to limit the SQL queries (whole-database queries otherwise)
*/
var $contactIds = array();
/**
- * params to dedupe against (queries against the whole contact set otherwise)
+ * Params to dedupe against (queries against the whole contact set otherwise)
*/
var $params = array();
}
/**
- * @param $cid
- * @param $oid
+ * @param int $cid
+ * @param int $oid
*
* @return bool
*/
class CRM_Dedupe_BAO_RuleGroup extends CRM_Dedupe_DAO_RuleGroup {
/**
- * ids of the contacts to limit the SQL queries (whole-database queries otherwise)
+ * Ids of the contacts to limit the SQL queries (whole-database queries otherwise)
*/
var $contactIds = array();
/**
- * params to dedupe against (queries against the whole contact set otherwise)
+ * Params to dedupe against (queries against the whole contact set otherwise)
*/
var $params = array();
/**
- * if there are no rules in rule group
+ * If there are no rules in rule group
*/
var $noRules = FALSE;
}
/**
- * return payment related table.
+ * Return payment related table.
*/
static function paymentTables() {
static $tables;
}
/**
- * return payment update Query.
+ * Return payment update Query.
*/
static function paymentSql($tableName, $mainContactId, $otherContactId) {
$sqls = array();
}
/**
- * @param $mainId
- * @param $otherId
- * @param $tableName
+ * @param int $mainId
+ * @param int $otherId
+ * @param string $tableName
* @param array $tableOperations
* @param string $mode
*
}
/**
- * batch merge a set of contacts based on rule-group and group.
+ * Batch merge a set of contacts based on rule-group and group.
*
* @param int $rgid rule group id
* @param int $gid group id
}
/**
- * merge given set of contacts. Performs core operation.
+ * Merge given set of contacts. Performs core operation.
*
* @param array $dupePairs set of pair of contacts for whom merge is to be done.
* @param array $cacheParams prev-next-cache params based on which next pair of contacts are computed.
class CRM_Event_BAO_Event extends CRM_Event_DAO_Event {
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
}
/**
- * update the is_active flag in the db
+ * 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
}
/**
- * add the event
+ * Add the event
*
* @param array $params reference array contains the values submitted by the form
*
}
/**
- * create the event
+ * Create the event
*
* @param array $params reference array contains the values submitted by the form
*
}
/**
- * delete the event
+ * Delete the event
*
* @param int $id event id
*
}
/**
- * Function to delete the location block associated with an event,
+ * Delete the location block associated with an event,
* if not being used by any other event.
*
* @param $locBlockId location block id to be deleted
}
/**
- * Function to get current/future Events
+ * Get current/future Events
*
* @param $all int 0 returns current and future events
* 1 if events all are required
}
/**
- * Function to get events Summary
+ * Get events Summary
*
* @static
*
}
/**
- * Function to get participant count
+ * Get participant count
*
- * @param $eventId
+ * @param int $eventId
* @param boolean $considerStatus consider status for participant count.
* @param boolean $status consider counted participant.
* @param boolean $considerRole consider role for participant count.
}
/**
- * function to get the information to map a event
+ * Get the information to map a event
*
* @param int $id for which we want map info
*
}
/**
- * function to get the complete information for one or more events
+ * Get the complete information for one or more events
*
* @param date $start get events with start date >= this date
* @param integer $type get events on the a specific event type (by event_type_id)
/**
* Process that send e-mails
*
- * @param $contactID
+ * @param int $contactID
* @param $values
- * @param $participantId
+ * @param int $participantId
* @param bool $isTest
* @param bool $returnMessageText
*
}
/**
- * Function to add the custom fields OR array of participant's
+ * Add the custom fields OR array of participant's
* profile info
*
- * @param $id
- * @param $name
- * @param $cid
+ * @param int $id
+ * @param string $name
+ * @param int $cid
* @param $template
- * @param $participantId
+ * @param int $participantId
* @param $isTest
* @param bool $isCustomProfile
* @param array $participantParams
}
/**
- * Function to build the array for display the profile fields
+ * Build the array for display the profile fields
*
* @param array $params key value.
* @param int $gid profile Id
}
/**
- * Function to build the array for Additional participant's information array of priamry and additional Ids
+ * Build the array for Additional participant's information array of priamry and additional Ids
*
* @param int $participantId id of Primary participant
* @param array $values key/value event info
}
/**
- * @param $locBlockId
+ * @param int $locBlockId
*
* @return int|null|string
*/
}
/**
- * make sure that the user has permission to access this event
+ * Make sure that the user has permission to access this event
*
* @param int $eventId
* @param int $type
}
/**
- * Function to calculate event total seats occupied.
+ * Calculate event total seats occupied.
*
* @param int $eventId event id.
* @param sting $extraWhereClause extra filter on participants.
}
/**
- * @param $event_id
+ * @param int $event_id
*
* @return object
*/
class CRM_Event_BAO_Participant extends CRM_Event_DAO_Participant {
/**
- * static field for all the participant information that we can potentially import
+ * Static field for all the participant information that we can potentially import
*
* @var array
* @static
static $_importableFields = NULL;
/**
- * static field for all the participant information that we can potentially export
+ * Static field for all the participant information that we can potentially export
*
* @var array
* @static
static $_exportableFields = NULL;
/**
- * static array for valid status transitions rules
+ * Static array for valid status transitions rules
*
* @var array
* @static
}
/**
- * takes an associative array and creates a participant object
+ * Takes an associative array and creates a participant object
*
* the function extract all the params it needs to initialize the create a
* participant object. the params array could contain additional unused name/value
}
/**
- * takes an associative array and creates a participant object
+ * Takes an associative array and creates a participant object
*
* @param array $params (reference ) an assoc array of name/value pairs
*
}
/**
- * combine all the importable fields from the lower levels object
+ * Combine all the importable fields from the lower levels object
*
* @param string $contactType
* @param bool $status
}
/**
- * combine all the exportable fields from the lower levels object
+ * Combine all the exportable fields from the lower levels object
*
* @return array array of exportable Fields
* @access public
}
/**
- * get the event name/sort name for a particular participation / participant
+ * Get the event name/sort name for a particular participation / participant
*
* @param int $participantId id of the participant
}
/**
- * fix the event level
+ * Fix the event level
*
* When price sets are used as event fee, fee_level is set as ^A
* separated string. We need to change that string to comma
}
/**
- * get the additional participant ids.
+ * Get the additional participant ids.
*
* @param int $primaryParticipantId primary partycipant Id
* @param boolean $excludeCancel do not include participant those are cancelled.
*
- * @param null $oldStatusId
+ * @param int $oldStatusId
*
* @return array $additionalParticipantIds
* @static
* Function for update primary and additional participant status
*
* @param int $participantID primary participant's id
- * @param $oldStatusID
- * @param null $newStatusID
+ * @param int $oldStatusID
+ * @param int $newStatusID
* @param bool $updatePrimaryStatus
*
* @return bool|void
}
/**
- * send mail and create activity
+ * Send mail and create activity
* when participant status changed.
*
* @param int $participantId participant id.
}
/**
- * get participant status change message.
+ * Get participant status change message.
*
- * @param $participantId
+ * @param int $participantId
* @param $statusChangeTo
- * @param $fromStatusId
+ * @param int $fromStatusId
*
* @return string
* @access public
}
/**
- * get event full and waiting list message.
+ * Get event full and waiting list message.
*
- * @param $eventId
- * @param null $participantId
+ * @param int $eventId
+ * @param int $participantId
*
* @return string
* @access public
}
/**
- * check for whether participant is primary or not
+ * Check for whether participant is primary or not
*
- * @param $participantId
+ * @param int $participantId
*
* @return true if participant is primary
* @access public
}
/**
- * get additional participant Ids for cascading with primary participant status
+ * Get additional participant Ids for cascading with primary participant status
*
* @param int $participantId participant id.
* @param int $oldStatusId previous status
}
/**
- * get participant record count for a Contact
+ * Get participant record count for a Contact
*
* @param int $contactID
*
}
/**
- * Function to get participant ids by contribution id
+ * Get participant ids by contribution id
*
* @param int $contributionId Contribution Id
* @param bool $excludeCancelled Exclude cancelled additional participant
}
/**
- * Function to get additional Participant edit & view url .
+ * Get additional Participant edit & view url .
*
* @param array $participantIds an array of additional participant ids.
*
}
/**
- * to create trxn entry if an event has discount.
+ * To create trxn entry if an event has discount.
*
* @param int $eventID event id
* @param array $contributionParams contribution params.
}
/**
- * Function to delete participants of contact
+ * Delete participants of contact
*
* CRM-12155
*
/**
* @param array $params
- * @param $participantId
- * @param $contributionId
+ * @param int $participantId
+ * @param int $contributionId
* @param $feeBlock
- * @param $lineItems
+ * @param array $lineItems
* @param $paidAmount
- * @param $priceSetId
+ * @param int $priceSetId
*/
static function changeFeeSelections($params, $participantId, $contributionId, $feeBlock, $lineItems, $paidAmount, $priceSetId) {
$contributionStatuses = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
/**
* @param $updatedAmount
* @param $paidAmount
- * @param $contributionId
+ * @param int $contributionId
*/
static function recordAdjustedAmt($updatedAmount, $paidAmount, $contributionId, $taxAmount = NULL) {
$balanceAmt = $updatedAmount - $paidAmount;
}
/**
- * @param $participantId
+ * @param int $participantId
* @param $activityType
*
* @throws CRM_Core_Exception
}
/**
- * @param $id
+ * @param int $id
*
* @return bool
*/
}
/**
- * @param $id
+ * @param int $id
* @param $isActive
*
* @return bool
}
/**
- * build select for CiviEvent
+ * Build select for CiviEvent
*
* @param $query
*
}
/**
- * @param $name
+ * @param string $name
* @param $mode
* @param $side
*
}
/**
- * getter for the qill object
+ * Getter for the qill object
*
* @return string
* @access public
/**
* @param $row
- * @param $id
+ * @param int $id
*/
static function searchAction(&$row, $id) {}
}
/**
- * create the labels (pdf)
+ * Create the labels (pdf)
* It assumes the participants are from the same event
*
* @param array $participants
}
/**
- * @param $eventID
+ * @param int $eventID
*
* @return CRM_Event_BAO_Event|null
*/
}
/**
- * @param $eventID
+ * @param int $eventID
* @param bool $img
*
* @return string
}
/**
- * this is supposed to be overrided
+ * This is supposed to be overrided
**/
public function generateLabel($participant) {
$txt = "{$this->event['title']}
function pdfExtraFormat() {}
/**
- * create labels (pdf)
+ * Create labels (pdf)
*
* @param array $participants
*
}
/**
- * @param $event_id
+ * @param int $event_id
*
* @return mixed
*/
}
/**
- * @param $id
+ * @param int $id
*
* @return bool|CRM_Event_Cart_BAO_Cart
*/
}
/**
- * @param $id
+ * @param int $id
*
* @return bool|CRM_Event_Cart_BAO_Cart
*/
}
/**
- * @param $user_id
+ * @param int $user_id
*
* @return bool|CRM_Event_Cart_BAO_Cart
*/
}
/**
- * @param $main_conference_event_id
+ * @param int $main_conference_event_id
*
* @return array
*/
}
/**
- * @param $event_id
+ * @param int $event_id
*
* @return mixed
*/
}
/**
- * @param $event_in_cart_id
+ * @param int $event_in_cart_id
*
* @return null
*/
}
/**
- * @param $event_in_cart_id
+ * @param int $event_in_cart_id
*
* @return bool|CRM_Event_Cart_BAO_EventInCart
*/
}
/**
- * @param $participant_id
+ * @param int $participant_id
*
* @return int
*/
/**
- * @param $from_cart_id
+ * @param int $from_cart_id
*/
public function adopt_participants($from_cart_id) {
$params = array(
//XXX assumes we don't allow a contact to register for the same conference more than once
//XXX flattens the object tree for convenient templating
/**
- * @param $main_event_participant_id
+ * @param int $main_event_participant_id
*
* @return array|null
*/
}
/**
- * @param $event_cart_id
+ * @param int $event_cart_id
*
* @return array
*/
}
/**
- * @param $id
+ * @param int $id
*
* @return bool|CRM_Event_Cart_BAO_EventInCart
*/
}
/**
- * @param $contact_id
+ * @param int $contact_id
*/
public function remove_participant_by_contact_id($contact_id) {
$to_remove = array();
}
/**
- * @param $participant_id
+ * @param int $participant_id
*
* @return mixed
*/
}
/**
- * @param $participant_id
+ * @param int $participant_id
*/
public function remove_participant_by_id($participant_id) {
$this->get_participant_by_id($participant_id)->delete();
}
/**
- * @param $event_id
+ * @param int $event_id
*
* @return array
*/
}
/**
- * @param null $parent_event_id
+ * @param int $parent_event_id
*
* @return bool
*/
}
/**
- * @param $event_cart_id
+ * @param int $event_cart_id
*
* @return array|null
*/
}
/**
- * @param $event_id
- * @param $event_cart_id
+ * @param int $event_id
+ * @param int $event_cart_id
*
* @return array|null
*/
}
/**
- * @param $id
+ * @param int $id
*
* @return mixed
*/
}
/**
- * @param $event_id
+ * @param int $event_id
*
* @return bool|int|null|string
*/
}
/**
- * @param null $registeringContactID
+ * @param int $registeringContactID
* @param array $fields
*
* @return int|mixed|null
}
/**
- * @param $page_name
+ * @param string $page_name
*
* @return mixed
*/
}
/**
- * @param $event_id
+ * @param int $event_id
*
* @return array
*/
}
/**
- * @param $event_id
- * @param $participant_id
- * @param $field_name
+ * @param int $event_id
+ * @param int $participant_id
+ * @param string $field_name
*
* @return string
*/
}
/**
- * @param $field_name
+ * @param string $field_name
*
* @return string
*/
class CRM_Event_Controller_Registration extends CRM_Core_Controller {
/**
- * class constructor
+ * Class constructor
*/
function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) {
parent::__construct($title, $modal);
class CRM_Event_Controller_Search extends CRM_Core_Controller {
/**
- * class constructor
+ * Class constructor
*/
function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) {
class CRM_Event_Form_EventFees {
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @param CRM_Core_Form $form
*
*
* @access public
*
- * @param $participantID
- * @param null $eventID
+ * @param int $participantID
+ * @param int $eventID
* @param bool $includeQtyZero
*
* @return void
class CRM_Event_Form_ManageEvent extends CRM_Core_Form {
/**
- * the id of the event we are proceessing
+ * The id of the event we are proceessing
*
* @var int
* @protected
public $_id;
/**
- * is this the first page?
+ * Is this the first page?
*
* @var boolean
* @access protected
protected $_first = FALSE;
/**
- * are we in single form mode or wizard mode?
+ * Are we in single form mode or wizard mode?
*
* @var boolean
* @access protected
protected $_action;
/**
- * are we actually managing an event template?
+ * Are we actually managing an event template?
* @var boolean
*/
protected $_isTemplate = FALSE;
/**
- * pre-populate fields based on this template event_id
+ * Pre-populate fields based on this template event_id
* @var integer
*/
protected $_templateId;
protected $_isRepeatingEvent;
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
class CRM_Event_Form_ManageEvent_Delete extends CRM_Event_Form_ManageEvent {
/**
- * page title
+ * Page title
*
* @var string
* @protected
protected $_title;
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
protected $_eventType = NULL;
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $values
*
public $_action;
/**
- * in Date
+ * In Date
*/
private $_inDate;
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $values posted values of the form
*
class CRM_Event_Form_ManageEvent_Location extends CRM_Event_Form_ManageEvent {
/**
- * how many locationBlocks should we display?
+ * How many locationBlocks should we display?
*
* @var int
* @const
CONST LOCATION_BLOCKS = 1;
/**
- * the variable, for storing the location array
+ * The variable, for storing the location array
*
* @var array
*/
protected $_locationIds = array();
/**
- * the variable, for storing location block id with event
+ * The variable, for storing location block id with event
*
* @var int
*/
protected $_oldLocBlockId = 0;
/**
- * get the db values for this form
+ * Get the db values for this form
*
*/
public $_values = array();
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $fields posted values of the form
*
class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent {
/**
- * what blocks should we show and hide.
+ * What blocks should we show and hide.
*
* @var CRM_Core_ShowHideBlocks
*/
protected $_profilePostMultipleAdd = array();
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
}
/**
- * build Registration Block
+ * Build Registration Block
*
* @param CRM_Core_Form $form
*
}
/**
- * build Confirmation Block
+ * Build Confirmation Block
*
* @param CRM_Core_Form $form
*
}
/**
- * Function to build Email Block
+ * Build Email Block
*
* @param CRM_Core_Form $form
*
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $values
* @param $files
class CRM_Event_Form_ManageEvent_ScheduleReminders extends CRM_Event_Form_ManageEvent {
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $fields posted values of the form
*
public $useLivePageJS = TRUE;
/**
- * the values for the contribution db object
+ * The values for the contribution db object
*
* @var array
* @protected
public $_values;
/**
- * the values for the quickconfig for priceset
+ * The values for the quickconfig for priceset
*
* @var boolean
* @protected
public $_priceSet;
/**
- * the id of the participation that we are proceessing
+ * The id of the participation that we are proceessing
*
* @var int
* @protected
public $_id;
/**
- * the id of the note
+ * The id of the note
*
* @var int
* @protected
protected $_noteId = NULL;
/**
- * the id of the contact associated with this participation
+ * The id of the contact associated with this participation
*
* @var int
* @protected
public $_contactId;
/**
- * array of event values
+ * Array of event values
*
* @var array
* @protected
protected $_eventTypeId = NULL;
/**
- * participant status Id
+ * Participant status Id
*/
protected $_statusId = NULL;
/**
- * cache all the participant statuses
+ * Cache all the participant statuses
*/
protected $_participantStatuses;
/**
- * participant mode
+ * Participant mode
*/
public $_mode = NULL;
/**
- * event ID preselect
+ * Event ID preselect
*/
public $_eID = NULL;
public $_online;
/**
- * store id of role custom data type ( option value )
+ * Store id of role custom data type ( option value )
*/
protected $_roleCustomDataTypeID;
/**
- * store id of event Name custom data type ( option value)
+ * Store id of event Name custom data type ( option value)
*/
protected $_eventNameCustomDataTypeID;
/**
- * selected discount id
+ * Selected discount id
*/
public $_originalDiscountId = NULL;
/**
- * event id
+ * Event id
*/
public $_eventId = NULL;
/**
- * id of payment, if any
+ * Id of payment, if any
*/
public $_paymentId = NULL;
public $_onlinePendingContributionId = NULL;
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $values posted values of the form
* @param $files
public $useLivePageJS = TRUE;
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
class CRM_Event_Form_Registration extends CRM_Core_Form {
/**
- * how many locationBlocks should we display?
+ * How many locationBlocks should we display?
*
* @var int
* @const
CONST LOCATION_BLOCKS = 1;
/**
- * the id of the event we are proceessing
+ * The id of the event we are proceessing
*
* @var int
* @protected
public $_eventId;
/**
- * the array of ids of all the participant we are proceessing
+ * The array of ids of all the participant we are proceessing
*
* @var int
* @protected
protected $_participantIDS = NULL;
/**
- * the id of the participant we are proceessing
+ * The id of the participant we are proceessing
*
* @var int
* @protected
protected $_participantId;
/**
- * is participant able to walk registration wizard.
+ * Is participant able to walk registration wizard.
*
* @var Boolean
* @protected
public $_allowConfirmation;
/**
- * is participant requires approval
+ * Is participant requires approval
*
* @var Boolean
* @public
public $_requireApproval;
/**
- * is event configured for waitlist.
+ * Is event configured for waitlist.
*
* @var Boolean
* @public
public $_allowWaitlist;
/**
- * store additional participant ids
+ * Store additional participant ids
* when there are pre-registered.
*
* @var array
public $_additionalParticipantIds;
/**
- * the mode that we are in
+ * The mode that we are in
*
* @var string
* @protect
public $_mode;
/**
- * the values for the contribution db object
+ * The values for the contribution db object
*
* @var array
* @protected
public $_values;
/**
- * the paymentProcessor attributes for this page
+ * The paymentProcessor attributes for this page
*
* @var array
* @protected
public $_isBillingAddressRequiredForPayLater;
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
}
/**
- * assign the minimal set of variables to the template
+ * Assign the minimal set of variables to the template
*
* @return void
* @access public
}
/**
- * add the custom fields
+ * Add the custom fields
*
- * @param $id
- * @param $name
+ * @param int $id
+ * @param string $name
* @param bool $viewOnly
*
* @return void
/**
* @param CRM_Core_Form $form
- * @param $eventID
+ * @param int $eventID
*
* @throws Exception
*/
}
/**
- * handle process after the confirmation of payment by User
+ * Handle process after the confirmation of payment by User
*
- * @param null $contactID
+ * @param int $contactID
* @param null $contribution
* @param null $payment
*
* Process the participant
*
* @param array $params
- * @param $contactID
+ * @param int $contactID
*
* @return void
* @access public
// set the first participant ID if not set, CRM-10032
/**
- * @param $participantID
+ * @param int $participantID
*/
function processFirstParticipant($participantID) {
$this->_participantId = $participantID;
public $_defaults = array();
/**
- * pre-registered additional participant id.
+ * Pre-registered additional participant id.
*
*/
public $additionalParticipantId = NULL;
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
}
/**
- * global form rule
+ * Global form rule
*
* @param array $fields the input form values
* @param array $files the uploaded files if any
}
/**
- * check whether call current participant is last one
+ * Check whether call current participant is last one
*
* @param bool $isButtonJs
*
}
/**
- * @param $elementName
+ * @param string $elementName
* @param array $optionIds
*/
function resetSubmittedValue($elementName, $optionIds = array()) {
class CRM_Event_Form_Registration_Confirm extends CRM_Event_Form_Registration {
/**
- * the values for the contribution db object
+ * The values for the contribution db object
*
* @var array
* @protected
public $_values;
/**
- * the total amount
+ * The total amount
*
* @var float
* @public
public $_totalAmount;
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
}
/**
- * overwrite action, since we are only showing elements in frozen mode
+ * Overwrite action, since we are only showing elements in frozen mode
* no help display needed
*
* @return int
* @param CRM_Core_Form $form
* @param array $params
* @param $result
- * @param $contactID
+ * @param int $contactID
* @param bool $pending
* @param bool $isAdditionalAmount
*
}
/**
- * update contact fields
+ * Update contact fields
*
- * @param $contactID
+ * @param int $contactID
* @param array $params
* @param $fields
* @param CRM_Core_Form $form
protected $_cc = NULL;
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
public $_noFees;
/**
- * array of payment related fields to potentially display on this form (generally credit card or debit card fields). This is rendered via billingBlock.tpl
+ * Array of payment related fields to potentially display on this form (generally credit card or debit card fields). This is rendered via billingBlock.tpl
* @var array
*/
public $_paymentFields = array();
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
}
/**
- * build the radio/text form elements for the amount field
+ * Build the radio/text form elements for the amount field
*
* @param CRM_Core_Form $form form object
* @param boolean $required true if you want to add formRule
}
/**
- * global form rule
+ * Global form rule
*
* @param array $fields the input form values
* @param array $files the uploaded files if any
*/
/**
* @param array $params
- * @param null $contactID
+ * @param int $contactID
*/
public function processRegistration($params, $contactID = NULL) {
$session = CRM_Core_Session::singleton();
class CRM_Event_Form_Registration_ThankYou extends CRM_Event_Form_Registration {
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
}
/**
- * overwrite action, since we are only showing elements in frozen mode
+ * Overwrite action, since we are only showing elements in frozen mode
* no help display needed
*
* @return int
class CRM_Event_Form_Search extends CRM_Core_Form_Search {
/**
- * the params that are sent to the query
+ * The params that are sent to the query
*
* @var array
* @access protected
protected $_queryParams;
/**
- * are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact
*
* @access protected
* @var boolean
protected $_single = FALSE;
/**
- * are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact
*
* @access protected
* @var boolean
protected $_limit = NULL;
/**
- * prefix for the controller
+ * Prefix for the controller
*
*/
protected $_prefix = "event_";
protected $_defaults;
/**
- * the saved search ID retrieved from the GET vars
+ * The saved search ID retrieved from the GET vars
*
* @var int
* @access protected
protected $_ssID;
/**
- * processing needed for buildForm and later
+ * Processing needed for buildForm and later
*
* @return void
* @access public
class CRM_Event_Form_Task extends CRM_Core_Form {
/**
- * the task being performed
+ * The task being performed
*
* @var int
*/
protected $_participantIds;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @param
*
}
/**
- * simple shell that derived classes can call to add buttons to
+ * Simple shell that derived classes can call to add buttons to
* the form with a customized title for the main Submit
*
* @param string $title title of the main button
protected $_context;
/**
- * the groupId retrieved from the GET vars
+ * The groupId retrieved from the GET vars
*
* @var int
*/
protected $_id;
/**
- * the title of the group
+ * The title of the group
*
* @var string
*/
protected $_title;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $fields posted values of the form
*
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
public $_single = FALSE;
/**
- * component clause
+ * Component clause
*/
public $_componentClause;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @param
*
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
class CRM_Event_Form_Task_Batch extends CRM_Event_Form_Task {
/**
- * the title of the group
+ * The title of the group
*
* @var string
*/
protected $_title;
/**
- * maximum profile fields that will be displayed
+ * Maximum profile fields that will be displayed
*
*/
protected $_maxFields = 9;
/**
- * variable to store redirect path
+ * Variable to store redirect path
*
*/
protected $_userContext;
/**
- * variable to store previous status id.
+ * Variable to store previous status id.
*
*/
protected $_fromStatusIds;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
}
/**
- * @param $participantId
- * @param $statusId
+ * @param int $participantId
+ * @param int $statusId
*
* @return Ambigous|void
*/
class CRM_Event_Form_Task_Cancel extends CRM_Event_Form_Task {
/**
- * variable to store redirect path
+ * Variable to store redirect path
*
*/
protected $_userContext;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
protected $_single = FALSE;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
public $_noEmails = FALSE;
/**
- * all the existing templates in the system
+ * All the existing templates in the system
*
* @var array
*/
public $_templates = NULL;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
class CRM_Event_Form_Task_PickProfile extends CRM_Event_Form_Task {
/**
- * the title of the group
+ * The title of the group
*
* @var string
*/
protected $_title;
/**
- * maximum event participations that should be allowed to update
+ * Maximum event participations that should be allowed to update
*
*/
protected $_maxParticipations = 100;
/**
- * variable to store redirect path
+ * Variable to store redirect path
*
*/
protected $_userContext;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $fields posted values of the form
*
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
class CRM_Event_Form_Task_Print extends CRM_Event_Form_Task {
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
class CRM_Event_Form_Task_Result extends CRM_Event_Form_Task {
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
class CRM_Event_Form_Task_SaveSearch extends CRM_Event_Form_Task {
/**
- * saved search id if any
+ * Saved search id if any
*
* @var int
*/
protected $_id;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
class CRM_Event_Form_Task_SaveSearch_Update extends CRM_Event_Form_Task_SaveSearch {
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
class CRM_Event_Form_Task_SearchTaskHookSample extends CRM_Event_Form_Task {
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
class CRM_Event_Import_Controller extends CRM_Core_Controller {
/**
- * class constructor
+ * Class constructor
*/
function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) {
parent::__construct($title, $modal);
*/
/**
- * name of the field
+ * Name of the field
*/
public $_name;
/**
- * title of the field to be used in display
+ * Title of the field to be used in display
*/
public $_title;
/**
- * type of field
+ * Type of field
* @var enum
*/
public $_type;
/**
- * regexp to match the CSV header of this column/field
+ * Regexp to match the CSV header of this column/field
* @var string
*/
public $_headerPattern;
/**
- * regexp to match the pattern of data from various column/fields
+ * Regexp to match the pattern of data from various column/fields
* @var string
*/
public $_dataPattern;
/**
- * value of this field
+ * Value of this field
* @var object
*/
public $_value;
/**
- * @param $name
+ * @param string $name
* @param $title
* @param int $type
* @param string $headerPattern
}
/**
- * the value is in string format. convert the value to the type of this field
+ * The value is in string format. convert the value to the type of this field
* and set the field value with the appropriate type
*/
function setValue($value) {
class CRM_Event_Import_Form_DataSource extends CRM_Core_Form {
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $fields posted values of the form
*
class CRM_Event_Import_Form_Preview extends CRM_Import_Form_Preview {
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
class CRM_Event_Import_Form_Summary extends CRM_Import_Form_Summary {
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
*/
/**
- * imported file size
+ * Imported file size
*/
protected $_fileSize;
/**
- * seperator being used
+ * Seperator being used
*/
protected $_seperator;
/**
- * total number of lines in file
+ * Total number of lines in file
*/
protected $_lineCount;
/**
- * whether the file has a column header or not
+ * Whether the file has a column header or not
*
* @var boolean
*/
protected $_haveColumnHeader;
/**
- * @param $fileName
+ * @param string $fileName
* @param string $seperator
* @param $mapper
* @param bool $skipColumnHeader
}
/**
- * format the field values for input to the api
+ * Format the field values for input to the api
*
* @return array (reference ) associative array of name/value pairs
* @access public
}
/**
- * @param $name
+ * @param string $name
* @param $title
* @param int $type
* @param string $headerPattern
protected $_newParticipants;
/**
- * class constructor
+ * Class constructor
*/
function __construct(&$mapperKeys, $mapperLocType = NULL, $mapperPhoneType = NULL) {
parent::__construct();
}
/**
- * the initializer code, called before the processing
+ * The initializer code, called before the processing
*
* @return void
* @access public
}
/**
- * handle the values in mapField mode
+ * Handle the values in mapField mode
*
* @param array $values the array of values belonging to this line
*
}
/**
- * handle the values in preview mode
+ * Handle the values in preview mode
*
* @param array $values the array of values belonging to this line
*
}
/**
- * handle the values in summary mode
+ * Handle the values in summary mode
*
* @param array $values the array of values belonging to this line
*
}
/**
- * handle the values in import mode
+ * Handle the values in import mode
*
* @param int $onDuplicate the code for what action to take on duplicates
* @param array $values the array of values belonging to this line
}
/**
- * the initializer code, called before the processing
+ * The initializer code, called before the processing
*
* @return void
* @access public
class CRM_Event_Page_AJAX {
/**
- * building EventFee combo box
+ * Building EventFee combo box
* FIXME: This ajax callback could be eliminated in favor of an entityRef field but the priceFieldValue api doesn't currently support filtering on entity_table
*/
function eventFee() {
}
/**
- * browse all events
+ * Browse all events
*
* @return void
*/
/**
* @param $whereClause
- * @param $whereParams
+ * @param array $whereParams
*/
function pager($whereClause, $whereParams) {
/**
* @param $whereClause
- * @param $whereParams
+ * @param array $whereParams
*/
function pagerAtoZ($whereClause, $whereParams) {
/**
* @param $fromClause
* @param $whereClause
- * @param $whereParams
+ * @param array $whereParams
*/
function pager($fromClause, $whereClause, $whereParams) {
/**
* @param $fromClause
* @param $whereClause
- * @param $whereParams
+ * @param array $whereParams
*/
function pager($fromClause, $whereClause, $whereParams) {
class CRM_Event_Page_UserDashboard extends CRM_Contact_Page_View_UserDashBoard {
/**
- * list participations for the UF user
+ * List participations for the UF user
*
* return null
* @access public
private static $eventType;
/**
- * event template titles
+ * Event template titles
* @var array
*/
private static $eventTemplates;
*
* @access public
*
- * @param null $id
+ * @param int $id
* @param bool $all
* @param null $condition
*
*
* @access public
*
- * @param null $id
+ * @param int $id
* @param null $cond
* @param string $retColumn tells populate() whether to return 'name' (default) or 'label' values
*
*
* @access public
*
- * @param null $id
+ * @param int $id
* @param null $cond
*
* @return array - array reference of all participant roles if any
*
* @access public
*
- * @param null $id
+ * @param int $id
*
* @return array - array reference of all participant listings if any
* @static
*
* @access public
*
- * @param null $id
+ * @param int $id
* @return array - array reference of all event types.
* @static
*/
}
/**
- * get event template titles
+ * Get event template titles
*
- * @param null $id
+ * @param int $id
*
* @return array of event id → template title pairs
*/
*
* @access public
*
- * @param null $id
+ * @param int $id
* @return array - array reference of all pcp if any
* @static
*/
static $_links = NULL;
/**
- * we use desc to remind us what that column is, name is used in the tpl
+ * We use desc to remind us what that column is, name is used in the tpl
*
* @var array
* @static
);
/**
- * are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact
*
* @access protected
* @var boolean
protected $_single = FALSE;
/**
- * are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact
*
* @access protected
* @var boolean
protected $_limit = NULL;
/**
- * what context are we being invoked from
+ * What context are we being invoked from
*
* @access protected
* @var string
protected $_context = NULL;
/**
- * what component context are we being invoked from
+ * What component context are we being invoked from
*
* @access protected
* @var string
protected $_compContext = NULL;
/**
- * queryParams is the array returned by exportValues called on
+ * QueryParams is the array returned by exportValues called on
* the HTML_QuickForm_Controller for that page.
*
* @var array
public $_queryParams;
/**
- * represent the type of selector
+ * Represent the type of selector
*
* @var int
* @access protected
}
/**
- * getter for array of the parameters required for creating pager.
+ * Getter for array of the parameters required for creating pager.
*
* @param $action
* @param array $params
}
/**
- * returns all the rows in the given offset and rowCount
+ * Returns all the rows in the given offset and rowCount
*
* @param enum $action the action being performed
* @param int $offset the row number to start from
}
/**
- * returns the column headers as an array of tuples:
+ * Returns the column headers as an array of tuples:
* (name, sortName (key to the sort array))
*
* @param string $action the action being performed
}
/**
- * name of export file.
+ * Name of export file.
*
* @param string $output type of output
*
class CRM_Event_StateMachine_Registration extends CRM_Core_StateMachine {
/**
- * class constructor
+ * Class constructor
*
* @param object $controller
* @param \const|int $action
protected $_task;
/**
- * class constructor
+ * Class constructor
*/
function __construct($controller, $action = CRM_Core_Action::NONE) {
parent::__construct($controller, $action);
}
/**
- * return the form name of the task
+ * Return the form name of the task
*
* @return string
* @access public
LABEL_CONTACTS = 16, GROUP_CONTACTS = 20;
/**
- * the task array
+ * The task array
*
* @var array
* @static
static $_tasks = NULL;
/**
- * the optional task array
+ * The optional task array
*
* @var array
* @static
}
/**
- * show tasks selectively based on the permission level
+ * Show tasks selectively based on the permission level
* of the user
*
* @param int $permission
CONST EXPORT_ROW_COUNT = 10000;
/**
- * get the list the export fields
+ * Get the list the export fields
*
* @param int $selectAll user preference while export
* @param array $ids contact ids
}
/**
- * name of the export file based on mode
+ * Name of the export file based on mode
*
* @param string $output type of output
* @param int $mode export mode
}
/**
- * handle import error file creation.
+ * Handle import error file creation.
*
*/
static function invoke() {
}
/**
- * @param $tableName
+ * @param string $tableName
* @param $details
* @param $sqlColumns
*/
}
/**
- * @param $tableName
+ * @param string $tableName
* @param $headerRows
* @param $sqlColumns
- * @param $exportParams
+ * @param array $exportParams
*/
static function mergeSameAddress($tableName, &$headerRows, &$sqlColumns, $exportParams) {
// check if any records are present based on if they have used shared address feature,
}
/**
- * @param $contactId
- * @param $exportParams
+ * @param int $contactId
+ * @param array $exportParams
*
* @return array
*/
/**
* @param $sql
- * @param $exportParams
+ * @param array $exportParams
* @param bool $sharedAddress
*
* @return array
}
/**
- * merge household record into the individual record
+ * Merge household record into the individual record
* if exists
*
* @param string $exportTempTable temporary temp table that stores the records
}
/**
- * Function to manipulate header rows for relationship fields
+ * Manipulate header rows for relationship fields
*
*/
public static function manipulateHeaderRows(&$headerRows, $contactRelationshipTypes) {
}
/**
- * Function to exclude contacts who are deceased, have "Do not mail" privacy setting,
+ * Exclude contacts who are deceased, have "Do not mail" privacy setting,
* or have no street address
*
*/
class CRM_Export_Form_Map extends CRM_Core_Form {
/**
- * mapper fields
+ * Mapper fields
*
* @var array
* @access protected
protected $_mapperFields;
/**
- * number of columns in import file
+ * Number of columns in import file
*
* @var int
* @access protected
protected $_exportColumnCount;
/**
- * loaded mapping ID
+ * Loaded mapping ID
*
* @var int
* @access protected
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $fields posted values of the form
*
* @param $values
- * @param $mappingTypeId
+ * @param int $mappingTypeId
*
* @return array list of errors to be posted back to the form
* @static
class CRM_Export_Form_Select extends CRM_Core_Form {
/**
- * various Contact types
+ * Various Contact types
*/
CONST
EXPORT_ALL = 1,
EXPORT_MERGE_HOUSEHOLD = 2;
/**
- * export modes
+ * Export modes
*/
CONST
CONTACT_EXPORT = 1,
ACTIVITY_EXPORT = 8;
/**
- * current export mode
+ * Current export mode
*
* @var int
*/
public $_componentTable;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @param
*
}
/**
- * validation
+ * Validation
*
* @param array $params (ref.) an assoc array of name/value pairs
*
}
/**
- * build mapping form element
+ * Build mapping form element
*
*/
function buildMapping() {
/**
* @param CRM_Extension_Info $info
- * @param $hookName
+ * @param string $hookName
*/
private function callHook(CRM_Extension_Info $info, $hookName) {
try {
}
/**
- * run hooks in the payment processor class
+ * Run hooks in the payment processor class
* Load requested payment processor and call the method specified.
*
* @param CRM_Extension_Info $info
}
/**
- * @param $name
+ * @param string $name
*
* @return bool
*/
static protected $_template;
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
if ( !isset( self::$_template ) ) {
// Override to assemble the appropriate subset of financial data for the specific export format
/**
- * @param $exportParams
+ * @param array $exportParams
*
* @return mixed
*/
/**
* @param $batchIds
- * @param $fileName
+ * @param string $fileName
*
* @throws CRM_Core_Exception
*/
);
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
}
/**
- * @param $exportParams
+ * @param array $exportParams
*/
function export($exportParams) {
$export = parent::export($exportParams);
}
/**
- * @param $batchId
+ * @param int $batchId
*
* @return Object
*/
);
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
}
/**
- * @param $exportParams
+ * @param array $exportParams
*/
function export( $exportParams ) {
parent::export( $exportParams );
}
/**
- * @param $batchId
+ * @param int $batchId
*
* @return Object
*/
class CRM_Financial_BAO_FinancialAccount extends CRM_Financial_DAO_FinancialAccount {
/**
- * static holder for the default LT
+ * Static holder for the default LT
*/
static $_defaultContributionType = NULL;
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
}
/**
- * update the is_active flag in the db
+ * 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
}
/**
- * add the financial types
+ * Add the financial types
*
* @param array $params reference array contains the values submitted by the form
* @param array $ids reference array contains the id
}
/**
- * delete financial Types
+ * Delete financial Types
*
* @param int $financialAccountId
* @static
}
/**
- * get accounting code for a financial type with account relation Income Account is
+ * Get accounting code for a financial type with account relation Income Account is
*
* @financialTypeId int Financial Type Id
*
- * @param $financialTypeId
+ * @param int $financialTypeId
*
* @return accounting code
* @static
}
/**
- * get AR account
+ * Get AR account
*
* @param $financialAccountId financial account id
*
class CRM_Financial_BAO_FinancialItem extends CRM_Financial_DAO_FinancialItem {
/**
- * class constructor
+ * Class constructor
*/
function __construct( ) {
parent::__construct( );
}
/**
- * add the financial items and financial trxn
+ * Add the financial items and financial trxn
*
* @param object $lineItem line item object
* @param object $contribution contribution object
}
/**
- * create the financial Items and financial enity trxn
+ * Create the financial Items and financial enity trxn
*
* @param array $params associated array to create financial items
* @param array $ids financial item ids
}
/**
- * takes an associative array and creates a entity financial transaction object
+ * Takes an associative array and creates a entity financial transaction object
*
* @param array $params (reference ) an assoc array of name/value pairs
*
}
/**
- * retrive entity financial trxn details
+ * Retrive entity financial trxn details
*
* @param array $params (reference ) an assoc array of name/value pairs
* @param bool $maxId to retrive max id
}
/**
- * check if contact is present in financial_item table
+ * Check if contact is present in financial_item table
*
* CRM-12929
*
class CRM_Financial_BAO_FinancialType extends CRM_Financial_DAO_FinancialType {
/**
- * static holder for the default LT
+ * Static holder for the default LT
*/
static $_defaultContributionType = null;
/**
- * class constructor
+ * Class constructor
*/
function __construct( ) {
parent::__construct( );
}
/**
- * update the is_active flag in the db
+ * 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
}
/**
- * add the financial types
+ * Add the financial types
*
* @param array $params reference array contains the values submitted by the form
* @param array $ids reference array contains the id
}
/**
- * delete financial Types
+ * Delete financial Types
*
* @param int $financialTypeId
*
}
/**
- * to fetch financial type having relationship as Income Account is
+ * To fetch financial type having relationship as Income Account is
*
*
* @return array all financial type with income account is relationship
class CRM_Financial_BAO_FinancialTypeAccount extends CRM_Financial_DAO_EntityFinancialAccount {
/**
- * class constructor
+ * Class constructor
*/
function __construct( ) {
parent::__construct( );
}
/**
- * financial account
+ * Financial account
* @var array
* @static
*/
}
/**
- * add the financial types
+ * Add the financial types
*
* @param array $params reference array contains the values submitted by the form
* @param array $ids reference array contains the id
}
/**
- * delete financial Types
+ * Delete financial Types
*
* @param int $financialTypeAccountId
* @param int $accountId
}
/**
- * get Financial Account Name
+ * Get Financial Account Name
*
* @param int $entityId
*
}
/**
- * Function to financial Account for payment instrument
+ * Financial Account for payment instrument
*
* @param int $paymentInstrumentValue payment instrument value
*
}
/**
- * Function to create default entity financial accounts
+ * Create default entity financial accounts
* for financial type
* CRM-12470
*
class CRM_Financial_BAO_PaymentProcessor extends CRM_Financial_DAO_PaymentProcessor
{
/**
- * static holder for the default payment processor
+ * Static holder for the default payment processor
*/
static $_defaultPaymentProcessor = NULL;
}
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
}
/**
- * update the is_active flag in the db
+ * 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
}
/**
- * retrieve the default payment processor
+ * Retrieve the default payment processor
*
* @param NULL
*
}
/**
- * get the payment processor details
+ * Get the payment processor details
*
* @param int $paymentProcessorID payment processor id
* @param string $mode payment mode ie test or live
}
/**
- * compare 2 payment processors to see which should go first based on is_default
+ * Compare 2 payment processors to see which should go first based on is_default
* (sort function for sortDefaultFirst)
* @param array $processor1
* @param array_type $processor2
}
/**
- * build payment processor details
+ * Build payment processor details
*
* @param object $dao payment processor object
* @param string $mode payment mode ie test or live
}
/**
- * get all payment processors as an array of objects.
+ * Get all payment processors as an array of objects.
*
* @param $isExcludeTest
* @param bool $reset
}
/**
- * get Payment processors with specified capabilities.
+ * Get Payment processors with specified capabilities.
* Note that both the singleton & the pseudoconstant function have caching so we don't add
* arguably this could go on the pseudoconstant class
*
}
/**
- * retrieve payment processor id / info/ object based on component-id.
+ * Retrieve payment processor id / info/ object based on component-id.
*
- * @param $entityID
+ * @param int $entityID
* @param string $component component
* @param string $type type of payment information to be retrieved
*
class CRM_Financial_BAO_PaymentProcessorType extends CRM_Financial_DAO_PaymentProcessorType {
/**
- * static holder for the default payment processor
+ * Static holder for the default payment processor
*/
static $_defaultPaymentProcessorType = NULL;
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
}
/**
- * update the is_active flag in the db
+ * 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
}
/**
- * retrieve the default payment processor
+ * Retrieve the default payment processor
*
* @param NULL
*
}
/**
- * add the payment-processor type in the db
+ * Add the payment-processor type in the db
*
* @param array $params (reference ) an assoc array of name/value pairs
*
}
/**
- * delete payment processor
+ * Delete payment processor
*
* @param int $paymentProcessorTypeId ID of the processor to be deleted.
*
protected $_exportFormat;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
* @return void
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param $values
* @param $files
protected $_id;
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $values
* @param $files
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param $action
* @param $permissions
- * @param $createdID
- * @param $userContactID
- * @param $actionName
+ * @param int $createdID
+ * @param int $userContactID
+ * @param string $actionName
*
* @return array list of errors to be posted back to the form
* @static
class CRM_Financial_Form_FinancialTypeAccount extends CRM_Contribute_Form {
/**
- * the financial type id saved to the session for an update
+ * The financial type id saved to the session for an update
*
* @var int
* @access protected
protected $_isARFlag = FALSE;
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param $values
* @param $files
}
/**
- * browse all entities.
+ * Browse all entities.
*
* @return void
* @access public
}
/**
- * edit CiviCRM Financial Type Account data.
+ * Edit CiviCRM Financial Type Account data.
*
* editing would involved modifying existing financial Account Type + adding data
* to new financial Account Type.
}
/**
- * takes an associative array and creates a friend object
+ * Takes an associative array and creates a friend object
*
* the function extract all the params it needs to initialize the create a
* friend object. the params array could contain additional unused name/value
}
/**
- * takes an associative array and creates a friend object
+ * Takes an associative array and creates a friend object
*
* @param array $params (reference ) an assoc array of name/value pairs
*
}
/**
- * takes an associative array and creates a tell a friend object
+ * Takes an associative array and creates a tell a friend object
*
* the function extract all the params it needs to initialize the create/edit a
* friend object. the params array could contain additional unused name/value
CONST NUM_OPTION = 3;
/**
- * the id of the entity that we are proceessing
+ * The id of the entity that we are proceessing
*
* @var int
* @protected
protected $_entityId;
/**
- * the table name of the entity that we are proceessing
+ * The table name of the entity that we are proceessing
*
* @var string
* @protected
protected $_campaignId;
/**
- * the contact ID
+ * The contact ID
*
* @var int
* @protected
}
/**
- * validation
+ * Validation
*
* @param array $fields
*
class CRM_Friend_Form_Contribute extends CRM_Contribute_Form_ContributionPage {
/**
- * tell a friend id in db
+ * Tell a friend id in db
*
* @var int
*/
class CRM_Friend_Form_Event extends CRM_Event_Form_ManageEvent {
/**
- * tell a friend id in db
+ * Tell a friend id in db
*
* @var int
*/
class CRM_Grant_BAO_Grant extends CRM_Grant_DAO_Grant {
/**
- * static field for all the grant information that we can potentially export
+ * Static field for all the grant information that we can potentially export
* @var array
* @static
*/
static $_exportableFields = NULL;
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
}
/**
- * get events Summary
+ * Get events Summary
*
* @static
*
}
/**
- * get events Summary
+ * Get events Summary
*
* @static
*
}
/**
- * retrieve statistics for grants.
+ * Retrieve statistics for grants.
*
* @static
*
}
/**
- * function to add grant
+ * Add grant
*
* @param array $params reference array contains the values submitted by the form
* @param array $ids reference array contains the id
}
/**
- * function to create the event
+ * Create the event
*
* @param array $params reference array contains the values submitted by the form
* @param array $ids reference array contains the id
}
/**
- * Function to delete the Contact
+ * Delete the Contact
*
* @param int $id contact id
*
}
/**
- * Function to delete the grant
+ * Delete the grant
*
* @param int $id grant id
*
}
/**
- * combine all the exportable fields from the lower levels object
+ * Combine all the exportable fields from the lower levels object
*
* @return array array of exportable Fields
* @access public
}
/**
- * Function to get grant record count for a Contact
+ * Get grant record count for a Contact
*
* @param int $contactID
*
}
/**
- * build select for CiviGrant
+ * Build select for CiviGrant
*
* @param $query
*
}
/**
- * @param $name
+ * @param string $name
* @param $mode
* @param $side
*
}
/**
- * getter for the qill object
+ * Getter for the qill object
*
* @return string
* @access public
}
/**
- * add all the elements shared between grant search and advanaced search
+ * Add all the elements shared between grant search and advanaced search
*
* @access public
*
/**
* @param $row
- * @param $id
+ * @param int $id
*/
static function searchAction(&$row, $id) {}
class CRM_Grant_Controller_Search extends CRM_Core_Controller {
/**
- * class constructor
+ * Class constructor
*/
function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) {
class CRM_Grant_Form_Grant extends CRM_Core_Form {
/**
- * the id of the case that we are proceessing
+ * The id of the case that we are proceessing
*
* @var int
* @protected
protected $_id;
/**
- * the id of the contact associated with this contribution
+ * The id of the contact associated with this contribution
*
* @var int
* @protected
protected $_context;
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
class CRM_Grant_Form_GrantView extends CRM_Core_Form {
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
class CRM_Grant_Form_Search extends CRM_Core_Form_Search {
/**
- * the params that are sent to the query
+ * The params that are sent to the query
*
* @var array
* @access protected
protected $_queryParams;
/**
- * are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact
*
* @access protected
* @var boolean
protected $_single = FALSE;
/**
- * are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact
*
* @access protected
* @var boolean
protected $_limit = NULL;
/**
- * prefix for the controller
+ * Prefix for the controller
*
*/
protected $_prefix = "grant_";
protected $_defaults;
/**
- * processing needed for buildForm and later
+ * Processing needed for buildForm and later
*
* @return void
* @access public
class CRM_Grant_Form_Task extends CRM_Core_Form {
/**
- * the task being performed
+ * The task being performed
*
* @var int
*/
protected $_grantIds;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @param
*
}
/**
- * simple shell that derived classes can call to add buttons to
+ * Simple shell that derived classes can call to add buttons to
* the form with a customized title for the main Submit
*
* @param string $title title of the main button
protected $_single = FALSE;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
class CRM_Grant_Form_Task_Print extends CRM_Grant_Form_Task {
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
class CRM_Grant_Form_Task_Result extends CRM_Grant_Form_Task {
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
class CRM_Grant_Form_Task_SearchTaskHookSample extends CRM_Grant_Form_Task {
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
class CRM_Grant_Form_Task_Update extends CRM_Grant_Form_Task {
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
}
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
static $_links = NULL;
/**
- * we use desc to remind us what that column is, name is used in the tpl
+ * We use desc to remind us what that column is, name is used in the tpl
*
* @var array
* @static
);
/**
- * are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact
*
* @access protected
* @var boolean
protected $_single = FALSE;
/**
- * are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact
*
* @access protected
* @var boolean
protected $_limit = NULL;
/**
- * what context are we being invoked from
+ * What context are we being invoked from
*
* @access protected
* @var string
protected $_context = NULL;
/**
- * queryParams is the array returned by exportValues called on
+ * QueryParams is the array returned by exportValues called on
* the HTML_QuickForm_Controller for that page.
*
* @var array
public $_queryParams;
/**
- * represent the type of selector
+ * Represent the type of selector
*
* @var int
* @access protected
}
/**
- * getter for array of the parameters required for creating pager.
+ * Getter for array of the parameters required for creating pager.
*
* @param $action
* @param array $params
}
/**
- * returns all the rows in the given offset and rowCount *
+ * Returns all the rows in the given offset and rowCount *
*
* @param enum $action the action being performed
* @param int $offset the row number to start from
}
/**
- * returns the column headers as an array of tuples:
+ * Returns the column headers as an array of tuples:
* (name, sortName (key to the sort array))
*
* @param string $action the action being performed
}
/**
- * name of export file.
+ * Name of export file.
*
* @param string $output type of output
*
protected $_task;
/**
- * class constructor
+ * Class constructor
*/ function __construct($controller, $action = CRM_Core_Action::NONE) {
parent::__construct($controller, $action);
}
/**
- * return the form name of the task
+ * Return the form name of the task
*
* @return string
* @access public
CONST DELETE_GRANTS = 1, PRINT_GRANTS = 2, EXPORT_GRANTS = 3, UPDATE_GRANTS = 4;
/**
- * the task array
+ * The task array
*
* @var array
* @static
static $_tasks = NULL;
/**
- * the optional task array
+ * The optional task array
*
* @var array
* @static
}
/**
- * show tasks selectively based on the permission level
+ * Show tasks selectively based on the permission level
* of the user
*
* @param int $permission
class CRM_Group_Controller extends CRM_Core_Controller {
/**
- * class constructor
+ * Class constructor
*/
function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) {
parent::__construct($title, $modal);
class CRM_Group_Form_Edit extends CRM_Core_Form {
/**
- * the group id, used when editing a group
+ * The group id, used when editing a group
*
* @var int
*/
protected $_id;
/**
- * the group object, if an id is present
+ * The group object, if an id is present
*
* @var object
*/
protected $_groupValues;
/**
- * what blocks should we show and hide.
+ * What blocks should we show and hide.
*
* @var CRM_Core_ShowHideBlocks
*/
protected $_showHide;
/**
- * the civicrm_group_organization table id
+ * The civicrm_group_organization table id
*
* @var int
*/
protected $_groupOrganizationID;
/**
- * set up variables to build the form
+ * Set up variables to build the form
*
* @return void
* @acess protected
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $fields posted values of the form
- * @param $fileParams
+ * @param array $fileParams
* @param $options
*
* @return array list of errors to be posted back to the form
}
/**
- * define action links
+ * Define action links
*
* @return array self::$_links array of action links
* @access public
function &links() {}
/**
- * return class name of edit form
+ * Return class name of edit form
*
* @return string
* @access public
}
/**
- * return name of edit form
+ * Return name of edit form
*
* @return string
* @access public
}
/**
- * return name of delete form
+ * Return name of delete form
*
* @return string
* @access public
}
/**
- * return user context uri to return to
+ * Return user context uri to return to
*
* @param null $mode
*
}
/**
- * return user context uri params
+ * Return user context uri params
*
* @param null $mode
*
}
/**
- * make sure that the user has permission to access this group
+ * Make sure that the user has permission to access this group
*
* @param int $id the id of the object
* @param int $title name or title of the object
class CRM_Group_StateMachine extends CRM_Core_StateMachine {
/**
- * class constructor
+ * Class constructor
*/
function __construct($controller, $action = CRM_Core_Action::NONE) {
parent::__construct($controller, $action);
}
/**
- * return the form name of the task. This is
+ * Return the form name of the task. This is
*
* @return string
* @access public
abstract public function getInfo();
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @access public
*/
}
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @access public
*/
}
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @access public
*/
abstract class CRM_Import_Form_MapField extends CRM_Core_Form {
/**
- * cache of preview data values
+ * Cache of preview data values
*
* @var array
* @access protected
protected $_dataValues;
/**
- * mapper fields
+ * Mapper fields
*
* @var array
* @access protected
protected $_mapperFields;
/**
- * loaded mapping ID
+ * Loaded mapping ID
*
* @var int
* @access protected
protected $_loadedMappingId;
/**
- * number of columns in import file
+ * Number of columns in import file
*
* @var int
* @access protected
protected $_columnCount;
/**
- * column headers, if we have them
+ * Column headers, if we have them
*
* @var array
* @access protected
protected $_columnHeaders;
/**
- * an array of booleans to keep track of whether a field has been used in
+ * An array of booleans to keep track of whether a field has been used in
* form building already.
*
* @var array
/**
- * total number of non empty lines
+ * Total number of non empty lines
*/
protected $_totalCount;
/**
- * running total number of valid lines
+ * Running total number of valid lines
*/
protected $_validCount;
/**
- * running total number of invalid rows
+ * Running total number of invalid rows
*/
protected $_invalidRowCount;
/**
- * maximum number of non-empty/comment lines to process
+ * Maximum number of non-empty/comment lines to process
*
* @var int
*/
protected $_maxLinesToProcess;
/**
- * maximum number of invalid rows to store
+ * Maximum number of invalid rows to store
*/
protected $_maxErrorCount;
/**
- * array of error lines, bounded by MAX_ERROR
+ * Array of error lines, bounded by MAX_ERROR
*/
protected $_errors;
/**
- * total number of conflict lines
+ * Total number of conflict lines
*/
protected $_conflictCount;
/**
- * array of conflict lines
+ * Array of conflict lines
*/
protected $_conflicts;
/**
- * total number of duplicate (from database) lines
+ * Total number of duplicate (from database) lines
*/
protected $_duplicateCount;
/**
- * array of duplicate lines
+ * Array of duplicate lines
*/
protected $_duplicates;
/**
- * running total number of warnings
+ * Running total number of warnings
*/
protected $_warningCount;
/**
- * maximum number of warnings to store
+ * Maximum number of warnings to store
*/
protected $_maxWarningCount = self::MAX_WARNINGS;
/**
- * array of warning lines, bounded by MAX_WARNING
+ * Array of warning lines, bounded by MAX_WARNING
*/
protected $_warnings;
/**
- * array of all the fields that could potentially be part
+ * Array of all the fields that could potentially be part
* of this import process
* @var array
*/
protected $_fields;
/**
- * array of the fields that are actually part of the import process
+ * Array of the fields that are actually part of the import process
* the position in the array also dictates their position in the import
* file
* @var array
protected $_activeFields;
/**
- * cache the count of active fields
+ * Cache the count of active fields
*
* @var int
*/
protected $_activeFieldCount;
/**
- * cache of preview rows
+ * Cache of preview rows
*
* @var array
*/
protected $_rows;
/**
- * filename of error data
+ * Filename of error data
*
* @var string
*/
protected $_errorFileName;
/**
- * filename of conflict data
+ * Filename of conflict data
*
* @var string
*/
protected $_conflictFileName;
/**
- * filename of duplicate data
+ * Filename of duplicate data
*
* @var string
*/
protected $_duplicateFileName;
/**
- * contact type
+ * Contact type
*
* @var int
*/
}
/**
- * setter function
+ * Setter function
*
* @param int $max
*
private $interval;
/**
- * @param $log_conn_id
+ * @param int $log_conn_id
* @param $log_date
* @param string $interval
*/
/**
* @param $table
- * @param null $contactID
+ * @param int $contactID
*
* @return array
*/
/**
* @param $table
- * @param $id
+ * @param int $id
*
* @return array
*/
}
/**
- * @param $id
+ * @param int $id
* @param $entity
* @param $logDate
*
}
/**
- * @param $id
- * @param $connId
+ * @param int $id
+ * @param int $connId
* @param $entity
* @param $oldAction
*
private $log_date;
/**
- * @param $log_conn_id
+ * @param int $log_conn_id
* @param $log_date
*/
function __construct($log_conn_id, $log_date) {
static $_patterns = NULL;
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
class CRM_Mailing_BAO_Component extends CRM_Mailing_DAO_Component {
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
}
/**
- * update the is_active flag in the db
+ * 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
private $_domain = NULL;
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
}
/**
- * @param $job_id
- * @param null $mailing_id
+ * @param int $job_id
+ * @param int $mailing_id
* @param null $mode
*
* @return int
// note that $job_id is used only as a variable in the temp table construction
// and does not play a role in the queries generated
/**
- * @param $job_id
- * @param null $mailing_id
+ * @param int $job_id
+ * @param int $mailing_id
* @param null $offset
* @param null $limit
* @param bool $storeRecipients
}
/**
- * static wrapper for getting verp and urls
+ * Static wrapper for getting verp and urls
*
* @param int $job_id ID of the Job associated with this message
* @param int $event_queue_id ID of the EventQueue
}
/**
- * get verp, urls and headers
+ * Get verp, urls and headers
*
* @param int $job_id ID of the Job associated with this message
* @param int $event_queue_id ID of the EventQueue
}
/**
- * add the mailings
+ * Add the mailings
*
* @param array $params reference array contains the values submitted by the form
* @param array $ids reference array contains the id
}
/**
- * get hash value of the mailing
+ * Get hash value of the mailing
*
*/
public static function getMailingHash($id) {
}
/**
- * @param $id
+ * @param int $id
*
* @throws Exception
*/
}
/**
- * returns all the mailings that this user can access. This is dependent on
+ * Returns all the mailings that this user can access. This is dependent on
* all the groups that the user has access to.
* However since most civi installs dont use ACL's we special case the condition
* where the user has access to ALL groups, and hence ALL mailings and return a
* @param string $sort The sql string that describes the sort order
*
* @param null $additionalClause
- * @param null $additionalParams
+ * @param array $additionalParams
*
* @return array The rows
* @access public
}
/**
- * show detail Mailing report
+ * Show detail Mailing report
*
* @param int $id
*
}
/**
- * build the compose mail form
+ * Build the compose mail form
*
* @param CRM_Core_Form $form
*
}
/**
- * Function to build the compose PDF letter form
+ * Build the compose PDF letter form
*
* @param CRM_Core_Form $form
*
}
/**
- * @param $jobID
+ * @param int $jobID
*
* @return mixed
*/
}
/**
- * @param $mailingID
+ * @param int $mailingID
*/
private static function addMultipleEmails($mailingID) {
$sql = "
}
/**
- * @param $mid
+ * @param int $mid
*
* @return null|string
*/
}
/**
- * Function to retrieve contact mailing
+ * Retrieve contact mailing
*
* @param array $params associated array
*
}
/**
- * Function to retrieve contact mailing count
+ * Retrieve contact mailing count
*
* @param array $params associated array
*
CONST MAX_CONTACTS_TO_PROCESS = 1000;
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
/**
* Initiate all pending/ready jobs
*
- * @param null $testParams
+ * @param array $testParams
* @param null $mode
*
* @return void
}
/**
- * @param null $testParams
+ * @param array $testParams
*/
public function queue($testParams = NULL) {
$mailing = new CRM_Mailing_BAO_Mailing();
*
* @param object $mailer A Mail object to send the messages
*
- * @param null $testParams
+ * @param array $testParams
*
* @return void
* @access public
}
/**
- * cancel a mailing
+ * Cancel a mailing
*
* @param int $mailingId the id of the mailing to be canceled
* @static
}
/**
- * @param $deliveredParams
- * @param $targetParams
+ * @param array $deliveredParams
+ * @param array $targetParams
* @param $mailing
* @param $job_date
*
}
/**
- * if mailings are involved, add the specific Mailing fields
+ * If mailings are involved, add the specific Mailing fields
*
* @param $query
*
}
/**
- * @param $name
+ * @param string $name
* @param $mode
* @param $side
*
}
/**
- * add all the elements shared between Mailing search and advnaced search
+ * Add all the elements shared between Mailing search and advnaced search
*
* @access public
*
- * @param $form CRM_Core_Form
+ * @param CRM_Core_Form $form
* @return void
* @static
*/
/**
* @param $row
- * @param $id
+ * @param int $id
*/
static function searchAction(&$row, $id) {}
*
* @param $query
* @param $values
- * @param $tableName
- * @param $fieldName
+ * @param string $tableName
+ * @param string $fieldName
* @param $fieldTitle
*
* @param $valueTitles
class CRM_Mailing_BAO_Recipients extends CRM_Mailing_DAO_Recipients {
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
}
/**
- * @param $mailingID
+ * @param int $mailingID
*
* @return null|string
*/
}
/**
- * @param $mailingID
+ * @param int $mailingID
* @param null $offset
* @param null $limit
*
class CRM_Mailing_BAO_Spool extends CRM_Mailing_DAO_Spool {
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
* @param string $body The full text of the message body, including any
* Mime parts, etc.
*
- * @param null $job_id
+ * @param int $job_id
*
* @internal param mixed $recipients Either a comma-seperated list of recipients
* (RFC822 compliant), or an array of recipients,
class CRM_Mailing_BAO_TrackableURL extends CRM_Mailing_DAO_TrackableURL {
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
/**
* @param $msg
- * @param $mailing_id
- * @param $queue_id
+ * @param int $mailing_id
+ * @param int $queue_id
* @param bool $onlyHrefs
*/
public static function scan_and_replace(&$msg, $mailing_id, $queue_id, $onlyHrefs = FALSE) {
class CRM_Mailing_Controller_Send extends CRM_Core_Controller {
/**
- * class constructor
+ * Class constructor
*/
function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) {
parent::__construct($title, $modal, NULL, FALSE, TRUE);
class CRM_Mailing_Event_BAO_Bounce extends CRM_Mailing_Event_DAO_Bounce {
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
class CRM_Mailing_Event_BAO_Confirm extends CRM_Mailing_Event_DAO_Confirm {
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
class CRM_Mailing_Event_BAO_Delivered extends CRM_Mailing_Event_DAO_Delivered {
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
class CRM_Mailing_Event_BAO_Forward extends CRM_Mailing_Event_DAO_Forward {
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
class CRM_Mailing_Event_BAO_Opened extends CRM_Mailing_Event_DAO_Opened {
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
* @param int $rowCount Number of rows
* @param array $sort sort array
*
- * @param null $contact_id
+ * @param int $contact_id
*
* @return array Result set
* @access public
class CRM_Mailing_Event_BAO_Queue extends CRM_Mailing_Event_DAO_Queue {
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
}
/**
- * @param $queueID
+ * @param int $queueID
*
* @return array
*/
class CRM_Mailing_Event_BAO_Reply extends CRM_Mailing_Event_DAO_Reply {
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
class CRM_Mailing_Event_BAO_Subscribe extends CRM_Mailing_Event_DAO_Subscribe {
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
}
/**
- * send subscribe mail
+ * Send subscribe mail
*
* @param array $groups the list of group ids for subscribe
* @param array $params the list of email
class CRM_Mailing_Event_BAO_TrackableURLOpen extends CRM_Mailing_Event_DAO_TrackableURLOpen {
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
class CRM_Mailing_Event_BAO_Unsubscribe extends CRM_Mailing_Event_DAO_Unsubscribe {
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
}
/**
- * @param $queueID
+ * @param int $queueID
*
* @return array
*/
}
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
}
/**
- * validation
+ * Validation
*
* @param array $params (ref.) an assoc array of name/value pairs
*
class CRM_Mailing_Form_Group extends CRM_Contact_Form_Task {
/**
- * the mailing ID of the mailing if we are resuming a mailing
+ * The mailing ID of the mailing if we are resuming a mailing
*
* @var integer
*/
protected $_mailingID;
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $fields posted values of the form
*
class CRM_Mailing_Form_Schedule extends CRM_Core_Form {
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
class CRM_Mailing_Form_Settings extends CRM_Core_Form {
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
class CRM_Mailing_Form_Task extends CRM_Core_Form {
/**
- * the task being performed
+ * The task being performed
*
* @var int
*/
protected $_componentIds;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @param
*
}
/**
- * simple shell that derived classes can call to add buttons to
+ * Simple shell that derived classes can call to add buttons to
* the form with a customized title for the main Submit
*
* @param string $title title of the main button
class CRM_Mailing_Form_Task_Print extends CRM_Mailing_Form_Task {
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
class CRM_Mailing_Form_Test extends CRM_Core_Form {
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
}
/**
- * validation
+ * Validation
*
* @param array $params (ref.) an assoc array of name/value pairs
*
class CRM_Mailing_Page_AJAX {
/**
- * fetch the template text/html messages
+ * Fetch the template text/html messages
*/
public static function template() {
$templateId = CRM_Utils_Type::escape($_POST['tid'], 'Integer');
}
/**
- * retrieve contact mailings
+ * Retrieve contact mailings
*/
public static function getContactMailings() {
$contactID = CRM_Utils_Type::escape($_GET['contact_id'], 'Integer');
class CRM_Mailing_Page_Browse extends CRM_Core_Page {
/**
- * all the fields that are listings related
+ * All the fields that are listings related
*
* @var array
* @access protected
protected $_fields;
/**
- * the mailing id of the mailing we're operating on
+ * The mailing id of the mailing we're operating on
*
* @int
* @access protected
protected $_mailingId;
/**
- * the action that we are performing (in CRM_Core_Action terms)
+ * The action that we are performing (in CRM_Core_Action terms)
*
* @int
* @access protected
public $_archived;
/**
- * scheduled mailing
+ * Scheduled mailing
*
* @boolean
* @access public
}
/**
- * run this page (figure out the action needed and perform it).
+ * Run this page (figure out the action needed and perform it).
*
* @return void
*/
class CRM_Mailing_Page_Event extends CRM_Core_Page {
/**
- * all the fields that are listings related
+ * All the fields that are listings related
*
* @var array
* @access protected
protected $_fields;
/**
- * run this page (figure out the action needed and perform it).
+ * Run this page (figure out the action needed and perform it).
*
* @return void
*/
class CRM_Mailing_Page_Preview extends CRM_Core_Page {
/**
- * run this page (figure out the action needed and perform it).
+ * Run this page (figure out the action needed and perform it).
*
* @return void
*/
}
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * run this page (figure out the action needed and perform it).
+ * Run this page (figure out the action needed and perform it).
*
- * @param null $id
- * @param null $contactID
+ * @param int $id
+ * @param int $contactID
* @param bool $print
* @param bool $allowID
*
class CRM_Mailing_PseudoConstant extends CRM_Core_PseudoConstant {
/**
- * mailing templates
+ * Mailing templates
* @var array
* @static
*/
private static $template;
/**
- * completed mailings
+ * Completed mailings
* @var array
* @static
*/
private static $completed;
/**
- * mailing components
+ * Mailing components
* @var array
* @static
*/
private static $component;
/**
- * default component id's, indexed by component type
+ * Default component id's, indexed by component type
*/
private static $defaultComponent;
class CRM_Mailing_Selector_Browse extends CRM_Core_Selector_Base implements CRM_Core_Selector_API {
/**
- * array of supported links, currenly null
+ * Array of supported links, currenly null
*
* @var array
* @static
static $_links = NULL;
/**
- * we use desc to remind us what that column is, name is used in the tpl
+ * We use desc to remind us what that column is, name is used in the tpl
*
* @var array
* @static
}
/**
- * getter for array of the parameters required for creating pager.
+ * Getter for array of the parameters required for creating pager.
*
* @param $action
* @param array $params
}
/**
- * returns the column headers as an array of tuples:
+ * Returns the column headers as an array of tuples:
* (name, sortName (key to the sort array))
*
* @param string $action the action being performed
}
/**
- * returns all the rows in the given offset and rowCount
+ * Returns all the rows in the given offset and rowCount
*
* @param enum $action the action being performed
* @param int $offset the row number to start from
}
/**
- * name of export file.
+ * Name of export file.
*
* @param string $output type of output
*
class CRM_Mailing_Selector_Event extends CRM_Core_Selector_Base implements CRM_Core_Selector_API {
/**
- * array of supported links, currenly null
+ * Array of supported links, currenly null
*
* @var array
* @static
static $_links = NULL;
/**
- * what event type are we browsing?
+ * What event type are we browsing?
*/
private $_event;
/**
- * should we only count distinct contacts?
+ * Should we only count distinct contacts?
*/
private $_is_distinct;
/**
- * which mailing are we browsing events from?
+ * Which mailing are we browsing events from?
*/
private $_mailing_id;
/**
- * do we want events tied to a specific job?
+ * Do we want events tied to a specific job?
*/
private $_job_id;
/**
- * for click-through events, do we only want those from a specific url?
+ * For click-through events, do we only want those from a specific url?
*/
private $_url_id;
/**
- * we use desc to remind us what that column is, name is used in the tpl
+ * We use desc to remind us what that column is, name is used in the tpl
*
* @var array
*/
}
/**
- * getter for array of the parameters required for creating pager.
+ * Getter for array of the parameters required for creating pager.
*
* @param $action
* @param array $params
}
/**
- * returns the column headers as an array of tuples:
+ * Returns the column headers as an array of tuples:
* (name, sortName (key to the sort array))
*
* @param string $action the action being performed
}
/**
- * returns all the rows in the given offset and rowCount
+ * Returns all the rows in the given offset and rowCount
*
* @param enum $action the action being performed
* @param int $offset the row number to start from
}
/**
- * name of export file.
+ * Name of export file.
*
* @param string $output type of output
*
static $_links = NULL;
/**
- * we use desc to remind us what that column is, name is used in the tpl
+ * We use desc to remind us what that column is, name is used in the tpl
*
* @var array
* @static
);
/**
- * are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact
*
* @access protected
* @var boolean
protected $_single = FALSE;
/**
- * are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact
*
* @access protected
* @var boolean
protected $_limit = NULL;
/**
- * what context are we being invoked from
+ * What context are we being invoked from
*
* @access protected
* @var string
protected $_context = NULL;
/**
- * what component context are we being invoked from
+ * What component context are we being invoked from
*
* @access protected
* @var string
protected $_compContext = NULL;
/**
- * queryParams is the array returned by exportValues called on
+ * QueryParams is the array returned by exportValues called on
* the HTML_QuickForm_Controller for that page.
*
* @var array
public $_queryParams;
/**
- * represent the type of selector
+ * Represent the type of selector
*
* @var int
* @access protected
}
/**
- * getter for array of the parameters required for creating pager.
+ * Getter for array of the parameters required for creating pager.
*
* @param $action
* @param array $params
}
/**
- * returns all the rows in the given offset and rowCount
+ * Returns all the rows in the given offset and rowCount
*
* @param enum $action the action being performed
* @param int $offset the row number to start from
}
/**
- * returns the column headers as an array of tuples:
+ * Returns the column headers as an array of tuples:
* (name, sortName (key to the sort array))
*
* @param string $action the action being performed
}
/**
- * name of export file.
+ * Name of export file.
*
* @param string $output type of output
*
class CRM_Mailing_StateMachine_Send extends CRM_Core_StateMachine {
/**
- * class constructor
+ * Class constructor
*
* @param CRM_Mailing_Controller $controller
* @param \const|int $action
*/
class CRM_Mailing_Task {
/**
- * the task array
+ * The task array
*
* @var array
* @static
static $_tasks = NULL;
/**
- * the optional task array
+ * The optional task array
*
* @var array
* @static
}
/**
- * show tasks selectively based on the permission level
+ * Show tasks selectively based on the permission level
* of the user
*
* @param int $permission
class CRM_Member_BAO_Membership extends CRM_Member_DAO_Membership {
/**
- * static field for all the membership information that we can potentially import
+ * Static field for all the membership information that we can potentially import
*
* @var array
* @static
static $_signupActType = NULL;
/**
- * class constructor
+ * Class constructor
*
* @access public
* @return \CRM_Member_DAO_Membership
}
/**
- * takes an associative array and creates a membership object
+ * Takes an associative array and creates a membership object
*
* the function extracts all the params it needs to initialize the created
* membership object. The params array could contain additional unused name/value
}
/**
- * takes an associative array and creates a membership object
+ * Takes an associative array and creates a membership object
*
* @param array $params (reference ) an assoc array of name/value pairs
* @param array $ids the array that holds all the db ids
}
/**
- * check the membership extended through relationship
+ * Check the membership extended through relationship
*
* @param int $membershipId membership id
* @param int $contactId contact id
}
/**
- * delete membership.
+ * Delete membership.
* Wrapper for most delete calls. Use this unless you JUST want to delete related memberships w/o deleting the parent.
*
* @param int $membershipId membership id that needs to be deleted
}
/**
- * delete membership.
+ * Delete membership.
*
* @param int $membershipId membership id that needs to be deleted
*
}
/**
- * Function to delete related memberships
+ * Delete related memberships
*
* @param int $ownerMembershipId
* @param int $contactId
}
/**
- * Function to obtain active/inactive memberships from the list of memberships passed to it.
+ * Obtain active/inactive memberships from the list of memberships passed to it.
*
* @param array $memberships membership records
* @param string $status active or inactive
}
/**
- * Function to build Membership Block in Contribution Pages
+ * Build Membership Block in Contribution Pages
*
* @param CRM_Core_Form $form form object
* @param int $pageID - unused?
}
/**
- * Function to return Membership Block info in Contribution Pages
+ * Return Membership Block info in Contribution Pages
*
* @param int $pageID contribution page id
*
}
/**
- * Function to return a current membership of given contact
+ * Return a current membership of given contact
* NB: if more than one membership meets criteria, a randomly selected one is returned.
*
* @param int $contactID contact id
}
/**
- * function to get all exportable fields
+ * Get all exportable fields
*
* @retun array return array of all exportable fields
* @static
}
/**
- * Function to get membership joins/renewals for a specified membership
+ * Get membership joins/renewals for a specified membership
* type. Specifically, retrieves a count of memberships whose "Membership
* Signup" or "Membership Renewal" activity falls in the given date range.
* Dates match the pattern "yyyy-mm-dd".
}
/**
- * Function to get a count of membership for a specified membership type,
+ * Get a count of membership for a specified membership type,
* optionally for a specified date. The date must have the form yyyy-mm-dd.
*
* If $date is omitted, this function counts as a member anyone whose
* @param int $contactID contact id
* @param CRM_Contribute_Form_Contribution_Confirm $form Confirmation form object
*
- * @param $premiumParams
+ * @param array $premiumParams
* @param null $customFieldsFormatted
* @param null $includeFieldTypes
*
*
* @param $isProcessSeparateMembershipTransaction
*
- * @param $defaultContributionTypeID
+ * @param int $defaultContributionTypeID
* @param array $membershipLineItems Line items specific to membership payment that is separate to contribution
* @throws CRM_Core_Exception
*
}
/**
- * Function to get the contribution page id from the membership record
+ * Get the contribution page id from the membership record
*
* @param int membershipId membership id
*
}
/**
- * Function to updated related memberships
+ * Updated related memberships
*
* @param int $ownerMembershipId owner Membership Id
* @param array $params formatted array of key => value..
}
/**
- * Function to get list of membership fields for profile
+ * Get list of membership fields for profile
* For now we only allow custom membership fields to be in
* profile
*
}
/**
- * function to get the sort name of a contact for a particular membership
+ * Get the sort name of a contact for a particular membership
*
* @param int $id id of the membership
*
}
/**
- * function to create memberships for related contacts
+ * Create memberships for related contacts
* takes into account the maximum related memberships
*
* @param array $params array of key - value pairs
/**
* @param CRM_Core_Form $form
- * @param null $membershipTypeID
+ * @param int $membershipTypeID
*
* @return array
*/
}
/**
- * Function to get membership record count for a Contact
+ * Get membership record count for a Contact
*
* @param int $contactID
* @param boolean $activeOnly
}
/**
- * Function to check whether payment processor supports
+ * Check whether payment processor supports
* cancellation of membership subscription
*
* @param int $mid membership id
}
/**
- * Function to check whether subscription is already cancelled
+ * Check whether subscription is already cancelled
*
* @param int $mid membership id
*
}
/**
- * Function to get membership joins for a specified membership
+ * Get membership joins for a specified membership
* type. Specifically, retrieves a count of still current memberships whose
* join_date and start_date are within a specified date range. Dates match
* the pattern "yyyy-mm-dd".
}
/**
- * Function to get membership renewals for a specified membership
+ * Get membership renewals for a specified membership
* type. Specifically, retrieves a count of still current memberships
* whose join_date is before and start_date is within a specified date
* range. Dates match the pattern "yyyy-mm-dd".
/**
* Where a second separate financial transaction is supported we will process it here
*
- * @param $contactID
+ * @param int $contactID
* @param CRM_Contribute_Form_Contribution_Confirm $form
- * @param $tempParams
+ * @param array $tempParams
* @param $isTest
- * @param $lineItems
+ * @param array $lineItems
* @param $minimumFee
- * @param $financialTypeID
+ * @param int $financialTypeID
*
* @throws CRM_Core_Exception
* @throws Exception
}
/**
- * @param $membershipParams
- * @param $contactID
+ * @param array $membershipParams
+ * @param int $contactID
* @param $customFieldsFormatted
- * @param $membershipID
+ * @param int $membershipID
* @param $memType
* @param $isTest
* @param $numTerms
/**
* @param integer $contactID
- * @param $membershipTypeID
+ * @param int $membershipTypeID
* @param bool $is_test
* @param $changeToday
* @param integer $modifiedID
* @param $customFieldsFormatted
* @param $numRenewTerms
- * @param $membershipID
+ * @param int $membershipID
* @param $pending
* @param $allStatus
* @param array $membershipTypeDetails
}
/**
- * Function to process price set and line items.
+ * Process price set and line items.
*
* @access public
*
- * @param $membershipId
+ * @param int $membershipId
* @param $lineItem
*
* @return void
}
/**
- * retrieve the contribution id for the associated Membership id
+ * Retrieve the contribution id for the associated Membership id
* @todo we should get this off the line item
*
* @param int $membershipId membership id.
* The function returns the membershiptypes for a particular contact
* who has lifetime membership without end date.
*
- * @param $contactID
+ * @param int $contactID
* @param bool $isTest
* @param bool $onlyLifeTime
*
}
/**
- * Function to record contribution record associated with membership
+ * Record contribution record associated with membership
*
* @param array $params array of submitted params
* @param array $ids (param in process of being removed - try to use params) array of ids
}
/**
- * Function to record line items for default membership
+ * Record line items for default membership
*
* @param CRM_Core_Form $qf
* @param array $membershipType array with membership type and organization
*/
class CRM_Member_BAO_MembershipBlock extends CRM_Member_DAO_MembershipBlock {
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
}
/**
- * add the membership Blocks
+ * Add the membership Blocks
*
* @param array $params reference array contains the values submitted by the form
*
}
/**
- * delete membership Blocks
+ * Delete membership Blocks
*
* @param int $id
*
class CRM_Member_BAO_MembershipLog extends CRM_Member_DAO_MembershipLog {
/**
- * add the membership log record
+ * Add the membership log record
*
* @param array $params reference array contains the values submitted by the form
* @param array $ids reference array contains the id
}
/**
- * delete membership log record
+ * Delete membership log record
*
* @param int $membershipID
*
}
/**
- * @param $contactID
+ * @param int $contactID
*/
static function resetModifiedID($contactID) {
$query = "
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
}
/**
- * add the membership Payments
+ * Add the membership Payments
*
* @param array $params reference array contains the values submitted by the form
*
}
/**
- * delete membership Payments
+ * Delete membership Payments
*
* @param int $id
*
class CRM_Member_BAO_MembershipStatus extends CRM_Member_DAO_MembershipStatus {
/**
- * static holder for the default LT
+ * Static holder for the default LT
*/
static $_defaultMembershipStatus = NULL;
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
}
/**
- * update the is_active flag in the db
+ * 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
return $membershipStatusBAO;
}
/**
- * add the membership types
+ * Add the membership types
*
* @param array $params reference array contains the values submitted by the form
* @param array $ids array contains the id - this param is deprecated
}
/**
- * get membership status
+ * Get membership status
*
* @param int $membershipStatusId
*
}
/**
- * delete membership Types
+ * Delete membership Types
*
* @param int $membershipStatusId
*
}
/**
- * Function to find the membership status based on start date, end date, join date & status date.
+ * Find the membership status based on start date, end date, join date & status date.
*
* @param string $startDate start date of the member whose membership status is to be calculated.
* @param string $endDate end date of the member whose membership status is to be calculated.
class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType {
/**
- * static holder for the default LT
+ * Static holder for the default LT
*/
static $_defaultMembershipType = NULL;
static $_membershipTypeInfo = array();
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
}
/**
- * update the is_active flag in the db
+ * 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
}
/**
- * add the membership types
+ * Add the membership types
*
* @param array $params reference array contains the values submitted by the form
* @param array $ids array contains the id (deprecated)
}
/**
- * delete membership Types
+ * Delete membership Types
*
* @param int $membershipTypeId
*
}
/**
- * convert membership Type's 'start day' & 'rollover day' to human readable formats.
+ * Convert membership Type's 'start day' & 'rollover day' to human readable formats.
*
* @param array $membershipType an array of membershipType-details.
* @static
}
/**
- * Function to get membership Types
+ * Get membership Types
*
* @param bool $public
*
}
/**
- * Function to get membership Type Details
+ * Get membership Type Details
*
* @param int $membershipTypeId
*
}
/**
- * Function to calculate start date and end date for new membership
+ * Calculate start date and end date for new membership
*
* @param int $membershipTypeId membership type id
* @param date $joinDate member since ( in mysql date format )
}
/**
- * Function to calculate start date and end date for renewal membership
+ * Calculate start date and end date for renewal membership
*
* @param int $membershipId
* @param $changeToday
}
/**
- * Function to retrieve all Membership Types associated
+ * Retrieve all Membership Types associated
* with an Organization
*
* @param int $orgID Id of Organization
}
/**
- * Function to retrieve all Membership Types with Member of Contact id
+ * Retrieve all Membership Types with Member of Contact id
*
* @param array membership types
*
/**
* @param array $params
- * @param $previousID
- * @param $membershipTypeId
+ * @param int $previousID
+ * @param int $membershipTypeId
*/
public static function createMembershipPriceField($params, $previousID, $membershipTypeId) {
}
/**
- * if membership are involved, add the specific membership fields
+ * If membership are involved, add the specific membership fields
*
* @param $query
*
}
/**
- * @param $name
+ * @param string $name
* @param $mode
* @param $side
*
/**
* @param $row
- * @param $id
+ * @param int $id
*/
static function searchAction(&$row, $id) {}
class CRM_Member_Controller_Search extends CRM_Core_Controller {
/**
- * class constructor
+ * Class constructor
*/
function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) {
}
/**
- * extract values from the contact create boxes on the form and assign appropriately to
+ * Extract values from the contact create boxes on the form and assign appropriately to
*
* - $this->_contributorEmail,
* - $this->_memberEmail &
}
/**
- * validation
+ * Validation
*
* @param array $params (ref.) an assoc array of name/value pairs
*
}
/**
- * send email receipt
+ * Send email receipt
*
* @param CRM_Core_Form $form form object
* @param array $formValues
class CRM_Member_Form_MembershipBlock extends CRM_Contribute_Form_ContributionPage {
/**
- * store membership price set id
+ * Store membership price set id
*/
protected $_memPriceSetId = NULL;
}
/**
- * validation
+ * Validation
*
* @param array $params (ref.) an assoc array of name/value pairs
*
* @param $files
- * @param null $contributionPageId
+ * @param int $contributionPageId
*
* @return mixed true or array of errors
* @access public
}
/**
- * validation
+ * Validation
*
* @param array $params (ref.) an assoc array of name/value pairs
*
}
/**
- * process the renewal form
+ * Process the renewal form
*
* @access public
*
class CRM_Member_Form_MembershipType extends CRM_Member_Form_MembershipConfig {
/**
- * max number of contacts we will display for membership-organisation
+ * Max number of contacts we will display for membership-organisation
*/
CONST MAX_CONTACTS = 50;
}
/**
- * validation
+ * Validation
*
* @param array $params (ref.) an assoc array of name/value pairs
*
}
/**
- * @param $previousID
- * @param $priceSetId
- * @param $membershipTypeId
+ * @param int $previousID
+ * @param int $priceSetId
+ * @param int $membershipTypeId
* @param $optionsIds
*/
public static function checkPreviousPriceField($previousID, $priceSetId, $membershipTypeId, &$optionsIds) {
}
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
class CRM_Member_Form_Search extends CRM_Core_Form_Search {
/**
- * the params that are sent to the query
+ * The params that are sent to the query
*
* @var array
* @access protected
protected $_queryParams;
/**
- * are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact
*
* @access protected
* @var boolean
protected $_single = FALSE;
/**
- * are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact
*
* @access protected
* @var boolean
protected $_defaults;
/**
- * prefix for the controller
+ * Prefix for the controller
*
*/
protected $_prefix = "member_";
/**
- * processing needed for buildForm and later
+ * Processing needed for buildForm and later
*
* @return void
* @access public
class CRM_Member_Form_Task extends CRM_Core_Form {
/**
- * the task being performed
+ * The task being performed
*
* @var int
*/
protected $_memberIds;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @param
*
}
/**
- * simple shell that derived classes can call to add buttons to
+ * Simple shell that derived classes can call to add buttons to
* the form with a customized title for the main Submit
*
* @param string $title title of the main button
class CRM_Member_Form_Task_Batch extends CRM_Member_Form_Task {
/**
- * the title of the group
+ * The title of the group
*
* @var string
*/
protected $_title;
/**
- * maximum profile fields that will be displayed
+ * Maximum profile fields that will be displayed
*
*/
protected $_maxFields = 9;
/**
- * variable to store redirect path
+ * Variable to store redirect path
*
*/
protected $_userContext;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
protected $_single = FALSE;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
public $_noEmails = FALSE;
/**
- * all the existing templates in the system
+ * All the existing templates in the system
*
* @var array
*/
public $_templates = NULL;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
class CRM_Member_Form_Task_Label extends CRM_Member_Form_Task {
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
class CRM_Member_Form_Task_PDFLetter extends CRM_Member_Form_Task {
/**
- * all the existing templates in the system
+ * All the existing templates in the system
*
* @var array
*/
public $_cid = NULL;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
}
/**
- * list available tokens, at time of writing these were
+ * List available tokens, at time of writing these were
* {membership.id} => Membership ID
* {membership.status} => Membership Status
* {membership.type} => Membership Type
class CRM_Member_Form_Task_PDFLetterCommon extends CRM_Contact_Form_Task_PDFLetterCommon {
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
* @todo this is horrible copy & paste code because there is so much risk of breakage
* in fixing the existing pdfLetter classes to be suitably generic
* @access public
}
/**
- * generate htmlfor pdf letters
+ * Generate htmlfor pdf letters
*
* @param array $membershipIDs
* @param array $returnProperties
class CRM_Member_Form_Task_PickProfile extends CRM_Member_Form_Task {
/**
- * the title of the group
+ * The title of the group
*
* @var string
*/
protected $_title;
/**
- * maximum members that should be allowed to update
+ * Maximum members that should be allowed to update
*
*/
protected $_maxMembers = 100;
/**
- * variable to store redirect path
+ * Variable to store redirect path
*
*/
protected $_userContext;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $fields posted values of the form
*
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
class CRM_Member_Form_Task_Print extends CRM_Member_Form_Task {
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
class CRM_Member_Form_Task_Result extends CRM_Member_Form_Task {
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
class CRM_Member_Form_Task_SearchTaskHookSample extends CRM_Member_Form_Task {
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
class CRM_Member_Import_Controller extends CRM_Core_Controller {
/**
- * class constructor
+ * Class constructor
*/
function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) {
parent::__construct($title, $modal);
*/
/**
- * name of the field
+ * Name of the field
*/
public $_name;
/**
- * title of the field to be used in display
+ * Title of the field to be used in display
*/
public $_title;
/**
- * type of field
+ * Type of field
* @var enum
*/
public $_type;
/**
- * is this field required
+ * Is this field required
* @var boolean
*/
public $_required;
/**
- * data to be carried for use by a derived class
+ * Data to be carried for use by a derived class
* @var object
*/
public $_payload;
/**
- * regexp to match the CSV header of this column/field
+ * Regexp to match the CSV header of this column/field
* @var string
*/
public $_headerPattern;
/**
- * regexp to match the pattern of data from various column/fields
+ * Regexp to match the pattern of data from various column/fields
* @var string
*/
public $_dataPattern;
/**
- * value of this field
+ * Value of this field
* @var object
*/
public $_value;
/**
- * @param $name
+ * @param string $name
* @param $title
* @param int $type
* @param string $headerPattern
}
/**
- * the value is in string format. convert the value to the type of this field
+ * The value is in string format. convert the value to the type of this field
* and set the field value with the appropriate type
*/
function setValue($value) {
class CRM_Member_Import_Form_DataSource extends CRM_Core_Form {
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
/**
- * to store contactType
+ * To store contactType
*
* @var int
* @static
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $fields posted values of the form
*
class CRM_Member_Import_Form_Preview extends CRM_Import_Form_Preview {
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
class CRM_Member_Import_Form_Summary extends CRM_Import_Form_Summary {
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
*/
/**
- * imported file size
+ * Imported file size
*/
protected $_fileSize;
/**
- * seperator being used
+ * Seperator being used
*/
protected $_seperator;
/**
- * total number of lines in file
+ * Total number of lines in file
*/
protected $_lineCount;
/**
- * whether the file has a column header or not
+ * Whether the file has a column header or not
*
* @var boolean
*/
protected $_haveColumnHeader;
/**
- * @param $fileName
+ * @param string $fileName
* @param string $seperator
* @param $mapper
* @param bool $skipColumnHeader
}
/**
- * format the field values for input to the api
+ * Format the field values for input to the api
*
* @return array (reference ) associative array of name/value pairs
* @access public
}
/**
- * @param $name
+ * @param string $name
* @param $title
* @param int $type
* @param string $headerPattern
protected $_newMemberships;
/**
- * class constructor
+ * Class constructor
*/
function __construct(&$mapperKeys, $mapperLocType = NULL, $mapperPhoneType = NULL) {
parent::__construct();
}
/**
- * the initializer code, called before the processing
+ * The initializer code, called before the processing
*
* @return void
* @access public
}
/**
- * handle the values in mapField mode
+ * Handle the values in mapField mode
*
* @param array $values the array of values belonging to this line
*
}
/**
- * handle the values in preview mode
+ * Handle the values in preview mode
*
* @param array $values the array of values belonging to this line
*
}
/**
- * handle the values in summary mode
+ * Handle the values in summary mode
*
* @param array $values the array of values belonging to this line
*
}
/**
- * handle the values in import mode
+ * Handle the values in import mode
*
* @param int $onDuplicate the code for what action to take on duplicates
* @param array $values the array of values belonging to this line
}
/**
- * the initializer code, called before the processing
+ * The initializer code, called before the processing
*
* @return void
* @access public
class CRM_Member_Page_AJAX {
/**
- * setDefaults according to membership type
+ * SetDefaults according to membership type
*/
static function getMemberTypeDefaults() {
if (!$_POST['mtype']) {
/**
* @param CRM_Core_Form $form
- * @param null $contactId
+ * @param int $contactId
*/
public static function setContext(&$form, $contactId = NULL) {
$context = CRM_Utils_Request::retrieve('context', 'String', $form, FALSE, 'search' );
}
/**
- * define action links for membership types of related organization
+ * Define action links for membership types of related organization
*
* @return array self::$_membershipTypesLinks array of action links
* @access public
class CRM_Member_Page_UserDashboard extends CRM_Contact_Page_View_UserDashBoard {
/**
- * list memberships for the UF user
+ * List memberships for the UF user
*
* return null
* @access public
class CRM_Member_PseudoConstant extends CRM_Core_PseudoConstant {
/**
- * membership types
+ * Membership types
* @var array
* @static
*/
private static $membershipType;
/**
- * membership types
+ * Membership types
* @var array
* @static
*/
*
* @access public
*
- * @param null $id
+ * @param int $id
* @param bool $force
*
* @return array - array reference of all membership types if any
*
* @access public
*
- * @param null $id
+ * @param int $id
* @param null $cond
* @param string $column
* @param bool $force
static $_links = NULL;
/**
- * we use desc to remind us what that column is, name is used in the tpl
+ * We use desc to remind us what that column is, name is used in the tpl
*
* @var array
* @static
);
/**
- * are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact
*
* @access protected
* @var boolean
protected $_single = FALSE;
/**
- * are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact
*
* @access protected
* @var boolean
protected $_limit = NULL;
/**
- * what context are we being invoked from
+ * What context are we being invoked from
*
* @access protected
* @var string
protected $_context = NULL;
/**
- * queryParams is the array returned by exportValues called on
+ * QueryParams is the array returned by exportValues called on
* the HTML_QuickForm_Controller for that page.
*
* @var array
public $_queryParams;
/**
- * represent the type of selector
+ * Represent the type of selector
*
* @var int
* @access protected
}
/**
- * getter for array of the parameters required for creating pager.
+ * Getter for array of the parameters required for creating pager.
*
* @param $action
* @param array $params
}
/**
- * returns all the rows in the given offset and rowCount
+ * Returns all the rows in the given offset and rowCount
*
* @param enum $action the action being performed
* @param int $offset the row number to start from
}
/**
- * returns the column headers as an array of tuples:
+ * Returns the column headers as an array of tuples:
* (name, sortName (key to the sort array))
*
* @param string $action the action being performed
}
/**
- * name of export file.
+ * Name of export file.
*
* @param string $output type of output
*
protected $_task;
/**
- * class constructor
+ * Class constructor
*/ function __construct($controller, $action = CRM_Core_Action::NONE) {
parent::__construct($controller, $action);
}
/**
- * return the form name of the task
+ * Return the form name of the task
*
* @return string
* @access public
CONST DELETE_MEMBERS = 1, PRINT_MEMBERS = 2, EXPORT_MEMBERS = 3, EMAIL_CONTACTS = 4, BATCH_MEMBERS = 5;
/**
- * the task array
+ * The task array
*
* @var array
* @static
static $_tasks = NULL;
/**
- * the optional task array
+ * The optional task array
*
* @var array
* @static
}
/**
- * show tasks selectively based on the permission level
+ * Show tasks selectively based on the permission level
* of the user
*
* @param int $permission
}
/**
- * add or update either a Personal Campaign Page OR a PCP Block
+ * Add or update either a Personal Campaign Page OR a PCP Block
*
* @param array $params reference array contains the values submitted by the form
* @param bool $pcpBlock if true, create or update PCPBlock, else PCP
}
/**
- * get the Display name of a contact for a PCP
+ * Get the Display name of a contact for a PCP
*
* @param int $id id for the PCP
*
}
/**
- * return PCP Block info for dashboard
+ * Return PCP Block info for dashboard
*
- * @param $contactId
+ * @param int $contactId
*
* @return array array of Pcp if found
* @access public
}
/**
- * function to show the total amount for Personal Campaign Page on thermometer
+ * Show the total amount for Personal Campaign Page on thermometer
*
* @param array $pcpId contains the pcp ID
*
}
/**
- * function to show the amount, nickname on honor roll
+ * Show the amount, nickname on honor roll
*
* @param array $pcpId contains the pcp ID
*
}
/**
- * Function to Delete the campaign page
+ * Delete the campaign page
*
* @param int $id campaign page id
*
* Process a PCP contribution/
*/
/**
- * @param $pcpId
+ * @param int $pcpId
* @param $component
* @param $entity
*
}
/**
- * Function to Approve / Reject the campaign page
+ * Approve / Reject the campaign page
*
* @param int $id campaign page id
*
}
/**
- * Function to send notfication email to supporter
+ * Send notfication email to supporter
* 1. when their PCP status is changed by site admin.
* 2. when supporter initially creates a Personal Campaign Page ($isInitial set to true).
*
}
/**
- * Function to Enable / Disable the campaign page
+ * Enable / Disable the campaign page
*
* @param int $id campaign page id
*
}
/**
- * Function to get pcp block is active
+ * Get pcp block is active
*
* @param int $pcpId
* @param $component
}
/**
- * Function to get pcp block is enabled for component page
+ * Get pcp block is enabled for component page
*
* @param int $pageId
* @param $component
}
/**
- * Function to find out if the PCP block is in use by one or more PCP page
+ * Find out if the PCP block is in use by one or more PCP page
*
* @param int $id pcp block id
*
}
/**
- * Function to get email is enabled for supporter's profile
+ * Get email is enabled for supporter's profile
*
* @param int $profileId supporter's profile id
*
}
/**
- * Function to obtain the title of page associated with a pcp
+ * Obtain the title of page associated with a pcp
*
* @param int $pcpId
* @param $component
}
/**
- * Function to get pcp block & entity id given pcp id
+ * Get pcp block & entity id given pcp id
*
* @param int $pcpId
* @param $component
}
/**
- * Function to get pcp entity table given a component.
+ * Get pcp entity table given a component.
*
* @param $component
*
}
/**
- * Function to get supporter profile id
+ * Get supporter profile id
*
* @param int $component_id
* @param string $component
class CRM_PCP_Controller_PCP extends CRM_Core_Controller {
/**
- * class constructor
+ * Class constructor
*/
function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) {
}
/**
- * global form rule
+ * Global form rule
*
* @param array $fields the input form values
* @param array $files the uploaded files if any
class CRM_PCP_Form_Contribute extends CRM_Contribute_Form_ContributionPage {
/**
- * the type of pcp component.
+ * The type of pcp component.
*
* @var int
* @protected
}
/**
- * validation
+ * Validation
*
* @param array $params (ref.) an assoc array of name/value pairs
*
class CRM_PCP_Form_Event extends CRM_Event_Form_ManageEvent {
/**
- * the type of pcp component.
+ * The type of pcp component.
*
* @var int
* @protected
}
/**
- * validation
+ * Validation
*
* @param array $params (ref.) an assoc array of name/value pairs
*
public $_context;
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @param null
*
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $fields posted values of the form
*
public $_component = NULL;
/**
- * are we in single form mode or wizard mode?
+ * Are we in single form mode or wizard mode?
*
* @var boolean
* @access protected
public $_single;
/**
- * the default values for the form
+ * The default values for the form
*
* @var array
* @protected
}
/**
- * global form rule
+ * Global form rule
*
* @param array $fields the input form values
* @param array $files the uploaded files if any
//@TODO this function changed, debug this at runtime
/**
* @param $whereClause
- * @param $whereParams
+ * @param array $whereParams
*/
function pagerAtoZ($whereClause, $whereParams) {
$where = '';
class CRM_PCP_StateMachine_PCP extends CRM_Core_StateMachine {
/**
- * class constructor
+ * Class constructor
*
* @param object $controller
* @param \const|int $action
class CRM_Pledge_BAO_Pledge extends CRM_Pledge_DAO_Pledge {
/**
- * static field for all the pledge information that we can potentially export
+ * Static field for all the pledge information that we can potentially export
*
* @var array
* @static
static $_exportableFields = NULL;
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
}
/**
- * add pledge
+ * Add pledge
*
* @param array $params reference array contains the values submitted by the form
*
}
/**
- * takes an associative array and creates a pledge object
+ * Takes an associative array and creates a pledge object
*
* @param array $params (reference ) an assoc array of name/value pairs
*
}
/**
- * delete the pledge
+ * Delete the pledge
*
* @param int $id pledge id
*
}
/**
- * get the amount details date wise.
+ * Get the amount details date wise.
*
* @param string $status
* @param string $startDate
}
/**
- * Function to get list of pledges In Honor of contact Ids
+ * Get list of pledges In Honor of contact Ids
*
* @param int $honorId In Honor of Contact ID
*
}
/**
- * Function to send Acknowledgment and create activity.
+ * Send Acknowledgment and create activity.
*
* @param CRM_Core_Form $form form object.
* @param array $params an assoc array of name/value pairs.
}
/**
- * combine all the exportable fields from the lower levels object
+ * Combine all the exportable fields from the lower levels object
*
* @return array array of exportable Fields
* @access public
}
/**
- * Function to get pending or in progress pledges
+ * Get pending or in progress pledges
*
* @param int $contactID contact id
*
}
/**
- * Function to get pledge record count for a Contact
+ * Get pledge record count for a Contact
*
- * @param $contactID
+ * @param int $contactID
*
* @return int count of pledge records
* @access public
class CRM_Pledge_BAO_PledgeBlock extends CRM_Pledge_DAO_PledgeBlock {
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
}
/**
- * takes an associative array and creates a pledgeBlock object
+ * Takes an associative array and creates a pledgeBlock object
*
* @param array $params (reference ) an assoc array of name/value pairs
*
}
/**
- * add pledgeBlock
+ * Add pledgeBlock
*
* @param array $params reference array contains the values submitted by the form
*
}
/**
- * delete the pledgeBlock
+ * Delete the pledgeBlock
*
* @param int $id pledgeBlock id
*
}
/**
- * return Pledge Block info in Contribution Pages
+ * Return Pledge Block info in Contribution Pages
*
* @param int $pageID contribution page id
*
}
/**
- * Function to build Pledge Block in Contribution Pages
+ * Build Pledge Block in Contribution Pages
*
* @param CRM_Core_Form $form
* @static
class CRM_Pledge_BAO_PledgePayment extends CRM_Pledge_DAO_PledgePayment {
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
}
/**
- * get pledge payment details
+ * Get pledge payment details
*
* @param int $pledgeId pledge id
*
/**
* Delete pledge payment
*
- * @param $id
+ * @param int $id
*
* @return int pledge payment id
* @static
}
/**
- * delete all pledge payments
+ * Delete all pledge payments
*
* @param int $id pledge id
*
}
/**
- * update Pledge Payment Status
+ * Update Pledge Payment Status
*
* @param int $pledgeID , id of pledge
* @param array $paymentIDs , ids of pledge payment(s) to update
}
/**
- * update pledge payment table
+ * Update pledge payment table
*
* @param int $pledgeId pledge id
* @param int $paymentStatusId payment status id to set
}
/**
- * Function to update pledge payment table when reminder is sent
+ * Update pledge payment table when reminder is sent
*
* @param int $paymentId payment id
*
}
/**
- * Function to get oldest pending or in progress pledge payments
+ * Get oldest pending or in progress pledge payments
*
* @param int $pledgeID pledge id
*
}
/**
- * @param $pledgeID
+ * @param int $pledgeID
* @param $actualAmount
* @param $pledgeScheduledAmount
- * @param null $paymentContributionId
- * @param null $pPaymentId
- * @param null $paymentStatusID
+ * @param int $paymentContributionId
+ * @param int $pPaymentId
+ * @param int $paymentStatusID
*/
static function adjustPledgePayment($pledgeID, $actualAmount, $pledgeScheduledAmount, $paymentContributionId = NULL, $pPaymentId = NULL, $paymentStatusID = NULL) {
$allStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
}
/**
- * build select for Pledge
+ * Build select for Pledge
*
* @param $query
*
}
/**
- * @param $name
+ * @param string $name
* @param $mode
* @param $side
*
}
/**
- * getter for the qill object
+ * Getter for the qill object
*
* @return string
* @access public
/**
* @param $row
- * @param $id
+ * @param int $id
*/
static function searchAction(&$row, $id) {}
class CRM_Pledge_Controller_Search extends CRM_Core_Controller {
/**
- * class constructor
+ * Class constructor
*/
function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) {
class CRM_Pledge_Form_Payment extends CRM_Core_Form {
/**
- * the id of the pledge payment that we are proceessing
+ * The id of the pledge payment that we are proceessing
*
* @var int
* @public
public $_id;
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
public $_action;
/**
- * the id of the pledge that we are proceessing
+ * The id of the pledge that we are proceessing
*
* @var int
* @public
public $_id;
/**
- * the id of the contact associated with this pledge
+ * The id of the contact associated with this pledge
*
* @var int
* @public
public $_freqUnits;
/**
- * is current pledge pending.
+ * Is current pledge pending.
* @public
*/
public $_isPending = FALSE;
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
}
/**
- * global form rule
+ * Global form rule
*
* @param array $fields the input form values
* @param array $files the uploaded files if any
class CRM_Pledge_Form_PledgeView extends CRM_Core_Form {
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
class CRM_Pledge_Form_Search extends CRM_Core_Form_Search {
/**
- * the params that are sent to the query
+ * The params that are sent to the query
*
* @var array
* @access protected
protected $_queryParams;
/**
- * are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact
*
* @access protected
* @var boolean
protected $_single = FALSE;
/**
- * are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact
*
* @access protected
* @var boolean
protected $_limit = NULL;
/**
- * prefix for the controller
+ * Prefix for the controller
*
*/
protected $_prefix = "pledge_";
protected $_defaults;
/**
- * processing needed for buildForm and later
+ * Processing needed for buildForm and later
*
* @return void
* @access public
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $fields posted values of the form
*
class CRM_Pledge_Form_Task extends CRM_Core_Form {
/**
- * the task being performed
+ * The task being performed
*
* @var int
*/
protected $_pledgeIds;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @param
*
}
/**
- * simple shell that derived classes can call to add buttons to
+ * Simple shell that derived classes can call to add buttons to
* the form with a customized title for the main Submit
*
* @param string $title title of the main button
protected $_single = FALSE;
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
class CRM_Pledge_Form_Task_Print extends CRM_Pledge_Form_Task {
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
}
/**
- * process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated
*
* @access public
*
class CRM_Pledge_Form_Task_Result extends CRM_Pledge_Form_Task {
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
class CRM_Pledge_Form_Task_SearchTaskHookSample extends CRM_Pledge_Form_Task {
/**
- * build all the data structures needed to build the form
+ * Build all the data structures needed to build the form
*
* @return void
* @access public
class CRM_Pledge_Page_AJAX {
/**
- * building Pledge Name combo box
+ * Building Pledge Name combo box
*/
static function pledgeName() {
static $_links = NULL;
/**
- * we use desc to remind us what that column is, name is used in the tpl
+ * We use desc to remind us what that column is, name is used in the tpl
*
* @var array
* @static
);
/**
- * are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact
*
* @access protected
* @var boolean
protected $_single = FALSE;
/**
- * are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact
*
* @access protected
* @var boolean
protected $_limit = NULL;
/**
- * what context are we being invoked from
+ * What context are we being invoked from
*
* @access protected
* @var string
protected $_context = NULL;
/**
- * queryParams is the array returned by exportValues called on
+ * QueryParams is the array returned by exportValues called on
* the HTML_QuickForm_Controller for that page.
*
* @var array
public $_queryParams;
/**
- * represent the type of selector
+ * Represent the type of selector
*
* @var int
* @access protected
}
/**
- * getter for array of the parameters required for creating pager.
+ * Getter for array of the parameters required for creating pager.
*
* @param $action
* @param array $params
}
/**
- * returns all the rows in the given offset and rowCount
+ * Returns all the rows in the given offset and rowCount
*
* @param enum $action the action being performed
* @param int $offset the row number to start from
}
/**
- * returns the column headers as an array of tuples:
+ * Returns the column headers as an array of tuples:
* (name, sortName (key to the sort array))
*
* @param string $action the action being performed
}
/**
- * name of export file.
+ * Name of export file.
*
* @param string $output type of output
*
protected $_task;
/**
- * class constructor
+ * Class constructor
*/ function __construct($controller, $action = CRM_Core_Action::NONE) {
parent::__construct($controller, $action);
}
/**
- * return the form name of the task
+ * Return the form name of the task
*
* @return string
* @access public
CONST DELETE_PLEDGES = 1, PRINT_PLEDGES = 2, EXPORT_PLEDGES = 3;
/**
- * the task array
+ * The task array
*
* @var array
* @static
static $_tasks = NULL;
/**
- * the optional task array
+ * The optional task array
*
* @var array
* @static
}
/**
- * show tasks selectively based on the permission level
+ * Show tasks selectively based on the permission level
* of the user
*
* @param int $permission
}
/**
- * @param $entityId
+ * @param int $entityId
* @param $entityTable
*
* @return null|string
}
/**
- * wrapper for line item retrieval when contribution ID is known
- * @param $contributionID
+ * Wrapper for line item retrieval when contribution ID is known
+ * @param int $contributionID
*
* @return array
*/
}
/**
- * process price set and line items.
+ * Process price set and line items.
*
- * @param $entityId
+ * @param int $entityId
* @param array $lineItem line item array
* @param object $contributionDetails
* @param string $entityTable entity table
}
/**
- * @param $entityId
+ * @param int $entityId
* @param string $entityTable
* @param $amount
- * @param null $otherParams
+ * @param array $otherParams
*/
public static function syncLineItems($entityId, $entityTable = 'civicrm_contribution', $amount, $otherParams = NULL) {
if (!$entityId || CRM_Utils_System::isNull($amount))
}
/**
- * build line items array.
+ * Build line items array.
* @param array $params form values
*
* @param string $entityId entity id
protected $_options;
/**
- * takes an associative array and creates a price field object
+ * Takes an associative array and creates a price field object
*
* the function extract all the params it needs to initialize the create a
* price field object. the params array could contain additional unused name/value
}
/**
- * takes an associative array and creates a price field object
+ * Takes an associative array and creates a price field object
*
* This function is invoked from within the web form layer and also from the api layer
*
}
/**
- * update the is_active flag in the db
+ * 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 CRM_Core_Form $qf form object (reference)
* @param string $elementName name of the custom field
- * @param $fieldId
+ * @param int $fieldId
* @param boolean $inactiveNeeded
* @param boolean $useRequired true if required else false
* @param string $label label for custom field
/**
* @param $optionLabel
- * @param $fid
+ * @param int $fid
*
* @return mixed
*/
class CRM_Price_BAO_PriceFieldValue extends CRM_Price_DAO_PriceFieldValue {
/**
- * insert/update a new entry in the database.
+ * Insert/update a new entry in the database.
*
* @param array $params (reference), array $ids
*
}
/**
- * update the is_active flag in the db
+ * 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
}
/**
- * delete all values of the given field id
+ * Delete all values of the given field id
*
* @param int $fieldId Price field id
*
class CRM_Price_BAO_PriceSet extends CRM_Price_DAO_PriceSet {
/**
- * static field for default price set details
+ * Static field for default price set details
*
* @var array
* @static
static $_defaultPriceSet = NULL;
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
}
/**
- * takes an associative array and creates a price set object
+ * Takes an associative array and creates a price set object
*
* @param array $params (reference) an assoc array of name/value pairs
*
}
/**
- * update the is_active flag in the db
+ * Update the is_active flag in the db
*
* @param int $id id of the database record
* @param $isActive
*
* An array containing price set details (including price fields) is returned
*
- * @param $setID
+ * @param int $setID
* @param bool $required
* @param bool $validOnly
*
/**
* @param CRM_Core_Form $form
- * @param $id
+ * @param int $id
* @param string $entityTable
* @param bool $validOnly
- * @param null $priceSetId
+ * @param int $priceSetId
*
* @return bool|false|int|null
*/
}
/**
- * build the price set form.
+ * Build the price set form.
*
* @param CRM_Core_Form $form
*
}
/**
- * check the current Membership
+ * Check the current Membership
* having end date null.
*/
static function checkCurrentMembership(&$options, $userid) {
}
/**
- * set daefult the price set fields.
+ * Set daefult the price set fields.
*
* @param CRM_Core_Form $form
* @param $defaults
}
/**
- * Function to check if auto renew option should be shown
+ * Check if auto renew option should be shown
*
* @param int $priceSetId price set id
*
}
/**
- * Function to retrieve auto renew frequency and interval
+ * Retrieve auto renew frequency and interval
*
* @param int $priceSetId price set id
*
}
/**
- * update the is_quick_config flag in the db
+ * Update the is_quick_config flag in the db
*
* @param int $id id of the database record
* @param boolean $isQuickConfig value we want to set the is_quick_config field
class CRM_Price_Form_DeleteField extends CRM_Core_Form {
/**
- * the field id
+ * The field id
*
* @var int
*/
protected $_title;
/**
- * set up variables to build the form
+ * Set up variables to build the form
*
* @param null
*
class CRM_Price_Form_DeleteSet extends CRM_Core_Form {
/**
- * the set id
+ * The set id
*
* @var int
*/
protected $_title;
/**
- * set up variables to build the form
+ * Set up variables to build the form
*
* @return void
* @acess protected
CONST NUM_OPTION = 15;
/**
- * the custom set id saved to the session for an update
+ * The custom set id saved to the session for an update
*
* @var int
* @access protected
protected $_extendComponentId;
/**
- * variable is set if price set is used for membership
+ * Variable is set if price set is used for membership
* @access protected
*/
protected $_useForMember;
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @param null
*
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $fields posted values of the form
*
class CRM_Price_Form_Option extends CRM_Core_Form {
/**
- * the price field id saved to the session for an update
+ * The price field id saved to the session for an update
*
* @var int
* @access protected
protected $_fid;
/**
- * option value id, used when editing the Option
+ * Option value id, used when editing the Option
*
* @var int
* @access protected
protected $_oid;
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @param null
*
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $fields posted values of the form
*
class CRM_Price_Form_Preview extends CRM_Core_Form {
/**
- * the group tree data
+ * The group tree data
*
* @var array
*/
protected $_groupTree;
/**
- * pre processing work done here.
+ * Pre processing work done here.
*
* gets session variables for group or field id
*
class CRM_Price_Form_Set extends CRM_Core_Form {
/**
- * the set id saved to the session for an update
+ * The set id saved to the session for an update
*
* @var int
* @access protected
protected $_sid;
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @param null
*
}
/**
- * global form rule
+ * Global form rule
*
* @param array $fields the input form values
* @param array $files the uploaded files if any
}
/**
- * edit price data.
+ * Edit price data.
*
* editing would involved modifying existing fields + adding data to new fields.
*
/**
* Preview price field
*
- * @param $fid
+ * @param int $fid
*
* @internal param int $id price field id
*
}
/**
- * edit custom Option.
+ * Edit custom Option.
*
* editing would involved modifying existing fields + adding data to new fields.
*
}
/**
- * edit price set
+ * Edit price set
*
* @param int $sid price set id
* @param string $action the action to be invoked
protected $_title;
/**
- * the fields needed to build this form
+ * The fields needed to build this form
*
* @var array
*/
public $_fields;
/**
- * to store contact details
+ * To store contact details
*
* @var array
*/
protected $_recordId = NULL;
/**
- * action for multi record profile (create/edit/delete)
+ * Action for multi record profile (create/edit/delete)
*
* @var string
*/
protected $_session = NULL;
/**
- * pre processing work done here.
+ * Pre processing work done here.
*
* gets session variables for table name, id of entity in table, type of entity and stores them.
*
}
/**
- * global form rule
+ * Global form rule
*
* @param array $fields the input form values
* @param array $files the uploaded files if any
class CRM_Profile_Form_Dynamic extends CRM_Profile_Form {
/**
- * pre processing work done here.
+ * Pre processing work done here.
*
* @param
*
}
/**
- * global form rule
+ * Global form rule
*
* @param array $fields the input form values
* @param array $files the uploaded files if any
protected $_prefix;
/**
- * pre processing work done here.
+ * Pre processing work done here.
*
* @param
*
}
/**
- * intercept QF validation and do our own redirection
+ * Intercept QF validation and do our own redirection
*
* We use this to send control back to the user for a user formatted page
* This allows the user to maintain the same state and display the error messages
class CRM_Profile_Form_Search extends CRM_Profile_Form {
/**
- * pre processing work done here.
+ * Pre processing work done here.
*
* @param
*
protected $_id;
/**
- * the profile group are are interested in
+ * The profile group are are interested in
*
* @var int
* @access protected
protected $_allFields = NULL;
/**
- * class constructor
+ * Class constructor
*
* @param int $id the contact id
* @param int $gid the group id
class CRM_Profile_Page_Listings extends CRM_Core_Page {
/**
- * all the fields that are listings related
+ * All the fields that are listings related
*
* @var array
* @access protected
protected $_fields;
/**
- * the custom fields for this domain
+ * The custom fields for this domain
*
* @var array
* @access protected
protected $_gid;
/**
- * state whether to display search form or not
+ * State whether to display search form or not
*
* @var int
*/
protected $_profileIds = array();
/**
- * extracts the parameters from the request and constructs information for
+ * Extracts the parameters from the request and constructs information for
* the selector object to do a query
*
* @return void
}
/**
- * run this page (figure out the action needed and perform it).
+ * Run this page (figure out the action needed and perform it).
*
* @return void
*/
}
/**
- * get the list of contacts for a profile
+ * Get the list of contacts for a profile
*
- * @param $gid
+ * @param int $gid
*
* @return array
* @access public
}
/**
- * build the outcome basing on the CRM_Profile_Page_Dynamic's HTML
+ * Build the outcome basing on the CRM_Profile_Page_Dynamic's HTML
*
* @return void
* @access public
class CRM_Profile_Selector_Listings extends CRM_Core_Selector_Base implements CRM_Core_Selector_API {
/**
- * array of supported links, currenly view and edit
+ * Array of supported links, currenly view and edit
*
* @var array
* @static
static $_links = NULL;
/**
- * we use desc to remind us what that column is, name is used in the tpl
+ * We use desc to remind us what that column is, name is used in the tpl
*
* @var array
* @static
protected $_params;
/**
- * the public visible fields to be shown to the user
+ * The public visible fields to be shown to the user
*
* @var array
* @access protected
protected $_fields;
/**
- * the custom fields for this domain
+ * The custom fields for this domain
*
* @var array
* @access protected
protected $_customFields;
/**
- * cache the query object
+ * Cache the query object
*
* @var object
* @access protected
protected $_query;
/**
- * cache the expanded options list if any
+ * Cache the expanded options list if any
*
* @var object
* @access protected
}
/**
- * getter for array of the parameters required for creating pager.
+ * Getter for array of the parameters required for creating pager.
*
* @param $action
* @param array $params
}
/**
- * returns the column headers as an array of tuples:
+ * Returns the column headers as an array of tuples:
* (name, sortName (key to the sort array))
*
* @param string $action the action being performed
}
/**
- * returns all the rows in the given offset and rowCount
+ * Returns all the rows in the given offset and rowCount
*
* @param enum $action the action being performed
* @param int $offset the row number to start from
}
/**
- * name of export file.
+ * Name of export file.
*
* @param string $output type of output
*
protected $_queryObjects = NULL;
/**
- * singleton function used to manage this object
+ * Singleton function used to manage this object
*
* @return object
* @static
class CRM_Report_BAO_ReportInstance extends CRM_Report_DAO_ReportInstance {
/**
- * takes an associative array and creates an instance object
+ * Takes an associative array and creates an instance object
*
* the function extract all the params it needs to initialize the create a
* instance object. the params array could contain additional unused name/value
}
/**
- * create instance
+ * Create instance
* takes an associative array and creates a instance object and does any related work like permissioning, adding to dashboard etc.
*
* This function is invoked from within the web form layer and also from the api layer
/**
* Delete the instance of the Report
*
- * @param null $id
+ * @param int $id
*
* @return mixed $results no of deleted Instance on success, false otherwise@access public
*/
protected $_customGroupJoin = 'LEFT JOIN';
/**
- * build tags filter
+ * Build tags filter
*
*/
protected $_tagFilter = FALSE;
/**
- * build groups filter
+ * Build groups filter
*
*/
protected $_groupFilter = FALSE;
protected $_selectedTables;
/**
- * outputmode e.g 'print', 'csv', 'pdf'
+ * Outputmode e.g 'print', 'csv', 'pdf'
* @var string
*/
protected $_outputMode;
public $_havingClauses = array();
/**
- * dashBoardRowCount Dashboard row count
+ * DashBoardRowCount Dashboard row count
* @var Integer
*/
public $_dashBoardRowCount;
/**
* @param $group
- * @param $grpFieldName
+ * @param string $grpFieldName
*
* @return bool
*/
/**
* Setter for $_id
*
- * @param $instanceid
+ * @param int $instanceid
*/
function setID($instanceid) {
$this->_id = $instanceid;
}
/**
- * @param $fieldName
+ * @param string $fieldName
* @param $relative
* @param $from
* @param $to
}
/**
- * @param $tableName
+ * @param string $tableName
* @param $tableKey
- * @param $fieldName
+ * @param string $fieldName
* @param $field
*
* @return bool
}
/**
- * beginPostProcess function run in both report mode and non-report mode (api)
+ * BeginPostProcess function run in both report mode and non-report mode (api)
*/
function beginPostProcessCommon() {
* Adjusts dates passed in to YEAR() for fiscal year.
*/
/**
- * @param $fieldName
+ * @param string $fieldName
*
* @return string
*/
}
/**
- * @param $groupID
+ * @param int $groupID
*/
function add2group($groupID) {
if (is_numeric($groupID) && isset($this->_aliases['civicrm_contact'])) {
}
/**
- * @param $groupID
+ * @param int $groupID
*
* @throws Exception
*/
}
/**
- * @param $fname
+ * @param string $fname
* @param $val
*
* @return null|string
}
/**
- * @param $groupID
+ * @param int $groupID
*/
function add2group($groupID) {
if (is_numeric($groupID)) {
* @param $rows
* @param $entryFound
* @param $row
- * @param $rowId
+ * @param int $rowId
* @param $rowNum
* @param $types
*/
* @param $value
* @param $row
* @param $selectedfield
- * @param $criteriaFieldName
+ * @param string $criteriaFieldName
*
* @return array
*/
* @param $value
* @param $row
* @param $selectedfield
- * @param $criteriaFieldName
+ * @param string $criteriaFieldName
*
* @return array
*/
* @param $value
* @param $row
* @param $selectedfield
- * @param $criteriaFieldName
+ * @param string $criteriaFieldName
*
* @return array
*/
/**
* @param $value
* @param $row
- * @param $fieldname
+ * @param string $fieldname
*
* @return mixed
*/
* If we are retrieving total paid we need to define the inclusion of pledge_payment
*/
/**
- * @param $tableName
+ * @param string $tableName
* @param $tableKey
- * @param $fieldName
+ * @param string $fieldName
* @param $field
*
* @return bool|string
*/
class CRM_Report_Page_Instance extends CRM_Core_Page {
/**
- * run this page (figure out the action needed and perform it).
+ * Run this page (figure out the action needed and perform it).
*
* @return void
*/
}
/**
- * run this page (figure out the action needed and perform it).
+ * Run this page (figure out the action needed and perform it).
*
* @return void
*/
}
/**
- * run this page (figure out the action needed and perform it).
+ * Run this page (figure out the action needed and perform it).
*
* @return void
*/
}
/**
- * get userContext params
+ * Get userContext params
*
* @param int $mode mode that we are in
*
class CRM_Report_Page_Report extends CRM_Core_Page {
/**
- * run this page (figure out the action needed and perform it).
+ * Run this page (figure out the action needed and perform it).
*
* @return void
*/
class CRM_Report_Page_TemplateList extends CRM_Core_Page {
/**
- * @param null $compID
+ * @param int $compID
* @param null $grouping
*
* @return array
}
/**
- * run this page (figure out the action needed and perform it).
+ * Run this page (figure out the action needed and perform it).
*
* @return void
*/
class CRM_Report_Utils_Get {
/**
- * @param $name
+ * @param string $name
* @param $type
*
* @return mixed|null
}
/**
- * @param $fieldName
+ * @param string $fieldName
* @param $field
* @param $defaults
*/
}
/**
- * @param $fieldName
+ * @param string $fieldName
* @param $field
* @param $defaults
*/
}
/**
- * @param $fieldName
+ * @param string $fieldName
* @param $field
* @param $defaults
*/
class CRM_Report_Utils_Report {
/**
- * @param null $instanceID
+ * @param int $instanceID
*
* @return null|string
*/
}
/**
- * @param null $instanceID
+ * @param int $instanceID
*
* @return array|bool
*/
* @param $urlValue
* @param string $query
* @param bool $absolute
- * @param null $instanceID
+ * @param int $instanceID
* @param array $drilldownReport
*
* @return bool|string
/**
* @param $fileContent
- * @param null $instanceID
+ * @param int $instanceID
* @param string $outputMode
* @param array $attachments
*
}
/**
- * @param $instanceId
+ * @param int $instanceId
*
* @return bool
*/
*
* @instanceId string $str the report instance to check
*
- * @param $instanceId
+ * @param int $instanceId
*
* @return boolean true if yes, else false
* @static
class CRM_SMS_BAO_Provider extends CRM_SMS_DAO_Provider {
/**
- * class constructor
+ * Class constructor
*
* @access public
* @return \CRM_SMS_DAO_Provider
/**
* @param $values
- * @param $providerId
+ * @param int $providerId
*/
static function updateRecord($values, $providerId) {
$dao = new CRM_SMS_DAO_Provider();
}
/**
- * @param $id
+ * @param int $id
* @param $is_active
*
* @return bool
}
/**
- * @param $providerID
+ * @param int $providerID
*
* @return null
* @throws Exception
}
/**
- * @param $providerID
+ * @param int $providerID
* @param null $returnParam
* @param null $returnDefaultString
*
class CRM_SMS_Controller_Send extends CRM_Core_Controller {
/**
- * class constructor
+ * Class constructor
*/
function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) {
parent::__construct($title, $modal, NULL, FALSE, TRUE);
class CRM_SMS_Form_Group extends CRM_Contact_Form_Task {
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $fields posted values of the form
*
class CRM_SMS_Form_Schedule extends CRM_Core_Form {
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
}
/**
- * validation
+ * Validation
*
* @param array $params (ref.) an assoc array of name/value pairs
*
CONST MAX_SMS_CHAR = 460;
/**
- * singleton function used to manage this object
+ * Singleton function used to manage this object
*
* @param array $providerParams
* @param bool $force
abstract function send($recipients, $header, $message, $dncID = NULL);
/**
- * return message text. Child class could override this function to have better control over the message being sent.
+ * Return message text. Child class could override this function to have better control over the message being sent.
*
* @access public
*/
}
/**
- * @param $apiMsgID
+ * @param int $apiMsgID
* @param $message
* @param array $headers
- * @param null $jobID
- * @param null $userID
+ * @param int $jobID
+ * @param int $userID
*
* @return $this|null|object
* @throws CRM_Core_Exception
}
/**
- * @param $name
+ * @param string $name
* @param $type
* @param bool $abort
* @param null $default
* @param $from
* @param $body
* @param null $to
- * @param null $trackID
+ * @param int $trackID
*
* @return $this|null|object
* @throws CRM_Core_Exception
class CRM_SMS_StateMachine_Send extends CRM_Core_StateMachine {
/**
- * class constructor
+ * Class constructor
*
* @param object $controller
* @param \const|int $action
class CRM_UF_Form_AbstractPreview extends CRM_Core_Form {
/**
- * the fields needed to build this form
+ * The fields needed to build this form
*
* @var array
*/
class CRM_UF_Form_Field extends CRM_Core_Form {
/**
- * the uf group id saved to the session for an update
+ * The uf group id saved to the session for an update
*
* @var int
* @access protected
protected $_fields;
/**
- * the title for field
+ * The title for field
*
* @var int
* @access protected
protected $_selectFields;
/**
- * to store fields with if locationtype exits status
+ * To store fields with if locationtype exits status
*
* @var array
* @access protected
protected $_hasLocationTypes;
/**
- * is this profile has searchable field
+ * Is this profile has searchable field
* or is any field having in selector true.
*
* @var boolean.
protected $_hasSearchableORInSelector;
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
}
/**
- * validation rule for subtype.
+ * Validation rule for subtype.
*
* @param array $groupType contains all groupTypes.
*
}
/**
- * validation rule for custom data extends entity column values.
+ * Validation rule for custom data extends entity column values.
*
* @param Object $customField Custom field
* @param Integer $gid Group Id.
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
* @param array $fields posted values of the form
*
class CRM_UF_Form_Group extends CRM_Core_Form {
/**
- * the form id saved to the session for an update
+ * The form id saved to the session for an update
*
* @var int
* @access protected
protected $_id;
/**
- * the title for group
+ * The title for group
*
* @var int
* @access protected
protected $_allPanes;
/**
- * set variables up before form is built
+ * Set variables up before form is built
*
* @return void
* @access public
}
/**
- * global form rule
+ * Global form rule
*
* @param array $fields the input form values
* @param array $files the uploaded files if any
class CRM_UF_Form_Inline_Preview extends CRM_UF_Form_AbstractPreview {
/**
- * pre processing work done here.
+ * Pre processing work done here.
*
* gets session variables for group or field id
*
class CRM_UF_Form_Inline_PreviewById extends CRM_UF_Form_AbstractPreview {
/**
- * pre processing work done here.
+ * Pre processing work done here.
*
* gets session variables for group or field id
*
class CRM_UF_Form_Preview extends CRM_UF_Form_AbstractPreview {
/**
- * pre processing work done here.
+ * Pre processing work done here.
*
* gets session variables for group or field id
*
}
/**
- * edit CiviCRM Profile data.
+ * Edit CiviCRM Profile data.
*
* editing would involved modifying existing fields + adding data to new fields.
*
}
/**
- * edit uf group
+ * Edit uf group
*
* @param int $id uf group id
* @param string $action the action to be invoked
}
/**
- * this function is for preview mode for ufoup
+ * This function is for preview mode for ufoup
*
* @param int $id uf group id
*
}
/**
- * @param $id
+ * @param int $id
* @param $action
*/
function setContext($id, $action) {
class CRM_Upgrade_Controller extends CRM_Core_Controller {
/**
- * class constructor
+ * Class constructor
*/
function __construct($title = NULL,
$action = CRM_Core_Action::NONE,
public $multilingual = FALSE;
/**
- * locales available for multilingual upgrade
+ * Locales available for multilingual upgrade
*
* @var array
* @public
public $locales;
/**
- * number to string mapper
+ * Number to string mapper
*
* @var array
* @public
}
/**
- * @param $fileName
+ * @param string $fileName
* @param bool $isQueryString
*/
function source($fileName, $isQueryString = FALSE) {
}
/**
- * getter function for title. Should be over-ridden by derived class
+ * Getter function for title. Should be over-ridden by derived class
*
* @return string
* @access public
/**
* @param CRM_Queue_TaskContext $ctx
- * @param $startId
- * @param $endId
+ * @param int $startId
+ * @param int $endId
*
* @return bool
*/
* (e.g. "http://example.com/?page=CiviCRM&q=civicrm/contact/imagefile&photo=123.jpg").
*
* @param CRM_Queue_TaskContext $ctx
- * @param $startId
- * @param $endId
+ * @param int $startId
+ * @param int $endId
* @return bool
*/
static function cleanupBackendImageUrls(CRM_Queue_TaskContext $ctx, $startId, $endId) {
}
/**
- * change index and add missing constraints for civicrm_contribution_recur
+ * Change index and add missing constraints for civicrm_contribution_recur
*/
function addMissingConstraints(CRM_Queue_TaskContext $ctx) {
$query = "SHOW KEYS FROM `civicrm_contribution_recur` WHERE key_name = 'UI_contrib_payment_instrument_id'";
}
/**
- * replace contribution_type to financial_type in table
+ * Replace contribution_type to financial_type in table
* civicrm_saved_search and Structure civicrm_report_instance
*/
function replaceContributionTypeId(CRM_Queue_TaskContext $ctx, $query, $table) {
protected $_options;
/**
- * takes an associative array and creates a price field object
+ * Takes an associative array and creates a price field object
*
* the function extract all the params it needs to initialize the create a
* price field object. the params array could contain additional unused name/value
}
/**
- * takes an associative array and creates a price field object
+ * Takes an associative array and creates a price field object
*
* This function is invoked from within the web form layer and also from the api layer
*
}
/**
- * update the is_active flag in the db
+ * 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 CRM_Core_Form $qf form object (reference)
* @param string $elementName name of the custom field
- * @param $fieldId
+ * @param int $fieldId
* @param boolean $inactiveNeeded
* @param boolean $useRequired true if required else false
* @param string $label label for custom field
/**
* @param $optionLabel
- * @param $fid
+ * @param int $fid
*
* @return mixed
*/
class CRM_Upgrade_Snapshot_V4p2_Price_BAO_FieldValue extends CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue {
/**
- * insert/update a new entry in the database.
+ * Insert/update a new entry in the database.
*
* @param array $params (reference), array $ids
*
}
/**
- * update the is_active flag in the db
+ * 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
}
/**
- * delete all values of the given field id
+ * Delete all values of the given field id
*
* @param int $fieldId Price field id
*
}
/**
- * @param $entityId
+ * @param int $entityId
* @param string $entityTable
* @param $amount
- * @param null $otherParams
+ * @param array $otherParams
*/
public static function syncLineItems($entityId, $entityTable = 'civicrm_contribution', $amount, $otherParams = NULL) {
if (!$entityId || CRM_Utils_System::isNull($amount))
class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Set extends CRM_Upgrade_Snapshot_V4p2_Price_DAO_Set {
/**
- * class constructor
+ * Class constructor
*/
function __construct() {
parent::__construct();
}
/**
- * takes an associative array and creates a price set object
+ * Takes an associative array and creates a price set object
*
* @param array $params (reference) an assoc array of name/value pairs
*
}
/**
- * update the is_active flag in the db
+ * Update the is_active flag in the db
*
* @param int $id id of the database record
* @param bool $isActive value we want to set the is_active field
/**
* @param CRM_Core_Form $form
- * @param $id
+ * @param int $id
* @param string $entityTable
* @param bool $validOnly
- * @param null $priceSetId
+ * @param int $priceSetId
*
* @return bool|false|int|null
*/
}
/**
- * build the price set form.
+ * Build the price set form.
*
* @param CRM_Core_Form $form
*
}
/**
- * set daefult the price set fields.
+ * Set daefult the price set fields.
*
* @param CRM_Core_Form $form
* @param $defaults
}
/**
- * Function to retrieve auto renew frequency and interval
+ * Retrieve auto renew frequency and interval
*
* @param int $priceSetId price set id
*
}
/**
- * update the is_quick_config flag in the db
+ * Update the is_quick_config flag in the db
*
* @param int $id id of the database record
* @param boolean $isQuickConfig value we want to set the is_quick_config field
public $visibility_id;
/**
- * class constructor
+ * Class constructor
*
* @access public
* @return \CRM_Upgrade_Snapshot_V4p2_Price_DAO_Field
public $is_active;
/**
- * class constructor
+ * Class constructor
*
* @access public
* @return \CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue
public $price_field_value_id;
/**
- * class constructor
+ * Class constructor
*
* @access public
* @return \CRM_Upgrade_Snapshot_V4p2_Price_DAO_LineItem
public $is_reserved;
/**
- * class constructor
+ * Class constructor
*
* @access public
* @return \CRM_Upgrade_Snapshot_V4p2_Price_DAO_Set
public $price_set_id;
/**
- * class constructor
+ * Class constructor
*
* @access public
* @return \CRM_Upgrade_Snapshot_V4p2_Price_DAO_SetEntity
class CRM_Upgrade_StateMachine extends CRM_Core_StateMachine {
/**
- * class constructor
+ * Class constructor
*
* @param object $controller
* @param const $pages
class CRM_Utils_Address {
/**
- * format an address string from address fields and a format string
+ * Format an address string from address fields and a format string
*
* Format an address basing on the address fields provided.
* Use Setting's address_format if there's no format specified.
}
/**
- * singleton function used to manage this object
+ * Singleton function used to manage this object
*
* @return object
* @static
private $title;
/**
- * @param $name
+ * @param string $name
* @param $message
* @param $title
*/
class CRM_Utils_Date {
/**
- * format a date by padding it with leading '0'.
+ * Format a date by padding it with leading '0'.
*
* @param array $date ('Y', 'M', 'd')
* @param string $separator the seperator to use when formatting the date
}
/**
- * return abbreviated weekday names according to the locale
+ * Return abbreviated weekday names according to the locale
*
* @return array 0-based array with abbreviated weekday names
*
}
/**
- * return full weekday names according to the locale
+ * Return full weekday names according to the locale
*
* @return array 0-based array with full weekday names
*
}
/**
- * return abbreviated month names according to the locale
+ * Return abbreviated month names according to the locale
*
* @param bool $month
*
}
/**
- * return full month names according to the locale
+ * Return full month names according to the locale
*
* @return array 1-based array with full month names
*
}
/**
- * create a date and time string in a provided format
+ * Create a date and time string in a provided format
*
* %b - abbreviated month name ('Jan'..'Dec')
* %B - full month name ('January'..'December')
}
/**
- * converts the date/datetime from MySQL format to ISO format
+ * Converts the date/datetime from MySQL format to ISO format
*
* @param string $mysql date/datetime in MySQL format
*
}
/**
- * converts the date/datetime from ISO format to MySQL format
+ * Converts the date/datetime from ISO format to MySQL format
* Note that until CRM-14986/ 4.4.7 this was required whenever the pattern $dao->find(TRUE): $dao->save(); was
* used to update an object with a date field was used. The DAO now checks for a '-' in date field strings
* & runs this function if the - appears - meaning it is likely redundant in the form & BAO layers
}
/**
- * converts the any given date to default date format.
+ * Converts the any given date to default date format.
*
* @param array $params has given date-format
* @param int $dateType type of date
}
/**
- * get customized today
+ * Get customized today
*
* This function is used for getting customized today. To get
* actuall today pass 'dayParams' as null. or else pass the day,
}
/**
- * find whether today's date lies in
+ * Find whether today's date lies in
* the given range
*
* @param date $startDate start date for the range
}
/**
- * get start date and end from
+ * Get start date and end from
* the given relative term and unit
*
* @param date $relative eg: term.unit
}
/**
- * Function to calculate Age in Years if greater than one year else in months
+ * Calculate Age in Years if greater than one year else in months
*
* @param date $birthDate Birth Date
*
}
/**
- * Function to calculate next payment date according to provided unit & interval
+ * Calculate next payment date according to provided unit & interval
*
* @param string $unit frequency unit like year,month, week etc..
*
}
/**
- * function to check given format is valid for bith date.
+ * Check given format is valid for bith date.
* and retrun supportable birth date format w/ qf mapping.
*
* @param $format given format ( eg 'M Y', 'Y M' )
}
/**
- * resolves the given relative time interval into finite time limits
+ * Resolves the given relative time interval into finite time limits
*
* @param array $relativeTerm relative time frame like this, previous, etc
* @param int $unit frequency unit like year, month, week etc..
}
/**
- * Function to calculate current fiscal year based on the fiscal month and day
+ * Calculate current fiscal year based on the fiscal month and day
*
* @param int $fyDate Fiscal start date
*
* @param bool $dupeCheck
* @param bool $dupeErrorArray
* @param bool $requiredCheck
- * @param null $dedupeRuleGroupID
+ * @param int $dedupeRuleGroupID
*
* @return array|null
*/
/**
*
* @param $result
- * @param $activityTypeID
+ * @param int $activityTypeID
*
* @return array <type> $params
*/
}
/**
- * @param $name
+ * @param string $name
* @param $arguments
*
* @throws Exception
}
/**
- * create a directory given a path name, creates parent directories
+ * Create a directory given a path name, creates parent directories
* if needed
*
* @param string $path the path name
}
/**
- * delete a directory given a path name, delete children directories
+ * Delete a directory given a path name, delete children directories
* and files if needed
*
* @param string $target the path name
/**
* @param $dsn
- * @param $fileName
+ * @param string $fileName
* @param null $prefix
* @param bool $isQueryString
* @param bool $dieOnErrors
}
/**
- * remove the 32 bit md5 we add to the fileName
+ * Remove the 32 bit md5 we add to the fileName
* also remove the unknown tag if we added it
*/
static function cleanFileName($name) {
}
/**
- * @param $name
+ * @param string $name
*
* @return string
*/
class CRM_Utils_Geocode_Google {
/**
- * server to retrieve the lat/long
+ * Server to retrieve the lat/long
*
* @var string
* @static
static protected $_server = 'maps.googleapis.com';
/**
- * uri of service
+ * Uri of service
*
* @var string
* @static
static protected $_uri = '/maps/api/geocode/xml?sensor=false&address=';
/**
- * function that takes an address object and gets the latitude / longitude for this
+ * Function that takes an address object and gets the latitude / longitude for this
* address. Note that at a later stage, we could make this function also clean up
* the address into a more valid format
*
class CRM_Utils_Geocode_Yahoo {
/**
- * server to retrieve the lat/long
+ * Server to retrieve the lat/long
*
* @var string
* @static
static protected $_server = 'query.yahooapis.com';
/**
- * uri of service
+ * Uri of service
*
* @var string
* @static
static protected $_uri = '/v1/public/yql';
/**
- * function that takes an address array and gets the latitude / longitude
+ * Function that takes an address array and gets the latitude / longitude
* and postal code for this address. Note that at a later stage, we could
* make this function also clean up the address into a more valid format
*
);
/**
- * @param $numParams
+ * @param array $numParams
* @param $arg1
* @param $arg2
* @param $arg3
/**
* @param $civiModules
* @param $fnSuffix
- * @param $numParams
+ * @param array $numParams
* @param $arg1
* @param $arg2
* @param $arg3
/**
* @param $recordBAO
- * @param $recordID
+ * @param int $recordID
* @param $isActive
*
* @return mixed
}
/**
- * create JSON object
+ * Create JSON object
* @deprecated
*
* @param array $params associated array, that needs to be
}
/**
- * encode json format for flexigrid, NOTE: "id" should be present in $params for each row
+ * Encode json format for flexigrid, NOTE: "id" should be present in $params for each row
*
* @param array $params associated array of values rows
* @param int $page page no for selector
/**
* @param $message
- * @param null $params
+ * @param array $params
*
* @return mixed
*/
}
/**
- * @param $name
+ * @param string $name
* @param $email
* @param bool $useQuote
*
}
/**
- * retrieve a contact ID and if not present
+ * Retrieve a contact ID and if not present
* create one with this email
*/
public static function getContactID($email, $name = NULL, $create = TRUE, &$mail) {
}
/**
- * @param $groupName
+ * @param string $groupName
* @param string $daoName
* @param null $sql
*/
/**
* @param $ids
- * @param $tableName
+ * @param string $tableName
* @param $fields
* @param $whereField
* @param null $additionalWhereCond
/**
* @param $sql
- * @param $tableName
+ * @param string $tableName
* @param $fields
*/
function sql($sql, $tableName, &$fields) {
}
/**
- * @param $id
- * @param $name
+ * @param int $id
+ * @param string $name
* @param $value
*/
function appendValue($id, $name, $value) {
}
/**
- * @param $fileName
+ * @param string $fileName
* @param null $lastExportTime
* @param bool $discoverContacts
*/
}
/**
- * @param $tableName
+ * @param string $tableName
*/
function populateCache($tableName) {
if (isset($this->_lookupCache[$tableName])) {
static $_currencySymbols = NULL;
/**
- * format a monetary string
+ * Format a monetary string
*
* Format a monetary string basing on the amount provided,
* ISO currency code provided and a format string consisting of:
class CRM_Utils_OpenFlashChart {
/**
- * colours.
+ * Colours.
* @var array
* @static
*/
}
/**
- * @param $name
+ * @param string $name
* @param bool $convert
*
* @return float|int|mixed
* @param $orientation
* @param $html
* @param $output
- * @param $fileName
+ * @param string $fileName
*
* @return string
*/
* @param $margins
* @param $html
* @param $output
- * @param $fileName
+ * @param string $fileName
*/
static function _html2pdf_wkhtmltopdf($paper_size, $orientation, $margins, $html, $output, $fileName) {
require_once 'packages/snappy/src/autoload.php';
}
/**
- * @param $fileName
+ * @param string $fileName
* @param $searchPath
* @param $values
* @param int $numPages
class CRM_Utils_Pager extends Pager_Sliding {
/**
- * constants for static parameters of the pager
+ * Constants for static parameters of the pager
*/
CONST ROWCOUNT = 50, PAGE_ID = 'crmPID', PAGE_ID_TOP = 'crmPID', PAGE_ID_BOTTOM = 'crmPID_B', PAGE_ROWCOUNT = 'crmRowCount';
/**
- * the output of the pager. This is a name/value array with various keys
+ * The output of the pager. This is a name/value array with various keys
* that an application could use to display the pager
* @var array
*/
}
/**
- * helper function to assign remaining pager options as good default
+ * Helper function to assign remaining pager options as good default
* values
*
* @param array $params the set of options needed to initialize the parent
class CRM_Utils_PagerAToZ {
/**
- * returns the alphabetic array for sorting by character
+ * Returns the alphabetic array for sorting by character
*
* @param array $query The query object
* @param string $sortByCharacter The character that we are potentially sorting on
}
/**
- * return the all the static characters
+ * Return the all the static characters
*
* @return array $staticAlphabets is a array of static characters
* @access private
}
/**
- * return the all the dynamic characters
+ * Return the all the dynamic characters
*
* @param $query
* @param $isDAO
}
/**
- * create the links
+ * Create the links
*
* @param array $query The form values for search
* @param string $sortByCharacter The character that we are potentially sorting on
static private $_singleton = NULL;
/**
- * singleton function used to manage this object
+ * Singleton function used to manage this object
*
* @param string the key to permit session scope's
*
class CRM_Utils_Recent {
/**
- * max number of items in queue
+ * Max number of items in queue
*
* @int
*/
static private $_recent = NULL;
/**
- * initialize this class and set the static variables
+ * Initialize this class and set the static variables
*
* @return void
* @access public
}
/**
- * return the recently viewed array
+ * Return the recently viewed array
*
* @return array the recently viewed array
* @access public
}
/**
- * add an item to the recent stack
+ * Add an item to the recent stack
*
* @param string $title the title to display
* @param string $url the link for the above title
* @param string $id object id
* @param $type
- * @param $contactId
- * @param $contactName
+ * @param int $contactId
+ * @param string $contactName
* @param array $others
*
* @return void
}
/**
- * delete an item from the recent stack
+ * Delete an item from the recent stack
*
* @param array $recentItem array of the recent Item to be removed
*
}
/**
- * delete an item from the recent stack
+ * Delete an item from the recent stack
*
* @param string $id contact id that had to be removed
*
static private $_singleton = NULL;
/**
- * class constructor
+ * Class constructor
*/
function __construct() {}
}
/**
- * check the validity of the date (in qf format)
+ * Check the validity of the date (in qf format)
* note that only a year is valid, or a mon-year is
* also valid in addition to day-mon-year. The date
* specified has to be beyond today. (i.e today or later)
}
/**
- * check the validity of a date or datetime (timestamp)
+ * Check the validity of a date or datetime (timestamp)
* value which is in YYYYMMDD or YYYYMMDDHHMMSS format
*
* Uses PHP checkdate() - params are ( int $month, int $day, int $year )
}
/**
- * see how file rules are written in HTML/QuickForm/file.php
+ * See how file rules are written in HTML/QuickForm/file.php
* Checks to make sure the uploaded file is ascii
*
* @param array Uploaded file info (from $_FILES)
}
/**
- * see how file rules are written in HTML/QuickForm/file.php
+ * See how file rules are written in HTML/QuickForm/file.php
* Checks to make sure the uploaded file is html
*
* @param array Uploaded file info (from $_FILES)
}
/**
- * check the validity of the date (in qf format)
+ * Check the validity of the date (in qf format)
* note that only a year is valid, or a mon-year is
* also valid in addition to day-mon-year
*
private $rows;
/**
- * array<string> list of column names
+ * Array<string> list of column names
*/
private $columns;
class CRM_Utils_Sort {
/**
- * constants to determine what direction each variable
+ * Constants to determine what direction each variable
* is to be sorted
*
* @var int
CONST ASCENDING = 1, DESCENDING = 2, DONTCARE = 4,
/**
- * the name for the sort GET/POST param
+ * The name for the sort GET/POST param
*
* @var string
*/
SORT_ID = 'crmSID', SORT_DIRECTION = 'crmSortDirection', SORT_ORDER = 'crmSortOrder';
/**
- * name of the sort function. Used to isolate session variables
+ * Name of the sort function. Used to isolate session variables
* @var string
*/
protected $_name;
/**
- * array of variables that influence the query
+ * Array of variables that influence the query
*
* @var array
*/
public $_vars;
/**
- * the newly formulated base url to be used as links
+ * The newly formulated base url to be used as links
* for various table elements
*
* @var string
protected $_link;
/**
- * what's the name of the sort variable in a REQUEST
+ * What's the name of the sort variable in a REQUEST
*
* @var string
*/
}
/**
- * create the sortID string to be used in the GET param
+ * Create the sortID string to be used in the GET param
*
* @param int $index the field index
* @param int $dir the direction of the sort
}
/**
- * init the sort ID values in the object
+ * Init the sort ID values in the object
*
* @param string $defaultSortOrder the sort order to use by default
*
}
/**
- * init the object
+ * Init the object
*
* @param string $defaultSortOrder the sort order to use by default
*
}
/**
- * getter for currentSortID
+ * Getter for currentSortID
*
* @return int returns of the current sort id
* @acccess public
}
/**
- * getter for currentSortDirection
+ * Getter for currentSortDirection
*
* @return int returns of the current sort direction
* @acccess public
}
/**
- * given a string, replace all non alpha numeric characters and
+ * Given a string, replace all non alpha numeric characters and
* spaces with the replacement character
*
* @param string $name the name to be worked on
}
/**
- * convert possibly underscore separated words to camel case with special handling for 'UF'
+ * Convert possibly underscore separated words to camel case with special handling for 'UF'
* e.g
* membership_payment returns MembershipPayment
* @param string $string
}
/**
- * takes a string and returns the last tuple of the string.
+ * Takes a string and returns the last tuple of the string.
* useful while converting file names to class names etc
*
* @param string $string the input string
}
/**
- * appends a name to a string and seperated by delimiter.
+ * Appends a name to a string and seperated by delimiter.
* does the right thing for an empty string
*
* @param string $str the string to be appended to
}
/**
- * determine if the string is composed only of ascii characters
+ * Determine if the string is composed only of ascii characters
*
* @param string $str input string
* @param boolean $utf8 attempt utf8 match on failure (default yes)
}
/**
- * determine the string replacements for redaction
+ * Determine the string replacements for redaction
* on the basis of the regular expressions
*
* @param string $str input string
}
/**
- * determine if two href's are equivalent (fuzzy match)
+ * Determine if two href's are equivalent (fuzzy match)
*
* @param string $url1 the first url to be matched
* @param string $url2 the second url to be matched against
}
/**
- * extract variable values
+ * Extract variable values
*
* @param mix $query this is basically url
*
}
/**
- * translate a true/false/yes/no string to a 0 or 1 value
+ * Translate a true/false/yes/no string to a 0 or 1 value
*
* @param string $str the string to be translated
*
}
/**
- * returns string '1' for a true/yes/1 string, and '0' for no/false/0 else returns false
+ * Returns string '1' for a true/yes/1 string, and '0' for no/false/0 else returns false
*
* @param string $str the string to be translated
*
}
/**
- * strip leading, trailing, double spaces from string
+ * Strip leading, trailing, double spaces from string
* used for postal/greeting/addressee
*
* @param string $string input string to be cleaned
}
/**
- * this function will mask part of the the user portion of an Email address (everything before the @)
+ * This function will mask part of the the user portion of an Email address (everything before the @)
*
* @param string $email the email address to be masked
* @param string $maskChar the character used for masking
}
/**
- * this function compares two strings
+ * This function compares two strings
*
* @param string $strOne string one
* @param string $strTwo string two
}
/**
- * @param $peopleID
+ * @param int $peopleID
*
* @return array
*/
}
/**
- * clean url, replaces first '&' with '?'
+ * Clean url, replaces first '&' with '?'
*
* @param string $url
*
*/
abstract class CRM_Utils_System_Base {
/**
- * deprecated property to check if this is a drupal install. The correct method is to have functions on the UF classes for all UF specific
+ * Deprecated property to check if this is a drupal install. The correct method is to have functions on the UF classes for all UF specific
* functions and leave the codebase oblivious to the type of CMS
* @deprecated
* @var bool
var $is_drupal = FALSE;
/**
- * deprecated property to check if this is a joomla install. The correct method is to have functions on the UF classes for all UF specific
+ * Deprecated property to check if this is a joomla install. The correct method is to have functions on the UF classes for all UF specific
* functions and leave the codebase oblivious to the type of CMS
* @deprecated
* @var bool
var $supports_form_extensions = FALSE;
/**
- * if we are using a theming system, invoke theme, else just print the
+ * If we are using a theming system, invoke theme, else just print the
* content
*
* @param string $content the content that will be themed
/**
* Determine the native ID of the CMS user
*
- * @param $username
+ * @param string $username
*
* @throws CRM_Core_Exception
* @return int|NULL
function getLoggedInUniqueIdentifier() {}
/**
- * return a UFID (user account ID from the UserFramework / CMS system being based on the user object
+ * Return a UFID (user account ID from the UserFramework / CMS system being based on the user object
* passed, defaulting to the logged in user if not passed. Note that ambiguous situation occurs
* in CRM_Core_BAO_UFMatch::synchronize - a cleaner approach would seem to be resolving the user id before calling
* the function
}
/**
- * return a unique identifier (usually an email address or username) from the UserFramework / CMS system being based on the user object
+ * Return a unique identifier (usually an email address or username) from the UserFramework / CMS system being based on the user object
* passed, defaulting to the logged in user if not passed. Note that ambiguous situation occurs
* in CRM_Core_BAO_UFMatch::synchronize - a cleaner approach would seem to be resolving the unique identifier before calling
* the function
}
/**
- * output code from error function
+ * Output code from error function
* @param string $content
*/
function outputError($content) {
class CRM_Utils_System_Drupal extends CRM_Utils_System_DrupalBase {
/**
- * create a user in Drupal.
+ * Create a user in Drupal.
*
* @param array $params associated array
* @param string $mail email id for cms user
* @param string $ufName User name
*/
/**
- * @param $ufID
- * @param $ufName
+ * @param int $ufID
+ * @param string $ufName
*/
function updateCMSName($ufID, $ufName) {
// CRM-5555
/**
- * sets the title of the page
+ * Sets the title of the page
*
* @param string $title
* @param null $pageTitle
}
/**
- * rewrite various system urls to https
+ * Rewrite various system urls to https
*
* @param null
*
}
/**
- * figure out the post url for the form
+ * Figure out the post url for the form
*
* @param mix $action the default action if one is pre-specified
*
* Load user into session
*/
/**
- * @param $username
+ * @param string $username
*
* @return bool
*/
/**
* Determine the native ID of the CMS user
*
- * @param $username
+ * @param string $username
* @return int|NULL
*/
function getUfId($username) {
}
/**
- * load drupal bootstrap
+ * Load drupal bootstrap
*
* @param array $params Either uid, or name & pass.
* @param boolean $loadUser boolean Require CMS user load.
}
/**
- * check is user logged in.
+ * Check is user logged in.
*
* @return boolean true/false.
*/
class CRM_Utils_System_Drupal6 extends CRM_Utils_System_DrupalBase {
/**
- * if we are using a theming system, invoke theme, else just print the
+ * If we are using a theming system, invoke theme, else just print the
* content
*
* @param string $content the content that will be themed
}
/**
- * create a user in Drupal.
+ * Create a user in Drupal.
*
* @param array $params associated array
* @param string $mail email id for cms user
* @param string $ufName User name
*/
/**
- * @param $ufID
- * @param $ufName
+ * @param int $ufID
+ * @param string $ufName
*/
function updateCMSName($ufID, $ufName) {
// CRM-5555
}
/**
- * get the drupal destination string. When this is passed in the
+ * Get the drupal destination string. When this is passed in the
* URL the user will be directed to it after filling in the drupal form
*
* @param CRM_Core_Form $form Form object representing the 'current' form - to which the user will be returned
}
/**
- * sets the title of the page
+ * Sets the title of the page
*
* @param string $title
* @param null $pageTitle
}
/**
- * rewrite various system urls to https
+ * Rewrite various system urls to https
*
* @param null
*
}
/**
- * figure out the post url for the form
+ * Figure out the post url for the form
*
* @param mix $action the default action if one is pre-specified
*
/**
* Determine the native ID of the CMS user
*
- * @param $username
+ * @param string $username
* @return int|NULL
*/
function getUfId($username) {
}
/**
- * load drupal bootstrap
+ * Load drupal bootstrap
*
* @param array $params Either uid, or name & pass.
* @param boolean $loadUser boolean Require CMS user load.
}
/**
- * check is user logged in.
+ * Check is user logged in.
*
* @return boolean true/false.
*/
class CRM_Utils_System_Drupal8 extends CRM_Utils_System_DrupalBase {
/**
- * create a user in Drupal.
+ * Create a user in Drupal.
*
* @param array $params associated array
* @param string $mail email id for cms user
}
/**
- * get the drupal destination string. When this is passed in the
+ * Get the drupal destination string. When this is passed in the
* URL the user will be directed to it after filling in the drupal form
*
* @param CRM_Core_Form $form Form object representing the 'current' form - to which the user will be returned
/**
- * sets the title of the page
+ * Sets the title of the page
*
* @param string $title
* @param string $pageTitle
/**
* Determine the native ID of the CMS user
*
- * @param $username
+ * @param string $username
* @return int|NULL
*/
function getUfId($username) {
}
/**
- * load drupal bootstrap
+ * Load drupal bootstrap
*
* @param array $params Either uid, or name & pass.
* @param boolean $loadUser boolean Require CMS user load.
}
/**
- * figure out the post url for the form
+ * Figure out the post url for the form
*
* @param mix $action the default action if one is pre-specified
*
}
/**
- * create a user of Joomla.
+ * Create a user of Joomla.
*
* @param array $params associated array
* @param string $mail email id for cms user
}
/**
- * sets the title of the page
+ * Sets the title of the page
*
* @param string $title title to set
* @param string $pageTitle
}
/**
- * rewrite various system urls to https
+ * Rewrite various system urls to https
*
* @return void
* access public
}
/**
- * figure out the post url for the form
+ * Figure out the post url for the form
*
* @param $action the default action if one is pre-specified
*
}
/**
- * set the email address of the user
+ * Set the email address of the user
*
* @param object $user handle to the user object
*
}
/**
- * load joomla bootstrap
+ * Load joomla bootstrap
*
* @param $params array with uid or name and password
* @param $loadUser boolean load cms user?
}
/**
- * check is user logged in.
+ * Check is user logged in.
*
* @return boolean true/false.
*/
}
/**
- * output code from error function
+ * Output code from error function
* @param string $content
*/
function outputError($content) {
static $ufClass = NULL;
/**
- * sets the title of the page
+ * Sets the title of the page
*
* @param string $title title for page
* @param $pageTitle
}
/**
- * given a permission string, check for access requirements
+ * Given a permission string, check for access requirements
*
* @param string $str the permission to check
*
}
/**
- * figure out the post url for the form
+ * Figure out the post url for the form
*
* @param the default action if one is pre-specified
*
}
/**
- * set the email address of the user
+ * Set the email address of the user
*
* @param object $user handle to the user object
*
}
/**
- * sets the title of the page
+ * Sets the title of the page
*
* @param string $title
* @param null $pageTitle
}
/**
- * figure out the post url for the form
+ * Figure out the post url for the form
*
* @param mix $action the default action if one is pre-specified
*
}
/**
- * rewrite various system urls to https
+ * Rewrite various system urls to https
*
* @param null
*
}
/**
- * figure out the post url for the form
+ * Figure out the post url for the form
*
* @param mix $action the default action if one is pre-specified
*
}
/**
- * load wordpress bootstrap
+ * Load wordpress bootstrap
*
* @param $name string optional username for login
* @param $pass string optional password for login
}
/**
- * check is user logged in.
+ * Check is user logged in.
*
* @return boolean true/false.
*/
}
/**
- * get timezone as a string
+ * Get timezone as a string
* @return string Timezone e.g. 'America/Los_Angeles'
*/
function getTimeZoneString() {
static private $_delta = 0;
/**
- * get the time
+ * Get the time
*
* @param string $returnFormat format in which date is to be retrieved
*
}
/**
- * set the given time
+ * Set the given time
*
* @param string $newDateTime a date formatted with strtotime
* @param string $returnFormat format in which date is to be retrieved
}
/**
- * get< the regex for token replacement
+ * Get< the regex for token replacement
*
* @param string $token_type a string indicating the the type of token to be used in the expression
*
}
/**
- * escape the string so a malicious user cannot inject smarty code into the template
+ * Escape the string so a malicious user cannot inject smarty code into the template
*
* @param string $string a string that needs to be escaped from smarty parsing
*
}
/**
- * gives required details of contacts in an indexed array format so we
+ * Gives required details of contacts in an indexed array format so we
* can iterate in a nice loop and do token evaluation
*
* @param $contactIDs
}
/**
- * gives required details of contribuion in an indexed array format so we
+ * Gives required details of contribuion in an indexed array format so we
* can iterate in a nice loop and do token evaluation
*
* @param array $contributionIDs
return $memberships['values'];
}
/**
- * replace greeting tokens exists in message/subject
+ * Replace greeting tokens exists in message/subject
*
* @access public
*/
}
/**
- * store membership tokens on the static _tokens array
+ * Store membership tokens on the static _tokens array
*/
protected static function _buildMembershipTokens() {
$key = 'membership';
/**
* Constructor for the tree.
*
- * @param $nodeName
+ * @param string $nodeName
*
* @internal param string $rootNode
*
}
/**
- * check if node is a leaf node.
+ * Check if node is a leaf node.
* Currently leaf nodes are strings and non-leaf nodes are arrays
*
* @param array(
}
/**
- * print the tree
+ * Print the tree
*
* @param none
*
static $SIGNABLE_FIELDS = array('reset', 'dao', 'idName', 'url', 'filter'); // 'id','src','dst','dir'
/**
- * correct duplicate weight entries by putting them (duplicate weights) in sequence.
+ * Correct duplicate weight entries by putting them (duplicate weights) in sequence.
*
* @param string $daoName full name of the DAO
* @param array $fieldValues field => value to be used in the WHERE
*
* @param string $daoName full name of the DAO
* $param integer $weight the weight to be removed
- * @param $fieldID
+ * @param int $fieldID
* @param array $fieldValues field => value to be used in the WHERE
* @param string $weightField field which contains the weight value,
* defaults to 'weight'
}
/**
- * returns the new calculated weight.
+ * Returns the new calculated weight.
*
* @param string $daoName full name of the DAO
* @param array $fieldValues field => value to be used in the WHERE
}
/**
- * returns the highest weight.
+ * Returns the highest weight.
*
* @param string $daoName full name of the DAO
* @param array $fieldValues field => value to be used in the WHERE
}
/**
- * returns the default weight ( highest weight + 1 ) to be used.
+ * Returns the default weight ( highest weight + 1 ) to be used.
*
* @param string $daoName full name of the DAO
* @param array $fieldValues field => value to be used in the WHERE
/**
* @param $rows
* @param string $daoName
- * @param $idName
+ * @param string $idName
* @param $returnURL
* @param null $filter
*/
}
/**
- * @param $name
+ * @param string $name
* @return bool
*/
public function is_set($name) {
*/
function civicrm_api3_address_create(&$params) {
/**
- * if street_parsing, street_address has to be parsed into
+ * If street_parsing, street_address has to be parsed into
* separate parts
*/
if (array_key_exists('street_parsing', $params)) {
* @param bool $dupeCheck
* @param bool $dupeErrorArray
* @param bool $obsoletevalue
- * @param null $dedupeRuleGroupID
+ * @param int $dedupeRuleGroupID
*
* @return null
* @throws API_Exception
*/
/**
* @param $event
- * @param $event_id
+ * @param int $event_id
*/
function _civicrm_api3_event_getisfull(&$event, $event_id) {
$eventFullResult = CRM_Event_BAO_Participant::eventFull($event_id, 1);
/**
* @param $type
- * @param $contactID
+ * @param int $contactID
* @param $offset
* @param $limit
* @param $selectFields
}
/**
- * @param $contactID
+ * @param int $contactID
* @param $offset
* @param $limit
* @param $sort
}
/**
- * @param $contactID
+ * @param int $contactID
* @param $offset
* @param $limit
* @param $sort
* as stable as possible
*
* @param array $params parameters passed into get function
- * @param $membershipTypeId
+ * @param int $membershipTypeId
* @param $activeOnly
*
* @return array result for calling function
*
* @param array $params parameters passed into get function
* @param $membershipValues
- * @param $contactID
+ * @param int $contactID
*
* @return array result for calling function
*/
* This API is used for deriving Membership Status of a given Membership
* record using the rules encoded in the membership_status table.
*
- * @param $membershipParams
+ * @param array $membershipParams
*
* @throws API_Exception
*
}
/**
- * @param $pledgeId
- * @param $paymentStatusId
+ * @param int $pledgeId
+ * @param int $paymentStatusId
* @param $paymentIds
*
* @return mixed
* @todo this should be handled by the api wrapper using getfields info - need to check
* how we add a a pseudoconstant to this pseudo api to make that work
*
- * @param $profileID
+ * @param int $profileID
*
* @return integer|string
* @throws CiviCRM_API3_Exception
* Function to do a 'standard' api del - when the api is only doing a $bao::del then use this
* if api::del doesn't exist it will try DAO delete method
*
- * @param $bao_name
+ * @param string $bao_name
* @param array $params
*
* @return array API result array
*
* @param array $returnArray - array to append custom data too - generally $result[4] where 4 is the entity id.
* @param string $entity e.g membership, event
- * @param $entity_id
+ * @param int $entity_id
* @param int $groupID - per CRM_Core_BAO_CustomGroup::getTree
* @param int $subType e.g. membership_type_id where custom data doesn't apply to all membership types
* @param string $subName - Subtype of entity
* we accept 'whatever strtotime accepts'
*
* @param string $dateValue
- * @param $fieldName
+ * @param string $fieldName
* @param $fieldType
*
* @throws Exception
}
/**
- * @param $name
+ * @param string $name
* @param $buffer
*/
function civicrm_write_file($name, &$buffer) {
/**
* @param $dsn
- * @param $fileName
+ * @param string $fileName
* @param bool $lineMode
*/
function civicrm_source($dsn, $fileName, $lineMode = FALSE) {
}
/**
- * @param $funcName
+ * @param string $funcName
* @param $testDetails
*
* @return bool
}
/**
- * @param $filename
+ * @param string $filename
* @param $testDetails
* @param bool $absolute
*/
}
/**
- * @param $filename
+ * @param string $filename
* @param $testDetails
*/
function requireNoFile($filename, $testDetails) {
}
/**
- * @param $filename
+ * @param string $filename
* @param $testDetails
*/
function moveFileOutOfTheWay($filename, $testDetails) {
}
/**
- * @param $filename
+ * @param string $filename
* @param $testDetails
* @param bool $absolute
*/
}
/**
- * @param $moduleName
+ * @param string $moduleName
* @param $testDetails
*/
function requireApacheModule($moduleName, $testDetails) {
/**
* @param $server
- * @param $username
+ * @param string $username
* @param $password
* @param $testDetails
*/
/**
* @param $server
- * @param $username
+ * @param string $username
* @param $password
* @param $database
* @param $testDetails
/**
* @param $server
- * @param $username
+ * @param string $username
* @param $password
* @param $database
* @param $testDetails
/**
* @param $server
- * @param $username
+ * @param string $username
* @param $password
* @param $database
* @param $testDetails
/**
* @param $server
- * @param $username
+ * @param string $username
* @param $password
* @param $database
* @param $testDetails
/**
* @param $server
- * @param $username
+ * @param string $username
* @param $password
* @param $testDetails
*/
/**
* @param $server
- * @param $username
+ * @param string $username
* @param $password
* @param $database
* @param $minValueKB
/**
* @param $server
- * @param $username
+ * @param string $username
* @param $password
* @param $database
* @param $testDetails
static private $_singleton = NULL;
/**
- * singleton function used to manage this object
+ * Singleton function used to manage this object
*
* @param string $mode the mode of operation: live or test
* @param array $paymentProcessor the details of the payment processor being invoked
}
/**
- * testcases for create() method
+ * Testcases for create() method
* create() method Add/Edit activity.
*/
function testCreate() {
}
/**
- * testcase for getContactActivity() method.
+ * Testcase for getContactActivity() method.
* getContactActivity() method get activities detail for given target contact id
*/
function testGetContactActivity() {
}
/**
- * testcase for retrieve() method.
+ * Testcase for retrieve() method.
* retrieve($params, $defaults) method return activity detail for given params
* and set defaults.
*/
}
/**
- * testcase for deleteActivity() method.
+ * Testcase for deleteActivity() method.
* deleteActivity($params) method deletes activity for given params.
*/
function testDeleteActivity() {
}
/**
- * testcase for deleteActivityTarget() method.
+ * Testcase for deleteActivityTarget() method.
* deleteActivityTarget($activityId) method deletes activity target for given activity id.
*/
function testDeleteActivityTarget() {
}
/**
- * testcase for deleteActivityAssignment() method.
+ * Testcase for deleteActivityAssignment() method.
* deleteActivityAssignment($activityId) method deletes activity assignment for given activity id.
*/
function testDeleteActivityAssignment() {
}
/**
- * test getActivitiesCount BAO method
+ * Test getActivitiesCount BAO method
*/
function testGetActivitiesCountforAdminDashboard() {
$op = new PHPUnit_Extensions_Database_Operation_Insert();
}
/**
- * test getActivitiesCount BAO method
+ * Test getActivitiesCount BAO method
*/
function testGetActivitiesCountforNonAdminDashboard() {
$op = new PHPUnit_Extensions_Database_Operation_Insert();
}
/**
- * test getActivitiesCount BAO method
+ * Test getActivitiesCount BAO method
*/
function testGetActivitiesCountforContactSummary() {
$op = new PHPUnit_Extensions_Database_Operation_Insert();
}
/**
- * Function to test getActivitiesCount BAO method
+ * Test getActivitiesCount BAO method
*/
function testGetActivitiesCountforContactSummaryWithNoActivities() {
$op = new PHPUnit_Extensions_Database_Operation_Insert();
}
/**
- * Function to test getActivities BAO method
+ * Test getActivities BAO method
*/
function testGetActivitiesforAdminDashboard() {
$op = new PHPUnit_Extensions_Database_Operation_Insert();
}
/**
- * Function to test getActivities BAO method
+ * Test getActivities BAO method
*/
function testGetActivitiesforNonAdminDashboard() {
$op = new PHPUnit_Extensions_Database_Operation_Insert();
}
/**
- * Function to test getActivities BAO method
+ * Test getActivities BAO method
*/
function testGetActivitiesforContactSummary() {
$op = new PHPUnit_Extensions_Database_Operation_Insert();
}
/**
- * Function to test getActivities BAO method
+ * Test getActivities BAO method
*/
function testGetActivitiesforContactSummaryWithNoActivities() {
$op = new PHPUnit_Extensions_Database_Operation_Insert();
}
}
/**
- * data provider for test process membership
+ * Data provider for test process membership
* @return array
*/
function getMembershipData() {
}
/**
- * test case for add( )
+ * Test case for add( )
* test with empty params.
*/
function testAddWithEmptyParams() {
}
/**
- * test case for add( )
+ * Test case for add( )
* test with names
* (create and update modes)
*/
}
/**
- * test case for add( )
+ * Test case for add( )
* test with all contact params
* (creat and update modes)
*/
}
/**
- * test case for add( )
+ * Test case for add( )
* test with All contact types.
*/
function testAddWithAllContactTypes() {
}
/**
- * test case for create( )
+ * Test case for create( )
* test with missing params.
*/
function testCreateWithEmptyParams() {
}
/**
- * test case for create( )
+ * Test case for create( )
* test with all params.
* ( create and update modes ).
*/
}
/**
- * test case for resolveDefaults( )
+ * Test case for resolveDefaults( )
* test all pseudoConstant, stateProvince, country.
*/
function testResolveDefaults() {
}
/**
- * test case for retrieve( )
+ * Test case for retrieve( )
* test with all values.
*/
function testRetrieve() {
}
/**
- * test case for deleteContact( )
+ * Test case for deleteContact( )
*/
function testDeleteContact() {
$contactParams = $this->contactParams();
}
/**
- * test case for createProfileContac( )
+ * Test case for createProfileContac( )
* test with all params.
* ( create and update modes )
*/
}
/**
- * test case for getContactDetails( )
+ * Test case for getContactDetails( )
*/
function testGetContactDetails() {
//get the contact params
}
/**
- * test case for
+ * Test case for
* importableFields( ) and exportableFields( )
*/
function testFields() {
}
/**
- * test case for getPrimaryEmail( )
+ * Test case for getPrimaryEmail( )
*
*/
function testGetPrimaryEmail() {
}
/**
- * test case for getPrimaryOpenId( )
+ * Test case for getPrimaryOpenId( )
*
*/
function testGetPrimaryOpenId() {
}
/**
- * test case for matchContactOnEmail( )
+ * Test case for matchContactOnEmail( )
*
*/
function testMatchContactOnEmail() {
}
/**
- * test case for getContactType( )
+ * Test case for getContactType( )
*
*/
function testGetContactType() {
}
/**
- * test case for displayName( )
+ * Test case for displayName( )
*
*/
function testDisplayName() {
}
/**
- * test case for getDisplayAndImage( )
+ * Test case for getDisplayAndImage( )
*
*/
function testGetDisplayAndImage() {
// }
/**
- * build common params
+ * Build common params
*
*/
private function contactParams() {
}
/**
- * search with only type
+ * Search with only type
* success expected.
*/
function testSearchWithType() {
}
/**
- * search with only subtype
+ * Search with only subtype
* success expected.
*/
function testSearchWithSubype() {
}
/**
- * search with type as well as subtype
+ * Search with type as well as subtype
* success expected.
*/
function testSearchWithTypeSubype() {
}
/**
- * search with invalid type or subtype
+ * Search with invalid type or subtype
*/
function testSearchWithInvalidData() {
// for invalid type
}
/**
- * search with wrong type or subtype
+ * Search with wrong type or subtype
*/
function testSearchWithWrongdData() {
}
/**
- * methods create Contact with valid data
+ * Methods create Contact with valid data
* success expected
*
*/
}
/**
- * update the contact with no subtype to a valid subtype
+ * Update the contact with no subtype to a valid subtype
* success expected
*/
function testUpdateContactNosubtypeToValid() {
}
/**
- * update the contact with subtype to another valid subtype
+ * Update the contact with subtype to another valid subtype
* success expected
*/
function testUpdateContactSubtype() {
}
/**
- * test contactTypes() and subTypes() methods with valid data
+ * Test contactTypes() and subTypes() methods with valid data
* success expected
*/
function testGetMethods() {
}
/**
- * test subTypes() methods with invalid data
+ * Test subTypes() methods with invalid data
*/
function testGetMethodsInvalid() {
}
/**
- * test add() methods with valid data
+ * Test add() methods with valid data
* success expected
*/
function testAdd() {
}
/**
- * test add() with invalid data
+ * Test add() with invalid data
*/
function testAddInvalid1() {
}
/**
- * test del() with valid data
+ * Test del() with valid data
* success expected
*/
function testDel() {
}
/**
- * test del() with invalid data
+ * Test del() with invalid data
*/
function testDelInvalid() {
}
/**
- * methods create relationshipType with valid data
+ * Methods create relationshipType with valid data
* success expected
*
*/
}
/**
- * methods create relationshipe within same contact type with invalid Relationships
+ * Methods create relationshipe within same contact type with invalid Relationships
*
*/
function testRelationshipCreateInvalidWithinSameType() {
}
/**
- * methods create relationshipe within diff contact type with invalid Relationships
+ * Methods create relationshipe within diff contact type with invalid Relationships
*
*/
function testRelCreateInvalidWithinDiffTypeSpocorIndivi() {
}
/**
- * methods create relationshipe within same contact type with valid data
+ * Methods create relationshipe within same contact type with valid data
* success expected
*
*/
}
/**
- * methods create relationshipe within different contact type with valid data
+ * Methods create relationshipe within different contact type with valid data
* success expected
*
*/
protected function tearDown() {}
/**
- * test case for add( )
+ * Test case for add( )
*/
function testAdd() {
}
/**
- * test case for getGroupId( )
+ * Test case for getGroupId( )
*/
function testGetGroupId() {
}
/**
- * test case for add( )
+ * Test case for add( )
*/
function testAddSimple() {
}
/**
- * create() method (create Contribution Page)
+ * Create() method (create Contribution Page)
*/
function testCreate() {
}
/**
- * test setValues() method
+ * Test setValues() method
*/
function testSetValues() {
}
/**
- * test copy() method
+ * Test copy() method
*/
function testcopy() {
$params = array(
}
/**
- * test checkRecurPaymentProcessor() method
+ * Test checkRecurPaymentProcessor() method
*/
function testcheckRecurPaymentProcessor() {
//@todo paypalpro create seems to fail silently without causing this class to fail
}
/**
- * test that an object can be retrieved & saved (per CRM-14986)
+ * Test that an object can be retrieved & saved (per CRM-14986)
* this has been causing a DB error so we are checking for absence of error
*/
function testFindSave() {
}
/**
- * test cancellation works per CRM-14986
+ * Test cancellation works per CRM-14986
* we are checking for absence of error
*/
function testCancelRecur() {
}
/**
- * create() method (create and update modes)
+ * Create() method (create and update modes)
*/
function testCreate() {
$contactId = Contact::createIndividual();
}
/**
- * create() method with custom data
+ * Create() method with custom data
*/
function testCreateWithCustomData() {
$contactId = Contact::createIndividual();
}
/**
- * deleteContribution() method
+ * DeleteContribution() method
*/
function testDeleteContribution() {
$contactId = Contact::createIndividual();
}
/**
- * create honor-contact method
+ * Create honor-contact method
*/
function testcreateAndGetHonorContact() {
$firstName = 'John_' . substr(sha1(rand()), 0, 7);
}
/**
- * display sort name during
+ * Display sort name during
* contribution batch update through profile
* sortName();
*/
}
/**
- * check method add()
+ * Check method add()
*/
function testAdd() {
$params = array(
}
/**
- * check method retrive()
+ * Check method retrive()
*/
function testRetrieve() {
$params = array(
}
/**
- * check method setIsActive()
+ * Check method setIsActive()
*/
function testSetIsActive() {
$params = array(
}
/**
- * check method del()
+ * Check method del()
*/
function testdel() {
$params = array(
}
/**
- * check method add()
+ * Check method add()
*/
function testAdd() {
$ids = array();
}
/**
- * check method retrieve( )
+ * Check method retrieve( )
*/
function testRetrieve() {
$ids = array();
}
/**
- * check method setIsActive( )
+ * Check method setIsActive( )
*/
function testSetIsActive() {
$ids = array();
}
/**
- * check method del( )
+ * Check method del( )
*/
function testDel() {
$ids = array();
}
/**
- * create() method (create and update modes)
+ * Create() method (create and update modes)
*/
function testCreate() {
$contactId = Contact::createIndividual();
}
/**
- * getValues() method (get Address fields)
+ * GetValues() method (get Address fields)
*/
function testGetValues() {
$contactId = Contact::createIndividual();
}
/**
- * parseStreetAddress() method (get street address parsed)
+ * ParseStreetAddress() method (get street address parsed)
*/
function testParseStreetAddress() {
}
/**
- * test getTree()
+ * Test getTree()
*/
function testGetTree() {
$params = array();
}
/**
- * test retrieve() with Empty Params
+ * Test retrieve() with Empty Params
*/
function testRetrieveEmptyParams() {
$params = array();
}
/**
- * test retrieve() with Inalid Params
+ * Test retrieve() with Inalid Params
*/
function testRetrieveInvalidParams() {
$params = array('id' => 99);
}
/**
- * Function to test retrieve()
+ * Test retrieve()
*/
function testRetrieve() {
$customGrouptitle = 'My Custom Group';
}
/**
- * Function to test setIsActive()
+ * Test setIsActive()
*/
function testSetIsActive() {
$customGrouptitle = 'My Custom Group';
}
/**
- * Function to test getGroupDetail() with Empty Params
+ * Test getGroupDetail() with Empty Params
*/
function testGetGroupDetailEmptyParams() {
$customGroupId = array();
}
/**
- * Function to test getGroupDetail() with Inalid Params
+ * Test getGroupDetail() with Inalid Params
*/
function testGetGroupDetailInvalidParams() {
$customGroupId = 99;
}
/**
- * Function to test getGroupDetail()
+ * Test getGroupDetail()
*/
function testGetGroupDetail() {
$customGrouptitle = 'My Custom Group';
}
/**
- * Function to test getTitle() with Invalid Params()
+ * Test getTitle() with Invalid Params()
*/
function testGetTitleWithInvalidParams() {
$params = 99;
}
/**
- * Function to test getTitle()
+ * Test getTitle()
*/
function testGetTitle() {
$customGrouptitle = 'My Custom Group';
}
/**
- * Function to test deleteGroup()
+ * Test deleteGroup()
*/
function testDeleteGroup() {
$customGrouptitle = 'My Custom Group';
}
/**
- * Function to test createTable()
+ * Test createTable()
*/
function testCreateTable() {
$customGrouptitle = 'My Custom Group';
}
/**
- * Function to test checkCustomField()
+ * Test checkCustomField()
*/
function testCheckCustomField() {
$customGroupTitle = 'My Custom Group';
}
/**
- * Function to test getActiveGroups() with Invalid Params()
+ * Test getActiveGroups() with Invalid Params()
*/
function testGetActiveGroupsWithInvalidParams() {
$contactId = Contact::createIndividual();
}
/**
- * Function to test create()
+ * Test create()
*/
function testCreate() {
$params = array(
}
/**
- * Function to test create() given a table_name
+ * Test create() given a table_name
*/
function testCreateTableName() {
$params = array(
}
/**
- * Function to test isGroupEmpty()
+ * Test isGroupEmpty()
*/
function testIsGroupEmpty() {
$customGrouptitle = 'Test Custom Group';
}
/**
- * Function to test getGroupTitles() with Invalid Params()
+ * Test getGroupTitles() with Invalid Params()
*/
function testgetGroupTitlesWithInvalidParams() {
$params = array(99);
}
/**
- * Function to test getGroupTitles()
+ * Test getGroupTitles()
*/
function testgetGroupTitles() {
$customGrouptitle = 'Test Custom Group';
/**
- * test store function for country
+ * Test store function for country
*
*/
function testStoreCountry() {
}
/**
- * test store function for file
+ * Test store function for file
*
*/
function atestStoreFile() {
}
/**
- * test store function for state province
+ * Test store function for state province
*
*/
function testStoreStateProvince() {
}
/**
- * test store function for date
+ * Test store function for date
*
*/
function testStoreDate() {
}
/**
- * test getEntityValues function for stored value
+ * Test getEntityValues function for stored value
*
*/
function testgetEntityValues() {
}
/**
- * add() method (create and update modes)
+ * Add() method (create and update modes)
*/
function testAdd() {
$contactId = Contact::createIndividual();
}
/**
- * holdEmail() method (set and reset on_hold condition)
+ * HoldEmail() method (set and reset on_hold condition)
*/
function testHoldEmail() {
$contactId = Contact::createIndividual();
}
/**
- * allEmails() method - get all emails for our contact, with primary email first
+ * AllEmails() method - get all emails for our contact, with primary email first
*/
function testAllEmails() {
$contactParams = array(
}
/**
- * check method create()
+ * Check method create()
*/
function testCreate() {
$contactId = $this->individualCreate();
}
/**
- * add() method (create and update modes)
+ * Add() method (create and update modes)
*/
function testAdd() {
$contactId = Contact::createIndividual();
}
/**
- * create() method
+ * Create() method
* create various elements of location block
* without civicrm_loc_block entry
*/
}
/**
- * create() method
+ * Create() method
* create various elements of location block
* with civicrm_loc_block
*/
}
/**
- * deleteLocBlock() method
+ * DeleteLocBlock() method
* delete the location block
* created with various elements.
*
}
/**
- * getValues() method
+ * GetValues() method
* get the values of various location elements
*/
function testLocBlockgetValues() {
}
/**
- * add() method (create and update modes)
+ * Add() method (create and update modes)
*/
function testAdd() {
$contactId = Contact::createIndividual();
}
/**
- * ifAllowedToLogin() method (set and reset allowed_to_login)
+ * IfAllowedToLogin() method (set and reset allowed_to_login)
*/
function testIfAllowedToLogin() {
$contactId = Contact::createIndividual();
}
/**
- * allOpenIDs() method - get all OpenIDs for the given contact
+ * AllOpenIDs() method - get all OpenIDs for the given contact
*/
function testAllOpenIDs() {
$contactId = Contact::createIndividual();
}
/**
- * add() method (create and update modes)
+ * Add() method (create and update modes)
*/
function testAdd() {
$contactId = Contact::createIndividual();
}
/**
- * allPhones() method - get all Phones for our contact, with primary Phone first
+ * AllPhones() method - get all Phones for our contact, with primary Phone first
*/
function testAllPhones() {
$contactParams = array(
}
/**
- * allEntityPhones() method - get all Phones for a location block, with primary Phone first
+ * AllEntityPhones() method - get all Phones for a location block, with primary Phone first
* @todo FIXME: Fixing this test requires add helper functions in CiviTest to create location block and phone and link them to an event. Punting to 3.1 cycle. DGG
*/
function SKIPPED_testAllEntityPhones() {}
}
/**
- * test IPN response updates contribution_recur & contribution for first & second contribution
+ * Test IPN response updates contribution_recur & contribution for first & second contribution
*/
function testIPNPaymentRecurSuccess() {
$this->setupRecurringPaymentProcessorTransaction();
}
/**
- * test IPN response updates contribution_recur & contribution for first & second contribution
+ * Test IPN response updates contribution_recur & contribution for first & second contribution
*/
function testIPNPaymentMembershipRecurSuccess() {
$this->setupMembershipRecurringPaymentProcessorTransaction();
}
/**
- * create a single post dated payment as a recurring transaction.
+ * Create a single post dated payment as a recurring transaction.
*
* Test works but not both due to some form of caching going on in the SmartySingleton
*/
}
/**
- * create a single post dated payment as a recurring transaction
+ * Create a single post dated payment as a recurring transaction
*/
function testCreateSinglePostDated() {
$start_date = date('Ymd', strtotime("+ 1 week"));
}
/**
- * test IPN response updates contribution_recur & contribution for first & second contribution
+ * Test IPN response updates contribution_recur & contribution for first & second contribution
*/
function testIPNPaymentRecurSuccess() {
$this->setupRecurringPaymentProcessorTransaction();
}
/**
- * test IPN response updates contribution_recur & contribution for first & second contribution
+ * Test IPN response updates contribution_recur & contribution for first & second contribution
*/
function testIPNPaymentMembershipRecurSuccess() {
$this->setupMembershipRecurringPaymentProcessorTransaction();
}
/**
- * check a payment express IPN call does not throw any errors
+ * Check a payment express IPN call does not throw any errors
* At this stage nothing it supposed to happen so it's a pretty blunt test
* but at least it should be e-notice free
}
/**
- * get PaymentExpress IPN for a single transaction
+ * Get PaymentExpress IPN for a single transaction
* @return array array representing a Paypal IPN POST
*/
function getPaypalExpressTransactionIPN() {
}
/**
- * test the payment method is adequately logged - we don't expect the processing to succeed
+ * Test the payment method is adequately logged - we don't expect the processing to succeed
*/
function testHandlePaymentMethodLogging() {
$params = array('processor_name' => 'Paypal', 'data' => 'blah');
}
/**
- * retrieve() method of participant status type
+ * Retrieve() method of participant status type
*/
function testRetrieveStatusType() {
}
/**
- * setIsActive() method of participant status type
+ * SetIsActive() method of participant status type
*/
function testSetIsActiveStatusType() {
}
/**
- * add() method (add and edit modes of participant)
+ * Add() method (add and edit modes of participant)
*/
function testAdd() {
$params = array(
}
/**
- * getValues() method (fetch value of participant)
+ * GetValues() method (fetch value of participant)
*/
function testgetValuesWithValidParams() {
$participantId = Participant::create($this->_contactId, $this->_eventId);
}
/**
- * getValues() method (checking for behavior when params are empty )
+ * GetValues() method (checking for behavior when params are empty )
*/
function testgetValuesWithoutValidParams() {
$params = $values = $ids = array();
}
/**
- * eventFull() method (checking the event for full )
+ * EventFull() method (checking the event for full )
*/
function testEventFull() {
$eventParams = array(
}
/**
- * importableFields() method ( Checking the Event's Importable Fields )
+ * ImportableFields() method ( Checking the Event's Importable Fields )
*/
function testimportableFields() {
$importableFields = CRM_Event_BAO_Participant::importableFields();
}
/**
- * participantDetails() method ( Checking the Participant Details )
+ * ParticipantDetails() method ( Checking the Participant Details )
*/
function testparticipantDetails() {
$participantId = Participant::create($this->_contactId, $this->_eventId);
}
/**
- * deleteParticipant() method ( Delete a Participant )
+ * DeleteParticipant() method ( Delete a Participant )
*/
function testdeleteParticipant() {
$params = array(
}
/**
- * checkDuplicate() method ( Checking for Duplicate Participant returns array of participant id)
+ * CheckDuplicate() method ( Checking for Duplicate Participant returns array of participant id)
*/
function testcheckDuplicate() {
$duplicate = array();
}
/**
- * create() method (create and updation of participant)
+ * Create() method (create and updation of participant)
*/
function testCreate() {
$params = array(
}
/**
- * exportableFields() method ( Exportable Fields for Participant)
+ * ExportableFields() method ( Exportable Fields for Participant)
*/
function testexportableFields() {
$exportableFields = CRM_Event_BAO_Participant::exportableFields();
}
/**
- * fixEventLevel() method (Setting ',' values), resolveDefaults(assinging value to array) method
+ * FixEventLevel() method (Setting ',' values), resolveDefaults(assinging value to array) method
*/
function testfixEventLevel() {
/**
* @param $module
- * @param $name
+ * @param string $name
*/
public static function incHookCount($module, $name) {
global $_test_extension_manager_moduletest_counts;
}
/**
- * check method add()
+ * Check method add()
*/
function testAdd() {
$params = array(
}
/**
- * check method retrive()
+ * Check method retrive()
*/
function testRetrieve() {
$params = array(
}
/**
- * check method setIsActive()
+ * Check method setIsActive()
*/
function testSetIsActive() {
$params = array(
}
/**
- * check method del()
+ * Check method del()
*/
function testdel() {
$params = array(
}
/**
- * check method getAccountingCode()
+ * Check method getAccountingCode()
*/
function testGetAccountingCode() {
$params = array(
}
/**
- * check method add()
+ * Check method add()
*/
function testAdd() {
$firstName = 'Shane';
}
/**
- * check method retrive()
+ * Check method retrive()
*/
function testRetrieve() {
$firstName = 'Shane';
}
/**
- * check method create()
+ * Check method create()
*/
function testCreate() {
$firstName = 'Shane';
}
/**
- * check method del()
+ * Check method del()
*/
function testCreateEntityTrxn() {
$fParams = array(
}
/**
- * check method retrieveEntityFinancialTrxn()
+ * Check method retrieveEntityFinancialTrxn()
*/
function testRetrieveEntityFinancialTrxn() {
$entityTrxn = self::testCreateEntityTrxn();
}
/**
- * check method add()
+ * Check method add()
*/
function testAdd() {
$params = array(
}
/**
- * check method del()
+ * Check method del()
*/
function testDel() {
$params = array(
}
/**
- * check method getFinancialAccount()
+ * Check method getFinancialAccount()
*/
function testRetrieve() {
$params = array(
}
/**
- * check method getFinancialAccount()
+ * Check method getFinancialAccount()
*/
function testGetFinancialAccount() {
$params = array(
}
/**
- * check method getInstrumentFinancialAccount()
+ * Check method getInstrumentFinancialAccount()
*/
function testGetInstrumentFinancialAccount() {
$paymentInstrumentValue = 1;
}
/**
- * check method add()
+ * Check method add()
*/
function testAdd() {
$params = array(
}
/**
- * check method retrive()
+ * Check method retrive()
*/
function testRetrieve() {
$params = array(
}
/**
- * check method setIsActive()
+ * Check method setIsActive()
*/
function testSetIsActive() {
$params = array(
}
/**
- * check method del()
+ * Check method del()
*/
function testDel() {
$params = array(
}
/**
- * check method create()
+ * Check method create()
*/
function testCreate() {
$params = array(
}
/**
- * check method retrieve()
+ * Check method retrieve()
*/
function testRetrieve() {
$params = array(
}
/**
- * check method setIsActive()
+ * Check method setIsActive()
*/
function testSetIsActive() {
$params = array(
}
/**
- * check method getDefault()
+ * Check method getDefault()
*/
function testGetDefault() {
$params = array('is_default' => 1);
}
/**
- * check method del()
+ * Check method del()
*/
function testDel() {
$params = array(
$_REQUEST = $this->_params;
}
/**
- * retrieve groups as 'view all contacts'
+ * Retrieve groups as 'view all contacts'
*/
function testGroupListViewAllContacts() {
$this->setPermissionAndRequest('view all contacts');
}
/**
- * retrieve groups as 'view all contacts' permissioned user
+ * Retrieve groups as 'view all contacts' permissioned user
* Without setting params the default is both enabled & disabled
* (if you do set default it is enabled only)
*/
}
/**
- * retrieve groups as 'view all contacts'
+ * Retrieve groups as 'view all contacts'
*/
function testGroupListViewAllContactsNotFoundTitle() {
$this->_params['title'] = 'z';
$this->assertEquals(0, $total);
}
/**
- * retrieve groups as 'edit all contacts'
+ * Retrieve groups as 'edit all contacts'
*/
function testGroupListEditAllContacts() {
$this->setPermissionAndRequest('edit all contacts');
}
/**
- * retrieve groups as 'view all contacts'
+ * Retrieve groups as 'view all contacts'
*/
function testGroupListViewAllContactsEnabled() {
$this->_params['status'] = 1;
}
/**
- * retrieve groups as 'view all contacts'
+ * Retrieve groups as 'view all contacts'
*/
function testGroupListViewAllContactsDisabled() {
$this->_params['status'] = 2;
}
/**
- * retrieve groups as 'view all contacts'
+ * Retrieve groups as 'view all contacts'
*/
function testGroupListViewAllContactsDisabledNotFoundTitle() {
$this->_params['status'] = 2;
}
/**
- * retrieve groups as 'view all contacts'
+ * Retrieve groups as 'view all contacts'
*/
function testGroupListViewAllContactsDisabledFoundTitle() {
$this->_params['status'] = 2;
}
/**
- * retrieve groups as 'view all contacts'
+ * Retrieve groups as 'view all contacts'
*/
function testGroupListViewAllContactsAll() {
$this->_params['status'] = 3;
/**
- * retrieve groups as 'view all contacts'
+ * Retrieve groups as 'view all contacts'
*/
function testGroupListAccessCiviCRM() {
$this->setPermissionAndRequest('access CiviCRM');
$this->assertEquals(0, $total, 'Total returned should be accurate based on permissions');
}
/**
- * retrieve groups as 'view all contacts'
+ * Retrieve groups as 'view all contacts'
*/
function testGroupListAccessCiviCRMEnabled() {
$this->_params['status'] = 1;
$this->assertEquals(0, $total, 'Total returned should be accurate based on permissions');
}
/**
- * retrieve groups as 'view all contacts'
+ * Retrieve groups as 'view all contacts'
*/
function testGroupListAccessCiviCRMDisabled() {
$this->_params['status'] = 2;
}
/**
- * retrieve groups as 'view all contacts'
+ * Retrieve groups as 'view all contacts'
*/
function testGroupListAccessCiviCRMAll() {
$this->_params['status'] = 2;
}
/**
- * retrieve groups as 'view all contacts'
+ * Retrieve groups as 'view all contacts'
*/
function testGroupListAccessCiviCRMFound() {
$this->_params['title'] = 'p';
}
/**
- * retrieve groups as 'view all contacts'
+ * Retrieve groups as 'view all contacts'
*/
function testGroupListAccessCiviCRMNotFound() {
$this->_params['title'] = 'z';
/**
- * get the contribution
+ * Get the contribution
* page id from the membership record
*/
function testgetContributionPageId() {
}
/**
- * build params
+ * Build params
*
*/
private function pcpBlockParams() {
}
/**
- * build params
+ * Build params
*
*/
private function pcpParams() {
}
/**
- * add() method (add and edit modes of pledge block)
+ * Add() method (add and edit modes of pledge block)
*/
function testAddPledgeBlock() {
}
/**
- * retrieve() and getPledgeBlock() method of pledge block
+ * Retrieve() and getPledgeBlock() method of pledge block
*/
function testRetrieveAndGetPledgeBlock() {
* Implementation of hook_civicrm_post used with all our test cases
*
* @param $op
- * @param $objectName
- * @param $objectId
+ * @param string $objectName
+ * @param int $objectId
* @param $objectRef
*/
function onPost($op, $objectName, $objectId, &$objectRef) {
}
/**
- * test case for add( )
+ * Test case for add( )
* test with empty params.
*/
function testFormatRFC822() {
* Execute a basic XML test case. Each test case creates a custom-group and
* custom-field then compares the output to a pre-defined XML file.
*
- * @param $customGroupParams
- * @param $fieldParams
+ * @param array $customGroupParams
+ * @param array $fieldParams
* @param $expectedXmlFilePath
* @dataProvider basicXmlTestCases
*/
}
/**
- * @param $expectedBaseDirName
+ * @param string $expectedBaseDirName
* @param $dirs
* @param $files
*/
}
/**
- * @param $inputParams
+ * @param array $inputParams
* @param $expectedOptions
* @param $expectedData
* @param $expectedChains
/**
* @param $reportClass
- * @param $inputParams
+ * @param array $inputParams
*
* @return string
* @throws Exception
}
/**
- * @param $option_group_name
+ * @param string $option_group_name
*
* @return array|int
*/
* @param bool $pledges
* @param bool $recurring
* @param bool $membershipTypes
- * @param null $memPriceSetId
+ * @param int $memPriceSetId
* @param bool $friend
* @param int $profilePreId
* @param int $profilePostId
}
/**
- * update default strict rule.
+ * Update default strict rule.
*
* @param string $contactType
* @param array $fields Fields to be set for strict rule
// Request a record from the DB by id. Success if row not found.
/**
* @param string $daoName
- * @param $id
+ * @param int $id
* @param $message
*/
function assertDBRowNotExist($daoName, $id, $message) {
// Compare all values in a single retrieved DB record to an array of expected values
/**
* @param string $daoName
- * @param $searchParams
+ * @param array $searchParams
* @param $expectedValues
*/
function assertDBCompareValues($daoName, $searchParams, $expectedValues) {
}
/**
- * @param $name
+ * @param string $name
* @param $sku
* @param $amount
* @param $price
}
/**
- * type and select first occurance of autocomplete
+ * Type and select first occurance of autocomplete
*/
function select2($fieldName,$label, $multiple = FALSE, $xpath=FALSE) {
// In the case of chainSelect, wait for options to load
}
/**
- * select multiple options
+ * Select multiple options
*/
function multiselect2($fieldid, $params) {
// In the case of chainSelect, wait for options to load
}
/**
- * function to enable or disable Pop-ups via Display Preferences
+ * Enable or disable Pop-ups via Display Preferences
*/
function enableDisablePopups($enabled = TRUE) {
$this->openCiviPage('admin/setting/preferences/display', 'reset=1');
class CiviUnitTestCase extends PHPUnit_Extensions_Database_TestCase {
/**
- * api version - easier to override than just a define
+ * Api version - easier to override than just a define
*/
protected $_apiversion = API_LATEST_VERSION;
/**
}
/**
- * emulate a logged in user since certain functions use that
+ * Emulate a logged in user since certain functions use that
* value to store a record in the DB (like activity)
* CRM-8180
*/
// Request a record from the DB by id. Success if row not found.
/**
* @param string $daoName
- * @param $id
+ * @param int $id
* @param null $message
*/
function assertDBRowNotExist($daoName, $id, $message = NULL) {
// Request a record from the DB by id. Success if row not found.
/**
* @param string $daoName
- * @param $id
+ * @param int $id
* @param null $message
*/
function assertDBRowExist($daoName, $id, $message = NULL) {
// Compare all values in a single retrieved DB record to an array of expected values
/**
* @param string $daoName
- * @param $searchParams
+ * @param array $searchParams
* @param $expectedValues
*/
function assertDBCompareValues($daoName, $searchParams, $expectedValues) {
}
/**
- * check that api returned 'is_error' => 0
+ * Check that api returned 'is_error' => 0
* else provide full message
* @param array $apiResult api result
* @param string $prefix extra test to add to message
}
/**
- * check that api returned 'is_error' => 1
+ * Check that api returned 'is_error' => 1
* else provide full message
*
* @param array $apiResult api result
}
/**
- * check that a deleted item has been deleted
+ * Check that a deleted item has been deleted
*/
function assertAPIDeleted($entity, $id) {
$this->callAPISuccess($entity, 'getcount', array('id' => $id), 0);
/**
- * check that api returned 'is_error' => 1
+ * Check that api returned 'is_error' => 1
* else provide full message
* @param array $result
* @param $expected
}
/**
- * @param $contactID
+ * @param int $contactID
*
* @return array|int
*/
}
/**
- * @param $contactTypeId
+ * @param int $contactTypeId
*
* @throws Exception
*/
}
/**
- * delete Membership Type
+ * Delete Membership Type
*
* @param array $params
*/
}
/**
- * @param $membershipID
+ * @param int $membershipID
*/
function membershipDelete($membershipID) {
$deleteParams = array('id' => $membershipID);
}
/**
- * @param $membershipStatusID
+ * @param int $membershipStatusID
*/
function membershipStatusDelete($membershipStatusID) {
if (!$membershipStatusID) {
}
/**
- * delete Relatinship Type
+ * Delete Relatinship Type
*
* @param int $relationshipTypeID
*/
}
/**
- * @param null $params
+ * @param array $params
*
* @return mixed
*/
}
/**
- * create Participant
+ * Create Participant
*
* @param array $params array of contact id and event id values
*
}
/**
- * Function to create Payment Processor
+ * Create Payment Processor
*
* @return object of Payment Processsor
*/
}
/**
- * Function to create contribution page
+ * Create contribution page
*
* @param array $params
* @return object of contribution page
}
/**
- * Function to create Tag
+ * Create Tag
*
* @param array $params
* @return array result of created tag
}
/**
- * Function to delete Tag
+ * Delete Tag
*
* @param int $tagId id of the tag to be deleted
*/
}
/**
- * Function to create contribution
+ * Create contribution
*
* @param int $cID contact_id
*
}
/**
- * Function to delete contribution
+ * Delete contribution
*
* @param int $pledgeId
*/
}
/**
- * Function to create contribution
+ * Create contribution
*
* @param int $cID contact_id
* @param int $cTypeID id of financial type
}
/**
- * Function to create online contribution
+ * Create online contribution
*
* @param array $params
* @param int $financialType id of financial type
}
/**
- * Function to delete contribution
+ * Delete contribution
*
* @param int $contributionId
*
}
/**
- * Function to create an Event
+ * Create an Event
*
* @param array $params name-value pair for an event
*
}
/**
- * Function to delete event
+ * Delete event
*
* @param int $id ID of the event
*
}
/**
- * Function to delete participant
+ * Delete participant
*
* @param int $participantID
*
}
/**
- * Function to create participant payment
+ * Create participant payment
*
- * @param $participantID
- * @param null $contributionID
+ * @param int $participantID
+ * @param int $contributionID
* @return int $id of created payment
*/
function participantPaymentCreate($participantID, $contributionID = NULL) {
}
/**
- * Function to delete participant payment
+ * Delete participant payment
*
* @param int $paymentID
*/
}
/**
- * Function to add a Location
+ * Add a Location
*
- * @param $contactID
+ * @param int $contactID
* @return int location id of created location
*/
function locationAdd($contactID) {
}
/**
- * Function to delete Locations of contact
+ * Delete Locations of contact
*
* @param array $params parameters
*/
}
/**
- * Function to add a Location Type
+ * Add a Location Type
*
- * @param null $params
+ * @param array $params
* @return int location id of created location
*/
function locationTypeCreate($params = NULL) {
}
/**
- * Function to delete a Location Type
+ * Delete a Location Type
*
* @param int location type id
*/
}
/**
- * Function to add a Group
+ * Add a Group
*
* @param array $params
* @return int groupId of created group
}
/**
- * Function to delete a Group
+ * Delete a Group
*
* @param int $gid
*/
}
/**
- * Function to add a UF Join Entry
+ * Add a UF Join Entry
*
- * @param null $params
+ * @param array $params
* @return int $id of created UF Join
*/
function ufjoinCreate($params = NULL) {
}
/**
- * Function to delete a UF Join Entry
+ * Delete a UF Join Entry
*
* @param array with missing uf_group_id
*/
}
/**
- * Function to create Group for a contact
+ * Create Group for a contact
*
* @param int $contactId
*/
}
/**
- * Function to delete Group for a contact
+ * Delete Group for a contact
*
- * @param $contactId
+ * @param int $contactId
*/
function contactGroupDelete($contactId) {
$params = array(
}
/**
- * Function to create Activity
+ * Create Activity
*
* @param array $params
* @return array|int
}
/**
- * Function to create an activity type
+ * Create an activity type
*
* @param array $params parameters
*/
}
/**
- * Function to delete activity type
+ * Delete activity type
*
* @param int $activityTypeId id of the activity type
*/
}
/**
- * Function to create custom group
+ * Create custom group
*
* @param array $params
* @return array|int
}
/**
- * existing function doesn't allow params to be over-ridden so need a new one
+ * Existing function doesn't allow params to be over-ridden so need a new one
* this one allows you to only pass in the params you want to change
*/
function CustomGroupCreateByParams($params = array()) {
}
/**
- * Function to delete custom group
+ * Delete custom group
*
* @param int $customGroupID
*
}
/**
- * Function to create custom field
+ * Create custom field
*
* @param array $params (custom_group_id) is required
* @return array|int
}
/**
- * Function to delete custom field
+ * Delete custom field
*
* @param int $customFieldID
*
}
/**
- * Function to create note
+ * Create note
*
- * @param $cId
+ * @param int $cId
* @return array $note
*/
function noteCreate($cId) {
}
/**
- * Function to delete note
+ * Delete note
*
* @param array $params
*
}
/**
- * Function to create custom field with Option Values
+ * Create custom field with Option Values
*
* @param array $customGroup
* @param string $name name of custom field
*/
/**
* @param array $params
- * @param $id
+ * @param int $id
* @param $entity
* @param int $delete
* @param string $errorText
}
/**
- * Function to get formatted values in the actual and expected result
+ * Get formatted values in the actual and expected result
* @param array $actual actual calculated values
* @param array $expected expected values
*
}
/**
- * Function to unset the key 'id' from the array
+ * Unset the key 'id' from the array
* @param array $unformattedArray The array from which the 'id' has to be unset
*
*/
}
/**
- * @param $name
+ * @param string $name
*/
function financialAccountDelete($name) {
$financialAccount = new CRM_Financial_DAO_FinancialAccount();
}
/**
- * alter default price set so that the field numbers are not all 1 (hiding errors)
+ * Alter default price set so that the field numbers are not all 1 (hiding errors)
*/
function offsetDefaultPriceSet() {
$contributionPriceSet = $this->callAPISuccess('price_set', 'getsingle', array('name' => 'default_contribution_amount'));
}
/**
- * we don't have a good way to set up a recurring contribution with a membership so let's just do one then alter it
+ * We don't have a good way to set up a recurring contribution with a membership so let's just do one then alter it
*/
function setupMembershipRecurringPaymentProcessorTransaction() {
$this->ids['membership_type'] = $this->membershipTypeCreate();
* Helper function to create
* a contact of type Individual
*
- * @param null $params
+ * @param array $params
* @return int $contactID id of created Individual
*/
static function createIndividual($params = NULL) {
* Helper function to create
* a contact of type Household
*
- * @param null $params
+ * @param array $params
* @return mixed $contactID id of created Household
*/
static function createHousehold($params = NULL) {
* Helper function to create
* a contact of type Organisation
*
- * @param null $params
+ * @param array $params
* @return mixed $contactID id of created Organisation
*/
static function createOrganisation($params = NULL) {
* Helper function to create
* a Contribution Page
*
- * @param null $id
+ * @param int $id
*
* @return mixed $contributionPage id of created Contribution Page
*/
* Helper function to create
* an Event
*
- * @param $contactId
+ * @param int $contactId
*
* @return mixed $event id of created Event
*/
/**
* Helper function to create a Participant
*
- * @param $contactId
- * @param $eventId
+ * @param int $contactId
+ * @param int $eventId
*
* @return mixed $participant id of created Participant
*/
//moves a field from one field to another
/**
* @param $field_to_move
- * @param $from_group_id
- * @param $to_group_id
+ * @param int $from_group_id
+ * @param int $to_group_id
*/
function _moveCustomField($field_to_move, $from_group_id, $to_group_id) {
//go to the move field page
//Get all custom field values for a given contact and custom group id using the api
/**
- * @param $contact_id
- * @param $group_id
+ * @param int $contact_id
+ * @param int $group_id
* @param bool $reset_cache
*
* @return array
//Adds a new custom field to a specfied custom field group, using the given
//datatype and widget.
/**
- * @param $group_id
+ * @param int $group_id
* @param string $type
* @param string $widget
* @param string $prefix
//randomly generates data for a specific custom field
/**
- * @param $contact_id
- * @param $group_id
+ * @param int $contact_id
+ * @param int $group_id
*/
function _fillCustomDataForContact($contact_id, $group_id) {
//edit the given contact
/**
* @param $campaignTitle
- * @param $id
+ * @param int $id
*/
function activityAddTest($campaignTitle, $id) {
// Adding Adding contact with randomized first name for test testContactContextActivityAdd
}
/**
- * @param $groupName
+ * @param string $groupName
* @param $campaignTitle
- * @param $id
+ * @param int $id
*/
function mailingAddTest($groupName, $campaignTitle, $id) {
//---- create mailing contact and add to mailing Group
/**
* @param $campaignTitle
- * @param $id
+ * @param int $id
*/
function memberAddTest($campaignTitle, $id) {
//Add new memebershipType
/**
* @param $campaignTitle
- * @param $id
+ * @param int $id
* @param bool $past
*/
function offlineContributionTest($campaignTitle, $id, $past = FALSE) {
}
/**
- * @param $groupName
+ * @param string $groupName
*/
function pastCampaignsTest($groupName) {
$this->openCiviPage('campaign/add', 'reset=1', '_qf_Campaign_upload-bottom');
/**
* @param $campaignTitle
- * @param $id
+ * @param int $id
*/
function offlineParticipantAddTest($campaignTitle, $id) {
// connect campaign with event
/**
* @param $campaignTitle
- * @param $id
+ * @param int $id
*/
function onlineContributionAddTest($campaignTitle, $id) {
// Use default payment processor
/**
* @param $campaignTitle
- * @param $id
+ * @param int $id
*/
function onlineParticipantAddTest($campaignTitle, $id) {
// Use default payment processor
}
/**
- * @param $id
+ * @param int $id
* @param $eventTitle
* @param $eventDescription
*/
/**
* @param bool $discount
* @param bool $priceSet
- * @param $processorId
+ * @param int $processorId
*/
function _testAddFees($discount = FALSE, $priceSet = FALSE, $processorId) {
// Go to Fees tab
/**
* @param $campaignTitle
- * @param $id
+ * @param int $id
*/
function pledgeAddTest($campaignTitle, $id) {
// create unique name
$this->webtestVerifyTabularData($LinkCaseActivityData);
}
/**
- * @param $firstName
+ * @param string $firstName
* @param $caseSubject
* @param $customGroupTitle
* @param $contactName
/**
* @param $caseRoles
- * @param $creatorName
+ * @param string $creatorName
*/
function _testVerifyCaseRoles($caseRoles, $creatorName) {
$id = $this->urlArg('id');
}
/**
- * @param $firstName
- * @param $lastName
+ * @param string $firstName
+ * @param string $lastName
* @param $action
*/
function _testSearchbyDate($firstName, $lastName, $action) {
}
/**
- * @param $firstName
- * @param $lastName
+ * @param string $firstName
+ * @param string $lastName
* @param $caseTypeLabel
*
* test for assign case to another client
/**
* @param $customGrpId1
- * @param $customId
+ * @param int $customId
*/
function _testDeleteCustomData($customGrpId1, $customId) {
// delete all custom data
}
/**
- * @param $customId
- * @param $custFname
- * @param $custMname
+ * @param int $customId
+ * @param string $custFname
+ * @param string $custMname
* @param $custLname
*/
function _testAdvansearchCaseData($customId, $custFname, $custMname, $custLname) {
}
/**
- * @param $firstName
- * @param $lastName
+ * @param string $firstName
+ * @param string $lastName
*
* @return bool
*/
}
/**
- * @param $firstName
- * @param $lastName
+ * @param string $firstName
+ * @param string $lastName
* @param $options
*/
function _addIndividual($firstName, $lastName, $options) {
//function to check match for sumbit Advance Search
/**
- * @param $firstName
+ * @param string $firstName
*/
function submitSearch($firstName) {
$this->clickLink("_qf_Advanced_refresh");
// function to fill basic search detail
/**
- * @param $firstName
- * @param $groupName
+ * @param string $firstName
+ * @param string $groupName
* @param $tagName
*/
function addBasicSearchDetail($firstName, $groupName, $tagName) {
/**
* @param bool $discount
* @param bool $priceSet
- * @param $processorId
+ * @param int $processorId
*/
function _testAddFees($discount = FALSE, $priceSet = FALSE, $processorId) {
// Go to Fees tab
}
/**
- * @param $ContactName
- * @param $relatedName
+ * @param string $ContactName
+ * @param string $relatedName
* @param $relType
*/
function _testAddRelationship($ContactName, $relatedName, $relType) {
}
/**
- * @param $username
+ * @param string $username
* @param $password
* @param $confirm_password
*/
}
/**
- * @param $firstName
- * @param $lastName
+ * @param string $firstName
+ * @param string $lastName
* @param $email
- * @param $groupName
+ * @param string $groupName
* @param bool $deceased
*/
function _testAddContact($firstName, $lastName, $email, $groupName, $deceased = FALSE) {
}
/**
- * @param $roleid
+ * @param int $roleid
*
* @return string
*/
$this->assertTrue($this->isTextPresent("Staff, Student"));
}
/**
- * @param $firstName
- * @param $lastName
+ * @param string $firstName
+ * @param string $lastName
* @param $subject
*/
function addActivity($firstName, $lastName, $subject) {
/**
* @param $fields
- * @param $profileName
+ * @param string $profileName
*
* @return null
*/
/**
* @param $contactType
- * @param $name
+ * @param string $name
* @param $email
* @param null $streetName
* @param null $postalCode
/**
* @param $validateStrings
- * @param $sid
+ * @param int $sid
*/
function _testVerifyPriceSet($validateStrings, $sid) {
// verify Price Set at Preview page
}
/**
- * check CRM-7943
+ * Check CRM-7943
*/
function testContributionPageSeparatePayment() {
// open browser, login
}
/**
- * check CRM-7949
+ * Check CRM-7949
*/
function testContributionPageSeparatePaymentPayLater() {
// open browser, login
//common function for doing offline contribution
/**
* @param array $params
- * @param $firstName
- * @param $lastName
+ * @param string $firstName
+ * @param string $lastName
* @param $processorName
*/
function _doOfflineContribution($params, $firstName, $lastName, $processorName) {
}
/**
- * @param $pageId
- * @param $cid
+ * @param int $pageId
+ * @param int $cid
* @param $pageTitle
*/
function _testOrganization($pageId, $cid, $pageTitle) {
}
/**
- * @param $pageId
- * @param $cid
+ * @param int $pageId
+ * @param int $cid
* @param $pageTitle
*/
function _testAnomoyousOganization($pageId, $cid, $pageTitle) {
}
/**
- * @param $pageId
- * @param $cid
+ * @param int $pageId
+ * @param int $cid
* @param $pageTitle
*/
function _testUserWithOneRelationship($pageId, $cid, $pageTitle) {
}
/**
- * @param $pageId
- * @param $cid
+ * @param int $pageId
+ * @param int $cid
* @param $pageTitle
*/
function _testUserWithMoreThanOneRelationship($pageId, $cid, $pageTitle) {
}
/**
- * @param $pageId
- * @param $cid
+ * @param int $pageId
+ * @param int $cid
* @param $pageTitle
*/
function _testOrganizationWithImageUpload($pageId, $cid, $pageTitle) {
}
/**
- * @param $pageId
+ * @param int $pageId
* @param bool $priceSet
*/
function _doContributionAndVerifyData($pageId, $priceSet = FALSE) {
}
/**
- * @param $firstName
+ * @param string $firstName
*/
function _addParticipant($firstName) {
}
/**
- * @param $entityId
+ * @param int $entityId
* @param null $from
* @param null $to
* @param null $cost
}
/**
- * @param $contId
+ * @param int $contId
*
* @return null|string
*/function _getFinancialTrxnAmount($contId) {
}
/**
- * @param $contId
+ * @param int $contId
*
* @return null|string
*/function _getFinancialItemAmount($contId) {
}
/**
- * @param $contId
+ * @param int $contId
*
* @return null|string
*/function _getTotalContributedAmount($contId) {
}
/**
- * @param $name
+ * @param string $name
*/
function _tryPaymentProcessor($name) {
// load contribution page
}
/**
- * @param $id
+ * @param int $id
* @param $eventTitle
* @param $discount
*/
/**
* @param $eventTitle
* @param $eventDescription
- * @param $templateID
- * @param $eventTypeID
+ * @param int $templateID
+ * @param int $eventTypeID
*/
function _testAddEventInfoFromTemplate($eventTitle, $eventDescription, $templateID, $eventTypeID) {
$this->waitForElementPresent("_qf_EventInfo_upload-bottom");
}
/**
- * @param $contributionID
+ * @param int $contributionID
*/
function verifyFinancialRecords($contributionID) {
// check count for civicrm_contribution and civicrm_financial_item in civicrm_entity_financial_trxn
}
/**
- * @param $firstName
- * @param $lastName
- * @param $processorId
+ * @param string $firstName
+ * @param string $lastName
+ * @param int $processorId
*/
function _fillParticipantDetails($processorId) {
$contact = $this->createDialogContact();
/**
* @param $validateStrings
- * @param $sid
+ * @param int $sid
*/
function _testVerifyPriceSet($validateStrings, $sid) {
// verify Price Set at Preview page
}
/**
- * test to regiter participant for event with
+ * Test to regiter participant for event with
* multiple price fields in price-set
* CRM-11986
}
/**
- * @param $expectedLineItems
+ * @param array $expectedLineItems
*/
function _checkLineItems($expectedLineItems) {
foreach ($expectedLineItems as $lineKey => $lineValue) {
/**
* @param $feeAmt
- * @param $amtPaid
+ * @param int $amtPaid
*/
function _checkPaymentInfoTable($feeAmt, $amtPaid) {
$this->assertElementContainsText("xpath=//td[@id='payment-info']/table[@id='info']/tbody/tr[2]/td", "$ {$feeAmt}", 'Missing text: appropriate fee amount');
}
/**
- * @param $firstName
+ * @param string $firstName
*/
function addParticipant($firstName) {
$this->openCiviPage("participant/add", "reset=1&action=add&context=standalone", '_qf_Participant_upload-bottom');
}
/**
- * @param $firstName
- * @param $lastName
+ * @param string $firstName
+ * @param string $lastName
* @param $events
*/
function _checkContributionsandEventRegistration($firstName, $lastName, $events) {
}
/**
- * @param $eventPageId
+ * @param int $eventPageId
*/
function _testRemoveProfile($eventPageId) {
$this->openCiviPage("event/manage/settings", "reset=1&action=update&id=$eventPageId");
}
/**
- * @param $customId
+ * @param int $customId
*
* @return array
*/
}
/**
- * @param $profileId
+ * @param int $profileId
*
* @return null
*/
}
/**
- * @param $eventPageId
- * @param $customId
- * @param $firstName
- * @param $lastName
- * @param $participantfname
- * @param $participantlname
+ * @param int $eventPageId
+ * @param int $customId
+ * @param string $firstName
+ * @param string $lastName
+ * @param string $participantfname
+ * @param string $participantlname
* @param $email1
* @param $email2
*/
}
/**
- * @param $eventPageId
- * @param $customId
- * @param $firstName2
- * @param $lastName2
- * @param $participantfname2
+ * @param int $eventPageId
+ * @param int $customId
+ * @param string $firstName2
+ * @param string $lastName2
+ * @param string $participantfname2
* @param $participantlname2
* @param $email3
* @param $email4
}
/**
- * @param $cfId
+ * @param int $cfId
*/
function _removeEmailField($cfId) {
$this->openCiviPage("admin/uf/group/field", "action=delete&id={$cfId}");
}
/**
- * @param $processorName
+ * @param string $processorName
* @param $campaignType
- * @param null $contributionPageId
- * @param $firstName
- * @param $lastName
- * @param $middleName
+ * @param int $contributionPageId
+ * @param string $firstName
+ * @param string $lastName
+ * @param string $middleName
* @param $email
*/
function _testAddEventForPCP($processorName, $campaignType, $contributionPageId = NULL, $firstName, $lastName, $middleName, $email) {
/**
* @param $eventTitle
- * @param $pageId
- * @param $firstName
- * @param $lastName
- * @param $middleName
+ * @param int $pageId
+ * @param string $firstName
+ * @param string $lastName
+ * @param string $middleName
* @param $email
* @param int $numberRegistrations
* @param $campaignType
/**
* @param $campaignType
- * @param $contributionPageId
+ * @param int $contributionPageId
*
* @return null
*/
}
/**
- * @param $eventName
- * @param $lastNameDonar
- * @param $firstNameDonar
- * @param $firstNameCreator
- * @param $lastNameCreator
+ * @param string $eventName
+ * @param string $lastNameDonar
+ * @param string $firstNameDonar
+ * @param string $firstNameCreator
+ * @param string $lastNameCreator
* @param $amount
*/
function _testParticipantSearchEventName($eventName, $lastNameDonar, $firstNameDonar, $firstNameCreator, $lastNameCreator, $amount) {
}
/**
- * @param $firstName
+ * @param string $firstName
* @param $lastName
* @param $pcpCreatorFirstName
* @param $pcpCreatorLastName
}
/**
- * @param $eventParams
+ * @param array $eventParams
* @param $participants
* @param $priceFieldOptionCounts
*/
}
/**
- * @param $optionGroupName
+ * @param string $optionGroupName
* @param $optionValue
*
* @return array|int
class ExportCiviSeleniumTestCase extends CiviSeleniumTestCase {
/**
- * download CSV file.
+ * Download CSV file.
*
* @param string $selector element selector(download button in most of the cases).
* @param string $fileName file name to be download.
}
/**
- * read CSV file and fire provided assertions.
+ * Read CSV file and fire provided assertions.
*
* @param string $file file path of CSV file.
* @param array $checkColumns check first row of csv
/**
* @param $setTitle
- * @param $batchId
+ * @param int $batchId
* @param $exportFormat
*/
function _testExportBatch($setTitle, $batchId, $exportFormat) {
}
/**
- * @param $widgetConfigureID
+ * @param int $widgetConfigureID
* @param $widgetEnabledSelector
* @param $widgetTitle
*/
}
/**
- * @param $widgetConfigureID
+ * @param int $widgetConfigureID
* @param $widgetEnabledSelector
*/
function _testRemoveDashboardElement($widgetConfigureID, $widgetEnabledSelector) {
/**
* Helper function to provide data for custom data import.
*
- * @param $customDataParams
- * @param $firstName1
+ * @param array $customDataParams
+ * @param string $firstName1
*
* @return array
*/
}
/**
- * @param $customFieldName
+ * @param string $customFieldName
* @param $type
*
* @return array
}
/**
- * check for Valid Street Address
+ * Check for Valid Street Address
*/
function testValidStreetAddressParsing() {
$this->webtestLogin();
}
/**
- * check for Invalid Street Address
+ * Check for Invalid Street Address
*/
function testInvalidStreetAddressParsing() {
$this->webtestLogin();
/**
* Helper function to provide data for custom data import.
*
- * @param $customDataParams
- * @param $firstName1
+ * @param array $customDataParams
+ * @param string $firstName1
*
* @return array
*/
* Helper function to provide data for custom data import.
*
* @param $customGroupTitle
- * @param $firstName1
- * @param $firstName2
+ * @param string $firstName1
+ * @param string $firstName2
* @param $id1
* @param $id2
*
class ImportCiviSeleniumTestCase extends CiviSeleniumTestCase {
/**
- * test csv import for each component.
+ * Test csv import for each component.
*
* @param string $component component name ( Event, Contribution, Membership, Activity etc)
* @param array $headers csv data headers
}
/**
- * test contact import.
+ * Test contact import.
*
* @param array $headers csv data headers
* @param array $rows csv data rows
/**
* Helper function to add new contact
*
- * @param $firstName
- * @param $lastName
- * @param $externalId
+ * @param string $firstName
+ * @param string $lastName
+ * @param int $externalId
*
* @return int external id
*/
}
/**
- * test Saved Import Mapping for Individuals.
+ * Test Saved Import Mapping for Individuals.
*/
function testSaveIndividualMapping() {
}
/**
- * @param $memTypeParams
+ * @param array $memTypeParams
*/
function _addMembership($memTypeParams) {
// click through to the membership view screen
/**
* @param $profileTitle
- * @param $customDataParams
+ * @param array $customDataParams
*/
function _addProfile($profileTitle, $customDataParams) {
}
/**
- * @param $firstName
- * @param $lastName
+ * @param string $firstName
+ * @param string $lastName
* @param $email
- * @param $contactParams
+ * @param array $contactParams
* @param $streetAddress
*/
function contactInfoFill($firstName, $lastName, $email, $contactParams, $streetAddress) {
* @param $validateString
* @param bool $dateSpecificFields
* @param $title
- * @param $sid
+ * @param int $sid
* @param bool $defaultPriceSet
* @param $contributionType
*
* @param $validateString
* @param bool $dateSpecificFields
* @param $title
- * @param $sid
+ * @param int $sid
* @param $contributionType
*
* @return array
/**
* @param $validateStrings
- * @param $sid
+ * @param int $sid
*/
function _testVerifyPriceSet($validateStrings, $sid) {
// verify Price Set at Preview page
}
/**
- * @param $sid
- * @param $contactParams
+ * @param int $sid
+ * @param array $contactParams
* @param $memTypeTitle1
* @param $memTypeTitle2
* @param bool $renew
}
/**
- * @param $sid
- * @param $contactParams
+ * @param int $sid
+ * @param array $contactParams
* @param $memTypeTitle1
* @param $term
*/
* @param $validateString
* @param bool $dateSpecificFields
* @param $title
- * @param $sid
+ * @param int $sid
* @param $contributionType
*
* @return array
/**
* @param $validateStrings
- * @param $sid
+ * @param int $sid
*/
function _testVerifyPriceSet($validateStrings, $sid) {
// verify Price Set at Preview page
}
/**
- * @param $pageId
- * @param $contactParams
+ * @param int $pageId
+ * @param array $contactParams
* @param $memTypeTitle1
* @param $memTypeTitle2
* @param bool $renew
}
/**
- * @param $pageId
- * @param $contactParams
+ * @param int $pageId
+ * @param array $contactParams
* @param $memTypeTitle1
* @param $term
* @param bool $renew
}
/**
- * @param $pageId
- * @param $memTypeId
- * @param $firstName
- * @param $lastName
+ * @param int $pageId
+ * @param int $memTypeId
+ * @param string $firstName
+ * @param string $lastName
* @param $payLater
* @param $hash
* @param bool $otherAmount
}
/**
- * @param $pageId
- * @param $memTypeId
- * @param null $cid
+ * @param int $pageId
+ * @param int $memTypeId
+ * @param int $cid
*/
function _testOnlineMembershipSignup($pageId, $memTypeId, $cid = NULL) {
//Open Live Contribution Page
}
/**
- * @param $gid
+ * @param int $gid
* @param $profileTitle
*/
function _deleteProfile($gid, $profileTitle) {
}
/**
- * @param $roleid
+ * @param int $roleid
*
* @return string
*/
}
/**
- * test permissions limited by hook
+ * Test permissions limited by hook
*/
function testContactGetHookLimitingHook() {
$this->hookClass->setHook('civicrm_aclWhereClause', array($this, 'aclWhereOnlySecond'));
}
/**
- * confirm that without check permissions we still get 2 contacts returned
+ * Confirm that without check permissions we still get 2 contacts returned
*/
function testContactGetHookLimitingHookDontCheck() {
//
}
/**
- * no results returned
+ * No results returned
*/
function aclWhereHookNoResults($type, &$tables, &$whereTables, &$contactID, &$where) {
}
/**
- * all results returned
+ * All results returned
* @implements CRM_Utils_Hook::aclWhereClause
*/
function aclWhereHookAllResults($type, &$tables, &$whereTables, &$contactID, &$where) {
}
/**
- * full results returned
+ * Full results returned
* @implements CRM_Utils_Hook::aclWhereClause
*/
function aclWhereOnlySecond($type, &$tables, &$whereTables, &$contactID, &$where) {
}
/**
- * test checks that all v3 API return a standardised error message when
+ * Test checks that all v3 API return a standardised error message when
* the $params passed in is not an array.
*/
function testParamsNotArray() {
}
/**
- * test exception is thrown
+ * Test exception is thrown
*/
function testv3WrapperException(){
try{
}
/**
- * check if required fields are not passed
+ * Check if required fields are not passed
*/
function testActionScheduleCreateWithoutRequired() {
$params = array(
}
/**
- * check with empty array
+ * Check with empty array
*/
function testActivityCreateEmpty() {
$result = $this->callAPIFailure('activity', 'create', array());
}
/**
- * check if required fields are not passed
+ * Check if required fields are not passed
*/
function testActivityCreateWithoutRequired() {
$params = array(
}
/**
- * check with incorrect required fields
+ * Check with incorrect required fields
*/
function testActivityCreateWithUnknownActivityTypeId() {
$params = array(
}
/**
- * check activity deletion with empty params
+ * Check activity deletion with empty params
*/
function testDeleteActivityForEmptyParams() {
$params = array('version' => $this->_apiversion);
}
/**
- * check activity deletion without activity id
+ * Check activity deletion without activity id
*/
function testDeleteActivityWithoutId() {
$params = array(
}
/**
- * check activity deletion without activity type
+ * Check activity deletion without activity type
*/
function testDeleteActivityWithoutActivityType() {
$params = array('id' => 1);
}
/**
- * check activity deletion with incorrect data
+ * Check activity deletion with incorrect data
*/
function testDeleteActivityWithIncorrectActivityType() {
$params = array(
}
/**
- * check activity deletion with correct data
+ * Check activity deletion with correct data
*/
function testDeleteActivity() {
$result = $this->callAPISuccess('activity', 'create', $this->_params);
}
/**
- * check if required fields are not passed
+ * Check if required fields are not passed
*/
function testActivityUpdateWithoutRequired() {
$params = array(
}
/**
- * check with incorrect required fields
+ * Check with incorrect required fields
*/
function testActivityUpdateWithIncorrectContactActivityType() {
$params = array(
}
/**
- * check activity update with status
+ * Check activity update with status
*/
function testActivityUpdateWithStatus() {
$activity = $this->callAPISuccess('activity', 'create', $this->_params);
}
/**
- * is_primary should be set as a default
+ * Is_primary should be set as a default
*/
public function testCreateAddressTestDefaults() {
$params = $this->_params;
}
/**
- * is_primary shoule be set as a default. ie. create the address, unset the params & recreate.
+ * Is_primary shoule be set as a default. ie. create the address, unset the params & recreate.
* is_primary should be 0 before & after the update. ie - having no other address
* is_primary is invalid
*/
}
/**
- * check with empty array
+ * Check with empty array
*/
function testCaseCreateEmpty() {
$result = $this->callAPIFailure('case', 'create', array());
}
/**
- * check if required fields are not passed
+ * Check if required fields are not passed
*/
function testCaseCreateWithoutRequired() {
$params = array(
}
/**
- * check with empty array
+ * Check with empty array
*/
function testCaseTypeCreateEmpty() {
$this->callAPIFailure('CaseType', 'create', array());
}
/**
- * check if required fields are not passed
+ * Check if required fields are not passed
*/
function testCaseTypeCreateWithoutRequired() {
$params = array(
}
/**
- * test create methods with valid data
+ * Test create methods with valid data
* success expected
*/
function testCaseTypeCreate() {
}
/**
- * test create methods with xml file
+ * Test create methods with xml file
* success expected
*/
function testCaseTypeCreateWithDefinition() {
$this->callAPIFailure('contact', 'create', $params);
}
/**
- * check with complete array + custom field
+ * Check with complete array + custom field
* Note that the test is written on purpose without any
* variables specific to participant so it can be replicated into other entities
* and / or moved to the automated test suite
}
/**
- * check with complete array + custom field
+ * Check with complete array + custom field
* Note that the test is written on purpose without any
* variables specific to participant so it can be replicated into other entities
* and / or moved to the automated test suite
}
/**
- * check with complete array + custom field
+ * Check with complete array + custom field
* Note that the test is written on purpose without any
* variables specific to participant so it can be replicated into other entities
* and / or moved to the automated test suite
}
/**
- * test that permissions are respected when creating contacts
+ * Test that permissions are respected when creating contacts
*/
function testContactCreationPermissions() {
$params = array(
}
/**
- * test get ref api - gets a list of references to an entity
+ * Test get ref api - gets a list of references to an entity
*/
function testGetReferenceCounts() {
$result = $this->callAPISuccess('Contact', 'create', array(
}
/**
- * test add methods with valid data
+ * Test add methods with valid data
* success expected
*/
function testContactCreate() {
/**
- * test add with invalid data
+ * Test add with invalid data
*/
function testContactAddInvalidData() {
/**
- * test update with no subtype to valid subtype
+ * Test update with no subtype to valid subtype
* success expected
*/
function testContactUpdateNoSubtypeValid() {
/**
- * test update with no subtype to invalid subtype
+ * Test update with no subtype to invalid subtype
*/
function testContactUpdateNoSubtypeInvalid() {
}
/**
- * test update with no subtype to valid subtype
+ * Test update with no subtype to valid subtype
* success expected
*/
function testContactUpdateSubtypeValid() {
}
/**
- * test update with no subtype to invalid subtype
+ * Test update with no subtype to invalid subtype
*/
function testContactUpdateSubtypeInvalid() {
}
/**
- * set up membership contribution page
+ * Set up membership contribution page
* @param bool $isSeparatePayment
*/
function setUpMembershipContributionPage($isSeparatePayment = FALSE) {
}
/**
- * help function to set up contribution page with some defaults
+ * Help function to set up contribution page with some defaults
*/
function setUpContributionPage() {
$contributionPageResult = $this->callAPISuccess($this->_entity, 'create', $this->params);
}
/**
- * test get methods
+ * Test get methods
* @todo - this might be better broken down into more smaller tests
*/
function testGetContributionSoft() {
}
/**
- * check with complete array + custom field
+ * Check with complete array + custom field
* Note that the test is written on purpose without any
* variables specific to participant so it can be replicated into other entities
* and / or moved to the automated test suite
}
/**
- * check with complete array + custom field
+ * Check with complete array + custom field
* Note that the test is written on purpose without any
* variables specific to participant so it can be replicated into other entities
* and / or moved to the automated test suite
$this->contributionGetnCheck($params, $contribution['id']);
}
/**
- * test create with valid payment instument
+ * Test create with valid payment instument
*/
function testCreateContributionWithPaymentInstrument() {
$params = $this->_params + array('payment_instrument' => 'EFT');
}
/**
- * test note created correctly
+ * Test note created correctly
*/
function testCreateContributionWithNote() {
$description = "Demonstrates creating contribution with Note Entity";
}
/**
- * in the interests of removing financial type / contribution type checks from
+ * In the interests of removing financial type / contribution type checks from
* legacy format function lets test that the api is doing this for us
*/
function testCreateInvalidFinancialType() {
}
/**
- * in the interests of removing financial type / contribution type checks from
+ * In the interests of removing financial type / contribution type checks from
* legacy format function lets test that the api is doing this for us
*/
function testValidNamedFinancialType() {
}
/**
- * test that BAO defaults work
+ * Test that BAO defaults work
*/
function testCreateBAODefaults() {
unset($this->_params['contribution_source_id'], $this->_params['payment_instrument_id']);
}
/**
- * test that update does not change status id CRM-15105
+ * Test that update does not change status id CRM-15105
*/
function testCreateUpdateWithoutChangingPendingStatus() {
$contribution = $this->callAPISuccess('contribution', 'create', array_merge($this->_params, array('contribution_status_id' => 2)));
}
/**
- * test membership is renewed when transaction completed
+ * Test membership is renewed when transaction completed
*/
function testCompleteTransactionMembershipPriceSet() {
$this->createPriceSetWithPage('membership');
}
/**
- * test membership is renewed when transaction completed
+ * Test membership is renewed when transaction completed
*/
function testCompleteTransactionMembershipPriceSetTwoTerms() {
$this->createPriceSetWithPage('membership');
/**
- * this could be merged with 4.5 function setup in api_v3_ContributionPageTest::setUpContributionPage
+ * This could be merged with 4.5 function setup in api_v3_ContributionPageTest::setUpContributionPage
* on parent class at some point (fn is not in 4.4)
* @param $entity
* @param array $params
/**
* Set up a pending transaction with a specific price field id
- * @param $priceFieldValueID
+ * @param int $priceFieldValueID
*/
function setUpPendingContribution($priceFieldValueID){
$contactID = $this->individualCreate();
}
/**
- * @param $contId
+ * @param int $contId
*
* @return null|string
*/function _getFinancialTrxnAmount($contId) {
}
/**
- * @param $contId
+ * @param int $contId
*
* @return null|string
*/function _getFinancialItemAmount($contId) {
}
/**
- * @param $contId
+ * @param int $contId
* @param $context
*/
function _checkFinancialItem($contId, $context) {
/**
* @param $contribution
* @param $context
- * @param null $instrumentId
+ * @param int $instrumentId
*/
function _checkFinancialTrxn($contribution, $context, $instrumentId = NULL) {
$trxnParams = array(
}
/**
- * check with no array
+ * Check with no array
*/
function testCustomFieldCreateNoArray() {
$fieldParams = NULL;
}
/**
- * check with no label
+ * Check with no label
*/
function testCustomFieldCreateWithoutLabel() {
$customGroup = $this->customGroupCreate(array('extends' => 'Individual', 'title' => 'text_test_group'));
}
/**
- * check with edit
+ * Check with edit
*/
function testCustomFieldCreateWithEdit() {
$customGroup = $this->customGroupCreate(array('extends' => 'Individual', 'title' => 'text_test_group'));
}
/**
- * check without groupId
+ * Check without groupId
*/
function testCustomFieldCreateWithoutGroupID() {
$fieldParams = array(
}
/**
- * @param $gid
+ * @param int $gid
* @param $htype
* @param $dtype
*
}
/**
- * @param $gid
+ * @param int $gid
* @param $htype
* @param $dtype
*
}*/
/**
- * check with data type - Options with option_values
+ * Check with data type - Options with option_values
*/
function testCustomFieldCreateWithEmptyOptionGroup() {
$customGroup = $this->customGroupCreate(array('extends' => 'Contact', 'title' => 'select_test_group'));
///////////////// civicrm_custom_field_delete methods
/**
- * check with no array
+ * Check with no array
*/
function testCustomFieldDeleteNoArray() {
$params = NULL;
}
/**
- * check without Field ID
+ * Check without Field ID
*/
function testCustomFieldDeleteWithoutFieldID() {
$params = array();
}
/**
- * check without valid array
+ * Check without valid array
*/
function testCustomFieldDelete() {
$customGroup = $this->customGroupCreate(array('extends' => 'Individual', 'title' => 'test_group'));
}
/**
- * check for Option Value
+ * Check for Option Value
*/
function testCustomFieldOptionValueDelete() {
$customGroup = $this->customGroupCreate(array('extends' => 'Contact', 'title' => 'ABC'));
///////////////// civicrm_custom_group_create methods
/**
- * check with empty array
+ * Check with empty array
* note that these tests are of marginal value so should not be included in copy & paste
* code. The SyntaxConformance is capable of testing this for all entities on create
* & delete (& it would be easy to add if not there)
}
/**
- * check with empty array
+ * Check with empty array
*/
function testCustomGroupCreateNoExtends() {
$params = array(
}
/**
- * check with empty array
+ * Check with empty array
*/
function testCustomGroupCreateInvalidExtends() {
$params = array(
}
/**
- * check with a string instead of array for extends
+ * Check with a string instead of array for extends
*/
function testCustomGroupCreateExtendsString() {
$params = array(
}
/**
- * check with valid array
+ * Check with valid array
*/
function testCustomGroupCreate() {
$params = array(
}
/**
- * check with valid array
+ * Check with valid array
*/
function testCustomGroupGetFields() {
$params = array(
}
/**
- * check with extends array length greater than 1
+ * Check with extends array length greater than 1
*/
function testCustomGroupExtendsMultipleCreate() {
$params = array(
}
/**
- * check with style missing from params array
+ * Check with style missing from params array
*/
function testCustomGroupCreateNoStyle() {
$params = array(
}
/**
- * check with not array
+ * Check with not array
*/
function testCustomGroupCreateNotArray() {
$params = NULL;
}
/**
- * check without title
+ * Check without title
*/
function testCustomGroupCreateNoTitle() {
$params = array('extends' => array('Contact'),
}
/**
- * check for household without weight
+ * Check for household without weight
*/
function testCustomGroupCreateHouseholdNoWeight() {
$params = array(
}
/**
- * check for Contribution Donation
+ * Check for Contribution Donation
*/
function testCustomGroupCreateContributionDonation() {
$params = array(
}
/**
- * check with valid array
+ * Check with valid array
*/
function testCustomGroupCreateGroup() {
$params = array(
}
/**
- * check with Activity - Meeting Type
+ * Check with Activity - Meeting Type
*/
function testCustomGroupCreateActivityMeeting() {
$params = array(
///////////////// civicrm_custom_group_delete methods
/**
- * check without GroupID
+ * Check without GroupID
*/
function testCustomGroupDeleteWithoutGroupID() {
$customGroup = $this->callAPIFailure('custom_group', 'delete', array());
}
/**
- * check with no array
+ * Check with no array
*/
function testCustomGroupDeleteNoArray() {
$params = NULL;
}
/**
- * check with valid custom group id
+ * Check with valid custom group id
*/
function testCustomGroupDelete() {
$customGroup = $this->customGroupCreate(array('extends' => 'Individual', 'title' => 'test_group'));
}
/**
- * main success get function
+ * Main success get function
*/
public function testGetCustomGroupSuccess() {
}
/**
- * @param $id
+ * @param int $id
* @param $oldCount
*/
function DashboardDelete($id, $oldCount) {
///////////////// civicrm_event_create methods
/**
- * check with complete array + custom field
+ * Check with complete array + custom field
* Note that the test is written on purpose without any
* variables specific to participant so it can be replicated into other entities
* and / or moved to the automated test suite
}
/**
- * check event_id still supported for delete
+ * Check event_id still supported for delete
*/
function testDeleteWithEventId() {
$params = array(
}
/**
- * test api_action param also works
+ * Test api_action param also works
*/
function testgetfieldsRest() {
$description = "demonstrate use of getfields to interrogate api";
///////////////// civicrm_group_organization_create methods
/**
- * check with valid params
+ * Check with valid params
*/
public function testGroupOrganizationCreate() {
$params = array(
$this->assertEquals($result['values'], $result2['values']);
}
/**
- * check with empty params array
+ * Check with empty params array
*/
public function testGroupOrganizationCreateWithEmptyParams() {
$params = array( );
}
/**
- * check with invalid params
+ * Check with invalid params
*/
public function testGroupOrganizationCreateParamsNotArray() {
$params = 'group_org';
}
/**
- * check with invalid params keys
+ * Check with invalid params keys
*/
public function testGroupOrganizationCreateWithInvalidKeys() {
$params = array(
}
/**
- * check with no name
+ * Check with no name
*/
function testCreateWithoutName() {
$params = array(
}
/**
- * create job with an invalid "run_frequency" value
+ * Create job with an invalid "run_frequency" value
*/
function testCreateWithInvalidFrequency() {
$params = array(
}
/**
- * create job
+ * Create job
*/
function testCreate() {
$result = $this->callAPIAndDocument('job', 'create', $this->_params, __FUNCTION__, __FILE__);
}
/**
- * check with empty array
+ * Check with empty array
*/
function testDeleteEmpty() {
$params = array();
}
/**
- * check with No array
+ * Check with No array
*/
function testDeleteParamsNotArray() {
$result = $this->callAPIFailure('job', 'delete', 'string');
}
/**
- * check if required fields are not passed
+ * Check if required fields are not passed
*/
function testDeleteWithoutRequired() {
$params = array(
}
/**
- * check with incorrect required fields
+ * Check with incorrect required fields
*/
function testDeleteWithIncorrectData() {
$params = array(
}
/**
- * check job delete
+ * Check job delete
*/
function testDelete() {
$createResult = $this->callAPISuccess('job', 'create', $this->_params);
}
/**
- * test the call reminder success sends more than 25 reminders & is not incorrectly limited
+ * Test the call reminder success sends more than 25 reminders & is not incorrectly limited
* Note that this particular test sends the reminders to the additional recipients only
* as no real reminder person is configured
*
}
/**
- * test scheduled reminders respect limit to (since above identified addition_to handling issue)
+ * Test scheduled reminders respect limit to (since above identified addition_to handling issue)
* We create 3 contacts - 1 is in our group, 1 has our membership & the chosen one has both
* & check that only the chosen one got the reminder
*/
/**
* @param $op
- * @param $objectName
- * @param $id
+ * @param string $objectName
+ * @param int $id
* @param array $params
*/
function hookPreRelationship($op, $objectName, $id, &$params ) {
$this->assertEquals($result['membership_type_id'], $this->_membershipTypeID2);
}
/**
- * check with complete array + custom field
+ * Check with complete array + custom field
* Note that the test is written on purpose without any
* variables specific to participant so it can be replicated into other entities
* and / or moved to the automated test suite
}
/**
- * check with complete array + custom field
+ * Check with complete array + custom field
* Note that the test is written on purpose without any
* variables specific to participant so it can be replicated into other entities
* and / or moved to the automated test suite
}
/**
- * change custom field using update
+ * Change custom field using update
*/
function testUpdateWithCustom() {
$ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__);
function tearDown() {}
/**
- * test create function succeeds
+ * Test create function succeeds
*/
public function testCreate() {
$result = $this->callAPIAndDocument('MessageTemplate', 'create', $this->params, __FUNCTION__, __FILE__);
///////////////// civicrm_note_get methods
/**
- * check retrieve note with empty parameter array
+ * Check retrieve note with empty parameter array
* Error expected
*/
function testGetWithEmptyParams() {
}
/**
- * check retrieve note with missing patrameters
+ * Check retrieve note with missing patrameters
* Error expected
*/
function testGetWithoutEntityId() {
}
/**
- * check civicrm_note_get
+ * Check civicrm_note_get
*/
function testGet() {
$entityId = $this->_noteID;
}
/**
- * success test for updating an existing Option Group
+ * Success test for updating an existing Option Group
*/
public function testCreateUpdateOptionGroup() {
$result = $this->callAPISuccess($this->_entity, 'create', $this->_params);
}
/**
- * success test for deleting an existing Option Group
+ * Success test for deleting an existing Option Group
*/
public function testDeleteOptionGroup() {
$result = $this->callAPISuccess($this->_entity, 'create', $this->_params);
}
/**
- * test that using option_group_name returns more than 1 & less than all
+ * Test that using option_group_name returns more than 1 & less than all
*/
public function testGetOptionGroupByName() {
$activityTypesParams = array('option_group_name' => 'activity_type', 'option.limit' => 100);
/**
- * update option value with 'id' paramter and the value to update
+ * Update option value with 'id' paramter and the value to update
* and not passing option group id
*/
public function testUpdateOptionValueNoGroupId() {
}
/**
- * update option value with 'id' paramter and the value to update
+ * Update option value with 'id' paramter and the value to update
* and as well as option group id
*/
public function testUpdateOptionValueWithGroupId() {
}
/**
- * check without contribution_id
+ * Check without contribution_id
*/
function testPaymentCreateMissingContributionId() {
//Without Payment EntityID
}
/**
- * check with valid array
+ * Check with valid array
*/
function testPaymentCreate() {
//Create Contribution & get contribution ID
}
/**
- * check with empty array
+ * Check with empty array
*/
function testPaymentUpdateEmpty() {
$params = array();
}
/**
- * check with missing participant_id
+ * Check with missing participant_id
*/
function testPaymentUpdateMissingParticipantId() {
//WithoutParticipantId
}
/**
- * check with missing contribution_id
+ * Check with missing contribution_id
*/
function testPaymentUpdateMissingContributionId() {
$params = array(
}
/**
- * check financial records for offline Participants
+ * Check financial records for offline Participants
*/
function testPaymentOffline() {
}
/**
- * check financial records for online Participant
+ * Check financial records for online Participant
*/
function testPaymentOnline() {
}
/**
- * check financial records for online Participant pay later scenario
+ * Check financial records for online Participant pay later scenario
*/
function testPaymentPayLaterOnline() {
}
/**
- * check with empty array
+ * Check with empty array
*/
function testPaymentDeleteWithEmptyParams() {
$params = array();
}
/**
- * check with wrong id
+ * Check with wrong id
*/
function testPaymentDeleteWithWrongID() {
$params = array(
}
/**
- * check with valid array
+ * Check with valid array
*/
function testPaymentDelete() {
}
/**
- * check with complete array + custom field
+ * Check with complete array + custom field
* Note that the test is written on purpose without any
* variables specific to participant so it can be replicated into other entities
* and / or moved to the automated test suite
///////////////// civicrm_participant_get methods
/**
- * check with wrong params type
+ * Check with wrong params type
*/
function testGetWrongParamsType() {
$params = 'a string';
}
/**
- * check with participant_id
+ * Check with participant_id
*/
function testGetParticipantIdOnly() {
$params = array(
}
/**
- * check with params id
+ * Check with params id
*/
function testGetParamsAsIdOnly() {
$params = array(
}
/**
- * check with params id
+ * Check with params id
*/
function testGetNestedEventGet() {
//create a second event & add participant to it.
}
/**
- * check with contact_id
+ * Check with contact_id
*/
function testGetContactIdOnly() {
$params = array(
}
/**
- * check with event_id
+ * Check with event_id
* fetch first record
*/
function testGetMultiMatchReturnFirst() {
}
/**
- * check with event_id
+ * Check with event_id
* in v3 this should return all participants
*/
function testGetMultiMatchNoReturnFirst() {
}
/**
- * check with participant_id
+ * Check with participant_id
*/
function testSearchParticipantIdOnly() {
$params = array(
}
/**
- * check with contact_id
+ * Check with contact_id
*/
function testSearchContactIdOnly() {
// Should get 2 participant records for this contact.
}
/**
- * check with event_id
+ * Check with event_id
*/
function testSearchByEvent() {
// Should get >= 3 participant records for this event. Also testing that last_name and event_title are returned.
}
/**
- * check with event_id
+ * Check with event_id
* fetch with limit
*/
function testSearchByEventWithLimit() {
}
/**
- * check with event_id
+ * Check with event_id
*/
function testCreateMissingContactID() {
$params = array(
}
/**
- * check with contact_id
+ * Check with contact_id
* without event_id
*/
function testCreateMissingEventID() {
}
/**
- * check with contact_id & event_id
+ * Check with contact_id & event_id
*/
function testCreateEventIdOnly() {
$params = array(
}
/**
- * check with complete array
+ * Check with complete array
*/
function testCreateAllParams() {
$params = $this->_params;
}
/**
- * check with complete array
+ * Check with complete array
*/
function testUpdate() {
$participantId = $this->participantCreate(array(
}
/**
- * check with empty array
+ * Check with empty array
*/
function testUpdateEmptyParams() {
$params = array();
}
/**
- * check without event_id
+ * Check without event_id
*/
function testUpdateWithoutEventId() {
$participantId = $this->participantCreate(array('contactID' => $this->_individualId, 'eventID' => $this->_eventID));
}
/**
- * check with Invalid participantId
+ * Check with Invalid participantId
*/
function testUpdateWithWrongParticipantId() {
$params = array(
}
/**
- * check with Invalid ContactId
+ * Check with Invalid ContactId
*/
function testUpdateWithWrongContactId() {
$participantId = $this->participantCreate(array(
}
/**
- * check with participant_id
+ * Check with participant_id
*/
function testParticipantDelete() {
$params = array(
}
/**
- * check without participant_id
+ * Check without participant_id
* and with event_id
* This should return an error because required param is missing..
*/
}
/**
- * delete with a get - a 'criteria delete'
+ * Delete with a get - a 'criteria delete'
*/
function testNestedDelete() {
$description = "Criteria delete by nesting a GET & a DELETE";
///////////////// civicrm_payment_processor_add methods
/**
- * check with no name
+ * Check with no name
*/
function testPaymentProcessorCreateWithoutName() {
$payProcParams = array(
}
/**
- * create payment processor
+ * Create payment processor
*/
function testPaymentProcessorCreate() {
$params = $this->_params;
///////////////// civicrm_payment_processor_delete methods
/**
- * check payment processor delete
+ * Check payment processor delete
*/
function testPaymentProcessorDelete() {
$id = $this->testPaymentProcessorCreate();
///////////////// civicrm_payment_processors_get methods
/**
- * check with valid params array.
+ * Check with valid params array.
*/
function testPaymentProcessorsGet() {
$params = $this->_params;
///////////////// civicrm_payment_processor_type_add methods
/**
- * check with no name
+ * Check with no name
*/
function testPaymentProcessorTypeCreateWithoutName() {
$payProcParams = array(
}
/**
- * create payment processor type
+ * Create payment processor type
*/
function testPaymentProcessorTypeCreate() {
$params = array( 'sequential' => 1,
///////////////// civicrm_payment_processor_type_delete methods
/**
- * check with empty array
+ * Check with empty array
*/
function testPaymentProcessorTypeDeleteEmpty() {
$params = array();
}
/**
- * check with No array
+ * Check with No array
*/
function testPaymentProcessorTypeDeleteParamsNotArray() {
$result = $this->callAPIFailure('payment_processor_type', 'delete', 'string');
}
/**
- * check if required fields are not passed
+ * Check if required fields are not passed
*/
function testPaymentProcessorTypeDeleteWithoutRequired() {
$params = array(
}
/**
- * check with incorrect required fields
+ * Check with incorrect required fields
*/
function testPaymentProcessorTypeDeleteWithIncorrectData() {
$result = $this->callAPIFailure('payment_processor_type', 'delete', array('id' => 'abcd'));
}
/**
- * check payment processor type delete
+ * Check payment processor type delete
*/
function testPaymentProcessorTypeDelete() {
$payProcType = $this->paymentProcessorTypeCreate();
///////////////// civicrm_payment_processor_type_update
/**
- * check with empty array
+ * Check with empty array
*/
function testPaymentProcessorTypeUpdateEmpty() {
$params = array();
}
/**
- * check with No array
+ * Check with No array
*/
function testPaymentProcessorTypeUpdateParamsNotArray() {
$result = $this->callAPIFailure('payment_processor_type', 'create', 'string');
}
/**
- * check with all parameters
+ * Check with all parameters
*/
function testPaymentProcessorTypeUpdate() {
// create sample payment processor type.
///////////////// civicrm_payment_processor_types_get methods
/**
- * check with empty array
+ * Check with empty array
*/
function testPaymentProcessorTypesGetEmptyParams() {
$results = $this->callAPISuccess('payment_processor_type', 'get', array( ));
}
/**
- * check with valid params array.
+ * Check with valid params array.
*/
function testPaymentProcessorTypesGet() {
$firstRelTypeParams = array(
}
/**
- * test checks behaviour when more payments are created than should be possible
+ * Test checks behaviour when more payments are created than should be possible
*/
function testCreatePledgePaymentAllCreated() {
$params = array(
///////////////// civicrm_pledge_get methods
/**
- * check with complete array + custom field
+ * Check with complete array + custom field
* Note that the test is written on purpose without any
* variables specific to participant so it can be replicated into other entities
* and / or moved to the automated test suite
$pledge = $this->callAPISuccess('pledge', 'delete', $params2);
}
/**
- * test 'return.pledge_financial_type' => 1 works
+ * Test 'return.pledge_financial_type' => 1 works
*/
function testGetPledgewithReturn() {
$this->assertEquals('Donation', $pledge['pledge_financial_type']);
}
/**
- * test 'return.pledge_contribution_type' => 1 works
+ * Test 'return.pledge_contribution_type' => 1 works
* This is for legacy compatibility
*/
function testGetPledgewithReturnLegacy() {
}
/**
- * test that status is set to pending
+ * Test that status is set to pending
*/
function testCreatePledgeNoStatus() {
}
/**
- * legacy support for pledge_id
+ * Legacy support for pledge_id
*/
function testDeletePledge() {
}
/**
- * std is to accept id
+ * Std is to accept id
*/
function testDeletePledgeUseID() {
}
/**
- * test to make sure empty get returns nothing
+ * Test to make sure empty get returns nothing
* Note that the function gives incorrect results if no pledges exist as it does a
* contact search instead - test only checks that the get finds the one existing
*/
////////////// test $this->callAPISuccess3_profile_get //////////////////
/**
- * check Without ProfileId
+ * Check Without ProfileId
*/
function testProfileGetWithoutProfileId() {
$params = array(
}
/**
- * check with no invalid profile Id
+ * Check with no invalid profile Id
*/
function testProfileGetInvalidProfileId() {
$params = array(
}
/**
- * check with success
+ * Check with success
*/
function testProfileGet() {
$pofileFieldValues = $this->_createIndividualContact();
}
/**
- * get Billing empty contact - this will return generic defaults
+ * Get Billing empty contact - this will return generic defaults
*/
function testProfileGetBillingEmptyContact() {
}
/**
- * check contact activity profile without activity id
+ * Check contact activity profile without activity id
*/
function testContactActivityGetWithoutActivityId() {
list($params, $expected) = $this->_createContactWithActivity();
}
/**
- * check contact activity profile wrong activity id
+ * Check contact activity profile wrong activity id
*/
function testContactActivityGetWrongActivityId() {
list($params, $expected) = $this->_createContactWithActivity();
}
/**
- * check contact activity profile with wrong activity type
+ * Check contact activity profile with wrong activity type
*/
function testContactActivityGetWrongActivityType() {
//flush cache by calling with reset
}
/**
- * check contact activity profile with success
+ * Check contact activity profile with success
*/
function testContactActivityGetSuccess() {
list($params, $expected) = $this->_createContactWithActivity();
/////////////// test $this->callAPISuccess3_profile_set //////////////////
/**
- * check Without ProfileId
+ * Check Without ProfileId
*/
function testProfileSubmitWithoutProfileId() {
$params = array(
}
/**
- * check with no invalid profile Id
+ * Check with no invalid profile Id
*/
function testProfileSubmitInvalidProfileId() {
$params = array(
}
/**
- * check with missing required field in profile
+ * Check with missing required field in profile
*/
function testProfileSubmitCheckProfileRequired() {
$pofileFieldValues = $this->_createIndividualContact();
}
/**
- * check with success
+ * Check with success
*/
function testProfileSubmit() {
$pofileFieldValues = $this->_createIndividualContact();
));
}
/**
- * set is deprecated but we need to ensure it still works
+ * Set is deprecated but we need to ensure it still works
*/
function testLegacySet() {
$pofileFieldValues = $this->_createIndividualContact();
}
/**
- * check contact activity profile without activity id
+ * Check contact activity profile without activity id
*/
function testContactActivitySubmitWithoutActivityId() {
list($params, $expected) = $this->_createContactWithActivity();
}
/**
- * check contact activity profile wrong activity id
+ * Check contact activity profile wrong activity id
*/
function testContactActivitySubmitWrongActivityId() {
list($params, $expected) = $this->_createContactWithActivity();
}
/**
- * check contact activity profile with wrong activity type
+ * Check contact activity profile with wrong activity type
*/
function testContactActivitySubmitWrongActivityType() {
//flush cache by calling with reset
}
/**
- * check contact activity profile with success
+ * Check contact activity profile with success
*/
function testContactActivitySubmitSuccess() {
list($params, $expected) = $this->_createContactWithActivity();
}
/**
- * check profile apply Without ProfileId
+ * Check profile apply Without ProfileId
*/
function testProfileApplyWithoutProfileId() {
$params = array(
}
/**
- * check profile apply with no invalid profile Id
+ * Check profile apply with no invalid profile Id
*/
function testProfileApplyInvalidProfileId() {
$params = array(
}
/**
- * check with success
+ * Check with success
*/
function testProfileApply() {
$pofileFieldValues = $this->_createIndividualContact();
}
/**
- * @param $profileID
+ * @param int $profileID
*/
function _addCustomFieldToProfile($profileID) {
$ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, '');
protected $_apiversion = 3;
protected $_cId_a;
/**
- * second individual
+ * Second individual
* @var integer
*/
protected $_cId_a_2;
///////////////// civicrm_relationship_create methods
/**
- * check with empty array
+ * Check with empty array
*/
function testRelationshipCreateEmpty() {
$this->callAPIFailure('relationship', 'create', array());
}
/**
- * check if required fields are not passed
+ * Check if required fields are not passed
*/
function testRelationshipCreateWithoutRequired() {
$params = array(
}
/**
- * check with incorrect required fields
+ * Check with incorrect required fields
*/
function testRelationshipCreateWithIncorrectData() {
}
/**
- * check relationship creation with invalid Relationship
+ * Check relationship creation with invalid Relationship
*/
function testRelationshipCreatInvalidRelationship() {
// both the contact of type Individual
}
/**
- * check relationship already exists
+ * Check relationship already exists
*/
function testRelationshipCreateAlreadyExists() {
$params = array(
}
/**
- * check relationship already exists
+ * Check relationship already exists
*/
function testRelationshipCreateUpdateAlreadyExists() {
$params = array(
}
/**
- * checkupdate doesn't reset stuff badly - CRM-11789
+ * Checkupdate doesn't reset stuff badly - CRM-11789
*/
function testRelationshipCreateUpdateDoesntMangle() {
$params = array(
/**
- * check relationship creation
+ * Check relationship creation
*/
function testRelationshipCreate() {
$params = array(
$this->callAPISuccess('relationship', 'delete', $params);
}
/**
- * ensure disabling works
+ * Ensure disabling works
*/
function testRelationshipUpdate() {
$result = $this->callAPISuccess('relationship', 'create', $this->_params);
$this->assertEquals(1, $result['values'][$result['id']]['is_permission_b_a']);
}
/**
- * check relationship creation
+ * Check relationship creation
*/
function testRelationshipCreateEmptyEndDate() {
$params = array(
}
/**
- * check relationship creation with custom data
+ * Check relationship creation with custom data
*/
function testRelationshipCreateWithCustomData() {
$customGroup = $this->createCustomGroup();
}
/**
- * check with complete array + custom field
+ * Check with complete array + custom field
* Note that the test is written on purpose without any
* variables specific to participant so it can be replicated into other entities
* and / or moved to the automated test suite
///////////////// civicrm_relationship_delete methods
/**
- * check with empty array
+ * Check with empty array
*/
function testRelationshipDeleteEmpty() {
$params = array();
}
/**
- * check if required fields are not passed
+ * Check if required fields are not passed
*/
function testRelationshipDeleteWithoutRequired() {
$params = array(
}
/**
- * check with incorrect required fields
+ * Check with incorrect required fields
*/
function testRelationshipDeleteWithIncorrectData() {
$params = array(
}
/**
- * check relationship creation
+ * Check relationship creation
*/
function testRelationshipDelete() {
$params = array(
///////////////// civicrm_relationship_update methods
/**
- * check with empty array
+ * Check with empty array
*/
function testRelationshipUpdateEmpty() {
$result = $this->callAPIFailure('relationship', 'create', array(),
}
/**
- * check if required fields are not passed
+ * Check if required fields are not passed
*/
/**
- * check relationship update
+ * Check relationship update
*/
function testRelationshipCreateDuplicate() {
$relParams = array(
}
/**
- * check with valid params array.
+ * Check with valid params array.
*/
function testRelationshipsGet() {
$relParams = array(
}
/**
- * check with valid params array.
+ * Check with valid params array.
* (The get function will behave differently without 'contact_id' passed
*/
function testRelationshipsGetGeneric() {
}
/**
- * check with invalid relationshipType Id
+ * Check with invalid relationshipType Id
*/
function testRelationshipTypeAddInvalidId() {
$relTypeParams = array(
}
/**
- * check with valid data with contact_b
+ * Check with valid data with contact_b
*/
function testGetRelationshipWithContactB() {
$relParams = array(
}
/**
- * check with valid data with relationshipTypes
+ * Check with valid data with relationshipTypes
*/
function testGetRelationshipWithRelTypes() {
$relParams = array(
///////////////// civicrm_relationship_type_add methods
/**
- * check with no name
+ * Check with no name
*/
function testRelationshipTypeCreateWithoutName() {
$relTypeParams = array(
}
/**
- * check with no contact type
+ * Check with no contact type
*/
function testRelationshipTypeCreateWithoutContactType() {
$relTypeParams = array(
}
/**
- * create relationship type
+ * Create relationship type
*/
function testRelationshipTypeCreate() {
$params = array(
}
/**
- * check if required fields are not passed
+ * Check if required fields are not passed
*/
function testRelationshipTypeDeleteWithoutRequired() {
$params = array(
}
/**
- * check with incorrect required fields
+ * Check with incorrect required fields
*/
function testRelationshipTypeDeleteWithIncorrectData() {
$params = array(
}
/**
- * check relationship type delete
+ * Check relationship type delete
*/
function testRelationshipTypeDelete() {
$id = $this->_relationshipTypeCreate();
///////////////// civicrm_relationship_type_update
/**
- * check with empty array
+ * Check with empty array
*/
function testRelationshipTypeUpdateEmpty() {
$params = array();
}
/**
- * check with no contact type
+ * Check with no contact type
*/
function testRelationshipTypeUpdateWithoutContactType() {
// create sample relationship type.
}
/**
- * check with all parameters
+ * Check with all parameters
*/
function testRelationshipTypeUpdate() {
// create sample relationship type.
///////////////// civicrm_relationship_types_get methods
/**
- * check with empty array
+ * Check with empty array
*/
function testRelationshipTypesGetEmptyParams() {
$firstRelTypeParams = array(
}
/**
- * check with params Not Array.
+ * Check with params Not Array.
*/
function testRelationshipTypesGetParamsNotArray() {
}
/**
- * check with valid params array.
+ * Check with valid params array.
*/
function testRelationshipTypesGet() {
$firstRelTypeParams = array(
}
/**
- * create relationship type.
+ * Create relationship type.
*/
function _relationshipTypeCreate($params = NULL) {
if (!is_array($params) || empty($params)) {
}
/**
/**
- * check getfields works
+ * Check getfields works
*/
function testGetFields() {
$description = 'Demonstrate return from getfields - see subfolder for variants';
}
/**
- * let's check it's loading from cache by meddling with the cache
+ * Let's check it's loading from cache by meddling with the cache
*/
function testGetFieldsCaching() {
$settingsMetadata = array();
}
/**
- * check getfields works
+ * Check getfields works
*/
function testCreateSetting() {
$description = "shows setting a variable for a given domain - if no domain is set current is assumed";
}
/**
- * check getfields works
+ * Check getfields works
*/
function testCreateInvalidSettings() {
$params = array(
}
/**
- * check invalid settings rejected -
+ * Check invalid settings rejected -
*/
function testCreateInvalidURLSettings() {
$params = array(
}
/**
- * check getfields works
+ * Check getfields works
*/
function testCreateInvalidBooleanSettings() {
$params = array(
}
/**
- * check getfields works
+ * Check getfields works
*/
function testCreateSettingMultipleDomains() {
$description = "shows setting a variable for all domains";
}
/**
- * setting api should set & fetch settings stored in config as well as those in settings table
+ * Setting api should set & fetch settings stored in config as well as those in settings table
*/
function testSetConfigSetting() {
$config = CRM_Core_Config::singleton();
}
/**
- * setting api should set & fetch settings stored in config as well as those in settings table
+ * Setting api should set & fetch settings stored in config as well as those in settings table
*/
function testGetConfigSetting() {
$settings = $this->callAPISuccess('setting', 'get', array(
}
/**
- * setting api should set & fetch settings stored in config as well as those in settings table
+ * Setting api should set & fetch settings stored in config as well as those in settings table
*/
function testGetSetConfigSettingMultipleDomains() {
$settings = $this->callAPISuccess('setting', 'create', array(
}
/**
- * test create function succeeds
+ * Test create function succeeds
*/
public function testCreateSurvey() {
$result = $this->callAPIAndDocument('survey', 'create', $this->params, __FUNCTION__, __FILE__);
}
/**
- * test & document chained delete pattern. Note that explanation of the pattern
+ * Test & document chained delete pattern. Note that explanation of the pattern
* is best put in the $description variable as it will then be displayed in the
* test generated examples. (these are to be found in the api/examples folder)
*
return $returnEntities;
}
/**
- * @param $entityName
+ * @param string $entityName
* @param int $count
*
*
*/
protected $ids = array();
/**
- * tag id
+ * Tag id
* @var integer
*/
protected $tag = array();
}
/**
- * online and offline contrbution from above created contrbution page
+ * Online and offline contrbution from above created contrbution page
*/
function testCreateContributionOnline() {
$this->setUpContributionPage();
}
/**
- * @param $contId
+ * @param int $contId
*
* @return null|string
*/
}
/**
- * @param $contId
+ * @param int $contId
*
* @return null|string
*/
/**
* @param array $params
- * @param $financialTypeId
+ * @param int $financialTypeId
*/
function _getFinancialAccountId($financialTypeId) {
$accountRel = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Income Account is' "));
}
/**
- * create / updating field
+ * Create / updating field
*/
public function testCreateUFField() {
$params = $this->_params; // copy
}
/**
- * deleting field
+ * Deleting field
*/
public function testDeleteUFField() {
$ufField = $this->callAPISuccess('uf_field', 'create', $this->_params);
}
/**
- * create / updating field
+ * Create / updating field
*/
public function testReplaceUFFields() {
$baseFields = array();
}
/**
- * updating group
+ * Updating group
*/
public function testUpdateUFGroup() {
$params = array(
}
/**
- * find uf join group id
+ * Find uf join group id
*/
public function testFindUFGroupId() {
$params = array(
}
/**
- * create/update uf join
+ * Create/update uf join
*/
public function testCreateUFJoin() {
$params = array(
}
/**
- * find uf join id
+ * Find uf join id
*/
public function testGetUFJoinId() {
$params = array(
}
/**
- * fetch contact id by uf id
+ * Fetch contact id by uf id
*/
public function testGetUFMatchID() {
$params = array(
}
/**
- * fetch uf id by contact id
+ * Fetch uf id by contact id
*/
public function testGetUFID() {
$params = array(
projects / civicrm-core.git / commitdiff