}
/**
- * Update the is_active flag in the db
+ * Update the is_active flag in the db.
*
* @param int $id
* Id of the database record.
}
/**
- * Update the is_active flag in the db
+ * Update the is_active flag in the db.
*
* @param int $id
* Id of the database record.
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 $_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
*/
class CRM_Activity_BAO_ActivityAssignment extends CRM_Activity_DAO_ActivityContact {
/**
- * Class constructor
+ * Class constructor.
*/
public function __construct() {
parent::__construct();
}
/**
- * Retrieve assignee_id by activity_id
+ * Retrieve assignee_id by activity_id.
*
* @param int $activity_id
*
}
/**
- * Retrieve assignee names by activity_id
+ * Retrieve assignee names by activity_id.
*
* @param array $activityIDs
* IDs of the activities.
class CRM_Activity_BAO_ActivityContact extends CRM_Activity_DAO_ActivityContact {
/**
- * Class constructor
+ * Class constructor.
*/
public function __construct() {
parent::__construct();
}
/**
- * 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 int $activityID
* @param int $recordTypeID
class CRM_Activity_BAO_ActivityTarget extends CRM_Activity_DAO_ActivityContact {
/**
- * Class constructor
+ * Class constructor.
*/
public 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
*
protected $activity;
/**
- * Constructor
+ * Constructor.
*
* @param object $act
* Reference to an activity object.
}
/**
- * Add an ics attachment to the input array
+ * Add an ics attachment to the input array.
*
* @param array $attachments
* Reference to array in same format returned from CRM_Core_BAO_File::getEntityFile().
}
/**
- * Remove temp file
+ * Remove temp file.
*/
public function cleanup() {
if (!empty ($this->icsfile)) {
}
/**
- * Given a list of conditions in query generate the required
+ * Given a list of conditions in query generate the required.
* where clause
*
* @param $query
}
/**
- * Where clause for a single field
+ * Where clause for a single field.
*
* @param $values
* @param $query
}
/**
- * Getter for the qill object
+ * Getter for the qill object.
*
* @return string
*/
}
/**
- * Add all the elements shared between case activity search and advanced search
+ * Add all the elements shared between case activity search and advanced search.
*
*
* @param CRM_Core_Form $form
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2014
* $Id$
- *
*/
/**
*
* Typically the first form will display the search criteria and it's results
*
- * The second form is used to process search results with the asscociated actions
+ * The second form is used to process search results with the associated actions
*
*/
class CRM_Activity_Controller_Search extends CRM_Core_Controller {
/**
- * Class constructor
+ * Class constructor.
+ *
* @param null $title
* @param bool $modal
* @param int|mixed|null $action
$this->_stateMachine = new CRM_Activity_StateMachine_Search($this, $action);
- // create and instantiate the pages
+ // Create and instantiate the pages.
$this->addPages($this->_stateMachine, $action);
- // add all the actions
+ // Add all the actions.
$this->addActions();
}
/**
+ * Getter for selectorName.
+ *
* @return mixed
*/
public function selectorName() {
public $_activityId;
/**
- * Store activity ids when multiple activities are created
+ * Store activity ids when multiple activities are created.
*
* @var int
*/
public $_activityIds = array();
/**
- * The id of activity type
+ * The id of activity type.
*
* @var int
*/
public $_activityTypeId;
/**
- * The name of activity type
+ * The name of activity type.
*
* @var string
*/
public $_activityTypeName;
/**
- * The id of currently viewed contact
+ * The id of currently viewed contact.
*
* @var int
*/
public $_currentlyViewedContactId;
/**
- * The id of source contact and target contact
+ * The id of source contact and target contact.
*
* @var int
*/
public $_currentUserId;
/**
- * The array of form field attributes
+ * The array of form field attributes.
*
* @var array
*/
protected $_crmDir = 'Activity';
/**
- * Survey activity
+ * Survey activity.
*
* @var boolean
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Global form rule
+ * Global form rule.
*
* @param array $fields
* The input form values.
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @param array $params
}
/**
- * Process activity creation
+ * Process activity creation.
*
* @param array $params
* Associated array of submitted values.
}
/**
- * 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
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
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
*/
protected $_queryParams;
/**
- * Are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact.
*
* @var boolean
*/
protected $_single = FALSE;
/**
- * Are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact.
*
* @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
*/
protected $_ssID;
/**
- * Processing needed for buildForm and later
+ * Processing needed for buildForm and later.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
class CRM_Activity_Form_Task extends CRM_Core_Form {
/**
- * The task being performed
+ * The task being performed.
*
* @var int
*/
protected $_task;
/**
- * The additional clause that we restrict the search with
+ * The additional clause that we restrict the search with.
*
* @var string
*/
protected $_componentClause = NULL;
/**
- * The array that holds all the component ids
+ * The array that holds all the component ids.
*
* @var array
*/
protected $_componentIds;
/**
- * The array that holds all the contact ids
+ * The array that holds all the contact ids.
*
* @var array
*/
public $_contactIds;
/**
- * The array that holds all the member ids
+ * The array that holds all the member ids.
*
* @var array
*/
public $_activityHolderIds;
/**
- * Build all the data structures needed to build the form
+ * Build all the data structures needed to build the form.
*
* @param
*
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
*/
protected $_tags;
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
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
*/
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*/
public function postProcess() {
$params = $this->exportValues();
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Add local and global form rules
+ * Add local and global form rules.
*
*
* @return void
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Add local and global form rules
+ * Add local and global form rules.
*
*
* @return void
}
/**
- * 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.
*
*
* @return void
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Add local and global form rules
+ * Add local and global form rules.
*
*
* @return void
}
/**
- * 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.
*
*
* @return void
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the uploaded file
+ * Process the uploaded file.
*
* @return void
*/
/**
- * Set variables up before form is built
+ * Set variables up before form is built.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Global validation rules for the form
+ * Global validation rules for the form.
*
* @param array $fields
* Posted values of the form.
}
/**
- * Process the mapped fields and map it into the uploaded file
+ * Process the mapped fields and map it into the uploaded file.
* preview the file and extract some summary statistics
*
* @return void
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
*/
}
/**
- * Process the mapped fields and map it into the uploaded file
+ * Process the mapped fields and map it into the uploaded file.
* preview the file and extract some summary statistics
*
* @return void
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
*/
*/
/**
- * Imported file size
+ * Imported file size.
*/
protected $_fileSize;
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
*/
}
/**
- * 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
}
/**
- * Store parser values
+ * Store parser values.
*
* @param CRM_Core_Session $store
*
}
/**
- * Export data to a CSV file
+ * Export data to a CSV file.
*
* @param string $fileName
* @param array $header
protected $_newActivity;
/**
- * Class constructor
+ * Class constructor.
* @param $mapperKeys
* @param null $mapperLocType
* @param null $mapperPhoneType
}
/**
- * 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.
class CRM_Activity_Page_Tab extends CRM_Core_Page {
/**
- * Browse all activities for a particular contact
+ * Browse all activities for a particular contact.
*
* @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 bool
*/
protected $_viewOptions;
/**
- * Class constructor
+ * Class constructor.
*
* @param int $contactId
* Contact whose activities we want to display.
}
/**
- * Returns all the rows in the given offset and rowCount
+ * Returns all the rows in the given offset and rowCount.
*
* @param string $action
* The action being performed.
}
/**
- * Get colunmn headers for search selector
+ * Get colunmn headers for search selector.
*
*
* @return array
);
/**
- * Are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact.
*
* @var boolean
*/
protected $_single = FALSE;
/**
- * Are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact.
*
* @var boolean
*/
protected $_limit = NULL;
/**
- * What context are we being invoked from
+ * What context are we being invoked from.
*
* @var string
*/
protected $_context = NULL;
/**
- * What component context are we being invoked from
+ * What component context are we being invoked from.
*
* @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
*/
protected $_action;
/**
- * The additional clause that we restrict the search with
+ * The additional clause that we restrict the search with.
*
* @var string
*/
protected $_activityClause = NULL;
/**
- * The query object
+ * The query object.
*
* @var string
*/
protected $_query;
/**
- * Class constructor
+ * Class constructor.
*
* @param array $queryParams
* Array of parameters for query.
class CRM_Activity_StateMachine_Search extends CRM_Core_StateMachine {
/**
- * The task that the wizard is currently processing
+ * The task that the wizard is currently processing.
*
* @var string
*/
}
/**
- * Return the form name of the task
+ * Return the form name of the task.
*
* @return string
*/
}
/**
- * Should the controller reset the session
+ * Should the controller reset the session.
* In some cases, specifically search we want to remember
* state across various actions and want to go back to the
* beginning from the final state, but retain the same session
EMAIL_SMS = 6;
/**
- * The task array
+ * The task array.
*
* @var array
*/
static $_tasks = NULL;
/**
- * The optional task array
+ * The optional task array.
*
* @var array
*/
static $_optionalTasks = NULL;
/**
- * These tasks are the core set of tasks that the user can perform
+ * These tasks are the core set of tasks that the user can perform.
* on a contact / group of contacts
*
* @return array
}
/**
- * These tasks are the core set of task titles
+ * These tasks are the core set of task titles.
* on activity
*
* @return array
}
/**
- * Show tasks selectively based on the permission level
+ * Show tasks selectively based on the permission level.
* of the user
*
* @param int $permission
}
/**
- * These tasks are the core set of tasks that the user can perform
+ * These tasks are the core set of tasks that the user can perform.
* on activity
*
* @param int $value
}
/**
- * Takes a bunch of params that are needed to match certain criteria and.
- * retrieves the relevant objects. It also stores all the retrieved
- * values in the default array
+ * Retrieve DB object based on input parameters.
+ *
+ * It also stores all the retrieved values in the default array.
*
* @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.
public $_membershipId = NULL;
/**
- * When not to reset sort_name
+ * When not to reset sort_name.
*/
protected $_preserveDefault = TRUE;
}
/**
- * Switch to stop synchronization from CiviCRM
+ * Switch to stop synchronization from CiviCRM.
* This was always false before, and is always true
* now. Most likely, this needs to be a setting.
*/
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.
}
/**
- * Takes a bunch of params that are needed to match certain criteria and
- * retrieves the relevant objects. Typically the valid params are only
- * campaign_id.
+ * Retrieve DB object based on input parameters.
+ *
+ * It also stores all the retrieved values in the default array.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
}
/**
- * 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.
}
/**
- * 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.
}
/**
- * Get Petition Signature Total
+ * Get Petition Signature Total.
*
* @param int $surveyId
*
}
/**
- * Get Petition Signature Total
+ * Get Petition Signature Total.
*
* @param int $surveyId
*
}
/**
- * Get Petition Signature Details
+ * Get Petition Signature Details.
*
* @param int $surveyId
* @param int $status_id
}
/**
- * This function returns all entities assigned to a specific tag
+ * This function returns all entities assigned to a specific tag.
*
* @param object $tag
* An object of a tag.
}
/**
- * 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
*/
class CRM_Campaign_BAO_Survey extends CRM_Campaign_DAO_Survey {
/**
- * Takes a bunch of params that are needed to match certain criteria and
- * retrieves the relevant objects. Typically the valid params are only
- * campaign_id.
+ * Retrieve DB object based on input parameters.
+ *
+ * It also stores all the retrieved values in the default array.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
- */
-
- /**
- * The action links that we need to display for the browse screen
- *
- * @param array $params
- * @param $defaults
*
* @return CRM_Campaign_DAO_Survey|null
*/
}
/**
- * 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.
}
/**
- * Get Surveys
+ * Get Surveys.
*
* @param bool $onlyActive
* Retrieve only active surveys.
}
/**
- * Get Surveys custom groups
+ * Get Surveys custom groups.
*
* @param array $surveyTypes
* 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.
}
/**
- * Delete the survey
+ * Delete the survey.
*
* @param int $id
* Survey id.
}
/**
- * This function retrieve all option groups which are created as a result set
+ * This function retrieve all option groups which are created as a result set.
*
* @param string $valueColumnName
* @return array
}
/**
- * This function retrive all response options of survey
+ * This function retrive all response options of survey.
*
* @param int $surveyId
* Survey id.
}
/**
- * This function return all voter links with respecting permissions
+ * This function return all voter links with respecting permissions.
*
* @param int $surveyId
* @param bool $enclosedInUL
}
/**
- * Get survey supportable profile types
+ * Get survey supportable profile types.
*/
public static function surveyProfileTypes() {
static $profileTypes;
}
/**
- * Get the valid survey response fields those
+ * Get the valid survey response fields those.
* are configured with profile and custom fields.
*
* @param int $surveyId
class CRM_Campaign_Controller_Search extends CRM_Core_Controller {
/**
- * Class constructor
+ * Class constructor.
*/
public function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) {
}
/**
- * Global validation rules for the form
+ * Global validation rules for the form.
* @param $fields
* @param $files
* @param $form
}
/**
- * Form submission of petition signature
+ * Form submission of petition signature.
*
*
* @return void
}
/**
- * Build the petition profile form
+ * Build the petition profile form.
*
* @param int $id
* @param string $name
}
/**
- * check if user has already signed this petition
+ * check if user has already signed this petition.
* @param array $params
*/
public function redirectIfSigned($params) {
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
*/
protected $_queryParams;
/**
- * Are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact.
*
* @var boolean
*/
protected $_single = FALSE;
/**
- * Are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact.
*
* @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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
class CRM_Campaign_Form_Search_Campaign extends CRM_Core_Form {
/**
- * Are we forced to run a search
+ * Are we forced to run a search.
*
* @var int
*/
protected $_force;
/**
- * Processing needed for buildForm and later
+ * Processing needed for buildForm and later.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
class CRM_Campaign_Form_Search_Petition extends CRM_Core_Form {
/**
- * Are we forced to run a search
+ * Are we forced to run a search.
*
* @var int
*/
protected $_force;
/**
- * Processing needed for buildForm and later
+ * Processing needed for buildForm and later.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
class CRM_Campaign_Form_Search_Survey extends CRM_Core_Form {
/**
- * Are we forced to run a search
+ * Are we forced to run a search.
*
* @var int
*/
protected $_force;
/**
- * Processing needed for buildForm and later
+ * Processing needed for buildForm and later.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
class CRM_Campaign_Form_Survey extends CRM_Core_Form {
/**
- * The id of the object being edited
+ * The id of the object being edited.
*
* @var int
*/
protected $_surveyId;
/**
- * Action
+ * Action.
*
* @var int
*/
protected $_action;
/**
- * SurveyTitle
+ * SurveyTitle.
*
* @var string
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
/**
- * Set variables up before form is built
+ * Set variables up before form is built.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form when submitted
+ * Process the form when submitted.
*
* @return void
*/
public $_values;
/**
- * Context
+ * Context.
*
* @var string
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form
+ * Process the form.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
/**
- * Process the form
+ * Process the form.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Global validation rules for the form
+ * Global validation rules for the form.
*/
public static function formRule($fields, $files, $form) {
$errors = array();
}
/**
- * Process the form
+ * Process the form.
*
* @return void
*/
protected $_action;
/**
- * Set variables up before form is built
+ * Set variables up before form is built.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
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
private $_allowAjaxReleaseButton;
/**
- * Build all the data structures needed to build the form
+ * Build all the data structures needed to build the form.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
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
*/
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
protected $_surveyActivities;
/**
- * Build all the data structures needed to build the form
+ * Build all the data structures needed to build the form.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
protected $_numVoters;
/**
- * Build all the data structures needed to build the form
+ * Build all the data structures needed to build the form.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * 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.
*
*
* @return void
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * add shortcut to Create New
+ * add shortcut to Create New.
* @param $shortCuts
*/
public function creatNewShortcut(&$shortCuts) {
public $useLivePageJS = TRUE;
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
class CRM_Campaign_Page_DashBoard extends CRM_Core_Page {
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
}
/**
- * Confirm email verification
+ * Confirm email verification.
*
* @param int $contact_id
* The id of the contact.
public $useLivePageJS = TRUE;
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
static $_links = NULL;
/**
- * The option group name
+ * The option group name.
*
* @var array
*/
protected $_GName;
/**
- * The option group id
+ * The option group id.
*
* @var array
*/
}
/**
- * Get BAO Name
+ * Get BAO Name.
*
* @return string
* Classname of BAO.
}
/**
- * Get action Links
+ * Get action Links.
*
* @return array
* (reference) of action links
}
/**
- * Browse all options
+ * Browse all options.
*
*
* @return void
}
/**
- * Get name of edit form
+ * Get name of edit form.
*
* @return string
* Classname of edit form.
}
/**
- * Get edit form name
+ * Get edit form name.
*
* @return string
* name of this page.
}
/**
- * Get userContext params
+ * Get userContext params.
*
* @param int $mode
* Mode that we are in.
public $_queryParams;
/**
- * Represent the type of selector
+ * Represent the type of selector.
*
* @var int
*/
protected $_action;
/**
- * The additional clause that we restrict the search with
+ * The additional clause that we restrict the search with.
*
* @var string
*/
protected $_surveyClause = NULL;
/**
- * The query object
+ * The query object.
*
* @var string
*/
protected $_query;
/**
- * Class constructor
+ * Class constructor.
*
* @param array $queryParams
* Array of parameters for query.
}
/**
- * Returns all the rows in the given offset and rowCount
+ * Returns all the rows in the given offset and rowCount.
*
* @param string $action
* The action being performed.
class CRM_Campaign_StateMachine_Search extends CRM_Core_StateMachine {
/**
- * The task that the wizard is currently processing
+ * The task that the wizard is currently processing.
*
* @var string
*/
protected $_task;
/**
- * Class constructor
+ * Class constructor.
*
* @param object $controller
* @param \const|int $action
}
/**
- * Return the form name of the task
+ * Return the form name of the task.
*
* @return string
*/
}
/**
- * Takes a bunch of params that are needed to match certain criteria and
- * retrieves the relevant objects. We'll tweak this function to be more
- * full featured over a period of time. This is the inverse function of
- * create. It also stores all the retrieved values in the default array
+ * Retrieve DB object based on input parameters.
+ *
+ * It also stores all the retrieved values in the default array.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
}
/**
- * Retrieve contact_id by case_id
+ * Retrieve contact_id by case_id.
*
* @param int $caseId
* ID of the case.
}
/**
- * Takes a bunch of params that are needed to match certain criteria and
- * retrieves the relevant objects. We'll tweak this function to be more
- * full featured over a period of time. This is the inverse function of
- * create. It also stores all the retrieved values in the default array
+ * Retrieve DB object based on input parameters.
+ *
+ * It also stores all the retrieved values in the default array.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
}
/**
- * 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
}
/**
- * Getter for the qill object
+ * Getter for the qill object.
*
* @return string
*/
}
/**
- * This includes any extra fields that might need for export etc
+ * This includes any extra fields that might need for export etc.
*/
public static function extraReturnProperties($mode) {
$properties = NULL;
}
/**
- * Add all the elements shared between case search and advanaced search
+ * Add all the elements shared between case search and advanaced search.
*
*
* @param CRM_Core_Form $form
class CRM_Case_Controller_Search extends CRM_Core_Controller {
/**
- * Class constructor
+ * Class constructor.
*/
public function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) {
}
/**
- * Global validation rules for the form
+ * Global validation rules for the form.
*
* @param array $values
* Posted values of the form.
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @param CRM_Core_Form $form
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @param CRM_Core_Form $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
*/
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @param CRM_Core_Form $form
}
/**
- * Global validation rules for the form
+ * Global validation rules for the form.
*
* @param $fields
* @param $files
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @param $form
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
class CRM_Case_Form_ActivityView extends CRM_Core_Form {
/**
- * Process the view
+ * Process the view.
*
*
* @return void
public $_caseTypeId = NULL;
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Add local and global form rules
+ * Add local and global form rules.
*
*
* @return void
}
/**
- * Global validation rules for the form
+ * Global validation rules for the form.
*
* @param array $values
* Posted values of the form.
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
private $_mergeCases = FALSE;
/**
- * Set variables up before form is built
+ * Set variables up before form is built.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form
+ * Process the form.
*
* @return void
*/
protected $_entityID;
/**
- * The custom data type
+ * The custom data type.
*
* @var int
*/
protected $_cdType;
/**
- * Entity sub type of the table id
+ * Entity sub type of the table id.
*
* @var string
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form
+ * Process the form.
*
* @return void
*/
public $_report = NULL;
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
protected $_defaults;
/**
- * Processing needed for buildForm and later
+ * Processing needed for buildForm and later.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Global validation rules for the form
+ * Global validation rules for the form.
*
* @param array $fields
* Posted values of the form.
}
/**
- * Set the default form values
+ * Set the default form values.
*
*
* @return array
protected $_caseIds;
/**
- * Build all the data structures needed to build the form
+ * Build all the data structures needed to build the form.
*
* @param
*
protected $_single = FALSE;
/**
- * Are we moving case to Trash
+ * Are we moving case to Trash.
*
* @var boolean
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
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
*/
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * add shortcut to Create New
+ * add shortcut to Create New.
* @param $shortCuts
*/
public function creatNewShortcut(&$shortCuts) {
}
/**
- * Delete relationships specific to case and relationship type
+ * Delete relationships specific to case and relationship type.
*/
public static function deleteCaseRoles() {
$caseId = CRM_Utils_Type::escape($_POST['case_id'], 'Positive');
class CRM_Case_Page_Tab extends CRM_Core_Page {
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
}
/**
- * View details of a case
+ * View details of a case.
*
* @return void
*/
}
/**
- * called when action is browse
+ * called when action is browse.
*
* @return void
*/
}
/**
- * called when action is update or new
+ * called when action is update or new.
*
* @return null
*/
}
/**
- * Get action links
+ * Get action links.
*
* @return array
* (reference) of action links
static $activityTypeList = array();
/**
- * Get all the case statues
+ * Get all the case statues.
*
*
* @param string $column
}
/**
- * Get all the redaction rules
+ * Get all the redaction rules.
*
*
* @param null $filter
}
/**
- * Get all the case type
+ * Get all the case type.
*
*
* @param string $column
}
/**
- * Get all the Encounter Medium
+ * Get all the Encounter Medium.
*
*
* @param string $column
}
/**
- * Get all Activity types for the CiviCase component
+ * Get all Activity types for the CiviCase component.
*
* The static array activityType is returned
*
protected $_query;
/**
- * Class constructor
+ * Class constructor.
*
* @param array $queryParams
* Array of parameters for query.
}
/**
- * Returns all the rows in the given offset and rowCount
+ * Returns all the rows in the given offset and rowCount.
*
* @param string $action
* The action being performed.
class CRM_Case_StateMachine_Search extends CRM_Core_StateMachine {
/**
- * The task that the wizard is currently processing
+ * The task that the wizard is currently processing.
*
* @var string
*/
protected $_task;
/**
- * Class constructor
+ * Class constructor.
*
* @param object $controller
* @param \const|int $action
}
/**
- * Return the form name of the task
+ * Return the form name of the task.
*
* @return string
*/
}
/**
- * These tasks are the core set of task titles
+ * These tasks are the core set of task titles.
*
* @return array
* the set of task titles
}
/**
- * These tasks get added based on the context the user is in
+ * These tasks get added based on the context the user is in.
*
* @return array
* the set of optional tasks for a group of contacts
}
/**
- * Show tasks selectively based on the permission level
+ * Show tasks selectively based on the permission level.
* of the user
*
* @param int $permission
}
/**
- * These tasks are the core set of tasks
+ * These tasks are the core set of tasks.
*
* @param int $value
*
}
/**
- * Retrieves AllowMultipleCaseClients setting
+ * Retrieves AllowMultipleCaseClients setting.
*
* @return string
* 1 if allowed, 0 if not
}
/**
- * Retrieves NaturalActivityTypeSort setting
+ * Retrieves NaturalActivityTypeSort setting.
*
* @return string
* 1 if natural, 0 if alphabetic
class CRM_Case_XMLProcessor_Report extends CRM_Case_XMLProcessor {
/**
- * The default variable defined
+ * The default variable defined.
*
* @var boolean
*/
END";
/**
- * The types of communication preferences
+ * The types of communication preferences.
*
* @var array
*/
);
/**
- * Types of greetings
+ * Types of greetings.
*
* @var array
*/
);
/**
- * 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 $_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
*/
}
/**
- * 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.
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.
}
/**
- * 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
}
/**
- * Get the permission base on its relationship
+ * Get the permission base on its relationship.
*
* @param int $selectedContactID
* Contact id of selected contact.
}
/**
- * Make sure the checksum is valid for the passed in contactID
+ * Make sure the checksum is valid for the passed in contactID.
*
* @param int $contactID
* @param string $inputCheck
}
/**
- * Get the count of contact loctions
+ * Get the count of contact loctions.
*
* @param int $contactId
* Contact id.
}
/**
- * Create Current employer relationship for a individual
+ * Create Current employer relationship for a individual.
*
* @param int $contactID
* Contact id of the individual.
}
/**
- * Create related memberships for current employer
+ * Create related memberships for current employer.
*
* @param int $contactID
* Contact id of the individual.
}
/**
- * 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.
}
/**
- * Clear cached current employer name
+ * Clear cached current employer name.
*
* @param int $contactId
* Contact id ( mostly individual contact id).
}
/**
- * Given an array of contact ids this function will return array with links to view contact page
+ * Given an array of contact ids this function will return array with links to view contact page.
*
* @param array $contactIDs
* Associated contact id's.
}
/**
- * Function handles shared contact address processing
+ * Function handles shared contact address processing.
* In this function we just modify submitted values so that new address created for the user
* has same address as shared contact address. We copy the address so that search etc will be
* much efficient.
}
/**
- * 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.
}
/**
- * Fetch the default greeting for a given contact type
+ * Fetch the default greeting for a given contact type.
*
* @param string $contactType
* Contact type.
class CRM_Contact_BAO_ContactType extends CRM_Contact_DAO_ContactType {
/**
- * Fetch object based on array of properties
+ * Fetch object based on array of properties.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
}
/**
- * Get a list of elements for select box
+ * Get a list of elements for select box.
* Note that this used to default to using the hex(01) character - which results in an invalid character being used in form fields
* which was not handled well be anything that loaded & resaved the html (outside core)
* The use of this separator is now explicit in the calling functions as a step towards it's removal
}
/**
- * Check if a given type is a subtype
+ * Check if a given type is a subtype.
*
* @param string $subType
* Contact subType.
}
/**
- * Create shortcuts menu for contactTypes
+ * Create shortcuts menu for contactTypes.
*
* @return array
* of contactTypes
}
/**
- * Delete Contact SubTypes
+ * Delete Contact SubTypes.
*
* @param int $contactTypeId
* ID of the Contact Subtype to be deleted.
}
/**
- * 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.
}
/**
- * Function that does something
+ * Function that does something.
* @todo what does this function do?
*
* @param int $contactID
}
/**
- * Takes a bunch of params that are needed to match certain criteria and
- * retrieves the relevant objects. Typically the valid params are only
- * group_id. We'll tweak this function to be more full featured over a period
- * of time. This is the inverse function of create. It also stores all the retrieved
- * values in the default array
+ * Retrieve DB object based on input parameters.
+ *
+ * It also stores all the retrieved values in the default array.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
}
/**
- * Get the count of a members in a group with the specific status
+ * Get the count of a members in a group with the specific status.
*
* @param int $id
* Group id.
}
/**
- * Get the list of member for a group id
+ * Get the list of member for a group id.
*
* @param int $groupID
* @param bool $useCache
}
/**
- * 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.
}
/**
- * Create a new group
+ * Create a new group.
*
* @param array $params
*
}
/**
- * Defines a new smart group
+ * Defines a new smart group.
*
* @param array $params
* Associative array of parameters.
}
/**
- * Update the is_active flag in the db
+ * Update the is_active flag in the db.
*
* @param int $id
* Id of the database record.
}
/**
- * Get permission relevant clauses
+ * Get permission relevant clauses.
* CRM-12209
*
* @param bool $force
}
/**
- * wrapper for ajax group selector
+ * wrapper for ajax group selector.
*
* @param array $params
* Associated array for params record id.
}
/**
- * This function to get list of groups
+ * This function to get list of groups.
*
* @param array $params
* Associated array for params.
}
/**
- * Generate permissioned where clause for group search
+ * Generate permissioned where clause for group search.
* @param array $params
* @param bool $sortBy
* @param bool $excludeHidden
}
/**
- * Define action links
+ * Define action links.
*
* @return array
* array of action links
class CRM_Contact_BAO_GroupContact extends CRM_Contact_DAO_GroupContact {
/**
- * Class constructor
+ * Class constructor.
*/
public 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
}
/**
- * Check if there is data to create the object
+ * Check if there is data to create the object.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
}
/**
- * 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.
}
/**
- * Returns membership details of a contact for a group
+ * Returns membership details of a contact for a group.
*
* @param int $contactId
* Id of the contact.
}
/**
- * Method to get Group Id
+ * Method to get Group Id.
*
* @param int $groupContactID
* Id of a perticuler group.
}
/**
- * Function merges the groups from otherContactID to mainContactID
+ * Function merges the groups from otherContactID to mainContactID.
* along with subscription history
*
* @param int $mainContactId
}
/**
- * Change the cache_date
+ * Change the cache_date.
*
* @param array $groupID
* @param bool $processed
}
/**
- * Removes all the cache entries pertaining to a specific group
+ * Removes all the cache entries pertaining to a specific group.
* If no groupID is passed in, removes cache entries for all groups
* Has an optimization to bypass repeated invocations of this function.
* Note that this function is an advisory, i.e. the removal respects the
}
/**
- * Removes one or more contacts from the smart group cache
+ * Removes one or more contacts from the smart group cache.
* @param int|array $cid
* @param int $groupId
* @return bool
}
/**
- * 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.
}
/**
- * Get all the smart groups that this contact belongs to
+ * Get all the smart groups that this contact belongs to.
* Note that this could potentially be a super slow function since
* it ensure that all contact groups are loaded in the cache
*
private $_alreadyStyled = FALSE;
/**
- * Class constructor
+ * Class constructor.
*/
public function __construct($styleLabels = FALSE, $styleIndent = " -- ") {
parent::__construct();
class CRM_Contact_BAO_GroupOrganization extends CRM_Contact_DAO_GroupOrganization {
/**
- * Class constructor
+ * Class constructor.
*/
public 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.
}
/**
- * Format the params
+ * Format the params.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
}
/**
- * Check if there is data to create the object
+ * Check if there is data to create the object.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
}
/**
- * Method to check group organization relationship exist
+ * Method to check group organization relationship exist.
*
* @param int $contactID
*
}
/**
- * 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 int $primaryContactId
* Null if deleting primary contact.
}
/**
- * Function is used to format the individual contact values
+ * Function is used to format the individual contact values.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
}
/**
- * Creates display name
+ * Creates display name.
*
* @return string
* the constructed display name
}
/**
- * Check if there is data to create the object
+ * Check if there is data to create the object.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
class CRM_Contact_BAO_Query {
/**
- * The various search modes
+ * The various search modes.
*
* @var int
*/
MODE_MAILING = 16384;
/**
- * The default set of return properties
+ * The default set of return properties.
*
* @var array
*/
static $_defaultReturnProperties = NULL;
/**
- * The default set of hier return properties
+ * The default set of hier return properties.
*
* @var array
*/
static $_defaultHierReturnProperties;
/**
- * The set of input params
+ * The set of input params.
*
* @var array
*/
public $_fields;
/**
- * The cache to translate the option values into labels
+ * The cache to translate the option values into labels.
*
* @var array
*/
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 $_strict = FALSE;
/**
- * What operator to use to group the clauses
+ * What operator to use to group the clauses.
*
* @var string
*/
public $_mode = 1;
/**
- * Should we only search on primary location
+ * Should we only search on primary location.
*
* @var boolean
*/
public $_primaryLocation = TRUE;
/**
- * Are contact ids part of the query
+ * Are contact ids part of the query.
*
* @var boolean
*/
public $_includeContactIds = FALSE;
/**
- * Should we use the smart group cache
+ * Should we use the smart group cache.
*
* @var boolean
*/
public $_smartGroupCache = TRUE;
/**
- * Should we display contacts with a specific relationship type
+ * Should we display contacts with a specific relationship type.
*
* @var string
*/
public $_displayRelationshipType = NULL;
/**
- * Reference to the query object for custom values
+ * Reference to the query object for custom values.
*
* @var Object
*/
);
/**
- * List of location specific fields
+ * List of location specific fields.
*/
static $_locationSpecificFields = array(
'street_address',
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
*/
}
/**
- * Generate the query based on what type of query we need
+ * Generate the query based on what type of query we need.
*
* @param bool $count
* @param bool $sortByChar
}
/**
- * Given a list of conditions in params generate the required
+ * Given a list of conditions in params generate the required.
* where clause
*
* @return string
}
/**
- * Getter for tables array
+ * Getter for tables array.
*
* @return array
*/
}
/**
- * Create the from clause
+ * Create the from clause.
*
* @param array $tables
* Tables that need to be included in this from clause.
}
/**
- * Function translates selection of group type into a list of groups
+ * Function translates selection of group type into a list of groups.
* @param $value
*
* @return array
}
/**
- * All tag search specific
+ * All tag search specific.
*
* @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.
}
/**
- * Getter for the qill object
+ * Getter for the qill object.
*
* @return string
*/
}
/**
- * Default set of return default hier return properties
+ * Default set of return default hier return properties.
*
* @return array
*/
}
/**
- * Builds the necessary structures for all fields that are similar to option value lookups
+ * Builds the necessary structures for all fields that are similar to option value lookups.
*
* @param string $name
* the name of the field.
}
/**
- * Include pseudo fields LEFT JOIN
+ * Include pseudo fields LEFT JOIN.
* @param string|array $sort can be a object or string
*
* @return array|NULL
protected $_queryObjects = NULL;
/**
- * Singleton function used to manage this object
+ * Singleton function used to manage this object.
*
* @return object
*/
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
*/
}
/**
- * Takes an associative array and creates a relationship object
+ * Takes an associative array and creates a relationship object.
* @deprecated For single creates use the api instead (it's tested).
* For multiple a new variant of this function needs to be written and migrated to as this is a bit
* nasty
}
/**
- * Add relationship to recent links
+ * Add relationship to recent links.
* @param array $params
* @param CRM_Contact_DAO_Relationship $relationship
*/
}
/**
- * Specifiy defaults for creating a relationship
+ * Specifiy defaults for creating a relationship.
*
* @return array
* array of defaults for creating relationship
/**
- * Check if there is data to create the object
+ * Check if there is data to create the object.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
}
/**
- * Delete the relationship
+ * Delete the relationship.
*
* @param int $id
* Relationship id.
}
/**
- * Delete the object records that are associated with this contact
+ * Delete the object records that are associated with this contact.
*
* @param int $contactId
* Id of the contact to delete.
}
/**
- * Get the other contact in a relationship
+ * Get the other contact in a relationship.
*
* @param int $id
* Relationship id.
}
/**
- * 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.
}
/**
- * 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.
}
/**
- * This function checks for duplicate relationship
+ * This function checks for duplicate relationship.
*
* @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.
}
/**
- * Helper function to form the sql for relationship retrieval
+ * Helper function to form the sql for relationship retrieval.
*
* @param int $contactId
* Contact id.
}
/**
- * Get a list of relationships
+ * Get a list of relationships.
*
* @param int $contactId
* Contact id.
}
/**
- * Get Current Employer for Contact
+ * Get Current Employer for Contact.
*
* @param $contactIds
* Contact Ids.
/**
- * Function to return list of permissioned contacts for a given contact and relationship type
+ * Function to return list of permissioned contacts for a given contact and relationship type.
*
* @param int $contactID
* contact id whose permissioned contacts are to be found.
}
/**
- * Merge relationships from otherContact to mainContact
+ * Merge relationships from otherContact to mainContact.
* Called during contact merge operation
*
* @param int $mainId
}
/**
- * Function filters the query by possible relationships for the membership type
+ * Function filters the query by possible relationships for the membership type.
* It is intended to be called when constructing queries for the api (reciprocal & non-reciprocal)
* and to add clauses to limit the return to those relationships which COULD inherit a membership type
* (as opposed to those who inherit a particular membership
/**
- * wrapper for contact relationship selector
+ * wrapper for contact relationship selector.
*
* @param array $params
* Associated array for params record id.
class CRM_Contact_BAO_RelationshipType extends CRM_Contact_DAO_RelationshipType {
/**
- * Class constructor
+ * Class constructor.
*/
public function __construct() {
parent::__construct();
}
/**
- * Fetch object based on array of properties
+ * Fetch object based on array of properties.
*
* @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.
}
/**
- * 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.
}
/**
- * 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
*/
}
/**
- * Takes a bunch of params that are needed to match certain criteria and
- * retrieves the relevant objects.
+ * Retrieve DB object based on input parameters.
+ *
+ * It also stores all the retrieved values in the default array.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
}
/**
- * Get the where clause for a saved search
+ * Get the where clause for a saved search.
*
* @param int $id
* Saved search id.
*/
class CRM_Contact_BAO_SubscriptionHistory extends CRM_Contact_DAO_SubscriptionHistory {
/**
- * Class constructor
+ * Class constructor.
*
* @return \CRM_Contact_DAO_SubscriptionHistory
*/
}
/**
- * Create a new subscription history record
+ * Create a new subscription history record.
*
* @param array $params
* Values for the new history record.
class CRM_Contact_Form_Contact extends CRM_Core_Form {
/**
- * The contact type of the form
+ * The contact type of the form.
*
* @var string
*/
public $_contactType;
/**
- * The contact type of the form
+ * The contact type of the form.
*
* @var string
*/
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
*/
protected $_dedupeButtonName;
/**
- * Name of optional save duplicate button
+ * Name of optional save duplicate button.
*
* @var string
*/
public $_customValueCount;
/**
- * The array of greetings with option group and filed names
+ * The array of greetings with option group and filed names.
*
* @var array
*/
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
*/
}
/**
- * Global validation rules for the form
+ * Global validation rules for the form.
*
* @param array $fields
* Posted values of the form.
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * 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.
}
/**
- * Use the form name to create the tpl file name
+ * Use the form name to create the tpl file name.
*
* @return string
*/
}
/**
- * Update membership status to deceased
+ * Update membership status to deceased.
* function return the status message for updated membership.
*
* @param array $deceasedParams
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Set the default form values
+ * Set the default form values.
*
*
* @return array
class CRM_Contact_Form_DedupeFind extends CRM_Admin_Form {
/**
- * Defined defaults
+ * Defined defaults.
*/
public $_defaults;
/**
- * Pre processing
+ * Pre processing.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
protected $_rgid;
/**
- * Pre processing
+ * Pre processing.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Global validation rules for the form
+ * Global validation rules for the form.
*
* @param array $fields
* Posted values of the form.
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
protected $_id;
/**
- * The contact_id of domain
+ * The contact_id of domain.
*
* @var int
*/
protected $_fromEmailId = NULL;
/**
- * Default location type fields
+ * Default location type fields.
*
* @var array
*/
}
/**
- * This virtual function is used to set the default values of
+ * This virtual function is used to set the default values of.
* various form elements
*
* @return array
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Add local and global form rules
+ * Add local and global form rules.
*
*
* @return void
}
/**
- * Global validation rules for the form
+ * Global validation rules for the form.
*
* @param array $fields
* Posted values of the form.
}
/**
- * Process the form when submitted
+ * Process the form when submitted.
*
* @return void
*/
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
}
/**
- * Set default values for address block
+ * Set default values for address block.
*
* @param array $defaults
* Defaults associated array.
static $greetings = array();
/**
- * Build the form object elements for Communication Preferences object
+ * Build the form object elements for Communication Preferences object.
*
* @param CRM_Core_Form $form
* Reference to the form object.
}
/**
- * Global form rule
+ * Global form rule.
*
* @param array $fields
* The input form values.
}
/**
- * set array of greeting fields
+ * set array of greeting fields.
*
* @param $contactType
*
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
*
}
/**
- * Build the form object elements for CustomData object
+ * Build the form object elements for CustomData object.
*
* @param CRM_Core_Form $form
* Reference to the form object.
class CRM_Contact_Form_Edit_Demographics {
/**
- * Build the form object elements for Demographics object
+ * Build the form object elements for Demographics object.
*
* @param CRM_Core_Form $form
* Reference to the form object.
class CRM_Contact_Form_Edit_Email {
/**
- * Build the form object elements for an email object
+ * Build the form object elements for an email object.
*
* @param CRM_Core_Form $form
* Reference to the form object.
class CRM_Contact_Form_Edit_Household {
/**
- * This function provides the HTML form elements that are specific
+ * This function provides the HTML form elements that are specific.
* to the Household Contact Type
*
* @param CRM_Core_Form $form
}
/**
- * Add rule for household
+ * Add rule for household.
*
* @param array $fields
* Array of form values.
class CRM_Contact_Form_Edit_IM {
/**
- * Build the form object elements for an IM object
+ * Build the form object elements for an IM object.
*
* @param CRM_Core_Form $form
* Reference to the form object.
}
/**
- * Global form rule
+ * Global form rule.
*
* @param array $fields
* The input form values.
class CRM_Contact_Form_Edit_Lock {
/**
- * Build the form object
+ * Build the form object.
*
* @param CRM_Core_Form $form
* Form object.
class CRM_Contact_Form_Edit_Notes {
/**
- * build form elements
+ * build form elements.
* params object $form object of the form
*
* @param $form
class CRM_Contact_Form_Edit_OpenID {
/**
- * Build the form object elements for an open id object
+ * Build the form object elements for an open id object.
*
* @param CRM_Core_Form $form
* Reference to the form object.
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
*/
const GROUP = 1, TAG = 2, ALL = 3;
/**
- * build form elements
+ * build form elements.
* params object $form object of the form
*
* @param CRM_Core_Form $form
}
/**
- * Set defaults for relevant form elements
+ * Set defaults for relevant form elements.
*
* @param int $id
* The contact id.
class CRM_Contact_Form_Edit_Website {
/**
- * Build the form object elements for an Website object
+ * Build the form object elements for an Website object.
*
* @param CRM_Core_Form $form
* Reference to the form object.
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Common form elements
+ * Common form elements.
*
* @return void
*/
}
/**
- * Override default cancel action
+ * Override default cancel action.
*
* @return void
*/
}
/**
- * Set defaults for the form
+ * Set defaults for the form.
*
* @return array
*/
}
/**
- * Add entry to log table
+ * Add entry to log table.
*
* @return void
*/
}
/**
- * Common function for all inline contact edit forms
+ * Common function for all inline contact edit forms.
* Prepares ajaxResponse
*
* @return void
}
/**
- * Render changelog footer markup for a contact and supply count
+ * Render change log footer markup for a contact and supply count.
+ *
* Needed for refreshing the contact summary screen
*
* @param int $cid
* @param bool $includeCount
* @return array
*/
- static function renderFooter($cid, $includeCount = TRUE) {
- // Load changelog footer from template
+ public static function renderFooter($cid, $includeCount = TRUE) {
+ // Load change log footer from template.
$smarty = CRM_Core_Smarty::singleton();
$smarty->assign('contactId', $cid);
$smarty->assign('external_identifier', CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $cid, 'external_identifier'));
}
/**
- * Call preprocess
+ * Call preprocess.
*/
public function preProcess() {
parent::preProcess();
}
/**
- * Build the form object elements for an address object
+ * Build the form object elements for an address object.
*
* @return void
*/
}
/**
- * Set defaults for the form
+ * Set defaults for the form.
*
* @return array
*/
}
/**
- * Process the form
+ * Process the form.
*
* @return void
*/
class CRM_Contact_Form_Inline_CommunicationPreferences extends CRM_Contact_Form_Inline {
/**
- * Build the form object elements for communication preferences
+ * Build the form object elements for communication preferences.
*
* @return void
*/
}
/**
- * Set defaults for the form
+ * Set defaults for the form.
*
* @return array
*/
}
/**
- * Process the form
+ * Process the form.
*
* @return void
*/
class CRM_Contact_Form_Inline_ContactInfo extends CRM_Contact_Form_Inline {
/**
- * Build the form object elements
+ * Build the form object elements.
*
* @return void
*/
}
/**
- * Set defaults for the form
+ * Set defaults for the form.
*
* @return array
*/
}
/**
- * Process the form
+ * Process the form.
*
* @return void
*/
class CRM_Contact_Form_Inline_ContactName extends CRM_Contact_Form_Inline {
/**
- * Build the form object elements
+ * Build the form object elements.
*
* @return void
*/
}
/**
- * Process the form
+ * Process the form.
*
* @return void
*/
class CRM_Contact_Form_Inline_CustomData extends CRM_Contact_Form_Inline {
/**
- * Custom group id
+ * Custom group id.
*
* @int
*/
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();
}
/**
- * Build the form object elements for custom data
+ * Build the form object elements for custom data.
*
* @return void
*/
}
/**
- * Set defaults for the form
+ * Set defaults for the form.
*
* @return array
*/
}
/**
- * Process the form
+ * Process the form.
*
* @return void
*/
class CRM_Contact_Form_Inline_Demographics extends CRM_Contact_Form_Inline {
/**
- * Build the form object elements
+ * Build the form object elements.
*
* @return void
*/
}
/**
- * Process the form
+ * Process the form.
*
* @return void
*/
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();
/**
- * No of email blocks for inline edit
+ * No of email blocks for inline edit.
*/
private $_blockCount = 6;
/**
- * Call preprocess
+ * Call preprocess.
*/
public function preProcess() {
parent::preProcess();
}
/**
- * Build the form object elements for an email object
+ * Build the form object elements for an email object.
*
* @return void
*/
}
/**
- * Global validation rules for the form
+ * Global validation rules for the form.
*
* @param array $fields
* Posted values of the form.
}
/**
- * Set defaults for the form
+ * Set defaults for the form.
*
* @return array
*/
}
/**
- * Process the form
+ * Process the form.
*
* @return void
*/
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();
/**
- * No of im blocks for inline edit
+ * No of im blocks for inline edit.
*/
private $_blockCount = 6;
/**
- * Call preprocess
+ * Call preprocess.
*/
public function preProcess() {
parent::preProcess();
}
/**
- * Build the form object elements for im object
+ * Build the form object elements for im object.
*
* @return void
*/
}
/**
- * Global validation rules for the form
+ * Global validation rules for the form.
*
* @param array $fields
* Posted values of the form.
}
/**
- * Set defaults for the form
+ * Set defaults for the form.
*
* @return array
*/
}
/**
- * Process the form
+ * Process the form.
*
* @return void
*/
class CRM_Contact_Form_Inline_Lock {
/**
- * This function provides the HTML form elements
+ * This function provides the HTML form elements.
*
* @param CRM_Core_Form $form
* Form object.
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();
/**
- * No of openid blocks for inline edit
+ * No of openid blocks for inline edit.
*/
private $_blockCount = 6;
/**
- * Call preprocess
+ * Call preprocess.
*/
public function preProcess() {
parent::preProcess();
}
/**
- * Build the form object elements for openID object
+ * Build the form object elements for openID object.
*
* @return void
*/
}
/**
- * Global validation rules for the form
+ * Global validation rules for the form.
*
* @param array $fields
* Posted values of the form.
}
/**
- * Set defaults for the form
+ * Set defaults for the form.
*
* @return array
*/
}
/**
- * Process the form
+ * Process the form.
*
* @return void
*/
private $_blockCount = 6;
/**
- * Call preprocess
+ * Call preprocess.
*/
public function preProcess() {
parent::preProcess();
}
/**
- * Build the form object elements for phone object
+ * Build the form object elements for phone object.
*
* @return void
*/
}
/**
- * Global validation rules for the form
+ * Global validation rules for the form.
*
* @param array $fields
* Posted values of the form.
}
/**
- * Set defaults for the form
+ * Set defaults for the form.
*
* @return array
*/
}
/**
- * Process the form
+ * Process the form.
*
* @return void
*/
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();
/**
- * No of website blocks for inline edit
+ * No of website blocks for inline edit.
*/
private $_blockCount = 6;
/**
- * Call preprocess
+ * Call preprocess.
*/
public function preProcess() {
parent::preProcess();
}
/**
- * Build the form object elements for website object
+ * Build the form object elements for website object.
*
* @return void
*/
}
/**
- * Set defaults for the form
+ * Set defaults for the form.
*
* @return array
*/
}
/**
- * Process the form
+ * Process the form.
*
* @return void
*/
class CRM_Contact_Form_Location {
/**
- * Set variables up before form is built
+ * Set variables up before form is built.
*
* @param CRM_Core_Form $form
*
}
/**
- * Build the form object
+ * Build the form object.
*
* @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
*
class CRM_Contact_Form_RelatedContact extends CRM_Core_Form {
/**
- * The contact type of the form
+ * The contact type of the form.
*
* @var string
*/
public $_contactId;
/**
- * Form defaults
+ * Form defaults.
*
* @var array
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * This function is called when the form is submitted
+ * This function is called when the form is submitted.
*
*
* @return void
}
/**
- * Date validation
+ * Date validation.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
class CRM_Contact_Form_Search extends CRM_Core_Form_Search {
/**
- * list of valid contexts
+ * list of valid contexts.
*
* @var array
*/
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 $_modeValues = NULL;
/**
- * The contextMenu
+ * The contextMenu.
*
* @var array
*/
protected $_contextMenu;
/**
- * The groupId retrieved from the GET vars
+ * The groupId retrieved from the GET vars.
*
* @var int
*/
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
*/
protected $_ssID;
/**
- * The group elements
+ * The group elements.
*
* @var array
*/
public $_groupIterator;
/**
- * The tag elements
+ * The tag elements.
*
* @var array
*/
public $_tagElement;
/**
- * The params used for search
+ * The params used for search.
*
* @var array
*/
protected $_params;
/**
- * The return properties used for search
+ * The return properties used for search.
*
* @var array
*/
protected $_returnProperties;
/**
- * The sort by character
+ * The sort by character.
*
* @var string
*/
protected $_sortByCharacter;
/**
- * The profile group id used for display
+ * The profile group id used for display.
*
* @var integer
*/
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
}
/**
- * Processing needed for buildForm and later
+ * Processing needed for buildForm and later.
*
* @return void
*/
}
/**
- * Common post processing
+ * Common post processing.
*
* @return void
*/
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Use the form name to create the tpl file name
+ * Use the form name to create the tpl file name.
*
* @return string
*/
}
/**
- * Set the default form values
+ * Set the default form values.
*
*
* @return array
}
/**
- * Normalize default values for multiselect plugins
+ * Normalize default values for multiselect plugins.
*
* @param array $defaults
* @return array
static $csv = array('contact_type', 'group', 'tag');
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Set the default form values
+ * Set the default form values.
*
*
* @return array
}
/**
- * Add local and global form rules
+ * Add local and global form rules.
*
*
* @return void
}
/**
- * Processing needed for buildForm and later
+ * Processing needed for buildForm and later.
*
* @return void
*/
}
/**
- * This method is called for processing a submitted search form
+ * This method is called for processing a submitted search form.
*
* @return void
*/
class CRM_Contact_Form_Search_Builder extends CRM_Contact_Form_Search {
/**
- * Number of columns in where
+ * Number of columns in where.
*
* @var int
*/
public $_columnCount;
/**
- * Number of blocks to be shown
+ * Number of blocks to be shown.
*
* @var int
*/
public $_blockCount;
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Add local and global form rules
+ * Add local and global form rules.
*
*
* @return void
}
/**
- * Global validation rules for the form
+ * Global validation rules for the form.
*
* @param $values
* @param $files
}
/**
- * Process the uploaded file
+ * Process the uploaded file.
*
* @return void
*/
}
/**
- * Use the form name to create the tpl file name
+ * Use the form name to create the tpl file name.
*
* @return string
*/
}
/**
- * Construct the search query
+ * Construct the search query.
*/
public function all(
$offset = 0, $rowcount = 0, $sort = NULL,
}
/**
- * WHERE clause is an array built from any required JOINS plus conditional filters based on search criteria field values
+ * WHERE clause is an array built from any required JOINS plus conditional filters based on search criteria field values.
*
* @param bool $includeContactIDs
*
}
/**
- * Construct the search query
+ * Construct the search query.
*
* @param int $offset
* @param int $rowcount
}
/**
- * WHERE clause is an array built from any required JOINS plus conditional filters based on search criteria field values
+ * WHERE clause is an array built from any required JOINS plus conditional filters based on search criteria field values.
*
* @param bool $includeContactIDs
*
}
/**
- * Construct the search query
+ * Construct the search query.
*/
public function all(
$offset = 0, $rowcount = 0, $sort = NULL,
}
/**
- * WHERE clause is an array built from any required JOINS plus conditional filters based on search criteria field values
+ * WHERE clause is an array built from any required JOINS plus conditional filters based on search criteria field values.
*
* @param bool $includeContactIDs
*
}
/**
- * Construct the search query
+ * Construct the search query.
*/
public function all(
$offset = 0, $rowcount = 0, $sort = NULL,
}
/**
- * WHERE clause is an array built from any required JOINS plus conditional filters based on search criteria field values
+ * WHERE clause is an array built from any required JOINS plus conditional filters based on search criteria field values.
*
* @param bool $includeContactIDs
*
}
/**
- * Create a SQL expression for matching against a list of
+ * Create a SQL expression for matching against a list of.
* text columns.
*
* @param string $table
}
/**
- * Construct the search query
+ * Construct the search query.
*/
public function all(
$offset = 0, $rowcount = 0, $sort = NULL,
protected $_title;
/**
- * Build all the data structures needed to build the form
+ * Build all the data structures needed to build the form.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Set the default form values
+ * Set the default form values.
*
*
* @return array
}
/**
- * Add local and global form rules
+ * Add local and global form rules.
*
*
* @return void
}
/**
- * 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.
*
*
* @return void
class CRM_Contact_Form_Task_AddToHousehold extends CRM_Contact_Form_Task {
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
class CRM_Contact_Form_Task_AddToOrganization extends CRM_Contact_Form_Task {
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
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
*/
protected $_tags;
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
class CRM_Contact_Form_Task_AlterPreferences extends CRM_Contact_Form_Task {
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Set the default form values
+ * Set the default form values.
*
*
* @return array
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * 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.
*
*
* @return void
}
/**
- * Parse street address
+ * Parse street address.
* @param array $contactValues
* Contact values.
* @param CRM_Core_Form $form
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * 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.
*
*
* @return void
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();
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @param CRM_Core_Form $form
}
/**
- * Form rule
+ * 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.
*
*
* @param CRM_Core_Form $form
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
*/
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
}
/**
- * Check for presence of tokens to be swapped out
+ * Check for presence of tokens to be swapped out.
*
* @param array $contact
* @param array $mailingFormatProperties
/**
- * Get the rows for the labels
+ * Get the rows for the labels.
*
* @param $contactIDs
* @param int $locationTypeID
}
/**
- * Get array of return properties for address fields required for mailing label
+ * Get array of return properties for address fields required for mailing label.
*
* @return array
* return properties for address e.g
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
}
/**
- * 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
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
*/
}
/**
- * Use the form name to create the tpl file name
+ * Use the form name to create the tpl file name.
*
* @return string
*/
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
*/
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
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
*
}
/**
- * Build the form object
+ * Build the form object.
*
* @var CRM_Core_Form $form
*
}
/**
- * Set default values
+ * Set default values.
*/
public static function setDefaultValues() {
$defaultFormat = CRM_Core_BAO_PdfFormat::getDefaultValues();
}
/**
- * Form rule
+ * Form rule.
*
* @param array $fields
* The input form values.
}
/**
- * 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.
*
*
* @param CRM_Core_Form $form
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @param CRM_Core_Form $form
protected $_userContext;
/**
- * Build all the data structures needed to build the form
+ * Build all the data structures needed to build the form.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Add local and global form rules
+ * Add local and global form rules.
*
*
* @return void
}
/**
- * 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.
*
*
* @return void
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
*/
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
class CRM_Contact_Form_Task_ProximityCommon extends CRM_Contact_Form_Task {
/**
- * The context that we are working on
+ * The context that we are working on.
*
* @var string
*/
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @param CRM_Core_Form $form
}
/**
- * Global form rule
+ * Global form rule.
*
* @param array $fields
* The input form values.
}
/**
- * Set the default form values
+ * Set the default form values.
*
*
* @param CRM_Core_Form $form
class CRM_Contact_Form_Task_RemoveFromGroup extends CRM_Contact_Form_Task {
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Set the default form values
+ * Set the default form values.
*
*
* @return array
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
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
*/
protected $_tags;
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
public $_single = FALSE;
/**
- * All the existing templates in the system
+ * All the existing templates in the system.
*
* @var array
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @param CRM_Core_Form $form
}
/**
- * Form rule
+ * 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.
*
*
* @param CRM_Core_Form $form
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
*/
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
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
*/
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
*/
public $_displayName;
/**
- * Primary email of contact for whom we are adding user
+ * Primary email of contact for whom we are adding user.
*
* @var int
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Validation Rule
+ * Validation Rule.
*
*/
public static function usernameRule($params) {
class CRM_Contact_Import_Controller extends CRM_Core_Controller {
/**
- * Class constructor
+ * Class constructor.
*
* @param null $title
* @param bool|int $action
private $_dataSourceClass;
/**
- * Set variables up before form is built
+ * Set variables up before form is built.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Add a PK and status column to the import table so we can track our progress
+ * Add a PK and status column to the import table so we can track our progress.
* Returns the name of the primary key and status columns
*
* @param $db
protected $_formattedFieldNames;
/**
- * On duplicate
+ * On duplicate.
*
* @var int
*/
protected static $customFields;
/**
- * Attempt to match header labels with our mapper fields
+ * Attempt to match header labels with our mapper fields.
* FIXME: This is essentially the same function as parent::defaultFromHeader
*
* @param $columnName name of column header
}
/**
- * Set variables up before form is built
+ * Set variables up before form is built.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * 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_Preview extends CRM_Import_Form_Preview {
/**
- * Set variables up before form is built
+ * Set variables up before form is built.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * 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
*/
}
/**
- * Clean up the import table we used
+ * Clean up the import table we used.
*
* @return void
*/
class CRM_Contact_Import_Page_AJAX {
/**
- * Show import status
+ * Show import status.
*/
public static function status() {
// make sure we get an id
}
/**
- * Given a list of the importable field keys that the user has selected
+ * Given a list of the importable field keys that the user has selected.
* set the active fields array to this list
*
* @param array $fieldKeys
}
/**
- * 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
}
/**
- * Store parser values
+ * Store parser values.
*
* @param CRM_Core_Session $store
*
}
/**
- * Export data to a CSV file
+ * Export data to a CSV file.
*
* @param string $fileName
* @param array $header
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.
*/
public function __construct(
&$mapperKeys, $mapperLocType = NULL, $mapperPhoneType = NULL, $mapperImProvider = NULL, $mapperRelated = NULL, $mapperRelatedContactType = NULL, $mapperRelatedContactDetails = NULL, $mapperRelatedContactLocType = NULL, $mapperRelatedContactPhoneType = NULL, $mapperRelatedContactImProvider = NULL,
}
/**
- * 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.
}
/**
- * Check if an error in custom data
+ * Check if an error in custom data.
*
* @param array $params
* @param string $errorMessage
}
/**
- * Check if value present in all genders or
+ * Check if value present in all genders or.
* as a substring of any gender value, if yes than return corresponding gender.
* eg value might be m/M, ma/MA, mal/MAL, male return 'Male'
* but if value is 'maleabc' than return false
}
/**
- * Ckeck a value present or not in a array
+ * Ckeck a value present or not in a array.
*
* @param $value
* @param $valueArray
}
/**
- * Method for creating contact
+ * Method for creating contact.
*/
public function createContact(&$formatted, &$contactFields, $onDuplicate, $contactId = NULL, $requiredCheck = TRUE, $dedupeRuleGroupID = NULL) {
$dupeCheck = FALSE;
}
/**
- * Format params for update and fill mode
+ * Format params for update and fill mode.
*
* @param array $params
* reference to an array containing all the.
}
/**
- * Ajax callback for custom fields of type ContactReference
+ * Ajax callback for custom fields of type ContactReference.
*
* Todo: Migrate contact reference fields to use EntityRef
*/
}
/**
- * Fetch the custom field help
+ * Fetch the custom field help.
*/
public static function customField() {
$fieldId = CRM_Utils_Type::escape($_REQUEST['id'], 'Integer');
}
/**
- * Delete custom value
+ * Delete custom value.
*/
public static function deleteCustomValue() {
$customValueID = CRM_Utils_Type::escape($_REQUEST['valueID'], 'Positive');
}
/**
- * check the CMS username
+ * check the CMS username.
*/
static public function checkUserName() {
$signer = new CRM_Utils_Signer(CRM_Core_Key::privateKey(), array('for', 'ts'));
}
/**
- * Function to get email address of a contact
+ * Function to get email address of a contact.
*/
public static function getContactEmail() {
if (!empty($_REQUEST['contact_id'])) {
}
/**
- * Function used for CiviCRM dashboard operations
+ * Function used for CiviCRM dashboard operations.
*/
public static function dashboard() {
$operation = CRM_Utils_Type::escape($_REQUEST['op'], 'String');
}
/**
- * Retrieve signature based on email id
+ * Retrieve signature based on email id.
*/
public static function getSignature() {
$emailID = CRM_Utils_Type::escape($_REQUEST['emailID'], 'Positive');
}
/**
- * Retrieve a PDF Page Format for the PDF Letter form
+ * Retrieve a PDF Page Format for the PDF Letter form.
*/
public function pdfFormat() {
$formatId = CRM_Utils_Type::escape($_REQUEST['formatId'], 'Integer');
}
/**
- * Retrieve Paper Size dimensions
+ * Retrieve Paper Size dimensions.
*/
public static function paperSize() {
$paperSizeName = CRM_Utils_Type::escape($_REQUEST['paperSizeName'], 'String');
}
/**
- * Retrieve contact relationships
+ * Retrieve contact relationships.
*/
public static function getContactRelationships() {
$contactID = CRM_Utils_Type::escape($_GET['cid'], 'Integer');
class CRM_Contact_Page_CustomSearch extends CRM_Core_Page {
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
class CRM_Contact_Page_DashBoard extends CRM_Core_Page {
/**
- * Run dashboard
+ * Run dashboard.
*
* @return void
*/
class CRM_Contact_Page_Dashlet extends CRM_Core_Page {
/**
- * Run dashboard
+ * Run dashboard.
*
* @return void
*/
protected $_gid;
/**
- * Get BAO Name
+ * Get BAO Name.
*
* @return string
* Classname of BAO.
}
/**
- * Get action Links
+ * Get action Links.
*
* @return void
* (reference) of action links
}
/**
- * Browse all rule groups
+ * Browse all rule groups.
*
* @return void
*/
}
/**
- * Browse all rule groups
+ * Browse all rule groups.
*
* @return void
*/
}
/**
- * Get name of edit form
+ * Get name of edit form.
*
* @return string
* classname of edit form
}
/**
- * Get edit form name
+ * Get edit form name.
*
* @return string
* name of this page
}
/**
- * Get user context
+ * Get user context.
*
* @param null $mode
*
class CRM_Contact_Page_DedupeRules extends CRM_Core_Page_Basic {
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
static $_links = NULL;
/**
- * Get BAO Name
+ * Get BAO Name.
*
* @return string
* Classname of BAO.
}
/**
- * Get action Links
+ * Get action Links.
*
* @return array
* (reference) of action links
}
/**
- * Run the page
+ * Run the page.
*
* This method is called after the page is created. It checks for the type
* of action and executes that action. Finally it calls the parent's run
}
/**
- * Browse all rule groups
+ * Browse all rule groups.
*
* @return void
*/
}
/**
- * Get name of edit form
+ * Get name of edit form.
*
* @return string
* classname of edit form
}
/**
- * Get edit form name
+ * Get edit form name.
*
* @return string
* name of this page
}
/**
- * Get user context
+ * Get user context.
*
* @param null $mode
*
class CRM_Contact_Page_SavedSearch extends CRM_Core_Page {
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
}
/**
- * Get action Links
+ * Get action Links.
*
* @return array
* (reference) of action links
class CRM_Contact_Page_Task extends CRM_Core_Page {
/**
- * Returns the page title
+ * Returns the page title.
*
* @return string
* the title of the page
}
/**
- * Add urls for display in the actions menu
+ * Add urls for display in the actions menu.
* @param CRM_Core_Page $obj
* @param int $cid
*/
public $_contactId;
/**
- * called when action is browse
+ * called when action is browse.
*
*/
public function browse() {
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
*/
class CRM_Contact_Page_View_GroupContact extends CRM_Core_Page {
/**
- * called when action is browse
+ * called when action is browse.
*
*/
public function browse() {
}
/**
- * called when action is update
+ * called when action is update.
*
* @param int $groupId
*
class CRM_Contact_Page_View_Log extends CRM_Core_Page {
/**
- * called when action is browse
+ * called when action is browse.
*
* @return null
*/
static $_commentLinks = NULL;
/**
- * View details of a note
+ * View details of a note.
*
* @return void
*/
}
/**
- * called when action is browse
+ * called when action is browse.
*/
public function browse() {
$note = new CRM_Core_DAO_Note();
}
/**
- * called when action is update or new
+ * called when action is update or new.
*/
public function edit() {
$controller = new CRM_Core_Controller_Simple('CRM_Note_Form_Note', ts('Contact Notes'), $this->_action);
}
/**
- * Delete the note object from the db
+ * Delete the note object from the db.
*
* @return void
*/
}
/**
- * Get action links
+ * Get action links.
*
* @return array
* (reference) of action links
}
/**
- * Get action links for comments
+ * Get action links for comments.
*
* @return array
* (reference) of action links
}
/**
- * View summary details of a contact
+ * View summary details of a contact.
*
* @return void
*/
class CRM_Contact_Page_View_Relationship extends CRM_Core_Page {
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
static $_links = NULL;
/**
- * Casid set if called from case context
+ * Casid set if called from case context.
*
* @var int
*/
public $_contactId = NULL;
/**
- * View details of a relationship
+ * View details of a relationship.
*
* @return void
*/
}
/**
- * called when action is browse
+ * called when action is browse.
*
*/
public function browse() {
}
/**
- * called when action is update or new
+ * called when action is update or new.
*
*/
public function edit() {
}
/**
- * called to delete the relationship of a contact
+ * called to delete the relationship of a contact.
*
*/
public function delete() {
}
/**
- * Get action links
+ * Get action links.
*
* @return array
* (reference) of action links
}
/**
- * Edit name and address of a contact
+ * Edit name and address of a contact.
*
* @return void
*/
}
/**
- * View summary details of a contact
+ * View summary details of a contact.
*
* @return void
*/
class CRM_Contact_Page_View_Sunlight extends CRM_Contact_Page_View {
/**
- * called when action is browse
+ * called when action is browse.
*
* @return void
*/
class CRM_Contact_Page_View_Tag extends CRM_Core_Page {
/**
- * called when action is browse
+ * called when action is browse.
*
* @return void
*/
public $_contactId = NULL;
/**
- * Always show public groups
+ * Always show public groups.
* @var bool
*/
public $_onlyPublicGroups = TRUE;
public $_edit = TRUE;
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
}
/**
- * Build user dashboard
+ * Build user dashboard.
*
* @return void
*/
}
/**
- * Perform actions and display for user dashboard
+ * Perform actions and display for user dashboard.
*
* @return void
*/
}
/**
- * Get action links
+ * Get action links.
*
* @return array
* (reference) of action links
class CRM_Contact_Page_View_UserDashBoard_GroupContact extends CRM_Contact_Page_View_UserDashBoard {
/**
- * called when action is browse
+ * called when action is browse.
*
* @return void
*/
}
/**
- * called when action is update
+ * called when action is update.
*
* @param int $groupId
*
protected $_fields;
/**
- * Class constructor
+ * Class constructor.
*
* @param $customSearchClass
* @param array $formValues
}
/**
- * Returns all the rows in the given offset and rowCount
+ * Returns all the rows in the given offset and rowCount.
*
* @param string $action
* The action being performed.
}
/**
- * Get colunmn headers for search selector
+ * Get colunmn headers for search selector.
*
* @return array
*/
protected $_task;
/**
- * Class constructor
+ * Class constructor.
*
* @param object $controller
* @param \const|int $action
}
/**
- * Return the form name of the task
+ * Return the form name of the task.
*
* @return string
*/
}
/**
- * These tasks get added based on the context the user is in
+ * These tasks get added based on the context the user is in.
*
* @return array
* the set of optional tasks for a group of contacts
public $_component = NULL;
/**
- * Class constructor
+ * Class constructor.
*
* @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
}
/**
- * Get defaults for new entity
+ * Get defaults for new entity.
* @return array
*/
public static function getDefaults() {
}
/**
- * 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.
}
/**
- * Takes a bunch of params that are needed to match certain criteria and
- * retrieves the relevant objects. We'll tweak this function to be more
- * full featured over a period of time. This is the inverse function of
- * create. It also stores all the retrieved values in the default array
+ * Retrieve DB object based on input parameters.
+ *
+ * It also stores all the retrieved values in the default array.
*
* @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.
*
* 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
+ * Delete the indirect records associated with this contribution first.
*
* @param int $id
*
}
/**
- * Check if there is a contribution with the same trxn_id or invoice_id
+ * Check if there is a contribution with the same trxn_id or invoice_id.
*
* @param array $input
* An assoc array of name/value pairs.
}
/**
- * 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
*
}
/**
- * 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.
}
/**
- * 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.
}
/**
- * Get the contribution details for component export
+ * Get the contribution details for component export.
*
* @param int $exportMode
* Export mode.
}
/**
- * Delete billing address record related contribution
+ * Delete billing address record related contribution.
*
* @param int $contributionId
* @param int $contactId
}
/**
- * Get individual id for onbehalf contribution
+ * Get individual id for onbehalf contribution.
*
* @param int $contributionId
* Contribution id.
}
/**
- * Load objects relations to contribution object
+ * Load objects relations to contribution object.
* Objects are stored in the $_relatedObjects property
* In the first instance we are just moving functionality from BASEIpn -
* @see http://issues.civicrm.org/jira/browse/CRM-9996
}
/**
- * Check whether subscription is already cancelled
+ * Check whether subscription is already cancelled.
*
* @param int $contributionId
* Contribution id.
}
/**
- * Create all financial accounts entry
+ * Create all financial accounts entry.
*
* @param array $params
* Contribution object, line item array and params for trxn.
}
/**
- * Update all financial accounts entry
+ * Update all financial accounts entry.
*
* @param array $params
* Contribution object, line item array and params for trxn.
}
/**
- * Check status validation on update of a contribution
+ * Check status validation on update of a contribution.
*
* @param array $values
* Previous form values before submit.
}
/**
- * Delete contribution of contact
+ * Delete contribution of contact.
*
* CRM-12155
*
}
/**
- * Validate financial type
+ * Validate financial type.
*
* CRM-13231
*
/**
- * Function to record additional payment for partial and refund contributions
+ * Function to record additional payment for partial and refund contributions.
*
* @param int $contributionId
* is the invoice contribution id (got created after processing participant payment).
}
/**
- * Get list of payments displayed by Contribute_Page_PaymentInfo
+ * Get list of payments displayed by Contribute_Page_PaymentInfo.
*
* @param int $id
* @param $component
class CRM_Contribute_BAO_Contribution_Utils {
/**
- * Process payment after confirmation
+ * Process payment after confirmation.
*
* @param CRM_Core_Form $form
* Form object.
}
/**
- * Get the contribution details by year
+ * Get the contribution details by year.
*
* @return array
* associated array
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.
}
/**
- * Send the emails
+ * Send the emails.
*
* @param int $contactID
* Contact id.
}
/**
- * Construct the message to be sent by the send function
+ * Construct the message to be sent by the send function.
*
* @param array $tplParams
* @param int $contactID
}
/**
- * Send the emails for Recurring Contribution Notication
+ * Send the emails for Recurring Contribution Notication.
*
* @param string $type
* TxnType.
}
/**
- * Generate html for pdf in confirmation receipt email attachment
+ * Generate html for pdf in confirmation receipt email attachment.
* @param int $contributionId
* Contribution Page Id.
* @param int $userID
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.
}
/**
- * 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
}
/**
- * Check if there is a recurring contribution with the same trxn_id or invoice_id
+ * Check if there is a recurring contribution with the same trxn_id or invoice_id.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
}
/**
- * Get list of recurring contribution of contact Ids
+ * Get list of recurring contribution of contact Ids.
*
* @param int $contactId
* Contact ID.
class CRM_Contribute_BAO_ContributionSoft extends CRM_Contribute_DAO_ContributionSoft {
/**
- * Construct method
+ * Construct method.
*/
public 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.
}
/**
- * Fetch object based on array of properties
+ * Fetch object based on array of properties.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
}
/**
- * Delete soft credits
+ * Delete soft credits.
*
* @param array $params
*
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.
*/
public function __construct() {
parent::__construct();
}
/**
- * Fetch object based on array of properties
+ * Fetch object based on array of properties.
*
* @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.
}
/**
- * add the financial types
+ * add the financial types.
*
* @param array $params
* Reference array contains the values submitted by the form.
}
/**
- * Delete premium Types
+ * Delete premium Types.
*
* @param int $productID
*/
class CRM_Contribute_BAO_Premium extends CRM_Contribute_DAO_Premium {
/**
- * Product information
+ * Product information.
* @var array
*/
private static $productInfo;
/**
- * Class constructor
+ * Class constructor.
*/
public function __construct() {
parent::__construct();
}
/**
- * Fetch object based on array of properties
+ * Fetch object based on array of properties.
*
* @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.
}
/**
- * Delete financial Types
+ * Delete financial Types.
*
* @param int $premiumID
*
}
/**
- * Build Premium Block im Contribution Pages
+ * Build Premium Block im Contribution Pages.
*
* @param CRM_Core_Form $form
* @param int $pageID
}
/**
- * Build Premium B im Contribution Pages
+ * Build Premium B im Contribution Pages.
*
* @param CRM_Core_Form $form
* @param int $productID
}
/**
- * Retrieve premium product and their options
+ * Retrieve premium product and their options.
*
* @return array
* product and option arrays
}
/**
- * Add all the elements shared between contribute search and advnaced search
+ * Add all the elements shared between contribute search and advnaced search.
*
*
* @param CRM_Core_Form $form
}
/**
- * Add the where for dates
+ * Add the where for dates.
*
* @param array $values
* Array of query values.
*/
protected $_paymentProcessors = array();
/**
- * The id of the contribution that we are processing
+ * The id of the contribution that we are processing.
*
* @var int
*/
public $_id;
/**
- * The id of the premium that we are proceessing
+ * The id of the premium that we are proceessing.
*
* @var int
*/
}
/**
- * Assign billing type id to bltID
+ * Assign billing type id to bltID.
*
* @throws CRM_Core_Exception
* @return void
}
/**
- * Process the Premium Information
+ * Process the Premium Information.
*
*
* @param array $params
}
/**
- * Process the Note
+ * Process the Note.
*
*
* @param array $params
}
/**
- * Process the Common data
+ * Process the Common data.
*
*
* @param array $params
protected $_selfService = FALSE;
/**
- * Set variables up before form is built
+ * Set variables up before form is built.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
*/
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 $_id;
/**
- * The id of the premium that we are processing
+ * The id of the premium that we are processing.
*
* @var int
*/
public $_productDAO = NULL;
/**
- * The id of the note
+ * The id of the note.
*
* @var int
*/
public $_noteID;
/**
- * The id of the contact associated with this contribution
+ * The id of the contact associated with this contribution.
*
* @var int
*/
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 $_ppID;
/**
- * The id of the pledge that we are processing
+ * The id of the pledge that we are processing.
*
* @var int
*/
public $_pledgeID;
/**
- * Is this contribution associated with an online
+ * Is this contribution associated with an online.
* financial transaction
*
* @var boolean
public $_context;
/**
- * Parameter with confusing name
+ * Parameter with confusing name.
* @todo what is it?
* @var string
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Global form rule
+ * Global form rule.
*
* @param array $fields
* The input form values.
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
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
*/
/**
- * The id of the contribution object that is created when the form is submitted
+ * The id of the contribution object that is created when the form is submitted.
*
* @var int
*/
public $_contributionID;
/**
- * Set the parameters to be passed to contribution create function
+ * Set the parameters to be passed to contribution create function.
*
* @param array $params
* @param int $contactID
}
/**
- * Set variables up before form is built
+ * Set variables up before form is built.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form
+ * Process the form.
*
* @return void
*/
class CRM_Contribute_Form_Contribution_Main extends CRM_Contribute_Form_ContributionBase {
/**
- * Define default MembershipType Id
+ * Define default MembershipType Id.
*/
public $_defaultMemTypeId;
protected $_snippet;
/**
- * Set variables up before form is built
+ * Set variables up before form is built.
*
* @return void
*/
}
/**
- * Set the default values
+ * Set the default values.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Build elements to collect information for recurring contributions
+ * Build elements to collect information for recurring contributions.
*
*
* @param CRM_Core_Form $form
}
/**
- * Global form rule
+ * Global form rule.
*
* @param array $fields
* The input form values.
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
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
*
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
public $_isBillingAddressRequiredForPayLater;
/**
- * Set variables up before form is built
+ * Set variables up before form is built.
*
* @throws \CRM_Contribute_Exception_InactiveContributionPageException
* @throws \Exception
}
/**
- * Set the default values
+ * Set the default values.
*
* @return void
*/
}
/**
- * Assign the minimal set of variables to the template
+ * Assign the minimal set of variables to the template.
*
* @return void
*/
}
/**
- * Add the custom fields
+ * Add the custom fields.
*
* @param int $id
* @param string $name
}
/**
- * Check template file exists
+ * Check template file exists.
* @param null $suffix
*
* @return null|string
}
/**
- * Use the form name to create the tpl file name
+ * Use the form name to create the tpl file name.
*
* @return string
*/
class CRM_Contribute_Form_ContributionCharts extends CRM_Core_Form {
/**
- * Year of chart
+ * Year of chart.
*
* @var int
*/
protected $_year = NULL;
/**
- * The type of chart
+ * The type of chart.
*
* @var string
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
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
*/
protected $_id;
/**
- * The pledgeBlock id saved to the session for an update
+ * The pledgeBlock id saved to the session for an update.
*
* @var int
*/
protected $_values;
/**
- * Set variables up before form is built
+ * Set variables up before form is built.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form
+ * Process the form.
*
* @return void
*/
}
/**
- * Use the form name to create the tpl file name
+ * Use the form name to create the tpl file name.
*
* @return string
*/
protected $_pid;
/**
- * Pre process the form
+ * Pre process the form.
*
*
* @return void
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form
+ * Process the form.
*
* @return void
*/
const NUM_OPTION = 11;
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Global form rule
+ * Global form rule.
*
* @param array $fields
* The input form values.
}
/**
- * Process the form
+ * Process the form.
*
* @return void
*/
class CRM_Contribute_Form_ContributionPage_Custom extends CRM_Contribute_Form_ContributionPage {
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form
+ * Process the form.
*
* @return void
*/
}
/**
- * Global form rule
+ * Global form rule.
*
* @param array $fields
* The input form values.
class CRM_Contribute_Form_ContributionPage_Delete extends CRM_Contribute_Form_ContributionPage {
/**
- * Page title
+ * Page title.
*
* @var string
*/
protected $_title;
/**
- * Check if there are any related contributions
+ * Check if there are any related contributions.
*/
protected $_relatedContributions;
/**
- * Set variables up before form is built
+ * Set variables up before form is built.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form when submitted
+ * Process the form when submitted.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Validation
+ * Validation.
*
* @param array $params
* (ref.) an assoc array of name/value pairs.
}
/**
- * Process the form
+ * Process the form.
*
* @return void
*/
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Global validation rules for the form
+ * Global validation rules for the form.
*
* @param array $values
* Posted values of the form.
}
/**
- * Process the form
+ * Process the form.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Global form rule
+ * Global form rule.
*
* @param array $fields
* The input form values.
}
/**
- * Process the form
+ * Process the form.
*
* @return void
*/
}
/**
- * 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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
class CRM_Contribute_Form_ManagePremiums extends CRM_Contribute_Form {
/**
- * Pre process the form
+ * Pre process the form.
*
*
* @return void
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Function for validation
+ * Function for validation.
*
* @param array $params
* (ref.) an assoc array of name/value pairs.
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
}
/**
- * Resize a premium image to a different size
+ * Resize a premium image to a different size.
*
*
* @param string $filename
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
*/
protected $_queryParams;
/**
- * Are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact.
*
* @var boolean
*/
protected $_single = FALSE;
/**
- * Are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact.
*
* @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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
class CRM_Contribute_Form_SearchContribution extends CRM_Core_Form {
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
class CRM_Contribute_Form_SoftCredit {
/**
- * Set variables up before form is built
+ * Set variables up before form is built.
*
* @param CRM_Core_Form $form
*
/**
- * Function used to build form element for soft credit block
+ * Function used to build form element for soft credit block.
*
* @param CRM_Core_Form $form
*
}
/**
- * Function used to set defaults for soft credit block
+ * Function used to set defaults for soft credit block.
*
* @param $defaults
* @param $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
*/
protected $_task;
/**
- * The additional clause that we restrict the search with
+ * The additional clause that we restrict the search with.
*
* @var string
*/
protected $_componentClause = NULL;
/**
- * The array that holds all the component ids
+ * The array that holds all the component ids.
*
* @var array
*/
protected $_componentIds;
/**
- * The array that holds all the contribution ids
+ * The array that holds all the contribution ids.
*
* @var array
*/
protected $_contributionIds;
/**
- * The array that holds all the contact ids
+ * The array that holds all the contact ids.
*
* @var array
*/
public $_contactIds;
/**
- * The array that holds all the mapping contribution and contact ids
+ * The array that holds all the mapping contribution and contact ids.
*
* @var array
*/
protected $_contributionContactIds = array();
/**
- * The flag to tell if there are soft credits included
+ * The flag to tell if there are soft credits included.
*
* @var boolean
*/
public $_includesSoftCredits = FALSE;
/**
- * Build all the data structures needed to build the form
+ * Build all the data structures needed to build the form.
*
* @param
*
protected $_userContext;
/**
- * Build all the data structures needed to build the form
+ * Build all the data structures needed to build the form.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
public $_single = FALSE;
/**
- * Gives all the statues for conribution
+ * Gives all the statues for conribution.
*/
public $_contributionStatusId;
/**
- * Gives the HTML template of PDF Invoice
+ * Gives the HTML template of PDF Invoice.
*/
public $_messageInvoice;
/**
- * This variable is used to assign parameters for HTML template of PDF Invoice
+ * This variable is used to assign parameters for HTML template of PDF Invoice.
*/
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * 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.
*
*
* @return void
}
/**
- * Process the PDf and email with activity and attachment
+ * Process the PDf and email with activity and attachment.
* on click of Print Invoices
*
* @param array $contribIDs
}
/**
- * Add activity for Email Invoice and the PDF Invoice
+ * Add activity for Email Invoice and the PDF Invoice.
*
* @param string $subject
* Activity subject.
}
/**
- * Create the Invoice file in upload folder for attachment
+ * Create the Invoice file in upload folder for attachment.
*
* @param string $html
* Content for pdf in html format.
protected $_rows;
/**
- * Build all the data structures needed to build the form
+ * Build all the data structures needed to build the form.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Set default values
+ * Set default values.
*/
public function setDefaultValues() {
$defaultFormat = CRM_Core_BAO_PdfFormat::getDefaultValues();
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
}
/**
- * Declaration of common variables for Invoice and PDF
+ * Declaration of common variables for Invoice and PDF.
*
*
* @param array $contribIds
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
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.
*
*
* @param CRM_Contribute_Form_Task $form
}
/**
- * Send pdf by email
+ * Send pdf by email.
*
* @param array $contact
* @param string $html
protected $_userContext;
/**
- * Build all the data structures needed to build the form
+ * Build all the data structures needed to build the form.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Add local and global form rules
+ * Add local and global form rules.
*
*
* @return void
}
/**
- * 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.
*
*
* @return void
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
*/
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
protected $_rows;
/**
- * Build all the data structures needed to build the form
+ * Build all the data structures needed to build the form.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * 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.
*
*
* @return void
public $_paymentProcessorObj = NULL;
/**
- * Set variables up before form is built
+ * Set variables up before form is built.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Global form rule
+ * Global form rule.
*
* @param array $fields
* The input form values.
}
/**
- * Process the form
+ * Process the form.
*
* @return void
*/
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
*/
}
/**
- * Actually build the components of the form
+ * Actually build the components of the form.
*
* @return void
*/
}
/**
- * called after the user submits the form
+ * called after the user submits the form.
*
*
* @return void
class CRM_Contribute_Import_Controller extends CRM_Core_Controller {
/**
- * Class constructor
+ * Class constructor.
*
* @param null $title
* @param bool|int $action
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the uploaded file
+ * Process the uploaded file.
*
* @return void
*/
/**
- * Set variables up before form is built
+ * Set variables up before form is built.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * 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
*/
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
*/
}
/**
- * 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
}
/**
- * Store parser values
+ * Store parser values.
*
* @param CRM_Core_Session $store
*
}
/**
- * Export data to a CSV file
+ * Export data to a CSV file.
*
* @param string $fileName
* @param array $header
}
/**
- * Determines the file extension based on error code
+ * Determines the file extension based on error code.
*
* @param int $type
* Error code constant.
}
/**
- * Determines the file name based on error code
+ * Determines the file name based on error code.
*
* @param int $type
* Error code constant.
}
/**
- * 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.
}
/**
- * Provides permissions that are unwise for Anonymous Roles to have
+ * Provides permissions that are unwise for Anonymous Roles to have.
*
* @return array
* list of permissions
}
/**
- * add shortcut to Create New
+ * add shortcut to Create New.
* @param $shortCuts
* @param $newCredit
*/
class CRM_Contribute_Page_ContributionPage extends CRM_Core_Page {
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
}
/**
- * Browse all contribution pages
+ * Browse all contribution pages.
*
* @param mixed $action
* Unused parameter.
public $_contactId = NULL;
/**
- * View details of a recurring contribution
+ * View details of a recurring contribution.
*
* @return void
*/
public $useLivePageJS = TRUE;
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
static $_links = NULL;
/**
- * Get BAO Name
+ * Get BAO Name.
*
* @return string
* Classname of BAO.
}
/**
- * Get action Links
+ * Get action Links.
*
* @return array
* (reference) of action links
}
/**
- * Get name of edit form
+ * Get name of edit form.
*
* @return string
* Classname of edit form.
}
/**
- * Get edit form name
+ * Get edit form name.
*
* @return string
* name of this page.
class CRM_Contribute_Page_Premium extends CRM_Core_Page_Basic {
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
static $_links = NULL;
/**
- * Get BAO Name
+ * Get BAO Name.
*
* @return string
* Classname of BAO.
}
/**
- * Get action Links
+ * Get action Links.
*
* @return array
* (reference) of action links
}
/**
- * Get name of edit form
+ * Get name of edit form.
*
* @return string
* Classname of edit form.
}
/**
- * Get edit form name
+ * Get edit form name.
*
* @return string
* name of this page.
class CRM_Contribute_Page_Tab extends CRM_Core_Page {
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
// end function
/**
- * called when action is browse
+ * called when action is browse.
*
*/
public function browse() {
}
/**
- * called when action is view
+ * called when action is view.
*
* @return null
*/
}
/**
- * called when action is update or new
+ * called when action is update or new.
*
* @return null
*/
class CRM_Contribute_Page_UserDashboard extends CRM_Contact_Page_View_UserDashBoard {
/**
- * called when action is browse
+ * called when action is browse.
*/
public function listContribution() {
$controller = new CRM_Core_Controller_Simple(
}
/**
- * Get all the valid accepted credit cards
+ * Get all the valid accepted credit cards.
*
*
* @return array
}
/**
- * Get all premiums
+ * Get all premiums.
*
*
* @param int $pageID
}
/**
- * Get all the contribution statuses
+ * Get all the contribution statuses.
*
*
* @param int $id
}
/**
- * Get all the Personal campaign pages
+ * Get all the Personal campaign pages.
*
*
* @param null $pageType
}
/**
- * Get all batches
+ * Get all batches.
*
*
* @param int $id
protected $_includeSoftCredits = FALSE;
/**
- * Class constructor
+ * Class constructor.
*
* @param array $queryParams
* Array of parameters for query.
}
/**
- * Returns all the rows in the given offset and rowCount
+ * Returns all the rows in the given offset and rowCount.
*
* @param string $action
* The action being performed.
class CRM_Contribute_StateMachine_Contribution extends CRM_Core_StateMachine {
/**
- * Class constructor
+ * Class constructor.
*
* @param CRM_Core_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.
*
* @param object $controller
* @param \const|int $action
}
/**
- * Return the form name of the task
+ * Return the form name of the task.
*
* @return string
*/
class CRM_Core_BAO_ActionLog extends CRM_Core_DAO_ActionLog {
/**
- * Create or update an action log entry
+ * Create or update an action log entry.
*
* @param array $params
*
}
/**
- * Get all fields of the type Date
+ * Get all fields of the type Date.
*/
public static function getDateFields() {
$allFields = CRM_Core_BAO_CustomField::getFields('');
}
/**
- * Retrieve list of Scheduled Reminders
+ * Retrieve list of Scheduled Reminders.
*
* @param bool $namesOnly
* Return simple list of names.
}
/**
- * 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.
}
/**
- * Takes a bunch of params that are needed to match certain criteria and
- * retrieves the relevant objects. It also stores all the retrieved
- * values in the default array
+ * Retrieve DB object based on input parameters.
+ *
+ * It also stores all the retrieved values in the default array.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
}
/**
- * 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.
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.
}
/**
- * 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.
}
/**
- * 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.
}
/**
- * Check if there is data to create the object
+ * Check if there is data to create the object.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
}
/**
- * Get address sequence
+ * Get address sequence.
*
* @return array
* Array of address sequence.
}
/**
- * Check if current address is used by any other contacts
+ * Check if current address is used by any other contacts.
*
* @param int $addressId
* Address id.
}
/**
- * 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.
}
/**
- * Update the shared addresses if master address is modified
+ * Update the shared addresses if master address is modified.
*
* @param int $addressId
* Address id.
}
/**
- * Merge contacts with the Same address to get one shared label
+ * Merge contacts with the Same address to get one shared label.
* @param array $rows
* Array[contact_id][contactDetails].
*/
}
/**
- * 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
}
/**
- * Check and set the status for shared address delete
+ * Check and set the status for shared address delete.
*
* @param int $addressId
* Address id.
}
/**
- * Call common delete function
+ * Call common delete function.
*/
public static function del($id) {
return CRM_Contact_BAO_Contact::deleteObjectWithPrimary('Address', $id);
class CRM_Core_BAO_Block {
/**
- * Fields that are required for a valid block
+ * Fields that are required for a valid block.
*/
static $requiredBlockFields = array(
'email' => array('email'),
}
/**
- * 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.
}
/**
- * Check if the current block exits
+ * Check if the current block exits.
*
* @param string $blockName
* Bloack name.
}
/**
- * Get all block ids for a contact
+ * Get all block ids for a contact.
*
* @param string $blockName
* Block name.
}
/**
- * Takes an associative array and creates a block
+ * Takes an associative array and creates a block.
*
* @param string $blockName
* Block name.
}
/**
- * Delete block
+ * Delete block.
*
* @param string $blockName
* Block name.
}
/**
- * Sort location array so primary element is first
+ * Sort location array so primary element is first.
*
* @param array $locations
*/
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.
}
/**
- * Create CMS user using Profile
+ * Create CMS user using Profile.
*
* @param array $params
* @param string $mail
}
/**
- * Create Form for CMS user using Profile
+ * Create Form for CMS user using Profile.
*
* @param CRM_Core_Form $form
* @param int $gid
static $_cache = NULL;
/**
- * Retrieve an item from the DB cache
+ * Retrieve an item from the DB cache.
*
* @param string $group
* (required) The group name of the item.
}
/**
- * Retrieve all items in a group
+ * Retrieve all items in a group.
*
* @param string $group
* (required) The group name of the item.
}
/**
- * Store an item in the DB cache
+ * Store an item in the DB cache.
*
* @param object $data
* (required) A reference to the data that will be serialized and stored.
}
/**
- * 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.
}
/**
- * 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).
}
/**
- * Retrieve the settings values from db
+ * Retrieve the settings values from db.
*
* @param $defaults
*
}
/**
- * Return likely default settings
+ * Return likely default settings.
* @return array
* site settings
* - $url
}
/**
- * 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
public static $_importFields = NULL;
/**
- * Build and retrieve the list of data types and descriptions
+ * Build and retrieve the list of data types and descriptions.
*
* @return array
* Data type => Description
}
/**
- * 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
*
}
/**
- * Fetch object based on array of properties
+ * Fetch object based on array of properties.
*
* @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.
}
/**
- * Get the field id from an import key
+ * Get the field id from an import key.
*
* @param string $key
* The key to parse.
}
/**
- * Use the cache to get all values of a specific custom field
+ * Use the cache to get all values of a specific custom field.
*
* @param int $fieldID
* The custom field ID.
}
/**
- * This function for building custom fields
+ * This function for building custom fields.
*
* @param CRM_Core_Form $qf
* Form object (reference).
}
/**
- * Set default values for custom data used in profile
+ * Set default values for custom data used in profile.
*
* @param int $customFieldId
* Custom field id.
}
/**
- * Format custom fields before inserting
+ * Format custom fields before inserting.
*
* @param int $customFieldId
* Custom field id.
}
/**
- * Determine whether it would be safe to move a field
+ * Determine whether it would be safe to move a field.
*
* @param int $fieldID
* FK to civicrm_custom_field.
}
/**
- * Get the database table name and column name for a custom field
+ * Get the database table name and column name for a custom field.
*
* @param int $fieldID
* The fieldID of the custom field.
}
/**
- * Get custom option groups
+ * Get custom option groups.
*
* @param array $includeFieldIds
* Ids of custom fields for which.
}
/**
- * Fix orphan groups
+ * Fix orphan groups.
*
* @param int $customFieldId
* Custom field id.
class CRM_Core_BAO_CustomGroup extends CRM_Core_DAO_CustomGroup {
/**
- * Class constructor
+ * Class constructor.
*/
public 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
*
}
/**
- * Fetch object based on array of properties
+ * Fetch object based on array of properties.
*
* @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.
}
/**
- * 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.
}
/**
- * Build custom data view
+ * Build custom data view.
*
* @param CRM_Core_Form $form
* Page object.
class CRM_Core_BAO_CustomOption {
/**
- * Fetch object based on array of properties
+ * Fetch object based on array of properties.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
}
/**
- * Returns all active options ordered by weight for a given field
+ * Returns all active options ordered by weight for a given field.
*
* @param int $fieldID
* Field whose options are needed.
}
/**
- * Delete Option
+ * Delete Option.
*
* @param $optionId integer
* option id
class CRM_Core_BAO_CustomValue extends CRM_Core_DAO {
/**
- * Validate a value against a CustomField type
+ * Validate a value against a CustomField type.
*
* @param string $type
* The type of the data.
}
/**
- * Delete option value give an option value and custom group id
+ * Delete option value give an option value and custom group id.
*
* @param int $customValueID
* Custom value ID.
}
/**
- * 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
* @param int $maxLength
'file_id' => $customValue['file_id'],
);
- // fix Date type to be timestamp, since that is how we store in db
+ // Fix Date type to be timestamp, since that is how we store in db.
if ($cvParam['type'] == 'Date') {
$cvParam['type'] = 'Timestamp';
}
}
/**
+ * Post process function.
+ *
* @param array $params
* @param $customFields
* @param $entityTable
}
$cond = implode(' AND ', $cond);
- // first find all the fields that extend this type of entity
+ // First find all the fields that extend this type of entity.
$query = "
SELECT cg.table_name,
cg.id as groupID,
if ($isMultiple[$tableName]) {
if ($formatMultiRecordField) {
$result["{$dao->id}"]["{$fieldID}"] = $dao->$fieldName;
- } else {
+ }
+ else {
$result["{$fieldID}_{$dao->id}"] = $dao->$fieldName;
}
}
*/
class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard {
/**
- * Add Dashboard
+ * Add Dashboard.
*
* @param array $params
* Values.
}
/**
- * Get the list of dashlets enabled by admin
+ * Get the list of dashlets enabled by admin.
*
* @param bool $all
* All or only active.
}
/**
- * Setup default dashlets for new users
+ * Setup default dashlets for new users.
*
* When a user accesses their dashboard for the first time, set up
* the default dashlets.
/**
- * Check dashlet permission for current user
+ * Check dashlet permission for current user.
*
* @param string $permission
* Comma separated list.
}
/**
- * Get details of each dashlets
+ * Get details of each dashlets.
*
* @param int $dashletID
* Widget ID.
}
/**
- * Save changes made by use to the Dashlet
+ * Save changes made by use to the Dashlet.
*
* @param array $columns
*
}
/**
- * Add dashlets
+ * Add dashlets.
*
* @param array $params
*
}
/**
- * Update contact dashboard with new dashlet
+ * Update contact dashboard with new dashlet.
*
* @param object : $dashlet
*
}
/**
- * Reset dashlet cache
+ * Reset dashlet cache.
*
* @param int $contactID
* Reset cache only for specific contact.
}
/**
- * Delete Dashlet
+ * Delete Dashlet.
*
* @param int $dashletID
*
class CRM_Core_BAO_Discount extends CRM_Core_DAO_Discount {
/**
- * Class constructor
+ * Class constructor.
*/
public function __construct() {
parent::__construct();
}
/**
- * Delete the discount
+ * Delete the discount.
*
* @param int $entityId
* @param string $entityTable
}
/**
- * Determine in which discount set the registration date falls
+ * Determine in which discount set the registration date falls.
*
* @param int $entityID
* Entity id to be searched.
class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain {
/**
- * Cache for the current domain object
+ * Cache for the current domain object.
*/
static $_domain = NULL;
private $_location = NULL;
/**
- * Fetch object based on array of properties
+ * Fetch object based on array of properties.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
}
/**
- * Get the domain BAO
+ * Get the domain BAO.
*
* @param null $reset
*
}
/**
- * Get the location values of a domain
+ * Get the location values of a domain.
*
* @return array
* Location::getValues
}
/**
- * Save the values of a domain
+ * Save the values of a domain.
*
* @param array $params
* @param int $id
}
/**
- * Create a new domain
+ * Create a new domain.
*
* @param array $params
*
}
/**
- * 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.
}
/**
- * Call common delete function
+ * Call common delete function.
*/
public static function del($id) {
return CRM_Contact_BAO_Contact::deleteObjectWithPrimary('Email', $id);
}
/**
- * 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
}
/**
- * Check if there is data to create the object
+ * Check if there is data to create the object.
*
* @param array $params
* An assoc array of name/value pairs.
}
/**
- * 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.
}
/**
- * This function returns all entities assigned to a specific tag
+ * This function returns all entities assigned to a specific tag.
*
* @param object $tag
* An object of a tag.
}
/**
- * Get contact tags
+ * Get contact tags.
*/
public static function getContactTags($contactID, $count = FALSE) {
$contactTags = array();
}
/**
- * Get child contact tags given parentId
+ * Get child contact tags given parentId.
*/
public static function getChildEntityTags($parentId, $entityId, $entityTable = 'civicrm_contact') {
$entityTags = array();
class CRM_Core_BAO_Extension extends CRM_Core_DAO_Extension {
/**
- * Fetch object based on array of properties
+ * Fetch object based on array of properties.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
}
/**
- * Delete an extension
+ * Delete an extension.
*
* @param int $id
* Id of the extension to be deleted.
}
/**
- * Change the schema version of an extension
+ * Change the schema version of an extension.
*
* @param string $fullName
* the fully-qualified name (eg "com.example.myextension").
}
/**
- * Determine the schema version of an extension
+ * Determine the schema version of an extension.
*
* @param string $fullName
* the fully-qualified name (eg "com.example.myextension").
*/
class CRM_Core_BAO_FinancialTrxn extends CRM_Financial_DAO_FinancialTrxn {
/**
- * Class constructor
+ * Class constructor.
*
* @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.
}
/**
- * Fetch object based on array of properties
+ * Fetch object based on array of properties.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
}
/**
- * Delete financial transaction
+ * Delete financial transaction.
*
* @param int $entity_id
* @return bool
}
/**
- * Create financial transaction for premium
+ * Create financial transaction for premium.
*
*/
public static function createPremiumTrxn($params) {
}
/**
- * 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.
}
/**
- * get partial payment amount and type of it
+ * get partial payment amount and type of it.
*
* @param int $entityId
* @param string $entityName
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.
}
/**
- * Call common delete function
+ * Call common delete function.
*/
public static function del($id) {
return CRM_Contact_BAO_Contact::deleteObjectWithPrimary('IM', $id);
class CRM_Core_BAO_Job extends CRM_Core_DAO_Job {
/**
- * Class constructor
+ * Class constructor.
*/
public function __construct() {
parent::__construct();
}
/**
- * Takes a bunch of params that are needed to match certain criteria and
- * retrieves the relevant objects. It also stores all the retrieved
- * values in the default array
+ * Retrieve DB object based on input parameters.
+ *
+ * It also stores all the retrieved values in the default array.
*
* @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.
}
/**
- * Function to delete scheduled job
+ * Function to delete scheduled job.
*
* @param $jobID
* ID of the job to be deleted.
}
/**
- * Trim job table on a regular basis to keep it at a good size
+ * Trim job table on a regular basis to keep it at a good size.
*
* CRM-10513
*/
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;
}
/**
- * Get Option Group ID for Label Formats
+ * Get Option Group ID for Label Formats.
*
* @param string $name
*
}
/**
- * Add ordering fields to Label Format list
+ * Add ordering fields to Label Format list.
*
* @param array (reference) $list List of Label Formats
* @param string $returnURL
}
/**
- * Retrieve the default Label Format values
+ * Retrieve the default Label Format values.
*
* @param string $groupName
* Label format group name.
}
/**
- * Get Label Format from the DB
+ * Get Label Format from the DB.
*
* @param string $field
* Field name to search by.
}
/**
- * Get Label Format by Name
+ * Get Label Format by Name.
*
* @param int $name
* Label format name. Empty = get default label format.
}
/**
- * Get Label Format by ID
+ * Get Label Format by ID.
*
* @param int $id
* Label format id. 0 = get default label format.
}
/**
- * Get Label Format field from associative array
+ * Get Label Format field from associative array.
*
* @param string $field
* Name of a label format field.
}
/**
- * Takes a bunch of params that are needed to match certain criteria and
- * retrieves the relevant objects. Typically the valid params are only
- * label id. It also stores all the retrieved values in the default array.
+ * Retrieve DB object based on input parameters.
+ *
+ * It also stores all the retrieved values in the default array.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
}
/**
- * Return the name of the group for customized labels
+ * Return the name of the group for customized labels.
*
* @return void
*/
}
/**
- * Save the Label Format in the DB
+ * Save the Label Format in the DB.
*
* @param array (reference) $values associative array of name/value pairs
* @param int $id
}
/**
- * Delete a Label Format
+ * Delete a Label Format.
*
* @param int $id
* ID of the label format to be deleted.
class CRM_Core_BAO_Location extends CRM_Core_DAO {
/**
- * Location block element array
+ * Location block element array.
*/
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.
}
/**
- * Creates the entry in the civicrm_loc_block
+ * Creates the entry in the civicrm_loc_block.
*/
public static function createLocBlock(&$location, &$entityElements) {
$locId = self::findExisting($entityElements);
}
/**
- * Takes an entity array and finds the existing location block
+ * Takes an entity array and finds the existing location block.
*/
public static function findExisting($entityElements) {
$eid = $entityElements['entity_id'];
}
/**
- * 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.
}
/**
- * Delete the Location Block
+ * Delete the Location Block.
*
* @param int $locBlockId
* Id of the Location Block.
}
/**
- * Check if there is data to create the object
+ * Check if there is data to create the object.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
}
/**
- * Delete all the block associated with the location
+ * Delete all the block associated with the location.
*
* @param int $contactId
* Contact id.
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.
*/
public function __construct() {
parent::__construct();
}
/**
- * Fetch object based on array of properties
+ * Fetch object based on array of properties.
*
* @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.
}
/**
- * Retrieve the default location_type
+ * Retrieve the default location_type.
*
* @return object
* The default location type object on success,
}
/**
- * Get ID of billing location type
+ * Get ID of billing location type.
*
* @return int
*/
}
/**
- * 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.
}
/**
- * Add log to civicrm_log table
+ * Add log to civicrm_log table.
*
* @param array $params
* Array of name-value pairs of log table.
}
/**
- * Get log record count for a Contact
+ * Get log record count for a Contact.
*
* @param int $contactID
*
}
/**
- * Function for find out whether to use logging schema entries for contact
+ * Function for find out whether to use logging schema entries for contact.
* summary, instead of normal log entries.
*
* @return int
class CRM_Core_BAO_MailSettings extends CRM_Core_DAO_MailSettings {
/**
- * Class constructor
+ * Class constructor.
*/
public function __construct() {
parent::__construct();
}
/**
- * Return the domain from the default set of settings
+ * Return the domain from the default set of settings.
*
* @return string
* default domain
}
/**
- * Return the localpart from the default set of settings
+ * Return the localpart from the default set of settings.
*
* @return string
* default localpart
}
/**
- * Return the return path from the default set of settings
+ * Return the return path from the default set of settings.
*
* @return string
* default return path
}
/**
- * Takes a bunch of params that are needed to match certain criteria and
- * retrieves the relevant objects. Typically the valid params are only
- * mail settings id. It also stores all the retrieved
- * values in the default array
+ * Retrieve DB object based on input parameters.
+ *
+ * It also stores all the retrieved values in the default array.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
}
/**
- * 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.
class CRM_Core_BAO_Mapping extends CRM_Core_DAO_Mapping {
/**
- * Class constructor
+ * Class constructor.
*/
public function __construct() {
parent::__construct();
}
/**
- * Fetch object based on array of properties
+ * Fetch object based on array of properties.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
}
/**
- * 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.
}
/**
- * Check Duplicate Mapping Name
+ * Check Duplicate Mapping Name.
*
* @param string $nameField
* mapping Name.
}
/**
- * Build the mapping form
+ * Build the mapping form.
*
* @param CRM_Core_Form $form
* @param string $mappingType
/**
- * Function returns all Custom group Names
+ * Function returns all Custom group Names.
*
* @param int $customfieldId
* Related file id.
class CRM_Core_BAO_MessageTemplate extends CRM_Core_DAO_MessageTemplate {
/**
- * Fetch object based on array of properties
+ * Fetch object based on array of properties.
*
* @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.
}
/**
- * 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.
*
* @param int $messageTemplatesID
* @return void
}
/**
- * Get the Message Templates
+ * Get the Message Templates.
*
*
* @param bool $all
}
/**
- * Send an email from the specified template based on an array of params
+ * Send an email from the specified template based on an array of params.
*
* @param array $params
* A string-keyed array of function params, see function body for details.
const CACHE_KEY_STRLEN = 8;
/**
- * Class constructor
+ * Class constructor.
*/
public 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.
}
/**
- * Fetch object based on array of properties
+ * Fetch object based on array of properties.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
}
/**
- * Calculate navigation weight
+ * Calculate navigation weight.
*
* @param int $parentID
* Parent_id of a menu.
}
/**
- * Get formatted menu list
+ * Get formatted menu list.
*
* @return array
* returns associated array
}
/**
- * Build navigation tree
+ * Build navigation tree.
*
* @param array $navigationTree
* Nested array of menus.
}
/**
- * Build menu
+ * Build menu.
*
* @param bool $json
* By default output is html.
}
/**
- * Recursively check child menus
+ * Recursively check child menus.
*
* @param array $value
* @param string $navigationString
}
/**
- * Get Menu name
+ * Get Menu name.
*
* @param $value
* @param array $skipMenuItems
}
/**
- * Create navigation for CiviCRM Admin Menu
+ * Create navigation for CiviCRM Admin Menu.
*
* @param int $contactID
* Contact id.
}
/**
- * Reset navigation for all contacts or a specified contact
+ * Reset navigation for all contacts or a specified contact.
*
* @param int $contactID
* Reset only entries belonging to that contact ID.
}
/**
- * Process navigation
+ * Process navigation.
*
* @param array $params
* Associated array, $_GET.
}
/**
- * Process move action
+ * Process move action.
*
* @param $nodeID
* Node that is being moved.
}
/**
- * Function to process rename action for tree
+ * Function to process rename action for tree.
*
* @param int $nodeID
* @param $label
}
/**
- * Process delete action for tree
+ * Process delete action for tree.
*
* @param int $nodeID
*/
}
/**
- * Get the info on navigation item
+ * Get the info on navigation item.
*
* @param int $navigationID
* Navigation id.
}
/**
- * Update menu
+ * Update menu.
*
* @param array $params
* @param array $newParams
}
/**
- * 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
}
/**
- * Check if there is data to create the object
+ * Check if there is data to create the object.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
}
/**
- * Delete the notes
+ * Delete the notes.
*
* @param int $id
* Note id.
}
/**
- * 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.
}
/**
- * 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.
}
/**
- * Get total count of direct children visible to the current user
+ * Get total count of direct children visible to the current user.
*
* @param int $id
* Note ID.
}
/**
- * Recursive function to get all descendent notes of the note with given ID
+ * Recursive function to get all descendent notes of the note with given ID.
*
* @param int $parentId
* ID of the note to start from.
}
/**
- * 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.
}
/**
- * Returns whether or not this OpenID is allowed to login
+ * Returns whether or not this OpenID is allowed to login.
*
* @param string $identity_url
* The OpenID to check.
}
/**
- * Call common delete function
+ * Call common delete function.
*/
public static function del($id) {
return CRM_Contact_BAO_Contact::deleteObjectWithPrimary('OpenID', $id);
class CRM_Core_BAO_OptionGroup extends CRM_Core_DAO_OptionGroup {
/**
- * Class constructor
+ * Class constructor.
*/
public function __construct() {
parent::__construct();
}
/**
- * Fetch object based on array of properties
+ * Fetch object based on array of properties.
*
* @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.
}
/**
- * Add the Option Group
+ * Add the Option Group.
*
* @param array $params
* Reference array contains the values submitted by the form.
}
/**
- * 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.
*/
public function __construct() {
parent::__construct();
}
/**
- * Set default Parameters
+ * Set default Parameters.
* This functions sets default parameters if not set:
* - name & label are set to each other as required (it might make more sense for one
* to be required but this would mean a change to the api level)
}
/**
- * Get next available value
+ * Get next available value.
* We will take the highest numeric value (or 0 if no numeric values exist)
* and add one. The calling function is responsible for any
* more complex decision making
}
/**
- * Fetch object based on array of properties
+ * Fetch object based on array of properties.
*
* @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.
}
/**
- * Add an Option Value
+ * Add an Option Value.
*
* @param array $params
* Reference array contains the values submitted by the form.
}
/**
- * 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.
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;
);
/**
- * Get Option Group ID for Paper Sizes
+ * Get Option Group ID for Paper Sizes.
*
* @return int
* Group ID (null if Group ID doesn't exist)
}
/**
- * Add ordering fields to Paper Size list
+ * Add ordering fields to Paper Size list.
*
* @param array (reference) $list List of Paper Sizes
* @param string $returnURL
}
/**
- * Retrieve the default Paper Size values
+ * Retrieve the default Paper Size values.
*
* @return array
* Name/value pairs containing the default Paper Size values.
}
/**
- * Get Paper Size from the DB
+ * Get Paper Size from the DB.
*
* @param string $field
* Field name to search by.
}
/**
- * Get Paper Size by Name
+ * Get Paper Size by Name.
*
* @param int $name
* Paper Size name. Empty = get default Paper Size.
}
/**
- * Get Paper Size by ID
+ * Get Paper Size by ID.
*
* @param int $id
* Paper Size id. 0 = get default Paper Size.
}
/**
- * Get Paper Size field from associative array
+ * Get Paper Size field from associative array.
*
* @param string $field
* Name of a Paper Size field.
}
/**
- * Takes a bunch of params that are needed to match certain criteria and
- * retrieves the relevant objects. Typically the valid params are only
- * paper size id. It also stores all the retrieved values in the default array.
+ * Retrieve DB object based on input parameters.
+ *
+ * It also stores all the retrieved values in the default array.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
}
/**
- * Save the Paper Size in the DB
+ * Save the Paper Size in the DB.
*
* @param array (reference) $values associative array of name/value pairs
* @param int $id
}
/**
- * 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;
}
/**
- * Get Option Group ID for PDF Page Formats
+ * Get Option Group ID for PDF Page Formats.
*
* @return int
* Group ID (null if Group ID doesn't exist)
}
/**
- * Add ordering fields to Page Format list
+ * Add ordering fields to Page Format list.
*
* @param array (reference) $list List of PDF Page Formats
* @param string $returnURL
}
/**
- * Get the default PDF Page Format values
+ * Get the default PDF Page Format values.
*
* @return array
* Name/value pairs containing the default PDF Page Format values.
}
/**
- * Get PDF Page Format from the DB
+ * Get PDF Page Format from the DB.
*
* @param string $field
* Field name to search by.
}
/**
- * Get PDF Page Format by Name
+ * Get PDF Page Format by Name.
*
* @param int $name
* PDF Page Format name. Empty = get default PDF Page Format.
}
/**
- * Get PDF Page Format by ID
+ * Get PDF Page Format by ID.
*
* @param int $id
* PDF Page Format id. 0 = get default PDF Page Format.
}
/**
- * Get PDF Page Format field from associative array
+ * Get PDF Page Format field from associative array.
*
* @param string $field
* Name of a PDF Page Format field.
}
/**
- * Takes a bunch of params that are needed to match certain criteria and
- * retrieves the relevant objects. Typically the valid params are only
- * format id. It also stores all the retrieved values in the default array.
+ * Retrieve DB object based on input parameters.
+ *
+ * It also stores all the retrieved values in the default array.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
}
/**
- * Save the PDF Page Format in the DB
+ * Save the PDF Page Format in the DB.
*
* @param array (reference) $values associative array of name/value pairs
* @param int $id
}
/**
- * 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.
}
/**
- * 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.
}
/**
- * Call common delete function
+ * Call common delete function.
*/
public static function del($id) {
// Ensure mysql phone function exists
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.
*/
public function __construct() {
parent::__construct();
}
/**
- * Fetch object based on array of properties
+ * Fetch object based on array of properties.
*
* @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.
}
/**
- * Delete preference dates
+ * Delete preference dates.
*
* @param int $id
*
}
/**
- * Save checkbox selections
+ * Save checkbox selections.
*
* @param $cacheKey
* @param string $action
}
/**
- * Get the selections
+ * Get the selections.
*
* @param string $cacheKey
* Cache key.
}
/**
- * This function updates the mode column in the civicrm_recurring_entity table
+ * This function updates the mode column in the civicrm_recurring_entity table.
*
* @param int $mode
* Mode of the entity to cascade changes across parent/child relations eg 1 - only this entity, 2 - this and the following entities, 3 - All the entity .
}
/**
- * This function generates all new entities based on object vars
+ * This function generates all new entities based on object vars.
*
* @return array
*/
}
/**
- * Generate new DAOs and along with entries in civicrm_recurring_entity table
+ * Generate new DAOs and along with entries in civicrm_recurring_entity table.
*
* @return array
*/
}
/**
- * This function gets all the children for a particular parent entity
+ * This function gets all the children for a particular parent entity.
*
* @param int $parentId
* Parent entity id .
}
/**
- * This function gets the parent for the entity id passed to it
+ * This function gets the parent for the entity id passed to it.
*
* @param int $entityId
* Entity ID .
}
/**
- * This function copies the information from parent entity and creates other entities with same information
+ * This function copies the information from parent entity and creates other entities with same information.
*
* @param string $entityTable
* Entity table name .
}
/**
- * This function maps values posted from form to civicrm_action_schedule columns
+ * This function maps values posted from form to civicrm_action_schedule columns.
*
* @param array $formParams
* And array of form values posted .
}
/**
- * wrapper of getScheduleReminderDetailsById function
+ * wrapper of getScheduleReminderDetailsById function.
*
* @param int $scheduleReminderId
* Primary key of civicrm_action_schedule table .
/**
- * This function gets time difference between the two datetime object
+ * This function gets time difference between the two datetime object.
*
* @param DateTime $startDate
* Start Date .
}
/**
- * This function gets all columns from civicrm_action_schedule on the basis of event id
+ * This function gets all columns from civicrm_action_schedule on the basis of event id.
*
* @param int $entityId
* Entity ID .
}
/**
- * Update mode column in civicrm_recurring_entity table for event related tabs
+ * Update mode column in civicrm_recurring_entity table for event related tabs.
*
* @param int $entityId
* Event id .
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',
}
/**
- * Allow key o be cleared
+ * Allow key o be cleared.
* @param string $cacheKey
*/
public static function flushCache($cacheKey) {
}
/**
- * Retrieve the value of a setting from the DB table
+ * Retrieve the value of a setting from the DB table.
*
* @param string $group
* (required) The group name of the item.
}
/**
- * Store an item in the setting table
+ * Store an item in the setting table.
*
* _setItem() is the common logic shared by setItem() and setItems().
*
}
/**
- * Store an item in a setting table
+ * Store an item in a setting table.
*
* _setItem() is the common logic shared by setItem() and setItems().
*
}
/**
- * Load the settings files defined in a series of folders
+ * Load the settings files defined in a series of folders.
* @param array $metaDataFolders
* List of folder paths.
* @return array
}
/**
- * Load up settings metadata from files
+ * Load up settings metadata from files.
*/
public static function loadSettingsMetadata($metaDataFolder) {
$settingMetaData = array();
class CRM_Core_BAO_Tag extends CRM_Core_DAO_Tag {
/**
- * Class constructor
+ * Class constructor.
*/
public function __construct() {
parent::__construct();
}
/**
- * Fetch object based on array of properties
+ * Fetch object based on array of properties.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
}
/**
- * Function to retrieve tags
+ * Function to retrieve tags.
*
* @param string $usedFor
* Which type of tag entity.
}
/**
- * 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
}
/**
- * Check if there is data to create the object
+ * Check if there is data to create the object.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
}
/**
- * Get the tag sets for a entity object
+ * Get the tag sets for a entity object.
*
* @param string $entityTable
* Entity_table.
class CRM_Core_BAO_UFField extends CRM_Core_DAO_UFField {
/**
- * Batch entry fields
+ * Batch entry fields.
*/
private static $_contriBatchEntryFields = NULL;
private static $_memberBatchEntryFields = NULL;
/**
- * Fetch object based on array of properties
+ * Fetch object based on array of properties.
*
* @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.
}
/**
- * 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.
}
/**
- * Add the UF Field
+ * Add the UF Field.
*
* @param array $params
* (reference) array containing the values submitted by the form.
}
/**
- * Automatically determine one weight and modify others
+ * Automatically determine one weight and modify others.
*
* @param array $params
* UFField record, e.g. with 'weight', 'uf_group_id', and 'field_id'.
}
/**
- * 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.
}
/**
- * Check the status of custom field used in uf fields
+ * Check the status of custom field used in uf fields.
*
* @param int $UFFieldId
*
}
/**
- * Get a list of fields which can be added to profiles
+ * Get a list of fields which can be added to profiles.
*
* @param int $gid : UF group ID
* @param array $defaults : Form defaults
}
/**
- * Get a list of fields which can be added to profiles
+ * Get a list of fields which can be added to profiles.
*
* @param bool $force
*
}
/**
- * Determine whether the given field_name is valid
+ * Determine whether the given field_name is valid.
*
* @param string $fieldName
* @return bool
LISTINGS_VISIBILITY = 4;
/**
- * Cache the match clause used in this transaction
+ * Cache the match clause used in this transaction.
*
* @var string
*/
static $_matchFields = NULL;
/**
- * Fetch object based on array of properties
+ * Fetch object based on array of properties.
*
* @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.
}
/**
- * Get all the registration fields
+ * Get all the registration fields.
*
* @param int $action
* What action are we doing.
}
/**
- * Get all the listing fields
+ * Get all the listing fields.
*
* @param int $action
* What action are we doing.
}
/**
- * Create a query to find all visible UFFields in a UFGroup
+ * Create a query to find all visible UFFields in a UFGroup.
*
* This is the SQL-variant of checkUFFieldDisplayable().
*
}
/**
- * Create a query to find all visible UFFields in a UFGroup
+ * Create a query to find all visible UFFields in a UFGroup.
*
* This is the PHP in-memory variant of createUFFieldQuery().
*
}
/**
- * Check the data validity
+ * Check the data validity.
*
* @param int $userID
* The user id that we are actually editing.
}
/**
- * 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.
}
/**
- * 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.
}
/**
- * Add the UF Group
+ * Add the UF Group.
*
* @param array $params
* Reference array contains the values submitted by the form.
}
/**
- * 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.
}
/**
- * Get the UF Join records for an ufgroup id
+ * Get the UF Join records for an ufgroup id.
*
* @param int $ufGroupId
* Uf group id.
}
/**
- * Function takes an associative array and creates a ufjoin record for ufgroup
+ * Function takes an associative array and creates a ufjoin record for ufgroup.
*
* @param array $params
* (reference) an assoc array of name/value pairs.
}
/**
- * 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.
}
/**
- * Get the weight for ufjoin record
+ * Get the weight for ufjoin record.
*
* @param int $ufGroupId
* If $ufGroupId get update weight or add weight.
}
/**
- * Get the uf group for a module
+ * Get the uf group for a module.
*
* @param string $moduleName
* Module name.
}
/**
- * 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).
}
/**
- * Add profile field to a form
+ * Add profile field to a form.
*
* @param CRM_Core_Form $form
* @param array $field
}
/**
- * Set profile defaults
+ * Set profile defaults.
*
* @param int $contactId
* Contact id.
}
/**
- * Assign uf fields to template
+ * Assign uf fields to template.
*
* @param int $gid
* Group id.
}
/**
- * Format fields for dupe Contact Matching
+ * Format fields for dupe Contact Matching.
*
* @param array $params
*
}
/**
- * Create a "group_type" string
+ * Create a "group_type" string.
*
* @param array $coreTypes
* E.g. array('Individual','Contact','Student').
}
/**
- * Retrieve groups of profiles
+ * Retrieve groups of profiles.
*
* @param int $profileID
* Id of the profile.
}
/**
- * Check if we are rendering mixed profiles
+ * Check if we are rendering mixed profiles.
*
* @param array $profileIds
* Associated array of profile ids.
}
/**
- * Determine of we show overlay profile or not
+ * Determine of we show overlay profile or not.
*
* @return bool
* true if profile should be shown else false
}
/**
- * 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
}
/**
- * This is function is used to format pseudo fields
+ * This is function is used to format pseudo fields.
*
* @param array $fields
* Associated array of profile fields.
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.
}
/**
- * Update the email value for the contact and user profile
+ * Update the email value for the contact and user profile.
*
* @param int $contactId
* Contact ID of the user.
}
/**
- * Delete the object records that are associated with this cms user
+ * Delete the object records that are associated with this cms user.
*
* @param int $ufID
* Id of the user to delete.
}
/**
- * 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
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
* @param int $contactID
}
/**
- * Delete website
+ * Delete website.
*
* @param array $ids
* Website ids.
}
/**
- * Get all the websites for a specified contact_id
+ * Get all the websites for a specified contact_id.
*
* @param int $id
* The contact id.
/**
* Function that must have never worked & should be removed.
*
- * Takes a bunch of params that are needed to match certain criteria and
- * retrieves the relevant objects.
+ * Retrieve DB object based on input parameters.
+ *
+ * It also stores all the retrieved values in the default array.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
class CRM_Core_Base {
/**
- * Constructor
+ * Constructor.
*/
public 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.
*/
public function __construct() {
}
}
/**
- * Creates the info block for drupal
+ * Creates the info block for drupal.
*
* @return array
*/
}
/**
- * 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
*/
}
/**
- * Create the list of dashboard links
+ * Create the list of dashboard links.
*
* @return void
*/
}
/**
- * 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
*/
}
/**
- * 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
*/
}
/**
- * Create the event blocks for upcoming events
+ * Create the event blocks for upcoming events.
*
* @return void
*/
}
/**
- * Automatically generate a variety of files
+ * Automatically generate a variety of files.
*/
public function main() {
if (!empty($this->digestPath) && file_exists($this->digestPath) && $this->hasExpectedFiles()) {
}
/**
- * Sets the size property of a textfield
+ * Sets the size property of a textfield.
* See constants defined in CRM_Utils_Type for possible values
*/
protected function getSize($fieldXML) {
}
/**
- * Calculate a cumulative digest based on a collection of files
+ * Calculate a cumulative digest based on a collection of files.
*
* @param array $files
* List of file names (strings).
}
/**
- * Find the path to the main Civi source tree
+ * Find the path to the main Civi source tree.
*
* @return string
* @throws RuntimeException
}
/**
- * Find files in several directories using several filename patterns
+ * Find files in several directories using several filename patterns.
*
* @param array $pairs
* Each item is an array(0 => $searchBaseDir, 1 => $filePattern).
public $info;
/**
- * Stores component keyword
+ * Stores component keyword.
* @var string name of component keyword
*/
protected $keyword;
abstract public function getInfo();
/**
- * Get a list of entities to register via API
+ * Get a list of entities to register via API.
*
* @return array
* list of entities; same format as CRM_Utils_Hook::managedEntities(&$entities)
}
/**
- * Provides permissions that are unwise for Anonymous Roles to have
+ * Provides permissions that are unwise for Anonymous Roles to have.
*
* @return array
* list of permissions
abstract public function getPermissions($getAllUnconditionally = FALSE);
/**
- * Determine how many other records refer to a given record
+ * Determine how many other records refer to a given record.
*
* @param CRM_Core_DAO $dao
* The item for which we want a reference count.
}
/**
- * Provides the xml menu files
+ * Provides the xml menu files.
*
* @return array
* array of menu files
}
/**
- * Format size
+ * Format size.
*
*/
public static function formatUnitSize($size, $checkForPostMax = FALSE) {
}
/**
- * Set the default values
+ * Set the default values.
* in an empty db, also called when setting component using GUI
*
* @param array $defaults
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 $wpBasePage = NULL;
/**
- * Provide addressSequence
+ * Provide addressSequence.
*
* @param
*
}
/**
- * Provide cached default currency symbol
+ * Provide cached default currency symbol.
*
* @param
*
}
/**
- * Provide cached default currency symbol
+ * Provide cached default currency symbol.
*
* @param
*
}
/**
- * Provide cached default country name
+ * Provide cached default country name.
*
* @param
*
}
/**
- * Provide cached country limit translated to names
+ * Provide cached country limit translated to names.
*
* @param
*
}
/**
- * Provide cached province limit translated to names
+ * Provide cached province limit translated to names.
*
* @param
*
*/
static $_testEntitiesToSkip = array();
/**
- * The factory class for this application
+ * The factory class for this application.
* @var object
*/
static $_factory = NULL;
static $_checkedSqlFunctionsExist = FALSE;
/**
- * Class constructor
+ * Class constructor.
*
* @return \CRM_Core_DAO
*/
}
/**
- * Empty definition for virtual function
+ * Empty definition for virtual function.
*/
public static function getTableName() {
return NULL;
}
/**
- * Initialize the DAO object
+ * Initialize the DAO object.
*
* @param string $dsn
* The database connection string.
}
/**
- * Returns list of FK relationships
+ * Returns list of FK relationships.
*
*
* @return array
}
/**
- * Returns all the column names of this table
+ * Returns all the column names of this table.
*
*
* @return array
}
/**
- * Deletes items from table which match current objects variables
+ * Deletes items from table which match current objects variables.
*
* Returns the true on success
*
}
/**
- * Check if there is a record with the same name in the db
+ * Check if there is a record with the same name in the db.
*
* @param string $value
* The value of the field we are checking.
}
/**
- * Check if there is a given column in a specific table
+ * Check if there is a given column in a specific table.
*
* @param string $tableName
* @param string $columnName
}
/**
- * Check whether a specific column in a specific table has always the same value
+ * Check whether a specific column in a specific table has always the same value.
*
* @param string $tableName
* @param string $columnName
}
/**
- * Check whether a specific column in a specific table is always NULL
+ * Check whether a specific column in a specific table is always NULL.
*
* @param string $tableName
* @param string $columnName
}
/**
- * Check if there is a given table in the database
+ * Check if there is a given table in the database.
*
* @param string $tableName
*
}
/**
- * Get sort string
+ * Get sort string.
*
* @param array|object $sort either array or CRM_Utils_Sort
* @param string $default
}
/**
- * Fetch object based on array of properties
+ * Fetch object based on array of properties.
*
* @param string $daoName
* Name of the dao object.
}
/**
- * Delete the object records that are associated with this contact
+ * Delete the object records that are associated with this contact.
*
* @param string $daoName
* Name of the dao object.
}
/**
- * 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.
}
/**
- * Fetch object based on array of properties
+ * Fetch object based on array of properties.
*
* @param string $daoName
* Name of the dao object.
}
/**
- * 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
}
/**
- * Set defaults when creating new entity
+ * Set defaults when creating new entity.
* (don't call this set defaults as already in use with different signature in some places)
*
* @param array $params
}
/**
- * Wrapper function to drop triggers
+ * Wrapper function to drop triggers.
*
* @param string $tableName
* the specific table requiring a rebuild; or NULL to rebuild all tables.
}
/**
- * Register all the standard rules that most forms potentially use
+ * Register all the standard rules that most forms potentially use.
*
* @return void
*/
}
/**
- * Performs the server side validation
+ * Performs the server side validation.
* @since 1.0
* @return bool
* true if no error found
}
/**
- * Getter function for Name
+ * Getter function for Name.
*
* @return string
*/
}
/**
- * Getter function for State
+ * Getter function for State.
*
* @return object
*/
}
/**
- * Getter function for StateType
+ * Getter function for StateType.
*
* @return int
*/
}
/**
- * Setter function for options
+ * Setter function for options.
*
* @param mixed $options
*
}
/**
- * Boolean function to determine if this is a one form page
+ * Boolean function to determine if this is a one form page.
*
* @return bool
*/
}
/**
- * Getter function for Form Action
+ * Getter function for Form Action.
*
* @return string
*/
}
/**
- * Setter function for Form Action
+ * Setter function for Form Action.
*
* @param string $action
*
}
/**
- * Render form and return contents
+ * Render form and return contents.
*
* @return string
*/
}
/**
- * Use the form name to create the tpl file name
+ * Use the form name to create the tpl file name.
*
* @return string
*/
}
/**
- * Error reporting mechanism
+ * Error reporting mechanism.
*
* @param string $message
* Error Message.
}
/**
- * Store the variable with the value in the form scope
+ * Store the variable with the value in the form scope.
*
* @param string $name
* Name of the variable.
}
/**
- * Get the variable from the form scope
+ * Get the variable from the form scope.
*
* @param string $name
* Name of the variable
}
/**
- * Getter for action
+ * Getter for action.
*
* @return int
*/
}
/**
- * 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.
}
/**
- * Assign value to name in template by reference
+ * Assign value to name in template by reference.
*
* @param string $var
* Name of variable.
}
/**
- * Appends values to template variables
+ * Appends values to template variables.
*
* @param array|string $tpl_var the template variable name(s)
* @param mixed $value
}
/**
- * Returns an array containing template variables
+ * Returns an array containing template variables.
*
* @param string $name
*
}
/**
- * Adds a select based on field metadata
+ * Adds a select based on field metadata.
* TODO: This could be even more generic and widget type (select in this case) could also be read from metadata
* Perhaps a method like $form->bind($name) which would look up all metadata for named field
* @param $name
}
/**
- * Add date
+ * Add date.
*
* @code
* // if you need time
}
/**
- * Function that will add date and time
+ * Function that will add date and time.
*/
public function addDateTime($name, $label, $required = FALSE, $attributes = NULL) {
$addTime = array('addTime' => TRUE);
}
/**
- * Add a currency and money element to the form
+ * Add a currency and money element to the form.
*/
public function addMoney(
$name,
}
/**
- * Add currency element to the form
+ * Add currency element to the form.
*/
public function addCurrency(
$name = 'currency',
}
/**
- * Create a single or multiple entity ref field
+ * Create a single or multiple entity ref field.
* @param string $name
* @param string $label
* @param array $props
}
/**
- * Function that can be defined in Form to override or
+ * Function that can be defined in Form to override or.
* perform specific action on cancel action
*/
public function cancelAction() {
}
/**
- * Helper function to verify that required fields have been filled
+ * Helper function to verify that required fields have been filled.
* Typically called within the scope of a FormRule function
*/
public static function validateMandatoryFields($fields, $values, &$errors) {
}
/**
- * Get the contact id of the logged in user
+ * Get the contact id of the logged in user.
*/
public function getLoggedInUserContactID() {
// check if the user is logged in and has a contact ID
}
/**
- * Sets form attribute
+ * Sets form attribute.
* @see CRM.loadForm
*/
public function preventAjaxSubmit() {
}
/**
- * Sets form attribute
+ * Sets form attribute.
* @see CRM.loadForm
*/
public function allowAjaxSubmit() {
}
/**
- * Sets page title based on entity and action
+ * Sets page title based on entity and action.
* @param string $entityLabel
*/
public function setPageTitle($entityLabel) {
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;
}
/**
- * build the date range array that will provide the form option values
+ * build the date range array that will provide the form option values.
* It can be - relative or absolute
*
* @param CRM_Core_Form $form
}
/**
- * Global validation rules for the form
+ * Global validation rules for the form.
*
* @param array $values
* Posted values of the form.
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
static private $_singleton = NULL;
/**
- * The converter from array size to css class
+ * The converter from array size to css class.
*
* @var array
*/
);
/**
- * Constructor
+ * Constructor.
*/
public function __construct() {
$template = CRM_Core_Smarty::singleton();
}
/**
- * Creates an array representing an element containing
+ * Creates an array representing an element containing.
* the key for storing this. We allow the parent to do most of the
* work, but then we add some CiviCRM specific enhancements to
* make the html compliant with our css etc
}
/**
- * Convert IDs to values and format for display
+ * Convert IDs to values and format for display.
*
* @param HTML_QuickForm_element $field
*/
}
/**
- * Save entity tags when it is not save used AJAX
+ * Save entity tags when it is not save used AJAX.
*
* @param array $params
* @param int $entityId
}
/**
- * CREATE INDEX queries for a given locale and table
+ * CREATE INDEX queries for a given locale and table.
*
* @param string $locale
* locale for which the queries should be created (null to create original indices).
}
/**
- * CREATE VIEW query for a given locale and table
+ * CREATE VIEW query for a given locale and table.
*
* @param string $locale
* locale of the view.
class CRM_Core_IDS {
/**
- * Define the threshold for the ids reactions
+ * Define the threshold for the ids reactions.
*/
private $threshold = array(
'log' => 25,
}
/**
- * Create the default config file for the IDS system
+ * Create the default config file for the IDS system.
*
* @param bool $force
* Should we recreate it irrespective if it exists or not.
static $_sessionID = NULL;
/**
- * Generate a private key per session and store in session
+ * Generate a private key per session and store in session.
*
* @return string
* private key for this session
}
/**
- * Validate a form key based on the form name
+ * Validate a form key based on the form name.
*
* @param string $key
* @param string $name
class CRM_Core_Menu {
/**
- * The list of menu items
+ * The list of menu items.
*
* @var array
*/
static $_items = NULL;
/**
- * The list of permissioned menu items
+ * The list of permissioned menu items.
*
* @var array
*/
const MENU_ITEM = 1;
/**
- * This function fetches the menu items from xml and xmlMenu hooks
+ * This function fetches the menu items from xml and xmlMenu hooks.
*
* @param boolen $fetchFromXML
* Fetch the menu items from xml and not from cache.
}
/**
- * This function defines information for various menu items
+ * This function defines information for various menu items.
*
* @param boolen $fetchFromXML
* Fetch the menu items from xml and not from cache.
}
/**
- * We use this function to
+ * We use this function to.
*
* 1. Compute the breadcrumb
* 2. Compute local tasks value if any
}
/**
- * This function recomputes menu from xml and populates civicrm_menu
+ * This function recomputes menu from xml and populates civicrm_menu.
* @param bool $truncate
*/
public static function store($truncate = TRUE) {
}
/**
- * This function retrieves all the values for the specific option group by id
+ * This function retrieves all the values for the specific option group by id.
* this is primarily used to create various html based form elements
* (radio, select, checkbox etc). OptionGroups for most cases have the
* 'label' in the label colum and the 'id' or 'name' in the value column
protected $_name;
/**
- * The title associated with this page
+ * The title associated with this page.
*
* @var object
*/
public $useLivePageJS;
/**
- * Class constructor
+ * Class constructor.
*
* @param string $title
* Title of the page.
}
/**
- * Store the variable with the value in the form scope
+ * Store the variable with the value in the form scope.
*
* @param string|array $name name of the variable or an assoc array of name/value pairs
* @param mixed $value
}
/**
- * Get the variable from the form scope
+ * Get the variable from the form scope.
*
* @param string $name name of the variable
*
}
/**
- * Assign value to name in template
+ * Assign value to name in template.
*
* @param string $var
* @param mixed $value
}
/**
- * Assign value to name in template by reference
+ * Assign value to name in template by reference.
*
* @param string $var
* @param mixed $value
}
/**
- * Appends values to template variables
+ * Appends values to template variables.
*
* @param array|string $tpl_var the template variable name(s)
* @param mixed $value
}
/**
- * Returns an array containing template variables
+ * Returns an array containing template variables.
*
* @param string $name
*
}
/**
- * Use the form name to create the tpl file name
+ * Use the form name to create the tpl file name.
*
* @return string
*/
}
/**
- * Setter for embedded
+ * Setter for embedded.
*
* @param bool $embedded
*
}
/**
- * Getter for embedded
+ * Getter for embedded.
*
* @return bool
* return the embedded value
}
/**
- * Setter for print
+ * Setter for print.
*
* @param bool $print
*
}
/**
- * Getter for print
+ * Getter for print.
*
* @return bool
* return the print value
class CRM_Core_Page_AJAX {
/**
- * Call generic ajax forms
+ * Call generic ajax forms.
*
*/
public static function run() {
}
/**
- * Change is_quick_config priceSet to complex
+ * Change is_quick_config priceSet to complex.
*
*/
public static function setIsQuickConfig() {
}
/**
- * Set headers appropriate for a js file
+ * Set headers appropriate for a js file.
*
* @param int|NULL $ttl
* Time-to-live (seconds).
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
*/
abstract protected function getBAOName();
/**
- * An array of action links
+ * An array of action links.
*
* @return array
* (reference)
abstract protected function &links();
/**
- * Name of the edit form class
+ * Name of the edit form class.
*
* @return string
*/
abstract protected function editForm();
/**
- * Name of the form
+ * Name of the form.
*
* @return string
*/
abstract protected function editName();
/**
- * UserContext to pop back to
+ * UserContext to pop back to.
*
* @param int $mode
* Mode that we are in.
abstract protected 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.
}
/**
- * Class constructor
+ * Class constructor.
*
* @param string $title
* Title of the page.
}
/**
- * Extrac the extension and suite from the request path
+ * Extrac the extension and suite from the request path.
*
* @return array
*/
static private $_singleton = NULL;
/**
- * Constructor
+ * Constructor.
*
* @param string $mode
* The mode of operation: live or test.
}
/**
- * Submit a payment using Advanced Integration Method
+ * Submit a payment using Advanced Integration Method.
*
* @param array $params
* Assoc array of input parameters for this transaction.
}
/**
- * Submit an Automated Recurring Billing subscription
+ * Submit an Automated Recurring Billing subscription.
*/
public function doRecurPayment() {
$template = CRM_Core_Smarty::singleton();
}
/**
- * Checks to see if invoice_id already exists in db
+ * Checks to see if invoice_id already exists in db.
*
* @param int $invoiceId
* The ID to check.
}
/**
- * Calculate and return the transaction fingerprint
+ * Calculate and return the transaction fingerprint.
*
* @return string
* fingerprint
}
/**
- * Extract variables from returned XML
+ * Extract variables from returned XML.
*
* Function is from Authorize.Net sample code, and used
* to prevent the requirement of XML functions.
}
/**
- * Helper function for _parseArbReturn
+ * Helper function for _parseArbReturn.
*
* Function is from Authorize.Net sample code, and used to avoid using
* PHP5 XML functions
}
/**
- * Get the value of a field if set
+ * Get the value of a field if set.
*
* @param string $field
* The field.
}
/**
- * This function checks to see if we have the right config values
+ * This function checks to see if we have the right config values.
*
* @return string
* the error message if any
class CRM_Core_Payment_AuthorizeNetIPN extends CRM_Core_Payment_BaseIPN {
/**
- * Constructor function
+ * Constructor function.
*
* @param array $inputData
* contents of HTTP REQUEST.
protected $_isFirstOrLastRecurringPayment = FALSE;
/**
- * Constructor
+ * Constructor.
*/
public function __construct() {
self::$_now = date('YmdHis');
}
/**
- * Store input array on the class
+ * Store input array on the class.
*
* @param array $parameters
*
}
/**
- * Load objects related to contribution
+ * Load objects related to contribution.
*
* @input array information from Payment processor
*
}
/**
- * Set contribution to failed
+ * Set contribution to failed.
* @param array $objects
* @param object $transaction
* @param array $input
}
/**
- * Handled pending contribution status
+ * Handled pending contribution status.
* @param array $objects
* @param object $transaction
* @return bool
}
/**
- * Send start or end notification for recurring payments
+ * Send start or end notification for recurring payments.
* @param $ids
* @param $recur
*/
}
/**
- * Update pledge associated with a recurring contribution
+ * Update pledge associated with a recurring contribution.
*
* If the contribution has a pledge_payment record pledge, then update the pledge_payment record & pledge based on that linkage.
*
}
/**
- * copy custom data of the initial contribution into its recurring contributions
+ * copy custom data of the initial contribution into its recurring contributions.
* @param int $recurId
* @param int $targetContributionId
*/
}
/**
- * copy soft credit record of first recurring contribution
+ * copy soft credit record of first recurring contribution.
* and add new soft credit against $targetContributionId
*
* @param int $recurId
static private $_singleton = NULL;
/**
- * Constructor
+ * Constructor.
*
* @param string $mode
* The mode of operation: live or test.
}
/**
- * Submit a payment using Advanced Integration Method
+ * Submit a payment using Advanced Integration Method.
*
* @param array $params
* Assoc array of input parameters for this transaction.
}
/**
- * This function checks to see if we have the right config values
+ * This function checks to see if we have the right config values.
*
* @return string
* the error message if any
static private $_singleton = NULL;
/**
- * Constructor
+ * Constructor.
*
* @param string $mode
* The mode of operation: live or test.
}
/**
- * Checks to see if invoice_id already exists in db
+ * Checks to see if invoice_id already exists in db.
*
* @param int $invoiceId
* The ID to check.
}
/**
- * Produces error message and returns from class
+ * Produces error message and returns from class.
* @param string $errorCode
* @param string $errorMessage
* @return CRM_Core_Error
}
/**
- * This public function checks to see if we have the right processor config values set
+ * This public function checks to see if we have the right processor config values set.
*
* NOTE: Called by Events and Contribute to check config params are set prior to trying
* register any credit card details
static private $_singleton = NULL;
/**
- * Constructor
+ * Constructor.
*
* @param string $mode
* The mode of operation: live or test.
// end function doDirectPayment
/**
- * Checks to see if invoice_id already exists in db
+ * Checks to see if invoice_id already exists in db.
*
* @param int $invoiceId
* The ID to check.
}
/**
- * Produces error message and returns from class
+ * Produces error message and returns from class.
*/
public function &errorExit($errorCode = NULL, $errorMessage = NULL) {
$e = CRM_Core_Error::singleton();
}
/**
- * This public function checks to see if we have the right processor config values set
+ * This public function checks to see if we have the right processor config values set.
*
* NOTE: Called by Events and Contribute to check config params are set prior to trying
* register any credit card details
}
/**
- * Add general billing fields
+ * Add general billing fields.
* @todo set these like processor fields & let payment processors alter them
*
* @param CRM_Core_Form $form
}
/**
- * Make sure that credit card number and cvv are valid
+ * Make sure that credit card number and cvv are valid.
* Called within the scope of a QF formRule function
*/
public static function validateCreditCard($values, &$errors) {
}
/**
- * Map address fields
+ * Map address fields.
*
* @param int $id
* @param $src
}
/**
- * 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
*
static private $_singleton = NULL;
/**
- * Constructor
+ * Constructor.
*
* @param string $mode
* The mode of operation: live or test.
}
/**
- * This function checks to see if we have the right config values
+ * This function checks to see if we have the right config values.
*
* @return string
* the error message if any
}
/**
- * Sets appropriate parameters for checking out to google
+ * Sets appropriate parameters for checking out to google.
*
* @param array $params
* Name value pair of contribution datat.
}
/**
- * Builds appropriate parameters for checking out to google and submits the post params
+ * Builds appropriate parameters for checking out to google and submits the post params.
*
* @param array $params
* Name value pair of contribution data.
}
/**
- * Constructor
+ * Constructor.
*
* @param string $mode
* The mode of operation: live or test.
static private $_singleton = NULL;
/**
- * Constructor
+ * Constructor.
*
* @param string $mode
* The mode of operation: live or test.
}
/**
- * This function checks to see if we have the right config values
+ * This function checks to see if we have the right config values.
*
* @internal param string $mode the mode we are operating in (live or test)
*
static private $_singleton = NULL;
/**
- * Constructor
+ * Constructor.
*
* @param string $mode
* The mode of operation: live or test.
}
/**
- * This function checks to see if we have the right config values
+ * This function checks to see if we have the right config values.
*
* @return string
* the error message if any
static private $_singleton = NULL;
/**
- * Constructor
+ * Constructor.
*
* @param string $mode
* The mode of operation: live or test.
/**
- * This function checks the PayJunction response code
+ * This function checks the PayJunction response code.
*
* @return bool
*/
}
/**
- * Get the value of a field if set
+ * Get the value of a field if set.
*
* @param string $field
* The field.
}
/**
- * This function checks to see if we have the right config values
+ * This function checks to see if we have the right config values.
*
* @return string
* the error message if any
static $_paymentProcessor = NULL;
/**
- * Constructor
+ * Constructor.
*/
public function __construct() {
parent::__construct();
static private $_singleton = NULL;
/**
- * Constructor
+ * Constructor.
*
* @param string $mode
* The mode of operation: live or test.
}
/**
- * This function checks to see if we have the right config values
+ * This function checks to see if we have the right config values.
*
* @return string
* the error message if any
protected $_inputParameters = array();
/**
- * Store for the variables from the invoice string
+ * Store for the variables from the invoice string.
* @var array
*/
protected $_invoiceData = array();
/**
- * Is this a payment express transaction
+ * Is this a payment express transaction.
*/
protected $_isPaymentExpress = FALSE;
protected $_component = 'contribute';
/**
- * Constructor function
+ * Constructor function.
*
* @param array $inputData
* Contents of HTTP REQUEST.
}
/**
- * get the values from the rp_invoice_id string
+ * get the values from the rp_invoice_id string.
*
* @param string $name
* E.g. i, values are stored in the string with letter codes.
}
/**
- * Process recurring contributions
+ * Process recurring contributions.
* @param array $input
* @param array $ids
* @param array $objects
}
/**
- * Handle payment express IPNs
+ * Handle payment express IPNs.
* For one off IPNS no actual response is required
* Recurring is more difficult as we have limited confirmation material
* lets look up invoice id in recur_contribution & rely on the unique transaction id to ensure no
}
/**
- * Function check if transaction already exists
+ * Function check if transaction already exists.
* @param string $trxn_id
* @return bool|void
*/
}
/**
- * Checks to see if invoice_id already exists in db
+ * Checks to see if invoice_id already exists in db.
*
* @param int $invoiceId
* The ID to check.
static private $_singleton = NULL;
/**
- * Constructor
+ * Constructor.
*
* @param string $mode
* The mode of operation: live or test.
}
/**
- * This function checks to see if we have the right config values
+ * This function checks to see if we have the right config values.
*
* @internal param string $mode the mode we are operating in (live or test)
*
}
/**
- * Main transaction function
+ * Main transaction function.
*
* @param array $params
* Name value pair of contribution data.
}
/**
- * Constructor
+ * Constructor.
*
* @param string $mode
* The mode of operation: live or test.
static private $_singleton = NULL;
/**
- * Constructor
+ * Constructor.
*
* @param string $mode
* The mode of operation: live or test.
}
/**
- * Submit a payment using Advanced Integration Method
+ * Submit a payment using Advanced Integration Method.
*
* @param array $params
* Assoc array of input parameters for this transaction.
}
/**
- * Checks to see if invoice_id already exists in db
+ * Checks to see if invoice_id already exists in db.
*
* @param int $invoiceId
* The ID to check.
}
/**
- * Get the value of a field if set
+ * Get the value of a field if set.
*
* @param string $field
* The field.
}
/**
- * This function checks to see if we have the right config values
+ * This function checks to see if we have the right config values.
*
* @return string
* the error message if any
// end function doDirectPayment
/**
- * Checks to see if invoice_id already exists in db
+ * Checks to see if invoice_id already exists in db.
*
* @param int $invoiceId
* The ID to check.
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;
}
/**
- * Write a CSV file to the browser output
+ * Write a CSV file to the browser output.
*
* @param string $fileName
* The name of the file that will be downloaded (this is sent to the browser).
public $ajaxPopupsEnabled;
/**
- * Get or set the single instance of CRM_Core_Resources
+ * Get or set the single instance of CRM_Core_Resources.
*
* @param CRM_Core_Resources $instance
* New copy of the manager.
public 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.
public 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.
public function getTotalCount($action);
/**
- * Returns all the rows in the given offset and rowCount
+ * Returns all the rows in the given offset and rowCount.
*
* @param string $action
* The action being performed.
public 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.
protected $_key;
/**
- * This function gets the attribute for the action that
+ * This function gets the attribute for the action that.
* it matches.
*
* @param string $match the action to match against
}
/**
- * 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.
}
/**
- * Setter for permission
+ * Setter for permission.
*
* @var string
*/
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 $_dynamicAction = FALSE;
/**
- * Class constructor
+ * Class constructor.
*
* @param CRM_Core_Selector_API $object
* An object that implements the selector API.
}
/**
- * Getter for pager
+ * Getter for pager.
*
* @return CRM_Utils_Pager
*/
}
/**
- * Getter for sort
+ * Getter for sort.
*
* @return CRM_Utils_Sort
*/
}
/**
- * Move the variables from the session to the template
+ * Move the variables from the session to the template.
*
* @return void
*/
}
/**
- * Setter for embedded
+ * Setter for embedded.
*
* @param bool $embedded
*
}
/**
- * Getter for embedded
+ * Getter for embedded.
*
* @return bool
* return the embedded value
}
/**
- * Setter for print
+ * Setter for print.
*
* @param bool $print
*
}
/**
- * Getter for print
+ * Getter for print.
*
* @return bool
* return the print value
protected $_htmlTypeTransitions;
/**
- * Set up variables to build the form
+ * Set up variables to build the form.
*
* @return void
* @acess protected
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form when submitted
+ * Process the form when submitted.
*
* @return void
*/
class CRM_Custom_Form_DeleteField extends CRM_Core_Form {
/**
- * The group id
+ * The group id.
*
* @var int
*/
protected $_id;
/**
- * The title of the group being deleted
+ * The title of the group being deleted.
*
* @var string
*/
protected $_title;
/**
- * Set up variables to build the form
+ * Set up variables to build the form.
*
* @return void
* @acess protected
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form when submitted
+ * Process the form when submitted.
*
* @return void
*/
class CRM_Custom_Form_DeleteGroup extends CRM_Core_Form {
/**
- * The group id
+ * The group id.
*
* @var int
*/
protected $_id;
/**
- * The title of the group being deleted
+ * The title of the group being deleted.
*
* @var string
*/
protected $_title;
/**
- * Set up variables to build the form
+ * Set up variables to build the form.
*
* @return void
* @acess protected
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form when submitted
+ * Process the form when submitted.
*
* @return void
*/
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
*/
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.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Global validation rules for the form
+ * Global validation rules for the form.
*
* @param array $fields
* Posted values of the form.
}
/**
- * Process the form
+ * Process the form.
*
* @return void
*/
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
*/
protected $_id;
/**
- * set is empty or not
+ * set is empty or not.
*
* @var bool
*/
protected $_isGroupEmpty = TRUE;
/**
- * Array of existing subtypes set for a custom set
+ * Array of existing subtypes set for a custom set.
*
* @var array
*/
protected $_subtypes = array();
/**
- * Array of default params
+ * Array of default params.
*
* @var array
*/
protected $_defaults = array();
/**
- * Set variables up before form is built
+ * Set variables up before form is built.
*
*
* @return void
}
/**
- * Global form rule
+ * Global form rule.
*
* @param array $fields
* The input form values.
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Process the form
+ * Process the form.
*
*
* @return void
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 $_dstFID;
/**
- * The title of the field being moved
+ * The title of the field being moved.
*
* @var string
*/
protected $_srcFieldLabel;
/**
- * Set up variables to build the form
+ * Set up variables to build the form.
*
* @return void
* @acess protected
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form when submitted
+ * Process the form when submitted.
*
* @return void
*/
protected $_id;
/**
- * Set variables up before form is built
+ * Set variables up before form is built.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Global validation rules for the form
+ * Global validation rules for the form.
*
* @param array $fields
* Posted values of the form.
}
/**
- * Process the form
+ * Process the form.
*
* @return void
*/
class CRM_Custom_Form_Preview extends CRM_Core_Form {
/**
- * The group tree data
+ * The group tree data.
*
* @var array
*/
}
/**
- * Set the default form values
+ * Set the default form values.
*
* @return array
* the default array reference
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the uploaded file
+ * Process the uploaded file.
*
* @return void
*/
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Global validation rules for the form
+ * Global validation rules for the form.
*
* @param array $fields
* Posted values of the form.
}
/**
- * Process the mapped fields and map it into the uploaded file
+ * Process the mapped fields and map it into the uploaded file.
* preview the file and extract some summary statistics
*
* @return void
protected $_importParserUrl = '&parser=CRM_Custom_Import_Parser';
/**
- * Set variables up before form is built
+ * Set variables up before form is built.
*
* @return void
*/
}
/**
- * Process the mapped fields and map it into the uploaded file
+ * Process the mapped fields and map it into the uploaded file.
* preview the file and extract some summary statistics
*
* @return void
*/
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
*/
}
/**
- * 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
}
/**
- * Store parser values
+ * Store parser values.
*
* @param CRM_Core_Session $store
*
protected $_multipleCustomData = '';
/**
- * Params for the current entity being prepared for the api
+ * Params for the current entity being prepared for the api.
* @var array
*/
protected $_params = array();
}
/**
- * 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.
}
/**
- * Format Date params
+ * Format Date params.
*
* Although the api will accept any strtotime valid string CiviCRM accepts at least one date format
* not supported by strtotime so we should run this through a conversion
}
/**
- * Set import entity
+ * Set import entity.
* @param string $entity
*/
public function setEntity($entity) {
public $useLivePageJS = TRUE;
/**
- * The group id of the field
+ * The group id of the field.
*
* @var int
*/
protected $_gid;
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
}
/**
- * Preview custom field
+ * Preview custom field.
*
* @param int $id
* Custom field id.
}
/**
- * Edit custom group
+ * Edit custom group.
*
* @param int $id
* Custom group id.
}
/**
- * Preview custom group
+ * Preview custom group.
*
* @param int $id
* Custom group id.
class CRM_Dashlet_Page_Activity extends CRM_Core_Page {
/**
- * List activities as dashlet
+ * List activities as dashlet.
*
* @return void
*/
class CRM_Dashlet_Page_AllCases extends CRM_Core_Page {
/**
- * List activities as dashlet
+ * List activities as dashlet.
*
* @return void
*/
}
/**
- * List blog articles as dashlet
+ * List blog articles as dashlet.
*/
public function run() {
$context = CRM_Utils_Request::retrieve('context', 'String', $this, FALSE, 'dashlet');
}
/**
- * Load blog articles from cache
+ * Load blog articles from cache.
* Refresh cache if expired
*
* @return array
}
/**
- * Parse rss feed and cache results
+ * Parse rss feed and cache results.
*
* @param $url
*
class CRM_Dashlet_Page_CaseDashboard extends CRM_Core_Page {
/**
- * Case dashboard as dashlet
+ * Case dashboard as dashlet.
*
* @return void
*/
class CRM_Dashlet_Page_MyCases extends CRM_Core_Page {
/**
- * List activities as dashlet
+ * List activities as dashlet.
*
* @return void
*/
var $params = array();
/**
- * If there are no rules in rule group
+ * If there are no rules in rule group.
*/
var $noRules = FALSE;
}
/**
- * sort queries by number of records for the table associated with them
+ * sort queries by number of records for the table associated with them.
* @param $tableQueries
*/
public static function orderByTableCount(&$tableQueries) {
}
/**
- * Get all of the combinations of fields that would work with a rule
+ * Get all of the combinations of fields that would work with a rule.
*/
public static function combos($rgFields, $threshold, &$combos, $running = array()) {
foreach ($rgFields as $rgField => $weight) {
}
/**
- * Returns the related tables groups for which a contact has any info entered
+ * Returns the related tables groups for which a contact has any info entered.
*/
public static function getActiveRelTables($cid) {
$cid = (int) $cid;
}
/**
- * Return tables using locations
+ * Return tables using locations.
*/
public static function locTables() {
static $locTables;
}
/**
- * Update the is_active flag in the db
+ * Update the is_active flag in the db.
*
* @param int $id
* Id of the database record.
}
/**
- * This is supposed to be overrided
+ * This is supposed to be overrided.
*/
public function generateLabel($participant) {
$txt = "{$this->event['title']}
class CRM_Event_Controller_Search extends CRM_Core_Controller {
/**
- * Class constructor
+ * Class constructor.
*/
public function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) {
public $useLivePageJS = TRUE;
/**
- * Set variables up before form is built
+ * Set variables up before form is built.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
class CRM_Event_Import_Controller extends CRM_Core_Controller {
/**
- * Class constructor
+ * Class constructor.
*
* @param null $title
* @param bool|int $action
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the uploaded file
+ * Process the uploaded file.
*
* @return void
*/
/**
- * Set variables up before form is built
+ * Set variables up before form is built.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * 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
*/
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
*/
}
/**
- * 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
}
/**
- * Store parser values
+ * Store parser values.
*
* @param CRM_Core_Session $store
*
}
/**
- * Export data to a CSV file
+ * Export data to a CSV file.
*
* @param string $fileName
* @param array $header
protected $_newParticipants;
/**
- * Class constructor
+ * Class constructor.
*/
public function __construct(&$mapperKeys, $mapperLocType = NULL, $mapperPhoneType = NULL) {
parent::__construct();
}
/**
- * 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.
}
/**
- * Get the array of successfully imported Participation ids
+ * Get the array of successfully imported Participation ids.
*
* @return array
*/
}
/**
- * add shortcut to Create New
+ * add shortcut to Create New.
* @param $shortCuts
* @param $newCredit
*/
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
*/
public function eventFee() {
class CRM_Event_Page_ManageEvent extends CRM_Core_Page {
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
protected $_isTemplate = FALSE;
/**
- * Get action Links
+ * Get action Links.
*
* @return array
* (reference) of action links
}
/**
- * Get tab Links for events
+ * Get tab Links for events.
*
* @param $enableCart
*
}
/**
- * Browse all events
+ * Browse all events.
*
* @return void
*/
public $_contactId = NULL;
/**
- * called when action is browse
+ * called when action is browse.
*/
public function browse() {
$controller = new CRM_Core_Controller_Simple(
}
/**
- * called when action is view
+ * called when action is view.
*
* @return null
*/
}
/**
- * called when action is update or new
+ * called when action is update or new.
*
* @return null
*/
class CRM_Event_Page_UserDashboard extends CRM_Contact_Page_View_UserDashBoard {
/**
- * List participations for the UF user
+ * List participations for the UF user.
*
*/
public function listParticipations() {
}
/**
- * Get all the n participant statuses
+ * Get all the n participant statuses.
*
*
* @param int $id
}
/**
- * Get all the n participant roles
+ * Get all the n participant roles.
*
*
* @param int $id
}
/**
- * Get all the participant listings
+ * Get all the participant listings.
*
*
* @param int $id
}
/**
- * Get event template titles
+ * Get event template titles.
*
* @param int $id
*
}
/**
- * Get all the Personal campaign pages
+ * Get all the Personal campaign pages.
*
*
* @param int $id
public $_queryParams;
/**
- * Represent the type of selector
+ * Represent the type of selector.
*
* @var int
*/
protected $_action;
/**
- * The additional clause that we restrict the search with
+ * The additional clause that we restrict the search with.
*
* @var string
*/
protected $_eventClause = NULL;
/**
- * The query object
+ * The query object.
*
* @var string
*/
protected $_query;
/**
- * Class constructor
+ * Class constructor.
*
* @param array $queryParams
* Array of parameters for query.
}
/**
- * Can be used to alter the number of participation returned from a buildForm hook
+ * Can be used to alter the number of participation returned from a buildForm hook.
*
* @param int $limit
* How many participations do we want returned.
}
/**
- * Returns all the rows in the given offset and rowCount
+ * Returns all the rows in the given offset and rowCount.
*
* @param string $action
* The action being performed.
class CRM_Event_StateMachine_Registration extends CRM_Core_StateMachine {
/**
- * Class constructor
+ * Class constructor.
*
* @param object $controller
* @param \const|int $action
class CRM_Event_StateMachine_Search extends CRM_Core_StateMachine {
/**
- * The task that the wizard is currently processing
+ * The task that the wizard is currently processing.
*
* @var string
*/
protected $_task;
/**
- * Class constructor
+ * Class constructor.
*
* @param object $controller
* @param \const|int $action
}
/**
- * Return the form name of the task
+ * Return the form name of the task.
*
* @return string
*/
}
/**
- * These tasks get added based on the context the user is in
+ * These tasks get added based on the context the user is in.
*
* @return array
* the set of optional tasks for a group of contacts
const EXPORT_ROW_COUNT = 10000;
/**
- * Get the list the export fields
+ * Get the list the export fields.
*
* @param int $selectAll
* User preference while export.
}
/**
- * Name of the export file based on mode
+ * Name of the export file based on mode.
*
* @param string $output
* Type of output.
}
/**
- * Manipulate header rows for relationship fields
+ * Manipulate header rows for relationship fields.
*
* @param $headerRows
* @param $contactRelationshipTypes
protected $_mappingId;
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Global validation rules for the form
+ * Global validation rules for the form.
*
* @param array $fields
* Posted values of the form.
}
/**
- * Process the uploaded file
+ * Process the uploaded file.
*
* @return void
*/
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
*
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Validation
+ * Validation.
*
* @param array $params
* (ref.) an assoc array of name/value pairs.
}
/**
- * Process the uploaded file
+ * Process the uploaded file.
*
* @return void
*/
}
/**
- * Build mapping form element
+ * Build mapping form element.
*/
public function buildMapping() {
switch ($this->_exportMode) {
class CRM_Extension_Browser {
/**
- * An URL for public extensions repository
+ * An URL for public extensions repository.
*/
const DEFAULT_EXTENSIONS_REPOSITORY = 'https://civicrm.org/extdir/ver={ver}|cms={uf}';
}
/**
- * Determine whether downloading is supported
+ * Determine whether downloading is supported.
*
* @return array
* List of error messages; empty if OK.
}
/**
- * Get a list of all available extensions
+ * Get a list of all available extensions.
*
* @return array
* ($key => CRM_Extension_Info)
}
/**
- * Get a description of a particular extension
+ * Get a description of a particular extension.
*
* @param string $key
* Fully-qualified extension name.
}
/**
- * A dummy function required for suppressing download errors
+ * A dummy function required for suppressing download errors.
*/
public static function downloadError($errorNumber, $errorString) {
}
}
/**
- * Determine the relative path of an extension directory
+ * Determine the relative path of an extension directory.
*
* @param string $key
* Extension name.
}
/**
- * Determine the relative path of an extension directory
+ * Determine the relative path of an extension directory.
*
* @param string $key
* Extension name.
}
/**
- * Get the container which defines a particular key
+ * Get the container which defines a particular key.
*
* @param string $key
* Extension name.
public function checkRequirements();
/**
- * Get a list of extensions available in this container
+ * Get a list of extensions available in this container.
*
* @return array
* List of keys (strings).
public function getPath($key);
/**
- * Determine the base URL for resources provided by the extension
+ * Determine the base URL for resources provided by the extension.
*
* @param string $key
* Fully-qualified extension name.
}
/**
- * Determine whether downloading is supported
+ * Determine whether downloading is supported.
*
* @return array
* list of error messages; empty if OK
}
/**
- * Install or upgrade an extension from a remote URL
+ * Install or upgrade an extension from a remote URL.
*
* @param string $key
* The name of the extension being installed.
}
/**
- * Extract an extension from a zip file
+ * Extract an extension from a zip file.
*
* @param string $key
* The name of the extension being installed; this usually matches the basedir in the .zip.
class CRM_Extension_Info {
/**
- * Extension info file name
+ * Extension info file name.
*/
const FILENAME = 'info.xml';
public $file = NULL;
/**
- * Load extension info an XML file
+ * Load extension info an XML file.
*
* @param $file
*
}
/**
- * Load extension info a string
+ * Load extension info a string.
*
* @param string $string
* XML content.
*/
class CRM_Extension_Manager {
/**
- * The extension is fully installed and enabled
+ * The extension is fully installed and enabled.
*/
const STATUS_INSTALLED = 'installed';
/**
- * The extension config has been applied to database but deactivated
+ * The extension config has been applied to database but deactivated.
*/
const STATUS_DISABLED = 'disabled';
}
/**
- * Remove all database references to an extension
+ * Remove all database references to an extension.
*
* Add records of the extension to the database -- and enable it
*
}
/**
- * Determine the status of an extension
+ * Determine the status of an extension.
*
* @param $key
*
}
/**
- * Determine the status of all extensions
+ * Determine the status of all extensions.
*
* @return array
* ($key => status_constant)
}
/**
- * 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
class CRM_Extension_Mapper {
/**
- * An URL for public extensions repository
+ * An URL for public extensions repository.
*/
//const DEFAULT_EXTENSIONS_REPOSITORY = 'http://civicrm.org/extdir/ver={ver}|cms={uf}';
/**
- * Extension info file name
+ * Extension info file name.
*/
const EXT_TEMPLATES_DIRNAME = 'templates';
}
/**
- * Get a list of base URLs for all active modules
+ * Get a list of base URLs for all active modules.
*
* @return array
* (string $extKey => string $baseUrl)
private $downloader = NULL;
/**
- * The URL of the remote extensions repository
+ * The URL of the remote extensions repository.
*
* @var string|FALSE
*/
}
/**
- * Get a container which represents all available extensions
+ * Get a container which represents all available extensions.
*
* @return CRM_Extension_Container_Interface
*/
}
/**
- * Get the container to which new extensions are installed
+ * Get the container to which new extensions are installed.
*
* This container should be a particular, writeable directory.
*
}
/**
- * Get the service which provides runtime information about extensions
+ * Get the service which provides runtime information about extensions.
*
* @return CRM_Extension_Mapper
*/
}
/**
- * Get the service for enabling and disabling extensions
+ * Get the service for enabling and disabling extensions.
*
* @return CRM_Extension_Manager
*/
}
/**
- * Determine the URL which provides a feed of available extensions
+ * Determine the URL which provides a feed of available extensions.
*
* @return string|FALSE
*/
const QUEUE_NAME = 'ext-upgrade';
/**
- * Determine whether any extensions have pending upgrades
+ * Determine whether any extensions have pending upgrades.
*
* @return bool
*/
}
/**
- * Fill a queue with upgrade tasks
+ * Fill a queue with upgrade tasks.
*
* @return CRM_Queue_Queue
*/
class CRM_Financial_BAO_ExportFormat {
/**
- * data which the individual export formats will output in the desired format
+ * data which the individual export formats will output in the desired format.
* @var array
*/
protected $_exportParams;
/**
- * smarty template
+ * smarty template.
* @var CRM_Core_Smarty
*/
static protected $_template;
/**
- * Class constructor
+ * Class constructor.
*/
public function __construct() {
if (!isset(self::$_template)) {
}
/**
- * Override to assemble the appropriate subset of financial data for the specific export format
+ * Override to assemble the appropriate subset of financial data for the specific export format.
* @param array $exportParams
*
* @return mixed
}
/**
- * Override this if appropriate
+ * Override this if appropriate.
* @return null
*/
public function getTemplateFileName() {
);
/**
- * Class constructor
+ * Class constructor.
*/
public function __construct() {
parent::__construct();
}
/**
- * Format table headers
+ * Format table headers.
*
* @param array $values
* @return array
}
/**
- * Generate CSV array for export
+ * Generate CSV array for export.
*
* @param array $export
*/
);
/**
- * Class constructor
+ * Class constructor.
*/
public function __construct() {
parent::__construct();
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.
*/
public function __construct() {
parent::__construct();
}
/**
- * Fetch object based on array of properties
+ * Fetch object based on array of properties.
*
* @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.
}
/**
- * Add the financial types
+ * Add the financial types.
*
* @param array $params
* Reference array contains the values submitted by the form.
}
/**
- * Delete financial Types
+ * Delete financial Types.
*
* @param int $financialAccountId
*/
}
/**
- * 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.
*
* @param int $financialTypeId
*
}
/**
- * 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.
*/
public function __construct() {
parent::__construct();
}
/**
- * Fetch object based on array of properties
+ * Fetch object based on array of properties.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
}
/**
- * Add the financial items and financial trxn
+ * Add the financial items and financial trxn.
*
* @param object $lineItem
* Line item 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.
}
/**
- * 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.
}
/**
- * 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.
*/
public function __construct() {
parent::__construct();
}
/**
- * Fetch object based on array of properties
+ * Fetch object based on array of properties.
*
* @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.
}
/**
- * Add the financial types
+ * Add the financial types.
*
* @param array $params
* Reference array contains the values submitted by the form.
}
/**
- * Delete financial Types
+ * Delete financial Types.
*
* @param int $financialTypeId
*
}
/**
- * fetch financial type having relationship as Income Account is
+ * fetch financial type having relationship as Income Account is.
*
*
* @return array
class CRM_Financial_BAO_FinancialTypeAccount extends CRM_Financial_DAO_EntityFinancialAccount {
/**
- * Class constructor
+ * Class constructor.
*/
public function __construct() {
parent::__construct();
}
/**
- * Financial account
+ * Financial account.
* @var array
*/
private static $financialAccount;
/**
- * Fetch object based on array of properties
+ * Fetch object based on array of properties.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
}
/**
- * Add the financial types
+ * Add the financial types.
*
* @param array $params
* Reference array contains the values submitted by the form.
}
/**
- * Delete financial Types
+ * Delete financial Types.
*
* @param int $financialTypeAccountId
* @param int $accountId
}
/**
- * Get Financial Account Name
+ * Get Financial Account Name.
*
* @param int $entityId
*
}
/**
- * Financial Account for payment instrument
+ * Financial Account for payment instrument.
*
* @param int $paymentInstrumentValue
* Payment instrument value.
static $_defaultPaymentProcessor = NULL;
/**
- * Create Payment Processor
+ * Create Payment Processor.
*
* @param array $params
* Parameters for Processor entity.
}
/**
- * Class constructor
+ * Class constructor.
*/
public function __construct() {
parent::__construct();
}
/**
- * Takes a bunch of params that are needed to match certain criteria and
- * retrieves the relevant objects. It also stores all the retrieved
- * values in the default array
+ * Retrieve DB object based on input parameters.
+ *
+ * It also stores all the retrieved values in the default array.
*
* @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.
}
/**
- * Retrieve the default payment processor
+ * Retrieve the default payment processor.
*
* @return CRM_Financial_DAO_PaymentProcessor|null
* The default payment processor object on success,
}
/**
- * Delete payment processor
+ * Delete payment processor.
*
* @param int $paymentProcessorID
*
}
/**
- * Get the payment processor details
+ * Get the payment processor details.
*
* @param int $paymentProcessorID
* Payment processor id.
}
/**
- * Build payment processor details
+ * Build payment processor details.
*
* @param object $dao
* Payment processor object.
}
/**
- * Is there a processor on this site with the specified capability
+ * Is there a processor on this site with the specified capability.
* @param array $capabilities
* @param bool $isIncludeTest
*
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.
*/
public function __construct() {
parent::__construct();
}
/**
- * Fetch object based on array of properties
+ * Fetch object based on array of properties.
*
* @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.
}
/**
- * Retrieve the default payment processor
+ * Retrieve the default payment processor.
*
* @return object
* The default payment processor object on success,
}
/**
- * Delete payment processor
+ * Delete payment processor.
*
* @param int $paymentProcessorTypeId
* ID of the processor to be deleted.
static $_entityID;
/**
- * Batch status
+ * Batch status.
* @var
*/
protected $_batchStatusId;
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
protected $_id;
/**
- * Financial batch ids
+ * Financial batch ids.
*/
protected $_batchIds = array();
/**
- * Export status id
+ * Export status id.
*/
protected $_exportStatusId;
/**
- * Export format
+ * Export format.
*/
protected $_exportFormat;
/**
- * Build all the data structures needed to build the form
+ * Build all the data structures needed to build the form.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
* @return void
*/
class CRM_Financial_Form_FinancialAccount extends CRM_Contribute_Form {
/**
- * Flag if its a AR account type
+ * Flag if its a AR account type.
*
* @var boolean
*/
/**
- * Set variables up before form is built
+ * Set variables up before form is built.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Global validation rules for the form
+ * Global validation rules for the form.
*
* @param array $values
* posted values of the form
}
/**
- * Process the form submission
+ * Process the form submission.
*
* @return void
*/
protected $_id;
/**
- * Set variables up before form is built
+ * Set variables up before form is built.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Global validation rules for the form
+ * Global validation rules for the form.
*
* @param array $values
* @param $files
}
/**
- * Process the form submission
+ * Process the form submission.
*
* @return void
*/
}
/**
- * Global validation rules for the form
+ * Global validation rules for the form.
*
* @param $action
* @param $permissions
class CRM_Financial_Form_FinancialType extends CRM_Contribute_Form {
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form submission
+ * Process the form submission.
*
* @return void
*/
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
*/
protected $_id;
/**
- * The name of the BAO object for this form
+ * The name of the BAO object for this form.
*
* @var string
*/
protected $_BAOName;
/**
- * Flag if its a AR account type
+ * Flag if its a AR account type.
*
* @var boolean
*/
protected $_isARFlag = FALSE;
/**
- * Set variables up before form is built
+ * Set variables up before form is built.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Global validation rules for the form
+ * Global validation rules for the form.
*
* @param array $values
* posted values of the form
}
/**
- * Process the form submission
+ * Process the form submission.
*
* @return void
*/
class CRM_Financial_Page_AJAX {
/**
- * get financial accounts of required account relationship
+ * get financial accounts of required account relationship.
* $financialAccountType array with key account relationship and value financial account type option groups
*
* @param $config
static $_links = NULL;
/**
- * Get BAO Name
+ * Get BAO Name.
*
* @return string
* Classname of BAO.
}
/**
- * Get action Links
+ * Get action Links.
*
*/
public function &links() {
}
/**
- * Get name of edit form
+ * Get name of edit form.
*
* @return string
* Classname of edit form.
}
/**
- * Get edit form name
+ * Get edit form name.
*
* @return string
* name of this page.
*/
class CRM_Financial_Page_BatchTransaction extends CRM_Core_Page_Basic {
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
static $_returnvalues = NULL;
/**
- * Get BAO Name
+ * Get BAO Name.
*
* @return string
* Classname of BAO.
}
/**
- * Get action Links
+ * Get action Links.
*
* @return array
* (reference) of action links
}
/**
- * Browse all financial batch transactions
+ * Browse all financial batch transactions.
*
*
* @return void
}
/**
- * Get name of edit form
+ * Get name of edit form.
*
* @return string
* Classname of edit form.
}
/**
- * Get edit form name
+ * Get edit form name.
*
* @return string
* name of this page.
public $useLivePageJS = TRUE;
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
static $_links = NULL;
/**
- * Get BAO Name
+ * Get BAO Name.
*
* @return string
* Classname of BAO.
}
/**
- * Get action Links
+ * Get action Links.
*
* @return array
* (reference) of action links
}
/**
- * Get name of edit form
+ * Get name of edit form.
*
* @return string
* Classname of edit form.
}
/**
- * Get edit form name
+ * Get edit form name.
*
* @return string
* name of this page.
class CRM_Financial_Page_FinancialBatch extends CRM_Core_Page_Basic {
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
static $_links = NULL;
/**
- * Get BAO Name
+ * Get BAO Name.
*
* @return string
* classname of BAO.
}
/**
- * Get action Links
+ * Get action Links.
*
* @return array
* (reference) of action links
/**
- * Get name of edit form
+ * Get name of edit form.
*
* @return string
* classname of edit form.
}
/**
- * Get edit form name
+ * Get edit form name.
*
* @return string
* name of this page.
public $useLivePageJS = TRUE;
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
static $_links = NULL;
/**
- * Get BAO Name
+ * Get BAO Name.
*
* @return string
* Classname of BAO.
}
/**
- * Get action Links
+ * Get action Links.
*
* @return array
* (reference) of action links
}
/**
- * Browse all financial types
+ * Browse all financial types.
*
*
* @return void
}
/**
- * Get name of edit form
+ * Get name of edit form.
*
* @return string
* Classname of edit form.
}
/**
- * Get edit form name
+ * Get edit form name.
*
* @return string
* name of this page.
*/
class CRM_Financial_Page_FinancialTypeAccount extends CRM_Core_Page {
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
static $_links = NULL;
/**
- * The account id that we need to display for the browse screen
+ * The account id that we need to display for the browse screen.
*
* @var array
*/
protected $_aid = NULL;
/**
- * Get BAO Name
+ * Get BAO Name.
*
* @return string
* Classname of BAO.
}
/**
- * Get action Links
+ * Get action Links.
*
* @return array
* (reference) of action links
}
/**
- * Browse all Financial Type Account data
+ * Browse all Financial Type Account data.
*
* @return void
*/
}
/**
- * 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.
}
/**
- * Build the form object
+ * Build the form object.
*
* @param CRM_Core_Form $form
* Form object.
}
/**
- * 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
class CRM_Friend_Form extends CRM_Core_Form {
/**
- * Constants for number of friend contacts
+ * Constants for number of friend contacts.
*/
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 $_entityId;
/**
- * The table name of the entity that we are proceessing
+ * The table name of the entity that we are proceessing.
*
* @var string
*/
protected $_campaignId;
/**
- * The contact ID
+ * The contact ID.
*
* @var int
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Validation
+ * Validation.
*
* @param array $fields
*
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
class CRM_Friend_Form_Contribute extends CRM_Contribute_Form_ContributionPage {
/**
- * Tell a friend id in db
+ * Tell a friend id in db.
*
* @var int
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
class CRM_Friend_Form_Event extends CRM_Event_Form_ManageEvent {
/**
- * Tell a friend id in db
+ * Tell a friend id in db.
*
* @var int
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
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 $_exportableFields = NULL;
/**
- * Class constructor
+ * Class constructor.
*/
public function __construct() {
parent::__construct();
}
/**
- * Get events Summary
+ * Get events Summary.
*
*
* @param bool $admin
}
/**
- * Get events Summary
+ * Get events Summary.
*
*
* @return array
}
/**
- * Fetch object based on array of properties
+ * Fetch object based on array of properties.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
}
/**
- * Add grant
+ * Add grant.
*
* @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 Contact
+ * Delete the Contact.
*
* @param int $id
* Contact id.
}
/**
- * 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
}
/**
- * 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
*
}
/**
- * Given a list of conditions in params generate the required
+ * Given a list of conditions in params generate the required.
* where clause
*
* @param $query
}
/**
- * Getter for the qill object
+ * Getter for the qill object.
*
* @return string
*/
}
/**
- * Add all the elements shared between grant search and advanaced search
+ * Add all the elements shared between grant search and advanaced search.
*
*
* @param CRM_Core_Form $form
class CRM_Grant_Controller_Search extends CRM_Core_Controller {
/**
- * Class constructor
+ * Class constructor.
*/
public 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 $_id;
/**
- * The id of the contact associated with this contribution
+ * The id of the contact associated with this contribution.
*
* @var int
*/
protected $_context;
/**
- * Set variables up before form is built
+ * Set variables up before form is built.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
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
*/
protected $_queryParams;
/**
- * Are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact.
*
* @var boolean
*/
protected $_single = FALSE;
/**
- * Are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact.
*
* @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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Set the default form values
+ * Set the default form values.
*
*
* @return array
class CRM_Grant_Form_Task extends CRM_Core_Form {
/**
- * The task being performed
+ * The task being performed.
*
* @var int
*/
protected $_task;
/**
- * The additional clause that we restrict the search with
+ * The additional clause that we restrict the search with.
*
* @var string
*/
protected $_componentClause = NULL;
/**
- * The array that holds all the component ids
+ * The array that holds all the component ids.
*
* @var array
*/
protected $_componentIds;
/**
- * The array that holds all the grant ids
+ * The array that holds all the grant ids.
*
* @var array
*/
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
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
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
*/
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
}
/**
- * add shortcut to Create New
+ * add shortcut to Create New.
* @param $shortCuts
*/
public function creatNewShortcut(&$shortCuts) {
class CRM_Grant_Page_Tab extends CRM_Contact_Page_View {
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
public $_contactId = NULL;
/**
- * called when action is browse
+ * called when action is browse.
*
*/
public function browse() {
}
/**
- * called when action is view
+ * called when action is view.
*
* @return null
*/
}
/**
- * called when action is update or new
+ * called when action is update or new.
*
* @return null
*/
}
/**
- * Build all the data structures needed to build the form
+ * Build all the data structures needed to build the form.
*
* @return void
*/
);
/**
- * Are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact.
*
* @var boolean
*/
protected $_single = FALSE;
/**
- * Are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact.
*
* @var boolean
*/
protected $_limit = NULL;
/**
- * What context are we being invoked from
+ * What context are we being invoked from.
*
* @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
*/
protected $_action;
/**
- * The additional clause that we restrict the search with
+ * The additional clause that we restrict the search with.
*
* @var string
*/
protected $_grantClause = NULL;
/**
- * The query object
+ * The query object.
*
* @var string
*/
protected $_query;
/**
- * Class constructor
+ * Class constructor.
*
* @param array $queryParams
* Array of parameters for query.
class CRM_Grant_StateMachine_Search extends CRM_Core_StateMachine {
/**
- * The task that the wizard is currently processing
+ * The task that the wizard is currently processing.
*
* @var string
*/
protected $_task;
/**
- * Class constructor
+ * Class constructor.
*
* @param object $controller
* @param \const|int $action
}
/**
- * Return the form name of the task
+ * Return the form name of the task.
*
* @return string
*/
class CRM_Group_Controller extends CRM_Core_Controller {
/**
- * Class constructor
+ * Class constructor.
*
* @param null $title
* @param bool|int $action
protected $_groupOrganizationID;
/**
- * Set up variables to build the form
+ * Set up variables to build the form.
*
* @return void
* @acess protected
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Global validation rules for the form
+ * Global validation rules for the form.
*
* @param array $fields
* Posted values of the form.
}
/**
- * Process the form when submitted
+ * Process the form when submitted.
*
* @return void
*/
}
/**
- * Build parent groups form elements
+ * Build parent groups form elements.
*
* @param CRM_Core_Form $form
*
}
/**
- * Define action links
+ * Define action links.
*
* self::$_links array of action links
*/
}
/**
- * Return class name of edit form
+ * Return class name of edit form.
*
* @return string
*/
}
/**
- * Return name of edit form
+ * Return name of edit form.
*
* @return string
*/
}
/**
- * Return name of delete form
+ * Return name of delete form.
*
* @return string
*/
}
/**
- * 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.
abstract class CRM_Import_DataSource {
/**
- * Provides information about the data source
+ * Provides information about the data source.
*
* @return array
* collection of info about this data source
abstract public function getInfo();
/**
- * Set variables up before form is built
+ * Set variables up before form is built.
*/
abstract public function preProcess(&$form);
abstract public function buildQuickForm(&$form);
/**
- * Process the form submission
+ * Process the form submission.
*/
abstract public function postProcess(&$params, &$db, &$form);
NUM_ROWS_TO_INSERT = 100;
/**
- * Provides information about the data source
+ * Provides information about the data source.
*
* @return array
* collection of info about this data source
}
/**
- * Set variables up before form is built
+ * Set variables up before form is built.
*/
public function preProcess(&$form) {
}
}
/**
- * Process the form submission
+ * Process the form submission.
*/
public function postProcess(&$params, &$db, &$form) {
$file = $params['uploadFile']['name'];
class CRM_Import_DataSource_SQL extends CRM_Import_DataSource {
/**
- * Provides information about the data source
+ * Provides information about the data source.
*
* @return array
* collection of info about this data source
}
/**
- * Set variables up before form is built
+ * Set variables up before form is built.
*/
public function preProcess(&$form) {
}
}
/**
- * Process the form submission
+ * Process the form submission.
*/
public function postProcess(&$params, &$db, &$form) {
$importJob = new CRM_Contact_Import_ImportJob(
}
/**
- * Attempt to match header labels with our mapper fields
+ * Attempt to match header labels with our mapper fields.
*
* @param string $header
* @param array $patterns
}
/**
- * Guess at the field names given the data and patterns from the schema
+ * Guess at the field names given the data and patterns from the schema.
*
* @param array $patterns
* @param string $index
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
abstract class CRM_Import_Form_Summary extends CRM_Core_Form {
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Abstract function definitions
+ * Abstract function definitions.
*/
abstract protected function init();
abstract protected function import($onDuplicate, &$values);
/**
- * Set and validate field values
+ * Set and validate field values.
*
* @param array $elements
* array.
}
/**
- * 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
}
/**
- * Setter function
+ * Setter function.
*
* @param int $max
*
}
/**
- * Determines the file extension based on error code
+ * Determines the file extension based on error code.
*
* @var $type error code constant
* @return string
}
/**
- * Determines the file name based on error code
+ * Determines the file name based on error code.
*
* @var $type error code constant
* @return string
class CRM_Import_StateMachine extends CRM_Core_StateMachine {
/**
- * Class constructor
+ * Class constructor.
*
* @param object $controller
* @param \const|int $action
static $_patterns = NULL;
/**
- * Class constructor
+ * Class constructor.
*/
public function __construct() {
parent::__construct();
}
/**
- * Build the static pattern array
+ * Build the static pattern array.
*
* @return void
*/
class CRM_Mailing_BAO_Component extends CRM_Mailing_DAO_Component {
/**
- * Class constructor
+ * Class constructor.
*/
public function __construct() {
parent::__construct();
}
/**
- * Fetch object based on array of properties
+ * Fetch object based on array of properties.
*
* @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.
}
/**
- * Create and Update mailing component
+ * Create and Update mailing component.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
}
/**
- * Generate an event queue for a test job
+ * Generate an event queue for a test job.
*
* @param array $testParams
* Contains form values.
}
/**
- * 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.
}
/**
- * Compose a message
+ * Compose a message.
*
* @param int $job_id
* ID of the Job associated with this message.
}
/**
- * Add the mailings
+ * Add the mailings.
*
* @param array $params
* Reference array contains the values submitted by the form.
}
/**
- * Replace the list of recipients on a given mailing
+ * Replace the list of recipients on a given mailing.
*
* @param int $mailingId
* @param string $type
}
/**
- * Get hash value of the mailing
+ * Get hash value of the mailing.
*
* @param $id
*
}
/**
- * Get the count of mailings
+ * Get the count of mailings.
*
* @param
*
}
/**
- * Get the rows for a browse operation
+ * Get the rows for a browse operation.
*
* @param int $offset
* The row number to start from.
}
/**
- * Show detail Mailing report
+ * Show detail Mailing report.
*
* @param int $id
*
}
/**
- * Delete Mails and all its associated records
+ * Delete Mails and all its associated records.
*
* @param int $id
* Id of the mail to delete.
}
/**
- * Build the compose mail form
+ * Build the compose mail form.
*
* @param CRM_Core_Form $form
*
}
/**
- * Build the compose PDF letter form
+ * Build the compose PDF letter form.
*
* @param CRM_Core_Form $form
*
}
/**
- * Get the search based mailing Ids
+ * Get the search based mailing Ids.
*
* @return array
* , searched base mailing ids.
}
/**
- * wrapper for ajax activity selector
+ * wrapper for ajax activity selector.
*
* @param array $params
* Associated array for params record id.
}
/**
- * Retrieve contact mailing
+ * Retrieve contact mailing.
*
* @param array $params
*
}
/**
- * Retrieve contact mailing count
+ * Retrieve contact mailing count.
*
* @param array $params
*
class CRM_Mailing_BAO_MailingAB extends CRM_Mailing_DAO_MailingAB {
/**
- * class constructor
+ * class constructor.
*/
public function __construct() {
parent::__construct();
}
/**
- * Construct a new mailingab object
+ * Construct a new mailingab object.
*
* @params array $params
* Form values.
}
/**
- * function to add the mailings
+ * function to add the mailings.
*
* @param array $params
* Reference array contains the values submitted by the form.
/**
- * Delete MailingAB and all its associated records
+ * Delete MailingAB and all its associated records.
*
* @param int $id
* Id of the mail to delete.
static $mailsProcessed = 0;
/**
- * Class constructor
+ * Class constructor.
*/
public function __construct() {
parent::__construct();
}
/**
- * post process to determine if the parent job
+ * post process to determine if the parent job.
* as well as the mailing is complete after the run
* @param null $mode
*/
}
/**
- * Split the parent job into n number of child job based on an offset
+ * Split the parent job into n number of child job based on an offset.
* If null or 0 , we create only one child job
* @param int $offset
*/
}
/**
- * Send the mailing
+ * Send the mailing.
*
* @param object $mailer
* A Mail object to send the messages.
}
/**
- * Cancel a mailing
+ * Cancel a mailing.
*
* @param int $mailingId
* The id of the mailing to be canceled.
}
/**
- * Return a translated status enum string
+ * Return a translated status enum string.
*
* @param string $status
* The status enum.
}
/**
- * Add all the elements shared between Mailing search and advnaced search
+ * Add all the elements shared between Mailing search and advnaced search.
*
*
* @param CRM_Core_Form $form
class CRM_Mailing_BAO_Recipients extends CRM_Mailing_DAO_Recipients {
/**
- * Class constructor
+ * Class constructor.
*/
public function __construct() {
parent::__construct();
class CRM_Mailing_BAO_Spool extends CRM_Mailing_DAO_Spool {
/**
- * Class constructor
+ * Class constructor.
*/
public function __construct() {
parent::__construct();
class CRM_Mailing_BAO_TrackableURL extends CRM_Mailing_DAO_TrackableURL {
/**
- * Class constructor
+ * Class constructor.
*/
public function __construct() {
parent::__construct();
const OUTBOUND_OPTION_REDIRECT_TO_DB = 5;
/**
- * What should be the verp separator we use
+ * What should be the verp separator we use.
*
* @var char
*/
class CRM_Mailing_Controller_Send extends CRM_Core_Controller {
/**
- * Class constructor
+ * Class constructor.
*
* @param null $title
* @param bool|int $action
class CRM_Mailing_Event_BAO_Bounce extends CRM_Mailing_Event_DAO_Bounce {
/**
- * Class constructor
+ * Class constructor.
*/
public function __construct() {
parent::__construct();
}
/**
- * Get row count for the event selector
+ * Get row count for the event selector.
*
* @param int $mailing_id
* ID of the mailing.
}
/**
- * Get rows for the event browser
+ * Get rows for the event browser.
*
* @param int $mailing_id
* ID of the mailing.
class CRM_Mailing_Event_BAO_Confirm extends CRM_Mailing_Event_DAO_Confirm {
/**
- * Class constructor
+ * Class constructor.
*/
public function __construct() {
parent::__construct();
}
/**
- * Confirm a pending subscription
+ * Confirm a pending subscription.
*
* @param int $contact_id
* The id of the contact.
class CRM_Mailing_Event_BAO_Delivered extends CRM_Mailing_Event_DAO_Delivered {
/**
- * Class constructor
+ * Class constructor.
*/
public function __construct() {
parent::__construct();
}
/**
- * Create a new delivery event
+ * Create a new delivery event.
*
* @param array $params
* Associative array of delivery event values.
}
/**
- * Get row count for the event selector
+ * Get row count for the event selector.
*
* @param int $mailing_id
* ID of the mailing.
}
/**
- * Get rows for the event browser
+ * Get rows for the event browser.
*
* @param int $mailing_id
* ID of the mailing.
class CRM_Mailing_Event_BAO_Forward extends CRM_Mailing_Event_DAO_Forward {
/**
- * Class constructor
+ * Class constructor.
*/
public function __construct() {
parent::__construct();
}
/**
- * Get row count for the event selector
+ * Get row count for the event selector.
*
* @param int $mailing_id
* ID of the mailing.
}
/**
- * Get rows for the event browser
+ * Get rows for the event browser.
*
* @param int $mailing_id
* ID of the mailing.
class CRM_Mailing_Event_BAO_Opened extends CRM_Mailing_Event_DAO_Opened {
/**
- * Class constructor
+ * Class constructor.
*/
public function __construct() {
parent::__construct();
}
/**
- * Register an open event
+ * Register an open event.
*
* @param int $queue_id
* The Queue Event ID of the recipient.
}
/**
- * Get row count for the event selector
+ * Get row count for the event selector.
*
* @param int $mailing_id
* ID of the mailing.
}
/**
- * Get opened count for each mailing for a given set of mailing IDs and a specific contact
+ * Get opened count for each mailing for a given set of mailing IDs and a specific contact.
*
* @param int $mailingIDs
* IDs of the mailing (comma separated).
}
/**
- * Get rows for the event browser
+ * Get rows for the event browser.
*
* @param int $mailing_id
* ID of the mailing.
class CRM_Mailing_Event_BAO_Queue extends CRM_Mailing_Event_DAO_Queue {
/**
- * Class constructor
+ * Class constructor.
*/
public function __construct() {
parent::__construct();
}
/**
- * Queue a new recipient
+ * Queue a new recipient.
*
* @param array $params
* Values of the new EventQueue.
}
/**
- * Count up events given a mailing id and optional job id
+ * Count up events given a mailing id and optional job id.
*
* @param int $mailing_id
* ID of the mailing to count.
}
/**
- * Get rows for the event browser
+ * Get rows for the event browser.
*
* @param int $mailing_id
* ID of the mailing.
}
/**
- * Get the mailing object for this queue event instance
+ * Get the mailing object for this queue event instance.
*
* @param
*
class CRM_Mailing_Event_BAO_Reply extends CRM_Mailing_Event_DAO_Reply {
/**
- * Class constructor
+ * Class constructor.
*/
public function __construct() {
parent::__construct();
}
/**
- * Forward a mailing reply
+ * Forward a mailing reply.
*
* @param int $queue_id
* Queue event ID of the sender.
}
/**
- * Send an automated response
+ * Send an automated response.
*
* @param object $mailing
* The mailing object.
}
/**
- * Get row count for the event selector
+ * Get row count for the event selector.
*
* @param int $mailing_id
* ID of the mailing.
}
/**
- * Get rows for the event browser
+ * Get rows for the event browser.
*
* @param int $mailing_id
* ID of the mailing.
class CRM_Mailing_Event_BAO_Subscribe extends CRM_Mailing_Event_DAO_Subscribe {
/**
- * Class constructor
+ * Class constructor.
*/
public function __construct() {
parent::__construct();
}
/**
- * Verify the hash of a subscription event
+ * Verify the hash of a subscription event.
*
* @param int $contact_id
* ID of the contact.
}
/**
- * Get the domain object given a subscribe event
+ * Get the domain object given a subscribe event.
*
* @param int $subscribe_id
* ID of the subscribe event.
}
/**
- * Get the group details to which given email belongs
+ * Get the group details to which given email belongs.
*
* @param string $email
* Email of the contact.
}
/**
- * Send subscribe mail
+ * Send subscribe mail.
*
* @param array $groups
* The list of group ids for subscribe.
class CRM_Mailing_Event_BAO_TrackableURLOpen extends CRM_Mailing_Event_DAO_TrackableURLOpen {
/**
- * Class constructor
+ * Class constructor.
*/
public function __construct() {
parent::__construct();
}
/**
- * Get row count for the event selector
+ * Get row count for the event selector.
*
* @param int $mailing_id
* ID of the mailing.
}
/**
- * Get tracked url count for each mailing for a given set of mailing IDs
+ * Get tracked url count for each mailing for a given set of mailing IDs.
*
* @param int $mailingIDs
* IDs of the mailing (comma separated).
}
/**
- * Get rows for the event browser
+ * Get rows for the event browser.
*
* @param int $mailing_id
* ID of the mailing.
class CRM_Mailing_Event_BAO_Unsubscribe extends CRM_Mailing_Event_DAO_Unsubscribe {
/**
- * Class constructor
+ * Class constructor.
*/
public function __construct() {
parent::__construct();
}
/**
- * Unsubscribe a contact from the domain
+ * Unsubscribe a contact from the domain.
*
* @param int $job_id
* The job ID.
}
/**
- * Unsubscribe a contact from all groups that received this mailing
+ * Unsubscribe a contact from all groups that received this mailing.
*
* @param int $job_id
* The job ID.
}
/**
- * Send a reponse email informing the contact of the groups from which he
+ * Send a reponse email informing the contact of the groups from which he.
* has been unsubscribed.
*
* @param string $queue_id
}
/**
- * Get row count for the event selector
+ * Get row count for the event selector.
*
* @param int $mailing_id
* ID of the mailing.
}
/**
- * Get rows for the event browser
+ * Get rows for the event browser.
*
* @param int $mailing_id
* ID of the mailing.
}
/**
- * Set variables up before form is built
+ * Set variables up before form is built.
*
* @return void
*/
}
/**
- * Display Name of the form
+ * Display Name of the form.
*
*
* @return string
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
protected $_id;
/**
- * The name of the BAO object for this form
+ * The name of the BAO object for this form.
*
* @var string
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
}
/**
- * Validation
+ * Validation.
*
* @param array $params
* (ref.) an assoc array of name/value pairs.
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Display Name of the form
+ * Display Name of the form.
*
*
* @return string
}
/**
- * 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
*/
}
/**
- * Build the form object for the last step of the mailing wizard
+ * Build the form object for the last step of the mailing wizard.
*
* @param
*
}
/**
- * Display Name of the form
+ * Display Name of the form.
*
*
* @return string
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Display Name of the form
+ * Display Name of the form.
*
*
* @return string
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
class CRM_Mailing_Form_Task extends CRM_Core_Form {
/**
- * The task being performed
+ * The task being performed.
*
* @var int
*/
protected $_task;
/**
- * The additional clause that we restrict the search with
+ * The additional clause that we restrict the search with.
*
* @var string
*/
protected $_componentClause = NULL;
/**
- * The array that holds all the component ids
+ * The array that holds all the component ids.
*
* @var array
*/
protected $_componentIds;
/**
- * Build all the data structures needed to build the form
+ * Build all the data structures needed to build the form.
*
* @param
*
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
*/
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
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
*/
}
/**
- * Display Name of the form
+ * Display Name of the form.
*
*
* @return string
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Validation
+ * Validation.
*
* @param array $params
* (ref.) an assoc array of name/value pairs.
}
/**
- * Display Name of the form
+ * Display Name of the form.
*
*
* @return string
}
/**
- * add shortcut to Create New
+ * add shortcut to Create New.
* @param $shortCuts
*/
public function creatNewShortcut(&$shortCuts) {
}
/**
- * Return all emails in the mail store
+ * Return all emails in the mail store.
*
* @return array
* array of ezcMail objects
}
/**
- * Return the next X messages from the mail store
+ * Return the next X messages from the mail store.
*
* @param int $count
* Number of messages to fetch (0 to fetch all).
class CRM_Mailing_MailStore_Imap extends CRM_Mailing_MailStore {
/**
- * Connect to the supplied IMAP server and make sure the two mailboxes exist
+ * Connect to the supplied IMAP server and make sure the two mailboxes exist.
*
* @param string $host
* Host to connect to.
}
/**
- * Move the specified message to the ignored folder
+ * Move the specified message to the ignored folder.
*
* @param int $nr
* Number of the message to move.
}
/**
- * Move the specified message to the processed folder
+ * Move the specified message to the processed folder.
*
* @param int $nr
* Number of the message to move.
class CRM_Mailing_MailStore_Localdir extends CRM_Mailing_MailStore {
/**
- * Connect to the supplied dir and make sure the two mail dirs exist
+ * Connect to the supplied dir and make sure the two mail dirs exist.
*
* @param string $dir
* Dir to operate upon.
}
/**
- * Return the next X messages from the mail store
+ * Return the next X messages from the mail store.
* FIXME: in CiviCRM 2.2 this always returns all the emails
*
* @param int $count
}
/**
- * Fetch the specified message to the local ignore folder
+ * Fetch the specified message to the local ignore folder.
*
* @param int $file
* File location of the message to fetch.
}
/**
- * Fetch the specified message to the local processed folder
+ * Fetch the specified message to the local processed folder.
*
* @param int $file
* File location of the message to fetch.
class CRM_Mailing_MailStore_Maildir extends CRM_Mailing_MailStore {
/**
- * Connect to the supplied dir and make sure the two mail dirs exist
+ * Connect to the supplied dir and make sure the two mail dirs exist.
*
* @param string $dir
* Dir to operate upon.
}
/**
- * Return the next X messages from the mail store
+ * Return the next X messages from the mail store.
* FIXME: in CiviCRM 2.2 this always returns all the emails
*
* @param int $count
}
/**
- * Fetch the specified message to the local ignore folder
+ * Fetch the specified message to the local ignore folder.
*
* @param int $file
* File location of the message to fetch.
}
/**
- * Fetch the specified message to the local processed folder
+ * Fetch the specified message to the local processed folder.
*
* @param int $file
* File location of the message to fetch.
class CRM_Mailing_MailStore_Mbox extends CRM_Mailing_MailStore {
/**
- * Connect to and lock the supplied file and make sure the two mail dirs exist
+ * Connect to and lock the supplied file and make sure the two mail dirs exist.
*
* @param string $file
* Mbox to operate upon.
}
/**
- * Fetch the specified message to the local ignore folder
+ * Fetch the specified message to the local ignore folder.
*
* @param int $nr
* Number of the message to fetch.
}
/**
- * Fetch the specified message to the local processed folder
+ * Fetch the specified message to the local processed folder.
*
* @param int $nr
* Number of the message to fetch.
}
/**
- * Fetch the specified message to the local ignore folder
+ * Fetch the specified message to the local ignore folder.
*
* @param int $nr
* Number of the message to fetch.
}
/**
- * Fetch the specified message to the local processed folder
+ * Fetch the specified message to the local processed folder.
*
* @param int $nr
* Number of the message to fetch.
}
/**
- * 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
*/
public $_archived;
/**
- * Scheduled mailing
+ * Scheduled mailing.
*
* @boolean
*/
class CRM_Mailing_Page_Component extends CRM_Core_Page_Basic {
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
static $_links = NULL;
/**
- * Get BAO Name
+ * Get BAO Name.
*
* @return string
* Classname of BAO.
}
/**
- * Get action Links
+ * Get action Links.
*
* @return array
* (reference) of action links
}
/**
- * Get name of edit form
+ * Get name of edit form.
*
* @return string
* Classname of edit form.
}
/**
- * Get edit form name
+ * Get edit form name.
*
* @return string
* name of this page.
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
*/
public $_mailing_id;
/**
- * Get BAO Name
+ * Get BAO Name.
*
* @return string
* Classname of BAO
*/
class CRM_Mailing_Page_Tab extends CRM_Contact_Page_View {
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
protected $_contactID;
/**
- * Lets do permission checking here
+ * Lets do permission checking here.
* First check for valid mailing, if false return fatal
* Second check for visibility
* Call a hook to see if hook wants to override visibility setting
private static $defaultComponent;
/**
- * Get all the mailing components of a particular type
+ * Get all the mailing components of a particular type.
*
* @param $type
* The type of component needed.
}
/**
- * Determine the default mailing component of a given type
+ * Determine the default mailing component of a given type.
*
* @param $type
* The type of component needed.
}
/**
- * Get all the mailing templates
+ * Get all the mailing templates.
*
*
* @return array
}
/**
- * Get all the completed mailing
+ * Get all the completed mailing.
*
*
* @param null $mode
protected $_parent;
/**
- * Class constructor
+ * Class constructor.
*
*
* @return \CRM_Mailing_Selector_Browse
}
/**
- * Returns all the rows in the given offset and rowCount
+ * Returns all the rows in the given offset and rowCount.
*
* @param string $action
* The action being performed.
public $_columnHeaders;
/**
- * Class constructor
+ * Class constructor.
*
* @param string $event
* The event type (queue/delivered/open...).
}
/**
- * Returns all the rows in the given offset and rowCount
+ * Returns all the rows in the given offset and rowCount.
*
* @param string $action
* The action being performed.
public $_queryParams;
/**
- * Represent the type of selector
+ * Represent the type of selector.
*
* @var int
*/
protected $_action;
/**
- * The additional clause that we restrict the search with
+ * The additional clause that we restrict the search with.
*
* @var string
*/
protected $_mailingClause = NULL;
/**
- * The query object
+ * The query object.
*
* @var string
*/
protected $_query;
/**
- * Class constructor
+ * Class constructor.
*
* @param array $queryParams
* Array of parameters for query.
}
/**
- * Returns all the rows in the given offset and rowCount
+ * Returns all the rows in the given offset and rowCount.
*
* @param string $action
* The action being performed.
class CRM_Mailing_StateMachine_Send extends CRM_Core_StateMachine {
/**
- * Class constructor
+ * Class constructor.
*
* @param CRM_Mailing_Controller $controller
* @param \const|int $action
}
/**
- * These tasks are the core set of tasks that the user can perform
+ * These tasks are the core set of tasks that the user can perform.
* on mailing recipients
*
* @param int $value
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 $_signupActType = NULL;
/**
- * Class constructor
+ * Class constructor.
*
* @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.
}
/**
- * Check the membership extended through relationship
+ * Check the membership extended through relationship.
*
* @param int $membershipId
* Membership id.
}
/**
- * Takes a bunch of params that are needed to match certain criteria and
- * retrieves the relevant objects. We'll tweak this function to be more
- * full featured over a period of time. This is the inverse function of
- * create. It also stores all the retrieved values in the default array
+ * Retrieve DB object based on input parameters.
+ *
+ * It also stores all the retrieved values in the default array.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
}
/**
- * Delete related memberships
+ * Delete related memberships.
*
* @param int $ownerMembershipId
* @param int $contactId
}
/**
- * Build Membership Block in Contribution Pages
+ * Build Membership Block in Contribution Pages.
*
* @param CRM_Core_Form $form
* Form object.
}
/**
- * Return Membership Block info in Contribution Pages
+ * Return Membership Block info in Contribution Pages.
*
* @param int $pageID
* Contribution page id.
}
/**
- * 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
}
/**
- * Combine all the importable fields from the lower levels object
+ * Combine all the importable fields from the lower levels object.
*
* @param string $contactType
* Contact type.
}
/**
- * Get all exportable fields
+ * Get all exportable fields.
*
* @retun array return array of all exportable fields
*/
}
/**
- * Function check the status of the membership before adding membership for a contact
+ * Function check the status of the membership before adding membership for a contact.
*
* @param int $contactId
* Contact id.
}
/**
- * Process the Memberships
+ * Process the Memberships.
*
* @param array $membershipParams
* Array of membership fields.
}
/**
- * Method to fix membership status of stale membership
+ * Method to fix membership status of stale membership.
*
* This method first checks if the membership is stale. If it is,
* then status will be updated based on existing start and end
}
/**
- * Get the contribution page id from the membership record
+ * Get the contribution page id from the membership record.
*
* @param int $membershipID
*
}
/**
- * Updated related memberships
+ * Updated related memberships.
*
* @param int $ownerMembershipId
* Owner Membership Id.
}
/**
- * 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
*
}
/**
- * 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.
}
/**
- * Create memberships for related contacts
+ * Create memberships for related contacts.
* takes into account the maximum related memberships
*
* @param array $params
}
/**
- * Delete the record that are associated with this Membership Payment
+ * Delete the record that are associated with this Membership Payment.
*
* @param int $membershipId
*
}
/**
- * Get membership record count for a Contact
+ * Get membership record count for a Contact.
*
* @param int $contactID
* @param bool $activeOnly
}
/**
- * Check whether subscription is already cancelled
+ * Check whether subscription is already cancelled.
*
* @param int $mid
* Membership id.
}
/**
- * Where a second separate financial transaction is supported we will process it here
+ * Where a second separate financial transaction is supported we will process it here.
*
* @param int $contactID
* @param CRM_Contribute_Form_Contribution_Confirm $form
}
/**
- * Turn array of errors into message string
+ * Turn array of errors into message string.
*
* @param array $errors
*
}
/**
- * Extract relevant values from the form so we can separate form logic from BAO logcis
+ * Extract relevant values from the form so we can separate form logic from BAO logcis.
*
* @param CRM_Core_Form $form
* @param $changeToday
}
/**
- * 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
}
/**
- * Record contribution record associated with membership
+ * Record contribution record associated with membership.
*
* @param array $params
* Array of submitted params.
}
/**
- * Record line items for default membership
+ * Record line items for default membership.
*
* @param CRM_Core_Form $qf
* @param array $membershipType
*/
class CRM_Member_BAO_MembershipBlock extends CRM_Member_DAO_MembershipBlock {
/**
- * Class constructor
+ * Class constructor.
*/
public 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.
}
/**
- * Delete membership log record
+ * Delete membership log record.
*
* @param int $membershipID
*
/**
- * Class constructor
+ * Class constructor.
*/
public 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.
*/
public function __construct() {
parent::__construct();
}
/**
- * Fetch object based on array of properties
+ * Fetch object based on array of properties.
*
* @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.
}
/**
- * Takes an associative array and creates a membership Status object
+ * Takes an associative array and creates a membership Status object.
* See http://wiki.civicrm.org/confluence/display/CRM/Database+layer
*
* @param array $params
}
/**
- * Add the membership types
+ * Add the membership types.
*
* @param array $params
* Reference array contains the values submitted by the form.
}
/**
- * Get defaults for new entity
+ * Get defaults for new entity.
* @return array
*/
public static function getDefaults() {
}
/**
- * Get membership status
+ * Get membership status.
*
* @param int $membershipStatusId
*
}
/**
- * Delete membership Types
+ * Delete membership Types.
*
* @param int $membershipStatusId
*
}
/**
- * Function that return the status ids whose is_current_member is set
+ * Function that return the status ids whose is_current_member is set.
*
* @return array
*/
}
/**
- * Does this membership start between the rollover date and the start of the next period
+ * Does this membership start between the rollover date and the start of the next period.
* (in which case they will get an extra membership period)
* ie if annual memberships run June - May & the rollover is in May memberships between
* May and June will return TRUE and between June and May will return FALSE
}
/**
- * Calculate start date and end date for renewal membership
+ * Calculate start date and end date for renewal membership.
*
* @param int $membershipId
* @param $changeToday
}
/**
- * Retrieve all Membership Types associated
+ * Retrieve all Membership Types associated.
* with an Organization
*
* @param int $orgID
}
/**
- * Retrieve all Membership Types with Member of Contact id
+ * Retrieve all Membership Types with Member of Contact id.
*
* @param array $membershipTypes
* array of membership type ids
class CRM_Member_Controller_Search extends CRM_Core_Controller {
/**
- * Class constructor
+ * Class constructor.
*/
public function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) {
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
protected $_memTypeSelected;
/**
- * Display name of the member
+ * Display name of the member.
*
* @var string
*/
protected $_memberEmail = NULL;
/**
- * Contact ID of the member
+ * Contact ID of the member.
*
* @var int
*/
protected $_contributorContactID = NULL;
/**
- * ID of the person the receipt is to go to
+ * ID of the person the receipt is to go to.
*
* @var int
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Validation
+ * Validation.
*
* @param array $params
* (ref.) an assoc array of name/value pairs.
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
}
/**
- * Send email receipt
+ * Send email receipt.
*
* @param CRM_Core_Form $form
* Form object.
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Validation
+ * Validation.
*
* @param array $params
* (ref.) an assoc array of name/value pairs.
}
/**
- * Process the form
+ * Process the form.
*
* @return void
*/
public $_id;
/**
- * The name of the BAO object for this form
+ * The name of the BAO object for this form.
*
* @var string
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
class CRM_Member_Form_MembershipRenewal extends CRM_Member_Form {
/**
- * Display name of the member
+ * Display name of the member.
*
* @var string
*/
protected $_memberEmail = NULL;
/**
- * Contact ID of the member
+ * Contact ID of the member.
*
*
* @var int
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Validation
+ * Validation.
*
* @param array $params
* (ref.) an assoc array of name/value pairs.
}
/**
- * Process the renewal form
+ * Process the renewal form.
*
*
* @return void
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Validation
+ * Validation.
*
* @param array $params
* (ref.) an assoc array of name/value pairs.
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
class CRM_Member_Form_MembershipView extends CRM_Core_Form {
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
static $_links = NULL;
/**
- * Add context information at the end of a link
+ * Add context information at the end of a link.
*
* @return string
* extra query parameters
}
/**
- * Get action Links
+ * Get action Links.
*
* @return array
* (reference) of action links
}
/**
- * Perform create or delete action on related memberships
+ * Perform create or delete action on related memberships.
*
* @param string $action
* Create or delete.
}
/**
- * Set variables up before form is built
+ * Set variables up before form is built.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
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
*/
protected $_queryParams;
/**
- * Are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact.
*
* @var boolean
*/
protected $_single = FALSE;
/**
- * Are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact.
*
* @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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
class CRM_Member_Form_Task extends CRM_Core_Form {
/**
- * The task being performed
+ * The task being performed.
*
* @var int
*/
protected $_task;
/**
- * The additional clause that we restrict the search with
+ * The additional clause that we restrict the search with.
*
* @var string
*/
protected $_componentClause = NULL;
/**
- * The array that holds all the component ids
+ * The array that holds all the component ids.
*
* @var array
*/
protected $_componentIds;
/**
- * The array that holds all the contact ids
+ * The array that holds all the contact ids.
*
* @var array
*/
public $_contactIds;
/**
- * The array that holds all the member ids
+ * The array that holds all the member ids.
*
* @var array
*/
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
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
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
*/
}
/**
- * Set defaults
+ * Set defaults.
* (non-PHPdoc)
* @see CRM_Core_Form::setDefaultValues()
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
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
*
}
/**
- * Generate htmlfor pdf letters
+ * Generate htmlfor pdf letters.
*
* @param array $membershipIDs
* @param array $returnProperties
protected $_userContext;
/**
- * Build all the data structures needed to build the form
+ * Build all the data structures needed to build the form.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Add local and global form rules
+ * Add local and global form rules.
*
*
* @return void
}
/**
- * 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.
*
*
* @return void
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
*/
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the uploaded file
+ * Process the uploaded file.
*
* @return void
*/
/**
- * store contactType
+ * store contactType.
*
* @var int
*/
/**
- * Set variables up before form is built
+ * Set variables up before form is built.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * 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
*/
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
*/
}
/**
- * 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
}
/**
- * Store parser values
+ * Store parser values.
*
* @param CRM_Core_Session $store
*
}
/**
- * Export data to a CSV file
+ * Export data to a CSV file.
*
* @param string $fileName
* @param array $header
protected $_newMemberships;
/**
- * Class constructor
+ * Class constructor.
*/
public function __construct(&$mapperKeys, $mapperLocType = NULL, $mapperPhoneType = NULL) {
parent::__construct();
}
/**
- * 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.
}
/**
- * add shortcut to Create New
+ * add shortcut to Create New.
* @param $shortCuts
* @param $newCredit
*/
class CRM_Member_Page_AJAX {
/**
- * SetDefaults according to membership type
+ * SetDefaults according to membership type.
*/
public static function getMemberTypeDefaults() {
if (!$_POST['mtype']) {
public $useLivePageJS = TRUE;
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
static $_links = NULL;
/**
- * Get BAO Name
+ * Get BAO Name.
*
* @return string
* Classname of BAO.
}
/**
- * Get action Links
+ * Get action Links.
*
* @return array
* (reference) of action links
}
/**
- * Get name of edit form
+ * Get name of edit form.
*
* @return string
* Classname of edit form.
}
/**
- * Get edit form name
+ * Get edit form name.
*
* @return string
* name of this page.
class CRM_Member_Page_MembershipType extends CRM_Core_Page {
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
public $useLivePageJS = TRUE;
/**
- * Get action Links
+ * Get action Links.
*
* @return array
* (reference) of action links
class CRM_Member_Page_Tab extends CRM_Core_Page {
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
public $_contactId = NULL;
/**
- * called when action is browse
+ * called when action is browse.
*/
public function browse() {
$links = self::links('all', $this->_isPaymentProcessor, $this->_accessContribution);
}
/**
- * called when action is view
+ * called when action is view.
*
* @return null
*/
}
/**
- * called when action is update or new
+ * called when action is update or new.
*
* @return null
*/
}
/**
- * Get action links
+ * Get action links.
*
* @param string $status
* @param null $isPaymentProcessor
}
/**
- * 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
}
/**
- * used for the to show the associated
+ * used for the to show the associated.
* contribution for the membership
*
* @param int $contactId
}
/**
- * Get BAO Name
+ * Get BAO Name.
*
* @return string
* Classname of BAO.
class CRM_Member_Page_UserDashboard extends CRM_Contact_Page_View_UserDashBoard {
/**
- * List memberships for the UF user
+ * List memberships for the UF user.
*
*/
public function listMemberships() {
class CRM_Member_PseudoConstant extends CRM_Core_PseudoConstant {
/**
- * Membership types
+ * Membership types.
* @var array
*/
private static $membershipType;
/**
- * Membership types
+ * Membership types.
* @var array
*/
private static $membershipStatus;
/**
- * Get all the membership types
+ * Get all the membership types.
*
*
* @param int $id
}
/**
- * Get all the membership statuss
+ * Get all the membership statuss.
*
*
* @param int $id
public $_queryParams;
/**
- * Represent the type of selector
+ * Represent the type of selector.
*
* @var int
*/
protected $_action;
/**
- * The additional clause that we restrict the search with
+ * The additional clause that we restrict the search with.
*
* @var string
*/
protected $_memberClause = NULL;
/**
- * The query object
+ * The query object.
*
* @var string
*/
protected $_query;
/**
- * Class constructor
+ * Class constructor.
*
* @param array $queryParams
* Array of parameters for query.
}
/**
- * Returns all the rows in the given offset and rowCount
+ * Returns all the rows in the given offset and rowCount.
*
* @param string $action
* The action being performed.
class CRM_Member_StateMachine_Search extends CRM_Core_StateMachine {
/**
- * The task that the wizard is currently processing
+ * The task that the wizard is currently processing.
*
* @var string
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Global form rule
+ * Global form rule.
*
* @param array $fields
* The input form values.
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Validation
+ * Validation.
*
* @param array $params
* (ref.) an assoc array of name/value pairs.
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Validation
+ * Validation.
*
* @param array $params
* (ref.) an assoc array of name/value pairs.
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
public $_context;
/**
- * Set variables up before form is built
+ * Set variables up before form is built.
*/
public function preProcess() {
if ($this->_action & CRM_Core_Action::DELETE) {
}
/**
- * Build the form object
+ * Build the form object.
*/
public function buildQuickForm() {
if ($this->_action & CRM_Core_Action::DELETE) {
}
/**
- * Global validation rules for the form
+ * Global validation rules for the form.
*
* @param array $fields
* Posted values of the form.
}
/**
- * Process the form
+ * Process the form.
*/
public function postProcess() {
if ($this->_action & CRM_Core_Action::DELETE) {
class CRM_PCP_Form_PCPAccount extends CRM_Core_Form {
/**
- * Variable defined for Contribution Page Id
+ * Variable defined for Contribution Page Id.
*/
public $_pageId = NULL;
public $_id = NULL;
public $_single;
/**
- * The default values for the form
+ * The default values for the form.
*
* @var array
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Global form rule
+ * Global form rule.
*
* @param array $fields
* The input form values.
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
class CRM_PCP_Page_PCP extends CRM_Core_Page_Basic {
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
static $_links = NULL;
/**
- * Get BAO Name
+ * Get BAO Name.
*
* @return string
* Classname of BAO.
}
/**
- * Get action Links
+ * Get action Links.
*
* @return array
* (reference) of action links
}
/**
- * Get name of edit form
+ * Get name of edit form.
*
* @return string
* Classname of edit form.
}
/**
- * Get edit form name
+ * Get edit form name.
*
* @return string
* name of this page.
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 $_exportableFields = NULL;
/**
- * Class constructor
+ * Class constructor.
*/
public function __construct() {
parent::__construct();
}
/**
- * Takes a bunch of params that are needed to match certain criteria and
- * retrieves the relevant objects. Typically the valid params are only
- * pledge id. We'll tweak this function to be more full featured over a period
- * of time. This is the inverse function of create. It also stores all the retrieved
- * values in the default array
+ * Retrieve DB object based on input parameters.
+ *
+ * It also stores all the retrieved values in the default array.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
}
/**
- * 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 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.
}
/**
- * 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
}
/**
- * Get pending or in progress pledges
+ * Get pending or in progress pledges.
*
* @param int $contactID
* Contact id.
}
/**
- * Get pledge record count for a Contact
+ * Get pledge record count for a Contact.
*
* @param int $contactID
*
}
/**
- * Get array of non transactional statuses
+ * Get array of non transactional statuses.
* @return array
* non transactional status ids
*/
}
/**
- * Get array of non transactional statuses
+ * Get array of non transactional statuses.
* @return array
* non transactional status ids
*/
class CRM_Pledge_BAO_PledgeBlock extends CRM_Pledge_DAO_PledgeBlock {
/**
- * Class constructor
+ * Class constructor.
*/
public function __construct() {
parent::__construct();
}
/**
- * Takes a bunch of params that are needed to match certain criteria and
- * retrieves the relevant objects. Typically the valid params are only
- * pledgeBlock id. We'll tweak this function to be more full featured over a period
- * of time. This is the inverse function of create. It also stores all the retrieved
- * values in the default array
+ * Retrieve DB object based on input parameters.
+ *
+ * It also stores all the retrieved values in the default array.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
}
/**
- * 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.
}
/**
- * Build Pledge Block in Contribution Pages
+ * Build Pledge Block in Contribution Pages.
*
* @param CRM_Core_Form $form
*/
class CRM_Pledge_BAO_PledgePayment extends CRM_Pledge_DAO_PledgePayment {
/**
- * Class constructor
+ * Class constructor.
*/
public function __construct() {
parent::__construct();
}
/**
- * Get pledge payment details
+ * Get pledge payment details.
*
* @param int $pledgeId
* Pledge id.
}
/**
- * Add pledge payment
+ * Add pledge payment.
*
* @param array $params
* Associate array of field.
}
/**
- * Takes a bunch of params that are needed to match certain criteria and
- * retrieves the relevant objects. Typically the valid params are only
- * pledge id. We'll tweak this function to be more full featured over a period
- * of time. This is the inverse function of create. It also stores all the retrieved
- * values in the default array
+ * Retrieve DB object based on input parameters.
+ *
+ * It also stores all the retrieved values in the default array.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
}
/**
- * Delete pledge payment
+ * Delete pledge payment.
*
* @param int $id
*
}
/**
- * 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.
}
/**
- * Calculate the pledge status
+ * Calculate the pledge status.
*
* @param int $pledgeId
* Pledge id.
}
/**
- * Update pledge payment table
+ * Update pledge payment table.
*
* @param int $pledgeId
* Pledge id.
}
/**
- * Update pledge payment table when reminder is sent
+ * Update pledge payment table when reminder is sent.
*
* @param int $paymentId
* Payment id.
}
/**
- * Get oldest pending or in progress pledge payments
+ * Get oldest pending or in progress pledge payments.
*
* @param int $pledgeID
* Pledge id.
}
/**
- * Build select for Pledge
+ * Build select for Pledge.
*
* @param $query
*
}
/**
- * Getter for the qill object
+ * Getter for the qill object.
*
* @return string
*/
}
/**
- * Ideally this function should include fields that are displayed in the selector
+ * Ideally this function should include fields that are displayed in the selector.
*/
public static function defaultReturnProperties(
$mode,
}
/**
- * This includes any extra fields that might need for export etc
+ * This includes any extra fields that might need for export etc.
*/
public static function extraReturnProperties($mode) {
$properties = NULL;
class CRM_Pledge_Controller_Search extends CRM_Core_Controller {
/**
- * Class constructor
+ * Class constructor.
*/
public 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 $_id;
/**
- * Set variables up before form is built
+ * Set variables up before form is built.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
public $_action;
/**
- * The id of the pledge that we are proceessing
+ * The id of the pledge that we are proceessing.
*
* @var int
*/
public $_id;
/**
- * The id of the contact associated with this pledge
+ * The id of the contact associated with this pledge.
*
* @var int
*/
public $_contactID;
/**
- * The Pledge values if an existing pledge
+ * The Pledge values if an existing pledge.
*/
public $_values;
/**
- * The Pledge frequency Units
+ * The Pledge frequency Units.
*/
public $_freqUnits;
public $_isPending = FALSE;
/**
- * Set variables up before form is built
+ * Set variables up before form is built.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Global form rule
+ * Global form rule.
*
* @param array $fields
* The input form values.
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
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
*/
protected $_queryParams;
/**
- * Are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact.
*
* @var boolean
*/
protected $_single = FALSE;
/**
- * Are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact.
*
* @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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Global validation rules for the form
+ * Global validation rules for the form.
*
* @param array $fields
* Posted values of the form.
}
/**
- * Set the default form values
+ * Set the default form values.
*
*
* @return array
class CRM_Pledge_Form_Task extends CRM_Core_Form {
/**
- * The task being performed
+ * The task being performed.
*
* @var int
*/
protected $_task;
/**
- * The additional clause that we restrict the search with
+ * The additional clause that we restrict the search with.
*
* @var string
*/
protected $_componentClause = NULL;
/**
- * The array that holds all the component ids
+ * The array that holds all the component ids.
*
* @var array
*/
protected $_componentIds;
/**
- * The array that holds all the pledge ids
+ * The array that holds all the pledge ids.
*
* @var array
*/
protected $_pledgeIds;
/**
- * Build all the data structures needed to build the form
+ * Build all the data structures needed to build the form.
*
* @param
*
protected $_single = FALSE;
/**
- * Build all the data structures needed to build the form
+ * Build all the data structures needed to build the form.
*/
public function preProcess() {
//check for delete
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
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
*/
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * add shortcut to Create New
+ * add shortcut to Create New.
* @param $shortCuts
*/
public function creatNewShortcut(&$shortCuts) {
class CRM_Pledge_Page_AJAX {
/**
- * Building Pledge Name combo box
+ * Building Pledge Name combo box.
*/
public static function pledgeName() {
}
/**
- * called when action is update or new
+ * called when action is update or new.
*
* @return null
*/
public $_contactId = NULL;
/**
- * called when action is browse
+ * called when action is browse.
*
* @return void
*/
}
/**
- * called when action is view
+ * called when action is view.
*
* @return null
*/
}
/**
- * called when action is update or new
+ * called when action is update or new.
*
* @return null
*/
class CRM_Pledge_Page_UserDashboard extends CRM_Contact_Page_View_UserDashBoard {
/**
- * called when action is browse
+ * called when action is browse.
*
*/
public function listPledges() {
}
/**
- * Return the form name of the task
+ * Return the form name of the task.
*
* @return string
*/
}
/**
- * These tasks are the core set of task titles
+ * These tasks are the core set of task titles.
*
* @return array
* the set of task titles
}
/**
- * These tasks get added based on the context the user is in
+ * These tasks get added based on the context the user is in.
*
* @return array
* the set of optional tasks for a group of contacts
}
/**
- * Takes a bunch of params that are needed to match certain criteria and
- * retrieves the relevant objects. Typically, the valid params are only
- * price_field_id. This is the inverse function of create. It also
- * stores all of the retrieved values in the default array.
+ * Retrieve DB object based on input parameters.
+ *
+ * It also stores all the retrieved values in the default array.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
}
/**
- * Wrapper for line item retrieval when contribution ID is known
+ * Wrapper for line item retrieval when contribution ID is known.
* @param int $contributionID
*
* @return array
}
/**
- * Calculate tax rate in percentage
+ * Calculate tax rate in percentage.
*
* @param array $lineItemId
* An assoc array of lineItem.
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
*
}
/**
- * Fetch object based on array of properties
+ * Fetch object based on array of properties.
*
* @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.
}
/**
- * This function for building custom fields
+ * This function for building custom fields.
*
* @param CRM_Core_Form $qf
* Form object (reference).
}
/**
- * Retrieve a list of options for the specified field
+ * Retrieve a list of options for the specified field.
*
* @param int $fieldId
* Price field ID.
}
/**
- * Validate the priceset
+ * Validate the priceset.
*
* @param int $priceSetId
* , array $fields.
}
/**
- * Get defaults for new entity
+ * Get defaults for new entity.
* @return array
*/
public static function getDefaults() {
}
/**
- * Takes a bunch of params that are needed to match certain criteria and
- * retrieves the relevant objects.
+ * Retrieve DB object based on input parameters.
+ *
+ * It also stores all the retrieved values in the default array.
*
* @param array $params
* (reference ) an assoc array.
}
/**
- * Retrive the all values for given field id
+ * Retrive the all values for given field id.
*
* @param int $fieldId
* Price_field_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.
}
/**
- * 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 $_defaultPriceSet = NULL;
/**
- * Class constructor
+ * Class constructor.
*/
public 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.
}
/**
- * Fetch object based on array of properties
+ * Fetch object based on array of properties.
*
* @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.
}
/**
- * Delete the price set
+ * Delete the price set.
*
* @param int $id
* Price Set id.
}
/**
- * Link the price set with the specified table and id
+ * Link the price set with the specified table and id.
*
* @param string $entityTable
* @param int $entityId
}
/**
- * Delete price set for the given entity and id
+ * Delete price set for the given entity and id.
*
* @param string $entityTable
* @param int $entityId
}
/**
- * Find a price_set_id associated with the given option value or field ID
+ * Find a price_set_id associated with the given option value or field ID.
*
* @param array $params
* (reference) an assoc array of name/value pairs.
}
/**
- * Return an associative array of all price sets
+ * Return an associative array of all price sets.
*
* @param bool $withInactive
* Whether or not to include inactive entries.
}
/**
- * Get price set details
+ * Get price set details.
*
* An array containing price set details (including price fields) is returned
*
}
/**
- * Get field ids of a price set
+ * Get field ids of a price set.
*
* @param int $id
* Price Set id.
}
/**
- * check price set permission
+ * check price set permission.
*
* @param int $sid
* The price set id.
}
/**
- * Check if auto renew option should be shown
+ * Check if auto renew option should be shown.
*
* @param int $priceSetId
* Price set id.
}
/**
- * 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.
}
/**
- * Function to set tax_amount and tax_rate in LineItem
+ * Function to set tax_amount and tax_rate in LineItem.
*
* @param array $field
* @param array $lineItem
class CRM_Price_Form_DeleteField extends CRM_Core_Form {
/**
- * The field id
+ * The field id.
*
* @var int
*/
protected $_fid;
/**
- * The title of the group being deleted
+ * The title of the group being deleted.
*
* @var string
*/
protected $_title;
/**
- * Set up variables to build the form
+ * Set up variables to build the form.
*
* @return void
* @acess protected
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form when submitted
+ * Process the form when submitted.
*
* @return void
*/
class CRM_Price_Form_DeleteSet extends CRM_Core_Form {
/**
- * The set id
+ * The set id.
*
* @var int
*/
protected $_sid;
/**
- * The title of the set being deleted
+ * The title of the set being deleted.
*
* @var string
*/
protected $_title;
/**
- * Set up variables to build the form
+ * Set up variables to build the form.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form when submitted
+ * Process the form when submitted.
*
* @return void
*/
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
*/
protected $_fid;
/**
- * The extended component Id
+ * The extended component Id.
*
* @var array
*/
protected $_extendComponentId;
/**
- * Variable is set if price set is used for membership
+ * Variable is set if price set is used for membership.
*/
protected $_useForMember;
/**
- * Set variables up before form is built
+ * Set variables up before form is built.
*/
public function preProcess() {
}
/**
- * Build the form object
+ * Build the form object.
*/
public function buildQuickForm() {
// lets trim all the whitespace
}
/**
- * Global validation rules for the form
+ * Global validation rules for the form.
*
* @param array $fields
* Posted values of the form.
}
/**
- * Process the form
+ * Process the form.
*/
public function postProcess() {
// store the submitted values in an array
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
*/
protected $_oid;
/**
- * Set variables up before form is built
+ * Set variables up before form is built.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Global validation rules for the form
+ * Global validation rules for the form.
*
* @param array $fields
* Posted values of the form.
}
/**
- * Process the form
+ * Process the form.
*
* @return void
*/
class CRM_Price_Form_Preview extends CRM_Core_Form {
/**
- * The group tree data
+ * The group tree data.
*
* @var array
*/
}
/**
- * Set the default form values
+ * Set the default form values.
*
* @return array
* the default array reference
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
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
*/
protected $_sid;
/**
- * Set variables up before form is built
+ * Set variables up before form is built.
*
* @return void
*/
}
/**
- * Global form rule
+ * Global form rule.
*
* @param array $fields
* The input form values.
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form
+ * Process the form.
*
* @return void
*/
public $useLivePageJS = TRUE;
/**
- * The price set group id of the field
+ * The price set group id of the field.
*
* @var int
*/
protected $_sid;
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
private static $_actionLinks;
/**
- * The price set is reserved or not
+ * The price set is reserved or not.
*
* @var boolean
*/
}
/**
- * Preview price field
+ * Preview price field.
*
* @param int $fid
*
public $useLivePageJS = TRUE;
/**
- * The field id of the option
+ * The field id of the option.
*
* @var int
*/
protected $_fid;
/**
- * The field id of the option
+ * The field id of the option.
*
* @var int
*/
protected $_sid;
/**
- * The price set is reserved or not
+ * The price set is reserved or not.
*
* @var boolean
*/
protected $_isSetReserved = FALSE;
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
class CRM_Price_Page_Set extends CRM_Core_Page {
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
}
/**
- * Edit price set
+ * Edit price set.
*
* @param int $sid
* Price set id.
}
/**
- * Preview price set
+ * Preview price set.
*
* @param int $sid
* Price set id.
}
/**
- * Browse all price sets
+ * Browse all price sets.
*
* @param string $action
* The action to be invoked.
protected $_skipPermission = FALSE;
/**
- * The contact id that we are editing
+ * The contact id that we are editing.
*
* @var int
*/
protected $_id;
/**
- * The group id that we are editing
+ * The group id that we are editing.
*
* @var int
*/
protected $_ufGroup = array('name' => 'unknown');
/**
- * The group id that we are passing in url
+ * The group id that we are passing in url.
*
* @var int
*/
public $_grid;
/**
- * Name of button for saving matching contacts
+ * Name of button for saving matching contacts.
* @var
*/
protected $_duplicateButtonName;
/**
- * The title of the category we are editing
+ * The title of the category we are editing.
*
* @var string
*/
protected $_title;
/**
- * The fields needed to build this form
+ * The fields needed to build this form.
*
* @var array
*/
public $_fields;
/**
- * store contact details
+ * store contact details.
*
* @var array
*/
protected $_contact;
/**
- * Do we allow updates of the contact
+ * Do we allow updates of the contact.
*
* @var int
*/
protected $_context;
/**
- * THe contact type for registration case
+ * THe contact type for registration case.
*
* @var string
*/
protected $_isContactActivityProfile = FALSE;
/**
- * Activity Id connected to the profile
+ * Activity Id connected to the profile.
*
* @var string
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Validate profile and provided activity Id
+ * Validate profile and provided activity Id.
*
* @param int $activityId
* @param int $contactId
}
/**
- * Global form rule
+ * Global form rule.
*
* @param array $fields
* The input form values.
}
/**
- * Use the form name to create the tpl file name
+ * Use the form name to create the tpl file name.
*
* @return string
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Global form rule
+ * Global form rule.
*
* @param array $fields
* The input form values.
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * 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
}
/**
- * Set the default form values
+ * Set the default form values.
*
*
* @return array
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
class CRM_Profile_Page_Dynamic extends CRM_Core_Page {
/**
- * The contact id of the person we are viewing
+ * The contact id of the person we are viewing.
*
* @var int
*/
protected $_id;
/**
- * The profile group are are interested in
+ * The profile group are are interested in.
*
* @var int
*/
protected $_gid;
/**
- * The profile types we restrict this page to display
+ * The profile types we restrict this page to display.
*
* @var string
*/
protected $_restrict;
/**
- * Should we bypass permissions
+ * Should we bypass permissions.
*
* @var boolean
*/
protected $_isContactActivityProfile = FALSE;
/**
- * Activity Id connected to the profile
+ * Activity Id connected to the profile.
*
* @var string
*/
protected $_allFields = NULL;
/**
- * Class constructor
+ * Class constructor.
*
* @param int $id
* The contact id.
}
/**
- * Use the form name to create the tpl file name
+ * Use the form name to create the tpl file name.
*
* @return string
*/
}
/**
- * Get the list of contacts for a profile
+ * Get the list of contacts for a profile.
*
* @param int $gid
*
}
/**
- * Use the form name to create the tpl file name
+ * Use the form name to create the tpl file name.
*
* @return string
*/
class CRM_Profile_Page_MultipleRecordFieldsListing extends CRM_Core_Page_Basic {
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
protected $_contactType = NULL;
/**
- * Get BAO Name
+ * Get BAO Name.
*
* @return string
* Classname of BAO.
}
/**
- * Get action Links
+ * Get action Links.
*
* @return array
* (reference) of action links
}
/**
- * Run the page
+ * Run the page.
*
* This method is called after the page is created. It checks for the type
* of action and executes that action. Finally it calls the parent's run
}
/**
- * Browse the listing
+ * Browse the listing.
*
* @return void
*/
}
/**
- * Get name of edit form
+ * Get name of edit form.
*
* @return string
* classname of edit form
}
/**
- * Get edit form name
+ * Get edit form name.
*
* @return string
* name of this page
}
/**
- * Get user context
+ * Get user context.
*
* @param null $mode
*
class CRM_Profile_Page_View extends CRM_Core_Page {
/**
- * The id of the contact
+ * The id of the contact.
*
* @var int
*/
protected $_id;
/**
- * The group id that we are editing
+ * The group id that we are editing.
*
* @var int
*/
}
/**
- * Use the form name to create the tpl file name
+ * Use the form name to create the tpl file name.
*
* @return string
*/
static $_columnHeaders;
/**
- * The sql params we use to get the list of contacts
+ * The sql params we use to get the list of contacts.
*
* @var string
*/
protected $_params;
/**
- * The public visible fields to be shown to the user
+ * The public visible fields to be shown to the user.
*
* @var array
*/
protected $_fields;
/**
- * The custom fields for this domain
+ * The custom fields for this domain.
*
* @var array
*/
protected $_customFields;
/**
- * Cache the query object
+ * Cache the query object.
*
* @var object
*/
protected $_query;
/**
- * Cache the expanded options list if any
+ * Cache the expanded options list if any.
*
* @var object
*/
protected $_options;
/**
- * The group id that we are editing
+ * The group id that we are editing.
*
* @var int
*/
protected $_gid;
/**
- * Do we enable mapping of users
+ * Do we enable mapping of users.
*
* @var boolean
*/
protected $_map;
/**
- * Do we enable edit link
+ * Do we enable edit link.
*
* @var boolean
*/
protected $_editLink;
/**
- * Should we link to the UF Profile
+ * Should we link to the UF Profile.
*
* @var boolean
*/
protected $_multiRecordTableName = NULL;
/**
- * Class constructor
+ * Class constructor.
*
* @param array $params the params for the where clause
* @param array $customFields
}
/**
- * Return the qill for this selector
+ * Return the qill for this selector.
*
* @return string
*/
}
/**
- * Returns all the rows in the given offset and rowCount
+ * Returns all the rows in the given offset and rowCount.
*
* @param string $action
* The action being performed.
}
/**
- * set the _multiRecordTableName to display the result set
+ * set the _multiRecordTableName to display the result set.
* according to multi record custom field values
*/
public function setMultiRecordTableName($fields) {
class CRM_Queue_BAO_QueueItem extends CRM_Queue_DAO_QueueItem {
/**
- * Ensure that the required SQL table exists
+ * Ensure that the required SQL table exists.
*
* @return bool
* TRUE if table now exists
}
/**
- * Print a fatal error
+ * Print a fatal error.
*
* @param array $error
* The PHP error (with "type", "message", etc).
}
/**
- * Print an unhandled exception
+ * Print an unhandled exception.
*
* @param Exception $e
* The unhandled exception.
class CRM_Queue_Page_AJAX {
/**
- * Run the next task and return status information
+ * Run the next task and return status information.
*
* Outputs JSON: array(
* is_error => bool,
}
/**
- * Run the next task and return status information
+ * Run the next task and return status information.
*
* Outputs JSON: array(
* is_error => bool,
}
/**
- * Run the next task and return status information
+ * Run the next task and return status information.
*
* Outputs JSON: array(
* is_error => bool,
}
/**
- * Determine the string name of this queue
+ * Determine the string name of this queue.
*
* @return string
*/
public abstract function deleteQueue();
/**
- * Check if the queue exists
+ * Check if the queue exists.
*
* @return bool
*/
public abstract function existsQueue();
/**
- * Add a new item to the queue
+ * Add a new item to the queue.
*
* @param mixed $data
* Serializable PHP object or array.
public abstract function createItem($data, $options = array());
/**
- * Determine number of items remaining in the queue
+ * Determine number of items remaining in the queue.
*
* @return int
*/
public abstract function numberOfItems();
/**
- * Get the next item
+ * Get the next item.
*
* @param int $lease_time
* Seconds.
public abstract function stealItem($lease_time = 3600);
/**
- * Remove an item from the queue
+ * Remove an item from the queue.
*
* @param object $item
* The item returned by claimItem.
public abstract function deleteItem($item);
/**
- * Return an item that could not be processed
+ * Return an item that could not be processed.
*
* @param object $item
* The item returned by claimItem.
}
/**
- * Check if the queue exists
+ * Check if the queue exists.
*
* @return bool
*/
}
/**
- * Add a new item to the queue
+ * Add a new item to the queue.
*
* @param mixed $data
* Serializable PHP object or array.
}
/**
- * Determine number of items remaining in the queue
+ * Determine number of items remaining in the queue.
*
* @return int
*/
}
/**
- * Get and remove the next item
+ * Get and remove the next item.
*
* @param int $leaseTime
* Seconds.
}
/**
- * Get the next item
+ * Get the next item.
*
* @param int $leaseTime
* Seconds.
}
/**
- * Remove an item from the queue
+ * Remove an item from the queue.
*
* @param object $item
* The item returned by claimItem.
}
/**
- * Return an item that could not be processed
+ * Return an item that could not be processed.
*
* @param CRM_Core_DAO $item
* The item returned by claimItem.
}
/**
- * Check if the queue exists
+ * Check if the queue exists.
*
* @return bool
*/
}
/**
- * Add a new item to the queue
+ * Add a new item to the queue.
*
* @param mixed $data
* Serializable PHP object or array.
}
/**
- * Determine number of items remaining in the queue
+ * Determine number of items remaining in the queue.
*
* @return int
*/
}
/**
- * Get the next item
+ * Get the next item.
*
* @param int $lease_time
* Seconds.
}
/**
- * Remove an item from the queue
+ * Remove an item from the queue.
*
* @param CRM_Core_DAO $dao
* The item returned by claimItem.
}
/**
- * Return an item that could not be processed
+ * Return an item that could not be processed.
*
* @param CRM_Core_DAO $dao
* The item returned by claimItem.
}
/**
- * Convert a queue "type" name to a class name
+ * Convert a queue "type" name to a class name.
*
* @param string $type
* E.g. "interactive", "immediate", "stomp", "beanstalk".
class CRM_Queue_Task {
/**
- * Task was performed successfully
+ * Task was performed successfully.
*/
const TASK_SUCCESS = 1;
/**
- * Task failed and should not be retried
+ * Task failed and should not be retried.
*/
const TASK_FAIL = 2;
}
/**
- * Perform the task
+ * Perform the task.
*
* @param array $taskCtx
* Array with keys:
protected $_queryObjects = NULL;
/**
- * Singleton function used to manage this object
+ * Singleton function used to manage this object.
*
* @return object
*/
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
+ * Delete the instance of the Report.
*
* @param int $id
*
}
/**
- * Use the form name to create the tpl file name
+ * Use the form name to create the tpl file name.
*
* @return string
*/
}
/**
- * Compile the report content
+ * Compile the report content.
* Although this function is super-short it is useful to keep separate so it can be over-ridden by report classes.
*
* @return string
}
/**
- * Generate Membership Type SQL Clause
+ * Generate Membership Type SQL Clause.
* @param mixed $value
* @param string $op
*
}
/**
- * Fetch array of DAO tables having columns included in SELECT or ORDER BY clause
+ * Fetch array of DAO tables having columns included in SELECT or ORDER BY clause.
* (building the array if it's unset)
*
* @return array
}
/**
- * Do AlterDisplay processing on Address Fields
+ * Do AlterDisplay processing on Address Fields.
*
* @param $row
* @param $rows
}
/**
- * Add Address into From Table if required
+ * Add Address into From Table if required.
*/
public function addAddressFromClause() {
// include address field if address column is to be included
}
/**
- * Add Phone into From Table if required
+ * Add Phone into From Table if required.
*/
public function addPhoneFromClause() {
// include address field if address column is to be included
}
/**
- * Get phone columns to add to array
+ * Get phone columns to add to array.
*
* @param array $options
* - prefix Prefix to add to table (in case of more than one instance of the table)
}
/**
- * Get address columns to add to array
+ * Get address columns to add to array.
*
* @param array $options
* - prefix Prefix to add to table (in case of more than one instance of the table)
}
/**
- * function used for showing charts on print screen
+ * function used for showing charts on print screen.
*/
public static function uploadChartImage() {
// upload strictly for '.png' images
}
/**
- * Apply common settings to entityRef fields
+ * Apply common settings to entityRef fields.
*
* @param array $field
* @param string $table
}
/**
- * Set variables to be accessed by API and form layer in processing
+ * Set variables to be accessed by API and form layer in processing.
*/
public function beginPostProcessCommon() {
$getRelationship = $this->_params['relationship_type_id_value'];
}
/**
- * Set variables to be accessed by API and form layer in processing
+ * Set variables to be accessed by API and form layer in processing.
*/
public function beginPostProcessCommon() {
$getRelationship = $this->_params['relationship_type_id_value'];
}
/**
- * Add The statistics
+ * Add The statistics.
* @param $rows
*
* @return array
}
/**
- * get participants information for events
+ * get participants information for events.
* @return array
*/
public function participantInfo() {
}
/**
- * Get address columns to add to array
+ * Get address columns to add to array.
*
* @param array $options
* Options for the report.
}
/**
- * Get Information about advertised Joins
+ * Get Information about advertised Joins.
*
* @return array
*/
}
/**
- * Define join from line item table to participant table
+ * Define join from line item table to participant table.
*/
public function joinParticipantFromLineItem() {
$this->_from .= " LEFT JOIN civicrm_participant {$this->_aliases['civicrm_participant']}
}
/**
- * Define join from Participant to Contribution table
+ * Define join from Participant to Contribution table.
*/
public function joinContributionFromParticipant() {
$this->_from .= " LEFT JOIN civicrm_participant_payment pp
}
/**
- * Define join from Membership to Contribution table
+ * Define join from Membership to Contribution table.
*/
public function joinContributionFromMembership() {
$this->_from .= " LEFT JOIN civicrm_membership_payment pp
}
/**
- * Retrieve text for financial type from pseudoconstant
+ * Retrieve text for financial type from pseudoconstant.
*
* @param $value
* @param array $row
}
/**
- * Retrieve text for contribution type from pseudoconstant
+ * Retrieve text for contribution type from pseudoconstant.
*
* @param $value
* @param array $row
}
/**
- * Retrieve text for contribution status from pseudoconstant
+ * Retrieve text for contribution status from pseudoconstant.
*
* @param $value
* @param array $row
}
/**
- * Retrieve text for payment instrument from pseudoconstant
+ * Retrieve text for payment instrument from pseudoconstant.
*
* @param $value
* @param array $row
}
/**
- * manipulate the select function to query count functions
+ * manipulate the select function to query count functions.
*/
public function select() {
}
/**
- * If we are retrieving total paid we need to define the inclusion of pledge_payment
+ * If we are retrieving total paid we need to define the inclusion of pledge_payment.
*
* @param string $tableName
* @param $tableKey
}
/**
- * This virtual function is used to set the default values of
+ * This virtual function is used to set the default values of.
* various form elements
*
* access public
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
}
/**
- * add shortcut to Create New
+ * add shortcut to Create New.
* @param $shortCuts
*/
public function creatNewShortcut(&$shortCuts) {
interface CRM_Report_Interface {
/**
- * The constructor gets the submitted form values
+ * The constructor gets the submitted form values.
*
* @param $formValues
*/
public function __construct(&$formValues);
/**
- * Builds the quickform for this search
+ * Builds the quickform for this search.
* @param $form
*/
public function buildForm(&$form);
*/
/**
- * The from clause for the query
+ * The from clause for the query.
*/
public function from();
/**
- * The where clause for the query
+ * The where clause for the query.
*/
public function where($includeContactIDs = FALSE);
/**
- * The template FileName to use to display the results
+ * The template FileName to use to display the results.
*/
public function templateFile();
/**
- * Returns an array of column headers and field names and sort options
+ * Returns an array of column headers and field names and sort options.
*/
public function &columns();
static $_exceptions = array('logging/contact/detail');
/**
- * Name of component if report list is filtered
+ * Name of component if report list is filtered.
*
* @var string
*/
protected $_compName = NULL;
/**
- * ID of component if report list is filtered
+ * ID of component if report list is filtered.
*
* @var int
*/
protected $_compID = NULL;
/**
- * ID of grouping if report list is filtered
+ * ID of grouping if report list is filtered.
*
* @var int
*/
protected $_grouping = NULL;
/**
- * ID of parent report template if list is filtered by template
+ * ID of parent report template if list is filtered by template.
*
* @var int
*/
protected $_ovID = NULL;
/**
- * Title of parent report template if list is filtered by template
+ * Title of parent report template if list is filtered by template.
*
* @var string
*/
public $useLivePageJS = TRUE;
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
static $_links = NULL;
/**
- * The option group name
+ * The option group name.
*
* @var array
*/
static $_GName = NULL;
/**
- * The option group id
+ * The option group id.
*
* @var array
*/
}
/**
- * Get BAO Name
+ * Get BAO Name.
*
* @return string
* Classname of BAO.
}
/**
- * Get action Links
+ * Get action Links.
*
* @return array
* (reference) of action links
}
/**
- * Browse all options
+ * Browse all options.
*
*
* @return void
}
/**
- * Get name of edit form
+ * Get name of edit form.
*
* @return string
* Classname of edit form.
}
/**
- * Get edit form name
+ * Get edit form name.
*
* @return string
* name of this page.
}
/**
- * Get userContext params
+ * Get userContext params.
*
* @param int $mode
* Mode that we are in.
}
/**
- * unset default filters
+ * unset default filters.
* @param $defaults
*/
public static function unsetFilters(&$defaults) {
}
/**
- * get instance count for a template
+ * get instance count for a template.
* @param $optionVal
*
* @return int|null|string
class CRM_SMS_BAO_Provider extends CRM_SMS_DAO_Provider {
/**
- * Class constructor
+ * Class constructor.
*
* @return \CRM_SMS_DAO_Provider
*/
}
/**
- * Retrieves the list of providers from the database
+ * Retrieves the list of providers from the database.
*
* $selectArr array of coloumns to fetch
* $getActive boolean to get active providers
class CRM_SMS_Controller_Send extends CRM_Core_Controller {
/**
- * Class constructor
+ * Class constructor.
*
* @param string $title
* @param bool|int $action
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Display Name of the form
+ * Display Name of the form.
*
*
* @return string
}
/**
- * 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
*/
}
/**
- * Build the form object for the last step of the sms wizard
+ * Build the form object for the last step of the sms wizard.
*
* @param
*
}
/**
- * Display Name of the form
+ * Display Name of the form.
*
*
* @return string
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Validation
+ * Validation.
*
* @param array $params
* (ref.) an assoc array of name/value pairs.
}
/**
- * Display Name of the form
+ * Display Name of the form.
*
*
* @return string
public $useLivePageJS = TRUE;
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
static $_links = NULL;
/**
- * Get BAO Name
+ * Get BAO Name.
*
* @return string
* Classname of BAO.
}
/**
- * Get action Links
+ * Get action Links.
*
* @return array
* (reference) of action links
}
/**
- * Get name of edit form
+ * Get name of edit form.
*
* @return string
* Classname of edit form.
}
/**
- * Get edit form name
+ * Get edit form name.
*
* @return string
* name of this page.
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
}
/**
- * Send an SMS Message via the API Server
+ * Send an SMS Message via the API Server.
*/
abstract public function send($recipients, $header, $message, $dncID = NULL);
class CRM_SMS_StateMachine_Send extends CRM_Core_StateMachine {
/**
- * Class constructor
+ * Class constructor.
*
* @param object $controller
* @param \const|int $action
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
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
*/
}
/**
- * Set the default form values
+ * Set the default form values.
*
*
* @return array
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Use the form name to create the tpl file name
+ * Use the form name to create the tpl file name.
*
* @return string
*/
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
*/
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
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form
+ * Process the form.
*
* @return void
*/
}
/**
- * 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
*/
protected $_id;
/**
- * The title for group
+ * The title for group.
*
* @var int
*/
protected $_allPanes;
/**
- * Set variables up before form is built
+ * Set variables up before form is built.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Global form rule
+ * Global form rule.
*
* @param array $fields
* The input form values.
}
/**
- * Process the form
+ * Process the form.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
class CRM_UF_Page_AJAX {
/**
- * Function the check whether the field belongs
+ * Function the check whether the field belongs.
* to multi-record custom set
*/
public function checkIsMultiRecord() {
public $useLivePageJS = TRUE;
/**
- * The group id of the field
+ * The group id of the field.
*
* @var int
*/
protected $_gid;
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
}
/**
- * Preview custom field
+ * Preview custom field.
*
* @param int $fieldId
* Custom field id.
class CRM_UF_Page_Group extends CRM_Core_Page {
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
}
/**
- * Edit uf group
+ * Edit uf group.
*
* @param int $id
* Uf group id.
}
/**
- * for preview mode for ufoup
+ * for preview mode for ufoup.
*
* @param int $id
* Uf group id.
}
/**
- * AJAX callback
+ * AJAX callback.
*/
public static function getSchemaJSON() {
$entityTypes = explode(',', $_REQUEST['entityTypes']);
class CRM_Upgrade_Controller extends CRM_Core_Controller {
/**
- * Class constructor
+ * Class constructor.
*
* @param null $title
* @param bool|int $action
protected $_config;
/**
- * Upgrade for multilingual
+ * Upgrade for multilingual.
*
* @var boolean
*/
public $multilingual = FALSE;
/**
- * Locales available for multilingual upgrade
+ * Locales available for multilingual upgrade.
*
* @var array
*/
public $locales;
/**
- * Number to string mapper
+ * Number to string mapper.
*
* @var array
*/
);
/**
- * Constructor for the basic form page
+ * Constructor for the basic form page.
*
* We should not use QuickForm directly. This class provides a lot
* of default convenient functions, rules and buttons
}
/**
- * Use the form name to create the tpl file name
+ * Use the form name to create the tpl file name.
*
* @return string
*/
}
/**
- * Determine the start and end version of the upgrade process
+ * Determine the start and end version of the upgrade process.
*
* @return array(0=>$currentVer, 1=>$latestVer)
*/
}
/**
- * Fill the queue with upgrade tasks
+ * Fill the queue with upgrade tasks.
*
* @param string $currentVer
* the original revision.
}
/**
- * Perform an incremental version update
+ * Perform an incremental version update.
*
* @param CRM_Queue_TaskContext $ctx
* @param string $rev
}
/**
- * Perform an incremental version update
+ * Perform an incremental version update.
*
* @param CRM_Queue_TaskContext $ctx
* @param string $rev
}
/**
- * Perform an incremental version update
+ * Perform an incremental version update.
*
* @param CRM_Queue_TaskContext $ctx
* @param string $rev
class CRM_Upgrade_Incremental_Legacy {
/**
- * Compute any messages which should be displayed before upgrade
+ * Compute any messages which should be displayed before upgrade.
*
* @param string $preUpgradeMessage
* alterable.
}
/**
- * Compute any messages which should be displayed after upgrade
+ * Compute any messages which should be displayed after upgrade.
*
* @param string $postUpgradeMessage
* alterable.
}
/**
- * Perform an incremental upgrade
+ * Perform an incremental upgrade.
*
* @param string $rev
* the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
}
/**
- * Perform an incremental upgrade
+ * Perform an incremental upgrade.
*
* @param string $rev
* the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
}
/**
- * This function should check if if need to skip current sql file
+ * This function should check if if need to skip current sql file.
* Name of this function will change according to the latest release
*/
public static function upgrade_2_2_alpha3($rev) {
}
/**
- * Perform an incremental upgrade
+ * Perform an incremental upgrade.
*
* @param string $rev
* the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
}
/**
- * Perform an incremental upgrade
+ * Perform an incremental upgrade.
*
* @param string $rev
* the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
}
/**
- * Perform an incremental upgrade
+ * Perform an incremental upgrade.
*
* @param string $rev
* the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
}
/**
- * Perform an incremental upgrade
+ * Perform an incremental upgrade.
*
* @param string $rev
* the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
}
/**
- * Perform an incremental upgrade
+ * Perform an incremental upgrade.
*
* @param string $rev
* the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
}
/**
- * Perform an incremental upgrade
+ * Perform an incremental upgrade.
*
* @param string $rev
* the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
}
/**
- * Perform an incremental upgrade
+ * Perform an incremental upgrade.
*
* @param string $rev
* the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
}
/**
- * Perform an incremental upgrade
+ * Perform an incremental upgrade.
*
* @param string $rev
* the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
}
/**
- * Perform an incremental upgrade
+ * Perform an incremental upgrade.
*
* @param string $rev
* the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
}
/**
- * Perform an incremental upgrade
+ * Perform an incremental upgrade.
*
* @param string $rev
* the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
}
/**
- * Perform an incremental upgrade
+ * Perform an incremental upgrade.
*
* @param string $rev
* the revision to which we are upgrading (Note: When processing a series of upgrades, this is the immediate upgrade - not the final).
}
/**
- * Compute any messages which should be displayed beforeupgrade
+ * Compute any messages which should be displayed beforeupgrade.
*
* Note: This function is called iteratively for each upcoming
* revision to the database.
}
/**
- * Compute any messages which should be displayed after upgrade
+ * Compute any messages which should be displayed after upgrade.
*
* @param string $postUpgradeMessage
* alterable.
}
/**
- * Compute any messages which should be displayed beforeupgrade
+ * Compute any messages which should be displayed beforeupgrade.
*
* Note: This function is called iteratively for each upcoming
* revision to the database.
}
/**
- * Compute any messages which should be displayed after upgrade
+ * Compute any messages which should be displayed after upgrade.
*
* @param string $postUpgradeMessage
* alterable.
}
/**
- * Compute any messages which should be displayed after upgrade
+ * Compute any messages which should be displayed after upgrade.
*
* @param string $postUpgradeMessage
* alterable.
}
/**
- * Compute any messages which should be displayed after upgrade
+ * Compute any messages which should be displayed after upgrade.
*
* @param string $postUpgradeMessage
* alterable.
}
/**
- * Compute any messages which should be displayed beforeupgrade
+ * Compute any messages which should be displayed beforeupgrade.
*
* Note: This function is called iteratively for each upcoming
* revision to the database.
}
/**
- * Compute any messages which should be displayed after upgrade
+ * Compute any messages which should be displayed after upgrade.
*
* @param string $postUpgradeMessage
* alterable.
}
/**
- * Change index and add missing constraints for civicrm_contribution_recur
+ * Change index and add missing constraints for civicrm_contribution_recur.
*/
public function addMissingConstraints(CRM_Queue_TaskContext $ctx) {
$query = "SHOW KEYS FROM `civicrm_contribution_recur` WHERE key_name = 'UI_contrib_payment_instrument_id'";
}
/**
- * Update financial_account_id for bad data in financial_trxn table
+ * Update financial_account_id for bad data in financial_trxn table.
* CRM-12844
*/
public function updateFinancialTrxnData(CRM_Queue_TaskContext $ctx) {
}
/**
- * Update financial_account_id for bad data in financial_trxn table
+ * Update financial_account_id for bad data in financial_trxn table.
* CRM-12844
*/
public function updateLineItemData(CRM_Queue_TaskContext $ctx) {
}
/**
- * Replace contribution_type to financial_type in table
+ * Replace contribution_type to financial_type in table.
* civicrm_saved_search and Structure civicrm_report_instance
*/
public function replaceContributionTypeId(CRM_Queue_TaskContext $ctx, $query, $table) {
}
/**
- * Add ON DELETE options for constraint if not present
+ * Add ON DELETE options for constraint if not present.
* CRM-13088 && CRM-12156
*
* @param CRM_Queue_TaskContext $ctx
}
/**
- * Compute any messages which should be displayed beforeupgrade
+ * Compute any messages which should be displayed beforeupgrade.
*
* Note: This function is called iteratively for each upcoming
* revision to the database.
}
/**
- * Compute any messages which should be displayed after upgrade
+ * Compute any messages which should be displayed after upgrade.
*
* @param string $postUpgradeMessage
* alterable.
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
*
}
/**
- * Fetch object based on array of properties
+ * Fetch object based on array of properties.
*
* @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.
}
/**
- * This function for building custom fields
+ * This function for building custom fields.
*
* @param CRM_Core_Form $qf
* Form object (reference).
}
/**
- * Retrieve a list of options for the specified field
+ * Retrieve a list of options for the specified field.
*
* @param int $fieldId
* Price field ID.
}
/**
- * Validate the priceset
+ * Validate the priceset.
*
* @param int $priceSetId
* @param array $fields
}
/**
- * Takes a bunch of params that are needed to match certain criteria and
- * retrieves the relevant objects.
+ * Retrieve DB object based on input parameters.
+ *
+ * It also stores all the retrieved values in the default array.
*
* @param array $params
* (reference ) an assoc array.
}
/**
- * Retrive the all values for given field id
+ * Retrive the all values for given field id.
*
* @param int $fieldId
* Price_field_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.
}
/**
- * Delete all values of the given field id
+ * Delete all values of the given field id.
*
* @param int $fieldId
* Price field id.
}
/**
- * Takes a bunch of params that are needed to match certain criteria and
- * retrieves the relevant objects. Typically, the valid params are only
- * price_field_id. This is the inverse function of create. It also
- * stores all of the retrieved values in the default array.
+ * Retrieve DB object based on input parameters.
+ *
+ * It also stores all the retrieved values in the default array.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
}
/**
- * This method will create the lineItem array required for
+ * This method will create the lineItem array required for.
* processAmount method
*
* @param int $fid
class CRM_Upgrade_Snapshot_V4p2_Price_BAO_Set extends CRM_Upgrade_Snapshot_V4p2_Price_DAO_Set {
/**
- * Class constructor
+ * Class constructor.
*/
public 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.
}
/**
- * Fetch object based on array of properties
+ * Fetch object based on array of properties.
*
* @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.
}
/**
- * Calculate the default price set id
+ * Calculate the default price set id.
* assigned to the contribution/membership etc
*
* @param string $entity
}
/**
- * Delete the price set
+ * Delete the price set.
*
* @param int $id
* Price Set id.
}
/**
- * Link the price set with the specified table and id
+ * Link the price set with the specified table and id.
*
* @param string $entityTable
* @param int $entityId
}
/**
- * Delete price set for the given entity and id
+ * Delete price set for the given entity and id.
*
* @param string $entityTable
* @param int $entityId
}
/**
- * Find a price_set_id associatied with the given option value or field ID
+ * Find a price_set_id associatied with the given option value or field ID.
*
* @param array $params
* (reference) an assoc array of name/value pairs.
}
/**
- * Return an associative array of all price sets
+ * Return an associative array of all price sets.
*
* @param bool $withInactive
* Whether or not to include inactive entries.
}
/**
- * Get price set details
+ * Get price set details.
*
* An array containing price set details (including price fields) is returned
*
}
/**
- * Get field ids of a price set
+ * Get field ids of a price set.
*
* @param int $id Price Set id
*
}
/**
- * check price set permission
+ * check price set permission.
*
* @param int $sid
* The price set id.
}
/**
- * Get the sum of participant count
+ * Get the sum of participant count.
* for all fields of given price set.
*
* @param int $sid
}
/**
- * Function to check if auto renew option should be shown
+ * Function to check if auto renew option should be shown.
*
* @param int $priceSetId
* Price set id.
}
/**
- * 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.
public $visibility_id;
/**
- * Class constructor
+ * Class constructor.
*
* @return \CRM_Upgrade_Snapshot_V4p2_Price_DAO_Field
*/
}
/**
- * return foreign links
+ * Return foreign links.
*
* @return array
*/
}
/**
- * returns all the column names of this table
+ * Returns all the column names of this table.
*
* @return array
*/
}
/**
- * returns the names of this table
+ * returns the names of this table.
*
* @return string
*/
}
/**
- * returns if this table needs to be logged
+ * returns if this table needs to be logged.
*
* @return boolean
*/
}
/**
- * returns the list of fields that can be imported
+ * returns the list of fields that can be imported.
*
* @return array
*/
}
/**
- * returns the list of fields that can be exported
+ * returns the list of fields that can be exported.
*
* @return array
*/
}
/**
- * returns an array containing the enum fields of the civicrm_price_field table
+ * returns an array containing the enum fields of the civicrm_price_field table.
*
* @return array
* (reference) the array of enum fields
public $is_active;
/**
- * Class constructor
+ * Class constructor.
*
* @return \CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue
*/
}
/**
- * return foreign links
+ * Return foreign links.
*
* @return array
*/
}
/**
- * returns all the column names of this table
+ * Returns all the column names of this table.
*
* @return array
*/
}
/**
- * returns the names of this table
+ * returns the names of this table.
*
* @return string
*/
}
/**
- * returns if this table needs to be logged
+ * returns if this table needs to be logged.
*
* @return boolean
*/
}
/**
- * returns the list of fields that can be imported
+ * returns the list of fields that can be imported.
*
* @return array
*/
}
/**
- * returns the list of fields that can be exported
+ * returns the list of fields that can be exported.
*
* @return array
*/
public $price_field_value_id;
/**
- * Class constructor
+ * Class constructor.
*
* @return \CRM_Upgrade_Snapshot_V4p2_Price_DAO_LineItem
*/
}
/**
- * return foreign links
+ * Return foreign links.
*
* @return array
*/
}
/**
- * returns all the column names of this table
+ * Returns all the column names of this table.
*
* @return array
*/
}
/**
- * returns the names of this table
+ * returns the names of this table.
*
* @return string
*/
}
/**
- * returns if this table needs to be logged
+ * returns if this table needs to be logged.
*
* @return boolean
*/
}
/**
- * returns the list of fields that can be imported
+ * returns the list of fields that can be imported.
*
* @return array
*/
}
/**
- * returns the list of fields that can be exported
+ * returns the list of fields that can be exported.
*
* @return array
*/
public $is_reserved;
/**
- * Class constructor
+ * Class constructor.
*
* @return \CRM_Upgrade_Snapshot_V4p2_Price_DAO_Set
*/
}
/**
- * return foreign links
+ * Return foreign links.
*
* @return array
*/
}
/**
- * returns all the column names of this table
+ * Returns all the column names of this table.
*
* @return array
*/
}
/**
- * returns the names of this table
+ * returns the names of this table.
*
* @return string
*/
}
/**
- * returns if this table needs to be logged
+ * returns if this table needs to be logged.
*
* @return boolean
*/
}
/**
- * returns the list of fields that can be imported
+ * returns the list of fields that can be imported.
*
* @return array
*/
}
/**
- * returns the list of fields that can be exported
+ * returns the list of fields that can be exported.
*
* @return array
*/
public $price_set_id;
/**
- * Class constructor
+ * Class constructor.
*
* @return \CRM_Upgrade_Snapshot_V4p2_Price_DAO_SetEntity
*/
}
/**
- * return foreign links
+ * Return foreign links.
*
* @return array
*/
}
/**
- * returns all the column names of this table
+ * Returns all the column names of this table.
*
* @return array
*/
}
/**
- * returns the names of this table
+ * returns the names of this table.
*
* @return string
*/
}
/**
- * returns if this table needs to be logged
+ * returns if this table needs to be logged.
*
* @return boolean
*/
}
/**
- * returns the list of fields that can be imported
+ * returns the list of fields that can be imported.
*
* @return array
*/
}
/**
- * returns the list of fields that can be exported
+ * returns the list of fields that can be exported.
*
* @return array
*/
class CRM_Upgrade_StateMachine extends CRM_Core_StateMachine {
/**
- * Class constructor
+ * Class constructor.
*
* @param object $controller
* @param const $pages
}
/**
- * Identify the fields which should be returned
+ * Identify the fields which should be returned.
*
* @param $apiRequest
* @return array
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.
}
/**
- * convert associative array names to values
+ * convert associative array names to values.
* and vice-versa.
*
* This function is used by both the web form layer and the api. Note that
}
/**
- * Get the first element of an array
+ * Get the first element of an array.
*
* @param array $array
* @return mixed|NULL
static private $_singleton = NULL;
/**
- * Constructor
+ * Constructor.
*
* @param array $config
* An array of configuration params.
}
/**
- * Singleton function used to manage this object
+ * Singleton function used to manage this object.
*
* @return object
*/
}
/**
- * Get cache relevant settings
+ * Get cache relevant settings.
*
* @param $cachePlugin
*
const DEFAULT_PREFIX = '';
/**
- * The default timeout to use
+ * The default timeout to use.
*
* @var int
*/
protected $_prefix = self::DEFAULT_PREFIX;
/**
- * Constructor
+ * Constructor.
*
* @param array $config
* An array of configuration params.
private $_cache;
/**
- * Constructor
+ * Constructor.
*
* @param array $config
* An array of configuration params.
interface CRM_Utils_Cache_Interface {
/**
- * Set the value in the cache
+ * Set the value in the cache.
*
* @param string $key
* @param mixed $value
public function set($key, &$value);
/**
- * Get a value from the cache
+ * Get a value from the cache.
*
* @param string $key
* @return mixed
public function get($key);
/**
- * Delete a value from the cache
+ * Delete a value from the cache.
*
* @param string $key
* @return void
public function delete($key);
/**
- * Delete all values from the cache
+ * Delete all values from the cache.
*
* @return void
*/
const DEFAULT_PREFIX = '';
/**
- * The host name of the memcached server
+ * The host name of the memcached server.
*
* @var string
*/
protected $_host = self::DEFAULT_HOST;
/**
- * The port on which to connect on
+ * The port on which to connect on.
*
* @var int
*/
protected $_port = self::DEFAULT_PORT;
/**
- * The default timeout to use
+ * The default timeout to use.
*
* @var int
*/
protected $_prefix = self::DEFAULT_PREFIX;
/**
- * The actual memcache object
+ * The actual memcache object.
*
* @var resource
*/
protected $_cache;
/**
- * Constructor
+ * Constructor.
*
* @param array $config
* An array of configuration params.
protected $_prefix = self::DEFAULT_PREFIX;
/**
- * The actual memcache object
+ * The actual memcache object.
*
* @var resource
*/
protected $_cache;
/**
- * Constructor
+ * Constructor.
*
* @param array $config
* An array of configuration params.
static private $_singleton = NULL;
/**
- * Constructor
+ * Constructor.
*
* @param array $config
* An array of configuration params.
private $_cache;
/**
- * Constructor
+ * Constructor.
*
* @param array $config
* An array of configuration params.
class CRM_Utils_Cache_SqlGroup implements CRM_Utils_Cache_Interface {
/**
- * The host name of the memcached server
+ * The host name of the memcached server.
*
* @var string
*/
protected $frontCache;
/**
- * Constructor
+ * Constructor.
*
* @param array $config
* An array of configuration params.
}
/**
- * Execute "checkAll"
+ * Execute "checkAll".
*
* @param array|NULL $messages list of CRM_Utils_Check_Message; or NULL if the default list should be fetched
*/
}
/**
- * Throw an exception if any of the checks fail
+ * Throw an exception if any of the checks fail.
*
* @param array|NULL $messages list of CRM_Utils_Check_Message; or NULL if the default list should be fetched
*
}
/**
- * 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')
}
/**
- * 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,
}
/**
- * 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.
}
/**
- * 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.
}
/**
- * 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.
}
/**
- * Function to convert mysql to date plugin format
+ * Function to convert mysql to date plugin format.
*
* @param string $mysqlDate
* Date string.
}
/**
- * Function get date format
+ * Function get date format.
*
* @param string $formatType
* Date name e.g. birth.
}
/**
- * Determine whether a given file is listed in the PHP include path
+ * Determine whether a given file is listed in the PHP include path.
*
* @param string $name
* Name of file.
}
/**
- * Make a file path relative to some base dir
+ * Make a file path relative to some base dir.
*
* @param $directory
* @param $basePath
}
/**
- * Create a path to a temporary file which can endure for multiple requests
+ * Create a path to a temporary file which can endure for multiple requests.
*
* TODO: Automatic file cleanup using, eg, TTL policy
*
}
/**
- * Create a path to a temporary directory which can endure for multiple requests
+ * Create a path to a temporary directory which can endure for multiple requests.
*
* TODO: Automatic file cleanup using, eg, TTL policy
*
static protected $_server = 'maps.googleapis.com';
/**
- * Uri of service
+ * Uri of service.
*
* @var string
*/
static protected $_server = 'query.yahooapis.com';
/**
- * Uri of service
+ * Uri of service.
*
* @var string
*/
private $backups = array();
/**
- * Get or set the single instance of CRM_Utils_GlobalStack
+ * Get or set the single instance of CRM_Utils_GlobalStack.
*
* @return CRM_Utils_GlobalStack
*/
private $commonCiviModules = array();
/**
- * Constructor and getter for the singleton instance
+ * Constructor and getter for the singleton instance.
*
* @param bool $fresh
*
}
/**
- * Invoke hooks
+ * Invoke hooks.
*
* @param int $numParams
* Number of parameters to pass to the hook.
}
/**
- * This hook retrieves links from other modules and injects it into
+ * This hook retrieves links from other modules and injects it into.
* the view contact tabs
*
* @param string $op
}
/**
- * This hook is called before a db write on a custom table
+ * This hook is called before a db write on a custom table.
*
* @param string $op
* The type of operation being performed.
}
/**
- * This hook is called when building the menu table
+ * This hook is called when building the menu table.
*
* @param array $files
* The current set of files to process.
}
/**
- * Determine how many other records refer to a given record
+ * Determine how many other records refer to a given record.
*
* @param CRM_Core_DAO $dao
* The item for which we want a reference count.
}
/**
- * This hook is called when building the amount structure for a Contribution or Event Page
+ * This hook is called when building the amount structure for a Contribution or Event Page.
*
* @param int $pageType
* Is this a contribution or event page.
}
/**
- * This hook is called when rendering the contact summary
+ * This hook is called when rendering the contact summary.
*
* @param int $contactID
* The contactID for whom the summary is being rendered
}
/**
- * This hook is called when membership status is being calculated
+ * This hook is called when membership status is being calculated.
*
* @param array $membershipStatus
* Membership status details as determined - alter if required.
}
/**
- * This hook is called when rendering the Manage Case screen
+ * This hook is called when rendering the Manage Case screen.
*
* @param int $caseID
* The case ID.
}
/**
- * This hooks allows to change option values
+ * This hooks allows to change option values.
*
* @param array $options
* Associated array of option values / id
}
/**
- * This hook is called before record is exported as CSV
+ * This hook is called before record is exported as CSV.
*
* @param string $exportTempTable
* Name of the temporary export table used during export.
}
/**
- * Hook definition for altering the generation of Mailing Labels
+ * Hook definition for altering the generation of Mailing Labels.
*
* @param array $args
* An array of the args in the order defined for the tcpdf multiCell api call.
}
/**
- * This hooks allows alteration of generated page content
+ * This hooks allows alteration of generated page content.
*
* @param $content
* Previously generated content.
}
/**
- * This hook collects the trigger definition from all components
+ * This hook collects the trigger definition from all components.
*
* @param $info
* @param string $tableName
}
/**
- * This hook is called when Settings specifications are loaded
+ * This hook is called when Settings specifications are loaded.
*
* @param array $settingsFolders
* List of paths from which to derive metadata
}
/**
- * This hook is called for declaring managed entities via API
+ * This hook is called for declaring managed entities via API.
*
* @param array[] $entityTypes
* List of entity types; each entity-type is an array with keys:
}
/**
- * This hook is called while preparing a profile form
+ * This hook is called while preparing a profile form.
*
* @param string $name
* @return mixed
}
/**
- * This hook is called while validating a profile form submission
+ * This hook is called while validating a profile form submission.
*
* @param string $name
* @return mixed
}
/**
- * This hook is called processing a valid profile form submission
+ * This hook is called processing a valid profile form submission.
*
* @param string $name
* @return mixed
/**
- * This hook is called before encoding data in barcode
+ * This hook is called before encoding data in barcode.
*
* @param array $data
* Associated array of values available for encoding.
}
/**
- * This hook is called while viewing contact dashboard
+ * This hook is called while viewing contact dashboard.
*
* @param array $availableDashlets
* List of dashlets; each is formatted per api/v3/Dashboard
}
/**
- * Generate a default CRUD URL for an entity
+ * Generate a default CRUD URL for an entity.
*
* @param array $spec
* With keys:.
*/
class CRM_Utils_Hook_Joomla extends CRM_Utils_Hook {
/**
- * Invoke hooks
+ * Invoke hooks.
*
* @param int $numParams
* Number of parameters to pass to the hook.
*/
class CRM_Utils_Hook_Soap extends CRM_Utils_Hook {
/**
- * Invoke hooks
+ * Invoke hooks.
*
* @param int $numParams
* Number of parameters to pass to the hook.
}
/**
- * Register a piece of code to run when invoking a hook
+ * Register a piece of code to run when invoking a hook.
* @param string $hook
* Hook name, e.g civicrm_pre.
* @param array $callable
}
/**
- * Invoke hooks
+ * Invoke hooks.
*
* @param int $numParams
* Number of parameters to pass to the hook.
);
/**
- * Invoke hooks
+ * Invoke hooks.
*
* @param int $numParams
* Number of parameters to pass to the hook.
}
/**
- * Send an HTTP GET for a remote resource
+ * Send an HTTP GET for a remote resource.
*
* @param string $remoteFile
* URL of remote file.
}
/**
- * Send an HTTP POST for a remote resource
+ * Send an HTTP POST for a remote resource.
*
* @param string $remoteFile
* URL of a .zip file.
class CRM_Utils_ICalendar {
/**
- * Escape text elements for safe ICalendar use
+ * Escape text elements for safe ICalendar use.
*
* @param $text
* Text to escape.
}
/**
- * Escape date elements for safe ICalendar use
+ * Escape date elements for safe ICalendar use.
*
* @param $date
* Date to escape.
*/
class CRM_Utils_JS {
/**
- * Parse a javascript file for translatable strings
+ * Parse a javascript file for translatable strings.
*
* @param string $jsCode
* Raw Javascript code.
class CRM_Utils_JSON {
/**
- * Output json to the client
+ * Output json to the client.
* @param mixed $input
*/
public static function output($input) {
}
/**
- * Create JSON object
+ * Create JSON object.
* @deprecated
*
* @param array $params
}
/**
- * encode data for dataTable plugin
+ * encode data for dataTable plugin.
*
* @param array $params
* Associated array of row elements.
}
/**
- * Get the Active outBound email
+ * Get the Active outBound email.
*
* @return bool
* TRUE if valid outBound email configuration found, false otherwise.
}
/**
- * Process the mailbox for all the settings from civicrm_mail_settings
+ * Process the mailbox for all the settings from civicrm_mail_settings.
*
* @param bool|string $civiMail if true, processing is done in CiviMail context, or Activities otherwise.
*
}
/**
- * 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) {
}
/**
- * Split a large array of contactIDs into more manageable smaller chunks
+ * Split a large array of contactIDs into more manageable smaller chunks.
*/
public function &splitContactIDs(&$contactIDs) {
// contactIDs could be a real large array, so we split it up into
}
/**
- * Given a set of contact IDs get the values
+ * Given a set of contact IDs get the values.
*/
public function getValues(&$contactIDs, &$additionalContactIDs) {
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_Number {
/**
- * Create a random number with a given precision
+ * Create a random number with a given precision.
*
* @param array $precision
* (int $significantDigits, int $postDecimalDigits).
}
/**
- * Retrieve a value from the bag
+ * Retrieve a value from the bag.
*
* @param string $key
* @param string|null $type
public $countY = 0;
/**
- * Constructor
+ * Constructor.
*
* @param $format
* Either the name of a Label Format in the Option Value table.
}
/**
- * initialize label format settings
+ * initialize label format settings.
*
* @param $format
* @param $unit
}
/**
- * Print a label
+ * Print a label.
*
* @param $texte
*/
}
/**
- * convert value from one metric to another
+ * convert value from one metric to another.
*
* @param $value
* @param $from
}
/**
- * Use the pager class to get the pageId and Offset
+ * Use the pager class to get the pageId and Offset.
*
* @return array
* an array of the pageID and offset
}
/**
- * Build a url for pager links
+ * Build a url for pager links.
*/
public function makeURL($key, $value) {
$href = CRM_Utils_System::makeURL($key, TRUE);
}
/**
- * Output the html pager link
+ * Output the html pager link.
* @param string $href
* @param string $title
* @param string $image
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.
}
/**
- * Return the all the static characters
+ * Return the all the static characters.
*
* @return array
* is a array of static characters
}
/**
- * 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.
*/
class CRM_Utils_PseudoConstant {
/**
- * CiviCRM pseudoconstant classes for wrapper functions
+ * CiviCRM pseudoconstant classes for wrapper functions.
*/
private static $constantClasses = array(
'CRM_Core_PseudoConstant',
private static $constants = NULL;
/**
- * Get constant
+ * Get constant.
*
* Wrapper for Pseudoconstant methods. We use this so the calling function
* doesn't need to know which class the Pseudoconstant is on
}
/**
- * Flush constant
+ * Flush constant.
*
* Wrapper for Pseudoconstant methods. We use this so the calling function
* doesn't need to know which class the Pseudoconstant is on
}
/**
- * Determine where a constant lives
+ * Determine where a constant lives.
*
* If there's a full, preloaded map, use it. Otherwise, use search
* class space.
}
/**
- * Generates values needed for error messages
+ * Generates values needed for error messages.
* @param string $message
*
* @return array
static private $_singleton = NULL;
/**
- * Singleton function used to manage this object
+ * Singleton function used to manage this object.
*
*
* @return object
}
/**
- * Add element to form
+ * Add element to form.
*/
public static function add(&$form) {
$error = NULL;
class CRM_Utils_Recent {
/**
- * Max number of items in queue
+ * Max number of items in queue.
*
* @int
*/
const MAX_ITEMS = 10, STORE_NAME = 'CRM_Utils_Recent';
/**
- * The list of recently viewed items
+ * The list of recently viewed items.
*
* @var array
*/
static private $_recent = NULL;
/**
- * Initialize this class and set the static variables
+ * Initialize this class and set the static variables.
*
* @return void
*/
}
/**
- * Return the recently viewed array
+ * Return the recently viewed array.
*
* @return array
* the recently viewed array
}
/**
- * Add an item to the recent stack
+ * Add an item to the recent stack.
*
* @param string $title
* The title to display.
}
/**
- * 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.
}
/**
- * Check if there is a record with the same name in the db
+ * Check if there is a record with the same name in the db.
*
* @param string $value
* The value of the field we are checking.
private $columns;
/**
- * Create a new INSERT query
+ * Create a new INSERT query.
*
* @param string $table
* Table-name and optional alias.
}
/**
- * Create a new SELECT query
+ * Create a new SELECT query.
*
* @param string $table
* Table-name and optional alias.
}
/**
- * Use REPLACE INTO instead of INSERT INTO
+ * Use REPLACE INTO instead of INSERT INTO.
*
* @param bool $asReplace
* @return CRM_Utils_SQL_Insert
private $offset = NULL;
/**
- * Create a new SELECT query
+ * Create a new SELECT query.
*
* @param string $from
* Table-name and optional alias.
}
/**
- * Create a new SELECT query
+ * Create a new SELECT query.
*
* @param string $from
* Table-name and optional alias.
}
/**
- * Add a new JOIN clause
+ * Add a new JOIN clause.
*
* @param string $name
* The effective alias of the joined table.
}
/**
- * Group results by adding extra items to the GROUP BY clause
+ * Group results by adding extra items to the GROUP BY clause.
*
* @param string|array $exprs list of SQL expressions
* @param null|array $args use NULL to disable interpolation; use an array of variables to enable
}
/**
- * Sort results by adding extra items to the ORDER BY clause
+ * Sort results by adding extra items to the ORDER BY clause.
*
* @param string|array $exprs list of SQL expressions
* @param null|array $args use NULL to disable interpolation; use an array of variables to enable
}
/**
- * Set a limit on the number of records to return
+ * Set a limit on the number of records to return.
*
* @param int $limit
* @param int $offset
}
/**
- * Verify a SOAP key
+ * Verify a SOAP key.
*
* @param string $key
* The soap key generated by authenticate().
}
/**
- * Authentication wrapper to the UF Class
+ * Authentication wrapper to the UF Class.
*
* @param string $name
* Login name.
}
/**
- * MAILER API
+ * MAILER API.
*/
public function mailer_event_bounce($key, $job, $queue, $hash, $body) {
$this->verify($key);
}
/**
- * Function returns the string for the order by clause
+ * Function returns the string for the order by clause.
*
* @return string
* the order by clause
}
/**
- * 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.
}
/**
- * 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
}
/**
- * Getter for currentSortDirection
+ * Getter for currentSortDirection.
*
* @return int
* returns of the current sort direction
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
-*/
+ */
/**
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2014
* $Id$
- *
*/
require_once 'HTML/QuickForm/Rule/Email.php';
/**
- * This class contains string functions
+ * This class contains string functions.
*
*/
class CRM_Utils_String {
const ALPHANUMERIC = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890';
/**
- * Convert a display name into a potential variable
- * name that we could use in forms/code
+ * Convert a display name into a potential variable name.
*
* @param $title title of the string
* @param int $maxLength
}
/**
- * Given a string, replace all non alpha numeric characters and
- * spaces with the replacement character
+ * Replace all non alpha numeric characters and spaces with the replacement character.
*
* @param string $name
* The name to be worked on.
* @param int $len
* Length of valid variables.
*
- *
* @return string
* returns the manipulated string
*/
public static function munge($name, $char = '_', $len = 63) {
- // replace all white space and non-alpha numeric with $char
+ // Replace all white space and non-alpha numeric with $char
// we only use the ascii character set since mysql does not create table names / field names otherwise
// CRM-11744
$name = preg_replace('/[^a-zA-Z0-9]+/', $char, trim($name));
}
/**
- * Takes a variable name and munges it randomly into another variable name
+ * Takes a variable name and munges it randomly into another variable name.
*
* @param string $name
* Initial Variable Name.
/**
* Takes a string and returns the last tuple of the string.
- * useful while converting file names to class names etc
+ *
+ * Useful while converting file names to class names etc
*
* @param string $string
* The input string.
/**
* Appends a name to a string and separated by delimiter.
- * does the right thing for an empty string
+ *
+ * Does the right thing for an empty string
*
* @param string $str
* The string to be appended to.
* The delimiter to use.
* @param mixed $name
* The string (or array of strings) to append.
- *
- * @return void
*/
public static function append(&$str, $delim, $name) {
if (empty($name)) {
}
/**
- * 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.
}
/**
- * Determine the string replacements for redaction
+ * Determine the string replacements for redaction.
* on the basis of the regular expressions
*
* @param string $str
}
/**
- * Extract the civicrm path from the url
+ * Extract the civicrm path from the url.
*
* @param string $query
* A url string.
}
/**
- * Generate a random string
+ * Generate a random string.
*
* @param $len
* @param $alphabet
}
/**
- * This function compares two strings
+ * This function compares two strings.
*
* @param string $strOne
* String one.
}
/**
- * Formats a string of attributes for insertion in an html tag
+ * Formats a string of attributes for insertion in an html tag.
*
* @param array $attributes
*
}
/**
- * this is a very drupal specific function for now
+ * this is a very drupal specific function for now.
*/
public static function updateCategories() {
$config = CRM_Core_Config::singleton();
}
/**
- * Determine the post URL for a form
+ * Determine the post URL for a form.
*
* @param $action
* The default action if one is pre-specified.
}
/**
- * Get the locale set in the hosting CMS
+ * Get the locale set in the hosting CMS.
*
* @return string
* The used locale or null for none.
}
/**
- * Determine the standard URL for viewing or editing the specified link
+ * Determine the standard URL for viewing or editing the specified link.
*
* This function delegates the decision-making to (a) the hook system and
* (b) the BAO system.
var $supports_form_extensions = FALSE;
/**
- * Append an additional breadcrumb tag to the existing breadcrumb
+ * Append an additional breadcrumb tag to the existing breadcrumb.
*
* @param array $breadCrumbs
*/
}
/**
- * Reset an additional breadcrumb tag to the existing breadcrumb
+ * Reset an additional breadcrumb tag to the existing breadcrumb.
*/
public function resetBreadCrumb() {
}
/**
- * Append a string to the head of the html file
+ * Append a string to the head of the html file.
*
* @param string $head
* The new string to be appended.
}
/**
- * Rewrite various system urls to https
+ * Rewrite various system urls to https.
*/
public function mapConfigToSSL() {
// dont need to do anything, let CMS handle their own switch to SSL
}
/**
- * Figure out the post url for QuickForm
+ * Figure out the post url for QuickForm.
*
* @param string $action
* The default url if one is pre-specified.
}
/**
- * Authenticate the user against the CMS db
+ * Authenticate the user against the CMS db.
*
* @param string $name
* The user name.
}
/**
- * Set a message in the CMS to display to a user
+ * Set a message in the CMS to display to a user.
*
* @param string $message
* The message to set.
}
/**
- * Load user into session
+ * Load user into session.
*
* @param $user
*
}
/**
- * Get the locale set in the CMS
+ * Get the locale set in the CMS.
*
* @return string|null
* Locale or null for none
}
/**
- * Get CMS Version
+ * Get CMS Version.
*
* @return string
*/
}
/**
- * Determine the native ID of the CMS user
+ * Determine the native ID of the CMS user.
*
* @param string $username
*
}
/**
- * Set a init session with user object
+ * Set a init session with user object.
*
* @param array $data
* Array with user specific data
}
/**
- * Add a script file
+ * Add a script file.
*
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
}
/**
- * Add an inline script
+ * Add an inline script.
*
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
}
/**
- * Add a css file
+ * Add a css file.
*
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
}
/**
- * Add an inline style
+ * Add an inline style.
*
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
}
/**
- * Sets the title of the page
+ * Sets the title of the page.
*
* @param string $title
* Title to set in html header
}
/**
- * Return default Site Settings
+ * Return default Site Settings.
*
* @param string $dir
*
}
/**
- * Set timezone in mysql so that timestamp fields show the correct time
+ * Set timezone in mysql so that timestamp fields show the correct time.
*/
public function setMySQLTimeZone() {
$timeZoneOffset = $this->getTimeZoneOffset();
/**
- * Get timezone from CMS
+ * Get timezone from CMS.
*
* @return string|false|null
*/
}
/**
- * Get timezone as a string
+ * Get timezone as a string.
* @return string
* Timezone string e.g. 'America/Los_Angeles'
*/
}
/**
- * Get Url to view user record
+ * Get Url to view user record.
* @param int $contactID
* Contact ID.
*
}
/**
- * Is the current user permitted to add a user
+ * Is the current user permitted to add a user.
* @return bool
*/
public function checkPermissionAddUser() {
}
/**
- * Output code from error function
+ * Output code from error function.
* @param string $content
*/
public function outputError($content) {
}
/**
- * Log error to CMS
+ * Log error to CMS.
*
* $param string $message
*/
}
/**
- * Append to coreResourcesList
+ * Append to coreResourcesList.
*
* @param array $list
*/
}
/**
- * Check if username and email exists in the drupal db
+ * Check if username and email exists in the drupal db.
*
* @param array $params
* Array of name and mail values.
}
/**
- * Determine the native ID of the CMS user
+ * Determine the native ID of the CMS user.
*
* @param string $username
* @return int|NULL
}
/**
- * Get the default location for CiviCRM blocks
+ * Get the default location for CiviCRM blocks.
*
* @return string
*/
}
/**
- * Load drupal bootstrap
+ * Load drupal bootstrap.
*
* @param array $params
* Either uid, or name & pass.
}
/**
- * Wrapper for og_membership creation
+ * Wrapper for og_membership creation.
*
* @param int $ogID
* Organic Group ID.
}
/**
- * Wrapper for og_membership deletion
+ * Wrapper for og_membership deletion.
*
* @param int $ogID
* Organic Group ID.
}
/**
- * Check if username and email exists in the drupal db
+ * Check if username and email exists in the drupal db.
*
* @param array $params
* Array of name and mail values.
}
/**
- * Append a string to the head of the html file
+ * Append a string to the head of the html file.
*
* @param string $head
* The new string to be appended.
}
/**
- * Add a css file
+ * Add a css file.
*
* @param $url : string, absolute path to file
* @param string $region
}
/**
- * Determine the native ID of the CMS user
+ * Determine the native ID of the CMS user.
*
* @param string $username
* @return int|NULL
}
/**
- * Load drupal bootstrap
+ * Load drupal bootstrap.
*
* @param array $params
* Either uid, or name & pass.
}
/**
- * Wrapper for og_membership creation
+ * Wrapper for og_membership creation.
*
* @param int $ogID
* Organic Group ID.
}
/**
- * Wrapper for og_membership deletion
+ * Wrapper for og_membership deletion.
*
* @param int $ogID
* Organic Group ID.
}
/**
- * Check if username and email exists in the drupal db
+ * Check if username and email exists in the drupal db.
*
* @param array $params
* Array of name and mail values.
}
/**
- * Check if a resource url is within the drupal directory and format appropriately
+ * Check if a resource url is within the drupal directory and format appropriately.
*
* This seems to be a legacy function. We assume all resources are within the drupal
* directory and always return TRUE. As well, we clean up the $url.
}
/**
- * Determine the native ID of the CMS user
+ * Determine the native ID of the CMS user.
*
* @param string $username
* @return int|NULL
}
/**
- * Load drupal bootstrap
+ * Load drupal bootstrap.
*
* @param array $params
* Either uid, or name & pass.
}
/**
- * Check if a resource url is within the drupal directory and format appropriately
+ * Check if a resource url is within the drupal directory and format appropriately.
*
* @param $url (reference)
*
}
/**
- * Append Drupal js to coreResourcesList
+ * Append Drupal js to coreResourcesList.
*/
public function appendCoreResources(&$list) {
$list[] = 'js/crm.drupal.js';
}
/**
- * Check if username and email exists in the drupal db
+ * Check if username and email exists in the drupal db.
*
* @param array $params
* Array of name and mail values.
}
/**
- * Set the email address of the user
+ * Set the email address of the user.
*
* @param object $user
* Handle to the user object.
}
/**
- * Set a init session with user object
+ * Set a init session with user object.
*
* @param array $data
* Array with user specific data.
}
/**
- * Load joomla bootstrap
+ * Load joomla bootstrap.
*
* @param array $params
* with uid or name and password.
}
/**
- * Output code from error function
+ * Output code from error function.
* @param string $content
*/
public function outputError($content) {
}
/**
- * Append Joomla js to coreResourcesList
+ * Append Joomla js to coreResourcesList.
*/
public function appendCoreResources(&$list) {
$list[] = 'js/crm.joomla.js';
class CRM_Utils_System_Soap extends CRM_Utils_System_Base {
/**
- * UF container variables
+ * UF container variables.
*/
static $uf = NULL;
static $ufClass = NULL;
}
/**
- * Set the email address of the user
+ * Set the email address of the user.
*
* @param object $user
* Handle to the user object.
}
/**
- * Swap the current UF for soap
+ * Swap the current UF for soap.
*/
public function swapUF() {
$config = CRM_Core_Config::singleton();
}
/**
- * WP action callback
+ * WP action callback.
*/
public static function _showHTMLHead() {
$region = CRM_Core_Region::instance('wp_head', FALSE);
}
/**
- * Load wordpress bootstrap
+ * Load wordpress bootstrap.
*
* @param string $name
* optional username for login.
static private $_delta = 0;
/**
- * Get the time
+ * Get the time.
*
* @param string $returnFormat
* Format in which date is to be retrieved.
}
/**
- * Get the time
+ * Get the time.
*
* @return int, seconds since epoch
*/
}
/**
- * Set the given time
+ * Set the given time.
*
* @param string $newDateTime
* A date formatted with strtotime.
}
/**
- * Remove any time overrides
+ * Remove any time overrides.
*/
public static function resetTime() {
self::$_delta = 0;
}
/**
- * Wrapper for token matching
+ * Wrapper for token matching.
*
* @param string $type
* The token type (domain,mailing,contact,action).
}
/**
- * Wrapper for token replacing
+ * Wrapper for token replacing.
*
* @param string $type
* The token type.
}
/**
- * 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.
}
/**
- * Parse html through Smarty resolving any smarty functions
+ * Parse html through Smarty resolving any smarty functions.
* @param string $tokenHtml
* @param array $entity
* @param string $entityType
}
/**
- * Replace unsubscribe tokens
+ * Replace unsubscribe tokens.
*
* @param string $str
* The string with tokens to be replaced.
}
/**
- * Replace resubscribe tokens
+ * Replace resubscribe tokens.
*
* @param string $str
* The string with tokens to be replaced.
}
/**
- * Find and replace tokens for each component
+ * Find and replace tokens for each component.
*
* @param string $str
* The string to search.
}
/**
- * Get array of string tokens
+ * Get array of string tokens.
*
* @param string $string
* The input string to parse for tokens.
}
/**
- * Get Membership Token Details
+ * Get Membership Token Details.
* @param array $membershipIDs
* Array of membership IDS.
*/
}
/**
- * Store membership tokens on the static _tokens array
+ * Store membership tokens on the static _tokens array.
*/
protected static function _buildMembershipTokens() {
$key = 'membership';
}
/**
- * Replace tokens for an entity
+ * Replace tokens for an entity.
* @param string $entity
* @param array $entityArray
* (e.g. in format from api).
}
/**
- * Replace Contribution tokens in html
+ * Replace Contribution tokens in html.
*
* @param string $str
* @param array $contribution
class CRM_Utils_Tree {
/**
- * Store the tree information as a string or array
+ * Store the tree information as a string or array.
* @var string|array
*/
private $tree;
}
/**
- * Find a node that matches the given string
+ * Find a node that matches the given string.
*
* @param string $name
* Name of the node we are searching for.
}
/**
- * Create a node
+ * Create a node.
*
* @param string $name
*
}
/**
- * Add node
+ * Add node.
*
* @param string $parentName
* Name of the parent ?.
}
/**
- * Add Data
+ * Add Data.
*
* @param string $parentName Name of the parent ?.
* @param string $childName - key to be used (optional)
}
/**
- * Get Tree
+ * Get Tree.
*
* @return tree
*/
}
/**
- * Print the tree
+ * Print the tree.
*
* @return void
*/
}
/**
- * Verify that a variable is of a given type
+ * Verify that a variable is of a given type.
*
* @param mixed $data
* The value to validate.
}
/**
- * Decode the address and return the sender and recipient as an array
+ * Decode the address and return the sender and recipient as an array.
*
* @param string $address
* The address to be decoded.
protected $cacheFile;
/**
- * Class constructor
+ * Class constructor.
*/
public function __construct() {
global $civicrm_root;
}
/**
- * Static instance provider
+ * Static instance provider.
*
* Method providing static instance of CRM_Utils_VersionCheck,
* as in Singleton pattern
}
/**
- * Finds the release info for a minor version
+ * Finds the release info for a minor version.
* @param string $version
* @return array|null
*/
}
/**
- * Alert the site admin of new versions of CiviCRM
+ * Alert the site admin of new versions of CiviCRM.
* Show the message once a day
*/
public function versionAlert() {
}
/**
- * Collect info about the site to be sent as pingback data
+ * Collect info about the site to be sent as pingback data.
*/
private function getSiteStats() {
$config = CRM_Core_Config::singleton();
}
/**
- * Get active payment processor types
+ * Get active payment processor types.
*/
private function getPayProcStats() {
$dao = new CRM_Financial_DAO_PaymentProcessor();
}
/**
- * Fetch counts from entity tables
+ * Fetch counts from entity tables.
* Add info to the 'entities' array
*/
private function getEntityStats() {
}
/**
- * Save version info to file
+ * Save version info to file.
* @param string $contents
*/
private function writeCacheFile($contents) {
class CRM_Utils_Wrapper {
/**
- * Simple Controller
+ * Simple Controller.
*
* The controller which will handle the display and processing of this page.
*/
}
/**
- * Convert an XML element to an array
+ * Convert an XML element to an array.
*
* @param $obj
* SimpleXMLElement.
}
/**
- * Determine the name of the folder within a zip
+ * Determine the name of the folder within a zip.
*
* @param ZipArchive $zip
* @param $expected
const RESPOND = 'api.respond';
/**
- * Handle any exceptions
+ * Handle any exceptions.
*
* @see ExceptionEvent
*/
}
/**
- * Look up the implementation for a given API request
+ * Look up the implementation for a given API request.
*
* @param array $apiRequest
* Array with keys:
}
/**
- * Call any nested api calls
+ * Call any nested api calls.
*
* TODO: We don't really need this to be a separate function.
* @param $params
private $forceRollback = array();
/**
- * Determine if an API request should be treated as transactional
+ * Determine if an API request should be treated as transactional.
*
* @param \Civi\API\Provider\ProviderInterface $apiProvider
* The API provider responsible for this request.
}
/**
- * Close any pending transactions
+ * Close any pending transactions.
*
* @param \Civi\API\Event\RespondEvent $event
* API response event.
}
/**
- * Rollback the pending transaction
+ * Rollback the pending transaction.
*
* @param \Civi\API\Event\ExceptionEvent $event
* API exception event.
}
/**
- * Get a list of AngularJS modules which should be autoloaded
+ * Get a list of AngularJS modules which should be autoloaded.
*
* @return array
* Each item has some combination of these keys:
*/
class Main extends \CRM_Core_Page {
/**
- * The weight to assign to any Angular JS module files
+ * The weight to assign to any Angular JS module files.
*/
const DEFAULT_MODULE_WEIGHT = 200;
}
/**
- * Get a list of all activities in the case
+ * Get a list of all activities in the case.
*
* @return array
* list of activity records (api/v3 format)
}
/**
- * Get a single activity record by type
+ * Get a single activity record by type.
*
* @param string $type
* @throws \Civi\CCase\Exception\MultipleActivityException
}
/**
- * Flush any cached information
+ * Flush any cached information.
*
* @return void
*/
}
/**
- * Find any extra listeners declared in XML and pass the event along to them
+ * Find any extra listeners declared in XML and pass the event along to them.
*
* @param \Civi\CCase\Event\CaseChangeEvent $event
*/
}
/**
- * Add a transaction callback
+ * Add a transaction callback.
*
* Pre-condition: isActive()
*
}
/**
- * Check configured php Memory
+ * Check configured php Memory.
* @return array
*/
public function checkMemory() {
}
/**
- * Get Configured PHP memory
+ * Get Configured PHP memory.
* @return float
*/
protected function getPHPMemory() {
const MINIMUM_THREAD_STACK = 192;
/**
- * Just check that the database configuration is okay
+ * Just check that the database configuration is okay.
* @param $databaseConfig
* @param $dbName
*/
}
/**
- * Check everything except the database
+ * Check everything except the database.
*/
public function check() {
global $crmPath, $installType;
*/
class test_extension_manager_reporttest extends CRM_Core_Report {
/**
+ * Class constructor.
*/
public function __construct() {
$logging = new CRM_Logging_Schema();
/**
* Tears down the fixture, for example, closes a network connection.
+ *
* This method is called after a test is executed.
*/
protected function tearDown() {
}
public function testRetrieveTargetIdsByActivityIdZeroID() {
- $activity = $this->activityCreate();
-
+ $this->activityCreate();
$target = CRM_Activity_BAO_ActivityTarget::retrieveTargetIdsByActivityId(0);
$this->assertSame($target, array(), 'No targets returned');
}
}
/**
- * Testcases for create() method
- * create() method Add/Edit activity.
+ * Test case for create() method.
*/
public function testCreate() {
$contactId = Contact::createIndividual();
}
/**
- * Testcase for getContactActivity() method.
- * getContactActivity() method get activities detail for given target contact id
+ * Test case for getContactActivity() method.
+ *
+ * getContactActivity() method get activities detail for given target contact id.
*/
public function testGetContactActivity() {
$contactId = Contact::createIndividual();
}
/**
- * Testcase for retrieve() method.
- * retrieve($params, $defaults) method return activity detail for given params
+ * Test case for retrieve() method.
+ *
+ * Retrieve($params, $defaults) method return activity detail for given params
* and set defaults.
*/
public function testRetrieve() {
}
/**
- * Testcase for deleteActivity() method.
+ * Test case for deleteActivity() method.
+ *
* deleteActivity($params) method deletes activity for given params.
*/
public function testDeleteActivity() {
}
/**
- * Testcase for deleteActivityTarget() method.
+ * Test case for deleteActivityTarget() method.
+ *
* deleteActivityTarget($activityId) method deletes activity target for given activity id.
*/
public function testDeleteActivityTarget() {
}
/**
- * Testcase for deleteActivityAssignment() method.
+ * Test case for deleteActivityAssignment() method.
+ *
* deleteActivityAssignment($activityId) method deletes activity assignment for given activity id.
*/
public function testDeleteActivityAssignment() {
class CRM_Batch_Form_EntryTest extends CiviUnitTestCase {
/**
- * Membership type name used in test function
+ * Membership type name used in test function.
* @var String
*/
protected $_membershipTypeName = NULL;
/**
- * Membership type id used in test function
+ * Membership type id used in test function.
* @var String
*/
protected $_membershipTypeID = NULL;
/**
- * Contact id used in test function
+ * Contact id used in test function.
* @var String
*/
protected $_contactID = NULL;
/**
- * Contact id used in test function
+ * Contact id used in test function.
* @var String
*/
protected $_contactID2 = NULL;
/**
- * Contact id used in test function
+ * Contact id used in test function.
* @var String
*/
protected $_contactID3 = NULL;
/**
- * Contact id used in test function
+ * Contact id used in test function.
* @var String
*/
protected $_contactID4 = NULL;
/**
* Search with only type.
- * success expected.
+ *
+ * Success expected.
*/
public function testSearchWithType() {
/**
* Search with only subtype.
- * success expected.
+ *
+ * Success expected.
*/
public function testSearchWithSubype() {
/**
* Search with type as well as subtype.
- * success expected.
+ *
+ * Success expected.
*/
public function testSearchWithTypeSubype() {
/**
* Methods create Contact with valid data.
- * success expected
+ *
+ * Success expected
*/
public function testCreateContact() {
//check for Type:Individual
/**
* Update the contact with no subtype to a valid subtype.
- * success expected
+ *
+ * Success expected.
*/
- public function testUpdateContactNosubtypeToValid() {
+ public function testUpdateContactNoSubtypeToValid() {
$params = array(
'first_name' => 'Anne',
'last_name' => 'Grant',
}
/**
- * 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
+ * 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
*/
public function testFindSave() {
$contributionRecur = $this->callAPISuccess('contribution_recur', 'create', $this->_params);
}
/**
- * Test cancellation works per CRM-14986
- * we are checking for absence of error
+ * Test cancellation works per CRM-14986.
+ *
+ * We are checking for absence of error.
*/
public function testCancelRecur() {
$contributionRecur = $this->callAPISuccess('contribution_recur', 'create', $this->_params);
}
/**
- * Check duplicate contribution id
+ * Check duplicate contribution id.
* during the contribution import
* checkDuplicateIds();
*/
}
/**
- * Test getTree()
+ * Test getTree().
*/
public function testGetTree() {
$params = array();
* Test that item leases expire at the expected time.
*
* @dataProvider getQueueSpecs
+ *
* @param $queueSpec
*/
public function testTimeoutRelease($queueSpec) {
}
/**
- * Run a series of tasks; one of the tasks will insert more
- * TODOs at the start of the list
+ * Run a series of tasks.
+ *
+ * One of the tasks will insert more TODOs at the start of the list.
*/
public function testRunAll_AddMore() {
- // prepare a list of tasks with an error in the middle
+ // Prepare a list of tasks with an error in the middle.
$this->queue->createItem(new CRM_Queue_Task(
array('CRM_Queue_RunnerTest', '_recordValue'),
array('a'),
<?php
-// vim: set si ai expandtab tabstop=4 shiftwidth=4 softtabstop=4:
-
/**
* File for the CRM_Utils_Cache_AllTests class
*
*/
/**
- * Include parent class definition
+ * Include parent class definition.
*/
require_once 'CiviTest/CiviTestSuite.php';
/**
- * Class containing all test suites
+ * Class containing all test suites.
*
* @package CiviCRM
*/
private static $instance = NULL;
/**
+ * Get instance.
*/
private static function getInstance() {
if (is_null(self::$instance)) {
}
/**
- * Build test suite dynamically.
+ * Build test suite dynamically.
*/
public static function suite() {
$inst = self::getInstance();
}
}
-// class CRM_Utils_Cache_AllTests
-
-// -- set Emacs parameters --
-// Local variables:
-// mode: php;
-// tab-width: 4
-// c-basic-offset: 4
-// c-hanging-comment-ender-p: nil
-// indent-tabs-mode: nil
-// End:
}
/**
- * Test civicrm_contact_check_params with no contact type
+ * Test civicrm_contact_check_params with no contact type.
*/
public function testCheckParamsWithNoContactType() {
$params = array('foo' => 'bar');
/**
- * Test civicrm_contact_check_params with a duplicate
+ * Test civicrm_contact_check_params with a duplicate.
*/
public function testCheckParamsWithDuplicateContact() {
// Insert a row in civicrm_contact creating individual contact
/**
- * Test civicrm_contact_check_params with a duplicate
+ * Test civicrm_contact_check_params with a duplicate.
* and request the error in array format
*/
public function testCheckParamsWithDuplicateContact2() {
);
}
- public function testGuessBaseDir_twodir() {
+ public function testGuessBaseDirTwoDir() {
$this->_doGuessBaseDir(FALSE,
array('dir-1', 'dir-2'),
array('dir-1/README.txt' => 'hello'),
);
}
- public function testGuessBaseDir_weird() {
+ public function testGuessBaseDirWeird() {
$this->_doGuessBaseDir(FALSE,
array('foo/../'),
array('foo/../README.txt' => 'hello'),
}
/**
- * Private helper function for calling civicrm_contact_add
+ * Private helper function for calling civicrm_contact_add.
*
* @param array $params
* For civicrm_contact_add api function call.
}
/**
- * Ensure that an invalid activity type causes failure
- * oddly enough this test was failing because the creation of the invalid type
+ * Ensure that an invalid activity type causes failure.
+ *
+ * Oddly enough this test was failing because the creation of the invalid type
* got added to the set up routine. Probably a mis-fix on a test
*/
public function testActivityCreateWithNonNumericActivityTypeId() {
}
/**
- * Is_primary should be set as a default
+ * Is_primary should be set as a default.
*/
public function testCreateAddressTestDefaults() {
$params = $this->_params;
}
/**
- * Is_primary should be set as a default. ie. create the address, unset the params & recreate.
+ * Is_primary should 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
+ * is_primary is invalid.
*/
public function testCreateAddressTestDefaultWithID() {
$params = $this->_params;
}
/**
- * Create an attachment using "content" and then "get" the attachment
+ * Create an attachment using "content" and then "get" the attachment.
*
* @param string $testEntityClass
* E.g. "CRM_Core_DAO_Activity".
/**
* Sets up the fixture, for example, opens a network connection.
+ *
* This method is called before a test is executed.
*/
protected function setUp() {
}
/**
- * Test civicrm_contact_create
+ * Test civicrm_contact_create.
*
* Verify that attempt to create individual contact with only
* first and last names succeeds
<?php
/**
- * File for the TestCase class
+ * @file
+ * File for the TestCase class
*
* (PHP 5)
*
protected $followup_activity_type_value;
/**
- * Test setup for every test
+ * Test setup for every test.
*
* Connect to the database, truncate the tables that will be used
* and redirect stdin to a temporary file
}
/**
- * Check with empty array
+ * Check with empty array.
*/
public function testCaseCreateEmpty() {
- $result = $this->callAPIFailure('case', 'create', array());
+ $this->callAPIFailure('case', 'create', array());
}
/**
- * Check if required fields are not passed
+ * Check if required fields are not passed.
*/
public function testCaseCreateWithoutRequired() {
$params = array(
}
/**
- * Test create function with valid parameters
+ * Test create function with valid parameters.
*/
public function testCaseCreate() {
// Create Case
}
/**
- * Test delete function with valid parameters
+ * Test delete function with valid parameters.
*/
public function testCaseDelete() {
// Create Case
}
/**
- * Test get function based on activity
+ * Test get function based on activity.
*/
public function testCaseGetByActivity() {
// Create Case
}
/**
- * Test get function based on contact id
+ * Test get function based on contact id.
*/
public function testCaseGetByContact() {
// Create Case
}
/**
- * Test get function based on subject
+ * Test get function based on subject.
*/
public function testCaseGetBySubject() {
// Create Case
}
/**
- * Test get function based on wrong subject
+ * Test get function based on wrong subject.
*/
public function testCaseGetByWrongSubject() {
// Create Case
}
/**
- * Test get function with no criteria
+ * Test get function with no criteria.
*/
public function testCaseGetNoCriteria() {
// Create Case
}
/**
- * Test activity api create for case activities
+ * Test activity api create for case activities.
*/
public function testCaseActivityCreate() {
// Create a case first
}
/**
- * Test activity api update for case activities
+ * Test activity api update for case activities.
*/
public function testCaseActivityUpdate() {
// Need to create the case and activity before we can update it
);
$contact = $this->callAPISuccess('contact', 'create', $params);
- $this->assertTrue(is_numeric($contact['id']), "In line " . __LINE__);
- $this->assertTrue($contact['id'] > 0, "In line " . __LINE__);
+ $this->assertTrue(is_numeric($contact['id']));
+ $this->assertTrue($contact['id'] > 0);
$newCount = CRM_Core_DAO::singleValueQuery('select count(*) from civicrm_contact');
$this->assertEquals($oldCount + 1, $newCount);
$contact = $this->callAPISuccess('contact', 'get', $params);
- $this->assertEquals(array('Student', 'Staff'), $contact['values'][$cid]['contact_sub_type'], "In line " . __LINE__);
+ $this->assertEquals(array('Student', 'Staff'), $contact['values'][$cid]['contact_sub_type']);
}
/**
$contact = $this->callAPISuccess('contact', 'create', $params);
- $this->assertEquals(1, $contact['id'], "In line " . __LINE__);
+ $this->assertEquals(1, $contact['id']);
$email = $this->callAPISuccess('email', 'get', array('contact_id' => $contact['id']));
$this->assertEquals(1, $email['count']);
$this->assertEquals('man3@yahoo.com', $email['values'][$email['id']]['email']);
'contact_type' => 'Household',
);
$contact = $this->callAPISuccess('contact', 'create', $params);
- $this->assertEquals(1, $contact['id'], "In line " . __LINE__);
+ $this->assertEquals(1, $contact['id']);
}
/**
$this->callAPISuccess('contact', 'delete', array('id' => $contact1['id']));
$this->callAPISuccess('contact', 'delete', array('id' => $contact2['id']));
$this->assertEquals(1, $countNotDeleted, 'contact_is_deleted => 0 is respected in line ' . __LINE__);
- $this->assertEquals(1, $countActive, 'in line ' . __LINE__);
- $this->assertEquals(1, $countTrash, 'in line ' . __LINE__);
- $this->assertEquals(2, $countAll, 'in line ' . __LINE__);
- $this->assertEquals(1, $countDeleted, 'in line ' . __LINE__);
+ $this->assertEquals(1, $countActive);
+ $this->assertEquals(1, $countTrash);
+ $this->assertEquals(2, $countAll);
+ $this->assertEquals(1, $countDeleted);
$this->assertEquals(1, $countDefault, 'Only active by default in line ' . __LINE__);
}
$this->assertEquals(1, $result['id']);
// checking child function result not covered in callAPIAndDocument
$this->assertAPISuccess($result['values'][$result['id']]['api.website.create']);
- $this->assertEquals("http://chained.org", $result['values'][$result['id']]['api.website.create.2']['values'][0]['url'], "In line " . __LINE__);
- $this->assertEquals("http://civicrm.org", $result['values'][$result['id']]['api.website.create']['values'][0]['url'], "In line " . __LINE__);
+ $this->assertEquals("http://chained.org", $result['values'][$result['id']]['api.website.create.2']['values'][0]['url']);
+ $this->assertEquals("http://civicrm.org", $result['values'][$result['id']]['api.website.create']['values'][0]['url']);
// delete the contact
$this->callAPISuccess('contact', 'delete', $result);
$this->assertEquals(1, $result['id']);
// the callAndDocument doesn't check the chained call
- $this->assertEquals(0, $result['values'][$result['id']]['api.website.create'][0]['is_error'], "In line " . __LINE__);
- $this->assertEquals("http://chained.org", $result['values'][$result['id']]['api.website.create'][1]['values'][0]['url'], "In line " . __LINE__);
- $this->assertEquals("http://civicrm.org", $result['values'][$result['id']]['api.website.create'][0]['values'][0]['url'], "In line " . __LINE__);
+ $this->assertEquals(0, $result['values'][$result['id']]['api.website.create'][0]['is_error']);
+ $this->assertEquals("http://chained.org", $result['values'][$result['id']]['api.website.create'][1]['values'][0]['url']);
+ $this->assertEquals("http://civicrm.org", $result['values'][$result['id']]['api.website.create'][0]['values'][0]['url']);
$this->callAPISuccess('contact', 'delete', $result);
}
/**
- * Verify that attempt to create individual contact with first.
- * and last names and email succeeds
+ * Verify that attempt to create individual contact with first, and last names and email succeeds.
*/
public function testCreateIndividualWithNameEmail() {
$params = array(
);
$contact = $this->callAPISuccess('contact', 'create', $params);
- $this->assertEquals(1, $contact['id'], "In line " . __LINE__);
+ $this->assertEquals(1, $contact['id']);
- // delete the contact
$this->callAPISuccess('contact', 'delete', $contact);
}
}
/**
- * Verify that attempt to create individual contact with first.
- * and last names, email and location type succeeds
+ * Test create individual contact with first &last names, email and location type succeeds.
*/
public function testCreateIndividualWithNameEmailLocationType() {
$params = array(
);
$result = $this->callAPISuccess('contact', 'create', $params);
- $this->assertEquals(1, $result['id'], "In line " . __LINE__);
+ $this->assertEquals(1, $result['id']);
$this->callAPISuccess('contact', 'delete', array('id' => $result['id']));
}
/**
- * Verify that when changing employers
- * the old employer relationship becomes inactive
+ * Verify that when changing employers the old employer relationship becomes inactive.
*/
public function testCreateIndividualWithEmployer() {
$employer = $this->organizationCreate();
}
/**
- * Verify that attempt to create household contact with details
- * succeeds
+ * Verify that attempt to create household contact with details succeeds.
*/
public function testCreateHouseholdDetails() {
$params = array(
$contact = $this->callAPISuccess('contact', 'create', $params);
- $this->assertEquals(1, $contact['id'], "In line " . __LINE__);
+ $this->assertEquals(1, $contact['id']);
$this->callAPISuccess('contact', 'delete', $contact);
}
* Test civicrm_contact_getquick() with empty name param.
*/
public function testContactGetQuick() {
- // Insert a row in civicrm_contact creating individual contact
+ // Insert a row in civicrm_contact creating individual contact.
$op = new PHPUnit_Extensions_Database_Operation_Insert();
$op->execute($this->_dbconn,
$this->createXMLDataSet(
);
$result = $this->callAPISuccess('contact', 'getquick', $params);
- $this->assertEquals(17, $result['values'][0]['id'], 'in line ' . __LINE__);
+ $this->assertEquals(17, $result['values'][0]['id']);
}
/**
- * Test civicrm_contact_get) with empty params
+ * Test civicrm_contact_get) with empty params.
*/
public function testContactGetEmptyParams() {
$this->callAPISuccess('contact', 'get', array());
}
/**
- * Test civicrm_contact_get(,true) with no matches
+ * Test civicrm_contact_get(,true) with no matches.
*/
public function testContactGetOldParamsNoMatches() {
- // Insert a row in civicrm_contact creating contact 17
+ // Insert a row in civicrm_contact creating contact 17.
$op = new PHPUnit_Extensions_Database_Operation_Insert();
$op->execute($this->_dbconn,
$this->createXMLDataSet(
'first_name' => 'Fred',
);
$result = $this->callAPISuccess('contact', 'get', $params);
- $this->assertEquals(0, $result['count'], 'in line ' . __LINE__);
+ $this->assertEquals(0, $result['count']);
}
/**
- * Test civicrm_contact_get(,true) with one match
+ * Test civicrm_contact_get(,true) with one match.
*/
public function testContactGetOldParamsOneMatch() {
- // Insert a row in civicrm_contact creating contact 17
+ // Insert a row in civicrm_contact creating contact 17
$op = new PHPUnit_Extensions_Database_Operation_Insert();
$op->execute($this->_dbconn,
$this->createXMLDataSet(dirname(__FILE__) . '/dataset/contact_17.xml'
'first_name' => 'Test',
);
$result = $this->callAPISuccess('contact', 'get', $params);
- $this->assertEquals(17, $result['values'][17]['contact_id'], 'in line ' . __LINE__);
- $this->assertEquals(17, $result['id'], 'in line ' . __LINE__);
+ $this->assertEquals(17, $result['values'][17]['contact_id']);
+ $this->assertEquals(17, $result['id']);
}
/**
- * Test civicrm_contact_search_count()
+ * Test civicrm_contact_search_count().
*/
public function testContactGetEmail() {
$params = array(
}
/**
- * Test birth date params incl value, array & birth_date_high, birth_date_low
- * && deceased
+ * Test birth date parameters.
+ *
+ * These include value, array & birth_date_high, birth_date_low
+ * && deceased.
*/
public function testContactGetBirthDate() {
$contact1 = $this->callAPISuccess('contact', 'create', array_merge($this->_params, array('birth_date' => 'first day of next month - 2 years')));
}
/**
- * Test Deceased date params incl value, array & Deceased_date_high, Deceased date_low
+ * Test Deceased date parameters.
+ *
+ * These include value, array & Deceased_date_high, Deceased date_low
* && deceased.
*/
public function testContactGetDeceasedDate() {
}
/**
- * Test for Contact.get id=@user:username
+ * Test for Contact.get id=@user:username.
*/
public function testContactGetByUsername() {
- // setup - create contact with a uf-match
+ // Setup - create contact with a uf-match.
$cid = $this->individualCreate(array(
'contact_type' => 'Individual',
'first_name' => 'testGetByUsername',
}
/**
- * Test for Contact.get id=@user:username (with an invalid username)
+ * Test for Contact.get id=@user:username (with an invalid username).
*/
public function testContactGetByUnknownUsername() {
// setup - mock the calls to CRM_Utils_System_*::getUfId
}
/**
- * Test TrueFalse format - I couldn't come up with an easy way to get an error on Get
+ * Test TrueFalse format - I couldn't come up with an easy way to get an error on Get.
*/
public function testContactGetFormatIsSuccessTrue() {
$this->createContactFromXML();
}
/**
- * test TrueFalse format.
+ * Test TrueFalse format.
*/
public function testContactCreateFormatIsSuccessFalse() {
}
/**
- * test Single Entity format.
+ * Test Single Entity format.
*/
- public function testContactGetSingle_entity_array() {
+ public function testContactGetSingleEntityArray() {
$this->createContactFromXML();
$description = "This demonstrates use of the 'format.single_entity_array' param.
/* This param causes the only contact to be returned as an array without the other levels.
/**
* Test Single Entity format.
*/
- public function testContactGetFormatCount_only() {
+ public function testContactGetFormatCountOnly() {
$this->createContactFromXML();
$description = "This demonstrates use of the 'getCount' action.\n"
. " *\n"
/**
* Test id only format.
*/
- public function testContactGetFormatID_only() {
+ public function testContactGetFormatIDOnly() {
$this->createContactFromXML();
$description = "This demonstrates use of the 'format.id_only' param.
/* This param causes the id of the only entity to be returned as an integer.
*
* (note that getquick api is required for autocomplete & has ACL permissions applied)
*/
- public function testGetquickPermission_CRM_13744() {
+ public function testGetquickPermissionCRM13744() {
CRM_Core_Config::singleton()->userPermissionClass->permissions = array('access CiviEvent');
$this->callAPIFailure('contact', 'getquick', array('name' => 'b', 'check_permissions' => TRUE));
CRM_Core_Config::singleton()->userPermissionClass->permissions = array('access CiviCRM');
}
/**
- * CRM-14743 - test api respects search operators
+ * CRM-14743 - test api respects search operators.
*/
public function testGetModifiedDateByOperators() {
$preExistingContactCount = CRM_Core_DAO::singleValueQuery('select count(*) FROM civicrm_contact');
}
/**
- * CRM-14743 - test api respects search operators
+ * CRM-14743 - test api respects search operators.
*/
public function testGetCreatedDateByOperators() {
$preExistingContactCount = CRM_Core_DAO::singleValueQuery('select count(*) FROM civicrm_contact');
}
/**
- * CRM-14263 check that API is not affected by search profile related bug
+ * CRM-14263 check that API is not affected by search profile related bug.
*/
public function testReturnCityProfile() {
$contactID = $this->individualCreate();
}
/**
- * Test contact.getactions
+ * Test contact getactions.
*/
public function testGetActions() {
$description = "Getting the available actions for an entity.";
class api_v3_ContributionSoftTest extends CiviUnitTestCase {
/**
- * Assume empty database with just civicrm_data
+ * Assume empty database with just civicrm_data.
*/
protected $_individualId; //the hard credit contact
protected $_softIndividual1Id; //the first soft credit contact
/**
- * civicrm_contribution_soft
+ * civicrm_contribution_soft.
*/
public function testCreateEmptyParamsContributionSoft() {
$softcontribution = $this->callAPIFailure('contribution_soft', 'create', array(),
}
/**
- * civicrm_contribution_soft_delete methods
+ * civicrm_contribution_soft_delete methods.
*
*/
public function testDeleteEmptyParamsContributionSoft() {
class api_v3_ContributionTest extends CiviUnitTestCase {
/**
- * Assume empty database with just civicrm_data
+ * Assume empty database with just civicrm_data.
*/
protected $_individualId;
protected $_contribution;
/**
* Sets up the fixture, for example, opens a network connection.
+ *
* This method is called before a test is executed.
*/
protected function setUp() {
);
}
- ///////////////// civicrm_domain_get methods
-
/**
- * Test civicrm_domain_get. Takes no params.
+ * Test civicrm_domain_get.
+ *
+ * Takes no params.
* Testing mainly for format.
*/
public function testGet() {
/**
* Test civicrm_domain_create with empty params.
+ *
* Error expected.
*/
public function testCreateWithEmptyParams() {
- $result = $this->callAPIFailure('domain', 'create', array());
+ $this->callAPIFailure('domain', 'create', array());
}
}
}
/**
- * If a new email is set to is_primary the prev should no longer be
+ * If a new email is set to is_primary the prev should no longer be.
*
* If is_primary is not set then it should become is_primary is no others exist
*/
}
/**
- * civicrm_entity_tag_get methods
+ * civicrm_entity_tag_get methods.
*/
public function testGetNoEntityID() {
$ContactId = $this->_individualID;
}
/**
- * civicrm_entity_tag_Delete methods
+ * civicrm_entity_tag_Delete methods.
*/
public function testEntityTagDeleteNoTagId() {
$entityTagParams = array(
}
/**
- * civicrm_tag_entities_get methods
+ * civicrm_tag_entities_get methods.
*/
public function testCommonContactEntityTagAdd() {
$params = array(
}
/**
- * civicrm_event_get methods
+ * civicrm_event_get methods.
*/
public function testGetEventById() {
$params = array(
}
/**
- * Legacy support for Contribution Type ID. We need to ensure this is supported
- * as an alias for financial_type_id
+ * Legacy support for Contribution Type ID.
+ *
+ * We need to ensure this is supported as an alias for financial_type_id.
*/
public function testCreateGetEventLegacyContributionTypeID() {
$contributionTypeArray = array('contribution_type_id' => 3);
$this->assertEquals($result['id'], $getresult['id']);
$this->callAPISuccess('event', 'delete', array('id' => $result['id']));
}
- ///////////////// 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
+ * and / or moved to the automated test suite.
*/
public function testCreateWithCustom() {
$ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__);
}
/**
- * Check event_id still supported for delete
+ * Check event_id still supported for delete.
*/
public function testDeleteWithEventId() {
$params = array(
///////////////// civicrm_event_search methods
/**
- * Test civicrm_event_search with wrong params type
+ * Test civicrm_event_search with wrong params type.
*/
public function testSearchWrongParamsType() {
$params = 'a string';
}
/**
- * Test civicrm_event_search. Success expected.
+ * Test civicrm_event_search.
+ *
+ * Success expected.
+ *
* return.offset and return.max_results test (CRM-5266)
*/
public function testSearchWithOffsetAndMaxResults() {
$result = $this->callAPIFailure('event', 'create', $params);
$this->assertEquals('API permission check failed for event/create call; insufficient permission: require access CiviCRM and access CiviEvent and edit all events', $result['error_message'], 'lacking permissions should not be enough to create an event');
- $config->userPermissionClass->permissions = array('access CiviEvent', 'edit all events', 'access CiviCRM');
+ $config->userPermissionClass->permissions = array(
+ 'access CiviEvent',
+ 'edit all events',
+ 'access CiviCRM',
+ );
$result = $this->callAPISuccess('event', 'create', $params);
}
}
/**
- * Test api_action param also works
+ * Test api_action param also works.
*/
public function testgetfieldsRest() {
$description = "demonstrate use of getfields to interrogate api";
/**
* Check checkbox type custom fields are created correctly.
+ *
* We want to ensure they are saved with separators as appropriate
*/
public function testCreateCustomCheckboxGrant() {
/**
* This is a test to check if setting fields one at a time alters other fields.
+ *
* Issues Hit so far =
* 1) Currency keeps getting reset to USD - BUT this may be the only enabled currency
* - in which case it is valid
}
/**
- * Create job with an invalid "run_frequency" value
+ * Create job with an invalid "run_frequency" value.
*/
public function testCreateWithInvalidFrequency() {
$params = array(
}
/**
- * 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
*/
}
/**
- * Test civicrm_mailing_create
+ * Test civicrm_mailing_create.
*/
public function testMailingABCreateSuccess() {
$result = $this->callAPIAndDocument($this->_entity, 'create', $this->_params, __FUNCTION__, __FILE__);
}
/**
- * Test civicrm_mailing_delete
+ * Test civicrm_mailing_delete.
*/
public function testMailerDeleteSuccess() {
$result = $this->callAPISuccess($this->_entity, 'create', $this->_params);
}
/**
- * Test civicrm_mailing_create
+ * Test civicrm_mailing_create.
*/
public function testMailerCreateSuccess() {
$result = $this->callAPIAndDocument('mailing', 'create', $this->_params, __FUNCTION__, __FILE__);
}
/**
- * Test civicrm_mailing_delete
+ * Test civicrm_mailing_delete.
*/
public function testMailerDeleteSuccess() {
$result = $this->callAPISuccess($this->_entity, 'create', $this->_params);
/**
- * Test civicrm_membership_status_get with empty params
+ * Test civicrm_membership_status_get with empty params.
*/
public function testGetEmptyParams() {
$result = $this->callAPISuccess('membership_status', 'get', array());
}
/**
- * If is_overide is passed in status must also be passed in
+ * If is_overide is passed in status must also be passed in.
*/
public function testCreateOverrideNoStatus() {
$params = $this->_params;
}
/**
- * Test civicrm_contact_memberships_create Invalid membership data
+ * Test civicrm_contact_memberships_create Invalid membership data.
* Error expected.
*/
public function testMembershipCreateInvalidMemData() {
}
/**
- * Test that if membership start date is not set it defaults to correct end date
+ * Test that if membership start date is not set it defaults to correct end date.
* - fixed
*/
public function testEmptyStartDateFixed() {
*/
class api_v3_MessageTemplateTest extends CiviUnitTestCase {
/**
- * Assume empty database with just civicrm_data
+ * Assume empty database with just civicrm_data.
*/
protected $entity = 'MessageTemplate';
protected $params;
}
/**
- * Test get function succeeds (this is actually largely tested in the get
- * action on create. Add extra checks for any 'special' return values or
+ * Test get function succeeds.
+ *
+ * This is actually largely tested in the get action on create.
+ *
+ * Add extra checks for any 'special' return values or
* behaviours
*/
public function testGet() {
}
/**
- * Check that domain_id is honoured
+ * Check that domain_id is honoured.
*/
public function testCreateOptionSpecifyDomain() {
$result = $this->callAPISuccess('option_group', 'get', array(
}
/**
- * Check that component_id is honoured
+ * Check that component_id is honoured.
*/
public function testCreateOptionSpecifyComponentID() {
$result = $this->callAPISuccess('option_group', 'get', array(
}
/**
- * Check that domain_id is honoured
+ * Check that domain_id is honoured.
*/
public function testCRM12133CreateOptionWeightNoValue() {
$optionGroup = $this->callAPISuccess(
}
/**
- * Check that domain_id is honoured
+ * Check that domain_id is honoured.
*/
public function testCreateOptionNoName() {
$optionGroup = $this->callAPISuccess('option_group', 'get', array(
}
/**
- * Check that pseudoconstant reflects new value added
- * and deleted
+ * Check that pseudoconstant reflects new value added.
*/
public function testCRM11876CreateOptionPseudoConstantUpdated() {
$optionGroupID = $this->callAPISuccess('option_group', 'getvalue', array(
///////////////// civicrm_participant_payment_create methods
/**
- * Test civicrm_participant_payment_create with wrong params type
+ * Test civicrm_participant_payment_create with wrong params type.
*/
public function testPaymentCreateWrongParamsType() {
$params = 'a string';
}
/**
- * Test civicrm_participant_payment_create with empty params
+ * Test civicrm_participant_payment_create with empty params.
*/
public function testPaymentCreateEmptyParams() {
$params = array();
}
/**
- * Check without contribution_id
+ * Check without contribution_id.
*/
public function testPaymentCreateMissingContributionId() {
//Without Payment EntityID
///////////////// civicrm_participant_payment_create methods
/**
- * Test civicrm_participant_payment_create with wrong params type
+ * Test civicrm_participant payment create with wrong params type.
*/
public function testPaymentUpdateWrongParamsType() {
$params = 'a string';
* Check with empty array.
*/
public function testPaymentUpdateEmpty() {
- $params = array();
- $participantPayment = $this->callAPIFailure('participant_payment', 'create', $params);
+ $this->callAPIFailure('participant_payment', 'create', array());
}
/**
- * Check with missing participant_id
+ * Check with missing participant_id.
*/
public function testPaymentUpdateMissingParticipantId() {
- //WithoutParticipantId
$params = array(
'contribution_id' => '3',
);
-
- $participantPayment = $this->callAPIFailure('participant_payment', 'create', $params);
+ $this->callAPIFailure('participant_payment', 'create', $params);
}
/**
- * Check with missing contribution_id
+ * Check with missing contribution_id.
*/
public function testPaymentUpdateMissingContributionId() {
$params = array(
$deletePayment = $this->callAPISuccess('participant_payment', 'delete', $params);
}
- ///////////////// civicrm_participant_payment_delete methods
/**
- * Test civicrm_participant_payment_delete with wrong params type
+ * Test civicrm_participant_payment_delete with wrong params type.
*/
public function testPaymentDeleteWrongParamsType() {
$params = 'a string';
- $result = $this->callAPIFailure('participant_payment', 'delete', $params);
+ $this->callAPIFailure('participant_payment', 'delete', $params);
}
/**
}
/**
- * Test civicrm_participant_get with empty params
+ * Test civicrm_participant_get with empty params.
*/
public function testGetEmptyParams() {
$this->callAPISuccess('participant', 'get', array());
}
/**
- * Check with participant_id
+ * Check with participant_id.
*/
public function testGetParticipantIdOnly() {
$params = array(
}
/**
- * Check with contact_id
+ * Check with contact_id.
*/
public function testGetContactIdOnly() {
$params = array(
}
/**
- * Check with event_id
+ * Check with event_id.
* fetch first record
*/
public function testGetMultiMatchReturnFirst() {
}
/**
- * Check with event_id
+ * Check with event_id.
* in v3 this should return all participants
*/
public function testGetMultiMatchNoReturnFirst() {
///////////////// civicrm_participant_get methods
/**
- * Test civicrm_participant_get with empty params
+ * Test civicrm_participant_get with empty params.
* In this case all the participant records are returned.
*/
public function testSearchEmptyParams() {
}
/**
- * Check with participant_id
+ * Check with participant_id.
*/
public function testSearchParticipantIdOnly() {
$params = array(
}
/**
- * Check with contact_id
+ * Check with contact_id.
*/
public function testSearchContactIdOnly() {
// Should get 2 participant records for this contact.
}
/**
- * Check with event_id
+ * Check with event_id.
*/
public 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
*/
public function testSearchByEventWithLimit() {
///////////////// civicrm_participant_create methods
/**
- * Test civicrm_participant_create with empty params
+ * Test civicrm_participant_create with empty params.
*/
public function testCreateEmptyParams() {
$params = array();
}
/**
- * Check with event_id
+ * Check with event_id.
*/
public function testCreateMissingContactID() {
$params = array(
}
/**
- * Check with contact_id
+ * Check with contact_id.
* without event_id
*/
public function testCreateMissingEventID() {
///////////////// civicrm_participant_update methods
/**
- * Test civicrm_participant_update with wrong params type
+ * Test civicrm_participant_update with wrong params type.
*/
public function testUpdateWrongParamsType() {
$params = 'a string';
}
/**
- * Check without event_id
+ * Check without event_id.
*/
public function testUpdateWithoutEventId() {
$participantId = $this->participantCreate(array('contactID' => $this->_individualId, 'eventID' => $this->_eventID));
///////////////// civicrm_participant_delete methods
/**
- * Test civicrm_participant_delete with wrong params type
+ * Test civicrm_participant_delete with wrong params type.
*/
public function testDeleteWrongParamsType() {
$params = 'a string';
}
/**
- * Test civicrm_participant_delete with empty params
+ * Test civicrm_participant_delete with empty params.
*/
public function testDeleteEmptyParams() {
$params = array();
}
/**
- * Check with participant_id
+ * Check with participant_id.
*/
public 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..
*/
}
/**
- * If a new phone is set to is_primary the prev should no longer be
+ * If a new phone is set to is_primary the prev should no longer be.
*
* If is_primary is not set then it should become is_primary is no others exist
*/
class api_v3_PledgePaymentTest extends CiviUnitTestCase {
/**
- * Assume empty database with just civicrm_data
+ * Assume empty database with just civicrm_data.
*/
protected $_individualId;
protected $_pledgeID;
}
/**
- * Test that creating a payment will add the contribution ID where only one pledge payment.
- * in schedule
+ * Test that creating a payment adds the contribution ID where only one pledge payment is in schedule.
*/
public function testCreatePledgePaymentWhereOnlyOnePayment() {
$pledgeParams = array(
class api_v3_PledgeTest extends CiviUnitTestCase {
/**
- * Assume empty database with just civicrm_data
+ * Assume empty database with just civicrm_data.
*/
protected $_individualId;
protected $_pledge;
$this->contactDelete($this->_individualId);
}
- ///////////////// 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
$result = $this->callAPISuccess($this->_entity, 'create', $params);
$this->assertAPISuccess($result, " testCreateWithCustom ");
- $this->assertAPISuccess($result, ' in line ' . __LINE__);
- $getparams = array('id' => $result['id'], 'return.custom_' . $ids['custom_field_id'] => 1);
- $check = $this->callAPISuccess($this->_entity, 'get', $getparams);
+ $this->assertAPISuccess($result);
+ $getParams = array('id' => $result['id'], 'return.custom_' . $ids['custom_field_id'] => 1);
+ $check = $this->callAPISuccess($this->_entity, 'get', $getParams);
$this->callAPISuccess('pledge', 'delete', array('id' => $check['id']));
- $this->assertEquals("custom string", $check['values'][$check['id']]['custom_' . $ids['custom_field_id']], ' in line ' . __LINE__);
+ $this->assertEquals("custom string", $check['values'][$check['id']]['custom_' . $ids['custom_field_id']]);
$this->customFieldDelete($ids['custom_field_id']);
$this->customGroupDelete($ids['custom_group_id']);
}
- public function testgetfieldspledge() {
+ /**
+ * Test getfields function for pledge.
+ */
+ public function testGetfieldsPledge() {
$result = $this->callAPISuccess('pledge', 'getfields', array('action' => 'get'));
$this->assertEquals(1, $result['values']['next_pay_date']['api.return']);
}
+ /**
+ * Test get pledge api.
+ */
public function testGetPledge() {
$this->_pledge = $this->callAPISuccess('pledge', 'create', $this->_params);
);
$result = $this->callAPIAndDocument('pledge', 'get', $params, __FUNCTION__, __FILE__);
$pledge = $result['values'][$this->_pledge['id']];
- $this->assertEquals($this->_individualId, $pledge['contact_id'], 'in line' . __LINE__);
- $this->assertEquals($this->_pledge['id'], $pledge['pledge_id'], 'in line' . __LINE__);
- $this->assertEquals(date('Y-m-d') . ' 00:00:00', $pledge['pledge_create_date'], 'in line' . __LINE__);
- $this->assertEquals(100.00, $pledge['pledge_amount'], 'in line' . __LINE__);
- $this->assertEquals('Pending', $pledge['pledge_status'], 'in line' . __LINE__);
- $this->assertEquals(5, $pledge['pledge_frequency_interval'], 'in line' . __LINE__);
- $this->assertEquals('year', $pledge['pledge_frequency_unit'], 'in line' . __LINE__);
- $this->assertEquals(date('Y-m-d', strtotime($this->scheduled_date)) . ' 00:00:00', $pledge['pledge_next_pay_date'], 'in line' . __LINE__);
- $this->assertEquals($pledge['pledge_next_pay_amount'], 20.00, 'in line' . __LINE__);
+ $this->assertEquals($this->_individualId, $pledge['contact_id']);
+ $this->assertEquals($this->_pledge['id'], $pledge['pledge_id']);
+ $this->assertEquals(date('Y-m-d') . ' 00:00:00', $pledge['pledge_create_date']);
+ $this->assertEquals(100.00, $pledge['pledge_amount']);
+ $this->assertEquals('Pending', $pledge['pledge_status']);
+ $this->assertEquals(5, $pledge['pledge_frequency_interval']);
+ $this->assertEquals('year', $pledge['pledge_frequency_unit']);
+ $this->assertEquals(date('Y-m-d', strtotime($this->scheduled_date)) . ' 00:00:00', $pledge['pledge_next_pay_date']);
+ $this->assertEquals($pledge['pledge_next_pay_amount'], 20.00);
$params2 = array(
'pledge_id' => $this->_pledge['id'],
}
/**
- * Test 'return.pledge_financial_type' => 1 works
+ * Test 'return.pledge_financial_type' => 1 works.
*/
- public function testGetPledgewithReturn() {
+ public function testGetPledgeWithReturn() {
$this->_pledge = $this->callAPISuccess('pledge', 'create', $this->_params);
$params = array(
}
/**
- * Test 'return.pledge_contribution_type' => 1 works
+ * Test 'return.pledge_contribution_type' => 1 works.
+ *
* This is for legacy compatibility
*/
- public function testGetPledgewithReturnLegacy() {
+ public function testGetPledgeWithReturnLegacy() {
$this->_pledge = $this->callAPISuccess('pledge', 'create', $this->_params);
$params = array(
$this->assertEquals('Donation', $pledge['pledge_financial_type']);
}
+ /**
+ * Test date legacy date filters like pledge_start_date_high.
+ */
public function testPledgeGetReturnFilters() {
- $oldPledge = $this->callAPISuccess('pledge', 'create', $this->_params);
+ $this->callAPISuccess('pledge', 'create', $this->_params);
$overdueParams = array(
'scheduled_date' => 'first saturday of march last year',
}
/**
- * create 2 pledges - see if we can get by status id
+ * Create 2 pledges - see if we can get by status id.
*/
public function testGetOverduePledge() {
$overdueParams = array(
/**
- * create 2 pledges - see if we can get by status id
+ * Create 2 pledges - see if we can get by status id.
*/
public function testSortParamPledge() {
$pledge1 = $this->callAPISuccess('pledge', 'create', $this->_params);
public function testCreatePledge() {
$result = $this->callAPIAndDocument('pledge', 'create', $this->_params, __FUNCTION__, __FILE__);
- $this->assertEquals($result['values'][0]['amount'], 100.00, 'In line ' . __LINE__);
- $this->assertEquals($result['values'][0]['installments'], 5, 'In line ' . __LINE__);
- $this->assertEquals($result['values'][0]['frequency_unit'], 'year', 'In line ' . __LINE__);
- $this->assertEquals($result['values'][0]['frequency_interval'], 5, 'In line ' . __LINE__);
- $this->assertEquals($result['values'][0]['frequency_day'], 15, 'In line ' . __LINE__);
- $this->assertEquals($result['values'][0]['original_installment_amount'], 20, 'In line ' . __LINE__);
- $this->assertEquals($result['values'][0]['status_id'], 2, 'In line ' . __LINE__);
- $this->assertEquals($result['values'][0]['create_date'], date('Ymd') . '000000', 'In line ' . __LINE__);
- $this->assertEquals($result['values'][0]['start_date'], date('Ymd') . '000000', 'In line ' . __LINE__);
- $this->assertAPISuccess($result, 'In line ' . __LINE__);
+ $this->assertEquals($result['values'][0]['amount'], 100.00);
+ $this->assertEquals($result['values'][0]['installments'], 5);
+ $this->assertEquals($result['values'][0]['frequency_unit'], 'year');
+ $this->assertEquals($result['values'][0]['frequency_interval'], 5);
+ $this->assertEquals($result['values'][0]['frequency_day'], 15);
+ $this->assertEquals($result['values'][0]['original_installment_amount'], 20);
+ $this->assertEquals($result['values'][0]['status_id'], 2);
+ $this->assertEquals($result['values'][0]['create_date'], date('Ymd') . '000000');
+ $this->assertEquals($result['values'][0]['start_date'], date('Ymd') . '000000');
+ $this->assertAPISuccess($result);
$payments = $this->callAPISuccess('PledgePayment', 'Get', array('pledge_id' => $result['id'], 'sequential' => 1));
- $this->assertAPISuccess($payments, 'In line ' . __LINE__);
- $this->assertEquals($payments['count'], 5, 'In line ' . __LINE__);
- require_once 'CRM/Utils/Date.php';
+ $this->assertAPISuccess($payments);
+ $this->assertEquals($payments['count'], 5);
$shouldBeDate = CRM_Utils_Date::format(CRM_Utils_Date::intervalAdd('year', 5 * 4, $this->scheduled_date), "-");
- $this->assertEquals(substr($shouldBeDate, 0, 10), substr($payments['values'][4]['scheduled_date'], 0, 10), 'In line ' . __LINE__);
+ $this->assertEquals(substr($shouldBeDate, 0, 10), substr($payments['values'][4]['scheduled_date'], 0, 10));
$pledgeID = array('id' => $result['id']);
$pledge = $this->callAPISuccess('pledge', 'delete', $pledgeID);
'pledge_id' => $pledge['id'],
'sequential' => 1,
));
- $this->assertEquals($payments['count'], 5, 'In line ' . __LINE__);
- $this->assertEquals('2011-07-06 00:00:00', $payments['values'][4]['scheduled_date'], 'In line ' . __LINE__);
+ $this->assertEquals($payments['count'], 5);
+ $this->assertEquals('2011-07-06 00:00:00', $payments['values'][4]['scheduled_date']);
$this->callAPISuccess('pledge', 'delete', array('pledge_id' => $pledge['id']));
}
'pledge_id' => $pledge['id'],
'sequential' => 1,
));
- $this->assertEquals(1, $payments['count'], 'In line ' . __LINE__);
- $this->assertEquals(2, $payments['values'][0]['status_id'], 'In line ' . __LINE__);
+ $this->assertEquals(1, $payments['count']);
+ $this->assertEquals(2, $payments['values'][0]['status_id']);
$pledgeID = array('id' => $pledge['id']);
$pledge = $this->callAPISuccess('pledge', 'delete', $pledgeID);
}
/**
- * test that using original_installment_amount rather than pledge_original_installment_amount works
- * Pledge field behaviour is a bit random & so pledge has come to try to handle both unique & non -unique fields
+ * Test that using original_installment_amount rather than pledge_original_installment_amount works.
+ *
+ * Pledge field behaviour is a bit random & so pledge has come to try to handle both unique & non -unique fields.
*/
public function testCreatePledgeWithNonUnique() {
$params = $this->_params;
$result = $this->callAPISuccess('pledge', 'create', $params);
$pledgeDetails = $this->callAPISuccess('Pledge', 'Get', array('id' => $result['id'], 'sequential' => 1));
$pledge = $pledgeDetails['values'][0];
- $this->assertEquals(100.00, $pledge['pledge_amount'], 'In line ' . __LINE__);
- $this->assertEquals('year', $pledge['pledge_frequency_unit'], 'In line ' . __LINE__);
- $this->assertEquals(5, $pledge['pledge_frequency_interval'], 'In line ' . __LINE__);
- $this->assertEquals(20, $pledge['pledge_next_pay_amount'], 'In line ' . __LINE__);
+ $this->assertEquals(100.00, $pledge['pledge_amount']);
+ $this->assertEquals('year', $pledge['pledge_frequency_unit']);
+ $this->assertEquals(5, $pledge['pledge_frequency_interval']);
+ $this->assertEquals(20, $pledge['pledge_next_pay_amount']);
$pledgeID = array('id' => $result['id']);
$pledge = $this->callAPISuccess('pledge', 'delete', $pledgeID);
}
+ /**
+ * Test cancelling a pledge.
+ */
public function testCreateCancelPledge() {
$result = $this->callAPISuccess('pledge', 'create', $this->_params);
- $this->assertEquals(2, $result['values'][0]['status_id'], "in line " . __LINE__);
- $cancelparams = array('sequential' => 1, 'id' => $result['id'], 'pledge_status_id' => 3);
- $result = $this->callAPISuccess('pledge', 'create', $cancelparams);
- $this->assertEquals(3, $result['values'][0]['status_id'], "in line " . __LINE__);
+ $this->assertEquals(2, $result['values'][0]['status_id']);
+ $cancelParams = array(
+ 'sequential' => 1,
+ 'id' => $result['id'],
+ 'pledge_status_id' => 3,
+ );
+ $result = $this->callAPISuccess('pledge', 'create', $cancelParams);
+ $this->assertEquals(3, $result['values'][0]['status_id']);
$pledgeID = array('id' => $result['id']);
- $pledge = $this->callAPISuccess('pledge', 'delete', $pledgeID);
+ $this->callAPISuccess('pledge', 'delete', $pledgeID);
}
/**
unset($params['status_id']);
unset($params['pledge_status_id']);
$result = $this->callAPISuccess('pledge', 'create', $params);
- $this->assertAPISuccess($result, "in line " . __LINE__);
- $this->assertEquals(2, $result['values'][0]['status_id'], "in line " . __LINE__);
+ $this->assertAPISuccess($result);
+ $this->assertEquals(2, $result['values'][0]['status_id']);
$pledgeID = array('pledge_id' => $result['id']);
$pledge = $this->callAPISuccess('pledge', 'delete', $pledgeID);
}
);
$original = $this->callAPISuccess('pledge', 'get', $old_params);
//Make sure it came back
- $this->assertEquals($original['values'][0]['pledge_id'], $pledgeID, 'In line ' . __LINE__);
+ $this->assertEquals($original['values'][0]['pledge_id'], $pledgeID);
//set up list of old params, verify
$old_contact_id = $original['values'][0]['contact_id'];
$old_frequency_unit = $original['values'][0]['pledge_frequency_unit'];
$old_status_id = $original['values'][0]['pledge_status'];
//check against values in CiviUnitTestCase::createPledge()
- $this->assertEquals($old_contact_id, $this->_individualId, 'In line ' . __LINE__);
- $this->assertEquals($old_frequency_unit, 'year', 'In line ' . __LINE__);
- $this->assertEquals($old_frequency_interval, 5, 'In line ' . __LINE__);
- $this->assertEquals($old_status_id, 'Pending', 'In line ' . __LINE__);
+ $this->assertEquals($old_contact_id, $this->_individualId);
+ $this->assertEquals($old_frequency_unit, 'year');
+ $this->assertEquals($old_frequency_interval, 5);
+ $this->assertEquals($old_status_id, 'Pending');
$params = array(
'id' => $pledgeID,
'contact_id' => $this->_individualId,
'id' => $pledge['id'],
);
$pledge = $this->callAPISuccess('pledge', 'get', $new_params);
- $this->assertEquals($pledge['values'][$pledgeID]['contact_id'], $this->_individualId, 'In line ' . __LINE__);
- $this->assertEquals($pledge['values'][$pledgeID]['pledge_status'], 'Cancelled', 'In line ' . __LINE__);
+ $this->assertEquals($pledge['values'][$pledgeID]['contact_id'], $this->_individualId);
+ $this->assertEquals($pledge['values'][$pledgeID]['pledge_status'], 'Cancelled');
$pledge = $this->callAPISuccess('pledge', 'delete', $new_params);
}
/**
- * Here we ensure we are maintaining our 'contract' & supporting previously working syntax
- * ie contribution_type_id
+ * Here we ensure we are maintaining our 'contract' & supporting previously working syntax.
+ *
+ * ie contribution_type_id.
+ *
+ * We test 'sequential' param here too.
*/
public function testCreateUpdatePledgeLegacy() {
-
- // we test 'sequential' param here too
$pledgeID = $this->pledgeCreate($this->_individualId);
$old_params = array(
'id' => $pledgeID,
'sequential' => 1,
);
$original = $this->callAPISuccess('pledge', 'get', $old_params);
- //Make sure it came back
- $this->assertEquals($original['values'][0]['pledge_id'], $pledgeID, 'In line ' . __LINE__);
- //set up list of old params, verify
+ // Make sure it came back.
+ $this->assertEquals($original['values'][0]['pledge_id'], $pledgeID);
+ // Set up list of old params, verify.
$old_contact_id = $original['values'][0]['contact_id'];
$old_frequency_unit = $original['values'][0]['pledge_frequency_unit'];
$old_frequency_interval = $original['values'][0]['pledge_frequency_interval'];
$old_status_id = $original['values'][0]['pledge_status'];
- //check against values in CiviUnitTestCase::createPledge()
- $this->assertEquals($old_contact_id, $this->_individualId, 'In line ' . __LINE__);
- $this->assertEquals($old_frequency_unit, 'year', 'In line ' . __LINE__);
- $this->assertEquals($old_frequency_interval, 5, 'In line ' . __LINE__);
- $this->assertEquals($old_status_id, 'Pending', 'In line ' . __LINE__);
+ // Check against values in CiviUnitTestCase::createPledge().
+ $this->assertEquals($old_contact_id, $this->_individualId);
+ $this->assertEquals($old_frequency_unit, 'year');
+ $this->assertEquals($old_frequency_interval, 5);
+ $this->assertEquals($old_status_id, 'Pending');
$params = array(
'id' => $pledgeID,
'contact_id' => $this->_individualId,
'id' => $pledge['id'],
);
$pledge = $this->callAPISuccess('pledge', 'get', $new_params);
- $this->assertEquals($pledge['values'][$pledgeID]['contact_id'], $this->_individualId, 'In line ' . __LINE__);
- $this->assertEquals($pledge['values'][$pledgeID]['pledge_status'], 'Cancelled', 'In line ' . __LINE__);
- $pledge = $this->callAPISuccess('pledge', 'delete', $new_params);
+ $this->assertEquals($pledge['values'][$pledgeID]['contact_id'], $this->_individualId);
+ $this->assertEquals($pledge['values'][$pledgeID]['pledge_status'], 'Cancelled');
+ $this->callAPISuccess('pledge', 'delete', $new_params);
}
+ /**
+ * Failure test for delete without id.
+ */
public function testDeleteEmptyParamsPledge() {
- $pledge = $this->callAPIFailure('pledge', 'delete', array(), 'Mandatory key(s) missing from params array: id');
+ $this->callAPIFailure('pledge', 'delete', array(), 'Mandatory key(s) missing from params array: id');
}
+ /**
+ * Failure test for invalid pledge id.
+ */
public function testDeleteWrongParamPledge() {
$params = array(
'pledge_source' => 'SSF',
);
- $pledge = $this->callAPIFailure('pledge', 'delete', $params, 'Mandatory key(s) missing from params array: id');
+ $this->callAPIFailure('pledge', 'delete', $params, 'Mandatory key(s) missing from params array: id');
}
/**
- * Legacy support for pledge_id
+ * Legacy support for pledge_id.
*/
public function testDeletePledge() {
}
/**
- * Std is to accept id.
+ * Standard is to accept id.
*/
public function testDeletePledgeUseID() {
$params = array(
'id' => $pledgeID,
);
- $result = $this->callAPIAndDocument('pledge', 'delete', $params, __FUNCTION__, __FILE__);
+ $this->callAPIAndDocument('pledge', 'delete', $params, __FUNCTION__, __FILE__);
}
/**
* 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
*/
public function testGetEmpty() {
- $result = $this->callAPISuccess('pledge', 'create', $this->_params);
+ $this->callAPISuccess('pledge', 'create', $this->_params);
$result = $this->callAPISuccess('pledge', 'get', array());
$this->assertAPISuccess($result, "This test is failing because it's acting like a contact get when no params set. Not sure the fix");
$this->assertEquals(1, $result['count'], 'in line ' . __LINE__);
$pledgeID = array('id' => $result['id']);
- $pledge = $this->callAPISuccess('pledge', 'delete', $pledgeID);
+ $this->callAPISuccess('pledge', 'delete', $pledgeID);
}
}
public $DBResetRequired = TRUE;
+ /**
+ * Set up for class.
+ */
public function setUp() {
parent::setUp();
$this->_params = array(
- # [domain_id] =>
'name' => 'default_goat_priceset',
'title' => 'Goat accessories',
'is_active' => 1,
}
/**
+ * Test create price set.
*/
public function testCreatePriceSet() {
$result = $this->callAPIAndDocument($this->_entity, 'create', $this->_params, __FUNCTION__, __FILE__);
}
/**
- * Check that no name doesn't cause failure
+ * Check that no name doesn't cause failure.
*/
public function testCreatePriceSetNoName() {
$params = $this->_params;
unset($params['name']);
- $result = $this->callAPISuccess($this->_entity, 'create', $params);
+ $this->callAPISuccess($this->_entity, 'create', $params);
}
/**
}
/**
- * Check with valid data with contact_b
+ * Check with valid data with contact_b.
*/
public function testGetRelationshipWithContactB() {
$relParams = array(
}
/**
+ * Test relationship get by membership type.
+ *
* Checks that passing in 'contact_id_b' + a relationship type
* will filter by relationship type for contact b
*
}
/**
+ * Test getrows on contact summary report.
*/
public function testReportTemplateGetRowsContactSummary() {
$description = "Retrieve rows from a report template (optionally providing the instance_id)";
}
/**
+ * Tet api to get rows from reports.
+ *
* @dataProvider getReportTemplates
+ *
* @param $reportID
+ *
* @throws \PHPUnit_Framework_IncompleteTestError
*/
public function testReportTemplateGetRowsAllReports($reportID) {
if (stristr($reportID, 'has existing issues')) {
$this->markTestIncomplete($reportID);
}
- $result = $this->callAPISuccess('report_template', 'getrows', array(
+ $this->callAPISuccess('report_template', 'getrows', array(
'report_id' => $reportID,
));
}
/**
+ * Test get statistics.
+ *
* @dataProvider getReportTemplates
+ *
* @param $reportID
+ *
* @throws \PHPUnit_Framework_IncompleteTestError
*/
public function testReportTemplateGetStatisticsAllReports($reportID) {
}
/**
- * Data provider function for getting all templates, note that the function needs to
+ * Data provider function for getting all templates.
+ *
+ * Note that the function needs to
* be static so cannot use $this->callAPISuccess
*/
public static function getReportTemplates() {
}
/**
- * Test get function succeeds (this is actually largely tested in the get
+ * Test get function succeeds.
+ *
+ * This is actually largely tested in the get
* action on create. Add extra checks for any 'special' return values or
* behaviours
*/
}
/**
- * 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)
+ * test generated examples. (these are to be found in the api/examples folder).
*/
public function testGetSurveyChainDelete() {
$description = "demonstrates get + delete in the same call";
/**
- * Verify that HTML metacharacters provided as inputs appear consistently
+ * Verify that HTML metacharacters provided as inputs appear consistently.
* as outputs.
*
* At time of writing, the encoding scheme requires (for example) that an
/**
* Sets up the fixture, for example, opens a network connection.
+ *
* This method is called before a test is executed.
*/
protected function setUp() {
$this->useTransaction(TRUE);
}
- ///////////////// civicrm_domain_get methods
-
/**
* Test system flush.
*/
}
/**
- * Test civicrm_tag_create
+ * Test civicrm_tag_create.
*/
public function testCreatePasstagInParams() {
$params = array(
}
/**
- * Test civicrm_tag_create activity tag- success expected. Test checks that used_for is set
- * and not over-written by default on update
+ * Test civicrm_tag_create activity tag- success expected.
+ *
+ * Test checks that used_for is set and not over-written by default on update.
*/
public function testCreateEntitySpecificTag() {
$params = array(
/**
* Sets up the fixture, for example, opens a network connection.
+ *
* This method is called before a test is executed.
*/
protected function setUp() {
/* ------------ Assertions ------------ */
/**
- * Assert "result" contains an API error
+ * Assert "result" contains an API error.
* @param result
*/
function assertApiError(result) {
projects / civicrm-core.git / commitdiff