* @param int $contactID
* The contactID for whom the check is made.
*
- * @return boolean true if yes, else false
+ * @return boolean
+ * true if yes, else false
* @static
*/
public static function check($str, $contactID = NULL) {
* Don't add delete clause if this is true,.
* this means it is handled by generating query
*
- * @return string the group where clause for this user
+ * @return string
+ * the group where clause for this user
*/
public static function whereClause(
$type,
* @param null $allGroups
* @param null $includedGroups
*
- * @return array the ids of the groups for which the user has permissions
+ * @return array
+ * the ids of the groups for which the user has permissions
*/
public static function group(
$type,
* @param null $includedGroups
* @param bool $flush
*
- * @return array the ids of the groups for which the user has permissions
+ * @return array
+ * the ids of the groups for which the user has permissions
*/
public static function groupPermission(
$type,
* @param bool $acl_role
* For grant operations, this flag determines if we're granting a single acl (false) or an entire group.
*
- * @return string - The WHERE clause, or 0 on failure
+ * @return string
+ * The WHERE clause, or 0 on failure
* @static
*/
public static function permissionClause(
* @param bool $hideEmpty
* Only return elements that have a value set.
*
- * @return array - Assoc. array of the ACL rule's properties
+ * @return array
+ * Assoc. array of the ACL rule's properties
*/
public function toArray($format = '%s', $hideEmpty = FALSE) {
$result = array();
* @param bool $aclRoles
* Should we include ACL Roles.
*
- * @return array - Array of assoc. arrays of ACL rules
+ * @return array
+ * Array of assoc. arrays of ACL rules
* @static
*/
public static function &getACLs($contact_id = NULL, $group_id = NULL, $aclRoles = FALSE) {
* @param int $group_id
* ID of a group to search for.
*
- * @return array - Array of assoc. arrays of ACL rules
+ * @return array
+ * Array of assoc. arrays of ACL rules
* @static
*/
public static function &getACLRoles($contact_id = NULL, $group_id = NULL) {
* @param bool $aclRoles
* Include ACL Roles?.
*
- * @return array - Assoc array of ACL rules
+ * @return array
+ * Assoc array of ACL rules
* @static
*/
public static function &getGroupACLs($contact_id, $aclRoles = FALSE) {
* @param int $contact_id
* ID of a contact to search for.
*
- * @return array - Array of assoc. arrays of ACL rules
+ * @return array
+ * Array of assoc. arrays of ACL rules
* @static
*/
public static function &getGroupACLRoles($contact_id) {
* @param int $contact_id
* The contact ID.
*
- * @return array - Assoc array of ACL rules
+ * @return array
+ * Assoc array of ACL rules
* @static
*/
public static function &getAllByContact($contact_id) {
* @param bool $is_active
* Value we want to set the is_active field.
*
- * @return Object DAO object on sucess, null otherwise
+ * @return Object
+ * DAO object on sucess, null otherwise
* @static
*/
public static function setIsActive($id, $is_active) {
* @param bool $is_active
* Value we want to set the is_active field.
*
- * @return Object DAO object on sucess, null otherwise
+ * @return Object
+ * DAO object on sucess, null otherwise
* @static
*/
public static function setIsActive($id, $is_active) {
* This function should be shared from a similar one in
* distmaker/utils/joomlaxml.php
*
- * @return array civicrm permissions
+ * @return array
+ * civicrm permissions
*/
public static function getPermissionArray() {
global $civicrm_root;
/**
* Get BAO Name
*
- * @return string Classname of BAO.
+ * @return string
+ * Classname of BAO.
*/
public function getBAOName() {
return 'CRM_ACL_BAO_ACL';
/**
* Get action Links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
*/
public function &links() {
if (!(self::$_links)) {
/**
* Get name of edit form
*
- * @return string Classname of edit form.
+ * @return string
+ * Classname of edit form.
*/
public function editForm() {
return 'CRM_ACL_Form_ACL';
/**
* Get edit form name
*
- * @return string name of this page.
+ * @return string
+ * name of this page.
*/
public function editName() {
return 'ACL';
*
* @param null $mode
*
- * @return string user context.
+ * @return string
+ * user context.
*/
public function userContext($mode = NULL) {
return 'civicrm/acl';
/**
* Get BAO Name
*
- * @return string Classname of BAO.
+ * @return string
+ * Classname of BAO.
*/
public function getBAOName() {
return 'CRM_ACL_BAO_ACL';
/**
* Get action Links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
*/
public function &links() {
if (!(self::$_links)) {
/**
* Get name of edit form
*
- * @return string Classname of edit form.
+ * @return string
+ * Classname of edit form.
*/
public function editForm() {
return 'CRM_ACL_Form_ACLBasic';
/**
* Get edit form name
*
- * @return string name of this page.
+ * @return string
+ * name of this page.
*/
public function editName() {
return 'Core ACLs';
*
* @param null $mode
*
- * @return string user context.
+ * @return string
+ * user context.
*/
public function userContext($mode = NULL) {
return 'civicrm/acl/basic';
/**
* Get BAO Name
*
- * @return string Classname of BAO.
+ * @return string
+ * Classname of BAO.
*/
public function getBAOName() {
return 'CRM_ACL_BAO_EntityRole';
/**
* Get action Links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
*/
public function &links() {
if (!(self::$_links)) {
/**
* Get name of edit form
*
- * @return string Classname of edit form.
+ * @return string
+ * Classname of edit form.
*/
public function editForm() {
return 'CRM_ACL_Form_EntityRole';
/**
* Get edit form name
*
- * @return string name of this page.
+ * @return string
+ * name of this page.
*/
public function editName() {
return 'ACL EntityRole';
*
* @param null $mode
*
- * @return string user context.
+ * @return string
+ * user context.
*/
public function userContext($mode = NULL) {
return 'civicrm/acl/entityrole';
* - context string page on which selector is build
* - activity_type_id int|string the activitiy types we want to restrict by
*
- * @return array (reference) $values the relevant data object values of open activities
+ * @return array
+ * (reference) $values the relevant data object values of open activities
*
* @static
*/
* user has permission. To decide whether we are going to include
* component related activities w/ core activity retrieve process.
*
- * @return array of component id and name.
+ * @return array
+ * of component id and name.
* @static
**/
public static function activityComponents() {
* - context string page on which selector is build
* - activity_type_id int|string the activity types we want to restrict by
*
- * @return int count of activities
+ * @return int
+ * count of activities
*
* @static
*/
* - count boolean are we interested in the count clause only?
* - activity_type_id int|string the activity types we want to restrict by
*
- * @return int count of activities
+ * @return int
+ * count of activities
*
* @static
*/
* @param string $additionalDetails
* The additional information of CC and BCC appended to the activity Details.
*
- * @return array ( sent, activityId) if any email is sent and activityId
+ * @return array
+ * ( sent, activityId) if any email is sent and activityId
* @static
*/
static function sendEmail(
* @param null $cc
* @param null $bcc
*
- * @return boolean true if successfull else false.
+ * @return boolean
+ * true if successfull else false.
* @static
*/
static function sendMessage(
*
* @param bool $status
*
- * @return array array of importable Fields
+ * @return array
+ * array of importable Fields
* @static
*/
public static function &importableFields($status = FALSE) {
* @param int $contactId
* Id of the contact whose activities need to find.
*
- * @return array array of activity fields
+ * @return array
+ * array of activity fields
*/
public static function getContactActivity($contactId) {
$activities = array();
* @param int $activityId
* Current activity id.
*
- * @return int $parentId Id of parent activity otherwise false.
+ * @return int
+ * $parentId Id of parent activity otherwise false.
*/
public static function getParentActivity($activityId) {
static $parentActivities = array();
* @param $activityID
* Current activity id.
*
- * @return int $params count of prior activities otherwise false.
+ * @return int
+ * $params count of prior activities otherwise false.
*/
public static function getPriorCount($activityID) {
static $priorCounts = array();
* Current activity id.
* @param bool $onlyPriorRevisions
*
- * @return array $result prior activities info.
+ * @return array
+ * prior activities info.
*/
public static function getPriorAcitivities($activityID, $onlyPriorRevisions = FALSE) {
static $priorActivities = array();
* @param int $activityID
* Prior activity id.
*
- * @return int current activity id.
+ * @return int
+ * current activity id.
*/
public static function getLatestActivityId($activityID) {
static $latestActivityIds = array();
* @param string $name
* If it is called by case $name = Case else $name = Activity.
*
- * @return array array of exportable Fields
+ * @return array
+ * array of exportable Fields
* @static
*/
public static function &exportableFields($name = 'Activity') {
/**
* Get the allowed profile fields for Activities
*
- * @return array array of activity profile Fields
+ * @return array
+ * array of activity profile Fields
*/
public static function getProfileFields() {
$exportableFields = self::exportableFields('Activity');
* @param int $action
* Edit/view.
*
- * @return boolean $allow true/false
+ * @return boolean
*/
public static function checkPermission($activityId, $action) {
$allow = FALSE;
* @param array $params
* Associated array for params record id.
*
- * @return array $contactActivities associated array of contact activities
+ * @return array
+ * associated array of contact activities
*/
public static function getContactActivitySelector(&$params) {
// format the params
* @param array $params
* (reference ) an assoc array of name/value pairs.
*
- * @return object activity type of object that is added
+ * @return object
+ * activity type of object that is added
*/
public static function create(&$params) {
$assignment = new CRM_Activity_BAO_ActivityContact();
* @param array $params
* The values for this table: activity id, contact id, record type.
*
- * @return object activity_contact object
+ * @return object
+ * activity_contact object
*
*/
public static function create(&$params) {
*
* @param array $params
*
- * @return object activity type of object that is added
+ * @return object
+ * activity type of object that is added
*/
public static function create(&$params) {
$target = new CRM_Activity_BAO_ActivityContact();
* @param array $contacts
* Array of contacts (attendees).
*
- * @return string Array index of the added attachment in the $attachments array, or else NULL.
+ * @return string
+ * Array index of the added attachment in the $attachments array, or else NULL.
*/
public function addAttachment(&$attachments, $contacts) {
// Check preferences setting
*
* access public
*
- * @return array reference to the array of default values
+ * @return array
+ * reference to the array of default values
*
*/
/**
*
* access public
*
- * @return array reference to the array of default values
+ * @return array
+ * reference to the array of default values
*
*/
/**
* @param array $fields
* Posted values of the form.
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($fields) {
* @param array $fields
* Posted values of the form.
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($fields) {
* @param array $fields
* Posted values of the form.
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($fields) {
/**
* Format the field values for input to the api
*
- * @return array (reference ) associative array of name/value pairs
+ * @return array
+ * (reference ) associative array of name/value pairs
*/
public function &getActiveFieldParams() {
$params = array();
* @param array $values
* The array of values belonging to this line.
*
- * @return boolean the result of this processing
+ * @return boolean
+ * the result of this processing
*/
public function preview(&$values) {
return $this->summary($values);
* @param array $values
* The array of values belonging to this line.
*
- * @return boolean the result of this processing
+ * @return boolean
+ * the result of this processing
*/
public function summary(&$values) {
$erroneousField = NULL;
* @param array $values
* The array of values belonging to this line.
*
- * @return boolean the result of this processing
+ * @return boolean
+ * the result of this processing
*/
public function import($onDuplicate, &$values) {
// first make sure this is a valid line
* @param enum $output
* What should the result set include (web/email/csv).
*
- * @return array the column headers that need to be displayed
+ * @return array
+ * the column headers that need to be displayed
*/
public function &getColumnHeaders($action = NULL, $output = NULL) {
if ($output == CRM_Core_Selector_Controller::EXPORT || $output == CRM_Core_Selector_Controller::SCREEN) {
*
* @param null $case
*
- * @return int Total number of rows
+ * @return int
+ * Total number of rows
*/
public function getTotalCount($action, $case = NULL) {
$params = array(
*
* @param null $case
*
- * @return int the total number of rows for this action
+ * @return int
+ * the total number of rows for this action
*/
public function &getRows($action, $offset, $rowCount, $sort, $output = NULL, $case = NULL) {
$params = array(
* @param string $output
* Type of output.
*
- * @return string name of the file
+ * @return string
+ * name of the file
*/
public function getExportFileName($output = 'csv') {
return ts('CiviCRM Activity');
* Get colunmn headers for search selector
*
*
- * @return array $_columnHeaders
+ * @return array
*/
private static function &_getColumnHeaders() {
if (!isset(self::$_columnHeaders)) {
*
* @param
*
- * @return int Total number of rows
+ * @return int
+ * Total number of rows
*/
public function getTotalCount($action) {
return $this->_query->searchQuery(0, 0, NULL,
* @param enum $output
* What should the result set include (web/email/csv).
*
- * @return array rows in the given offset and rowCount
+ * @return array
+ * rows in the given offset and rowCount
*/
public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
$result = $this->_query->searchQuery(
}
/**
- * @return array $qill which contains an array of strings
+ * @return array
+ * which contains an array of strings
*/
public function getQILL() {
return $this->_query->qill();
* @param enum $output
* What should the result set include (web/email/csv).
*
- * @return array the column headers that need to be displayed
+ * @return array
+ * the column headers that need to be displayed
*/
public function &getColumnHeaders($action = NULL, $output = NULL) {
if (!isset(self::$_columnHeaders)) {
* @param string $output
* Type of output.
*
- * @return string name of the file
+ * @return string
+ * name of the file
*/
public function getExportFileName($output = 'csv') {
return ts('CiviCRM Activity Search');
*
* @param string $formName
*
- * @return string the name of the form that will handle the task
+ * @return string
+ * the name of the form that will handle the task
*/
public function taskName($controller, $formName = 'Search') {
// total hack, check POST vars and then session to determine stuff
* These tasks are the core set of tasks that the user can perform
* on a contact / group of contacts
*
- * @return array the set of tasks for a group of contacts
+ * @return array
+ * the set of tasks for a group of contacts
* @static
*/
public static function &tasks() {
* These tasks are the core set of task titles
* on activity
*
- * @return array the set of task titles
+ * @return array
+ * the set of task titles
* @static
*/
public static function &taskTitles() {
*
* @param int $permission
*
- * @return array set of tasks that are valid for the user
+ * @return array
+ * set of tasks that are valid for the user
*/
public static function &permissionedTaskTitles($permission) {
$tasks = array();
*
* @param int $value
*
- * @return array the set of tasks for a group of activity
+ * @return array
+ * the set of tasks for a group of activity
* @static
*/
public static function getTask($value) {
* @param array $fields
* Posted values of the form.
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($fields) {
* @param array $self
* Current form object.
*
- * @return array array of errors / empty array.
+ * @return array
+ * array of errors / empty array.
* @static
*/
public static function formRule($fields, $files, $self) {
* @param array $fields
* Posted values of the form.
*
- * @return array if errors then list of errors to be posted back to the form,
+ * @return array
+ * if errors then list of errors to be posted back to the form,
* true otherwise
* @static
*/
* @param array $fields
* Posted values of the form.
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($fields) {
* @param array $values
* Posted values of the form.
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($values) {
*
* @param null $mode
*
- * @return string user context.
+ * @return string
+ * user context.
*/
public function userContext($mode = NULL) {
return 'civicrm/api/doc';
/**
* Get user context.
*
- * @return string user context.
+ * @return string
+ * user context.
*/
public function userContext() {
return 'civicrm/api/explorer';
/**
* Get BAO Name
*
- * @return string Classname of BAO.
+ * @return string
+ * Classname of BAO.
*/
public function getBAOName() {
return 'CRM_Contact_BAO_ContactType';
/**
* Get action Links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
*/
public function &links() {
if (!(self::$_links)) {
/**
* Get name of edit form
*
- * @return string Classname of edit form.
+ * @return string
+ * Classname of edit form.
*/
public function editForm() {
return 'CRM_Admin_Form_ContactType';
/**
* Get edit form name
*
- * @return string name of this page.
+ * @return string
+ * name of this page.
*/
public function editName() {
return 'Contact Types';
*
* @param null $mode
*
- * @return string user context.
+ * @return string
+ * user context.
*/
public function userContext($mode = NULL) {
return 'civicrm/admin/options/subtype';
/**
* Get BAO Name
*
- * @return string Classname of BAO.
+ * @return string
+ * Classname of BAO.
*/
public function getBAOName() {
return 'CRM_Event_BAO_Event';
/**
* Get action Links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
*/
public function &links() {
if (!(self::$_links)) {
/**
* Get name of edit form
*
- * @return string Classname of edit form.
+ * @return string
+ * Classname of edit form.
*/
public function editForm() {
return 'CRM_Admin_Form_EventTemplate';
/**
* Get edit form name
*
- * @return string name of this page.
+ * @return string
+ * name of this page.
*/
public function editName() {
return 'Event Templates';
*
* @param null $mode
*
- * @return string user context.
+ * @return string
+ * user context.
*/
public function userContext($mode = NULL) {
return 'civicrm/admin/eventTemplate';
/**
* Get BAO Name
*
- * @return string Classname of BAO.
+ * @return string
+ * Classname of BAO.
*/
public function getBAOName() {
return 'CRM_Core_BAO_Extension';
/**
* Get action Links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
*/
public function &links() {
if (!(self::$_links)) {
/**
* Get name of edit form
*
- * @return string Classname of edit form.
+ * @return string
+ * Classname of edit form.
*/
public function editForm() {
return 'CRM_Admin_Form_Extensions';
/**
* Get edit form name
*
- * @return string name of this page.
+ * @return string
+ * name of this page.
*/
public function editName() {
return 'CRM_Admin_Form_Extensions';
*
* @param null $mode
*
- * @return string user context.
+ * @return string
+ * user context.
*/
public function userContext($mode = NULL) {
return 'civicrm/admin/extensions';
/**
* Get BAO Name
*
- * @return string Classname of BAO.
+ * @return string
+ * Classname of BAO.
*/
public function getBAOName() {
return 'CRM_Core_BAO_Job';
/**
* Get action Links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
*/
public function &links() {
if (!(self::$_links)) {
/**
* Get name of edit form
*
- * @return string Classname of edit form.
+ * @return string
+ * Classname of edit form.
*/
public function editForm() {
return 'CRM_Admin_Form_Job';
/**
* Get edit form name
*
- * @return string name of this page.
+ * @return string
+ * name of this page.
*/
public function editName() {
return 'Scheduled Jobs';
*
* @param null $mode
*
- * @return string user context.
+ * @return string
+ * user context.
*/
public function userContext($mode = NULL) {
return 'civicrm/admin/job';
/**
* Get BAO Name
*
- * @return string Classname of BAO.
+ * @return string
+ * Classname of BAO.
*/
public function getBAOName() {
return 'CRM_Core_BAO_Job';
/**
* Get action Links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
*/
public function &links() {
return self::$_links;
/**
* Get name of edit form
*
- * @return string Classname of edit form.
+ * @return string
+ * Classname of edit form.
*/
public function editForm() {
return 'CRM_Admin_Form_Job';
/**
* Get edit form name
*
- * @return string name of this page.
+ * @return string
+ * name of this page.
*/
public function editName() {
return 'Scheduled Jobs';
*
* @param null $mode
*
- * @return string user context.
+ * @return string
+ * user context.
*/
public function userContext($mode = NULL) {
return 'civicrm/admin/job';
/**
* Get BAO Name
*
- * @return string Classname of BAO.
+ * @return string
+ * Classname of BAO.
*/
public function getBAOName() {
return 'CRM_Core_BAO_LabelFormat';
/**
* Get action Links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
*/
public function &links() {
if (!(self::$_links)) {
/**
* Get name of edit form
*
- * @return string Classname of edit form.
+ * @return string
+ * Classname of edit form.
*/
public function editForm() {
return 'CRM_Admin_Form_LabelFormats';
/**
* Get edit form name
*
- * @return string name of this page.
+ * @return string
+ * name of this page.
*/
public function editName() {
return 'Mailing Label Formats';
*
* @param null $mode
*
- * @return string user context.
+ * @return string
+ * user context.
*/
public function userContext($mode = NULL) {
return 'civicrm/admin/labelFormats';
/**
* Get BAO Name
*
- * @return string Classname of BAO.
+ * @return string
+ * Classname of BAO.
*/
public function getBAOName() {
return 'CRM_Core_BAO_LocationType';
/**
* Get action Links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
*/
public function &links() {
if (!(self::$_links)) {
/**
* Get name of edit form
*
- * @return string Classname of edit form.
+ * @return string
+ * Classname of edit form.
*/
public function editForm() {
return 'CRM_Admin_Form_LocationType';
/**
* Get edit form name
*
- * @return string name of this page.
+ * @return string
+ * name of this page.
*/
public function editName() {
return 'Location Types';
*
* @param null $mode
*
- * @return string user context.
+ * @return string
+ * user context.
*/
public function userContext($mode = NULL) {
return 'civicrm/admin/locationType';
/**
* Get BAO Name
*
- * @return string Classname of BAO.
+ * @return string
+ * Classname of BAO.
*/
public function getBAOName() {
return 'CRM_Core_BAO_MailSettings';
/**
* Get action Links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
*/
public function &links() {
if (!(self::$_links)) {
/**
* Get name of edit form
*
- * @return string Classname of edit form.
+ * @return string
+ * Classname of edit form.
*/
public function editForm() {
return 'CRM_Admin_Form_MailSettings';
/**
* Get edit form name
*
- * @return string name of this page.
+ * @return string
+ * name of this page.
*/
public function editName() {
return 'Mail Settings';
*
* @param null $mode
*
- * @return string user context.
+ * @return string
+ * user context.
*/
public function userContext($mode = NULL) {
return 'civicrm/admin/mailSettings';
/**
* Get BAO
*
- * @return string Classname of BAO.
+ * @return string
+ * Classname of BAO.
*/
public function getBAOName() {
return 'CRM_Core_BAO_Mapping';
/**
* Get action Links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
*/
public function &links() {
if (!(self::$_links)) {
/**
* Get name of edit form
*
- * @return string Classname of edit form.
+ * @return string
+ * Classname of edit form.
*/
public function editForm() {
return 'CRM_Admin_Form_Mapping';
/**
* Get form name for edit form
*
- * @return string name of this page.
+ * @return string
+ * name of this page.
*/
public function editName() {
return 'Mapping';
/**
* Get form name for delete form
*
- * @return string name of this page.
+ * @return string
+ * name of this page.
*/
public function deleteName() {
return 'Mapping';
*
* @param null $mode
*
- * @return string user context.
+ * @return string
+ * user context.
*/
public function userContext($mode = NULL) {
return 'civicrm/admin/mapping';
/**
* Get name of delete form
*
- * @return string Classname of delete form.
+ * @return string
+ * Classname of delete form.
*/
public function deleteForm() {
return 'CRM_Admin_Form_Mapping';
/**
* Get BAO Name
*
- * @return string Classname of BAO.
+ * @return string
+ * Classname of BAO.
*/
public function getBAOName() {
return 'CRM_Core_BAO_MessageTemplate';
/**
* Get action Links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
*/
public function &links() {
if (!(self::$_links)) {
/**
* Get name of edit form
*
- * @return string Classname of edit form.
+ * @return string
+ * Classname of edit form.
*/
public function editForm() {
return 'CRM_Admin_Form_MessageTemplates';
/**
* Get edit form name
*
- * @return string name of this page.
+ * @return string
+ * name of this page.
*/
public function editName() {
return ts('Message Template');
*
* @param null $mode
*
- * @return string user context.
+ * @return string
+ * user context.
*/
public function userContext($mode = NULL) {
return 'civicrm/admin/messageTemplates';
/**
* Get BAO Name
*
- * @return string Classname of BAO.
+ * @return string
+ * Classname of BAO.
*/
public function getBAOName() {
return 'CRM_Core_BAO_Navigation';
/**
* Get action Links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
*/
public function &links() {
}
/**
* Get name of edit form
*
- * @return string Classname of edit form.
+ * @return string
+ * Classname of edit form.
*/
public function editForm() {
return 'CRM_Admin_Form_Navigation';
/**
* Get edit form name
*
- * @return string name of this page.
+ * @return string
+ * name of this page.
*/
public function editName() {
return 'CiviCRM Navigation';
*
* @param null $mode
*
- * @return string user context.
+ * @return string
+ * user context.
*/
public function userContext($mode = NULL) {
return 'civicrm/admin/menu';
/**
* Get BAO Name
*
- * @return string Classname of BAO.
+ * @return string
+ * Classname of BAO.
*/
public function getBAOName() {
return self::$_gName ? 'CRM_Core_BAO_OptionValue' : 'CRM_Core_BAO_OptionGroup';
/**
* Get action Links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
*/
public function &links() {
if (!(self::$_links)) {
/**
* Get name of edit form
*
- * @return string Classname of edit form.
+ * @return string
+ * Classname of edit form.
*/
public function editForm() {
return self::$_gName ? 'CRM_Admin_Form_Options' : 'CRM_Admin_Form_OptionGroup';
/**
* Get edit form name
*
- * @return string name of this page.
+ * @return string
+ * name of this page.
*/
public function editName() {
return self::$_gLabel;
*
* @param null $mode
*
- * @return string user context.
+ * @return string
+ * user context.
*/
public function userContext($mode = NULL) {
return 'civicrm/admin/options' . (self::$_gName ? '/' . self::$_gName : '');
/**
* Get BAO Name
*
- * @return string Classname of BAO.
+ * @return string
+ * Classname of BAO.
*/
public function getBAOName() {
return 'CRM_Financial_BAO_PaymentProcessor';
/**
* Get action Links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
*/
public function &links() {
if (!(self::$_links)) {
/**
* Get name of edit form
*
- * @return string Classname of edit form.
+ * @return string
+ * Classname of edit form.
*/
public function editForm() {
return 'CRM_Admin_Form_PaymentProcessor';
/**
* Get edit form name
*
- * @return string name of this page.
+ * @return string
+ * name of this page.
*/
public function editName() {
return 'Payment Processors';
*
* @param null $mode
*
- * @return string user context.
+ * @return string
+ * user context.
*/
public function userContext($mode = NULL) {
return 'civicrm/admin/paymentProcessor';
/**
* Get BAO Name
*
- * @return string Classname of BAO.
+ * @return string
+ * Classname of BAO.
*/
public function getBAOName() {
return 'CRM_Financial_BAO_PaymentProcessorType';
/**
* Get action Links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
*/
public function &links() {
if (!(self::$_links)) {
/**
* Get name of edit form
*
- * @return string Classname of edit form.
+ * @return string
+ * Classname of edit form.
*/
public function editForm() {
return 'CRM_Admin_Form_PaymentProcessorType';
/**
* Get edit form name
*
- * @return string name of this page.
+ * @return string
+ * name of this page.
*/
public function editName() {
return 'Payment Processor Type';
*
* @param null $mode
*
- * @return string user context.
+ * @return string
+ * user context.
*/
public function userContext($mode = NULL) {
return 'civicrm/admin/paymentProcessorType';
/**
* Get BAO Name
*
- * @return string Classname of BAO.
+ * @return string
+ * Classname of BAO.
*/
public function getBAOName() {
return 'CRM_Core_BAO_PdfFormat';
/**
* Get action Links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
*/
public function &links() {
if (!(self::$_links)) {
/**
* Get name of edit form
*
- * @return string Classname of edit form.
+ * @return string
+ * Classname of edit form.
*/
public function editForm() {
return 'CRM_Admin_Form_PdfFormats';
/**
* Get edit form name
*
- * @return string name of this page.
+ * @return string
+ * name of this page.
*/
public function editName() {
return 'PDF Page Formats';
*
* @param null $mode
*
- * @return string user context.
+ * @return string
+ * user context.
*/
public function userContext($mode = NULL) {
return 'civicrm/admin/pdfFormats';
/**
* Get action Links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
*/
function &stringActionLinks() {
// check if variable _actionsLinks is populated
/**
* Get BAO Name
*
- * @return string Classname of BAO.
+ * @return string
+ * Classname of BAO.
*/
public function getBAOName() {
return 'CRM_Core_BAO_PreferencesDate';
/**
* Get action Links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
*/
public function &links() {
if (!(self::$_links)) {
/**
* Get name of edit form
*
- * @return string Classname of edit form.
+ * @return string
+ * Classname of edit form.
*/
public function editForm() {
return 'CRM_Admin_Form_PreferencesDate';
/**
* Get edit form name
*
- * @return string name of this page.
+ * @return string
+ * name of this page.
*/
public function editName() {
return 'Date Preferences';
*
* @param null $mode
*
- * @return string user context.
+ * @return string
+ * user context.
*/
public function userContext($mode = NULL) {
return 'civicrm/admin/setting/preferences/date';
/**
* Get BAO Name
*
- * @return string Classname of BAO.
+ * @return string
+ * Classname of BAO.
*/
public function getBAOName() {
return 'CRM_Contact_BAO_RelationshipType';
/**
* Get action Links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
*/
public function &links() {
if (!(self::$_links)) {
/**
* Get name of edit form
*
- * @return string Classname of edit form.
+ * @return string
+ * Classname of edit form.
*/
public function editForm() {
return 'CRM_Admin_Form_RelationshipType';
/**
* Get edit form name
*
- * @return string name of this page.
+ * @return string
+ * name of this page.
*/
public function editName() {
return 'Relationship Types';
*
* @param null $mode
*
- * @return string user context.
+ * @return string
+ * user context.
*/
public function userContext($mode = NULL) {
return 'civicrm/admin/reltype';
/**
* Get BAO Name
*
- * @return string Classname of BAO.
+ * @return string
+ * Classname of BAO.
*/
public function getBAOName() {
return 'CRM_Core_BAO_ActionSchedule';
/**
* Get action Links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
*/
public function &links() {
if (!(self::$_links)) {
/**
* Get name of edit form
*
- * @return string Classname of edit form.
+ * @return string
+ * Classname of edit form.
*/
public function editForm() {
return 'CRM_Admin_Form_ScheduleReminders';
/**
* Get edit form name
*
- * @return string name of this page.
+ * @return string
+ * name of this page.
*/
public function editName() {
return 'ScheduleReminders';
*
* @param null $mode
*
- * @return string user context.
+ * @return string
+ * user context.
*/
public function userContext($mode = NULL) {
return 'civicrm/admin/scheduleReminders';
/**
* Get BAO
*
- * @return string Classname of BAO.
+ * @return string
+ * Classname of BAO.
*/
public function getBAOName() {
return 'CRM_Core_BAO_Tag';
/**
* Get action Links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
*/
public function &links() {
if (!(self::$_links)) {
/**
* Get name of edit form
*
- * @return string Classname of edit form.
+ * @return string
+ * Classname of edit form.
*/
public function editForm() {
return 'CRM_Admin_Form_Tag';
/**
* Get form name for edit form
*
- * @return string name of this page.
+ * @return string
+ * name of this page.
*/
public function editName() {
return 'Tag';
/**
* Get form name for delete form
*
- * @return string name of this page.
+ * @return string
+ * name of this page.
*/
public function deleteName() {
return 'Tag';
*
* @param null $mode
*
- * @return string user context.
+ * @return string
+ * user context.
*/
public function userContext($mode = NULL) {
return 'civicrm/admin/tag';
/**
* Get name of delete form
*
- * @return string Classname of delete form.
+ * @return string
+ * Classname of delete form.
*/
public function deleteForm() {
return 'CRM_Admin_Form_Tag';
* @param array $layout
* Layout meta data.
*
- * @return array $formattedRow row with meta data
+ * @return array
+ * row with meta data
*/
public static function formatLabel(&$row, &$layout) {
$formattedRow = array('labelFormat' => $layout['label_format_name']);
* @param bool $is_active
* Value we want to set the is_active field.
*
- * @return Object DAO object on success, null otherwise
+ * @return Object
+ * DAO object on success, null otherwise
*
* @static
*/
/**
* get the list of print labels
*
- * @return array list of labels
+ * @return array
+ * list of labels
* @static
*/
public static function getList() {
* @param array $params
* Associated array of submitted values.
*
- * @return array $formattedLayout array formatted array
+ * @return array
+ * array formatted array
*/
public static function buildLayout(&$params) {
$layoutParams = array('id' => $params['badge_id']);
* @param json $jsonData
* Json object.
*
- * @return array associated array of decoded elements
+ * @return array
+ * associated array of decoded elements
* @static
*/
static public function getDecodedData($jsonData) {
/**
* Get BAO Name
*
- * @return string Classname of BAO.
+ * @return string
+ * Classname of BAO.
*/
public function getBAOName() {
return 'CRM_Badge_BAO_Layout';
/**
* Get action Links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
*/
public function &links() {
if (!(self::$_links)) {
/**
* Get name of edit form
*
- * @return string Classname of edit form.
+ * @return string
+ * Classname of edit form.
*/
public function editForm() {
return 'CRM_Badge_Form_Layout';
/**
* Get edit form name
*
- * @return string name of this page.
+ * @return string
+ * name of this page.
*/
public function editName() {
return 'Badge Layout';
*
* @param null $mode
*
- * @return string user context.
+ * @return string
+ * user context.
*/
public function userContext($mode = NULL) {
return 'civicrm/admin/badgelayout';
* @param string $context
* String.
*
- * @return object $batch batch object
+ * @return object
+ * $batch batch object
*/
public static function create(&$params, $ids = NULL, $context = NULL) {
if (empty($params['id'])) {
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return array CRM_Batch_BAO_Batch object on success, null otherwise
+ * @return array
+ * CRM_Batch_BAO_Batch object on success, null otherwise
* @static
*/
public static function retrieve(&$params, &$defaults) {
* @param int $batchTypeId
* Batch type id.
*
- * @return int $profileId profile id
+ * @return int
+ * $profileId profile id
* @static
*/
public static function getProfileId($batchTypeId) {
* @param array $params
* Associated array for params record id.
*
- * @return array $batchList associated array of batch list
+ * @return array
+ * associated array of batch list
*/
public function getBatchListSelector(&$params) {
// format the params
*
* @param null $context
*
- * @return array $links array of action links
+ * @return array
+ * array of action links
*/
public function links($context = NULL) {
if ($context == 'financialBatch') {
/**
* Get batch list
*
- * @return array array of all batches
+ * @return array
+ * array of all batches
* excluding batches with data entry in progress
*/
public static function getBatches() {
* Get batch names
* @param string $batchIds
*
- * @return array array of batches
+ * @return array
+ * array of batches
*/
public static function getBatchNames($batchIds) {
$query = 'SELECT id, title
*
* @param string $batchIds
*
- * @return array array of batches
+ * @return array
+ * array of batches
*/
public static function getBatchStatuses($batchIds) {
$query = 'SELECT id, status_id
* @param array $self
* Form object.
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($params, $files, $self) {
/**
* Get BAO Name
*
- * @return string Classname of BAO.
+ * @return string
+ * Classname of BAO.
*/
public function getBAOName() {
return 'CRM_Batch_BAO_Batch';
/**
* Get action Links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
*/
public function &links() {
}
/**
* Get name of edit form
*
- * @return string Classname of edit form.
+ * @return string
+ * Classname of edit form.
*/
public function editForm() {
return 'CRM_Batch_Form_Batch';
/**
* Get edit form name
*
- * @return string name of this page.
+ * @return string
+ * name of this page.
*/
public function editName() {
return ts('Batch Processing');
*
* @param null $mode
*
- * @return string user context.
+ * @return string
+ * user context.
*/
public function userContext($mode = NULL) {
return CRM_Utils_System::currentPath();
* @param bool $is_active
* Value we want to set the is_active field.
*
- * @return Object DAO object on sucess, null otherwise
+ * @return Object
+ * DAO object on sucess, null otherwise
* @static
*/
public static function setIsActive($id, $is_active) {
* @param object $tag
* An object of a tag.
*
- * @return array $contactIds array of contact ids
+ * @return array
+ * array of contact ids
*/
public function getEntitiesByTag($tag) {
$contactIds = array();
/**
* Function get the fields for campaign.
*
- * @return array self::$_campaignFields an associative array of campaign fields
+ * @return array
+ * self::$_campaignFields an associative array of campaign fields
* @static
*/
public static function &getFields() {
* @param bool $is_active
* Value we want to set the is_active field.
*
- * @return Object DAO object on sucess, null otherwise
+ * @return Object
+ * DAO object on sucess, null otherwise
* @static
*/
public static function setIsActive($id, $is_active) {
* @param array $returnProperties
* An array of return elements.
*
- * @return array $voterDetails array of contact info.
+ * @return array
+ * array of contact info.
* @static
*/
public static function voterDetails($voterIds, $returnProperties = array()) {
* @param int $interviewerId
* @param array $statusIds
*
- * @return array $activityDetails array of survey activity.
+ * @return array
+ * array of survey activity.
* @static
*/
static function voterActivityDetails(
* This function retrieve all option groups which are created as a result set
*
* @param string $valueColumnName
- * @return array $resultSets an array of option groups.
+ * @return array
+ * an array of option groups.
* @static
*/
public static function getResultSets($valueColumnName = 'title') {
*
* @param int $activityId
* Activity id.
- * @return boolean $isSurveyActivity true/false
+ * @return boolean
* @static
*/
public static function isSurveyActivity($activityId) {
*
* @param int $surveyId
* Survey id.
- * @return array $responseOptions an array of option values
+ * @return array
+ * an array of option values
* @static
*/
public static function getResponsesOptions($surveyId) {
* @param int $surveyTypeId
* Survey activity type id.
*
- * @return array an array of valid survey response fields.
+ * @return array
+ * an array of valid survey response fields.
*/
public static function getSurveyResponseFields($surveyId, $surveyTypeId = NULL) {
if (empty($surveyId)) {
/**
* Get all interviewers of surveys.
*
- * @return array an array of valid survey response fields.
+ * @return array
+ * an array of valid survey response fields.
*/
public static function getInterviewers() {
static $interviewers;
*
* @param array $params
*
- * @return array success message
+ * @return array
+ * success message
*/
public static function releaseRespondent($params) {
$activityStatus = CRM_Core_PseudoConstant::activityStatus('name');
*
* @param null
*
- * @return array array of default values
+ * @return array
+ * array of default values
*/
public function setDefaultValues() {
$defaults = $this->_values;
*
* @param null
*
- * @return array array of default values
+ * @return array
+ * array of default values
*/
public function setDefaultValues() {
if ($this->_cdType) {
*
* @param null
*
- * @return array array of default values
+ * @return array
+ * array of default values
*/
public function setDefaultValues() {
$defaults = array();
*
* @param null
*
- * @return array array of default values
+ * @return array
+ * array of default values
*/
public function setDefaultValues() {
$defaults = $this->_values;
*
* @param null
*
- * @return array array of default values
+ * @return array
+ * array of default values
*/
public function setDefaultValues() {
$defaults = parent::setDefaultValues();
* @param $files
* @param $self
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($fields, $files, $self) {
/**
* Get the action links for this page.
*
- * @return array $_actionLinks
+ * @return array
*
*/
public function &actionLinks() {
/**
* Get the action links for this page.
*
- * @return array $_campaignActionLinks
+ * @return array
*
*/
public function &campaignActionLinks() {
* @param int $activity_id
* @param int $petition_id
*
- * @return boolean True on success
+ * @return boolean
+ * True on success
* @static
*/
public static function confirm($contact_id, $subscribe_id, $hash, $activity_id, $petition_id) {
/**
* Get BAO Name
*
- * @return string Classname of BAO.
+ * @return string
+ * Classname of BAO.
*/
public function getBAOName() {
return 'CRM_Core_BAO_OptionValue';
/**
* Get action Links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
*/
public function &links() {
if (!(self::$_links)) {
/**
* Get name of edit form
*
- * @return string Classname of edit form.
+ * @return string
+ * Classname of edit form.
*/
public function editForm() {
return 'CRM_Campaign_Form_SurveyType';
/**
* Get edit form name
*
- * @return string name of this page.
+ * @return string
+ * name of this page.
*/
public function editName() {
return $this->_GName;
*
* @param null $mode
*
- * @return string user context.
+ * @return string
+ * user context.
*/
public function userContext($mode = NULL) {
return 'civicrm/admin/campaign/surveyType';
*
* @param string $returnColumn
*
- * @return array - array reference of all survey activity types.
+ * @return array
+ * array reference of all survey activity types.
* @static
*/
public static function &activityType($returnColumn = 'name') {
*
* @static
*
- * @return array - array reference of all campaign types.
+ * @return array
+ * array reference of all campaign types.
*
*/
public static function &campaignType() {
*
* @static
*
- * @return array - array reference of all campaign status.
+ * @return array
+ * array reference of all campaign status.
*
*/
public static function &campaignStatus() {
*
* @static
*
- * @return array - array reference of all Engagement Level.
+ * @return array
+ * array reference of all Engagement Level.
*/
public static function &engagementLevel() {
if (!isset(self::$engagementLevel)) {
*
* @param
*
- * @return int Total number of rows
+ * @return int
+ * Total number of rows
*/
public function getTotalCount($action) {
return $this->_query->searchQuery(0, 0, NULL,
* @param enum $output
* What should the result set include (web/email/csv).
*
- * @return int the total number of rows for this action
+ * @return int
+ * the total number of rows for this action
*/
public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
$result = $this->_query->searchQuery($offset, $rowCount, $sort,
}
/**
- * @return array $qill which contains an array of strings
+ * @return array
+ * which contains an array of strings
**/
public function getQILL() {
return $this->_query->qill();
* @param enum $output
* What should the result set include (web/email/csv).
*
- * @return array the column headers that need to be displayed
+ * @return array
+ * the column headers that need to be displayed
*/
public function &getColumnHeaders($action = NULL, $output = NULL) {
self::$_columnHeaders = array();
* @param string $output
* Type of output.
*
- * @return string name of the file
+ * @return string
+ * name of the file
*/
public function getExportFileName($output = 'csv') {
return ts('CiviCRM Respondent Search');
*
* @param string $formName
*
- * @return string the name of the form that will handle the task
+ * @return string
+ * the name of the form that will handle the task
*/
public function taskName($controller, $formName = 'Search') {
// total hack, check POST vars and then session to determine stuff
* These tasks are the core set of tasks that the user can perform
* on a voter / group of voters
*
- * @return array the set of tasks for a group of voters.
+ * @return array
+ * the set of tasks for a group of voters.
* @static
*/
public static function &tasks() {
* These tasks are the core set of task titles
* on voters.
*
- * @return array the set of task titles
+ * @return array
+ * the set of task titles
* @static
*/
public static function &taskTitles() {
*
* @param int $permission
*
- * @return array set of tasks that are valid for the user
+ * @return array
+ * set of tasks that are valid for the user
*/
public static function &permissionedTaskTitles($permission) {
$tasks = self::taskTitles();
*
* @param int $value
*
- * @return array the set of tasks for a group of voters.
+ * @return array
+ * the set of tasks for a group of voters.
* @static
*/
public static function getTask($value) {
* @param int $caseId
* @param string $colName
*
- * @return string case type
+ * @return string
+ * case type
* @static
*/
public static function getCaseType($caseId, $colName = 'title') {
*
* @param bool $moveToTrash
*
- * @return bool is successful
+ * @return bool
+ * is successful
* @static
*/
public static function deleteCase($caseId, $moveToTrash = FALSE) {
*
* @param string $context
*
- * @return array Array of Cases
+ * @return array
+ * Array of Cases
*
*/
public static function getCases($allCases = TRUE, $userID = NULL, $type = 'upcoming', $context = 'dashboard') {
* Case id.
* @param int $relationshipID
*
- * @return array case role / relationships
+ * @return array
+ * case role / relationships
*
* @static
*/
* @param int $userID
* @param null $type
*
- * @return array of case activities
+ * @return array
+ * of case activities
*
* @static
*/
* @param bool $skipDetails
* If true include details of contacts.
*
- * @return array $searchRows array of return properties
+ * @return array
+ * array of return properties
*
* @static
*/
*
* @param string $type
*
- * @return array $activityInfo Array of scheduled activity type and date
+ * @return array
+ * Array of scheduled activity type and date
*
*
* @static
/**
* Combine all the exportable fields from the lower levels object
*
- * @return array array of exportable Fields
+ * @return array
+ * array of exportable Fields
* @static
*/
public static function &exportableFields() {
* Case role assignee contactId.
* @param int $contactId
*
- * @return void on success creates activity and case activity
+ * @return void
+ * on success creates activity and case activity
*
* @static
*/
* @param int $caseId
* Case id.
*
- * @return array $caseManagerContact array of contact on success otherwise empty
+ * @return array
+ * array of contact on success otherwise empty
*
* @static
*/
* @param array $excludeCaseIds
* @param bool $excludeDeleted
*
- * @return array of case and related data keyed on case id
+ * @return array
+ * of case and related data keyed on case id
*/
public static function getUnclosedCases($params = array(), $excludeCaseIds = array(), $excludeDeleted = TRUE, $includeClosed = FALSE) {
//params from ajax call.
* @param bool $checkComponent
* Do we need to check component enabled.
*
- * @return boolean $allow true/false
+ * @return boolean
* @static
*/
public static function checkPermission($activityId, $operation, $actTypeId = NULL, $contactId = NULL, $checkComponent = TRUE) {
* @param int $activityID
* Activity id.
*
- * @return boolean $isCaseActivity true/false
+ * @return boolean
*/
public static function isCaseActivity($activityID) {
$isCaseActivity = FALSE;
* Get all the case type ids currently in use
*
*
- * @return array $caseTypeIds
+ * @return array
*/
public static function getUsedCaseType() {
static $caseTypeIds;
* Get all the case status ids currently in use
*
*
- * @return array $caseStatusIds
+ * @return array
*/
public static function getUsedCaseStatuses() {
static $caseStatusIds;
*
* @param int $contactId
*
- * @return array $configured
+ * @return array
*/
public static function isCaseConfigured($contactId = NULL) {
$configured = array_fill_keys(array('configured', 'allowToAddNewCase', 'redirectToCaseAdmin'), FALSE);
*
* @param int $caseId
*
- * @return array $clients associated array with client ids
+ * @return array
+ * associated array with client ids
* @static
*/
public static function getCaseClients($caseId) {
* @param string $name
* @param array $definition
* The case-type defintion expressed as an array-tree.
- * @return string XML
+ * @return string
+ * XML
* @static
*/
public static function convertDefinitionToXML($name, $definition) {
* @param SimpleXmlElement $xml
* A single case-type record.
*
- * @return array the definition of the case-type, expressed as PHP array-tree
+ * @return array
+ * the definition of the case-type, expressed as PHP array-tree
* @static
*/
public static function convertXmlToDefinition($xml) {
* Determine if modifications are allowed on the case-type
*
* @param int $caseTypeId
- * @return bool TRUE if the definition can be modified
+ * @return bool
+ * TRUE if the definition can be modified
*/
public static function isForkable($caseTypeId) {
$caseTypeName = CRM_Core_DAO::getFieldValue('CRM_Case_DAO_CaseType', $caseTypeId, 'name', 'id', TRUE);
* @param $files
* @param CRM_Core_Form $form
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($values, $files, $form) {
* @param $files
* @param CRM_Core_Form $form
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($values, $files, $form) {
* @param $files
* @param CRM_Core_Form $form
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($values, $files, $form) {
* @param $files
* @param CRM_Core_Form $form
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($values, $files, $form) {
* @param $files
* @param CRM_Core_Form $form
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($fields, $files, $form) {
* @param $files
* @param CRM_Core_Form $form
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($values, $files, $form) {
* Set the default form values
*
*
- * @return array the default array reference
+ * @return array
+ * the default array reference
*/
public function setDefaultValues() {
$defaults = array();
/**
* Get action links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
* @static
*/
static
* @param null $condition
* @param bool $fresh
*
- * @return array - array reference of all case statues
+ * @return array
+ * array reference of all case statues
* @static
*/
public static function caseStatus($column = 'label', $onlyActive = TRUE, $condition = NULL, $fresh = FALSE) {
*
* @param null $filter
*
- * @return array - array reference of all redaction rules
+ * @return array
+ * array reference of all redaction rules
* @static
*/
* @param string $column
* @param bool $onlyActive
*
- * @return array - array reference of all case type
+ * @return array
+ * array reference of all case type
* @static
*/
public static function caseType($column = 'title', $onlyActive = TRUE) {
* @param string $column
* @param bool $onlyActive
*
- * @return array - array reference of all Encounter Medium.
+ * @return array
+ * array reference of all Encounter Medium.
* @static
*/
public static function encounterMedium($column = 'label', $onlyActive = TRUE) {
*
* @static
*
- * @return array - array reference of all activity types.
+ * @return array
+ * array reference of all activity types.
*/
public static function &caseActivityType($indexName = TRUE, $all = FALSE) {
$cache = (int) $indexName . '_' . (int) $all;
*
* @param
*
- * @return int Total number of rows
+ * @return int
+ * Total number of rows
*/
public function getTotalCount($action) {
return $this->_query->searchQuery(0, 0, NULL,
* @param enum $output
* What should the result set include (web/email/csv).
*
- * @return int the total number of rows for this action
+ * @return int
+ * the total number of rows for this action
*/
public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
$result = $this->_query->searchQuery($offset, $rowCount, $sort,
}
/**
- * @return array $qill which contains an array of strings
+ * @return array
+ * which contains an array of strings
*/
// the current internationalisation is bad, but should more or less work
* @param enum $output
* What should the result set include (web/email/csv).
*
- * @return array the column headers that need to be displayed
+ * @return array
+ * the column headers that need to be displayed
*/
public function &getColumnHeaders($action = NULL, $output = NULL) {
if (!isset(self::$_columnHeaders)) {
* @param string $output
* Type of output.
*
- * @return string name of the file
+ * @return string
+ * name of the file
*/
public function getExportFileName($output = 'csv') {
return ts('Case Search');
*
* @param string $formName
*
- * @return string the name of the form that will handle the task
+ * @return string
+ * the name of the form that will handle the task
*/
public function taskName($controller, $formName = 'Search') {
// total hack, check POST vars and then session to determine stuff
* These tasks are the core set of tasks that the user can perform
* on a contact / group of contacts
*
- * @return array the set of tasks for a group of contacts
+ * @return array
+ * the set of tasks for a group of contacts
* @static
*/
public static function &tasks() {
/**
* These tasks are the core set of task titles
*
- * @return array the set of task titles
+ * @return array
+ * the set of task titles
* @static
*/
public static function &taskTitles() {
/**
* These tasks get added based on the context the user is in
*
- * @return array the set of optional tasks for a group of contacts
+ * @return array
+ * the set of optional tasks for a group of contacts
* @static
*/
public static function &optionalTaskTitle() {
*
* @param int $permission
*
- * @return array set of tasks that are valid for the user
+ * @return array
+ * set of tasks that are valid for the user
*/
public static function &permissionedTaskTitles($permission) {
$tasks = array();
*
* @param int $value
*
- * @return array the set of tasks for a group of contacts
+ * @return array
+ * the set of tasks for a group of contacts
* @static
*/
public static function getTask($value) {
/**
* Retrieves AllowMultipleCaseClients setting
*
- * @return string 1 if allowed, 0 if not
+ * @return string
+ * 1 if allowed, 0 if not
*/
public function getAllowMultipleCaseClients() {
$xml = $this->retrieve("Settings");
/**
* Retrieves NaturalActivityTypeSort setting
*
- * @return string 1 if natural, 0 if alphabetic
+ * @return string
+ * 1 if natural, 0 if alphabetic
*/
public function getNaturalActivityTypeSort() {
$xml = $this->retrieve("Settings");
*
* @param bool $type
*
- * @return array the displayName and contactImage for this contact
+ * @return array
+ * the displayName and contactImage for this contact
* @static
*/
public static function getDisplayAndImage($id, $type = FALSE) {
* @param bool $skipUndelete
* Whether to force contact delete or not.
*
- * @return boolean true if contact deleted, false otherwise
+ * @return boolean
+ * true if contact deleted, false otherwise
* @static
*/
public static function deleteContact($id, $restore = FALSE, $skipUndelete = FALSE) {
* @param int $id
* Id of the contact.
*
- * @return boolean true if contact image is deleted
+ * @return boolean
+ * true if contact image is deleted
*/
public static function deleteContactImage($id) {
if (!$id) {
* @param string $absolutePath
* Absolute path.
*
- * @return String $relativePath Relative url of uploaded image
+ * @return String
+ * Relative url of uploaded image
*/
public static function getRelativePath($absolutePath) {
$relativePath = NULL;
* @param Integer $imageHeight
* Height of image.
*
- * @return Array thumb dimension of image
+ * @return Array
+ * thumb dimension of image
*/
public static function getThumbSize($imageWidth, $imageHeight) {
$thumbWidth = 100;
* @param string $opType
* Type of operation like fatal, bounce etc.
*
- * @return boolean true if valid image extension
+ * @return boolean
+ * true if valid image extension
*/
public static function processImageParams(
&$params,
* @param int $id
* Id of the contact whose contact type is needed.
*
- * @return string contact_type if $id found else null ""
+ * @return string
+ * contact_type if $id found else null ""
*
*
* @static
*
* @param null $implodeDelimiter
*
- * @return string contact_sub_type if $id found else null ""
+ * @return string
+ * contact_sub_type if $id found else null ""
*
*
* @static
*
* @param bool $withMultiCustomFields
*
- * @return array array of importable Fields
+ * @return array
+ * array of importable Fields
* @static
*/
static function importableFields(
*
* @param bool $withMultiRecord
*
- * @return array array of exportable Fields
+ * @return array
+ * array of exportable Fields
* @static
*/
public static function &exportableFields($contactType = 'Individual', $status = FALSE, $export = FALSE, $search = FALSE, $withMultiRecord = FALSE) {
* @param int $contactId
* Contact id.
*
- * @return array a hierarchical property tree if appropriate
+ * @return array
+ * a hierarchical property tree if appropriate
* @static
*/
public static function &makeHierReturnProperties($fields, $contactId = NULL) {
* @param bool $skipDefaultPriamry
* @param null $block
*
- * @return int $locationType location_type_id
+ * @return int
+ * $locationType location_type_id
* @static
*/
public static function getPrimaryLocationType($contactId, $skipDefaultPriamry = FALSE, $block = NULL) {
* @param int $id
* Id of the contact.
*
- * @return array of display_name, email if found, do_not_email or (null,null,null)
+ * @return array
+ * of display_name, email if found, do_not_email or (null,null,null)
* @static
*/
public static function getContactDetails($id) {
* Basically lets us know where this request is coming from.
* if via a profile from web, we restrict what groups are changed
*
- * @return int contact id created/edited
+ * @return int
+ * contact id created/edited
* @static
*/
static function createProfileContact(
* @param string $ctype
* Contact type.
*
- * @return object $dao contact details
+ * @return object
+ * $dao contact details
* @static
*/
public static function &matchContactOnEmail($mail, $ctype = NULL) {
* @param string $ctype
* Contact type.
*
- * @return object $dao contact details
+ * @return object
+ * $dao contact details
* @static
*/
public static function &matchContactOnOpenId($openId, $ctype = NULL) {
* @param int $contactID
* Contact id.
*
- * @return string $dao->email email address if present else null
+ * @return string
+ * >email email address if present else null
* @static
*/
public static function getPrimaryEmail($contactID) {
* @param int $contactID
* Contact id.
*
- * @return string $dao->openid OpenID if present else null
+ * @return string
+ * >openid OpenID if present else null
* @static
*/
public static function getPrimaryOpenId($contactID) {
* @param string $condOperator
* Operator use for grouping multiple conditions.
*
- * @return array $locBlockIds loc block ids which fulfill condition.
+ * @return array
+ * loc block ids which fulfill condition.
* @static
*/
public static function getLocBlockIds($contactId, $criteria = array(), $condOperator = 'AND') {
*
* @param int $contactId
*
- * @return array of context menu for logged in user.
+ * @return array
+ * of context menu for logged in user.
* @static
*/
public static function contextMenu($contactId = NULL) {
* @param int $contactId
* Contact id.
*
- * @return bool true if present else false.
+ * @return bool
+ * true if present else false.
* @static
*/
public static function checkDomainContact($contactId) {
* @param bool $isPrimary
* @param int $locationTypeID
*
- * @return array of display_name, email, location type and location id if found, or (null,null,null, null)
+ * @return array
+ * of display_name, email, location type and location id if found, or (null,null,null, null)
* @static
*/
public static function getEmailDetails($id, $isPrimary = TRUE, $locationTypeID = NULL) {
*
* @param null $type
*
- * @return array tuple of display_name and sms if found, or (null,null)
+ * @return array
+ * tuple of display_name and sms if found, or (null,null)
* @static
*/
public static function getPhoneDetails($id, $type = NULL) {
* Contact id.
* @param int|string $type the type of operation (view|edit)
*
- * @return boolean true if the user has permission, false otherwise
+ * @return boolean
+ * true if the user has permission, false otherwise
* @static
*/
public static function allow($id, $type = CRM_Core_Permission::VIEW) {
* @param int $contactID
* Contact id of the current contact.
*
- * @return bool true if logged in user has permission to view
+ * @return bool
+ * true if logged in user has permission to view
* selected contact record else false
* @static
*/
* @param string $entityType
* @param null $hashSize
*
- * @return array ( $cs, $ts, $live )
+ * @return array
+ * ( $cs, $ts, $live )
* @static
*/
public static function generateChecksum($entityId, $ts = NULL, $live = NULL, $hash = NULL, $entityType = 'contact', $hashSize = NULL) {
* @param string $inputCheck
* Checksum to match against.
*
- * @return boolean true if valid, else false
+ * @return boolean
+ * true if valid, else false
* @static
*/
public static function validChecksum($contactID, $inputCheck) {
* @param int $contactId
* Contact id.
*
- * @return int $locationCount max locations for the contact
+ * @return int
+ * $locationCount max locations for the contact
* @static
*/
public static function maxLocations($contactId) {
* Associated with the contact which is edited.
*
*
- * @return array $contactViewLinks returns array with links to contact view
+ * @return array
+ * returns array with links to contact view
* @static
*/
public static function formatContactIDSToLinks($contactIDs, $addViewLink = TRUE, $addEditLink = TRUE, $originalId = NULL) {
* @param array $returnProperties
* Array of return elements.
*
- * @return array $contactDetails array of contact info.
+ * @return array
+ * array of contact info.
* @static
*/
public static function contactDetails($componentIds, $componentName, $returnProperties = array()) {
* @param array $addresses
* Associated array of.
*
- * @return array $contactNames associated array of contact names
+ * @return array
+ * associated array of contact names
* @static
*/
public static function getAddressShareContactNames(&$addresses) {
* @param string $greetingType
* Greeting type.
*
- * @return int or null
+ * @return int
+ * or null
*/
public static function defaultGreeting($contactType, $greetingType) {
$contactTypeFilters = array('Individual' => 1, 'Household' => 2, 'Organization' => 3);
*
* @param bool $all
*
- * @return array of basic contact types information.
+ * @return array
+ * of basic contact types information.
* @static
*/
public static function &basicTypeInfo($all = FALSE) {
*
* @param bool $all
*
- * @return array of basic contact types
+ * @return array
+ * of basic contact types
* @static
*/
public static function basicTypes($all = FALSE) {
* @param bool $ignoreCache
* @param bool $reset
*
- * @return array of sub type information
+ * @return array
+ * of sub type information
* @static
*/
public static function &subTypeInfo($contactType = NULL, $all = FALSE, $ignoreCache = FALSE, $reset = FALSE) {
* @param string $columnName
* @param bool $ignoreCache
*
- * @return array of all subtypes OR list of subtypes associated to
+ * @return array
+ * of all subtypes OR list of subtypes associated to
* a given basic contact type
* @static
*/
*
* @param bool $all
*
- * @return array of basic types + all subtypes.
+ * @return array
+ * of basic types + all subtypes.
* @static
*/
public static function contactTypes($all = FALSE) {
* @param bool $all
* @param bool $reset
*
- * @return array of basic types + all subtypes.
+ * @return array
+ * of basic types + all subtypes.
* @static
*/
public static function contactTypeInfo($all = FALSE, $reset = FALSE) {
* @param null $typeName
* @param null $delimiter
*
- * @return array of basictypes with name as 'built-in name' and 'label' as value
+ * @return array
+ * of basictypes with name as 'built-in name' and 'label' as value
* @static
*/
public static function contactTypePairs($all = FALSE, $typeName = NULL, $delimiter = NULL) {
* Contact subType.
* @param bool $ignoreCache
*
- * @return boolean true if subType, false otherwise.
+ * @return boolean
+ * true if subType, false otherwise.
* @static
*/
public static function isaSubType($subType, $ignoreCache = FALSE) {
* Contact subTypes.
* @param bool $ignoreCache
*
- * @return array of suppressed subTypes.
+ * @return array
+ * of suppressed subTypes.
* @static
*/
public static function suppressSubTypes(&$subTypes, $ignoreCache = FALSE) {
* @param bool $ignoreCache
* @param string $columnName
*
- * @return boolean true if contact extends, false otherwise.
+ * @return boolean
+ * true if contact extends, false otherwise.
* @static
*/
public static function isExtendsContactType($subType, $contactType, $ignoreCache = FALSE, $columnName = 'name') {
/**
* Create shortcuts menu for contactTypes
*
- * @return array of contactTypes
+ * @return array
+ * of contactTypes
* @static
*/
public static function getCreateNewList() {
* @param bool $is_active
* Value we want to set the is_active field.
*
- * @return Object DAO object on success, null otherwise
+ * @return Object
+ * DAO object on success, null otherwise
* @static
*/
public static function setIsActive($id, $is_active) {
* @param string $subType
* Subtype.
*
- * @return boolean true/false.
+ * @return boolean
* @static
*/
public static function isAllowEdit($contactId, $subType = NULL) {
*
* @param bool $countChildGroups
*
- * @return int count of members in the group with above status
+ * @return int
+ * count of members in the group with above status
*/
public static function memberCount($id, $status = 'Added', $countChildGroups = FALSE) {
$groupContact = new CRM_Contact_DAO_GroupContact();
* @param int $groupID
* @param bool $useCache
*
- * @return array $aMembers this array contains the list of members for this group id
+ * @return array
+ * this array contains the list of members for this group id
* @static
*/
public static function &getMember($groupID, $useCache = TRUE) {
* @param NULL $offset
* @param NULL $rowCount
*
- * @return array of group objects.
+ * @return array
+ * of group objects.
*
*
* @todo other BAO functions that use returnProperties (e.g. Query Objects) receive the array flipped & filled with 1s and
* @param int $id
* The id of the object.
*
- * @return string the permission that the user has (or NULL)
+ * @return string
+ * the permission that the user has (or NULL)
* @static
*/
public static function checkPermission($id) {
* @param bool $isActive
* Value we want to set the is_active field.
*
- * @return Object DAO object on sucess, NULL otherwise
+ * @return Object
+ * DAO object on sucess, NULL otherwise
* @static
*/
public static function setIsActive($id, $isActive) {
* Type of group(Access/Mailing) OR the key of the group.
* @param bool|\boolen $excludeHidden exclude hidden groups.
*
- * @return string $condition
+ * @return string
* @static
*/
public static function groupTypeCondition($groupType = NULL, $excludeHidden = TRUE) {
* @param array $params
* ( reference ) an assoc array of name/value pairs.
*
- * @return array ( smartGroupId, ssId ) smart group id and saved search id
+ * @return array
+ * ( smartGroupId, ssId ) smart group id and saved search id
* @static
*/
public static function createHiddenSmartGroup($params) {
* @param array $params
* Associated array for params record id.
*
- * @return array $groupList associated array of group list
+ * @return array
+ * associated array of group list
* -rp = rowcount
* -page= offset
* @todo there seems little reason for the small number of functions that call this to pass in
/**
* Define action links
*
- * @return array $links array of action links
+ * @return array
+ * array of action links
*/
public static function actionLinks() {
$links = array(
* @param array $values
* Output values of the object.
*
- * @return array (reference) the values that could be potentially assigned to smarty
+ * @return array
+ * (reference) the values that could be potentially assigned to smarty
* @static
*/
public static function getValues(&$params, &$values) {
* @param string $status
* @param int $tracking
*
- * @return array (total, added, notAdded) count of contacts added to group
+ * @return array
+ * (total, added, notAdded) count of contacts added to group
* @static
*/
static function addContactsToGroup(
* @param string $status
* @param NULL $tracking
*
- * @return array (total, removed, notRemoved) count of contacts removed to group
+ * @return array
+ * (total, removed, notRemoved) count of contacts removed to group
* @static
*/
static function removeContactsFromGroup(
* @param bool $visibility
*
*
- * @return array $values this array has key-> group id and value group title
+ * @return array
+ * this array has key-> group id and value group title
* @static
*/
public static function getGroupList($contactId = 0, $visibility = FALSE) {
*
* @param bool $excludeHidden
*
- * @return array (reference )|int $values the relevant data object values for the contact or
+ * @return array
+ * (reference )|int $values the relevant data object values for the contact or
* the total count when $count is TRUE
*
* $access public
* @param string $method
* If we want the subscription history details for a specific method.
*
- * @return object of group contact
+ * @return object
+ * of group contact
* @static
*/
public static function getMembershipDetail($contactId, $groupID, $method = 'Email') {
*
* TODO: use the 3rd $sqls param to append sql statements rather than executing them here
*
- * @return void.
+ * @return void
+ *
* @static
*/
public static function mergeGroupContact($mainContactId, $otherContactId) {
* @param string $status
* @param NULL $tracking
*
- * @return array (total, added, notAdded) count of contacts added to group
+ * @return array
+ * (total, added, notAdded) count of contacts added to group
* @static
*/
static function bulkAddContactsToGroup(
* @param $groupIDs
* Of group that we are checking against.
*
- * @return boolean TRUE if we did not regenerate, FALSE if we did
+ * @return boolean
+ * TRUE if we did not regenerate, FALSE if we did
*/
public static function check($groupIDs) {
if (empty($groupIDs)) {
* @param bool $includeHiddenGroups
* Hidden groups are excluded by default.
*
- * @return string the sql query which lists the groups that need to be refreshed
+ * @return string
+ * the sql query which lists the groups that need to be refreshed
* @static
*/
public static function groupRefreshedClause($groupIDClause = NULL, $includeHiddenGroups = FALSE) {
* @param bool $includeHiddenGroups
* Hidden groups are excluded by default.
*
- * @return string the sql query which lists the groups that need to be refreshed
+ * @return string
+ * the sql query which lists the groups that need to be refreshed
* @static
*/
public static function shouldGroupBeRefreshed($groupID, $includeHiddenGroups = FALSE) {
* @param int $limit
* Limits the number of groups we evaluate.
*
- * @return boolean TRUE if we did not regenerate, FALSE if we did
+ * @return boolean
+ * TRUE if we did not regenerate, FALSE if we did
*/
public static function loadAll($groupIDs = NULL, $limit = 0) {
// ensure that all the smart groups are loaded
* @param bool $showHidden
* Hidden groups are shown only if this flag is set.
*
- * @return array an array of groups that this contact belongs to
+ * @return array
+ * an array of groups that this contact belongs to
*/
public static function contactGroup($contactID, $showHidden = FALSE) {
if (empty($contactID)) {
* @param int $contactId
* Contact id.
*
- * @return Object DAO object on success
+ * @return Object
+ * DAO object on success
* @static
*/
public static function updatePrimaryContact($primaryContactId, $contactId) {
/**
* Creates display name
*
- * @return string the constructed display name
+ * @return string
+ * the constructed display name
*/
public function displayName() {
$prefix = CRM_Core_PseudoConstant::get('CRM_Contact_DAO_Contact', 'prefix_id');
* @param bool $groupContacts
* @param bool $onlyDeleted
*
- * @return array sql query parts as an array
+ * @return array
+ * sql query parts as an array
*/
public function query($count = FALSE, $sortByChar = FALSE, $groupContacts = FALSE, $onlyDeleted = FALSE) {
// build permission clause
*
* @param CRM_Core_DAO $dao
*
- * @return array values for this query
+ * @return array
+ * values for this query
*/
public function store($dao) {
$value = array();
* @param bool $primaryLocation
* @param int $mode
*
- * @return string the from clause
+ * @return string
+ * the from clause
* @static
*/
public static function fromClause(&$tables, $inner = NULL, $right = NULL, $primaryLocation = TRUE, $mode = 1) {
*
* @param int $mode
*
- * @return array derault return properties
+ * @return array
+ * derault return properties
*/
public static function &defaultReturnProperties($mode = 1) {
if (!isset(self::$_defaultReturnProperties)) {
* @param string $dataType
* Data type of the field.
*
- * @return string where clause for the query
+ * @return string
+ * where clause for the query
*/
public static function buildClause($field, $op, $value = NULL, $dataType = NULL) {
$op = trim($op);
* The data type for this element.
* @param bool $useIDsOnly
*
- * @return void adds the where clause and qill to the query object
+ * @return void
+ * adds the where clause and qill to the query object
*/
function optionValueQuery(
$name,
/**
* Get or build the list of search objects (via hook)
*
- * @return array of CRM_Contact_BAO_Query_Interface objects
+ * @return array
+ * of CRM_Contact_BAO_Query_Interface objects
*/
public function getSearchQueryObjects() {
if ($this->_queryObjects === NULL) {
/**
* Specifiy defaults for creating a relationship
*
- * @return array $defaults array of defaults for creating relationship
+ * @return array
+ * array of defaults for creating relationship
* @static
*/
public static function getdefaults() {
*
* @static
*
- * @return array - array reference of all relationship types with context to current contact.
+ * @return array
+ * array reference of all relationship types with context to current contact.
*/
static function getContactRelationshipType(
$contactId = NULL,
* @param int $relationshipTypeId
* Relationship type id.
*
- * @return boolean true if it is valid relationship else false
+ * @return boolean
+ * true if it is valid relationship else false
* @static
*/
public static function checkRelationshipType($contact_a, $contact_b, $relationshipTypeId) {
* @param int $relationshipId
* This is relationship id for the contact.
*
- * @return boolean true if record exists else false
+ * @return boolean
+ * true if record exists else false
* @static
*/
public static function checkDuplicateRelationship(&$params, $id, $contactId = 0, $relationshipId = 0) {
* Value we want to set the is_active field.
*
* @throws CiviCRM_API3_Exception
- * @return Object DAO object on success, null otherwise
+ * @return Object
+ * DAO object on success, null otherwise
* @static
*/
public static function setIsActive($id, $is_active) {
* @param array $values
* Output values of the object.
*
- * @return array (reference) the values that could be potentially assigned to smarty
+ * @return array
+ * (reference) the values that could be potentially assigned to smarty
* @static
*/
public static function &getValues(&$params, &$values) {
* @param string $targetContactType
* It's valid contact tpye(may be Individual , Organization , Household).
*
- * @return array - array reference of all relationship types with context to current contact type .
+ * @return array
+ * array reference of all relationship types with context to current contact type .
*
*/
public function getRelationType($targetContactType) {
* @param $contactIds
* Contact Ids.
*
- * @return array $currentEmployer array of the current employer
+ * @return array
+ * array of the current employer
* @static
*/
public static function getCurrentEmployer($contactIds) {
*
* @static
*
- * @return array array of employers.
+ * @return array
+ * array of employers.
*
*/
public static function getPermissionedEmployer($contactID, $name = NULL) {
*
* @static
*
- * @return array of contacts
+ * @return array
+ * of contacts
*/
public static function getPermissionedContacts($contactID, $relTypeId, $name = NULL) {
$contacts = array();
* @param array $params
* Associated array for params record id.
*
- * @return array $contactRelationships associated array of contact relationships
+ * @return array
+ * associated array of contact relationships
*/
public static function getContactRelationshipSelector(&$params) {
// format the params
* @param bool $is_active
* Value we want to set the is_active field.
*
- * @return Object DAO object on sucess, null otherwise
+ * @return Object
+ * DAO object on sucess, null otherwise
* @static
*/
public static function setIsActive($id, $is_active) {
/**
* Query the db for all saved searches.
*
- * @return array $aSavedSearch - contains the search name as value and and id as key
+ * @return array
+ * contains the search name as value and and id as key
*
*/
public function getAll() {
* @param int $id
* The id of the saved search.
*
- * @return array the values of the posted saved search
+ * @return array
+ * the values of the posted saved search
* @static
*/
public static function &getFormValues($id) {
* @param array $whereTables
* (reference ) add the tables that are needed for the where clause.
*
- * @return string the where clause for this saved search
+ * @return string
+ * the where clause for this saved search
* @static
*/
public static function whereClause($id, &$tables, &$whereTables) {
*
* @param string $value
*
- * @return string the name of the saved search
+ * @return string
+ * the name of the saved search
* @static
*/
public static function getName($id, $value = 'name') {
* @param array $params
* Values for the new history record.
*
- * @return object $history The new history object
+ * @return object
+ * $history The new history object
* @static
*/
public static function &create(&$params) {
* @param int $contactId
* Contact id if doing update.
*
- * @return bool $primaryID email/openId
+ * @return bool
+ * email/openId
* @static
*/
public static function formRule($fields, &$errors, $contactId = NULL) {
* @param array $fields
* The hierarchical value representation of this location.
*
- * @return boolean true if data exists, false otherwise
+ * @return boolean
+ * true if data exists, false otherwise
* @static
*/
public static function blockDataExists(&$fields) {
* @param array $params
* of key value consist of address blocks.
*
- * @return array $parseSuccess as array of sucess/fails for each address block
+ * @return array
+ * as array of sucess/fails for each address block
* @static
*/
public function parseAddress(&$params) {
* Set the default form values
*
*
- * @return array the default array reference
+ * @return array
+ * the default array reference
*/
public function setDefaultValues() {
if ($this->_cdType || $this->_multiRecordDisplay == 'single') {
* @param $files
* @param $self
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($fields, $files, $self) {
*
* access public
*
- * @return array reference to the array of default values
+ * @return array
+ * reference to the array of default values
*
*/
/**
* @param array $fields
* Posted values of the form.
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($fields) {
* @param array $errors
* List of errors to be posted back to the form.
*
- * @return array $errors
+ * @return array
* @static
*/
public static function formRule($fields, $errors) {
* @param array $errors
* List of errors to be posted back to the form.
*
- * @return array $errors
+ * @return array
* @static
*/
public static function formRule($fields, $errors) {
*
* @param int $contactID
*
- * @return array extra options to return in JSON
+ * @return array
+ * extra options to return in JSON
*/
public static function getResponse($contactID) {
$timestamps = CRM_Contact_BAO_Contact::getTimestamps($contactID);
* @param array $errors
* List of errors to be posted back to the form.
*
- * @return array $errors
+ * @return array
* @static
*/
public static function formRule($fields, $errors) {
* @param array $errors
* List of errors to be posted back to the form.
*
- * @return array $errors
+ * @return array
* @static
*/
public static function formRule($fields, $errors) {
*
* access public
*
- * @return array reference to the array of default values
+ * @return array
+ * reference to the array of default values
*
*/
/**
/**
* Define the set of valid contexts that the search form operates on
*
- * @return array the valid context set and the titles
+ * @return array
+ * the valid context set and the titles
* @static
*/
public static function &validContext() {
* Set the default form values
*
*
- * @return array the default array reference
+ * @return array
+ * the default array reference
*/
public function setDefaultValues() {
$defaults = $this->_formValues;
* Set the default form values
*
*
- * @return array the default array reference
+ * @return array
+ * the default array reference
*/
public function setDefaultValues() {
$defaults = array();
* @param $files
* @param $self
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($values, $files, $self) {
/**
* CRM-9434 Hackish function to fetch fields with options.
* FIXME: When our core fields contain reliable metadata this will be much simpler.
- * @return array: (string => string) key: field_name value: api entity name
+ * @return array
+ * (string => string) key: field_name value: api entity name
* Note: options are fetched via ajax using the api "getoptions" method
*/
public static function fieldOptions() {
*
* access public
*
- * @return array reference to the array of default values
+ * @return array
+ * reference to the array of default values
*
*/
/**
/**
* @param int|array $limit
- * @return string SQL
+ * @return string
+ * SQL
* @see CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery::toLimit
*/
public function toLimit($limit) {
* NULL if no limit; or array(0 => $limit, 1 => $offset)
* @param array|NULL $detailLimit final limit (applied when building $detailTable)
* NULL if no limit; or array(0 => $limit, 1 => $offset)
- * @return array keys: match-descriptor
+ * @return array
+ * keys: match-descriptor
* - count: int
*/
public abstract function fillTempTable($queryText, $entityIDTableName, $detailTable, $queryLimit, $detailLimit);
* - sql: an array of SQL queries to execute
* - final: an array of SQL queries to execute at the end
* - *: All other keys are treated as table names
- * @return array keys: match-descriptor
+ * @return array
+ * keys: match-descriptor
* - count: int
* - files: NULL | array
*/
* Eg "civicrm_note" or "civicrm_note mynote".
* @param array|string $fullTextFields list of field names
* @param string $queryText
- * @return string SQL, eg "MATCH (col1) AGAINST (queryText)" or "col1 LIKE '%queryText%'"
+ * @return string
+ * SQL, eg "MATCH (col1) AGAINST (queryText)" or "col1 LIKE '%queryText%'"
*/
public function matchText($table, $fullTextFields, $queryText) {
$strtolower = function_exists('mb_strtolower') ? 'mb_strtolower' : 'strtolower';
/**
* @param int|array $limit
- * @return string SQL
+ * @return string
+ * SQL
* @see CRM_Contact_Form_Search_Custom_FullText::toLimit
*/
public function toLimit($limit) {
/**
* @param array|int $limit
- * @return array (0 => $limit, 1 => $offset)
+ * @return array
+ * (0 => $limit, 1 => $offset)
*/
public function parseLimitOffset($limit) {
if (is_scalar($limit)) {
/**
* @param string $queryText
* @param string $entityIDTableName
- * @return array list tables/queries (for runQueries)
+ * @return array
+ * list tables/queries (for runQueries)
*/
public function prepareQueries($queryText, $entityIDTableName) {
// Note: For available full-text indices, see CRM_Core_InnoDBIndexer
/**
* @param string $queryText
* @param string $entityIDTableName
- * @return array list tables/queries (for runQueries)
+ * @return array
+ * list tables/queries (for runQueries)
*/
public function prepareQueries($queryText, $entityIDTableName) {
// Note: For available full-text indices, see CRM_Core_InnoDBIndexer
/**
* @param string $queryText
* @param string $entityIDTableName
- * @return array list tables/queries (for runQueries)
+ * @return array
+ * list tables/queries (for runQueries)
*/
public function prepareQueries($queryText, $entityIDTableName) {
// Note: For available full-text indices, see CRM_Core_InnoDBIndexer
*
* @param string $queryText
* @param string $entityIDTableName
- * @return array list tables/queries (for runQueries)
+ * @return array
+ * list tables/queries (for runQueries)
*/
public function prepareQueries($queryText, $entityIDTableName) {
// Note: For available full-text indices, see CRM_Core_InnoDBIndexer
*
* @param string $queryText
* @param string $entityIDTableName
- * @return array list tables/queries (for runQueries)
+ * @return array
+ * list tables/queries (for runQueries)
*/
public function prepareQueries($queryText, $entityIDTableName) {
// Note: For available full-text indices, see CRM_Core_InnoDBIndexer
*
* @param string $queryText
* @param string $entityIDTableName
- * @return array list tables/queries (for runQueries)
+ * @return array
+ * list tables/queries (for runQueries)
*/
public function prepareQueries($queryText, $entityIDTableName) {
// Note: For available full-text indices, see CRM_Core_InnoDBIndexer
* Set the default form values
*
*
- * @return array the default array reference
+ * @return array
+ * the default array reference
*/
public function setDefaultValues() {
$defaults = array();
*
* @param array $params
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($params) {
* Set the default form values
*
*
- * @return array the default array reference
+ * @return array
+ * the default array reference
*/
public function setDefaultValues() {
$defaults = array();
*
* @param null
*
- * @return array array of default values
+ * @return array
+ * array of default values
*/
public function setDefaultValues() {
$defaults = array();
* @param bool $mergeSameHousehold
* UNUSED.
*
- * @return array of rows for labels
+ * @return array
+ * of rows for labels
*/
public static function getRows($contactIDs, $locationTypeID, $respectDoNotMail, $mergeSameAddress, $mergeSameHousehold) {
/**
* Get array of return properties for address fields required for mailing label
- * @return array return properites for address e.g
+ * @return array
+ * return properites for address e.g
* array (
* - [street_address] => 1,
* - [supplemental_address_1] => 1,
* @param $addBreadCrumb
* @param string $type
*
- * @return string the location of the file we have created
+ * @return string
+ * the location of the file we have created
*/
public static function createMapXML($ids, $locationId, &$page, $addBreadCrumb, $type = 'Contact') {
$config = CRM_Core_Config::singleton();
* @param array $fields
* Posted values of the form.
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($fields) {
*
* @param CRM_Core_Form $form
*
- * @return array the default array reference
+ * @return array
+ * the default array reference
*/
public function setDefaultValues($form) {
$defaults = array();
* Set the default form values
*
*
- * @return array the default array reference
+ * @return array
+ * the default array reference
*/
public function setDefaultValues() {
$defaults = array();
*
* access public
*
- * @return array reference to the array of default values
+ * @return array
+ * reference to the array of default values
*
*/
/**
* @param array $fields
* Posted values of the form.
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($fields) {
* @param $files
* @param $self
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($fields, $files, $self) {
/**
* Format the field values for input to the api
*
- * @return array (reference ) associative array of name/value pairs
+ * @return array
+ * (reference ) associative array of name/value pairs
*/
public function &getActiveFieldParams() {
$params = array();
* @param array $values
* The array of values belonging to this line.
*
- * @return boolean the result of this processing
+ * @return boolean
+ * the result of this processing
*/
public function preview(&$values) {
return $this->summary($values);
* @param array $values
* The array of values belonging to this line.
*
- * @return boolean the result of this processing
+ * @return boolean
+ * the result of this processing
*/
public function summary(&$values) {
$erroneousField = NULL;
*
* @param bool $doGeocodeAddress
*
- * @return boolean the result of this processing
+ * @return boolean
+ * the result of this processing
*/
public function import($onDuplicate, &$values, $doGeocodeAddress = FALSE) {
$config = CRM_Core_Config::singleton();
/**
* Get BAO Name
*
- * @return string Classname of BAO.
+ * @return string
+ * Classname of BAO.
*/
public function getBAOName() {
return 'CRM_Dedupe_BAO_RuleGroup';
/**
* Get action Links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
*/
public function &links() {
}
/**
* Get name of edit form
*
- * @return string classname of edit form
+ * @return string
+ * classname of edit form
*/
public function editForm() {
return 'CRM_Contact_Form_DedupeFind';
/**
* Get edit form name
*
- * @return string name of this page
+ * @return string
+ * name of this page
*/
public function editName() {
return 'DedupeFind';
*
* @param null $mode
*
- * @return string user context
+ * @return string
+ * user context
*/
public function userContext($mode = NULL) {
return 'civicrm/contact/dedupefind';
/**
* Get BAO Name
*
- * @return string Classname of BAO.
+ * @return string
+ * Classname of BAO.
*/
public function getBAOName() {
return 'CRM_Dedupe_BAO_RuleGroup';
/**
* Get action Links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
*/
public function &links() {
if (!(self::$_links)) {
/**
* Get name of edit form
*
- * @return string classname of edit form
+ * @return string
+ * classname of edit form
*/
public function editForm() {
return 'CRM_Contact_Form_DedupeRules';
/**
* Get edit form name
*
- * @return string name of this page
+ * @return string
+ * name of this page
*/
public function editName() {
return 'DedupeRules';
*
* @param null $mode
*
- * @return string user context
+ * @return string
+ * user context
*/
public function userContext($mode = NULL) {
return 'civicrm/contact/deduperules';
/**
* Get action Links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
* @static
*/
public static function &links() {
/**
* Returns the page title
*
- * @return string the title of the page
+ * @return string
+ * the title of the page
*/
public function getTitle() {
return "Task Results";
*
* @param int $contactId
*
- * @return array contact fields in fixed order
+ * @return array
+ * contact fields in fixed order
*/
public static function getContactDetails($contactId) {
return list($displayName,
/**
* Get action links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
* @static
*/
public static function &links() {
/**
* Get action links for comments
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
* @static
*/
public static function &commentLinks() {
/**
* Get action links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
* @static
*/
public static function &links() {
/**
* Get action links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
* @static
*/
static
* @param enum $output
* What should the result set include (web/email/csv).
*
- * @return array the column headers that need to be displayed
+ * @return array
+ * the column headers that need to be displayed
*/
public function &getColumnHeaders($action = NULL, $output = NULL) {
$headers = NULL;
*
* @param
*
- * @return int Total number of rows
+ * @return int
+ * Total number of rows
*/
public function getTotalCount($action) {
// Use count from cache during paging/sorting
* @param enum $output
* What should the result set include (web/email/csv).
*
- * @return int the total number of rows for this action
+ * @return int
+ * the total number of rows for this action
*/
public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
$config = CRM_Core_Config::singleton();
* @param array(
reference) $formValues submitted formValues
*
- * @return array $qill which contains an array of strings
+ * @return array
+ * which contains an array of strings
*/
// the current internationalisation is bad, but should more or less work
* @param string $output
* Type of output.
*
- * @return string name of the file
+ * @return string
+ * name of the file
*/
public function getExportFileName($output = 'csv') {
return ts('CiviCRM Contact Search');
* Get colunmn headers for search selector
*
*
- * @return array $_columnHeaders
+ * @return array
*/
private static function &_getColumnHeaders() {
if (!isset(self::$_columnHeaders)) {
* Default function for qill, if needed to be implemented, we
* expect the subclass to do it
*
- * @return string the status message
+ * @return string
+ * the status message
*/
/**
* @return string
* @param enum $output
* What should the result set include (web/email/csv).
*
- * @return array the column headers that need to be displayed
+ * @return array
+ * the column headers that need to be displayed
*/
public function &getColumnHeaders($action = NULL, $output = NULL) {
$columns = $this->_search->columns();
*
* @param
*
- * @return int Total number of rows
+ * @return int
+ * Total number of rows
*/
public function getTotalCount($action) {
return $this->_search->count();
* @param enum $output
* What should the result set include (web/email/csv).
*
- * @return int the total number of rows for this action
+ * @return int
+ * the total number of rows for this action
*/
public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
* @param array(
reference) $formValues submitted formValues
*
- * @return array $qill which contains an array of strings
+ * @return array
+ * which contains an array of strings
*/
public function getQILL() {
return NULL;
* @param string $output
* Type of output.
*
- * @return string name of the file
+ * @return string
+ * name of the file
*/
public function getExportFileName($output = 'csv') {
return ts('CiviCRM Custom Search');
*
* @param string $formName
*
- * @return string the name of the form that will handle the task
+ * @return string
+ * the name of the form that will handle the task
*/
public function taskName($controller, $formName = 'Search') {
// total hack, check POST vars and then session to determine stuff
* These tasks are the core set of tasks that the user can perform
* on a contact / group of contacts
*
- * @return array the set of tasks for a group of contacts
+ * @return array
+ * the set of tasks for a group of contacts
* @static
*/
public static function &taskTitles() {
* @param bool $deletedContacts
* Are these tasks for operating on deleted contacts?.
*
- * @return array set of tasks that are valid for the user
+ * @return array
+ * set of tasks that are valid for the user
*/
public static function &permissionedTaskTitles($permission, $deletedContacts = FALSE) {
self::initTasks();
/**
* These tasks get added based on the context the user is in
*
- * @return array the set of optional tasks for a group of contacts
+ * @return array
+ * the set of optional tasks for a group of contacts
* @static
*/
public static function &optionalTaskTitle() {
* @param string $contactType
* @param bool $status
*
- * @return array array of importable Fields
+ * @return array
+ * array of importable Fields
* @static
*/
public static function &importableFields($contactType = 'Individual', $status = TRUE) {
*
* @param int $id
*
- * @return boolean true if duplicate, false otherwise
+ * @return boolean
+ * true if duplicate, false otherwise
* static
*/
public static function checkDuplicate($input, &$duplicates, $id = NULL) {
* @param bool $addExtraFields
* True if special fields needs to be added.
*
- * @return array the list of contribution fields
+ * @return array
+ * the list of contribution fields
* @static
*/
public static function getContributionFields($addExtraFields = TRUE) {
* @param array $params
* An assoc array of name/value pairs.
*
- * @return array contribution id if success else NULL
+ * @return array
+ * contribution id if success else NULL
* static
*/
public static function checkDuplicateIds($params) {
* @param string $componentIds
* Component ids.
*
- * @return array associated array
+ * @return array
+ * associated array
*
* @static
*/
* @param int $contributorId
* Contributor id.
*
- * @return array $ids containing organization id and individual id
+ * @return array
+ * containing organization id and individual id
*/
public static function getOnbehalfIds($contributionId, $contributorId = NULL) {
* Distinguishes between whether to send message or return.
* message text. We are working towards this function ALWAYS returning message text & calling
* function doing emails / pdfs with it
- * @return array $messageArray - messages
+ * @return array
+ * messages
*/
/**
* @param $input
* @param array $ids
* The set of ids related to the inpurt.
*
- * @return array $values
+ * @return array
*
* NB don't add direct calls to the function as we intend to change the signature
*/
* @param int $contributionId
* Contribution id.
*
- * @return string $status contribution status
+ * @return string
+ * contribution status
* @static
*/
public static function isSubscriptionCancelled($contributionId) {
*
* @throws CRM_Core_Exception
* @throws Exception
- * @return array associated array
+ * @return array
+ * associated array
*
* @static
*/
* @param int $param
* Year.
*
- * @return array associated array
+ * @return array
+ * associated array
*
* @static
*/
/**
* Get the contribution details by year
*
- * @return array associated array
+ * @return array
+ * associated array
*
* @static
*/
* @param float $taxRate
* Tax rate of selected financial account for field.
*
- * @return array array of tax amount
+ * @return array
+ * array of tax amount
*
* @static
*
* @param bool $is_active
* Value we want to set the is_active field.
*
- * @return Object DAO object on success, null otherwise
+ * @return Object
+ * DAO object on success, null otherwise
* @static
*/
public static function setIsActive($id, $is_active) {
* @param int $contributionPageId
* Contribution Page Id.
*
- * @return boolean true if payment processor supports recurring
+ * @return boolean
+ * true if payment processor supports recurring
* else false
*
* @static
* Get info for all sections enable/disable.
*
* @param array $contribPageIds
- * @return array $info info regarding all sections.
+ * @return array
+ * info regarding all sections.
* @static
*/
public static function getSectionInfo($contribPageIds = array()) {
* Contribution Page Id.
* @param int $userID
* Contact id for contributor.
- * @return array $pdfHtml
+ * @return array
*/
public static function addInvoicePdfToEmail($contributionId, $userID) {
$contributionID = array($contributionId);
* Helper to determine if the page supports separate membership payments
* @param int id form id
*
- * @return bool isSeparateMembershipPayment
+ * @return bool
+ * isSeparateMembershipPayment
*/
public static function getIsMembershipPayment($id) {
$membershipBlocks = civicrm_api3('membership_block', 'get', array('entity_table' => 'civicrm_contribution_page', 'entity_id' => $id, 'sequential' => TRUE));
* @param array $params
* (reference ) an assoc array of name/value pairs.
*
- * @return object activity contact object
+ * @return object
+ * activity contact object
*
*/
public static function create(&$params) {
* @param array $duplicates
* (reference ) store ids of duplicate contribs.
*
- * @return boolean true if duplicate, false otherwise
+ * @return boolean
+ * true if duplicate, false otherwise
* static
*/
public static function checkDuplicate($params, &$duplicates) {
* @param array $ids
* (reference ) an array of recurring contribution ids.
*
- * @return array $totalCount an array of recurring ids count
+ * @return array
+ * an array of recurring ids count
* static
*/
public static function getCount(&$ids) {
* @param int $contactId
* Contact ID.
*
- * @return array list of recurring contribution fields
+ * @return array
+ * list of recurring contribution fields
*
* @static
*/
* @param array $params
* (reference ) an assoc array of name/value pairs.
*
- * @return object soft contribution of object that is added
+ * @return object
+ * soft contribution of object that is added
*
*/
public static function add(&$params) {
* @param bool $all
* Include PCP data.
*
- * @return array of soft contribution ids, amounts, and associated contact ids
+ * @return array
+ * of soft contribution ids, amounts, and associated contact ids
* @static
*/
public static function getSoftContribution($contributionID, $all = FALSE) {
* @param bool $is_active
* Value we want to set the is_active field.
*
- * @return Object DAO object on sucess, null otherwise
+ * @return Object
+ * DAO object on sucess, null otherwise
* @static
*/
public static function setIsActive($id, $is_active) {
* @param bool $is_active
* Value we want to set the is_active field.
*
- * @return Object DAO object on sucess, null otherwise
+ * @return Object
+ * DAO object on sucess, null otherwise
* @static
*/
public static function setIsActive($id, $is_active) {
/**
* Retrieve premium product and their options
*
- * @return array product and option arrays
+ * @return array
+ * product and option arrays
* @static
*/
public static function getPremiumProductInfo() {
/**
* Function get the import/export fields for contribution
*
- * @return array self::$_contributionFields associative array of contribution fields
+ * @return array
+ * self::$_contributionFields associative array of contribution fields
* @static
*/
public static function &getFields() {
}
/**
- * @return array of valid processors. The array resembles the DB table but also has 'object' as a key
+ * @return array
+ * of valid processors. The array resembles the DB table but also has 'object' as a key
* @throws Exception
*/
public function getValidProcessors() {
*
* access public
*
- * @return array reference to the array of default values
+ * @return array
+ * reference to the array of default values
*
*/
/**
*
* @param null
*
- * @return array array of default values
+ * @return array
+ * array of default values
*/
public function setDefaultValues() {
$defaults = array('is_notify' => 1);
* the default values are retrieved from the database
*
*
- * @return array defaults
+ * @return array
+ * defaults
*/
public function setDefaultValues() {
//some child classes calling setdefaults directly w/o preprocess.
* @param $files
* @param $self
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($values, $files, $self) {
* @param $errors
* @param $self
*
- * @return array of errors
+ * @return array
+ * of errors
* @static
*/
public static function formRule($fields, $errors, $self) {
*
* @param array $values
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($values) {
* @param array $contactIds
* Contact Id.
*
- * @return array array of common elements
+ * @return array
+ * array of common elements
*
* @static
*/
*
* access public
*
- * @return array reference to the array of default values
+ * @return array
+ * reference to the array of default values
*
*/
/**
* @param string $task
* @param string $separator
*
- * @return array:
+ * @return array
+ *
*/
public static function buildContributionArray($groupBy, $form, $returnProperties, $skipOnHold, $skipDeceased, $messageToken, $task, $separator) {
$contributions = $contacts = $notSent = array();
* @param array $fields
* Posted values of the form.
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($fields) {
* @param array $fields
* Posted values of the form.
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($fields) {
*
* access public
*
- * @return array reference to the array of default values
+ * @return array
+ * reference to the array of default values
*
*/
/**
* @param $files
* @param $self
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($fields, $files, $self) {
/**
* Format the field values for input to the api
*
- * @return array (reference ) associative array of name/value pairs
+ * @return array
+ * (reference ) associative array of name/value pairs
*/
public function &getActiveFieldParams() {
$params = array();
* @param array $values
* The array of values belonging to this line.
*
- * @return boolean the result of this processing
+ * @return boolean
+ * the result of this processing
*/
public function preview(&$values) {
return $this->summary($values);
* @param array $values
* The array of values belonging to this line.
*
- * @return boolean the result of this processing
+ * @return boolean
+ * the result of this processing
*/
public function summary(&$values) {
$erroneousField = NULL;
* @param array $values
* The array of values belonging to this line.
*
- * @return boolean the result of this processing
+ * @return boolean
+ * the result of this processing
*/
public function import($onDuplicate, &$values) {
// first make sure this is a valid line
* Needs to be implemented in component's information
* class.
*
- * @return array collection of required component settings
+ * @return array
+ * collection of required component settings
*
*/
/**
/**
* Provides permissions that are unwise for Anonymous Roles to have
*
- * @return array list of permissions
+ * @return array
+ * list of permissions
* @see CRM_Component_Info::getPermissions
*/
/**
/**
* Get BAO Name
*
- * @return string Classname of BAO.
+ * @return string
+ * Classname of BAO.
*/
public function getBAOName() {
return 'CRM_Contribute_BAO_ManagePremiums';
/**
* Get action Links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
*/
public function &links() {
if (!(self::$_links)) {
/**
* Get name of edit form
*
- * @return string Classname of edit form.
+ * @return string
+ * Classname of edit form.
*/
public function editForm() {
return 'CRM_Contribute_Form_ManagePremiums';
/**
* Get edit form name
*
- * @return string name of this page.
+ * @return string
+ * name of this page.
*/
public function editName() {
return 'Manage Premiums';
*
* @param null $mode
*
- * @return string user context.
+ * @return string
+ * user context.
*/
public function userContext($mode = NULL) {
return 'civicrm/admin/contribute/managePremiums';
* pages. This typically involves assigning the appropriate
* smarty variable :)
*
- * @return string The content generated by running this page
+ * @return string
+ * The content generated by running this page
*/
/**
* @return string
/**
* Get BAO Name
*
- * @return string Classname of BAO.
+ * @return string
+ * Classname of BAO.
*/
public function getBAOName() {
return 'CRM_Contribute_BAO_Premium';
/**
* Get action Links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
*/
public function &links() {
if (!(self::$_links)) {
/**
* Get name of edit form
*
- * @return string Classname of edit form.
+ * @return string
+ * Classname of edit form.
*/
public function editForm() {
return 'CRM_Contribute_Form_ContributionPage_Premium';
/**
* Get edit form name
*
- * @return string name of this page.
+ * @return string
+ * name of this page.
*/
public function editName() {
return 'Configure Premiums';
*
* @param null $mode
*
- * @return string user context.
+ * @return string
+ * user context.
*/
public function userContext($mode = NULL) {
return CRM_Utils_System::currentPath();
*
* @param int $id
*
- * @return array - array reference of all financial types if any
+ * @return array
+ * array reference of all financial types if any
* @static
*/
public static function &financialType($id = NULL) {
* @param string $retrieveColumn
* @param string $key
*
- * @return array - array reference of all financial accounts if any
+ * @return array
+ * array reference of all financial accounts if any
* @static
*/
public static function &financialAccount($id = NULL, $financialAccountTypeId = NULL, $retrieveColumn = 'name', $key = 'id') {
* Do we want all pages or only active pages.
*
*
- * @return array - array reference of all contribution pages if any
+ * @return array
+ * array reference of all contribution pages if any
* @static
*/
public static function &contributionPage($id = NULL, $all = FALSE) {
*
* @param string $columnName
*
- * @return array - array reference of all payment instruments if any
+ * @return array
+ * array reference of all payment instruments if any
* @static
*/
public static function &paymentInstrument($columnName = 'label') {
* Get all the valid accepted credit cards
*
*
- * @return array - array reference of all payment instruments if any
+ * @return array
+ * array reference of all payment instruments if any
* @static
*/
public static function &creditCard() {
*
*
* @param int $pageID
- * @return array - array of all Premiums if any
+ * @return array
+ * array of all Premiums if any
* @static
*/
public static function products($pageID = NULL) {
*
* @param int $id
* @param string $columnName
- * @return array - array reference of all contribution statuses
+ * @return array
+ * array reference of all contribution statuses
* @static
*/
public static function &contributionStatus($id = NULL, $columnName = 'label') {
* @param null $pageType
* @param int $id
*
- * @return array - array reference of all pcp if any
+ * @return array
+ * array reference of all pcp if any
* @static
*/
public static function &pcPage($pageType = NULL, $id = NULL) {
* @static
*
* @param string $column
- * @return array - array reference of all PCP activity statuses
+ * @return array
+ * array reference of all PCP activity statuses
*/
public static function &pcpStatus($column = 'label') {
if (NULL === self::$pcpStatus) {
*
* @param int $financialTypeId
* @param int $relationTypeId
- * @return array - array reference of all financial accounts for a Financial type
+ * @return array
+ * array reference of all financial accounts for a Financial type
*/
public static function financialAccountType($financialTypeId, $relationTypeId = NULL) {
if (!CRM_Utils_Array::value($financialTypeId, self::$financialTypeAccount)) {
*
*
* @param int $id
- * @return array - array reference of all batches if any
+ * @return array
+ * array reference of all batches if any
* @static
*/
public static function &batch($id = NULL) {
*
* @param
*
- * @return int Total number of rows
+ * @return int
+ * Total number of rows
*/
public function getTotalCount($action) {
return $this->_query->searchQuery(0, 0, NULL,
* @param enum $output
* What should the result set include (web/email/csv).
*
- * @return int the total number of rows for this action
+ * @return int
+ * the total number of rows for this action
*/
public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
if ($this->_includeSoftCredits) {
}
/**
- * @return array $qill which contains an array of strings
+ * @return array
+ * which contains an array of strings
*/
// the current internationalisation is bad, but should more or less work
* @param enum $output
* What should the result set include (web/email/csv).
*
- * @return array the column headers that need to be displayed
+ * @return array
+ * the column headers that need to be displayed
*/
public function &getColumnHeaders($action = NULL, $output = NULL) {
self::$_columnHeaders = array(
* @param string $output
* Type of output.
*
- * @return string name of the file
+ * @return string
+ * name of the file
*/
public function getExportFileName($output = 'csv') {
return ts('CiviCRM Contribution Search');
*
* @param string $formName
*
- * @return string the name of the form that will handle the task
+ * @return string
+ * the name of the form that will handle the task
*/
public function taskName($controller, $formName = 'Search') {
// total hack, check POST vars and then session to determine stuff
* These tasks are the core set of tasks that the user can perform
* on a contact / group of contacts
*
- * @return array the set of tasks for a group of contacts
+ * @return array
+ * the set of tasks for a group of contacts
* @static
*/
public static function &tasks() {
* These tasks are the core set of task titles
* on contributors
*
- * @return array the set of task titles
+ * @return array
+ * the set of task titles
* @static
*/
public static function &taskTitles() {
*
* @param bool $softCreditFiltering
*
- * @return array set of tasks that are valid for the user
+ * @return array
+ * set of tasks that are valid for the user
*/
public static function &permissionedTaskTitles($permission, $softCreditFiltering = FALSE) {
$tasks = array();
*
* @param int $value
*
- * @return array the set of tasks for a group of contributors
+ * @return array
+ * the set of tasks for a group of contributors
* @static
*/
public static function getTask($value) {
* @param string $str
* The action to be resolved.
*
- * @return int the action mask corresponding to the input string
+ * @return int
+ * the action mask corresponding to the input string
* @static
*/
public static function resolve($str) {
* @param mixed $item
* Either a single string or an array of strings.
*
- * @return int the action mask corresponding to the input args
+ * @return int
+ * the action mask corresponding to the input args
* @static
*
*/
* @param string $item
* The input action to process.
*
- * @return int the action mask corresponding to the input string
+ * @return int
+ * the action mask corresponding to the input string
* @static
*
*/
* @param int $mask
* The action mask.
*
- * @return string the corresponding action description
+ * @return string
+ * the corresponding action description
* @static
*
*/
* @param null $objectName
* @param int $objectId
*
- * @return string the html string
+ * @return string
+ * the html string
* @static
*/
static function formLink(
* @param array $values
* The array of values for parameter substitution in the str.
*
- * @return string the substituted string
+ * @return string
+ * the substituted string
* @static
*/
public static function &replace(&$str, &$values) {
*
* @param string the permission
*
- * @return int the mask for the above permission
+ * @return int
+ * the mask for the above permission
* @static
*/
public static function mask($permissions) {
* @param bool $id
* Mapping id.
*
- * @return array associated array of all the drop downs in the form
+ * @return array
+ * associated array of all the drop downs in the form
* @static
*/
public static function getSelection($id = NULL) {
* @param null $entityValue
* @param int $id
*
- * @return array (reference) reminder list
+ * @return array
+ * (reference) reminder list
* @static
*/
public static function &getList($namesOnly = FALSE, $entityValue = NULL, $id = NULL) {
* @param bool $is_active
* Value we want to set the is_active field.
*
- * @return Object DAO object on success, null otherwise
+ * @return Object
+ * DAO object on success, null otherwise
* @static
*/
public static function setIsActive($id, $is_active) {
*
* @param null $entity
*
- * @return array $blocks array of created address
+ * @return array
+ * array of created address
* @static
*/
public static function create(&$params, $fixAddress = TRUE, $entity = NULL) {
* True if you need to fix (format) address values.
* before inserting in db
*
- * @return object CRM_Core_BAO_Address object on success, null otherwise
+ * @return object
+ * CRM_Core_BAO_Address object on success, null otherwise
* @static
*/
public static function add(&$params, $fixAddress) {
* If microformat output is required.
* @param int|string $fieldName conditional field name
*
- * @return array $addresses array with address fields
+ * @return array
+ * array with address fields
* @static
*/
public static function &getValues($entityBlock, $microformat = FALSE, $fieldName = 'contact_id') {
*
* @param bool $updateBlankLocInfo
*
- * @return array the array of adrress data
+ * @return array
+ * the array of adrress data
* @static
*/
public static function allAddress($id, $updateBlankLocInfo = FALSE) {
* The array containing entity_id and.
* entity_table name
*
- * @return array the array of adrress data
+ * @return array
+ * the array of adrress data
* @static
*/
public static function allEntityAddress(&$entityElements) {
/**
* Get address sequence
*
- * @return array of address sequence.
+ * @return array
+ * of address sequence.
*/
public static function addressSequence() {
$config = CRM_Core_Config::singleton();
* @param string Street address including number and apt
* @param string Locale - to set locale used to parse address
*
- * @return array $parseFields parsed fields values.
+ * @return array
+ * parsed fields values.
* @static
*/
public static function parseStreetAddress($streetAddress, $locale = NULL) {
* @param array $fields
* An array of importable/exportable contact fields.
*
- * @return array $fields an array of contact fields and only the enabled address options
+ * @return array
+ * an array of contact fields and only the enabled address options
* @static
*/
public static function validateAddressOptions($fields) {
* @param bool $returnStatus
* By default false.
*
- * @return string $statusMessage
+ * @return string
* @static
*/
public static function setSharedAddressDeleteStatus($addressId = NULL, $contactId = NULL, $returnStatus = FALSE) {
* @param array $params
* Input parameters to find object.
*
- * @return array of $block objects.
+ * @return array
+ * of $block objects.
* @static
*/
public static function &getValues($blockName, $params) {
* @param string $blockName
* Name of the above object.
*
- * @return array of $block objects.
+ * @return array
+ * of $block objects.
* @static
*/
public static function retrieveBlock(&$block, $blockName) {
* @param array $params
* Associated array of submitted fields.
*
- * @return boolean true if the block has data, otherwise false
+ * @return boolean
+ * true if the block has data, otherwise false
* @static
*/
public static function dataExists($blockFields, &$params) {
* @param array $params
* Associated array of submitted fields.
*
- * @return boolean true if the block exits, otherwise false
+ * @return boolean
+ * true if the block exits, otherwise false
* @static
*/
public static function blockExists($blockName, &$params) {
* @param null $entityElements
* @param bool $updateBlankLocInfo
*
- * @return array $contactBlockIds formatted array of block ids
+ * @return array
+ * formatted array of block ids
*
* @static
*/
* @param null $entity
* @param int $contactId
*
- * @return object CRM_Core_BAO_Block object on success, null otherwise
+ * @return object
+ * CRM_Core_BAO_Block object on success, null otherwise
* @static
*/
public static function create($blockName, &$params, $entity = NULL, $contactId = NULL) {
* @param string $mail
* Email id for cms user.
*
- * @return int contact id that has been created
+ * @return int
+ * contact id that has been created
* @static
*/
public static function create(&$params, $mail) {
* @param int $componentID
* The optional component ID (so componenets can share the same name space).
*
- * @return object The data if present in cache, else null
+ * @return object
+ * The data if present in cache, else null
* @static
*/
public static function &getItem($group, $path, $componentID = NULL) {
* @param int $componentID
* The optional component ID (so componenets can share the same name space).
*
- * @return object The data if present in cache, else null
+ * @return object
+ * The data if present in cache, else null
* @static
*/
public static function &getItems($group, $componentID = NULL) {
*
* @param $defaults
*
- * @return array $defaults
+ * @return array
* @static
*/
public static function retrieve(&$defaults) {
/**
* Return likely default settings
- * @return array site settings
+ * @return array
+ * site settings
* -$url,
* - $dir Base Directory
* - $siteName
* @param string $componentName
* Name of the component to be enabled, needs to be valid.
*
- * @return boolean - true if valid component name and enabling succeeds, else false
+ * @return boolean
+ * true if valid component name and enabling succeeds, else false
* @static
*/
public static function enableComponent($componentName) {
*
* @param NULL
*
- * @return array Data type => Description
+ * @return array
+ * Data type => Description
* @static
*/
public static function &dataType() {
* @param bool $is_active
* Value we want to set the is_active field.
*
- * @return Object DAO object on sucess, null otherwise
+ * @return Object
+ * DAO object on sucess, null otherwise
*
* @static
*/
* @param int $id
* Id of field.
*
- * @return string name
+ * @return string
+ * name
*
* @static
*
* @param bool $checkPermission
* If false, do not include permissioning clause.
*
- * @return array $fields - an array of active custom fields.
+ * @return array
+ * an array of active custom fields.
*
* @static
*/
*
* @param bool $withMultiple
*
- * @return array $fields -
+ * @return array
+ *
*
* @static
*/
* @param int $contactID
* @param int $fieldID
*
- * @return string the display value
+ * @return string
+ * the display value
*
* @static
*/
* @param bool $includeViewOnly
* If true, fields marked 'View Only' are included. Required for APIv3.
*
- * @return array $customFormatted formatted custom field array
+ * @return array
+ * formatted custom field array
* @static
*/
static function formatCustomField(
* @param bool $force
* Force the sql to be run again (primarily used for tests).
*
- * @return array - fatal is fieldID does not exists, else array of tableName, columnName
+ * @return array
+ * fatal is fieldID does not exists, else array of tableName, columnName
* @static
*/
public static function getTableColumnGroup($fieldID, $force = FALSE) {
* Custom data submitted.
* ie array( 'custom_1' => 'validate me' );
*
- * @return array $errors validation errors.
+ * @return array
+ * validation errors.
* @static
*/
public static function validateCustomData($params) {
* @param bool $is_activeValue we want to set the is_active field.
* Value we want to set the is_active field.
*
- * @return Object DAO object on sucess, null otherwise
+ * @return Object
+ * DAO object on sucess, null otherwise
* @static
*/
public static function setIsActive($id, $is_active) {
*
* @param int $activityTypeId
*
- * @return bool TRUE if a group is found or created; FALSE on error
+ * @return bool
+ * TRUE if a group is found or created; FALSE on error
*/
public static function autoCreateByActivityType($activityTypeId) {
if (self::hasCustomGroup('Activity', NULL, $activityTypeId)) {
* @param bool $fromCache
* @param bool $onlySubType
*
- * @return array $groupTree - array The returned array is keyed by group id and has the custom group table fields
+ * @return array
+ * array The returned array is keyed by group id and has the custom group table fields
* and a subkey 'fields' holding the specific custom fields.
* If entityId is passed in the fields keys have a subkey 'customValue' which holds custom data
* if set for the given entity. This is structured as an array of values with each one having the keys 'id', 'data'
*
* @param bool $getCount
*
- * @return boolean does this entity have data in this custom table
+ * @return boolean
+ * does this entity have data in this custom table
*/
static public function customGroupDataExistsForEntity($entityID, $table, $getCount = FALSE) {
$query = "
* @param int $id
* Id of group.
*
- * @return string title
+ * @return string
+ * title
*
* @static
*
*
* @param null $inSelector
*
- * @return array $groupTree - array consisting of all group and field details
+ * @return array
+ * array consisting of all group and field details
*
*
* @static
* @param string $entityType
* What entity are we extending here ?.
*
- * @return string $tableName
+ * @return string
*
* @static
*
* @param bool $force
* whether to force the deletion, even if there are custom fields.
*
- * @return boolean false if field exists for this group, true if group gets deleted.
+ * @return boolean
+ * false if field exists for this group, true if group gets deleted.
*
* @static
*
* Remove custom fields of a type eg: array("Individual") ;.
*
*
- * @return boolean false if it matches else true
+ * @return boolean
+ * false if it matches else true
* @static
*/
public static function checkCustomField($customFieldId, &$removeCustomFieldTypes) {
* Group count by default 1, but can varry for multiple value custom data.
* @param object form object
*
- * @return array $formattedGroupTree
+ * @return array
*/
public static function formatGroupTree(&$groupTree, $groupCount = 1, &$form) {
$formattedGroupTree = array();
* @param array $fieldIds
* Array of custom field ids.
*
- * @return array $groupLabels - array consisting of groups and fields labels with ids.
+ * @return array
+ * array consisting of groups and fields labels with ids.
*/
public static function getGroupTitles($fieldIds) {
if (!is_array($fieldIds) && empty($fieldIds)) {
* @param int $gID
* Custom group id.
*
- * @return boolean true if empty otherwise false.
+ * @return boolean
+ * true if empty otherwise false.
*/
public static function isGroupEmpty($gID) {
if (!$gID) {
* @param array $types
* Var which should have the list appended.
*
- * @return array of types.
+ * @return array
+ * of types.
*/
public static function getExtendedObjectTypes(&$types = array()) {
static $flag = FALSE, $objTypes = array();
* @param bool $inactiveNeededDo we need inactive options ?.
* Do we need inactive options ?.
*
- * @return array $customOption all active options for fieldId
+ * @return array
+ * all active options for fieldId
* @static
*/
static function getCustomOption(
* @param string $dataType
* the data type of the field (optional).
*
- * @return string the label to display for this custom field
+ * @return string
+ * the label to display for this custom field
* @static
*/
public static function getOptionLabel($fieldId, $value, $htmlType = NULL, $dataType = NULL) {
*
* @param NULL
*
- * @return array array of strings
+ * @return array
+ * array of strings
*/
public function query() {
$this->select();
* @param string $value
* The data to be validated.
*
- * @return boolean True if the value is of the specified type
+ * @return boolean
+ * True if the value is of the specified type
* @static
*/
public static function typecheck($type, $value) {
*
* @param bool $formatMultiRecordField
*
- * @return array $fields Array of custom values for the entity with key=>value
+ * @return array
+ * Array of custom values for the entity with key=>value
* pairs specified as civicrm_custom_field.id => custom value.
* Empty array if no custom values found.
* @static
* @param bool $checkPermission
* All or only authorized for the current user.
*
- * @return array $widgets array of dashlets
+ * @return array
+ * array of dashlets
* @static
*/
public static function getDashlets($all = TRUE, $checkPermission = TRUE) {
* Provide the dashlets for the contact id.
* passed rather than the current user.
*
- * @return array $dashlets array of dashlets
+ * @return array
+ * array of dashlets
* @static
*/
public static function getContactDashlets($flatFormat = FALSE, $contactID = NULL) {
* When a user accesses their dashboard for the first time, set up
* the default dashlets.
*
- * @return array of dashboard_id's
+ * @return array
+ * of dashboard_id's
*/
public static function initializeDashlets() {
$dashlets = array();
* Comma separated list.
* @param string $operator
*
- * @return boolean true if use has permission else false
+ * @return boolean
+ * true if use has permission else false
*/
public static function checkPermission($permission, $operator) {
if ($permission) {
* @param int $dashletID
* Widget ID.
*
- * @return array associted array title and content
+ * @return array
+ * associted array title and content
* @static
*/
public static function getDashletInfo($dashletID) {
* @param array $params
* Associated array.
*
- * @return object $dashlet returns dashlet object
+ * @return object
+ * $dashlet returns dashlet object
* @static
*/
public static function addDashlet(&$params) {
* @param array $params
* (reference) an assoc array of name/value pairs.
*
- * @return object CRM_Core_DAO_Discount object on success, otherwise null
+ * @return object
+ * CRM_Core_DAO_Discount object on success, otherwise null
* @static
*/
public static function add(&$params) {
* @param string $entityTable
* Entity table to be searched.
*
- * @return array $optionGroupIDs option group Ids associated with discount
+ * @return array
+ * option group Ids associated with discount
*
*/
public static function getOptionGroup($entityId, $entityTable) {
* @param string $entityTable
* Entity table to be searched.
*
- * @return integer $dao->id discount id of the set which matches
+ * @return integer
+ * $dao->id discount id of the set which matches
* the date criteria
*/
public static function findSet($entityID, $entityTable) {
*
* @param NULL
*
- * @return array Location::getValues
+ * @return array
+ * Location::getValues
*/
public function &getLocationValues() {
if ($this->_location == NULL) {
* @param array $params
* @param int $id
*
- * @return array domain
+ * @return array
+ * domain
*/
public static function edit(&$params, &$id) {
$domain = new CRM_Core_DAO_Domain();
*
* @param array $params
*
- * @return array domain
+ * @return array
+ * domain
*/
public static function create($params) {
$domain = new CRM_Core_DAO_Domain();
/**
* @param bool $skipFatal
*
- * @return array name & email for domain
+ * @return array
+ * name & email for domain
* @throws Exception
*/
public static function getNameAndEmail($skipFatal = FALSE) {
* @param array $params
* (reference ) an assoc array of name/value pairs.
*
- * @return object CRM_Core_BAO_Email object on success, null otherwise
+ * @return object
+ * CRM_Core_BAO_Email object on success, null otherwise
* @static
*/
public static function add(&$params) {
*
* @param bool $updateBlankLocInfo
*
- * @return array the array of email id's
+ * @return array
+ * the array of email id's
* @static
*/
public static function allEmails($id, $updateBlankLocInfo = FALSE) {
* The array containing entity_id and.
* entity_table name
*
- * @return array the array of email id's
+ * @return array
+ * the array of email id's
* @static
*/
public static function allEntityEmails(&$entityElements) {
* Build From Email as the combination of all the email ids of the logged in user and
* the domain email id
*
- * @return array an array of email ids
+ * @return array
+ * an array of email ids
* @static
*/
public static function getFromEmail() {
* @param string $entityTable
* Name of entity table default:civicrm_contact.
*
- * @return array (total, added, notAdded) count of enities added to tag
+ * @return array
+ * (total, added, notAdded) count of enities added to tag
* @static
*/
public static function addEntitiesToTag(&$entityIds, $tagId, $entityTable = 'civicrm_contact') {
* @param string $entityTable
* Name of entity table default:civicrm_contact.
*
- * @return array (total, removed, notRemoved) count of entities removed from tags
+ * @return array
+ * (total, removed, notRemoved) count of entities removed from tags
* @static
*/
public static function removeEntitiesFromTag(&$entityIds, $tagId, $entityTable = 'civicrm_contact') {
* @param object $tag
* An object of a tag.
*
- * @return array $entityIds array of entity ids
+ * @return array
+ * array of entity ids
*/
public function getEntitiesByTag($tag) {
$entityIds = array();
* @param string $separator
* The string separator where to implode the urls.
*
- * @return array An array with 2 elements. The string and the number of attachments
+ * @return array
+ * An array with 2 elements. The string and the number of attachments
* @static
*/
public static function attachmentInfo($entityTable, $entityID, $separator = '<br />') {
* To get single trxn id for a entity table i.e last or first.
* @param bool $newTrxn
*
- * @return array $tag array of category id's the contact belongs to.
+ * @return array
+ * array of category id's the contact belongs to.
*
* @static
*/
* @param int $entity_id
* Id of the entity usually the contactID.
*
- * @return array $tag array of catagory id's the contact belongs to.
+ * @return array
+ * array of catagory id's the contact belongs to.
*
* @static
*/
* Id of the latest payment.
*
*
- * @return array $payment array of previous payments
+ * @return array
+ * array of previous payments
*
* @static
*/
* @param string $entity_table
* Name of the entity table usually 'civicrm_contact'.
*
- * @return array $tag array of catagory id's the contact belongs to.
+ * @return array
+ * array of catagory id's the contact belongs to.
*
* @static
*/
* @param array $params
* (reference ) an assoc array of name/value pairs.
*
- * @return object CRM_Core_BAO_IM object on success, null otherwise
+ * @return object
+ * CRM_Core_BAO_IM object on success, null otherwise
* @static
*/
public static function add(&$params) {
*
* @param bool $updateBlankLocInfo
*
- * @return array the array of im details
+ * @return array
+ * the array of im details
* @static
*/
public static function allIMs($id, $updateBlankLocInfo = FALSE) {
* The array containing entity_id and.
* entity_table name
*
- * @return array the array of im details
+ * @return array
+ * the array of im details
* @static
*/
public static function allEntityIMs(&$entityElements) {
* @param bool $is_active
* Value we want to set the is_active field.
*
- * @return Object DAO object on sucess, null otherwise
+ * @return Object
+ * DAO object on sucess, null otherwise
*
* @static
*/
*
* @param void
*
- * @return array array of page orientations
+ * @return array
+ * array of page orientations
* @static
*/
public static function getPageOrientations() {
* @param string $name
* Group name.
*
- * @return array array of font names
+ * @return array
+ * array of font names
* @static
*/
public static function getFontNames($name = 'label_format') {
*
* @param void
*
- * @return array array of font sizes
+ * @return array
+ * array of font sizes
* @static
*/
public static function getFontSizes() {
*
* @param void
*
- * @return array array of measurement units
+ * @return array
+ * array of measurement units
* @static
*/
public static function getUnits() {
*
* @param void
*
- * @return array array of alignments
+ * @return array
+ * array of alignments
* @static
*/
public static function getTextAlignments() {
*
* @param void
*
- * @return array array of alignments
+ * @return array
+ * array of alignments
* @static
*/
public static function getFontStyles() {
*
* @param string $name
*
- * @return int Group ID (null if Group ID doesn't exist)
+ * @return int
+ * Group ID (null if Group ID doesn't exist)
*/
private static function _getGid($name = 'label_format') {
if (!isset(self::$_gid[$name]) || !self::$_gid[$name]) {
* @param string $returnURL
* URL of page calling this function.
*
- * @return array (reference) List of Label Formats
+ * @return array
+ * (reference) List of Label Formats
* @static
*/
public static function addOrder(&$list, $returnURL) {
* @param string $groupName
* Group name of the label format option group.
*
- * @return array (reference) label format list
+ * @return array
+ * (reference) label format list
* @static
*/
public static function &getList($namesOnly = FALSE, $groupName = 'label_format') {
* @param string $groupName
* Label format group name.
*
- * @return array Name/value pairs containing the default Label Format values.
+ * @return array
+ * Name/value pairs containing the default Label Format values.
* @static
*/
public static function &getDefaultValues($groupName = 'label_format') {
*
* @param string $groupName
*
- * @return array $values (reference) associative array of name/value pairs
+ * @return array
+ * (reference) associative array of name/value pairs
*/
public static function &getLabelFormat($field, $val, $groupName = 'label_format') {
$params = array('is_active' => 1, $field => $val);
* @param int $name
* Label format name. Empty = get default label format.
*
- * @return array $values (reference) associative array of name/value pairs
+ * @return array
+ * (reference) associative array of name/value pairs
*/
public static function &getByName($name) {
return self::getLabelFormat('name', $name);
* @param string $groupName
* Group name.
*
- * @return array $values (reference) associative array of name/value pairs
+ * @return array
+ * (reference) associative array of name/value pairs
*/
public static function &getById($id, $groupName = 'label_format') {
return self::getLabelFormat('id', $id, $groupName);
*
* @param null $entity
*
- * @return array $location
+ * @return array
* @static
*/
public static function create(&$params, $fixAddress = TRUE, $entity = NULL) {
* @param array $params
* (reference ) an assoc array of name/value pairs.
*
- * @return object CRM_Core_BAO_locBlock object on success, null otherwise
+ * @return object
+ * CRM_Core_BAO_locBlock object on success, null otherwise
* @static
*/
public static function addLocBlock(&$params) {
* @param $entityBlock
* @param bool $microformat
*
- * @return array array of objects(CRM_Core_BAO_Location)
+ * @return array
+ * array of objects(CRM_Core_BAO_Location)
* @static
*/
public static function &getValues($entityBlock, $microformat = FALSE) {
* @param int $updateLocBlockId
* Update location block id.
*
- * @return int newly created/updated location block id.
+ * @return int
+ * newly created/updated location block id.
*/
public static function copyLocBlock($locBlockId, $updateLocBlockId = NULL) {
//get the location info.
* @param bool $is_active
* Value we want to set the is_active field.
*
- * @return Object DAO object on sucess, null otherwise
+ * @return Object
+ * DAO object on sucess, null otherwise
*
* @static
*/
*
* @param NULL
*
- * @return object The default location type object on success,
+ * @return object
+ * The default location type object on success,
* null otherwise
* @static
*/
*
* @param int $contactID
*
- * @return int count of log records
+ * @return int
+ * count of log records
* @static
*/
public static function getContactLogCount($contactID) {
* Function for find out whether to use logging schema entries for contact
* summary, instead of normal log entries.
*
- * @return int report id of Contact Logging Report (Summary) / false
+ * @return int
+ * report id of Contact Logging Report (Summary) / false
* @static
*/
public static function useLoggingReport() {
/**
* Return the domain from the default set of settings
*
- * @return string default domain
+ * @return string
+ * default domain
*/
public static function defaultDomain() {
return self::defaultDAO()->domain;
/**
* Return the localpart from the default set of settings
*
- * @return string default localpart
+ * @return string
+ * default localpart
*/
public static function defaultLocalpart() {
return self::defaultDAO()->localpart;
/**
* Return the return path from the default set of settings
*
- * @return string default return path
+ * @return string
+ * default return path
*/
public static function defaultReturnPath() {
return self::defaultDAO()->return_path;
/**
* Return the "include message ID" flag from the default set of settings.
*
- * @return boolean default include message ID
+ * @return boolean
+ * default include message ID
*/
public static function includeMessageId() {
return CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::MAILING_PREFERENCES_NAME,
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return object CRM_Core_DAO_Mapping object on success, otherwise NULL
+ * @return object
+ * CRM_Core_DAO_Mapping object on success, otherwise NULL
* @static
*/
public static function retrieve(&$params, &$defaults) {
* @param array $params
* An array of name/value pairs.
*
- * @return object CRM_Core_DAO_Mapper object on success, otherwise NULL
+ * @return object
+ * CRM_Core_DAO_Mapper object on success, otherwise NULL
* @static
*/
public static function add($params) {
* @param string $mappingTypeId
* Mapping type id.
*
- * @return array $mapping array of mapping name
+ * @return array
+ * array of mapping name
* @static
*/
public static function getMappings($mappingTypeId) {
* @param int $mappingId
* Mapping id.
*
- * @return array $mappingFields array of mapping fields
+ * @return array
+ * array of mapping fields
* @static
*/
public static function getMappingFields($mappingId) {
* @param int $smartGroupId
* Smart group id.
*
- * @return array $returnFields associated array of elements
+ * @return array
+ * associated array of elements
* @static
*/
public static function getFormattedFields($smartGroupId) {
* @param int $relationshipTypeId
* Related relationship type id.
*
- * @return array all custom field titles
+ * @return array
+ * all custom field titles
*/
public function getRelationTypeCustomGroupData($relationshipTypeId) {
* Row no of the fields.
*
*
- * @return array $returnFields formatted associated array of elements
+ * @return array
+ * formatted associated array of elements
* @static
*/
public static function formattedFields(&$params, $row = FALSE) {
* @param bool $is_active
* Value we want to set the is_active field.
*
- * @return Object DAO object on sucess, NULL otherwise
+ * @return Object
+ * DAO object on sucess, NULL otherwise
* @static
*/
public static function setIsActive($id, $is_active) {
* @param array $params
* A string-keyed array of function params, see function body for details.
*
- * @return array of four parameters: a boolean whether the email was sent, and the subject, text and HTML templates
+ * @return array
+ * of four parameters: a boolean whether the email was sent, and the subject, text and HTML templates
*/
public static function sendTemplate($params) {
$defaults = array(
* @param bool $is_active
* Value we want to set the is_active field.
*
- * @return Object DAO object on sucess, NULL otherwise
+ * @return Object
+ * DAO object on sucess, NULL otherwise
*
* @static
*/
* Get existing / build navigation for CiviCRM Admin Menu
*
* @static
- * @return array associated array
+ * @return array
+ * associated array
*/
public static function getMenus() {
$menus = array();
*
* @param array associated array of submitted values
*
- * @return object navigation object
+ * @return object
+ * navigation object
* @static
*/
public static function add(&$params) {
* @param int $menuID
* Menu id.
*
- * @return int $weight string
+ * @return int
+ * $weight string
* @static
*/
public static function calculateWeight($parentID = NULL, $menuID = NULL) {
/**
* Get formatted menu list
*
- * @return array $navigations returns associated array
+ * @return array
+ * returns associated array
* @static
*/
public static function getNavigationList() {
* @param bool $navigationMenu
* True when called for building top navigation menu.
*
- * @return array $navigationTree nested array of menus
+ * @return array
+ * nested array of menus
* @static
*/
public static function buildNavigationTree(&$navigationTree, $parentID, $navigationMenu = TRUE) {
* @param int $contactID
* Contact id.
*
- * @return string $navigation returns navigation html
+ * @return string
+ * returns navigation html
* @static
*/
public static function createNavigation($contactID) {
* @param int $navigationID
* Navigation id.
*
- * @return array associated array
+ * @return array
+ * associated array
* @static
*/
public static function getNavigationInfo($navigationID) {
* @param int $id
* Id of the note to retrieve.
*
- * @return string the note text or NULL if note not found
+ * @return string
+ * the note text or NULL if note not found
*
* @static
*/
* @param int $id
* Id of the note to retrieve.
*
- * @return string the note subject or NULL if note not found
+ * @return string
+ * the note subject or NULL if note not found
*
* @static
*/
* @param object $note
* Either the id of the note to retrieve, or the CRM_Core_DAO_Note object itself.
*
- * @return boolean TRUE if the note should be displayed, otherwise FALSE
+ * @return boolean
+ * TRUE if the note should be displayed, otherwise FALSE
*
* @static
*/
* @param array $ids
* (deprecated) associated array with note id - preferably set $params['id'].
*
- * @return object $note CRM_Core_BAO_Note object
+ * @return object
+ * $note CRM_Core_BAO_Note object
* @static
*/
public static function &add(&$params, $ids = array()) {
* @param int $numNotes
* The maximum number of notes to return (0 if all).
*
- * @return object $notes Object of CRM_Core_BAO_Note
+ * @return object
+ * $notes Object of CRM_Core_BAO_Note
* @static
*/
public static function &getValues(&$params, &$values, $numNotes = self::MAX_NOTES) {
*
* @param string $entityTable
*
- * @return array $viewNote array of note properties
+ * @return array
+ * array of note properties
*
* @static
*/
*
* @param int $contactID
*
- * @return int $count count of log records
+ * @return int
+ * $count count of log records
*
* @static
*/
* @param bool $snippet
* If TRUE, returned values will be pre-formatted for display in a table of notes.
*
- * @return array Nested associative array beginning with direct children of given note.
+ * @return array
+ * Nested associative array beginning with direct children of given note.
*
* @static
*/
* @param int $id
* Note ID.
*
- * @return int $count Number of notes having the give note as parent
+ * @return int
+ * $count Number of notes having the give note as parent
*
* @static
*/
* @param int $depth
* Depth of current iteration within the descendent tree (used for comparison against maxDepth).
*
- * @return array Nested associative array beginning with direct children of given note.
+ * @return array
+ * Nested associative array beginning with direct children of given note.
* @static
*/
private static function buildNoteTree($parentId, $maxDepth = 0, $snippet = FALSE, &$tree = array(), $depth = 0) {
* @param array $ids
* (reference) one-dimensional array to store found descendent ids.
*
- * @return array $ids One-dimensional array containing ids of all desendent notes
+ * @return array
+ * One-dimensional array containing ids of all desendent notes
*/
public static function getDescendentIds($parentId, &$ids = array()) {
// get direct children of given parentId note
* @param array $params
* (reference ) an assoc array of name/value pairs.
*
- * @return object CRM_Core_BAO_OpenID object on success, null otherwise
+ * @return object
+ * CRM_Core_BAO_OpenID object on success, null otherwise
* @static
*/
public static function add(&$params) {
*
* @param bool $updateBlankLocInfo
*
- * @return array the array of openid's
+ * @return array
+ * the array of openid's
* @static
*/
public static function allOpenIDs($id, $updateBlankLocInfo = FALSE) {
* @param bool $is_active
* Value we want to set the is_active field.
*
- * @return Object DAO object on sucess, null otherwise
+ * @return Object
+ * DAO object on sucess, null otherwise
* @static
*/
public static function setIsActive($id, $is_active) {
* @param int $optionGroupId
* Id of the Option Group.
*
- * @return String title
+ * @return String
+ * title
*
* @static
*/
* @param bool $is_active
* Value we want to set the is_active field.
*
- * @return Object DAO object on sucess, null otherwise
+ * @return Object
+ * DAO object on sucess, null otherwise
* @static
*/
public static function setIsActive($id, $is_active) {
* @param int $activityTypeId
* Activity type id.
*
- * @return array label and description
+ * @return array
+ * label and description
* @static
*/
public static function getActivityTypeDetails($activityTypeId) {
* @param int $id
* Id of Option Value.
*
- * @return string title
+ * @return string
+ * title
*
* @static
*
* @param int $optionGroupID
* The option group for which we want the values from.
*
- * @return array an array of array of values for this option group
+ * @return array
+ * an array of array of values for this option group
* @static
*/
public static function getOptionValuesArray($optionGroupID) {
* @param int $optionGroupID
* The option group for which we want the values from.
*
- * @return array an associative array of label, value pairs
+ * @return array
+ * an associative array of label, value pairs
* @static
*/
public static function getOptionValuesAssocArray($optionGroupID) {
* @param string $optionGroupName
* The option group name for which we want the values from.
*
- * @return array an associative array of label, value pairs
+ * @return array
+ * an associative array of label, value pairs
* @static
*/
public static function getOptionValuesAssocArrayFromName($optionGroupName) {
*
* @param void
*
- * @return int Group ID (null if Group ID doesn't exist)
+ * @return int
+ * Group ID (null if Group ID doesn't exist)
*/
private static function _getGid() {
if (!self::$_gid) {
* @param string $returnURL
* URL of page calling this function.
*
- * @return array (reference) List of Paper Sizes
+ * @return array
+ * (reference) List of Paper Sizes
* @static
*/
public static function &addOrder(&$list, $returnURL) {
* @param bool $namesOnly
* Return simple list of names.
*
- * @return array (reference) Paper Size list
+ * @return array
+ * (reference) Paper Size list
* @static
*/
public static function &getList($namesOnly = FALSE) {
*
* @param NULL
*
- * @return array Name/value pairs containing the default Paper Size values.
+ * @return array
+ * Name/value pairs containing the default Paper Size values.
* @static
*/
public static function &getDefaultValues() {
* @param int $val
* Field value to search for.
*
- * @return array $values (reference) associative array of name/value pairs
+ * @return array
+ * (reference) associative array of name/value pairs
*/
public static function &getPaperFormat($field, $val) {
$params = array('is_active' => 1, $field => $val);
* @param int $name
* Paper Size name. Empty = get default Paper Size.
*
- * @return array $values (reference) associative array of name/value pairs
+ * @return array
+ * (reference) associative array of name/value pairs
*/
public static function &getByName($name) {
return self::getPaperFormat('name', $name);
* @param int $id
* Paper Size id. 0 = get default Paper Size.
*
- * @return array $values (reference) associative array of name/value pairs
+ * @return array
+ * (reference) associative array of name/value pairs
*/
public static function &getById($id) {
return self::getPaperFormat('id', $id);
*
* @param void
*
- * @return array array of page orientations
+ * @return array
+ * array of page orientations
*/
public static function getPageOrientations() {
return array(
*
* @param void
*
- * @return array array of measurement units
+ * @return array
+ * array of measurement units
*/
public static function getUnits() {
return array(
*
* @param void
*
- * @return int Group ID (null if Group ID doesn't exist)
+ * @return int
+ * Group ID (null if Group ID doesn't exist)
*/
private static function _getGid() {
if (!self::$_gid) {
* @param bool $namesOnly
* Return simple list of names.
*
- * @return array (reference) PDF Page Format list
+ * @return array
+ * (reference) PDF Page Format list
* @static
*/
public static function &getList($namesOnly = FALSE) {
*
* @param NULL
*
- * @return array Name/value pairs containing the default PDF Page Format values.
+ * @return array
+ * Name/value pairs containing the default PDF Page Format values.
* @static
*/
public static function &getDefaultValues() {
* @param int $val
* Field value to search for.
*
- * @return array $values (reference) associative array of name/value pairs
+ * @return array
+ * (reference) associative array of name/value pairs
*/
public static function &getPdfFormat($field, $val) {
$params = array('is_active' => 1, $field => $val);
* @param int $name
* PDF Page Format name. Empty = get default PDF Page Format.
*
- * @return array $values (reference) associative array of name/value pairs
+ * @return array
+ * (reference) associative array of name/value pairs
*/
public static function &getByName($name) {
return self::getPdfFormat('name', $name);
* @param int $id
* PDF Page Format id. 0 = get default PDF Page Format.
*
- * @return array $values (reference) associative array of name/value pairs
+ * @return array
+ * (reference) associative array of name/value pairs
*/
public static function &getById($id) {
return self::getPdfFormat('id', $id);
* @param array $params
* (reference ) an assoc array of name/value pairs.
*
- * @return object CRM_Core_BAO_Phone object on success, null otherwise
+ * @return object
+ * CRM_Core_BAO_Phone object on success, null otherwise
* @static
*/
public static function add(&$params) {
*
* @param array entityBlock input parameters to find object
*
- * @return array array of phone objects
+ * @return array
+ * array of phone objects
* @static
*/
public static function &getValues($entityBlock) {
* @param null $type
* @param array $filters
*
- * @return array the array of phone ids which are potential numbers
+ * @return array
+ * the array of phone ids which are potential numbers
* @static
*/
public static function allPhones($id, $updateBlankLocInfo = FALSE, $type = NULL, $filters = array()) {
*
* @param null $type
*
- * @return array the array of phone ids which are potential numbers
+ * @return array
+ * the array of phone ids which are potential numbers
* @static
*/
public static function allEntityPhones($entityElements, $type = NULL) {
* @param bool $is_active
* Value we want to set the is_active field.
*
- * @return Object DAO object on sucess, null otherwise
+ * @return Object
+ * DAO object on sucess, null otherwise
*
* @static
*/
/**
* This function builds a "When" object based on schedule/reminder params
*
- * @return object When object
+ * @return object
+ * When object
*/
public function generateRecursion() {
// return if already generated
* This function iterates through when object criterias and
* generates recursive dates based on that
*
- * @return array array of dates
+ * @return array
+ * array of dates
*/
public function generateRecursiveDates() {
$this->generateRecursion();
*
* @static
*
- * @return array an array of child ids
+ * @return array
+ * an array of child ids
*/
static public function getEntitiesForParent($parentId, $entityTable, $includeParent = TRUE, $mode = 3, $initiatorId = NULL) {
$entities = array();
*
* @static
*
- * @return array array of connected ids
+ * @return array
+ * array of connected ids
*/
static public function getEntitiesFor($entityId, $entityTable, $includeParent = TRUE, $mode = 3) {
$parentId = self::getParentFor($entityId, $entityTable);
*
* @static
*
- * @return int unsigned $parentId Parent ID
+ * @return int
+ * unsigned $parentId Parent ID
*/
static public function getParentFor($entityId, $entityTable, $includeParent = TRUE) {
if (empty($entityId) || empty($entityTable)) {
* @param array $scheduleReminderDetails
* Array of repeat criterias saved in civicrm_action_schedule table .
*
- * @return object When object
+ * @return object
+ * When object
*/
public function getRecursionFromSchedule($scheduleReminderDetails = array()) {
$r = new When();
*
* @static
*
- * @return object DateTime object which contain time difference
+ * @return object
+ * DateTime object which contain time difference
*/
static public function getInterval($startDate, $endDate) {
if ($startDate && $endDate) {
* @param int $domainID
* @param bool $force
*
- * @return boolean true if item is already in cache
+ * @return boolean
+ * true if item is already in cache
* @static
*/
static function inCache(
* @param bool $createMode
*
* @throws api_Exception
- * @return array $fieldstoset name => value array of the fields to be set (with extraneous removed)
+ * @return array
+ * name => value array of the fields to be set (with extraneous removed)
*/
public static function validateSettingsInput($params, &$fields, $createMode = TRUE) {
$group = CRM_Utils_Array::value('group', $params);
* @param int $domainID
* @param null $profile
*
- * @return array $result - the following information as appropriate for each setting
+ * @return array
+ * the following information as appropriate for each setting
* - name
* - type
* - default
* @param array $defaults
* (reference ) an assoc array to hold the flattened values.
*
- * @return object CRM_Core_DAO_Tag object on success, otherwise null
+ * @return object
+ * CRM_Core_DAO_Tag object on success, otherwise null
* @static
*/
public static function retrieve(&$params, &$defaults) {
* (optional) the array that holds all the db ids - we are moving away from this in bao.
* signatures
*
- * @return object CRM_Core_DAO_Tag object on success, otherwise null
+ * @return object
+ * CRM_Core_DAO_Tag object on success, otherwise null
* @static
*/
public static function add(&$params, $ids = array()) {
* @param string $entityTable
* Entity_table.
*
- * @return array $tagSets array of tag sets
+ * @return array
+ * array of tag sets
* @static
*/
public static function getTagSet($entityTable) {
/**
* Get the tags that are not children of a tagset.
*
- * @return array $tags associated array of tag name and id
+ * @return array
+ * associated array of tag name and id
* @access public
* @static
*/
* @param int $id
* Id of uf_form.
*
- * @return string title
+ * @return string
+ * title
*
* @static
*
* @param bool $is_active
* Value we want to set the is_active field.
*
- * @return Object DAO object on sucess, null otherwise
+ * @return Object
+ * DAO object on sucess, null otherwise
* @static
*/
public static function setIsActive($id, $is_active) {
*
* @param int $UFFieldId
*
- * @return boolean false if custom field are disabled else true
+ * @return boolean
+ * false if custom field are disabled else true
* @static
*/
public static function checkUFStatus($UFFieldId) {
* @param array $optional
* Array of types those are optional.
*
- * @return boolean $valid
+ * @return boolean
* @static
*/
public static function checkValidProfileType($ufGroupId, $required, $optional = NULL) {
*
* @param bool $skipComponentType
*
- * @return string profile group_type
+ * @return string
+ * profile group_type
* @static
*
* TODO Why is this function in this class? It seems to be about the UFGroup.
* True if only pure profiles are required.
* @param bool $skipComponentType
*
- * @return string profile group_type
+ * @return string
+ * profile group_type
* @static
*
* TODO Why is this function in this class? It seems to be about the UFGroup.
*
* @param int $profileID
*
- * @return boolean $result true/false.
+ * @return boolean
*/
public static function checkSearchableORInSelector($profileID) {
$result = FALSE;
*
* @param int $profileID
*
- * @return void.
+ * @return void
+ *
*/
public function resetInSelectorANDSearchable($profileID) {
if (!$profileID) {
* Filter to apply to profile fields - expected usage is to only fill based on.
* the bottom profile per CRM-13726
*
- * @return bool Can the address block be hidden safe in the knowledge all fields are elsewhere collected (see CRM-15118)
+ * @return bool
+ * Can the address block be hidden safe in the knowledge all fields are elsewhere collected (see CRM-15118)
*/
public static function assignAddressField($key, &$profileAddressFields, $profileFilter) {
$billing_id = CRM_Core_BAO_LocationType::getBilling();
* @param array $defaults
* (reference) an assoc array to hold the flattened values.
*
- * @return object CRM_Core_DAO_UFGroup object
+ * @return object
+ * CRM_Core_DAO_UFGroup object
* @static
*/
public static function retrieve(&$params, &$defaults) {
* @param int $id
* Id of uf_group.
*
- * @return string contact type
+ * @return string
+ * contact type
*/
public static function getContactType($id) {
* @param int $id
* Id of uf_form.
*
- * @return string title
+ * @return string
+ * title
*
* @static
*
* @param bool $is_active
* Value we want to set the is_active field.
*
- * @return Object CRM_Core_DAO_UFGroup object on success, null otherwise
+ * @return Object
+ * CRM_Core_DAO_UFGroup object on success, null otherwise
* @static
*/
public static function setIsActive($id, $is_active) {
*
* @param null $ctype
*
- * @return array the fields that are needed for registration
+ * @return array
+ * the fields that are needed for registration
* @static
*/
public static function getRegistrationFields($action, $mode, $ctype = NULL) {
* @param null $restrict
* @param bool $skipPermission
* @param int $permissionType
- * @return array the fields that are listings related
+ * @return array
+ * the fields that are listings related
* @static
*/
static function getListingFields(
* @param string $orderBy
* @param null $orderProfiles
*
- * @return array the fields that belong to this ufgroup(s)
+ * @return array
+ * the fields that belong to this ufgroup(s)
* @static
*/
static function getFields(
* @param bool $searchable
* @param bool $showAll
* @param int $visibility
- * @return bool TRUE if field is displayable
+ * @return bool
+ * TRUE if field is displayable
*/
protected static function filterUFField($field, $searchable, $showAll, $visibility) {
if ($searchable && $field->is_searchable != 1) {
* The action of the form.
*
* @pram boolean $register is this the registrtion form
- * @return boolean true if form is valid
+ * @return boolean
+ * true if form is valid
* @static
*/
public static function isValid($userID, $title, $register = FALSE, $action = NULL) {
* @param bool $doNotProcess
* @param null $ctype
*
- * @return string the html for the form on success, otherwise empty string
+ * @return string
+ * the html for the form on success, otherwise empty string
* @static
*/
static function getEditHTML(
* @param int $status
* If set return module other than default modules (User Account/User registration/Profile).
*
- * @return array $ufGroupJoinRecords
+ * @return array
*
* @static
*/
* @param int $ufGroupId
* If $ufGroupId get update weight or add weight.
*
- * @return int weight of the UFGroup
+ * @return int
+ * weight of the UFGroup
* @static
*/
public static function getWeight($ufGroupId = NULL) {
* Which operation (view, edit, create, etc) to check permission for.
* @param array|NULL $returnFields list of UFGroup fields to return; NULL for default
*
- * @return array $ufGroups array of ufgroups for a module
+ * @return array
+ * array of ufgroups for a module
* @static
*/
public static function getModuleUFGroup($moduleName = NULL, $count = 0, $skipPermission = TRUE, $op = CRM_Core_Permission::VIEW, $returnFields = NULL) {
* Uf group id (profile id).
* @param int $contactID
*
- * @return boolean true or false
+ * @return boolean
+ * true or false
* @static
*/
public static function filterUFGroups($ufGroupId, $contactID = NULL) {
* @param bool $onlyPure
* True if only pure profiles are required.
*
- * @return array $profiles associative array of profiles
+ * @return array
+ * associative array of profiles
* @static
*/
public static function getProfiles($types, $onlyPure = FALSE) {
* @param array $optional
* Array of types those are optional.
*
- * @return array $profiles associative array of profiles
+ * @return array
+ * associative array of profiles
* @static
*/
public static function getValidProfiles($required, $optional = NULL) {
* @param array $required
* Array of fields those are required in the profile.
*
- * @return array $profiles associative array of profiles
+ * @return array
+ * associative array of profiles
* @static
*/
public static function checkValidProfile($ufId, $required = NULL) {
*
* @param int $contactId
*
- * @return array $data assoicated formatted array
+ * @return array
+ * assoicated formatted array
* @static
*/
public static function formatFields($params, $contactId = NULL) {
* @param int $ignoreFieldId
* Ignore particular profile field.
*
- * @return array list of calculated group type
+ * @return array
+ * list of calculated group type
*/
public static function calculateGroupType($gId, $includeTypeValues = FALSE, $ignoreFieldId = NULL) {
//get the profile fields.
* @param int $ignoreFieldId
* Ignore perticular profile field.
*
- * @return array list of calculated group type
+ * @return array
+ * list of calculated group type
*/
public static function _calculateGroupType($ufFields, $includeTypeValues = FALSE, $ignoreFieldId = NULL) {
$groupType = $groupTypeValues = $customFieldIds = array();
*
* @param bool $isStandalone
*
- * @return void.
+ * @return void
+ *
*/
public static function setComponentDefaults(&$fields, $componentId, $component, &$defaults, $isStandalone = FALSE) {
if (!$componentId ||
* @param int $profileID
* Id of the profile.
*
- * @return array returns array
+ * @return array
+ * returns array
* @static
*/
public static function profileGroups($profileID) {
* @param int $contactId
* User contact id.
*
- * @return array $subscribeGroupIds This contains array of groups for subscription
+ * @return array
+ * This contains array of groups for subscription
*/
public static function getDoubleOptInGroupIds(&$params, $contactId = NULL) {
$config = CRM_Core_Config::singleton();
* @param array $profileIds
* Associated array of profile ids.
*
- * @return boolean $mixProfile true if profile is mixed
+ * @return boolean
+ * true if profile is mixed
* @static
*/
public static function checkForMixProfiles($profileIds) {
/**
* Determine of we show overlay profile or not
*
- * @return boolean true if profile should be shown else false
+ * @return boolean
+ * true if profile should be shown else false
* @static
*/
public static function showOverlayProfile() {
* @param int $profileId
* @param string $groupType
*
- * @return Array group type values
+ * @return Array
+ * group type values
* @static
*/
public static function groupTypeValues($profileId, $groupType = NULL) {
/**
* Get profiles used for batch entry
*
- * @return array profileIds profile ids
+ * @return array
+ * profileIds profile ids
* @static
*/
public static function getBatchProfiles() {
* @param array $params
* (reference) an assoc array of name/value pairs.
*
- * @return int or null
+ * @return int
+ * or null
* @static
*/
public static function findJoinEntryId(&$params) {
* @param array $params
* (reference) an assoc array of name/value pairs.
*
- * @return int or null
+ * @return int
+ * or null
* @static
*/
public static function findUFGroupId(&$params) {
* @param int $ufID
* Id of UF for which related contact_id is required.
*
- * @return int contact_id on success, null otherwise
+ * @return int
+ * contact_id on success, null otherwise
* @static
*/
public static function getContactId($ufID) {
* @param int $contactID
* ID of the contact for which related uf_id is required.
*
- * @return int uf_id of the given contact_id on success, null otherwise
+ * @return int
+ * uf_id of the given contact_id on success, null otherwise
* @static
*/
public static function getUFId($contactID) {
* Get the list of contact_id
*
*
- * @return int contact_id on success, null otherwise
+ * @return int
+ * contact_id on success, null otherwise
* @static
*/
public static function getContactIDs() {
*
* @param int $openId
*
- * @return bool true if allowed to login, false otherwise
+ * @return bool
+ * true if allowed to login, false otherwise
* @static
*/
public static function getAllowedToLogin($openId) {
* have id's (it uses OpenIDs, which go in a different field)
*
*
- * @return int next highest unused value for uf_id
+ * @return int
+ * next highest unused value for uf_id
* @static
*/
public static function getNextUfIdValue() {
* @param array $params
* (reference ) an assoc array of name/value pairs.
*
- * @return object CRM_Core_BAO_Website object on success, null otherwise
+ * @return object
+ * CRM_Core_BAO_Website object on success, null otherwise
* @static
*/
public static function add(&$params) {
*
* @param bool $updateBlankLocInfo
*
- * @return array the array of website details
+ * @return array
+ * the array of website details
* @static
*/
public static function allWebsites($id, $updateBlankLocInfo = FALSE) {
*
* @param bool $rebuildEach
* Whether to perform rebuild after each individual API call.
- * @return array Each item is $params for WordReplacement.create
+ * @return array
+ * Each item is $params for WordReplacement.create
* @see CRM_Core_BAO_WordReplacement::convertConfigArraysToAPIParams
*/
public static function getConfigArraysAsAPIParams($rebuildEach) {
* @param string $property
* The desired property.
*
- * @return string the value of the desired property
+ * @return string
+ * the value of the desired property
*/
public static function getProperty($id, $property) {
if (!(self::$_properties)) {
/**
* Returns the whole $_properties array
*
- * @return array the $_properties array
+ * @return array
+ * the $_properties array
*/
public static function properties() {
if (!(self::$_properties)) {
}
/**
- * @return array of class names; each class implements CRM_Core_CodeGen_ITask
+ * @return array
+ * of class names; each class implements CRM_Core_CodeGen_ITask
*/
public function getTasks() {
$components = array(
*
* @param array $pairs
* Each item is an array(0 => $searchBaseDir, 1 => $filePattern).
- * @return array of file paths
+ * @return array
+ * of file paths
*/
public static function findManyFiles($pairs) {
$files = array();
* @param $config
* @param $oldMode
*
- * @return array collection of component settings
+ * @return array
+ * collection of component settings
*/
public function add($config, $oldMode) {
foreach (get_class_vars(get_class($this)) as $key => $value) {
/**
* EXPERIMENTAL: Get a list of AngularJS modules
*
- * @return array list of modules; same format as CRM_Utils_Hook::angularModules(&$angularModules)
+ * @return array
+ * list of modules; same format as CRM_Utils_Hook::angularModules(&$angularModules)
* @see CRM_Utils_Hook::angularModules
*/
public function getAngularModules() {
* Needs to be implemented in component's information
* class.
*
- * @return array collection of required component settings
+ * @return array
+ * collection of required component settings
*
*/
abstract public function getInfo();
/**
* Get a list of entities to register via API
*
- * @return array list of entities; same format as CRM_Utils_Hook::managedEntities(&$entities)
+ * @return array
+ * list of entities; same format as CRM_Utils_Hook::managedEntities(&$entities)
* @see CRM_Utils_Hook::managedEntities
*/
public function getManagedEntities() {
/**
* Provides permissions that are unwise for Anonymous Roles to have
*
- * @return array list of permissions
+ * @return array
+ * list of permissions
* @see CRM_Component_Info::getPermissions
*/
public function getAnonymousPermissionWarnings() {
*
* @param CRM_Core_DAO $dao
* The item for which we want a reference count.
- * @return array each item in the array is an array with keys:
+ * @return array
+ * each item in the array is an array with keys:
* - name: string, eg "sql:civicrm_email:contact_id"
* - type: string, eg "sql"
* - count: int, eg "5" if there are 5 email addresses that refer to $dao
* Provides information whether given component is currently
* marked as enabled in configuration.
*
- * @return boolean true if component is enabled, false if not
+ * @return boolean
+ * true if component is enabled, false if not
*
*/
public function isEnabled() {
/**
* Provides component's advanced search pane's template path.
*
- * @return string component's advanced search pane's template path
+ * @return string
+ * component's advanced search pane's template path
*
*/
public function getAdvancedSearchPaneTemplatePath() {
/**
* Provides information whether given component uses system wide search.
*
- * @return boolean true if component needs search integration
+ * @return boolean
+ * true if component needs search integration
*
*/
public function usesSearch() {
/**
* Provides the xml menu files
*
- * @return array array of menu files
+ * @return array
+ * array of menu files
*
*/
public function menuFiles() {
* FIXME: It should be protected so the keyword is not
* FIXME: accessed from beyond component infrastructure.
*
- * @return string component keyword
+ * @return string
+ * component keyword
*
*/
public function getKeyword() {
* we have two submit buttons, we could have one displayed as a button and
* the other as an image, both are of type 'submit'.
*
- * @return string the name of the button that has been pressed by the user
+ * @return string
+ * the name of the button that has been pressed by the user
*/
public function getButtonName() {
$data = &$this->container();
/**
* Getter for embedded
*
- * @return boolean return the embedded value
+ * @return boolean
+ * return the embedded value
*/
public function getEmbedded() {
return $this->_embedded;
/**
* Getter for skipRedirection
*
- * @return boolean return the skipRedirection value
+ * @return boolean
+ * return the skipRedirection value
*/
public function getSkipRedirection() {
return $this->_skipRedirection;
/**
* Getter for print
*
- * @return boolean return the print value
+ * @return boolean
+ * return the print value
*/
public function getPrint() {
return $this->_print;
* @param bool $i18nRewrite
* Whether to rewrite the query.
*
- * @return object the current DAO object after the query execution
+ * @return object
+ * the current DAO object after the query execution
*/
public function query($query, $i18nRewrite = TRUE) {
// rewrite queries that should use $dbLocale-based views for multi-language installs
*
* @static
*
- * @return array of CRM_Core_Reference_Interface
+ * @return array
+ * of CRM_Core_Reference_Interface
*/
public static function getReferenceColumns() {
return array();
* Get/set an associative array of table columns
*
* @param array key=>type array
- * @return array (associative)
+ * @return array
+ * (associative)
*/
public function table() {
$fields = &$this->fields();
* @param array $params
* (reference ) associative array of name/value pairs.
*
- * @return boolean did we copy all null values into the object
+ * @return boolean
+ * did we copy all null values into the object
*/
public function copyValues(&$params) {
$fields = &$this->fields();
* Field that i'm interested in or null if.
* you want the attributes for all DAO text fields
*
- * @return array assoc array of name => attribute pairs
+ * @return array
+ * assoc array of name => attribute pairs
* @static
*/
public static function getAttribute($class, $fieldName = NULL) {
* @param string $fieldName
* The name of the field in the DAO.
*
- * @return boolean true if object exists
+ * @return boolean
+ * true if object exists
* @static
*/
public static function objectExists($value, $daoName, $daoID, $fieldName = 'name') {
* @param bool $i18nRewrite
* Whether to rewrite the query on multilingual setups.
*
- * @return boolean true if exists, else false
+ * @return boolean
+ * true if exists, else false
* @static
*/
public static function checkFieldExists($tableName, $columnName, $i18nRewrite = TRUE) {
* @param string $tableName
* @param string $constraint
*
- * @return boolean true if constraint exists, false otherwise
+ * @return boolean
+ * true if constraint exists, false otherwise
* @static
*/
public static function checkConstraintExists($tableName, $constraint) {
*
* @throws Exception
*
- * @return boolean true if CONSTRAINT keyword exists, false otherwise
+ * @return boolean
+ * true if CONSTRAINT keyword exists, false otherwise
*/
public static function schemaRequiresRebuilding($tables = array("civicrm_contact")) {
$show = array();
* @param string $tableName
* @param string $columnName
*
- * @return boolean true if in format, false otherwise
+ * @return boolean
+ * true if in format, false otherwise
* @static
*/
public static function checkFKConstraintInFormat($tableName, $columnName) {
* @param string $columnName
* @param string $columnValue
*
- * @return boolean true if the value is always $columnValue, false otherwise
+ * @return boolean
+ * true if the value is always $columnValue, false otherwise
* @static
*/
public static function checkFieldHasAlwaysValue($tableName, $columnName, $columnValue) {
* @param string $tableName
* @param string $columnName
*
- * @return boolean true if if the value is always NULL, false otherwise
+ * @return boolean
+ * true if if the value is always NULL, false otherwise
* @static
*/
public static function checkFieldIsAlwaysNull($tableName, $columnName) {
*
* @param string $tableName
*
- * @return boolean true if exists, else false
+ * @return boolean
+ * true if exists, else false
* @static
*/
public static function checkTableExists($tableName) {
* @param int $id
* Id of the DAO object being searched for.
*
- * @return object Object of the type of the class that called this function.
+ * @return object
+ * Object of the type of the class that called this function.
*/
public static function findById($id) {
$object = new static();
* @param string $searchColumn
* Name of the column you want to search by.
*
- * @return boolean true if we found and updated the object, else false
+ * @return boolean
+ * true if we found and updated the object, else false
* @static
*/
public static function setFieldValue($daoName, $searchValue, $setColumn, $setValue, $searchColumn = 'id') {
* @param string $default
* Default sort value.
*
- * @return string - sortString
+ * @return string
+ * sortString
* @static
*/
public static function getSortString($sort, $default = NULL) {
* @param array $returnProperities
* An assoc array of fields that need to be returned, eg array( 'first_name', 'last_name').
*
- * @return object an object of type referenced by daoName
+ * @return object
+ * an object of type referenced by daoName
* @static
*/
public static function commonRetrieve($daoName, &$params, &$defaults, $returnProperities = NULL) {
* @param array $returnProperities
* An assoc array of fields that need to be returned, eg array( 'first_name', 'last_name').
*
- * @return object an object of type referenced by daoName
+ * @return object
+ * an object of type referenced by daoName
* @static
*/
public static function commonRetrieveAll($daoName, $fieldIdName = 'id', $fieldId, &$details, $returnProperities = NULL) {
* @param array $strings
* @param string $default
* the value to use if $strings has no elements.
- * @return string eg "abc","def","ghi"
+ * @return string
+ * eg "abc","def","ghi"
*/
public static function escapeStrings($strings, $default = NULL) {
static $_dao = NULL;
/**
* Find all records which refer to this entity.
*
- * @return array of objects referencing this
+ * @return array
+ * of objects referencing this
*/
public function findReferences() {
$links = self::getReferencesToTable(static::getTableName());
}
/**
- * @return array each item has keys:
+ * @return array
+ * each item has keys:
* - name: string
* - type: string
* - count: int
* @param string $tableName
* Table referred to.
*
- * @return array structure of table and column, listing every table with a
+ * @return array
+ * structure of table and column, listing every table with a
* foreign key reference to $tableName, and the column where the key appears.
*/
public static function getReferencesToTable($tableName) {
* @param $action: (str) api action
* @param $params: (array) api params
*
- * @return array of permissions to check for this entity-action combo
+ * @return array
+ * of permissions to check for this entity-action combo
*/
function _civicrm_api3_permissions($entity, $action, &$params) {
$entity = _civicrm_api_get_entity_name_from_camel($entity);
* useful when we die during initialization and permissioning
* subsystem is not initialized - CRM-13765
*
- * @return string the generated output
+ * @return string
+ * the generated output
* @static
*/
public static function debug($name, $variable = NULL, $log = TRUE, $html = TRUE, $checkPermission = TRUE) {
* @param string $comp
* Variable name.
*
- * @return string the generated output
+ * @return string
+ * the generated output
*
*
* @static
*
* @param string $comp
* Message to be output.
- * @return string format of the backtrace
+ * @return string
+ * format of the backtrace
*
*
* @static
* TRUE if we should try to display content of function arguments (which could be sensitive); FALSE to display only the type of each function argument.
* @param int $maxArgLen
* Maximum number of characters to show from each argument string.
- * @return string printable plain-text
+ * @return string
+ * printable plain-text
*/
public static function formatBacktrace($backTrace, $showArgs = TRUE, $maxArgLen = 80) {
$message = '';
* Render an exception as HTML string
*
* @param Exception $e
- * @return string printable HTML text
+ * @return string
+ * printable HTML text
*/
public static function formatHtmlException(Exception $e) {
$msg = '';
* Write details of an exception to the log
*
* @param Exception $e
- * @return string printable plain text
+ * @return string
+ * printable plain text
*/
public static function formatTextException(Exception $e) {
$msg = get_class($e) . ": \"" . $e->getMessage() . "\"\n";
*
* @param object $obj
* The PEAR_ERROR object.
- * @return object $obj
+ * @return object
+ * $obj
* @static
*/
public static function nullHandler($obj) {
* - xparent_id: int - business-entity to which file is attached (directly or indirectly)
* @param int $limit
* @param int $offset
- * @return array each item has keys:
+ * @return array
+ * each item has keys:
* - file_id: int
* - parent_table: string - entity to which file is directly attached
* - parent_id: int - entity to which file is directly attached
*
* access public
*
- * @return array reference to the array of default values
+ * @return array
+ * reference to the array of default values
*
*/
public function setDefaultValues() {
/**
* Performs the server side validation
* @since 1.0
- * @return boolean true if no error found
+ * @return boolean
+ * true if no error found
* @throws HTML_QuickForm_Error
*/
public function validate() {
* Additional Operator Selections to add.
* @param string $dateFormat
* @param bool $displayTime
- * @return array Values for Selector
+ * @return array
+ * Values for Selector
*/
static function returnDateRangeSelector(
&$form, $fieldName, $count = 1,
* @param array $fields
* Posted values of the form .
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($values) {
/**
* @param string $fldName
- * @return bool TRUE if encoding should be skipped for this field
+ * @return bool
+ * TRUE if encoding should be skipped for this field
*/
public static function isSkippedField($fldName) {
return CRM_Utils_API_HTMLInputCoder::singleton()->isSkippedField($fldName);
/**
* Returns whether gettext is running natively or using PHP-Gettext.
*
- * @return bool True if gettext is native
+ * @return bool
+ * True if gettext is native
*/
public function isNative() {
return $this->_nativegettext;
* @param bool $justEnabled
* whether to return all languages or just the enabled ones.
*
- * @return array of code/language name mappings
+ * @return array
+ * of code/language name mappings
*/
public static function languages($justEnabled = FALSE) {
static $all = NULL;
* source string.
* @param mixed arguments, can be passed in an array or through single variables
*
- * @return string modified string
+ * @return string
+ * modified string
*/
public function strarg($str) {
$tr = array();
* @param array $params
* the params of the translation (if any).
*
- * @return string the translated string
+ * @return string
+ * the translated string
*/
public function crm_translate($text, $params = array()) {
if (isset($params['escape'])) {
* @param string $string
* this string should be translated.
*
- * @return string the translated string
+ * @return string
+ * the translated string
*/
public function translate($string) {
return ($this->_phpgettext) ? $this->_phpgettext->translate($string) : $string;
* @param $key
* Key of the extension (can be 'civicrm', or 'org.example.foo').
*
- * @return Boolean True if the domain was changed for an extension.
+ * @return Boolean
+ * True if the domain was changed for an extension.
*/
public function setGettextDomain($key) {
/* No domain changes for en_US */
/**
* Set the LC_TIME locale if it's not set already (for a given language choice).
*
- * @return string the final LC_TIME that got set
+ * @return string
+ * the final LC_TIME that got set
*/
public static function setLcTime() {
static $locales = array();
* @param $params
* Array an array of additional parameters.
*
- * @return string the translated string
+ * @return string
+ * the translated string
*/
function ts($text, $params = array()) {
static $config = NULL;
*
* access public
*
- * @return array reference to the array of default values
+ * @return array
+ * reference to the array of default values
*
*/
public function setDefaultValues() {
* @param string $query
* the query for rewrite.
*
- * @return string the rewritten query
+ * @return string
+ * the rewritten query
*/
public static function rewriteQuery($query) {
global $dbLocale;
* @param string $class
* schema structure class to use.
*
- * @return array array of CREATE INDEX queries
+ * @return array
+ * array of CREATE INDEX queries
*/
private static function createIndexQueries($locale, $table, $class = 'CRM_Core_I18n_SchemaStructure') {
$indices =& $class::indices();
* @param string $class
* schema structure class to use.
*
- * @return array array of CREATE INDEX queries
+ * @return array
+ * array of CREATE INDEX queries
*/
private static function createViewQuery($locale, $table, &$dao, $class = 'CRM_Core_I18n_SchemaStructure') {
$columns =& $class::columns();
* @param bool $force
* Should we recreate it irrespective if it exists or not.
*
- * @return string the full path to the config file
+ * @return string
+ * the full path to the config file
* @static
*/
public static function createConfigFile($force = FALSE) {
* Get a list of FTS index names that are currently defined in the database.
*
* @param string $table
- * @return array (string $indexName => string $indexName)
+ * @return array
+ * (string $indexName => string $indexName)
*/
public function findActualFtsIndexNames($table) {
$mysqlVersion = CRM_Core_DAO::singleValueQuery('SELECT VERSION()');
* FTS index.
*
* @param $table
- * @return array (string $indexName => string $sql)
+ * @return array
+ * (string $indexName => string $sql)
*/
public function buildIndexSql($table) {
$sqls = array(); // array (string $idxName => string $sql)
* Generate a "DROP INDEX" statement for each existing FTS index
*
* @param string $table
- * @return array (string $idxName => string $sql)
+ * @return array
+ * (string $idxName => string $sql)
*/
public function dropIndexSql($table) {
$sqls = array();
* populates class param.
*
* @param void
- * @return array ($id => CRM_Core_ScheduledJob)
+ * @return array
+ * ($id => CRM_Core_ScheduledJob)
*
*/
/**
/**
* Generate a private key per session and store in session
*
- * @return string private key for this session
+ * @return string
+ * private key for this session
* @static
*/
public static function privateKey() {
* @param bool $addSequence
* Should we add a unique sequence number to the end of the key.
*
- * @return string valid formID
+ * @return string
+ * valid formID
* @static
*/
public static function get($name, $addSequence = FALSE) {
* @param string $name
* @param bool $addSequence
*
- * @return string $formKey if valid, else null
+ * @return string
+ * if valid, else null
* @static
*/
public static function validate($key, $name, $addSequence = FALSE) {
/**
* @param $modules
*
- * @return array indexed by is_active,name
+ * @return array
+ * indexed by is_active,name
*/
protected static function createModuleIndex($modules) {
$result = array();
* @param $moduleIndex
* @param $declarations
*
- * @return array indexed by module,name
+ * @return array
+ * indexed by module,name
*/
protected static function createDeclarationIndex($moduleIndex, $declarations) {
$result = array();
* @param string $path
* Path for which breadcrumb is to be build.
*
- * @return array The breadcrumb for this path
+ * @return array
+ * The breadcrumb for this path
*
* @static
*/
* @param string $keyColumnName
* the column to use for 'key'.
*
- * @return array the values as specified by the above params
+ * @return array
+ * the values as specified by the above params
* @static
* @void
*/
* @param bool $onlyActive
* @param bool $fresh
*
- * @return array of values as specified by the above params
+ * @return array
+ * of values as specified by the above params
* @static
* @void
*/
*
* @static
*
- * @return string the value from the row where is_default = true
+ * @return string
+ * the value from the row where is_default = true
*/
public static function getDefaultValue($groupName) {
if (empty($groupName)) {
*
* @static
*
- * @return int the option group ID
+ * @return int
+ * the option group ID
*/
public static function createAssoc($groupName, &$values, &$defaultID, $groupTitle = NULL) {
self::deleteAssoc($groupName);
* @param array $links
* Has links like edit, delete, disable ..etc.
*
- * @return array of option-values
+ * @return array
+ * of option-values
*
* @static
*/
* @param string $fieldName
* The name of the field in the DAO.
*
- * @return boolean true if object exists
+ * @return boolean
+ * true if object exists
* @static
*/
public static function optionExists($value, $daoName, $daoID, $optionGroupID, $fieldName = 'name') {
* @param string $mode
* @param string $contactType
*
- * @return boolean true if object exists
+ * @return boolean
+ * true if object exists
* @static
*/
public static function getFields($mode = '', $contactType = 'Individual') {
* @param bool $isActiveDo you want only active option values?.
* Do you want only active option values?.
*
- * @return array of option-values
+ * @return array
+ * of option-values
*
* @static
*/
/**
* Getter for embedded
*
- * @return boolean return the embedded value
+ * @return boolean
+ * return the embedded value
*/
public function getEmbedded() {
return $this->_embedded;
/**
* Getter for print
*
- * @return boolean return the print value
+ * @return boolean
+ * return the print value
*/
public function getPrint() {
return $this->_print;
* pages. This typically involves assigning the appropriate
* smarty variable :)
*
- * @return string The content generated by running this page
+ * @return string
+ * The content generated by running this page
*/
public function run() {
$this->registerResources(CRM_Core_Resources::singleton());
/**
* Get a list of AngularJS modules which should be autoloaded
*
- * @return array (string $name => array('ext' => string $key, 'js' => array $paths, 'css' => array $paths))
+ * @return array
+ * (string $name => array('ext' => string $key, 'js' => array $paths, 'css' => array $paths))
*/
public static function getAngularModules() {
$angularModules = array();
/**
* An array of action links
*
- * @return array (reference)
+ * @return array
+ * (reference)
*/
abstract function &links();
* @param int $name
* The name or title of the object.
*
- * @return string permission value if permission is granted, else null
+ * @return string
+ * permission value if permission is granted, else null
*/
public function checkPermission($id, $name) {
return CRM_Core_Permission::EDIT;
* Any parameters passed as part of this page request.
* @param bool $absolute
* Whether to return an absolute URL.
- * @return string URL
+ * @return string
+ * URL
*/
public static function createUrl($requestPath, $requestArgs, $pageArgs, $absolute) {
if (empty($pageArgs['url'])) {
* Return an array of all the details about the fields potentially required for payment fields
* Only those determined by getPaymentFormFields will actually be assigned to the form
*
- * @return array field metadata
+ * @return array
+ * field metadata
*/
public function getPaymentFormFieldsMetadata() {
//@todo convert credit card type into an option value
* @param array $params
* Assoc array of input parameters for this transaction.
*
- * @return array the result in an nice formatted array (or an error object)
+ * @return array
+ * the result in an nice formatted array (or an error object)
* @abstract
*/
abstract function doDirectPayment(&$params);
*
* @param $component
*
- * @return array $params (modified)
+ * @return array
+ * (modified)
* @throws CRM_Core_Exception
*/
public function doPayment(&$params, $component) {
/**
* This function checks to see if we have the right config values
*
- * @return string the error message if any
+ * @return string
+ * the error message if any
*/
abstract function checkConfig();
* @param array $params
* Assoc array of input parameters for this transaction.
*
- * @return array the result in a nice formatted array (or an error object)
+ * @return array
+ * the result in a nice formatted array (or an error object)
*/
public function doDirectPayment(&$params) {
if (!defined('CURLOPT_SSLCERT')) {
* @param int $invoiceId
* The ID to check.
*
- * @return bool True if ID exists, else false
+ * @return bool
+ * True if ID exists, else false
*/
public function _checkDupe($invoiceId) {
$contribution = new CRM_Contribute_DAO_Contribution();
* @param string $key
* @param string $data
*
- * @return string the HMAC_MD5 encoding string
+ * @return string
+ * the HMAC_MD5 encoding string
**/
public function hmac($key, $data) {
if (function_exists('mhash')) {
/**
* Calculate and return the transaction fingerprint
*
- * @return string fingerprint
+ * @return string
+ * fingerprint
**/
public function CalculateFP() {
$x_tran_key = $this->_getParam('paymentKey');
* @param string $data
* A single CSV line.
*
- * @return array CSV fields
+ * @return array
+ * CSV fields
*/
public function explode_csv($data) {
$data = trim($data);
* @param string $content
* XML reply from Authorize.Net.
*
- * @return array refId, resultCode, code, text, subscriptionId
+ * @return array
+ * refId, resultCode, code, text, subscriptionId
*/
public function _parseArbReturn($content) {
$refId = $this->_substring_between($content, '<refId>', '</refId>');
* @param string $field
* @param mixed $value
*
- * @return bool false if value is not a scalar, true if successful
+ * @return bool
+ * false if value is not a scalar, true if successful
*/
public function _setParam($field, $value) {
if (!is_scalar($value)) {
/**
* This function checks to see if we have the right config values
*
- * @return string the error message if any
+ * @return string
+ * the error message if any
*/
public function checkConfig() {
$error = array();
* @param array $params
* Assoc array of input parameters for this transaction.
*
- * @return array the result in a nice formatted array (or an error object)
+ * @return array
+ * the result in a nice formatted array (or an error object)
*/
public function doDirectPayment(&$params) {
// Invoke hook_civicrm_paymentProcessor
/**
* This function checks to see if we have the right config values
*
- * @return string the error message if any
+ * @return string
+ * the error message if any
*/
public function checkConfig() {
return NULL;
* @param int $invoiceId
* The ID to check.
*
- * @return bool True if ID exists, else false
+ * @return bool
+ * True if ID exists, else false
*/
public function _checkDupe($invoiceId) {
$contribution = new CRM_Contribute_DAO_Contribution();
* @param int $invoiceId
* The ID to check.
*
- * @return bool True if ID exists, else false
+ * @return bool
+ * True if ID exists, else false
*/
public function _checkDupe($invoiceId) {
$contribution = new CRM_Contribute_DAO_Contribution();
/**
* This function checks to see if we have the right config values
*
- * @return string the error message if any
+ * @return string
+ * the error message if any
*/
public function checkConfig() {
$config = CRM_Core_Config::singleton();
* @param array $params
* Assoc array of input parameters for this transaction.
*
- * @return array the result in an nice formatted array (or an error object)
+ * @return array
+ * the result in an nice formatted array (or an error object)
* @abstract
*/
public function doDirectPayment(&$params) {
* @param $response
* @param $serial
* @internal param \xml $xml_response response send by google in xml format
- * @return array context of this call (test, module, payment processor id)
+ * @return array
+ * context of this call (test, module, payment processor id)
* @static
*/
public function getContext($privateData, $orderNo, $root, $response, $serial) {
* @param array $params
* Assoc array of input parameters for this transaction.
*
- * @return array the result in an nice formatted array (or an error object)
+ * @return array
+ * the result in an nice formatted array (or an error object)
* @abstract
*/
public function doDirectPayment(&$params) {
*
* @internal param string $mode the mode we are operating in (live or test)
*
- * @return string the error message if any
+ * @return string
+ * the error message if any
*/
public function checkConfig() {
$error = array();
* @param array $params
* Assoc array of input parameters for this transaction.
*
- * @return array the result in an nice formatted array (or an error object)
+ * @return array
+ * the result in an nice formatted array (or an error object)
* @abstract
*/
public function doDirectPayment(&$params) {
/**
* This function checks to see if we have the right config values
*
- * @return string the error message if any
+ * @return string
+ * the error message if any
*/
public function checkConfig() {
$error = array();
* @param array $params
* Assoc array of input parameters for this transaction.
*
- * @return array the result in an nice formatted array (or an error object)
+ * @return array
+ * the result in an nice formatted array (or an error object)
* @abstract
*/
public function doDirectPayment(&$params) {
* @param string $field
* @param mixed $value
*
- * @return bool false if value is not a scalar, true if successful
+ * @return bool
+ * false if value is not a scalar, true if successful
*/
public function _setParam($field, $value) {
if (!is_scalar($value)) {
/**
* This function checks to see if we have the right config values
*
- * @return string the error message if any
+ * @return string
+ * the error message if any
*/
public function checkConfig() {
$error = array();
* @param array $params
* Assoc array of input parameters for this transaction.
*
- * @return array the result in an nice formatted array (or an error object)
+ * @return array
+ * the result in an nice formatted array (or an error object)
*/
public function setExpressCheckOut(&$params) {
$args = array();
* @param string $token
* The key associated with this transaction.
*
- * @return array the result in an nice formatted array (or an error object)
+ * @return array
+ * the result in an nice formatted array (or an error object)
*/
public function getExpressCheckoutDetails($token) {
$args = array();
*
* @internal param string $token the key associated with this transaction
*
- * @return array the result in an nice formatted array (or an error object)
+ * @return array
+ * the result in an nice formatted array (or an error object)
*/
public function doExpressCheckout(&$params) {
$args = array();
* Assoc array of input parameters for this transaction.
*
* @param string $component
- * @return array the result in an nice formatted array (or an error object)
+ * @return array
+ * the result in an nice formatted array (or an error object)
*/
public function doDirectPayment(&$params, $component = 'contribute') {
$args = array();
/**
* This function checks to see if we have the right config values
*
- * @return string the error message if any
+ * @return string
+ * the error message if any
*/
public function checkConfig() {
$error = array();
* @param array $params
* Assoc array of input parameters for this transaction.
*
- * @return array the result in an nice formatted array (or an error object)
+ * @return array
+ * the result in an nice formatted array (or an error object)
* @abstract
*/
public function doDirectPayment(&$params) {
* @param int $invoiceId
* The ID to check.
*
- * @return bool True if ID exists, else false
+ * @return bool
+ * True if ID exists, else false
*/
public function _checkDupe($invoiceId) {
//copied from Eway but not working and not really sure it should!
*
* @internal param string $mode the mode we are operating in (live or test)
*
- * @return string the error message if any
+ * @return string
+ * the error message if any
*/
public function checkConfig() {
$errorMsg = array();
*
* @internal param string $mode the mode we are operating in (live or test)
*
- * @return string the error message if any
+ * @return string
+ * the error message if any
*/
public function checkConfig() {
$config = CRM_Core_Config::singleton();
* @param array $params
* Assoc array of input parameters for this transaction.
*
- * @return array the result in an nice formatted array (or an error object)
+ * @return array
+ * the result in an nice formatted array (or an error object)
* @abstract
*/
public function doDirectPayment(&$params) {
* @param int $orderNo
* <order-total> send by google.
*
- * @return array context of this call (test, component, payment processor id)
+ * @return array
+ * context of this call (test, component, payment processor id)
* @static
*/
public static function getContext($privateData, $orderNo) {
* @param array $params
* Assoc array of input parameters for this transaction.
*
- * @return array the result in a nice formatted array (or an error object)
+ * @return array
+ * the result in a nice formatted array (or an error object)
*/
public function doDirectPayment(&$params) {
* @param string $xml
* an XML string.
*
- * @return array An array of the result with following keys:
+ * @return array
+ * An array of the result with following keys:
*/
public function xml_parse_into_assoc($xml) {
$input = array();
* @param int $invoiceId
* The ID to check.
*
- * @return bool True if ID exists, else false
+ * @return bool
+ * True if ID exists, else false
*/
public function _checkDupe($invoiceId) {
$contribution = new CRM_Contribute_DAO_Contribution();
* @param string $field
* @param mixed $value
*
- * @return bool false if value is not a scalar, true if successful
+ * @return bool
+ * false if value is not a scalar, true if successful
*/
public function _setParam($field, $value) {
if (!is_scalar($value)) {
/**
* This function checks to see if we have the right config values
*
- * @return string the error message if any
+ * @return string
+ * the error message if any
*/
public function checkConfig() {
$error = array();
* @param int $invoiceId
* The ID to check.
*
- * @return bool True if ID exists, else false
+ * @return bool
+ * True if ID exists, else false
*/
public function _checkDupe($invoiceId) {
$contribution = new CRM_Contribute_DAO_Contribution();
/**
* Get the current permission of this user
*
- * @return string the permission of the user (edit or view or null)
+ * @return string
+ * the permission of the user (edit or view or null)
*/
public static function getPermission() {
$config = CRM_Core_Config::singleton();
* array('access CiviEvent', 'access CiviContribute')
* ),
*
- * @return boolean true if yes, else false
+ * @return boolean
+ * true if yes, else false
* @static
*/
public static function check($permissions) {
* @param array $array
* The group/role to check.
*
- * @return boolean true if yes, else false
+ * @return boolean
+ * true if yes, else false
* @static
*/
public static function checkGroupRole($array) {
* @param array $whereTables
* (reference ) add the tables that are needed for the where clause.
*
- * @return string the group where clause for this user
+ * @return string
+ * the group where clause for this user
*/
public static function getPermissionedStaticGroupClause($type, &$tables, &$whereTables) {
$config = CRM_Core_Config::singleton();
*
* @static
*
- * @return array - array reference of all groups.
+ * @return array
+ * array reference of all groups.
*/
public static function group($groupType, $excludeHidden = TRUE) {
$config = CRM_Core_Config::singleton();
* @param string $permissionName
* Name of the permission we are interested in.
*
- * @return string a comma separated list of email addresses
+ * @return string
+ * a comma separated list of email addresses
*/
public static function permissionEmails($permissionName) {
$config = CRM_Core_Config::singleton();
* @param string $roleName
* Name of the role we are interested in.
*
- * @return string a comma separated list of email addresses
+ * @return string
+ * a comma separated list of email addresses
*/
public static function roleEmails($roleName) {
$config = CRM_Core_Config::singleton();
/**
* Get the current permission of this user
*
- * @return string the permission of the user (edit or view or null)
+ * @return string
+ * the permission of the user (edit or view or null)
*/
public function getPermission() {
return CRM_Core_Permission::EDIT;
* @param array $whereTables
* (reference ) add the tables that are needed for the where clause.
*
- * @return string the group where clause for this user
+ * @return string
+ * the group where clause for this user
*/
public function whereClause($type, &$tables, &$whereTables) {
return '( 1 )';
* @param array $whereTables
* (reference ) add the tables that are needed for the where clause.
*
- * @return string the group where clause for this user
+ * @return string
+ * the group where clause for this user
*/
public function getPermissionedStaticGroupClause($type, &$tables, &$whereTables) {
$this->group();
* @param bool|\boolen $excludeHidden exclude hidden groups.
*
*
- * @return array - array reference of all groups.
+ * @return array
+ * array reference of all groups.
*/
public function group($groupType = NULL, $excludeHidden = TRUE) {
return CRM_Core_PseudoConstant::allGroup($groupType, $excludeHidden);
* @param array $whereTables
* (reference ) add the tables that are needed for the where clause.
*
- * @return string the group where clause for this user
+ * @return string
+ * the group where clause for this user
*/
public function groupClause($type, &$tables, &$whereTables) {
return ' (1) ';
* @param string $str
* The permission to check.
*
- * @return boolean true if yes, else false
+ * @return boolean
+ * true if yes, else false
*/
public function check($str) {
* @param array $array
* The roles to check.
*
- * @return boolean true if yes, else false
+ * @return boolean
+ * true if yes, else false
*/
public function checkGroupRole($array) {
* @param string $permissionName
* Name of the permission we are interested in.
*
- * @return string a comma separated list of email addresses
+ * @return string
+ * a comma separated list of email addresses
*/
public function permissionEmails($permissionName) {
CRM_Core_Error::fatal("this function only works in Drupal 6 at the moment");
* @param string $roleName
* Name of the role we are interested in.
*
- * @return string a comma separated list of email addresses
+ * @return string
+ * a comma separated list of email addresses
*/
public function roleEmails($roleName) {
CRM_Core_Error::fatal("this function only works in Drupal 6 at the moment");
*
* @param $module
*
- * @return Array of permissions, in the same format as CRM_Core_Permission::getCorePermissions().
+ * @return Array
+ * of permissions, in the same format as CRM_Core_Permission::getCorePermissions().
* @see CRM_Core_Permission::getCorePermissions
*/
public static function getModulePermissions($module) {
* Get the permissions defined in the hook_civicrm_permission implementation
* in all enabled CiviCRM module extensions.
*
- * @return Array of permissions, in the same format as CRM_Core_Permission::getCorePermissions().
+ * @return Array
+ * of permissions, in the same format as CRM_Core_Permission::getCorePermissions().
*/
public function getAllModulePermissions() {
$permissions = array();
*
* @param int $contactID
*
- * @return boolean true if yes, else false
+ * @return boolean
+ * true if yes, else false
*/
public function check($str, $contactID = NULL) {
$str = $this->translatePermission($str, 'Drupal', array(
* @param array $array
* The roles to check.
*
- * @return boolean true if yes, else false
+ * @return boolean
+ * true if yes, else false
*/
public function checkGroupRole($array) {
if (function_exists('user_load') && isset($array)) {
* @param string $permissionName
* Name of the permission we are interested in.
*
- * @return string a comma separated list of email addresses
+ * @return string
+ * a comma separated list of email addresses
*/
public function permissionEmails($permissionName) {
static $_cache = array();
*
* @param int $contactID
*
- * @return boolean true if yes, else false
+ * @return boolean
+ * true if yes, else false
*/
public function check($str, $contactID = NULL) {
$str = $this->translatePermission($str, 'Drupal6', array(
* @param array $array
* The roles to check.
*
- * @return boolean true if yes, else false
+ * @return boolean
+ * true if yes, else false
*/
public function checkGroupRole($array) {
* @param string $roleName
* Name of the role we are interested in.
*
- * @return string a comma separated list of email addresses
+ * @return string
+ * a comma separated list of email addresses
*/
public function roleEmails($roleName) {
static $_cache = array();
* @param string $permissionName
* Name of the permission we are interested in.
*
- * @return string a comma separated list of email addresses
+ * @return string
+ * a comma separated list of email addresses
*/
public function permissionEmails($permissionName) {
static $_cache = array();
*
* @param $module
*
- * @return Array of permissions, in the same format as CRM_Core_Permission::getCorePermissions().
+ * @return Array
+ * of permissions, in the same format as CRM_Core_Permission::getCorePermissions().
*/
public static function getModulePermissions($module) {
$return_permissions = array();
* Exclude hidden groups.
*
*
- * @return array - array reference of all groups.
+ * @return array
+ * array reference of all groups.
*/
public function group($groupType = NULL, $excludeHidden = TRUE) {
if (!isset($this->_viewPermissionedGroups)) {
* @param array $whereTables
* (reference) add the tables that are needed for the where clause.
*
- * @return string the clause to add to the query retrieving viewable groups
+ * @return string
+ * the clause to add to the query retrieving viewable groups
*/
public function groupClause($type, &$tables, &$whereTables) {
if (!isset($this->_viewPermissionedGroups)) {
/**
* Get the current permission of this user
*
- * @return string the permission of the user (edit or view or null)
+ * @return string
+ * the permission of the user (edit or view or null)
*/
public function getPermission() {
$this->group();
* @param array $array
* The roles to check.
*
- * @return boolean true if yes, else false
+ * @return boolean
+ * true if yes, else false
*
*/
public function checkGroupRole($array) {
* @param string $permissionName
* Name of the permission we are interested in.
*
- * @return string a comma separated list of email addresses
+ * @return string
+ * a comma separated list of email addresses
*/
public function permissionEmails($permissionName) {
static $_cache = array();
* @param string $str
* The permission to check.
*
- * @return boolean true if yes, else false
+ * @return boolean
+ * true if yes, else false
*/
public function check($str) {
$config = CRM_Core_Config::singleton();
* @param array $array
* The roles to check.
*
- * @return boolean true if yes, else false
+ * @return boolean
+ * true if yes, else false
* @static
*/
public function checkGroupRole($array) {
* @param string $str
* The permission to check.
*
- * @return boolean true if yes, else false
+ * @return boolean
+ * true if yes, else false
*/
public function check($str) {
* @param string $str
* The permission to check.
*
- * @return boolean true if yes, else false
+ * @return boolean
+ * true if yes, else false
*/
public function check($str) {
if ($str == CRM_Core_Permission::ALWAYS_DENY_PERMISSION) {
* @param array $whereTables
* (reference ) add the tables that are needed for the where clause.
*
- * @return string the group where clause for this user
+ * @return string
+ * the group where clause for this user
*/
public function whereClause($type, &$tables, &$whereTables) {
return '( 1 )';
* @param string $str
* The permission to check.
*
- * @return boolean true if yes, else false
+ * @return boolean
+ * true if yes, else false
*/
public function check($str) {
// Generic cms 'administer users' role tranlates to 'administrator' WordPress role
*
* @static
*
- * @return array - array reference of all activity types.
+ * @return array
+ * array reference of all activity types.
*/
public static function &activityType() {
$args = func_get_args();
*
* @param bool $limit
*
- * @return array - array reference of all State/Provinces.
+ * @return array
+ * array reference of all State/Provinces.
*/
public static function &stateProvince($id = FALSE, $limit = TRUE) {
if (($id && !CRM_Utils_Array::value($id, self::$stateProvince)) || !self::$stateProvince || !$id) {
*
* @param bool $limit
*
- * @return array - array reference of all State/Province abbreviations.
+ * @return array
+ * array reference of all State/Province abbreviations.
*/
public static function &stateProvinceAbbreviation($id = FALSE, $limit = TRUE) {
if ($id > 1) {
*
* @param bool $applyLimit
*
- * @return array - array reference of all countries.
+ * @return array
+ * array reference of all countries.
*/
public static function country($id = FALSE, $applyLimit = TRUE) {
if (($id && !CRM_Utils_Array::value($id, self::$country)) || !self::$country || !$id) {
*
* @param bool $id
*
- * @return array - array reference of all country ISO codes.
+ * @return array
+ * array reference of all country ISO codes.
*/
public static function &countryIsoCode($id = FALSE) {
if (!self::$countryIsoCode) {
*
* @static
*
- * @return array - array reference of all groups.
+ * @return array
+ * array reference of all groups.
*/
public static function &allGroup($groupType = NULL, $excludeHidden = TRUE) {
$condition = CRM_Contact_BAO_Group::groupTypeCondition($groupType, $excludeHidden);
*
* @static
*
- * @return array - array reference of all groups.
+ * @return array
+ * array reference of all groups.
*/
public static function group($groupType = NULL, $excludeHidden = TRUE) {
return CRM_Core_Permission::group($groupType, $excludeHidden);
* @param null $groupType
* @param bool $excludeHidden
*
- * @return array - array reference of all groups.
+ * @return array
+ * array reference of all groups.
*/
public static function &staticGroup($onlyPublic = FALSE, $groupType = NULL, $excludeHidden = TRUE) {
if (!self::$staticGroup) {
*
* @static
*
- * @return array - array reference of all relationship types.
+ * @return array
+ * array reference of all relationship types.
*/
public static function &relationshipType($valueColumnName = 'label', $reset = FALSE) {
if (!CRM_Utils_Array::value($valueColumnName, self::$relationshipType) || $reset) {
* so far, we use this for validation only, so there's no point of putting this into the database
*
*
- * @return array - array reference of all currency codes
+ * @return array
+ * array reference of all currency codes
* @static
*/
public static function ¤cyCode() {
*
* @param bool|int $id - Optional id to return
*
- * @return array - array reference of all Counties
+ * @return array
+ * array reference of all Counties
*/
public static function &county($id = FALSE) {
if (!self::$county) {
*
* @param null $additionalCond
*
- * @return array - array of all payment processors
+ * @return array
+ * array of all payment processors
*/
public static function &paymentProcessor($all = FALSE, $test = FALSE, $additionalCond = NULL) {
$condition = "is_test = ";
* @param int $id
* @param string $return
*
- * @return array - array of all payment processor types
+ * @return array
+ * array of all payment processor types
*/
public static function &paymentProcessorType($all = FALSE, $id = NULL, $return = 'title') {
$cacheKey = $id . '_' . $return;
*
* @param bool $id
*
- * @return array - array reference of all World Regions
+ * @return array
+ * array reference of all World Regions
* @static
*/
public static function &worldRegion($id = FALSE) {
*
* @param string $column
*
- * @return array - array reference of all activity statuses
+ * @return array
+ * array reference of all activity statuses
*/
public static function &activityStatus($column = 'label') {
if (NULL === self::$activityStatus) {
*
* @param string $column
*
- * @return array - array reference of all Visibility levels.
+ * @return array
+ * array reference of all Visibility levels.
*/
public static function &visibility($column = 'label') {
if (!isset(self::$visibility)) {
*
* @param int $stateID
*
- * @return int the country id that the state belongs to
+ * @return int
+ * the country id that the state belongs to
* @static
*/
public static function countryIDForStateID($stateID) {
*
* @param string $columnName
*
- * @return array - array reference of all greetings.
+ * @return array
+ * array reference of all greetings.
*/
public static function greeting($filter, $columnName = 'label') {
$index = $filter['greeting_type'] . '_' . $columnName;
*
* @static
*
- * @return array - array reference of default greetings.
+ * @return array
+ * array reference of default greetings.
*
*/
public static function &greetingDefaults() {
*
* @static
*
- * @return array - array($fullyQualifiedName => $label) list of extensions
+ * @return array
+ * array($fullyQualifiedName => $label) list of extensions
*/
public static function &getExtensions() {
if (!self::$extensions) {
* @param int $id
* @param null $condition
*
- * @return array - array reference of all Option Group Name
+ * @return array
+ * array reference of all Option Group Name
*/
public static function accountOptionValues($optionGroupName, $id = NULL, $condition = NULL) {
$cacheKey = $optionGroupName . '_' . $condition;
* Whether to forcibly reload extensions list from canonical store.
* @static
*
- * @return array - array(array('prefix' => $, 'file' => $))
+ * @return array
+ * array(array('prefix' => $, 'file' => $))
*/
public static function getModuleExtensions($fresh = FALSE) {
return CRM_Extension_System::singleton()->getMapper()->getActiveModuleFiles($fresh);
*
* @static
*
- * @return array - array list of tax rates with the financial type
+ * @return array
+ * array list of tax rates with the financial type
*/
public static function getTaxRates() {
if (!self::$taxRates) {
*
* @param CRM_Core_DAO $targetDao
* The instance for which we want references.
- * @return array a record describing the reference; must include the keys:
+ * @return array
+ * a record describing the reference; must include the keys:
* - 'type': string (not necessarily unique)
* - 'count': int
*/
/**
* @param array $settings
* @param array $additions
- * @return array combination of $settings and $additions
+ * @return array
+ * combination of $settings and $additions
*/
protected function mergeSettings($settings, $additions) {
foreach ($additions as $k => $v) {
/**
* Create dynamic script for localizing js widgets
*
- * @return string javascript content
+ * @return string
+ * javascript content
*/
public static function outputLocalizationJS() {
CRM_Core_Page_AJAX::setJsHeaders();
}
/**
- * @return bool - is this page request an ajax snippet?
+ * @return bool
+ * is this page request an ajax snippet?
*/
public static function isAjaxMode() {
return in_array(CRM_Utils_Array::value('snippet', $_REQUEST), array(CRM_Core_Smarty::PRINT_SNIPPET, CRM_Core_Smarty::PRINT_NOFORM, CRM_Core_Smarty::PRINT_JSON));
* @param null $minOffset
* @param null $maxOffset
*
- * @return array the date array
+ * @return array
+ * the date array
* @static
*/
public static function date($type = NULL, $format = NULL, $minOffset = NULL, $maxOffset = NULL) {
/**
* Get the Map Provider
*
- * @return array $map array of map providers
+ * @return array
+ * array of map providers
* @static
*/
public static function mapProvider() {
/**
* Get the Geocoding Providers from available plugins
*
- * @return array $geo array of geocoder providers
+ * @return array
+ * array of geocoder providers
* @static
*/
public static function geoProvider() {
* Get the Address Standardization Providers from available
* plugins
*
- * @return array $addr array of address standardization providers
+ * @return array
+ * array of address standardization providers
* @static
*/
public static function addressProvider() {
*
* @param string action the action being performed
*
- * @return array the elements that can be sorted along with their properties
+ * @return array
+ * the elements that can be sorted along with their properties
*
*/
public function &getSortOrder($action);
* @param enum $type
* What should the result set include (web/email/csv).
*
- * @return array the column headers that need to be displayed
+ * @return array
+ * the column headers that need to be displayed
*/
public function &getColumnHeaders($action = NULL, $type = NULL);
*
* @param string action the action being performed
*
- * @return int the total number of rows for this action
+ * @return int
+ * the total number of rows for this action
*
*
*/
* @param enum $type
* What should the result set include (web/email/csv).
*
- * @return int the total number of rows for this action
+ * @return int
+ * the total number of rows for this action
*/
public function &getRows($action, $offset, $rowCount, $sort, $type = NULL);
*
* @param string type the type of export required: csv/xml/foaf etc
*
- * @return string the fileName which we will munge to skip spaces and
+ * @return string
+ * the fileName which we will munge to skip spaces and
* special characters to avoid various browser issues
*
*/
* @param string match the action to match against
* @param string attribute the attribute to return ( name, link, title )
*
- * @return string the attribute that matches the action if any
+ * @return string
+ * the attribute that matches the action if any
*
*
*/
* @param string $action
* The action being performed.
*
- * @return string template file name
+ * @return string
+ * template file name
*/
public function getTemplateFileName($action = NULL) {
return (str_replace('_', DIRECTORY_SEPARATOR, CRM_Utils_System::getClassName($this)) . ".tpl");
*
* @param string action the action being performed
*
- * @return array the elements that can be sorted along with their properties
+ * @return array
+ * the elements that can be sorted along with their properties
*/
public function &getSortOrder($action) {
$columnHeaders = &$this->getColumnHeaders(NULL);
* @param int $reset
* Are we being reset.
*
- * @return boolean if the GET params are different from the session params
+ * @return boolean
+ * if the GET params are different from the session params
*/
public function hasChanged($reset) {
*
* @param CRM_Core_Form $form
*
- * @return array of rows
+ * @return array
+ * of rows
*/
public function getRows($form) {
if ($form->_output == self::EXPORT || $form->_output == self::SCREEN) {
* Default function for qill, if needed to be implemented, we
* expect the subclass to do it
*
- * @return string the status message
+ * @return string
+ * the status message
*/
public function getQill() {
return $this->_object->getQill();
/**
* Getter for embedded
*
- * @return boolean return the embedded value
+ * @return boolean
+ * return the embedded value
*/
public function getEmbedded() {
return $this->_embedded;
/**
* Getter for print
*
- * @return boolean return the print value
+ * @return boolean
+ * return the print value
*/
public function getPrint() {
return $this->_print;
/**
* Pops the top userContext stack
*
- * @return string the top of the userContext stack (also pops the top element)
+ * @return string
+ * the top of the userContext stack (also pops the top element)
*
*/
public function popUserContext() {
/**
* Reads the top userContext stack
*
- * @return string the top of the userContext stack
+ * @return string
+ * the top of the userContext stack
*
*/
public function readUserContext() {
* @param bool $reset
* Should we reset the status variable?.
*
- * @return string the status message if any
+ * @return string
+ * the status message if any
*/
public function getStatus($reset = FALSE) {
$this->initialize();
* @param string $text
* @param string $js
*
- * @return string the formatted html link
+ * @return string
+ * the formatted html link
*/
public static function linkHtml($name, $href, $text, $js) {
return '<a name="' . $name . '" id="' . $name . '" href="' . $href . '" ' . $js . ">$text</a>";
* @param object $smarty
* The Smarty object.
*
- * @return string the string, translated by gettext
+ * @return string
+ * the string, translated by gettext
*/
function smarty_block_edit($params, $text, &$smarty) {
$action = $smarty->_tpl_vars['action'];
* @param object $smarty
* The Smarty object.
*
- * @return string the string, translated by gettext
+ * @return string
+ * the string, translated by gettext
*/
function smarty_block_htxt($params, $text, &$smarty) {
$id = $params['id'];
* @param object $smarty
* The Smarty object.
*
- * @return string multilingualized query
+ * @return string
+ * multilingualized query
*/
function smarty_block_localize($params, $text, &$smarty) {
if (!$smarty->_tpl_vars['multilingual']) {
* @param object $smarty
* The Smarty object.
*
- * @return string the string, translated by gettext
+ * @return string
+ * the string, translated by gettext
*/
function smarty_block_serialize($params, $text, &$smarty) {
return serialize($text);
* @param object $smarty
* The Smarty object.
*
- * @return string the string, translated by gettext
+ * @return string
+ * the string, translated by gettext
*/
function smarty_block_ts($params, $text, &$smarty) {
if (!isset($params['domain'])) {
* @param object $smarty
* The Smarty object.
*
- * @return string the generated key
+ * @return string
+ * the generated key
*/
function smarty_function_crmKey($params, &$smarty) {
return
* @param object $smarty
* The Smarty object.
*
- * @return string HTML
+ * @return string
+ * HTML
*/
function smarty_function_crmNavigationMenu($params, &$smarty) {
$config = CRM_Core_Config::singleton();
* @param object $smarty
* Reference to the smarty object.
*
- * @return string HTML code of a link to documentation
+ * @return string
+ * HTML code of a link to documentation
*/
function smarty_function_docURL($params, &$smarty) {
if (!isset($smarty)) {
* @param object $smarty
* Reference to the smarty object.
*
- * @return string the help html to be inserted
+ * @return string
+ * the help html to be inserted
*/
function smarty_function_help($params, &$smarty) {
if (!isset($params['id']) || !isset($smarty->_tpl_vars['config'])) {
* @param object $smarty
* The Smarty object.
*
- * @return string the string, translated by gettext
+ * @return string
+ * the string, translated by gettext
*/
function smarty_function_sectionTotal($params, &$smarty) {
/* section totals are stored in template variable 'sectionTotals',
* @param string $class
* The new class or classes to add (separate with a space).
*
- * @return string the new modified html string
+ * @return string
+ * the new modified html string
*/
function smarty_modifier_crmAddClass($string, $class) {
// Standardize white space
*
* @param string $btnName
*
- * @return string button type, one of: 'upload', 'next', 'back', 'cancel', 'refresh'
+ * @return string
+ * button type, one of: 'upload', 'next', 'back', 'cancel', 'refresh'
* 'submit', 'done', 'display', 'jump' 'process'
*/
function smarty_modifier_crmBtnType($btnName) {
* @param null $dateFormat
* @param bool $onlyTime
*
- * @return string human readable date format | invalid date message
+ * @return string
+ * human readable date format | invalid date message
*/
function smarty_modifier_crmDate($dateString, $dateFormat = NULL, $onlyTime = FALSE) {
if ($dateString) {
* @param string $attribute
* The attribute to modify.
*
- * @return string the new modified html string
+ * @return string
+ * the new modified html string
*/
function smarty_modifier_crmDelete($string, $attribute) {
static $endOfElement = '/>';
*
* @param bool $gdata
*
- * @return string formatted text
+ * @return string
+ * formatted text
*/
function smarty_modifier_crmICalDate($str, $gdata = FALSE) {
return CRM_Utils_ICalendar::formatDate($str, $gdata);
*
* @param string $str
*
- * @return string formatted text
+ * @return string
+ * formatted text
*/
function smarty_modifier_crmICalText($str) {
return CRM_Utils_ICalendar::formatText($str);
* @param string $insertBefore
* The string before which we want this tag inserted.
*
- * @return string the new modified html string
+ * @return string
+ * the new modified html string
*/
function smarty_modifier_crmInsert($string, $attribute, $value, $insertBefore = '/>') {
return str_replace($insertBefore, ' ' . $attribute . '="' . $value . '"' . $insertBefore, $string);
* @param null $format
* @param bool $onlyNumber
*
- * @return string formatted monetary amount
+ * @return string
+ * formatted monetary amount
*/
function smarty_modifier_crmMoney($amount, $currency = NULL, $format = NULL, $onlyNumber = FALSE) {
return CRM_Utils_Money::format($amount, $currency, $format, $onlyNumber);
* @param string $thousands_sep
* Thousands sep character (if other than ",").
*
- * @return string the formatted string
+ * @return string
+ * the formatted string
*
* For alternate decimal point and thousands separator, delimit values with single quotes in the template.
* EXAMPLE: {$number|crmNumberFormat:2:',':' '} for French notation - 1234.56 becomes 1 234,56
* @param string $value
* The new attribute value.
*
- * @return string the new modified html string
+ * @return string
+ * the new modified html string
*/
function smarty_modifier_crmReplace($string, $attribute, $value) {
// we need to search and replace the string: $attribute=XXX or $attribute="XXX"
* @param string $full
* All alternatives as a long string (or some other text).
*
- * @return string only the first alternative found (or the text without alternatives)
+ * @return string
+ * only the first alternative found (or the text without alternatives)
*/
function smarty_modifier_crmStripAlternatives($full) {
return CRM_Utils_String::stripAlternatives($full);
* @param string $text
* Text to HTML-ize.
*
- * @return string HTML-ized version of $text
+ * @return string
+ * HTML-ized version of $text
*/
function smarty_modifier_htmlize($text) {
$text = preg_replace('@(https?://([-\w\.]+)+(:\d+)?(/([-\w/_\.]*(\?\S+)?)?)?)@', '<a href="$1">$1</a>', $text);
*
* @param mixed $data
*
- * @return string JSON
+ * @return string
+ * JSON
*/
function smarty_modifier_json($data) {
return json_encode($data);
* @param string $name
* The state name.
*
- * @return object the state object
+ * @return object
+ * the state object
*/
public function find($name) {
if (array_key_exists($name, $this->_states)) {
/**
* Return the list of state objects
*
- * @return array array of states in the state machine
+ * @return array
+ * array of states in the state machine
*/
public function getStates() {
return $this->_states;
/**
* Return the list of form objects
*
- * @return array array of pages in the state machine
+ * @return array
+ * array of pages in the state machine
*/
public function getPages() {
return $this->_pages;
*
* @param null
*
- * @return array array of default values
+ * @return array
+ * array of default values
*/
public function setDefaultValues() {
$defaults = $this->_values;
* @param $files
* @param $self
*
- * @return array if errors then list of errors to be posted back to the form,
+ * @return array
+ * if errors then list of errors to be posted back to the form,
* true otherwise
* @static
*/
*
* @param null
*
- * @return array array of default values
+ * @return array
+ * array of default values
*/
public function setDefaultValues() {
$defaults = &$this->_defaults;
* @param array $list
* Array of relationship name.
*
- * @return array of relationship name.
+ * @return array
+ * of relationship name.
*/
public static function getFormattedList(&$list) {
$relName = array();
*
* @param null
*
- * @return array array of default values
+ * @return array
+ * array of default values
*/
public function setDefaultValues() {
$defaults = $fieldDefaults = array();
* @param $files
* @param CRM_Core_Form $form
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($fields, $files, $form) {
*
* @param null
*
- * @return array the default array reference
+ * @return array
+ * the default array reference
*/
public function setDefaultValues() {
$defaults = array();
* @param array $fields
* Posted values of the form.
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($fields) {
/**
* Format the field values for input to the api
*
- * @return array (reference ) associative array of name/value pairs
+ * @return array
+ * (reference ) associative array of name/value pairs
*/
public function &getActiveFieldParams() {
$params = array();
* @param array $values
* The array of values belonging to this line.
*
- * @return boolean the result of this processing
+ * @return boolean
+ * the result of this processing
*/
public function preview(&$values) {
return $this->summary($values);
* @param array $values
* The array of values belonging to this line.
*
- * @return boolean the result of this processing
+ * @return boolean
+ * the result of this processing
* It is called from both the preview & the import actions
* (non-PHPdoc)
* @see CRM_Custom_Import_Parser_BaseClass::summary()
* @param array $values
* The array of values belonging to this line.
*
- * @return boolean the result of this processing
+ * @return boolean
+ * the result of this processing
*/
public function import($onDuplicate, &$values) {
$response = $this->summary($values);
* @param int $id
* Custom group ID.
*
- * @return array $importableFields
+ * @return array
*
* @static
*/
*
* @param null
*
- * @return array array of action links that we need to display for the browse screen
+ * @return array
+ * array of action links that we need to display for the browse screen
*/
public function &actionLinks() {
if (!isset(self::$_actionLinks)) {
*
* @param null
*
- * @return array array of action links that we need to display for the browse screen
+ * @return array
+ * array of action links that we need to display for the browse screen
*/
public function &actionLinks() {
// check if variable _actionsLinks is populated
*
* @param null
*
- * @return array array of action links that we need to display for the browse screen
+ * @return array
+ * array of action links that we need to display for the browse screen
*/
public function &actionLinks() {
if (!isset(self::$_actionLinks)) {
* Return the SQL query for the given rule - either for finding matching
* pairs of contacts, or for matching against the $params variable (if set).
*
- * @return string SQL query performing the search
+ * @return string
+ * SQL query performing the search
*/
public function sql() {
if ($this->params &&
* @param string $requestedType
* The requested contact type.
*
- * @return array a table-keyed array of field-keyed arrays holding supported fields' titles
+ * @return array
+ * a table-keyed array of field-keyed arrays holding supported fields' titles
*/
public static function &supportedFields($requestedType) {
static $fields = NULL;
*
* @param array $params
*
- * @return array (rule field => weight) array and threshold associated to rule group
+ * @return array
+ * (rule field => weight) array and threshold associated to rule group
* @access public
*/
public static function dedupeRuleFieldsWeight($params) {
*
* @static
*
- * @return array id => "nice name" of rule group
+ * @return array
+ * id => "nice name" of rule group
*/
public static function getByType($contactType = NULL) {
$dao = new CRM_Dedupe_DAO_RuleGroup();
* @param array $cids
* Contact ids to limit the search to.
*
- * @return array array of (cid1, cid2, weight) dupe triples
+ * @return array
+ * array of (cid1, cid2, weight) dupe triples
*/
public static function dupes($rgid, $cids = array()) {
$rgBao = new CRM_Dedupe_BAO_RuleGroup();
* @param int $ruleGroupID
* The id of the dedupe rule we should be using.
*
- * @return array matching contact ids
+ * @return array
+ * matching contact ids
*/
static function dupesByParams(
$params,
* @param int $gid
* Contact group id (currently, works only with non-smart groups).
*
- * @return array array of (cid1, cid2, weight) dupe triples
+ * @return array
+ * array of (cid1, cid2, weight) dupe triples
*/
public static function dupesInGroup($rgid, $gid) {
$cids = array_keys(CRM_Contact_BAO_Group::getMember($gid));
* @param string $ctype
* Contact type of the given contact.
*
- * @return array array of dupe contact_ids
+ * @return array
+ * array of dupe contact_ids
*/
public static function dupesOfContact($cid, $used = 'Unsupervised', $ctype = NULL) {
// if not provided, fetch the contact type from the database
* @param string $ctype
* Contact type of the given contact.
*
- * @return array valid $params array for dedupe
+ * @return array
+ * valid $params array for dedupe
*/
public static function formatParams($fields, $ctype) {
$flat = array();
}
/**
- * @return array of field names which will be compared, so everything except ID.
+ * @return array
+ * of field names which will be compared, so everything except ID.
*/
public static function getContactFields() {
$contactFields = CRM_Contact_DAO_Contact::fields();
* @param bool $is_active
* Value we want to set the is_active field.
*
- * @return Object DAO object on sucess, null otherwise
+ * @return Object
+ * DAO object on sucess, null otherwise
* @static
*/
public static function setIsActive($id, $is_active) {
*
* @static
*
- * @return array Array of event summary values
+ * @return array
+ * Array of event summary values
*/
public static function getEventSummary() {
$eventSummary = $eventIds = array();
* Consider counted( is filter role) participant.
*
*
- * @return array array with count of participants for each event based on status/role
+ * @return array
+ * array with count of participants for each event based on status/role
*/
public static function getParticipantCount(
$eventId,
* @param bool $onlyPublicInclude public events only, default TRUE.
* Include public events only, default TRUE.
*
- * @return array $all array of all the events that are searched
+ * @return array
+ * array of all the events that are searched
* @static
*/
static function &getCompleteInfo(
*
* @param bool $skipCancel
*
- * @return array $customProfile array of Additional participant's info OR array of Ids.
+ * @return array
+ * array of Additional participant's info OR array of Ids.
*/
static function buildCustomProfile(
$participantId,
/* Function to retrieve all events those having location block set.
*
- * @return array $events array of all events.
+ * @return array
+ * array of all events.
*/
/**
* @return array
*
* @param array $values
* Key/value event info.
- * @return boolean true if allow registration otherwise false
+ * @return boolean
+ * true if allow registration otherwise false
*/
/**
* @param $values
*
* @param array $params
* Key/value participant info.
- * @return boolean $alreadyRegistered true/false
+ * @return boolean
*/
/**
* @param array $params
* @param int $eventId
* @param int $type
*
- * @return string the permission that the user has (or null)
+ * @return string
+ * the permission that the user has (or null)
* @static
*/
public static function checkPermission($eventId = NULL, $type = CRM_Core_Permission::VIEW) {
* @param int $eventId
* The id of the event.
*
- * @return array an array of email ids
+ * @return array
+ * an array of email ids
* @static
*/
public static function getFromEmailIds($eventId = NULL) {
* @param sting $extraWhereClause
* Extra filter on participants.
*
- * @return int event total seats w/ given criteria.
+ * @return int
+ * event total seats w/ given criteria.
* @static
*/
public static function eventTotalSeats($eventId, $extraWhereClause = NULL) {
* @param int $templateId
* Event template id.
*
- * @return array of custom data defaults.
+ * @return array
+ * of custom data defaults.
*/
public static function getTemplateDefaultValues($templateId) {
$defaults = array();
* @param bool $considerWaiting
* @param bool $considerTestParticipants
*
- * @return array $optionsCount an array of each option id and total count
+ * @return array
+ * an array of each option id and total count
* @static
*/
static function priceSetOptionsCount(
* @param int $eventId
* Event id.
*
- * @return int $spaces Number of Empty Seats/null.
+ * @return int
+ * $spaces Number of Empty Seats/null.
* @static
*/
public static function pendingToConfirmSpaces($eventId) {
* @param bool $status
* @param bool $onlyParticipant
*
- * @return array array of importable Fields
+ * @return array
+ * array of importable Fields
* @static
*/
public static function &importableFields($contactType = 'Individual', $status = TRUE, $onlyParticipant = FALSE) {
/**
* Combine all the exportable fields from the lower levels object
*
- * @return array array of exportable Fields
+ * @return array
+ * array of exportable Fields
* @static
*/
public static function &exportableFields() {
* @param int $participantId
* Id of the participant.
*
- * @return array $name associated array with sort_name and event title
+ * @return array
+ * associated array with sort_name and event title
* @static
*/
public static function participantDetails($participantId) {
*
* @param int $oldStatusId
*
- * @return array $additionalParticipantIds
+ * @return array
* @static
*/
public static function getAdditionalParticipantIds($primaryParticipantId, $excludeCancel = TRUE, $oldStatusId = NULL) {
* @param bool $hasLineItems
* Do fetch from line items.
*
- * @return array $feeDetails
+ * @return array
* @static
*/
public function getFeeDetails($participantIds, $hasLineItems = FALSE) {
* @param int $primaryParticipantID
* Id of primary participant record.
*
- * @return array $additionalParticipants $displayName => $viewUrl
+ * @return array
+ * $displayName => $viewUrl
* @static
*/
public static function getAdditionalParticipants($primaryParticipantID) {
*
* @param int $contactID
*
- * @return int count of participant records
+ * @return int
+ * count of participant records
* @static
*/
public static function getContactParticipantCount($contactID) {
* @param bool $excludeCancelled
* Exclude cancelled additional participant.
*
- * @return array $participantsId
+ * @return array
* @static
*/
public static function getParticipantIds($contributionId, $excludeCancelled = FALSE) {
* @param array $participantIds
* An array of additional participant ids.
*
- * @return array of Urls.
+ * @return array
+ * of Urls.
* @static
*/
public static function getAdditionalParticipantUrl($participantIds) {
* @param array $ids
* with one values of id for this participantPayment record (for update).
*
- * @return object the partcipant payment record
+ * @return object
+ * the partcipant payment record
* @static
*/
public static function create(&$params, &$ids) {
* @param array $params
* Associative array whose values match the record to be deleted.
*
- * @return boolean true if deleted false otherwise
+ * @return boolean
+ * true if deleted false otherwise
* @static
*/
public static function deleteParticipantPayment($params) {
*
* @param array $values
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($values) {
* @param int $templateId
* Event template id.
*
- * @return array of custom data defaults.
+ * @return array
+ * of custom data defaults.
*/
public function templateCustomDataValues($templateId) {
$defaults = array();
* @param array $values
* Posted values of the form.
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($values) {
* @param array $fields
* Posted values of the form.
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($fields) {
* @param $files
* @param CRM_Core_Form $form
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($values, $files, $form) {
* @param $files
* @param $self
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($values, $files, $self) {
* An array of user submitted params.
*
*
- * @return array $formatted, formatted price set params.
+ * @return array
+ * , formatted price set params.
*/
/**
* @param CRM_Core_Form $form
* Form object.
*
*
- * @return array $optionsCount, array of each option w/ count total.
+ * @return array
+ * , array of each option w/ count total.
*/
/**
* @param $form
*
* @param bool $isButtonJs
*
- * @return boolean ture on success.
+ * @return boolean
+ * ture on success.
*/
public function isLastParticipant($isButtonJs = FALSE) {
$participant = $isButtonJs ? $this->_params[0]['additional_participants'] : $this->_params[0]['additional_participants'] + 1;
* Set the default form values
*
*
- * @return array the default array reference
+ * @return array
+ * the default array reference
*/
public function setDefaultValues() {
$defaults = array();
* Set the default form values
*
*
- * @return array the default array reference
+ * @return array
+ * the default array reference
*/
public function setDefaultValues() {
$defaults = array();
* @param array $fields
* Posted values of the form.
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($params) {
* @param array $fields
* Posted values of the form.
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($fields) {
* @param $files
* @param $self
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($fields, $files, $self) {
/**
* Format the field values for input to the api
*
- * @return array (reference ) associative array of name/value pairs
+ * @return array
+ * (reference ) associative array of name/value pairs
*/
public function &getActiveFieldParams() {
$params = array();
* @param array $values
* The array of values belonging to this line.
*
- * @return boolean the result of this processing
+ * @return boolean
+ * the result of this processing
*/
public function preview(&$values) {
return $this->summary($values);
* @param array $values
* The array of values belonging to this line.
*
- * @return boolean the result of this processing
+ * @return boolean
+ * the result of this processing
*/
public function summary(&$values) {
$erroneousField = NULL;
* @param array $values
* The array of values belonging to this line.
*
- * @return boolean the result of this processing
+ * @return boolean
+ * the result of this processing
*/
public function import($onDuplicate, &$values) {
/**
* Get action Links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
*/
public function &links() {
if (!(self::$_actionLinks)) {
*
* @param $enableCart
*
- * @return array (reference) of tab links
+ * @return array
+ * (reference) of tab links
*/
public static function &tabs($enableCart) {
$cacheKey = $enableCart ? 1 : 0;
* @param bool $all
* @param null $condition
*
- * @return array - array of all events if any
+ * @return array
+ * array of all events if any
* @static
*/
public static function event($id = NULL, $all = FALSE, $condition = NULL) {
* @param string $retColumn
* Tells populate() whether to return 'name' (default) or 'label' values.
*
- * @return array - array reference of all participant statuses if any
+ * @return array
+ * array reference of all participant statuses if any
* @static
*/
public static function &participantStatus($id = NULL, $cond = NULL, $retColumn = 'name') {
/**
* Return a status-type-keyed array of status classes
*
- * @return array of status classes, keyed by status type
+ * @return array
+ * of status classes, keyed by status type
*/
public static function &participantStatusClass() {
static $statusClasses = NULL;
* @param int $id
* @param null $cond
*
- * @return array - array reference of all participant roles if any
+ * @return array
+ * array reference of all participant roles if any
* @static
*/
public static function &participantRole($id = NULL, $cond = NULL) {
*
* @param int $id
*
- * @return array - array reference of all participant listings if any
+ * @return array
+ * array reference of all participant listings if any
* @static
*/
public static function &participantListing($id = NULL) {
*
*
* @param int $id
- * @return array - array reference of all event types.
+ * @return array
+ * array reference of all event types.
* @static
*/
public static function &eventType($id = NULL) {
*
* @param int $id
*
- * @return array of event id → template title pairs
+ * @return array
+ * of event id → template title pairs
*/
public static function &eventTemplates($id = NULL) {
if (!self::$eventTemplates) {
*
*
* @param int $id
- * @return array - array reference of all pcp if any
+ * @return array
+ * array reference of all pcp if any
* @static
*/
public static function &pcPage($id = NULL) {
*
* @param
*
- * @return int Total number of rows
+ * @return int
+ * Total number of rows
*/
public function getTotalCount($action) {
return $this->_query->searchQuery(0, 0, NULL,
* @param enum $output
* What should the result set include (web/email/csv).
*
- * @return array rows in the given offset and rowCount
+ * @return array
+ * rows in the given offset and rowCount
*/
public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
$result = $this->_query->searchQuery($offset, $rowCount, $sort,
* FIXME: the current internationalisation is bad, but should more or less work
* on most of "European" languages
*
- * @return array $qill which contains an array of strings
+ * @return array
+ * which contains an array of strings
*/
public function getQILL() {
return $this->_query->qill();
* @param enum $output
* What should the result set include (web/email/csv).
*
- * @return array the column headers that need to be displayed
+ * @return array
+ * the column headers that need to be displayed
*/
public function &getColumnHeaders($action = NULL, $output = NULL) {
if (!isset(self::$_columnHeaders)) {
* @param string $output
* Type of output.
*
- * @return string name of the file
+ * @return string
+ * name of the file
*/
public function getExportFileName($output = 'csv') {
return ts('CiviCRM Event Search');
*
* @param string $formName
*
- * @return string the name of the form that will handle the task
+ * @return string
+ * the name of the form that will handle the task
*/
public function taskName($controller, $formName = 'Search') {
// total hack, check POST vars and then session to determine stuff
* These tasks are the core set of tasks that the user can perform
* on a contact / group of contacts
*
- * @return array the set of tasks for a group of contacts
+ * @return array
+ * the set of tasks for a group of contacts
* @static
*/
public static function &tasks() {
* These tasks are the core set of task titles
* for participants
*
- * @return array the set of task titles
+ * @return array
+ * the set of task titles
* @static
*/
public static function &taskTitles() {
/**
* These tasks get added based on the context the user is in
*
- * @return array the set of optional tasks for a group of contacts
+ * @return array
+ * the set of optional tasks for a group of contacts
* @static
*/
public static function &optionalTaskTitle() {
*
* @param int $permission
*
- * @return array set of tasks that are valid for the user
+ * @return array
+ * set of tasks that are valid for the user
*/
public static function &permissionedTaskTitles($permission) {
$tasks = array();
*
* @param int $value
*
- * @return array the set of tasks for a group of participants
+ * @return array
+ * the set of tasks for a group of participants
* @static
*/
public static function getTask($value) {
* @param int $mode
* Export mode.
*
- * @return string name of the file
+ * @return string
+ * name of the file
*/
public static function getExportFileName($output = 'csv', $mode = CRM_Export_Form_Select::CONTACT_EXPORT) {
switch ($mode) {
* @param $values
* @param int $mappingTypeId
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($fields, $values, $mappingTypeId) {
* extensions.
*
*
- * @return Array list of extension names
+ * @return Array
+ * list of extension names
*/
private function grabRemoteKeyList() {
* Get a list of all keys in these containers -- and the
* name of the container which defines each key.
*
- * @return array ($key => $containerName)
+ * @return array
+ * ($key => $containerName)
*/
public function getKeysToContainer() {
if ($this->cache) {
/**
* Determine whether downloading is supported
*
- * @return array list of error messages; empty if OK
+ * @return array
+ * list of error messages; empty if OK
*/
public function checkRequirements() {
$errors = array();
* The name of the extension being installed.
* @param string $downloadUrl
* URL of a .zip file.
- * @return bool TRUE for success
+ * @return bool
+ * TRUE for success
* @throws CRM_Extension_Exception
*/
public function download($key, $downloadUrl) {
* URL of a .zip file.
* @param string $localFile
* Path at which to store the .zip file.
- * @return boolean Whether the download was successful.
+ * @return boolean
+ * Whether the download was successful.
*/
public function fetch($remoteFile, $localFile) {
$result = CRM_Utils_HttpClient::singleton()->fetch($remoteFile, $localFile);
*
* @param $key
*
- * @return string constant (STATUS_INSTALLED, STATUS_DISABLED, STATUS_UNINSTALLED, STATUS_UNKNOWN)
+ * @return string
+ * constant (STATUS_INSTALLED, STATUS_DISABLED, STATUS_UNINSTALLED, STATUS_UNKNOWN)
*/
public function getStatus($key) {
$statuses = $this->getStatuses();
/**
* Determine the status of all extensions
*
- * @return array ($key => status_constant)
+ * @return array
+ * ($key => status_constant)
*/
public function getStatuses() {
if (!is_array($this->statuses)) {
* @param $key
*
* @throws CRM_Extension_Exception
- * @return array (0 => CRM_Extension_Info, 1 => CRM_Extension_Manager_Interface)
+ * @return array
+ * (0 => CRM_Extension_Info, 1 => CRM_Extension_Manager_Interface)
*/
private function _getInfoTypeHandler($key) {
$info = $this->mapper->keyToInfo($key); // throws Exception
* @param $key
*
* @throws CRM_Extension_Exception
- * @return array (0 => CRM_Extension_Info, 1 => CRM_Extension_Manager_Interface)
+ * @return array
+ * (0 => CRM_Extension_Info, 1 => CRM_Extension_Manager_Interface)
*/
private function _getMissingInfoTypeHandler($key) {
$info = $this->createInfoFromDB($key);
/**
* @param string $attr
* The attribute used to key the array.
- * @return array ($$attr => $id)
+ * @return array
+ * ($$attr => $id)
*/
private function _getAllPaymentProcessorTypes($attr) {
$ppt = array();
* @param string $clazz
* Extension class name.
*
- * @return string name of extension key
+ * @return string
+ * name of extension key
*/
public function classToKey($clazz) {
return str_replace('_', '.', $clazz);
*
* @param $clazz
*
- * @return string full path the extension .php file
+ * @return string
+ * full path the extension .php file
*/
public function classToPath($clazz) {
$elements = explode('_', $clazz);
* @param string $key
* A string which might be an extension key.
*
- * @return boolean true if given string is an extension name
+ * @return boolean
+ * true if given string is an extension name
*/
public function isExtensionKey($key) {
// check if the string is an extension name or the class
* @param string $clazz
* A string which might be an extension class name.
*
- * @return boolean true if given string is an extension class name
+ * @return boolean
+ * true if given string is an extension class name
*/
public function isExtensionClass($clazz) {
* @param string $key
* Extension key.
*
- * @return string name of extension's main class
+ * @return string
+ * name of extension's main class
*/
public function keyToClass($key) {
return str_replace('.', '_', $key);
* @param string $key
* Extension key.
*
- * @return string path to file containing extension's main class
+ * @return string
+ * path to file containing extension's main class
*/
public function keyToPath($key) {
$info = $this->keyToInfo($key);
*
* @param string $key
* Extension key.
- * @return string local path of the extension source tree
+ * @return string
+ * local path of the extension source tree
*/
public function keyToBasePath($key) {
if ($key == 'civicrm') {
* @param string $key
* Extension key.
*
- * @return string url for resources in this extension
+ * @return string
+ * url for resources in this extension
*/
public function keyToUrl($key) {
if ($key == 'civicrm') {
*
* @param bool $fresh
* whether to forcibly reload extensions list from canonical store.
- * @return array - array(array('prefix' => $, 'file' => $))
+ * @return array
+ * array(array('prefix' => $, 'file' => $))
*/
public function getActiveModuleFiles($fresh = FALSE) {
$config = CRM_Core_Config::singleton();
/**
* Get a list of base URLs for all active modules
*
- * @return array (string $extKey => string $baseUrl)
+ * @return array
+ * (string $extKey => string $baseUrl)
*/
public function getActiveModuleUrls() {
// TODO optimization/caching
/**
* Get a list of all installed modules, including enabled and disabled ones
*
- * @return array CRM_Core_Module
+ * @return array
+ * CRM_Core_Module
*/
public function getModules() {
$result = array();
* @param string $clazz
* Extension class name.
*
- * @return string path to extension's templates directory
+ * @return string
+ * path to extension's templates directory
*/
public function getTemplatePath($clazz) {
$path = $this->container->getPath($this->classToKey($clazz));
* @param string $clazz
* Extension class name.
*
- * @return string extension's template name
+ * @return string
+ * extension's template name
*/
public function getTemplateName($clazz) {
$info = $this->keyToInfo($this->classToKey($clazz));
* @param bool $is_active
* Value we want to set the is_active field.
*
- * @return Object DAO object on sucess, null otherwise
+ * @return Object
+ * DAO object on sucess, null otherwise
* @static
*/
public static function setIsActive($id, $is_active) {
*
* @param \account|string $accountTypeCode account type code
*
- * @return integer count
+ * @return integer
+ * count
* @static
*/
public static function getARAccounts($financialAccountId, $financialAccountTypeId = NULL, $accountTypeCode = 'ar') {
* @param bool $is_active
* Value we want to set the is_active field.
*
- * @return Object DAO object on sucess, null otherwise
+ * @return Object
+ * DAO object on sucess, null otherwise
* @static
*/
public static function setIsActive($id, $is_active) {
* fetch financial type having relationship as Income Account is
*
*
- * @return array all financial type with income account is relationship
+ * @return array
+ * all financial type with income account is relationship
* @static
*/
public static function getIncomeFinancialType() {
* @param bool $is_active
* Value we want to set the is_active field.
*
- * @return Object DAO object on sucess, null otherwise
+ * @return Object
+ * DAO object on sucess, null otherwise
*
* @static
*/
*
* @param NULL
*
- * @return object The default payment processor object on success,
+ * @return object
+ * The default payment processor object on success,
* null otherwise
* @static
*/
* @param string $mode
* Payment mode ie test or live.
*
- * @return array associated array with payment processor related fields
+ * @return array
+ * associated array with payment processor related fields
* @static
*/
public static function getPayment($paymentProcessorID, $mode) {
* @param string $mode
* Payment mode ie test or live.
*
- * @return array associated array with payment processor related fields
+ * @return array
+ * associated array with payment processor related fields
* @static
*/
public static function buildPayment($dao, $mode) {
*
* @param array $ids
*
- * @return array available processors
+ * @return array
+ * available processors
*/
public static function getPaymentProcessors($capabilities = array(), $ids = array()) {
$mode = NULL;
* @param string $type
* Type of payment information to be retrieved.
*
- * @return int / array / object based on type
+ * @return int
+ * / array / object based on type
* @static
*/
public static function getProcessorForEntity($entityID, $component = 'contribute', $type = 'id') {
* @param bool $is_active
* Value we want to set the is_active field.
*
- * @return Object DAO object on sucess, null otherwise
+ * @return Object
+ * DAO object on sucess, null otherwise
*
* @static
*/
*
* @param NULL
*
- * @return object The default payment processor object on success,
+ * @return object
+ * The default payment processor object on success,
* null otherwise
* @static
*/
*
* @internal param array $fields posted values of the form
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($values, $files, $self) {
* @param $files
* @param $self
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($values, $files, $self) {
* @param int $userContactID
* @param string $actionName
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public function checkPermissions($action, $permissions, $createdID, $userContactID, $actionName) {
*
* @internal param array $fields posted values of the form
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($values, $files, $self) {
/**
* Get BAO Name
*
- * @return string Classname of BAO.
+ * @return string
+ * Classname of BAO.
*/
public function getBAOName() {
return 'CRM_Batch_BAO_Batch';
/**
* Get action Links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
*/
public function &links() {
}
/**
* Get name of edit form
*
- * @return string Classname of edit form.
+ * @return string
+ * Classname of edit form.
*/
public function editForm() {
return 'CRM_Financial_Form_FinancialBatch';
/**
* Get edit form name
*
- * @return string name of this page.
+ * @return string
+ * name of this page.
*/
public function editName() {
return ts('Accounting Batch Processing');
*
* @param null $mode
*
- * @return string user context.
+ * @return string
+ * user context.
*/
public function userContext($mode = NULL) {
return CRM_Utils_System::currentPath();
/**
* Get BAO Name
*
- * @return string Classname of BAO.
+ * @return string
+ * Classname of BAO.
*/
public function getBAOName() {
return 'CRM_Batch_BAO_Batch';
/**
* Get action Links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
*/
public function &links() {
if (!(self::$_links)) {
/**
* Get name of edit form
*
- * @return string Classname of edit form.
+ * @return string
+ * Classname of edit form.
*/
public function editForm() {
return 'CRM_Financial_Form_BatchTransaction';
/**
* Get edit form name
*
- * @return string name of this page.
+ * @return string
+ * name of this page.
*/
public function editName() {
return 'Batch';
*
* @param null $mode
*
- * @return string user context.
+ * @return string
+ * user context.
*/
public function userContext($mode = NULL) {
return 'civicrm/batchtransaction';
/**
* Get BAO Name
*
- * @return string Classname of BAO.
+ * @return string
+ * Classname of BAO.
*/
public function getBAOName() {
return 'CRM_Financial_BAO_FinancialAccount';
/**
* Get action Links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
*/
public function &links() {
if (!(self::$_links)) {
/**
* Get name of edit form
*
- * @return string Classname of edit form.
+ * @return string
+ * Classname of edit form.
*/
public function editForm() {
return 'CRM_Financial_Form_FinancialAccount';
/**
* Get edit form name
*
- * @return string name of this page.
+ * @return string
+ * name of this page.
*/
public function editName() {
return 'Financial Types';
*
* @param null $mode
*
- * @return string user context.
+ * @return string
+ * user context.
*/
public function userContext($mode = NULL) {
return 'civicrm/admin/financial/financialAccount';
/**
* Get BAO Name
*
- * @return string classname of BAO.
+ * @return string
+ * classname of BAO.
*/
public function getBAOName() {
return 'CRM_Batch_BAO_Batch';
/**
* Get action Links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
*/
public function &links() {
if (!(self::$_links)) {
/**
* Get name of edit form
*
- * @return string classname of edit form.
+ * @return string
+ * classname of edit form.
*/
public function editForm() {
return 'CRM_Financial_Form_FinancialBatch';
/**
* Get edit form name
*
- * @return string name of this page.
+ * @return string
+ * name of this page.
*/
public function editName() {
return 'Accounting Batch';
*
* @param null $mode
*
- * @return string user context.
+ * @return string
+ * user context.
*/
public function userContext($mode = NULL) {
$context = $this->get("context");
/**
* Get BAO Name
*
- * @return string Classname of BAO.
+ * @return string
+ * Classname of BAO.
*/
public function getBAOName() {
return 'CRM_Financial_BAO_FinancialType';
/**
* Get action Links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
*/
public function &links() {
if (!(self::$_links)) {
/**
* Get name of edit form
*
- * @return string Classname of edit form.
+ * @return string
+ * Classname of edit form.
*/
public function editForm() {
return 'CRM_Financial_Form_FinancialType';
/**
* Get edit form name
*
- * @return string name of this page.
+ * @return string
+ * name of this page.
*/
public function editName() {
return 'Financial Types';
*
* @param null $mode
*
- * @return string user context.
+ * @return string
+ * user context.
*/
public function userContext($mode = NULL) {
return 'civicrm/admin/financial/financialType';
/**
* Get BAO Name
*
- * @return string Classname of BAO.
+ * @return string
+ * Classname of BAO.
*/
public function getBAOName() {
return 'CRM_Financial_BAO_FinancialTypeAccount';
/**
* Get action Links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
*/
public function &links() {
if (!(self::$_links)) {
* @param array $values
* Output values of the object.
*
- * @return array $values values
+ * @return array
+ * values
* @static
*/
public static function retrieve(&$params, &$values) {
*
* @param bool $admin
*
- * @return array Array of event summary values
+ * @return array
+ * Array of event summary values
*/
public static function getGrantSummary($admin = FALSE) {
$query = "
*
* @static
*
- * @return array Array of event summary values
+ * @return array
+ * Array of event summary values
*/
public static function getGrantStatusOptGroup() {
*
* @param bool $admin
*
- * @return array Array of grant summary statistics
+ * @return array
+ * Array of grant summary statistics
*/
public static function getGrantStatistics($admin = FALSE) {
$grantStatuses = array();
/**
* Combine all the exportable fields from the lower levels object
*
- * @return array array of exportable Fields
+ * @return array
+ * array of exportable Fields
* @static
*/
public static function &exportableFields() {
*
* @param int $contactID
*
- * @return int count of grant records
+ * @return int
+ * count of grant records
* @static
*/
public static function getContactGrantCount($contactID) {
* Set the default form values
*
*
- * @return array the default array reference
+ * @return array
+ * the default array reference
*/
public function &setDefaultValues() {
return $this->_formValues;
*
* @param
*
- * @return int Total number of rows
+ * @return int
+ * Total number of rows
*/
public function getTotalCount($action) {
return $this->_query->searchQuery(0, 0, NULL,
* @param enum $output
* What should the result set include (web/email/csv).
*
- * @return int the total number of rows for this action
+ * @return int
+ * the total number of rows for this action
*/
public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
$result = $this->_query->searchQuery($offset, $rowCount, $sort,
}
/**
- * @return array $qill which contains an array of strings
+ * @return array
+ * which contains an array of strings
*/
// the current internationalisation is bad, but should more or less work
* @param enum $output
* What should the result set include (web/email/csv).
*
- * @return array the column headers that need to be displayed
+ * @return array
+ * the column headers that need to be displayed
*/
public function &getColumnHeaders($action = NULL, $output = NULL) {
if (!isset(self::$_columnHeaders)) {
* @param string $output
* Type of output.
*
- * @return string name of the file
+ * @return string
+ * name of the file
*/
public function getExportFileName($output = 'csv') {
return ts('CiviCRM Grant Search');
*
* @param string $formName
*
- * @return string the name of the form that will handle the task
+ * @return string
+ * the name of the form that will handle the task
*/
public function taskName($controller, $formName = 'Search') {
// total hack, check POST vars and then session to determine stuff
* These tasks are the core set of tasks that the user can perform
* on a contact / group of contacts
*
- * @return array the set of tasks for a group of contacts
+ * @return array
+ * the set of tasks for a group of contacts
* @static
*/
public static function &tasks() {
/**
* These tasks are the core set of task titles
*
- * @return array the set of task titles
+ * @return array
+ * the set of task titles
* @static
*/
public static function &taskTitles() {
*
* @param int $permission
*
- * @return array set of tasks that are valid for the user
+ * @return array
+ * set of tasks that are valid for the user
*/
public static function &permissionedTaskTitles($permission) {
$tasks = array();
*
* @param int $value
*
- * @return array the set of tasks for a group of contacts
+ * @return array
+ * the set of tasks for a group of contacts
* @static
*/
public static function getTask($value) {
* @param array $fileParams
* @param $options
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($fields, $fileParams, $options) {
*
* @param CRM_Core_Form $form
*
- * @return array parent groups
+ * @return array
+ * parent groups
* @static
*/
public static function buildParentGroups(&$form) {
/**
* Define action links
*
- * @return array self::$_links array of action links
+ * @return array
+ * self::$_links array of action links
*/
public function &links() {
}
* @param int $title
* Name or title of the object.
*
- * @return string the permission that the user has (or null)
+ * @return string
+ * the permission that the user has (or null)
*/
public function checkPermission($id, $title) {
return CRM_Contact_BAO_Group::checkPermission($id, $title);
/**
* Provides information about the data source
*
- * @return array collection of info about this data source
+ * @return array
+ * collection of info about this data source
*
*
*/
*
* @param CRM_Core_Form $form
*
- * @return void (operates directly on form argument)
+ * @return void
+ * (operates directly on form argument)
*/
abstract public function buildQuickForm(&$form);
/**
* Provides information about the data source
*
- * @return array collection of info about this data source
+ * @return array
+ * collection of info about this data source
*
*
*/
*
* @param CRM_Core_Form $form
*
- * @return void (operates directly on form argument)
+ * @return void
+ * (operates directly on form argument)
*/
public function buildQuickForm(&$form) {
$form->add('hidden', 'hidden_dataSource', 'CRM_Import_DataSource_CSV');
* @param string $fieldSeparator
* Character that seperates the various columns in the file.
*
- * @return string name of the created table
+ * @return string
+ * name of the created table
*/
private static function _CsvToTable(
&$db,
/**
* Provides information about the data source
*
- * @return array collection of info about this data source
+ * @return array
+ * collection of info about this data source
*
*
*/
*
* @param CRM_Core_Form $form
*
- * @return void (operates directly on form argument)
+ * @return void
+ * (operates directly on form argument)
*/
public function buildQuickForm(&$form) {
$form->add('hidden', 'hidden_dataSource', 'CRM_Import_DataSource_SQL');
/**
* Format the field values for input to the api
*
- * @return array (reference) associative array of name/value pairs
+ * @return array
+ * (reference) associative array of name/value pairs
*/
public function &getActiveFieldParams() {
$params = array();
* @param string $message
* The message to be matched.
*
- * @return array Tuple (bounce_type, bounce_reason)
+ * @return array
+ * Tuple (bounce_type, bounce_reason)
* @static
*/
public static function &match(&$message) {
* @param bool $is_active
* Value we want to set the is_active field.
*
- * @return Object DAO object on sucess, null otherwise
+ * @return Object
+ * DAO object on sucess, null otherwise
* @static
*/
public static function setIsActive($id, $is_active) {
*
* @param string $token The token for which we will be doing adata lookup
*
- * @return array $funcStruct An array that holds the token itself and the type.
+ * @return array
+ * An array that holds the token itself and the type.
* the type will tell us which function to use for the data lookup
* if we need to do a lookup at all
*/
* that the user has uploaded or declared (if they have dome that)
*
*
- * @return array reference to an assoc array
+ * @return array
+ * reference to an assoc array
*
**/
private function &getTemplates() {
* this function needs to have some sort of a body assigned
* either text or html for this to have any meaningful impact
*
- * @return array reference to an assoc array
+ * @return array
+ * reference to an assoc array
*
**/
public function &getTokens() {
* Returns the token set for all 3 parts as one set. This allows it to be sent to the
* hook in one call and standardizes it across other token workflows
*
- * @return array reference to an assoc array
+ * @return array
+ * reference to an assoc array
*
**/
public function &getFlattenedTokens() {
* @param string $email
* Destination address.
*
- * @return array (reference) array array ref that hold array refs to the verp info and urls
+ * @return array
+ * (reference) array array ref that hold array refs to the verp info and urls
*/
public static function getVerpAndUrls($job_id, $event_queue_id, $hash, $email) {
// create a skeleton object and set its properties that are required by getVerpAndUrlsAndHeaders()
*
* @param bool $isForward
*
- * @return array (reference) array array ref that hold array refs to the verp info, urls, and headers
+ * @return array
+ * (reference) array array ref that hold array refs to the verp info, urls, and headers
* @access private
*/
private function getVerpAndUrlsAndHeaders($job_id, $event_queue_id, $hash, $email, $isForward = FALSE) {
* Return a list of group names for this mailing. Does not work with
* prior-mailing targets.
*
- * @return array Names of groups receiving this mailing
+ * @return array
+ * Names of groups receiving this mailing
*/
public function &getGroupNames() {
if (!isset($this->id)) {
* @param array $params
* @param array $ids
*
- * @return object $mailing The new mailing object
+ * @return object
+ * $mailing The new mailing object
* @static
*/
public static function create(&$params, $ids = array()) {
*
* @param bool $isSMS
*
- * @return array Associative array of reporting data
+ * @return array
+ * Associative array of reporting data
* @static
*/
public static function &report($id, $skipDetails = FALSE, $isSMS = FALSE) {
*
* @param
*
- * @return int Count
+ * @return int
+ * Count
*/
public function getCount() {
$this->selectAdd();
* where the user has access to ALL groups, and hence ALL mailings and return a
* value of TRUE (to avoid the downstream where clause with a list of mailing list IDs
*
- * @return boolean | array - TRUE if the user has access to all mailings, else array of mailing IDs (possibly empty)
+ * @return boolean
+ * | array - TRUE if the user has access to all mailings, else array of mailing IDs (possibly empty)
* @static
*/
public static function mailingACLIDs() {
* @param null $additionalClause
* @param array $additionalParams
*
- * @return array The rows
+ * @return array
+ * The rows
*/
public function &getRows($offset, $rowCount, $sort, $additionalClause = NULL, $additionalParams = NULL) {
$mailing = self::getTableName();
/**
* Get the search based mailing Ids
*
- * @return array $mailingIDs, searched base mailing ids.
+ * @return array
+ * , searched base mailing ids.
*/
public function searchMailingIDs() {
$group = CRM_Mailing_DAO_MailingGroup::getTableName();
*
* @param bool $isSMS
*
- * @return array $report array content/component.
+ * @return array
+ * array content/component.
* @access public
*/
public static function getMailingContent(&$report, &$form, $isSMS = FALSE) {
* @param array $params
* Associated array for params record id.
*
- * @return array $contactActivities associated array of contact activities
+ * @return array
+ * associated array of contact activities
*/
public static function getContactMailingSelector(&$params) {
// format the params
* @param array $params
* Associated array.
*
- * @return array of mailings for a contact
+ * @return array
+ * of mailings for a contact
*
* @static
*/
* @param array $params
* Associated array.
*
- * @return int count of mailings for a contact
+ * @return int
+ * count of mailings for a contact
*
* @static
*/
* @param $params
* @param array $ids
*
- * @return object $mailingab The new mailingab object
+ * @return object
+ * $mailingab The new mailingab object
* @static
*/
public static function create(&$params, $ids = array()) {
* @param string $status
* The status enum.
*
- * @return string The translated version
+ * @return string
+ * The translated version
* @static
*/
public static function status($status) {
* Return a workflow clause for use in SQL queries,
* to only process jobs that are approved.
*
- * @return string For use in a WHERE clause
+ * @return string
+ * For use in a WHERE clause
* @static
*/
public static function workflowClause() {
* @param int $queue_id
* The queue event id (contact clicking through).
*
- * @return string $redirect The redirect/tracking url
+ * @return string
+ * The redirect/tracking url
* @static
*/
public static function getTrackerURL($url, $mailing_id, $queue_id) {
* @param bool $is_distinct
* Group by queue ID?.
*
- * @return int Number of rows in result set
+ * @return int
+ * Number of rows in result set
* @static
*/
public static function getTotalCount($mailing_id, $job_id = NULL, $is_distinct = FALSE, $toDate = NULL) {
* @param array $sort
* Sort array.
*
- * @return array Result set
+ * @return array
+ * Result set
* @static
*/
public static function &getRows(
* @param string $hash
* The hash.
*
- * @return boolean True on success
+ * @return boolean
+ * True on success
* @static
*/
public static function confirm($contact_id, $subscribe_id, $hash) {
* @param bool $is_distinct
* Group by queue ID?.
*
- * @return int Number of rows in result set
+ * @return int
+ * Number of rows in result set
* @static
*/
public static function getTotalCount($mailing_id, $job_id = NULL, $is_distinct = FALSE, $toDate = NULL) {
* @param array $sort
* Sort array.
*
- * @return array Result set
+ * @return array
+ * Result set
* @static
*/
public static function &getRows(
* @param bool $is_distinct
* Group by queue ID?.
*
- * @return int Number of rows in result set
+ * @return int
+ * Number of rows in result set
* @static
*/
public static function getTotalCount(
* @param array $sort
* Sort array.
*
- * @return array Result set
+ * @return array
+ * Result set
* @static
*/
public static function &getRows(
* @param bool $is_distinct
* Group by queue ID?.
*
- * @return int Number of rows in result set
+ * @return int
+ * Number of rows in result set
* @static
*/
public static function getTotalCount(
*
* @param $mailingIDs
*
- * @return array Opened count per mailing ID
+ * @return array
+ * Opened count per mailing ID
* @static
*/
public static function getMailingTotalCount($mailingIDs) {
* @param int $contactID
* ID of the contact.
*
- * @return array Count per mailing ID
+ * @return array
+ * Count per mailing ID
* @static
*/
public static function getMailingContactCount($mailingIDs, $contactID) {
*
* @param int $contact_id
*
- * @return array Result set
+ * @return array
+ * Result set
* @static
*/
public static function &getRows(
*
* @param array The ids to be hashed
*
- * @return int The hash
+ * @return int
+ * The hash
* @static
*/
public static function hash($params) {
* @param int $queue_id
* The queue event ID.
*
- * @return string The email address
+ * @return string
+ * The email address
* @static
*/
public static function getEmailAddress($queue_id) {
* @param int $job_id
* Optional ID of a job to limit results.
*
- * @return int Number of matching events
+ * @return int
+ * Number of matching events
* @static
*/
public static function getTotalCount($mailing_id, $job_id = NULL) {
* @param array $sort
* Sort array.
*
- * @return array Result set
+ * @return array
+ * Result set
* @static
*/
public static function &getRows(
*
* @param
*
- * @return object Mailing BAO
+ * @return object
+ * Mailing BAO
*/
public function &getMailing() {
$mailing = new CRM_Mailing_BAO_Mailing();
* @param bool $is_distinct
* Group by queue ID?.
*
- * @return int Number of rows in result set
+ * @return int
+ * Number of rows in result set
* @static
*/
public static function getTotalCount(
* @param array $sort
* Sort array.
*
- * @return array Result set
+ * @return array
+ * Result set
* @static
*/
public static function &getRows(
* @param int $subscribe_id
* ID of the subscribe event.
*
- * @return object $domain The domain owning the event
+ * @return object
+ * $domain The domain owning the event
* @static
*/
public static function &getDomain($subscribe_id) {
* @param int $contactID
* ContactID if we want an exact match.
*
- * @return array $groups array of group ids
+ * @return array
+ * array of group ids
*/
public static function getContactGroups($email, $contactID = NULL) {
if ($contactID) {
* @param int $url_id
* The ID of the trackable URL.
*
- * @return string $url The redirection url, or base url on failure.
+ * @return string
+ * The redirection url, or base url on failure.
* @static
*/
public static function track($queue_id, $url_id) {
* @param int $url_id
* Optional ID of a url to filter on.
*
- * @return int Number of rows in result set
+ * @return int
+ * Number of rows in result set
* @static
*/
public static function getTotalCount(
*
* @param $mailingIDs
*
- * @return array trackable url count per mailing ID
+ * @return array
+ * trackable url count per mailing ID
* @static
*/
public static function getMailingTotalCount($mailingIDs) {
* @param int $contactID
* ID of the contact.
*
- * @return array Count per mailing ID
+ * @return array
+ * Count per mailing ID
* @static
*/
public static function getMailingContactCount($mailingIDs, $contactID) {
* @param int $contact_id
* Optional contact ID.
*
- * @return array Result set
+ * @return array
+ * Result set
* @static
*/
public static function &getRows(
* @param string $hash
* The hash.
*
- * @return boolean Was the contact successfully unsubscribed?
+ * @return boolean
+ * Was the contact successfully unsubscribed?
* @static
*/
public static function unsub_from_domain($job_id, $queue_id, $hash) {
*
* @param null $org_unsubscribe
*
- * @return int Number of rows in result set
+ * @return int
+ * Number of rows in result set
* @static
*/
public static function getTotalCount(
* Sort array.
*
* @param null $org_unsubscribe
- * @return array Result set
+ * @return array
+ * Result set
* @static
*/
public static function &getRows(
* @param array $fields
* Posted values of the form.
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($fields) {
* @param $files
* @param $self
*
- * @return boolean True if either we deliver immediately, or the
+ * @return boolean
+ * True if either we deliver immediately, or the
* date is properly set.
* @static
*/
* @param array $self
* An current this object.
*
- * @return boolean true on successful SMTP handoff
+ * @return boolean
+ * true on successful SMTP handoff
*/
public static function testMail($testParams, $files, $self) {
$error = NULL;
* Name of the settings set from civimail_mail_settings to use (null for default).
*
* @throws Exception
- * @return object mail store implementation for processing CiviMail-bound emails
+ * @return object
+ * mail store implementation for processing CiviMail-bound emails
*/
public static function getStore($name = NULL) {
$dao = new CRM_Core_DAO_MailSettings;
/**
* Return all emails in the mail store
*
- * @return array array of ezcMail objects
+ * @return array
+ * array of ezcMail objects
*/
public function allMails() {
return $this->fetchNext(0);
* @param int $count
* Number of messages to fetch (0 to fetch all).
*
- * @return array array of ezcMail objects
+ * @return array
+ * array of ezcMail objects
*/
public function fetchNext($count = 1) {
if (isset($this->_transport->options->uidReferencing) and $this->_transport->options->uidReferencing) {
* Name of the Maildir.
*
* @throws Exception
- * @return string path to the Maildir's cur directory
+ * @return string
+ * path to the Maildir's cur directory
*/
public function maildir($name) {
$config = CRM_Core_Config::singleton();
* @param int $count
* Number of messages to fetch FIXME: ignored in CiviCRM 2.2 (assumed to be 0, i.e., fetch all).
*
- * @return array array of ezcMail objects
+ * @return array
+ * array of ezcMail objects
*/
public function fetchNext($count = 0) {
$mails = array();
* @param int $count
* Number of messages to fetch FIXME: ignored in CiviCRM 2.2 (assumed to be 0, i.e., fetch all).
*
- * @return array array of ezcMail objects
+ * @return array
+ * array of ezcMail objects
*/
public function fetchNext($count = 0) {
$mails = array();
/**
* Get BAO Name
*
- * @return string Classname of BAO.
+ * @return string
+ * Classname of BAO.
*/
public function getBAOName() {
return 'CRM_Mailing_BAO_Component';
/**
* Get action Links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
*/
public function &links() {
if (!(self::$_links)) {
/**
* Get name of edit form
*
- * @return string Classname of edit form.
+ * @return string
+ * Classname of edit form.
*/
public function editForm() {
return 'CRM_Mailing_Form_Component';
/**
* Get edit form name
*
- * @return string name of this page.
+ * @return string
+ * name of this page.
*/
public function editName() {
return 'Mailing Components';
*
* @param null $mode
*
- * @return string user context.
+ * @return string
+ * user context.
*/
public function userContext($mode = NULL) {
return CRM_Utils_System::currentPath();
/**
* Get BAO Name
*
- * @return string Classname of BAO
+ * @return string
+ * Classname of BAO
*/
public function getBAOName() {
return 'CRM_Mailing_BAO_Mailing';
*
* @param null $mode
*
- * @return string user context.
+ * @return string
+ * user context.
*/
public function userContext($mode = NULL) {
return 'civicrm/mailing/report';
* @param $type
* The type of component needed.
*
- * @return array - array reference of all mailing components
+ * @return array
+ * array reference of all mailing components
* @static
*/
public static function &component($type = NULL) {
* @param $undefined
* The value to use if no default is defined.
*
- * @return integer -The ID of the default mailing component.
+ * @return integer
+ * The ID of the default mailing component.
* @static
*/
public static function &defaultComponent($type, $undefined = NULL) {
* Get all the mailing templates
*
*
- * @return array - array reference of all mailing templates if any
+ * @return array
+ * array reference of all mailing templates if any
* @static
*/
public static function &template() {
*
* @param null $mode
*
- * @return array - array reference of all mailing templates if any
+ * @return array
+ * array reference of all mailing templates if any
* @static
*/
public static function &completed($mode = NULL) {
* @param enum $output
* What should the result set include (web/email/csv).
*
- * @return array the column headers that need to be displayed
+ * @return array
+ * the column headers that need to be displayed
*/
public function &getColumnHeaders($action = NULL, $output = NULL) {
$mailing = CRM_Mailing_BAO_Mailing::getTableName();
*
* @param
*
- * @return int Total number of rows
+ * @return int
+ * Total number of rows
*/
public function getTotalCount($action) {
$job = CRM_Mailing_BAO_MailingJob::getTableName();
* @param enum $output
* What should the result set include (web/email/csv).
*
- * @return int the total number of rows for this action
+ * @return int
+ * the total number of rows for this action
*/
public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
static $actionLinks = NULL;
* @param string $output
* Type of output.
*
- * @return string name of the file
+ * @return string
+ * name of the file
*/
public function getExportFileName($output = 'csv') {
return ts('CiviMail Mailings');
* @param enum $output
* What should the result set include (web/email/csv).
*
- * @return array the column headers that need to be displayed
+ * @return array
+ * the column headers that need to be displayed
*/
public function &getColumnHeaders($action = NULL, $output = NULL) {
$mailing = CRM_Mailing_BAO_Mailing::getTableName();
*
* @param
*
- * @return int Total number of rows
+ * @return int
+ * Total number of rows
*/
public function getTotalCount($action) {
switch ($this->_event_type) {
* @param enum $output
* What should the result set include (web/email/csv).
*
- * @return int the total number of rows for this action
+ * @return int
+ * the total number of rows for this action
*/
public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
switch ($this->_event_type) {
* @param string $output
* Type of output.
*
- * @return string name of the file
+ * @return string
+ * name of the file
*/
public function getExportFileName($output = 'csv') {}
*
* @param
*
- * @return int Total number of rows
+ * @return int
+ * Total number of rows
*/
public function getTotalCount($action) {
return $this->_query->searchQuery(0, 0, NULL,
* @param enum $output
* What should the result set include (web/email/csv).
*
- * @return int the total number of rows for this action
+ * @return int
+ * the total number of rows for this action
*/
public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
$result = $this->_query->searchQuery($offset, $rowCount, $sort,
}
/**
- * @return array $qill which contains an array of strings
+ * @return array
+ * which contains an array of strings
*/
// the current internationalisation is bad, but should more or less work
* @param enum $output
* What should the result set include (web/email/csv).
*
- * @return array the column headers that need to be displayed
+ * @return array
+ * the column headers that need to be displayed
*/
public function &getColumnHeaders($action = NULL, $output = NULL) {
if (!isset(self::$_columnHeaders)) {
* @param string $output
* Type of output.
*
- * @return string name of the file
+ * @return string
+ * name of the file
*/
public function getExportFileName($output = 'csv') {
return ts('CiviCRM Mailing Search');
* These tasks are the core set of tasks that the user can perform
* on a contact / group of contacts
*
- * @return array the set of tasks for a group of contacts
+ * @return array
+ * the set of tasks for a group of contacts
* @static
*/
public static function &tasks() {
* These tasks are the core set of task titles
* on mailing recipients
*
- * @return array the set of task titles
+ * @return array
+ * the set of task titles
* @static
*/
public static function &taskTitles() {
*
* @param int $permission
*
- * @return array set of tasks that are valid for the user
+ * @return array
+ * set of tasks that are valid for the user
*/
public static function &permissionedTaskTitles($permission) {
$task = array();
*
* @param int $value
*
- * @return array the set of tasks for a group of mailing recipients
+ * @return array
+ * the set of tasks for a group of mailing recipients
* @static
*/
public static function getTask($value) {
*
* @param int $action
*
- * @return Array array of contact_id of all related contacts.
+ * @return Array
+ * array of contact_id of all related contacts.
* @static
*/
public static function checkMembershipRelationship($membershipId, $contactId, $action = CRM_Core_Action::ADD) {
* @param int $membershipId
* Membership id of values to return.
*
- * @return array of key value pairs
+ * @return array
+ * of key value pairs
*/
public static function getStatusANDTypeValues($membershipId) {
$values = array();
* @param string $status
* Active or inactive.
*
- * @return array $actives array of memberships based on status
+ * @return array
+ * array of memberships based on status
* @static
*/
public static function activeMembers($memberships, $status = 'active') {
* Thank you page.
* @param null $isTest
*
- * @return bool Is this a separate membership payment
+ * @return bool
+ * Is this a separate membership payment
*
* @static
*/
* Contact type.
* @param bool $status
*
- * @return array array of importable Fields
+ * @return array
+ * array of importable Fields
* @static
*/
public static function &importableFields($contactType = 'Individual', $status = TRUE) {
* @param bool|int $isTest if true, membership is for a test site
* @param bool|int $isOwner if true, only retrieve membership records for owners //LCD
*
- * @return integer the number of members of type $membershipTypeId whose
+ * @return integer
+ * the number of members of type $membershipTypeId whose
* start_date is between $startDate and $endDate
*/
//LCD
*
* @param int membershipId membership id
*
- * @return int $contributionPageId contribution page id
+ * @return int
+ * $contributionPageId contribution page id
* @static
*/
public static function getContributionPageId($membershipID) {
*
* @param null $mode
*
- * @return array the list of membership fields
+ * @return array
+ * the list of membership fields
* @static
*/
public static function getMembershipFields($mode = NULL) {
* @param int $membershipId
* Membsership id.
*
- * @return boolean true if deleted false otherwise
+ * @return boolean
+ * true if deleted false otherwise
*/
public static function deleteMembershipPayment($membershipId) {
* @param int $mid
* Membership id.
*
- * @return string $status contribution status
+ * @return string
+ * contribution status
* @static
*/
public static function isSubscriptionCancelled($mid) {
* Date on which to end counting.
* @param bool|int $isTest if true, membership is for a test site
*
- * @return integer returns the number of members of type $membershipTypeId
+ * @return integer
+ * returns the number of members of type $membershipTypeId
* whose join_date is before $startDate and
* whose start_date is between $startDate and $endDate
*/
* @param int $membershipId
* Membership id.
*
- * @return integer contribution id
+ * @return integer
+ * contribution id
*/
public static function getMembershipContributionId($membershipId) {
* IMPORTANT:
* Sending renewal reminders has been migrated from this job to the Scheduled Reminders function as of 4.3.
*
- * @return array $result
+ * @return array
*/
public static function updateAllMembershipStatus() {
* @param bool $isTest
* Mode of payment.
*
- * @return array of membership type
+ * @return array
+ * of membership type
* @static
*/
public static function getContactsCancelledMembership($contactID, $isTest = FALSE) {
* @param bool $is_active
* Value we want to set the is_active field.
*
- * @return Object DAO object on sucess, null otherwise
+ * @return Object
+ * DAO object on sucess, null otherwise
* @static
*/
public static function setIsActive($id, $is_active) {
* @param bool $is_active
* Value we want to set the is_active field.
*
- * @return Object DAO object on sucess, null otherwise
+ * @return Object
+ * DAO object on sucess, null otherwise
* @static
*/
public static function setIsActive($id, $is_active) {
* @param int $numRenewTerms
* How many membership terms are being added to end date (default is 1).
*
- * @return array associated array with start date, end date and join date for the membership
+ * @return array
+ * associated array with start date, end date and join date for the membership
* @static
*/
public static function getDatesForMembershipType($membershipTypeId, $joinDate = NULL, $startDate = NULL, $endDate = NULL, $numRenewTerms = 1) {
*
* CRM-7297 Membership Upsell - Added $membershipTypeID param to facilitate calculations of dates when membership type changes
*
- * @return Array array fo the start date, end date and join date of the membership
+ * @return Array
+ * array fo the start date, end date and join date of the membership
* @static
*/
public static function getRenewalDatesForMembershipType($membershipId, $changeToday = NULL, $membershipTypeID = NULL, $numRenewTerms = 1) {
* @param int $orgID
* Id of Organization.
*
- * @return Array array of the details of membership types
+ * @return Array
+ * array of the details of membership types
* @static
*/
public static function getMembershipTypesByOrg($orgID) {
*
* @param array membership types
*
- * @return Array array of the details of membership types with Member of Contact id
+ * @return Array
+ * array of the details of membership types with Member of Contact id
* @static
*/
public static function getMemberOfContactByMemTypes($membershipTypes) {
* Funtion to retrieve organization and associated membership
* types
*
- * @return array arrays of organization and membership types
+ * @return array
+ * arrays of organization and membership types
*
* @static
*/
* the default values are retrieved from the database
*
*
- * @return array defaults
+ * @return array
+ * defaults
*/
public function setDefaultValues() {
$defaults = array();
* @param object $membership
* Object.
*
- * @return boolean true if mail was sent successfully
+ * @return boolean
+ * true if mail was sent successfully
* @static
*/
public static function emailReceipt(&$form, &$formValues, &$membership) {
* the default values are retrieved from the database
*
*
- * @return array defaults
+ * @return array
+ * defaults
*/
public function setDefaultValues() {
$defaults = array();
/**
* Get action Links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
*/
public function &links() {
if (!(self::$_links)) {
*
* @param null
*
- * @return array array of default values
+ * @return array
+ * array of default values
*/
public function setDefaultValues() {
$defaults = array();
* @param array $fields
* Posted values of the form.
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($fields) {
* @param $files
* @param $self
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($fields, $files, $self) {
/**
* Format the field values for input to the api
*
- * @return array (reference ) associative array of name/value pairs
+ * @return array
+ * (reference ) associative array of name/value pairs
*/
public function &getActiveFieldParams() {
$params = array();
* @param array $values
* The array of values belonging to this line.
*
- * @return boolean the result of this processing
+ * @return boolean
+ * the result of this processing
*/
public function preview(&$values) {
return $this->summary($values);
* @param array $values
* The array of values belonging to this line.
*
- * @return boolean the result of this processing
+ * @return boolean
+ * the result of this processing
*/
public function summary(&$values) {
$erroneousField = NULL;
* @param array $values
* The array of values belonging to this line.
*
- * @return boolean the result of this processing
+ * @return boolean
+ * the result of this processing
*/
public function import($onDuplicate, &$values) {
try {
*
* @param $formatted
*
- * @return Array formatted containing date values
+ * @return Array
+ * formatted containing date values
*
*/
public function formattedDates($calcDates, &$formatted) {
* Needs to be implemented in component's information
* class.
*
- * @return array collection of required component settings
+ * @return array
+ * collection of required component settings
*
*/
/**
/**
* Get BAO Name
*
- * @return string Classname of BAO.
+ * @return string
+ * Classname of BAO.
*/
public function getBAOName() {
return 'CRM_Member_BAO_MembershipStatus';
/**
* Get action Links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
*/
public function &links() {
if (!(self::$_links)) {
/**
* Get name of edit form
*
- * @return string Classname of edit form.
+ * @return string
+ * Classname of edit form.
*/
public function editForm() {
return 'CRM_Member_Form_MembershipStatus';
/**
* Get edit form name
*
- * @return string name of this page.
+ * @return string
+ * name of this page.
*/
public function editName() {
return 'Membership Status';
*
* @param null $mode
*
- * @return string user context.
+ * @return string
+ * user context.
*/
public function userContext($mode = NULL) {
return 'civicrm/admin/member/membershipStatus';
/**
* Get action Links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
*/
public function &links() {
if (!(self::$_links)) {
* @param bool $isCancelSupported
* @param bool $isUpdateBilling
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
* @static
*/
static function &links(
/**
* Define action links for membership types of related organization
*
- * @return array self::$_membershipTypesLinks array of action links
+ * @return array
+ * self::$_membershipTypesLinks array of action links
*/
public static function &membershipTypesLinks() {
if (!self::$_membershipTypesLinks) {
/**
* Get BAO Name
*
- * @return string Classname of BAO.
+ * @return string
+ * Classname of BAO.
*/
public function getBAOName() {
return 'CRM_Member_BAO_Membership';
* @param int $id
* @param bool $force
*
- * @return array - array reference of all membership types if any
+ * @return array
+ * array reference of all membership types if any
* @static
*/
public static function &membershipType($id = NULL, $force = FALSE) {
* @param string $column
* @param bool $force
*
- * @return array - array reference of all membership statuss if any
+ * @return array
+ * array reference of all membership statuss if any
* @static
*/
public static function &membershipStatus($id = NULL, $cond = NULL, $column = 'name', $force = FALSE, $allStatus = FALSE) {
*
* @param
*
- * @return int Total number of rows
+ * @return int
+ * Total number of rows
*/
public function getTotalCount($action) {
return $this->_query->searchQuery(0, 0, NULL,
* @param enum $output
* What should the result set include (web/email/csv).
*
- * @return int the total number of rows for this action
+ * @return int
+ * the total number of rows for this action
*/
public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
// check if we can process credit card registration
}
/**
- * @return array $qill which contains an array of strings
+ * @return array
+ * which contains an array of strings
*/
// the current internationalisation is bad, but should more or less work
* @param enum $output
* What should the result set include (web/email/csv).
*
- * @return array the column headers that need to be displayed
+ * @return array
+ * the column headers that need to be displayed
*/
public function &getColumnHeaders($action = NULL, $output = NULL) {
if (!isset(self::$_columnHeaders)) {
* @param string $output
* Type of output.
*
- * @return string name of the file
+ * @return string
+ * name of the file
*/
public function getExportFileName($output = 'csv') {
return ts('CiviCRM Member Search');
*
* @param string $formName
*
- * @return string the name of the form that will handle the task
+ * @return string
+ * the name of the form that will handle the task
*/
public function taskName($controller, $formName = 'Search') {
// total hack, check POST vars and then session to determine stuff
* These tasks are the core set of tasks that the user can perform
* on a contact / group of contacts
*
- * @return array the set of tasks for a group of contacts
+ * @return array
+ * the set of tasks for a group of contacts
* @static
*/
public static function &tasks() {
* These tasks are the core set of task titles
* on members
*
- * @return array the set of task titles
+ * @return array
+ * the set of task titles
* @static
*/
public static function &taskTitles() {
*
* @param int $permission
*
- * @return array set of tasks that are valid for the user
+ * @return array
+ * set of tasks that are valid for the user
*/
public static function &permissionedTaskTitles($permission) {
$tasks = array();
*
* @param int $value
*
- * @return array the set of tasks for a group of members
+ * @return array
+ * the set of tasks for a group of members
* @static
*/
public static function getTask($value) {
*
* @param int $contactId
*
- * @return array array of Pcp if found
+ * @return array
+ * array of Pcp if found
* @static
*/
public static function getPcpDashboardInfo($contactId) {
*
* @static
*
- * @return array $honor
+ * @return array
*/
public static function honorRoll($pcpId) {
$query = "
/**
* Get action links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
* @static
*/
public static function &pcpLinks() {
*
* @param null
*
- * @return array array of default values
+ * @return array
+ * array of default values
*/
public function setDefaultValues() {
$defaults = array();
* @param $files
* @param CRM_Core_Form $form
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($fields, $files, $form) {
/**
* Get BAO Name
*
- * @return string Classname of BAO.
+ * @return string
+ * Classname of BAO.
*/
public function getBAOName() {
return 'CRM_PCP_BAO_PCP';
/**
* Get action Links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
*/
public function &links() {
if (!(self::$_links)) {
/**
* Get name of edit form
*
- * @return string Classname of edit form.
+ * @return string
+ * Classname of edit form.
*/
public function editForm() {
return 'CRM_PCP_Form_PCP';
/**
* Get edit form name
*
- * @return string name of this page.
+ * @return string
+ * name of this page.
*/
public function editName() {
return ts('Personal Campaign Page');
*
* @param null $mode
*
- * @return string user context.
+ * @return string
+ * user context.
*/
public function userContext($mode = NULL) {
return 'civicrm/admin/pcp';
* @param array $returnProperties
* If you want to return specific fields.
*
- * @return array associated array of field values
+ * @return array
+ * associated array of field values
* @static
*/
public static function &getValues(&$params, &$values, $returnProperties = NULL) {
* @param int $honorId
* In Honor of Contact ID.
*
- * @return array return the list of pledge fields
+ * @return array
+ * return the list of pledge fields
*
* @static
*/
* @param array $params
* An assoc array of name/value pairs.
*
- * @return void.
+ * @return void
+ *
*/
public static function sendAcknowledgment(&$form, $params) {
//handle Acknowledgment.
/**
* Combine all the exportable fields from the lower levels object
*
- * @return array array of exportable Fields
+ * @return array
+ * array of exportable Fields
* @static
*/
public static function &exportableFields() {
* @param int $contactID
* Contact id.
*
- * @return array associated array of pledge id(s)
+ * @return array
+ * associated array of pledge id(s)
* @static
*/
public static function getContactPledges($contactID) {
*
* @param int $contactID
*
- * @return int count of pledge records
+ * @return int
+ * count of pledge records
* @static
*/
public static function getContactPledgeCount($contactID) {
* Find payments which can be safely canceled.
*
* @param int $pledgeID
- * @return array of int (civicrm_pledge_payment.id)
+ * @return array
+ * of int (civicrm_pledge_payment.id)
*/
public static function findCancelablePayments($pledgeID) {
$statuses = array_flip(CRM_Contribute_PseudoConstant::contributionStatus());
*
* @param int $pledgeID
* @param int $pledgeStatusID
- * @return bool do financial transactions exist for this pledge?
+ * @return bool
+ * do financial transactions exist for this pledge?
*/
public static function pledgeHasFinancialTransactions($pledgeID, $pledgeStatusID) {
if (empty($pledgeStatusID)) {
* @param int $statusID
* Pledge status id.
*
- * @return bool is it a transactional status?
+ * @return bool
+ * is it a transactional status?
*/
protected static function isTransactedStatus($statusID) {
if (!in_array($statusID, self::getNonTransactionalStatus())) {
/**
* Get array of non transactional statuses
- * @return array non transactional status ids
+ * @return array
+ * non transactional status ids
*/
protected static function getNonTransactionalStatus() {
$paymentStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
/**
* Get array of non transactional statuses
- * @return array non transactional status ids
+ * @return array
+ * non transactional status ids
*/
protected static function getTransactionalStatus() {
$paymentStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
* @param int $pledgeId
* Pledge id.
*
- * @return array associated array of pledge payment details
+ * @return array
+ * associated array of pledge payment details
* @static
*/
public static function getPledgePayments($pledgeId) {
*
* @param int $id
*
- * @return int pledge payment id
+ * @return int
+ * pledge payment id
* @static
*/
public static function del($id) {
* @param bool $isScriptUpdate
* , is function being called from bin script?.
*
- * @return int $newStatus, updated status id (or 0)
+ * @return int
+ * $newStatus, updated status id (or 0)
*/
static function updatePledgePaymentStatus(
$pledgeID,
*
* @param array $params
*
- * @return array $newdate Next scheduled date as an array
+ * @return array
+ * Next scheduled date as an array
* @static
*/
public static function calculateBaseScheduleDate(&$params) {
* @param int $pledgeId
* Pledge id.
*
- * @return int $statusId calculated status id of pledge
+ * @return int
+ * $statusId calculated status id of pledge
* @static
*/
public static function calculatePledgeStatus($pledgeId) {
*
* @param int $limit
*
- * @return array associated array of pledge details
+ * @return array
+ * associated array of pledge details
* @static
*/
public static function getOldestPledgePayment($pledgeID, $limit = 1) {
* Set the default form values
*
*
- * @return array the default array reference
+ * @return array
+ * the default array reference
*/
public function setDefaultValues() {
$defaults = array();
* Needs to be implemented in component's information
* class.
*
- * @return array collection of required component settings
+ * @return array
+ * collection of required component settings
*/
public function getInfo() {
return array(
*
* @param
*
- * @return int Total number of rows
+ * @return int
+ * Total number of rows
*/
public function getTotalCount($action) {
return $this->_query->searchQuery(0, 0, NULL,
* @param enum $output
* What should the result set include (web/email/csv).
*
- * @return int the total number of rows for this action
+ * @return int
+ * the total number of rows for this action
*/
public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
$result = $this->_query->searchQuery($offset, $rowCount, $sort,
}
/**
- * @return array $qill which contains an array of strings
+ * @return array
+ * which contains an array of strings
*/
// the current internationalisation is bad, but should more or less work
* @param enum $output
* What should the result set include (web/email/csv).
*
- * @return array the column headers that need to be displayed
+ * @return array
+ * the column headers that need to be displayed
*/
public function &getColumnHeaders($action = NULL, $output = NULL) {
if (!isset(self::$_columnHeaders)) {
* @param string $output
* Type of output.
*
- * @return string name of the file
+ * @return string
+ * name of the file
*/
public function getExportFileName($output = 'csv') {
return ts('Pledge Search');
*
* @param string $formName
*
- * @return string the name of the form that will handle the task
+ * @return string
+ * the name of the form that will handle the task
*/
public function taskName($controller, $formName = 'Search') {
// total hack, check POST vars and then session to determine stuff
* These tasks are the core set of tasks that the user can perform
* on a contact / group of contacts
*
- * @return array the set of tasks for a group of contacts
+ * @return array
+ * the set of tasks for a group of contacts
* @static
*/
public static function &tasks() {
/**
* These tasks are the core set of task titles
*
- * @return array the set of task titles
+ * @return array
+ * the set of task titles
* @static
*/
public static function &taskTitles() {
/**
* These tasks get added based on the context the user is in
*
- * @return array the set of optional tasks for a group of contacts
+ * @return array
+ * the set of optional tasks for a group of contacts
* @static
*/
public static function &optionalTaskTitle() {
*
* @param int $permission
*
- * @return array set of tasks that are valid for the user
+ * @return array
+ * set of tasks that are valid for the user
*/
public static function &permissionedTaskTitles($permission) {
$tasks = array();
*
* @param int $value
*
- * @return array the set of tasks for a group of pledge holders
+ * @return array
+ * the set of tasks for a group of pledge holders
* @static
*/
public static function getTask($value) {
* this function precedes the convenience of the contribution id but since it does quite a bit more than just a db retrieval we need to be able to use it even
* when we don't want it's entity-id magix
*
- * @return array of line items
+ * @return array
+ * of line items
*/
public static function getLineItems($entityId, $entity = 'participant', $isQuick = NULL, $isQtyZero = TRUE, $relatedEntity = FALSE, $overrideWhereClause = '') {
$whereClause = $fromClause = NULL;
* @param bool $is_active
* Value we want to set the is_active field.
*
- * @return Object DAO object on sucess, null otherwise
+ * @return Object
+ * DAO object on sucess, null otherwise
*
* @static
*/
* @param int $id
* Id of field.
*
- * @return string name
+ * @return string
+ * name
*
* @static
*
* @param bool $reset
* Ignore stored values\.
*
- * @return array array of options
+ * @return array
+ * array of options
*/
public static function getOptions($fieldId, $inactiveNeeded = FALSE, $reset = FALSE) {
static $options = array();
* @param string $displayOpt
* Tax display setting option.
*
- * @return string $label tax label for custom field
+ * @return string
+ * tax label for custom field
*
* @static
*
* For order by, default weight.
* @param bool|int $isActive is_active, default false
*
- * @return array $values
+ * @return array
*
* @static
*/
* @param int $id
* Id of field option.
*
- * @return string name
+ * @return string
+ * name
*
* @static
*
* @param bool $is_active
* Value we want to set the is_active field.
*
- * @return Object DAO object on sucess, null otherwise
+ * @return Object
+ * DAO object on sucess, null otherwise
*
* @static
*/
*
* @internal param bool $is_active value we want to set the is_active field
*
- * @return Object DAO object on sucess, null otherwise
+ * @return Object
+ * DAO object on sucess, null otherwise
* @static
*/
public static function setIsActive($id, $isActive) {
*
* @param string $entity
*
- * @return array $defaultPriceSet default price set
+ * @return array
+ * default price set
*
* @static
*
* @param int $id
* Id of price set.
*
- * @return string title
+ * @return string
+ * title
*
* @static
*
* @param int $id
* Price Set id.
*
- * @return boolean false if fields exist for this set, true if the
+ * @return boolean
+ * false if fields exist for this set, true if the
* set could be deleted
*
* @static
* Whether or not to include inactive entries.
* @param bool|string $extendComponentName name of the component like 'CiviEvent','CiviContribute'
*
- * @return array associative array of id => name
+ * @return array
+ * associative array of id => name
*/
public static function getAssoc($withInactive = FALSE, $extendComponentName = FALSE) {
$query = '
*
* @internal param int $setId - price set id whose details are needed
*
- * @return array $setTree - array consisting of field details
+ * @return array
+ * array consisting of field details
*/
public static function getSetDetail($setID, $required = TRUE, $validOnly = FALSE) {
// create a new tree
* @param CRM_Core_Form $form
* @param $defaults
*
- * @return array $defaults
+ * @return array
*/
public static function setDefaultPriceSet(&$form, &$defaults) {
if (!isset($form->_priceSet) || empty($form->_priceSet['fields'])) {
* @param int $id
* Price Set id.
*
- * @return array of the field ids
+ * @return array
+ * of the field ids
*
* @static
*/
* @param int $priceSetId
* Price set id.
*
- * @return int $autoRenewOption ( 0:hide, 1:optional 2:required )
+ * @return int
+ * $autoRenewOption ( 0:hide, 1:optional 2:required )
*/
public static function checkAutoRenewForPriceSet($priceSetId) {
// auto-renew option should be visible if membership types associated with all the fields has
* @param int $priceSetId
* Price set id.
*
- * @return array associate array of frequency interval and unit
+ * @return array
+ * associate array of frequency interval and unit
* @static
*/
public static function getRecurDetails($priceSetId) {
* @param bool $isQuickConfigValue we want to set the is_quick_config field.
* Value we want to set the is_quick_config field.
*
- * @return Object DAO object on sucess, null otherwise
+ * @return Object
+ * DAO object on sucess, null otherwise
* @static
*/
public static function setIsQuickConfig($id, $isQuickConfig) {
*
* @param null
*
- * @return array array of default values
+ * @return array
+ * array of default values
*/
public function setDefaultValues() {
$defaults = array();
* @param $files
* @param CRM_Core_Form $form
*
- * @return array if errors then list of errors to be posted back to the form,
+ * @return array
+ * if errors then list of errors to be posted back to the form,
* true otherwise
* @static
*/
*
* @param null
*
- * @return array array of default values
+ * @return array
+ * array of default values
*/
public function setDefaultValues() {
if ($this->_action == CRM_Core_Action::DELETE) {
* @param $files
* @param CRM_Core_Form $form
*
- * @return array if errors then list of errors to be posted back to the form,
+ * @return array
+ * if errors then list of errors to be posted back to the form,
* true otherwise
* @static
*/
*
* @param null
*
- * @return array the default array reference
+ * @return array
+ * the default array reference
*/
public function setDefaultValues() {
$defaults = array();
*
* @param null
*
- * @return array array of default values
+ * @return array
+ * array of default values
*/
public function setDefaultValues() {
$defaults = array('is_active' => TRUE);
*
* @param null
*
- * @return array array of action links that we need to display for the browse screen
+ * @return array
+ * array of action links that we need to display for the browse screen
*/
function &actionLinks() {
if (!isset(self::$_actionLinks)) {
*
* @param null
*
- * @return array array of action links that we need to display for the browse screen
+ * @return array
+ * array of action links that we need to display for the browse screen
*/
function &actionLinks() {
if (!isset(self::$_actionLinks)) {
*
* @param null
*
- * @return array array of action links that we need to display for the browse screen
+ * @return array
+ * array of action links that we need to display for the browse screen
*/
function &actionLinks() {
// check if variable _actionsLinks is populated
* This is a first version and will be tweaked over a period of time
*
*
- * @return boolean true if no error found
+ * @return boolean
+ * true if no error found
*/
public function validate() {
$errors = parent::validate();
* Set the default form values
*
*
- * @return array the default array reference
+ * @return array
+ * the default array reference
*/
public function setDefaultValues() {
$defaults = array();
/**
* Get the action links for this page.
*
- * @return array $_actionLinks
+ * @return array
*
*/
public function &actionLinks() {
/**
* Get BAO Name
*
- * @return string Classname of BAO.
+ * @return string
+ * Classname of BAO.
*/
public function getBAOName() {
return '';
/**
* Get action Links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
*/
public function &links() {
if (!(self::$_links[$this->_pageViewType])) {
/**
* Get name of edit form
*
- * @return string classname of edit form
+ * @return string
+ * classname of edit form
*/
public function editForm() {
return '';
/**
* Get edit form name
*
- * @return string name of this page
+ * @return string
+ * name of this page
*/
public function editName() {
return '';
*
* @param null $mode
*
- * @return string user context
+ * @return string
+ * user context
*/
public function userContext($mode = NULL) {
return '';
* @param enum $output
* What should the result set include (web/email/csv).
*
- * @return array the column headers that need to be displayed
+ * @return array
+ * the column headers that need to be displayed
*/
public function &getColumnHeaders($action = NULL, $output = NULL) {
static $skipFields = array('group', 'tag');
*
* @param
*
- * @return int Total number of rows
+ * @return int
+ * Total number of rows
*/
public function getTotalCount($action) {
$additionalWhereClause = 'contact_a.is_deleted = 0';
* @param enum $output
* What should the result set include (web/email/csv).
*
- * @return int the total number of rows for this action
+ * @return int
+ * the total number of rows for this action
*/
public function &getRows($action, $offset, $rowCount, $sort, $output = NULL, $extraWhereClause = NULL) {
* @param string $output
* Type of output.
*
- * @return string name of the file
+ * @return string
+ * name of the file
*/
public function getExportFileName($output = 'csv') {
return ts('CiviCRM Profile Listings');
/**
* Ensure that the required SQL table exists
*
- * @return bool TRUE if table now exists
+ * @return bool
+ * TRUE if table now exists
*/
public static function findCreateTable() {
$checkTableSql = "show tables like 'civicrm_queue_item'";
* @param int $lease_time
* Seconds.
*
- * @return object with key 'data' that matches the inputted data
+ * @return object
+ * with key 'data' that matches the inputted data
*/
public abstract function claimItem($lease_time = 3600);
* @param int $lease_time
* Seconds.
*
- * @return object with key 'data' that matches the inputted data
+ * @return object
+ * with key 'data' that matches the inputted data
*/
public abstract function stealItem($lease_time = 3600);
/**
* Get or build the list of search objects (via hook)
*
- * @return array of CRM_Report_BAO_Hook_Interface objects
+ * @return array
+ * of CRM_Report_BAO_Hook_Interface objects
*/
public function getSearchQueryObjects() {
if ($this->_queryObjects === NULL) {
/**
* Getter for $_defaultValues
- * @return array $_defaultValues
+ * @return array
*/
public function getDefaultValues() {
return $this->_defaults;
* Fetch array of DAO tables having columns included in SELECT or ORDER BY clause
* (building the array if it's unset)
*
- * @return Array $this->_selectedTables
+ * @return Array
+ * >_selectedTables
*/
public function selectedTables() {
if (!$this->_selectedTables) {
* @param bool $filters
* @param array $defaults
*
- * @return array address fields for construct clause
+ * @return array
+ * address fields for construct clause
*/
public function addAddressFields($groupBy = TRUE, $orderBy = FALSE, $filters = TRUE, $defaults = array('country_id' => TRUE)) {
$addressFields = array(
* - prefix Prefix to add to table (in case of more than one instance of the table)
* - prefix_label Label to give columns from this phone table instance
*
- * @return array phone columns definition
+ * @return array
+ * phone columns definition
*/
public function getPhoneColumns($options = array()) {
$defaultOptions = array(
* - prefix Prefix to add to table (in case of more than one instance of the table)
* - prefix_label Label to give columns from this address table instance
*
- * @return array address columns definition
+ * @return array
+ * address columns definition
*/
public function getAddressColumns($options = array()) {
$options += array(
}
/** adding address fields with dbAlias for order clause
- * @return array address fields
+ * @return array
+ * address fields
*/
public function addressFields($orderBy = FALSE) {
$address = parent::addAddressFields(FALSE, TRUE);
* - order_by enable these fields for order by
* - filters enable these fields for filtering
* - defaults - (is this working?) values to pre-populate
- * @return array address fields for construct clause
+ * @return array
+ * address fields for construct clause
*/
/**
* Get address columns to add to array
* - prefix Prefix to add to table (in case of more than one instance of the table)
* - prefix_label Label to give columns from this address table instance
*
- * @return array address columns definition
+ * @return array
+ * address columns definition
*/
/**
* @param array $options
*
* access public
*
- * @return array reference to the array of default values
+ * @return array
+ * reference to the array of default values
*
*/
/**
* Needs to be implemented in component's information
* class.
*
- * @return array collection of required component settings
+ * @return array
+ * collection of required component settings
*
*/
/**
* Retrieves report instances, optionally filtered by parent report template ($ovID)
* or by component ($compID)
*
- * @return array $rows
+ * @return array
* @static
*/
public function &info() {
/**
* Get BAO Name
*
- * @return string Classname of BAO.
+ * @return string
+ * Classname of BAO.
*/
public function getBAOName() {
return 'CRM_Core_BAO_OptionValue';
/**
* Get action Links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
*/
public function &links() {
if (!(self::$_links)) {
/**
* Get name of edit form
*
- * @return string Classname of edit form.
+ * @return string
+ * Classname of edit form.
*/
public function editForm() {
return 'CRM_Report_Form_Register';
/**
* Get edit form name
*
- * @return string name of this page.
+ * @return string
+ * name of this page.
*/
public function editName() {
return self::$_GName;
*
* @param null $mode
*
- * @return string user context.
+ * @return string
+ * user context.
*/
public function userContext($mode = NULL) {
return 'civicrm/report/options/' . self::$_gName;
*
* @param int $instanceId
*
- * @return boolean true if yes, else false
+ * @return boolean
+ * true if yes, else false
* @static
*/
public static function isInstanceGroupRoleAllowed($instanceId) {
* @param array $params
* All effective report criteria, as in CRM_Report_Form::_params.
*
- * @return string URL query string
+ * @return string
+ * URL query string
*/
public static function getPreviewCriteriaQueryParams($defaults = array(), $params = array()) {
static $query_string;
* @param array $fields
* Posted values of the form.
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($fields) {
*
* access public
*
- * @return array reference to the array of default values
+ * @return array
+ * reference to the array of default values
*
*/
/**
* @param $files
* @param $self
*
- * @return boolean True if either we deliver immediately, or the
+ * @return boolean
+ * True if either we deliver immediately, or the
* date is properly set.
* @static
*/
/**
* Get BAO Name
*
- * @return string Classname of BAO.
+ * @return string
+ * Classname of BAO.
*/
public function getBAOName() {
return 'CRM_SMS_BAO_Provider';
/**
* Get action Links
*
- * @return array (reference) of action links
+ * @return array
+ * (reference) of action links
*/
public function &links() {
if (!(self::$_links)) {
/**
* Get name of edit form
*
- * @return string Classname of edit form.
+ * @return string
+ * Classname of edit form.
*/
public function editForm() {
return 'CRM_SMS_Form_Provider';
/**
* Get edit form name
*
- * @return string name of this page.
+ * @return string
+ * name of this page.
*/
public function editName() {
return 'SMS Provider';
*
* @param null $mode
*
- * @return string user context.
+ * @return string
+ * user context.
*/
public function userContext($mode = NULL) {
return 'civicrm/admin/sms/provider';
* Set the default form values
*
*
- * @return array the default array reference
+ * @return array
+ * the default array reference
*/
public function setDefaultValues() {
$defaults = array();
*
* @param array $errors
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRuleSubType($fieldType, $groupType, $errors) {
* @param array $errors
* Collect errors.
*
- * @return Array list of errors to be posted back to the form
+ * @return Array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRuleCustomDataExtentColumnValue($customField, $gid, $fieldType, &$errors) {
* @param $files
* @param $self
*
- * @return array list of errors to be posted back to the form
+ * @return array
+ * list of errors to be posted back to the form
* @static
*/
public static function formRule($fields, $files, $self) {
/**
* Get the action links for this page.
*
- * @return array $_actionLinks
+ * @return array
*
*/
function &actionLinks() {
*
* @param
*
- * @return array $_actionLinks
+ * @return array
*
*/
public function &actionLinks() {
* A string to use in section headers.
* @param array $availableFields
* List of fields that are allowed in profiles, e.g. $availableFields['my_field']['field_type'].
- * @return array with keys 'sections' and 'schema'
+ * @return array
+ * with keys 'sections' and 'schema'
* @see js/model/crm.core.js
* @see js/model/crm.mappedcore.js
*/
*
* @param CRM_Queue_TaskContext $ctx
*
- * @return bool TRUE for success
+ * @return bool
+ * TRUE for success
*/
public static function addNameFieldOptions(CRM_Queue_TaskContext $ctx) {
$query = "SELECT `value` FROM `civicrm_setting` WHERE `group_name` = 'CiviCRM Preferences' AND `name` = 'contact_edit_options'";
*
* @param CRM_Queue_TaskContext $ctx
*
- * @return bool TRUE for success
+ * @return bool
+ * TRUE for success
*/
public static function migrateHonoreeInfo(CRM_Queue_TaskContext $ctx) {
$query = "ALTER TABLE `civicrm_uf_join`
*
* @param CRM_Queue_TaskContext $ctx
*
- * @return bool TRUE for success
+ * @return bool
+ * TRUE for success
*/
public static function activityContacts(CRM_Queue_TaskContext $ctx) {
$upgrade = new CRM_Upgrade_Form();
*
* @param CRM_Queue_TaskContext $ctx
*
- * @return bool TRUE for success
+ * @return bool
+ * TRUE for success
* @see http://issues.civicrm.org/jira/browse/CRM-13187
*/
public static function wordReplacements(CRM_Queue_TaskContext $ctx) {
* @param CRM_Queue_TaskContext $ctx
* @param $rev
*
- * @return bool TRUE for success
+ * @return bool
+ * TRUE for success
* @see http://issues.civicrm.org/jira/browse/CRM-13655
*/
public static function wordReplacements_patch(CRM_Queue_TaskContext $ctx, $rev) {
*
* @param bool $rebuildEach
* Whether to perform rebuild after each individual API call.
- * @return array Each item is $params for WordReplacement.create
+ * @return array
+ * Each item is $params for WordReplacement.create
* @see CRM_Core_BAO_WordReplacement::convertConfigArraysToAPIParams
*/
public static function getConfigArraysAsAPIParams($rebuildEach) {
/**
* @param array $params
- * @return bool TRUE if $params is valid
+ * @return bool
+ * TRUE if $params is valid
*/
public static function isValidWordReplacement($params) {
$result = strlen($params['find_word']) <= self::MAX_WORD_REPLACEMENT_SIZE && strlen($params['replace_word']) <= self::MAX_WORD_REPLACEMENT_SIZE;
*
* @param CRM_Queue_TaskContext $ctx
*
- * @return bool TRUE for success
+ * @return bool
+ * TRUE for success
*/
public function task_4_3_x_checkConstraints(CRM_Queue_TaskContext $ctx) {
CRM_Core_DAO::executeQuery('ALTER TABLE `civicrm_financial_account` CHANGE `contact_id` `contact_id` INT( 10 ) UNSIGNED NULL DEFAULT NULL');
*
* @param CRM_Queue_TaskContext $ctx
*
- * @return bool TRUE for success
+ * @return bool
+ * TRUE for success
*/
public function task_4_3_x_checkIndexes(CRM_Queue_TaskContext $ctx) {
$query = "
*
* @param CRM_Queue_TaskContext $ctx
*
- * @return bool TRUE for success
+ * @return bool
+ * TRUE for success
*/
public static function phoneNumeric(CRM_Queue_TaskContext $ctx) {
CRM_Core_DAO::executeQuery(CRM_Contact_BAO_Contact::DROP_STRIP_FUNCTION_43);
* @param bool $is_active
* Value we want to set the is_active field.
*
- * @return Object DAO object on sucess, null otherwise
+ * @return Object
+ * DAO object on sucess, null otherwise
*
* @static
*/
* @param int $id
* Id of field.
*
- * @return string name
+ * @return string
+ * name
*
* @static
*
* @param bool $reset
* Ignore stored values\.
*
- * @return array array of options
+ * @return array
+ * array of options
*/
public static function getOptions($fieldId, $inactiveNeeded = FALSE, $reset = FALSE) {
static $options = array();
* For order by, default weight.
* @param bool|int $isActive is_active, default false
*
- * @return array $values
+ * @return array
*
* @static
*/
* @param int $id
* Id of field option.
*
- * @return string name
+ * @return string
+ * name
*
* @static
*
* @param bool $is_active
* Value we want to set the is_active field.
*
- * @return Object DAO object on sucess, null otherwise
+ * @return Object
+ * DAO object on sucess, null otherwise
*
* @static
*/
*
* @param null $isQuick
*
- * @return array of line items
+ * @return array
+ * of line items
*/
public static function getLineItems($entityId, $entity = 'participant', $isQuick = NULL) {
$selectClause = $whereClause = $fromClause = NULL;
* @param bool $isActive
* Value we want to set the is_active field.
*
- * @return Object DAO object on sucess, null otherwise
+ * @return Object
+ * DAO object on sucess, null otherwise
* @static
*/
public static function setIsActive($id, $isActive) {
* @param int $id
* Id of price set.
*
- * @return string title
+ * @return string
+ * title
*
* @static
*
* @param int $id
* Price Set id.
*
- * @return boolean false if fields exist for this set, true if the
+ * @return boolean
+ * false if fields exist for this set, true if the
* set could be deleted
*
* @static
* Whether or not to include inactive entries.
* @param bool|string $extendComponentName name of the component like 'CiviEvent','CiviContribute'
*
- * @return array associative array of id => name
+ * @return array
+ * associative array of id => name
*/
public static function getAssoc($withInactive = FALSE, $extendComponentName = FALSE) {
$query = "
* @param bool $required
* @param bool $validOnly
*
- * @return array $setTree - array consisting of field details
+ * @return array
+ * array consisting of field details
*/
public static function getSetDetail($setID, $required = TRUE, $validOnly = FALSE) {
// create a new tree
* @param CRM_Core_Form $form
* @param $defaults
*
- * @return array $defaults
+ * @return array
*/
static function setDefaultPriceSet(&$form, &$defaults) {
if (!isset($form->_priceSet) || empty($form->_priceSet['fields'])) {
*
* @param int id Price Set id
*
- * @return array of the field ids
+ * @return array
+ * of the field ids
*
* @static
*/
* @param int $priceSetId
* Price set id.
*
- * @return int $autoRenewOption ( 0:hide, 1:optional 2:required )
+ * @return int
+ * $autoRenewOption ( 0:hide, 1:optional 2:required )
*/
public static function checkAutoRenewForPriceSet($priceSetId) {
// auto-renew option should be visible if membership types associated with all the fields has
* @param int $priceSetId
* Price set id.
*
- * @return array associate array of frequency interval and unit
+ * @return array
+ * associate array of frequency interval and unit
* @static
*/
public static function getRecurDetails($priceSetId) {
* @param bool $isQuickConfigValue we want to set the is_quick_config field.
* Value we want to set the is_quick_config field.
*
- * @return Object DAO object on sucess, null otherwise
+ * @return Object
+ * DAO object on sucess, null otherwise
* @static
*/
public static function setIsQuickConfig($id, $isQuickConfig) {
/**
* returns an array containing the enum fields of the civicrm_price_field table
*
- * @return array (reference) the array of enum fields
+ * @return array
+ * (reference) the array of enum fields
*/
static function &getEnums()
{
* @param string $value
* The enum value up for translation.
*
- * @return string the display value of the enum
+ * @return string
+ * the display value of the enum
*/
public static function tsEnum($field, $value)
{
/**
* @param string $fldName
- * @return bool TRUE if encoding should be skipped for this field
+ * @return bool
+ * TRUE if encoding should be skipped for this field
*/
public function isSkippedField($fldName) {
$skipFields = $this->getSkipFields();
* @param array $createParams
* @param array $keys
* @param bool $isMandatory
- * @return array revised $createParams, including 'id' if known
+ * @return array
+ * revised $createParams, including 'id' if known
* @throws API_Exception
*/
public function match($entity, $createParams, $keys, $isMandatory) {
* @param array $keys
* List of keys to match against.
*
- * @return array APIv3 $params
+ * @return array
+ * APIv3 $params
*/
public function createGetParams($origParams, $keys) {
$params = array('version' => 3);
*
* @param null $tokenFields
*
- * @return string formatted address string
+ * @return string
+ * formatted address string
*
* @static
*/
/**
* @param $subset
* @param $superset
- * @return bool TRUE if $subset is a subset of $superset
+ * @return bool
+ * TRUE if $subset is a subset of $superset
*/
public static function isSubset($subset, $superset) {
foreach ($subset as $expected) {
* We might even expose the results of these checks on the Wordpress
* plugin status page or the Drupal admin/reports/status path.
*
- * @return array of messages
+ * @return array
+ * of messages
* @link https://api.drupal.org/api/drupal/modules%21system%21system.api.php/function/hook_requirements
*/
public function checkAll() {
* is browseable or visible to search engines; it means it can be
* requested directly.
*
- * @return array of messages
+ * @return array
+ * of messages
* @see CRM-14091
*/
public function checkLogFileIsNotAccessible() {
* Being retrievable doesn't mean the files are browseable or visible
* to search engines; it only means they can be requested directly.
*
- * @return array of messages
+ * @return array
+ * of messages
* @see CRM-14091
*
* @TODO: Test with WordPress, Joomla.
* MAY trigger false positives (if you have files named 'a', 'e'
* we'll probably match that).
*
- * @return array of messages
+ * @return array
+ * of messages
* @see CRM-14091
*
* @TODO: Test with WordPress, Joomla.
*
* @param string $targetDir
* Local path to a directory.
- * @return string a guessed URL for $realDir
+ * @return string
+ * a guessed URL for $realDir
*/
public function guessUrl($targetDir) {
$filePathMarker = $this->getFilePathMarker();
* The seperator to use when formatting the date.
* @param int|string $invalidDate what to return if the date is invalid
*
- * @return string - formatted string for date
+ * @return string
+ * formatted string for date
*
* @static
*/
/**
* Return abbreviated weekday names according to the locale
*
- * @return array 0-based array with abbreviated weekday names
+ * @return array
+ * 0-based array with abbreviated weekday names
*
* @static
*/
/**
* Return full weekday names according to the locale
*
- * @return array 0-based array with full weekday names
+ * @return array
+ * 0-based array with full weekday names
*
* @static
*/
*
* @param bool $month
*
- * @return array 1-based array with abbreviated month names
+ * @return array
+ * 1-based array with abbreviated month names
*
* @static
*/
/**
* Return full month names according to the locale
*
- * @return array 1-based array with full month names
+ * @return array
+ * 1-based array with full month names
*
* @static
*/
* @param array $dateParts
* An array with the desired date parts.
*
- * @return string the $format-formatted $date
+ * @return string
+ * the $format-formatted $date
* @static
*/
public static function customFormat($dateString, $format = NULL, $dateParts = NULL) {
* @param string $mysql
* Date/datetime in MySQL format.
*
- * @return string date/datetime in ISO format
+ * @return string
+ * date/datetime in ISO format
* @static
*/
public static function mysqlToIso($mysql) {
* @param string $iso
* Date/datetime in ISO format.
*
- * @return string date/datetime in MySQL format
+ * @return string
+ * date/datetime in MySQL format
* @static
*/
public static function isoToMysql($iso) {
* Expected date format( default.
* format is 2007-12-21 )
*
- * @return string Return the customized todays date (Y-m-d)
+ * @return string
+ * Return the customized todays date (Y-m-d)
* @static
*/
public static function getToday($dayParams = NULL, $format = "Y-m-d") {
* @param $from
* @param $to
*
- * @return array start date, end date
+ * @return array
+ * start date, end date
* @static
*/
public static function getFromTo($relative, $from, $to) {
* @param date $birthDate
* Birth Date.
*
- * @return int array $results contains years or months
+ * @return int
+ * array $results contains years or months
* @static
*/
static public function calculateAge($birthDate) {
*
* @param bool $dontCareTime
*
- * @return array $result contains new date with added interval
+ * @return array
+ * contains new date with added interval
*/
public static function intervalAdd($unit, $interval, $date, $dontCareTime = FALSE) {
if (is_array($date)) {
* @param int $unit
* Frequency unit like year, month, week etc.
*
- * @return array $dateRange start date and end date for the relative time frame
+ * @return array
+ * start date and end date for the relative time frame
* @static
*/
public static function relativeToAbsolute($relativeTerm, $unit) {
* @param int $fyMonth
* Fiscal Start Month.
*
- * @return int $fy Current Fiscl Year
+ * @return int
+ * $fy Current Fiscl Year
* @static
*/
public static function calculateFiscalYear($fyDate, $fyMonth) {
* @param string $format
* Expected return date format.( default is mysql ).
*
- * @return string $mysqlDate date format that is excepted by mysql
+ * @return string
+ * date format that is excepted by mysql
*/
public static function processDate($date, $time = NULL, $returnNullString = FALSE, $format = 'YmdHis') {
$mysqlDate = NULL;
* @param null $format
* @param null $timeFormat
*
- * @return array $date and time
+ * @return array
+ * and time
*/
public static function setDateDefaults($mysqlDate = NULL, $formatType = NULL, $format = NULL, $timeFormat = NULL) {
// if date is not passed assume it as today
* @param string $formatType
* Date name e.g. birth.
*
- * @return string $format
+ * @return string
*/
public static function getDateFormat($formatType = NULL) {
$format = NULL;
*
* @param <type> $params
*
- * @return array <type>
+ * @return array
+ * <type>
*/
function _civicrm_api3_deprecated_duplicate_formatted_contact($params) {
$id = CRM_Utils_Array::value('id', $params);
* @param string $csType
* Contact subtype if exists/passed.
*
- * @return null on success, error message otherwise
+ * @return null
+ * on success, error message otherwise
*/
function _civicrm_api3_deprecated_contact_check_custom_params($params, $csType = NULL) {
empty($csType) ? $onlyParent = TRUE : $onlyParent = FALSE;
* @param $result
* @param int $activityTypeID
*
- * @return array <type> $params
+ * @return array
+ * <type> $params
*/
function _civicrm_api3_deprecated_activity_buildmailparams($result, $activityTypeID) {
// get ready for collecting data about activity to be created
* @param string $name
* Name of file.
*
- * @return boolean true if file is ascii
+ * @return boolean
+ * true if file is ascii
*/
public static function isAscii($name) {
$fd = fopen($name, "r");
* @param string $name
* Name of file.
*
- * @return boolean true if file is html
+ * @return boolean
+ * true if file is html
*/
public static function isHtml($name) {
$fd = fopen($name, "r");
* @param string $name
* Name of file.
*
- * @return boolean whether the file was recoded properly
+ * @return boolean
+ * whether the file was recoded properly
*/
public static function toUtf8($name) {
static $config = NULL;
* @param string $name
* Name of file.
*
- * @return boolean whether the file can be include()d or require()d
+ * @return boolean
+ * whether the file can be include()d or require()d
*/
public static function isIncludable($name) {
$x = @fopen($name, 'r', TRUE);
* The new location of the directory.
* @param bool $verbose
*
- * @return bool TRUE on success
+ * @return bool
+ * TRUE on success
*/
public static function replaceDir($fromDir, $toDir, $verbose = FALSE) {
if (is_dir($toDir)) {
* @param array $values
* @param bool $stateName
*
- * @return boolean true if we modified the address, false otherwise
+ * @return boolean
+ * true if we modified the address, false otherwise
* @static
*/
public static function format(&$values, $stateName = FALSE) {
* @param bool $stateName
* This parameter currently has no function.
*
- * @return boolean true if we modified the address, false otherwise
+ * @return boolean
+ * true if we modified the address, false otherwise
* @static
*/
public static function format(&$values, $stateName = FALSE) {
/**
* @param array $new
* The new, incoming frame.
- * @return array frame
+ * @return array
+ * frame
*/
public function createBackup($new) {
$frame = array();
* @param array $params
* The parameters used for object creation / editing.
*
- * @return null the return value is ignored
+ * @return null
+ * the return value is ignored
*/
public static function pre($op, $objectName, $id, &$params) {
$event = new \Civi\Core\Event\PreEvent($op, $objectName, $id, $params);
* @param array $values
* (optional) the values to fill the links.
*
- * @return null the return value is ignored
+ * @return null
+ * the return value is ignored
*/
public static function links($op, $objectName, &$objectId, &$links, &$mask = NULL, &$values = array()) {
return self::singleton()->invoke(6, $op, $objectName, $objectId, $links, $mask, $values, 'civicrm_links');
* @param CRM_Core_Form $form
* Reference to the form object.
*
- * @return null the return value is ignored
+ * @return null
+ * the return value is ignored
*/
public static function preProcess($formName, &$form) {
return self::singleton()
* @param CRM_Core_Form $form
* Reference to the form object.
*
- * @return null the return value is ignored
+ * @return null
+ * the return value is ignored
*/
public static function buildForm($formName, &$form) {
return self::singleton()->invoke(2, $formName, $form,
* @param CRM_Core_Form $form
* Reference to the form object.
*
- * @return null the return value is ignored
+ * @return null
+ * the return value is ignored
*/
public static function postProcess($formName, &$form) {
return self::singleton()->invoke(2, $formName, $form,
* @param array $params
* The parameters that were sent into the calling function.
*
- * @return null the return value is ignored
+ * @return null
+ * the return value is ignored
*/
public static function custom($op, $groupID, $entityID, &$params) {
return self::singleton()
* @param string $where
* The currrent where clause.
*
- * @return null the return value is ignored
+ * @return null
+ * the return value is ignored
*/
public static function aclWhereClause($type, &$tables, &$whereTables, &$contactID, &$where) {
return self::singleton()
* @param array $currentGroups
* The set of objects that are currently permissioned for this contact.
*
- * @return null the return value is ignored
+ * @return null
+ * the return value is ignored
*/
public static function aclGroup($type, $contactID, $tableName, &$allGroups, &$currentGroups) {
return self::singleton()
* @param array $files
* The current set of files to process.
*
- * @return null the return value is ignored
+ * @return null
+ * the return value is ignored
*/
public static function xmlMenu(&$files) {
return self::singleton()->invoke(1, $files,
* @param array $entities
* List of pending entities.
*
- * @return null the return value is ignored
+ * @return null
+ * the return value is ignored
*/
public static function managed(&$entities) {
return self::singleton()->invoke(1, $entities,
* (output parameter) where should the hook content be displayed.
* relative to the activity list
*
- * @return string the html snippet to include in the dashboard
+ * @return string
+ * the html snippet to include in the dashboard
*/
public static function dashboard($contactID, &$contentPlacement = self::DASHBOARD_BELOW) {
$retval = self::singleton()->invoke(2, $contactID, $contentPlacement,
* @param int $caseID
* The case ID.
*
- * @return array of data to be displayed, where the key is a unique id to be used for styling (div id's)
+ * @return array
+ * of data to be displayed, where the key is a unique id to be used for styling (div id's)
* and the value is an array with keys 'label' and 'value' specifying label/value pairs
*/
public static function caseSummary($caseID) {
*
* @internal param array $seletor the selector object. Allows you access to the context of the search
*
- * @return void modify the header and values object to pass the data u need
+ * @return void
+ * modify the header and values object to pass the data u need
*/
public static function searchColumns($objectName, &$headers, &$rows, &$selector) {
return self::singleton()->invoke(4, $objectName, $headers, $rows, $selector,
* @param array $participant
* Array of participant values.
*
- * @return null the return value is ignored
+ * @return null
+ * the return value is ignored
*/
public static function alterBadge($labelName, &$label, &$format, &$participant) {
return self::singleton()
*
* @param array $angularModules
* List of modules.
- * @return null the return value is ignored
+ * @return null
+ * the return value is ignored
*
* @code
* function mymod_civicrm_angularModules(&$angularModules) {
*
* @param string $remoteFile
* URL of remote file.
- * @return array array(0 => STATUS_OK|STATUS_DL_ERROR, 1 => string)
+ * @return array
+ * array(0 => STATUS_OK|STATUS_DL_ERROR, 1 => string)
*/
public function get($remoteFile) {
// Download extension zip file ...
* URL of a .zip file.
* @param array $params
*
- * @return array array(0 => STATUS_OK|STATUS_DL_ERROR, 1 => string)
+ * @return array
+ * array(0 => STATUS_OK|STATUS_DL_ERROR, 1 => string)
*/
public function post($remoteFile, $params) {
// Download extension zip file ...
/**
* @param string $remoteFile
- * @return array (0 => resource, 1 => CA_Config_Curl)
+ * @return array
+ * (0 => resource, 1 => CA_Config_Curl)
*/
protected function createCurl($remoteFile) {
require_once 'CA/Config/Curl.php';
*
* @param string $jsCode
* Raw Javascript code.
- * @return array of translatable strings
+ * @return array
+ * of translatable strings
*/
public static function parseStrings($jsCode) {
$strings = array();
* @param string $identifier
* Identifier for the JSON array.
*
- * @return string $jsonObject JSON array
+ * @return string
+ * JSON array
* @static
*/
public static function encode($params, $identifier = 'id') {
* (by reference).
*
*
- * @return boolean true if a mail was sent, else false
+ * @return boolean
+ * true if a mail was sent, else false
*/
public static function send(&$params) {
$returnPath = CRM_Core_BAO_MailSettings::defaultReturnPath();
* @param string $header
* The full name + email address string.
*
- * @return string the plucked email address
+ * @return string
+ * the plucked email address
* @static
*/
public static function pluckEmailFromHeader($header) {
/**
* Get the Active outBound email
*
- * @return boolean true if valid outBound email configuration found, false otherwise
+ * @return boolean
+ * true if valid outBound email configuration found, false otherwise
* @static
*/
public static function validOutBoundMail() {
* @param string $html
* @param string $format
*
- * @return array $attachments
+ * @return array
*/
public static function appendPDF($fileName, $html, $format = NULL) {
$pdf_filename = CRM_Core_Config::singleton()->templateCompileDir . CRM_Utils_File::makeFileName($fileName);
/**
* Process the default mailbox (ie. that is used by civiMail for the bounce)
*
- * @return boolean always returns true (for the api). at a later stage we should
+ * @return boolean
+ * always returns true (for the api). at a later stage we should
* fix this to return true on success / false on failure etc
*/
public static function processBounces() {
/**
* Render the in-memory representation as XML
*
- * @return string XML
+ * @return string
+ * XML
*/
public function toXML() {
$buffer = '<?xml version="1.0" encoding="iso-8859-1" ?>';
* Each item is an array(0 => MappedEntityname, 1 => InputFieldName (id-field), 2 => OutputFieldName (name-field), 3 => OptionalPrefix).
* @param CRM_Core_DAO $dao
* The entity for which we want to prepare mapped fields.
- * @return array new fields
+ * @return array
+ * new fields
*/
public function computeMappedFields($mappedFields, $dao) {
$keyValues = array();
* @param string $tagName
* @param array $keyValues
* @throws Exception
- * @return string XML
+ * @return string
+ * XML
*/
public function renderKeyValueXML($tagName, $keyValues) {
$xml = " <$tagName>";
* @param string $prefix
*
* @throws Exception
- * @return string XML
+ * @return string
+ * XML
*/
public function renderTextTag($name, $value, $prefix = '') {
if (!preg_match('/^[a-zA-Z0-9\_]+$/', $name)) {
* @param string $valueFormat
* The desired monetary value display format (e.g. '%!i').
*
- * @return string formatted monetary string
+ * @return string
+ * formatted monetary string
*
* @static
*/
* @param float $interval
* Seconds to wait in between pollings.
*
- * @return bool TRUE if service is online
+ * @return bool
+ * TRUE if service is online
*/
public static function waitForServiceStartup($host, $port, $serverStartupTimeOut, $interval = 0.333) {
$start = time();
* @param array $params
* Assoc array of name/value pairs.
*
- * @return object $chart object of open flash chart.
+ * @return object
+ * $chart object of open flash chart.
* @static
*/
public static function &barChart(&$params) {
* @param array $params
* Assoc array of name/value pairs.
*
- * @return object $chart object of open flash chart.
+ * @return object
+ * $chart object of open flash chart.
* @static
*/
public static function &pieChart(&$params) {
* @param array $params
* Assoc array of name/value pairs.
*
- * @return object $chart object of open flash chart.
+ * @return object
+ * $chart object of open flash chart.
* @static
*/
public static function &bar_3dChart(&$params) {
* <p>.
* An offset to check for.
* </p>
- * @return boolean true on success or false on failure.
+ * @return boolean
+ * true on success or false on failure.
* </p>
* <p>
* The return value will be casted to boolean if non-boolean was returned.
* (PHP 5 >= 5.1.0)<br/>
* Count elements of an object
* @link http://php.net/manual/en/countable.count.php
- * @return int The custom count as an integer.
+ * @return int
+ * The custom count as an integer.
* </p>
* <p>
* The return value is cast to an integer.
*
* @param array $params
*
- * @return int new pageId to display to the user
+ * @return int
+ * new pageId to display to the user
*/
public function getPageID($defaultPageId = 1, &$params) {
// POST has higher priority than GET vars
* @param int $defaultPageRowCount
* The default value if not set.
*
- * @return int the rowCount value to use
+ * @return int
+ * the rowCount value to use
*
*/
public function getPageRowCount($defaultPageRowCount = self::ROWCOUNT) {
*
* @param void
*
- * @return array: an array of the pageID and offset
+ * @return array
+ * an array of the pageID and offset
*
*
*/
*
* @param bool $isDAO
*
- * @return string The html formatted string
+ * @return string
+ * The html formatted string
* @static
*/
public static function getAToZBar(&$query, $sortByCharacter, $isDAO = FALSE) {
/**
* Return the all the static characters
*
- * @return array $staticAlphabets is a array of static characters
+ * @return array
+ * is a array of static characters
* @static
*/
public static function getStaticCharacters() {
* @param $query
* @param $isDAO
*
- * @return array $dynamicAlphabets is a array of dynamic characters
+ * @return array
+ * is a array of dynamic characters
* @static
*/
public static function getDynamicCharacters(&$query, $isDAO) {
*
* @param $isDAO
*
- * @return array with links
+ * @return array
+ * with links
* @static
*/
public static function createLinks(&$query, $sortByCharacter, $isDAO) {
*
* @param $constant
*
- * @return array - array reference of all relevant constant
+ * @return array
+ * array reference of all relevant constant
*/
public static function getConstant($constant) {
$class = self::findConstantClass($constant);
*
* @param $constant
*
- * @return array - array reference of all relevant constant
+ * @return array
+ * array reference of all relevant constant
*/
public static function flushConstant($constant) {
$class = self::findConstantClass($constant);
*
* This may be inefficient and should generally be avoided.
*
- * @return array of string, constant names
+ * @return array
+ * of string, constant names
*/
public static function findConstants() {
if (self::$constants === NULL) {
*
* @param $class
*
- * @return array of string, constant names
+ * @return array
+ * of string, constant names
*/
public static function findConstantsByClass($class) {
$clazz = new ReflectionClass($class);
* @param string $var
* The string to be echoed.
*
- * @return string $var
+ * @return string
*/
public static function ping($var = NULL) {
$session = CRM_Core_Session::singleton();
/**
* Return the recently viewed array
*
- * @return array the recently viewed array
+ * @return array
+ * the recently viewed array
* @static
*/
public static function &get() {
* @param bool $monthRequired
* Check whether month is mandatory.
*
- * @return bool true if valid date
+ * @return bool
+ * true if valid date
* @static
*/
public static function currentDate($date, $monthRequired = TRUE) {
*
* @param string $date
*
- * @return bool true if valid date
+ * @return bool
+ * true if valid date
* @static
*/
public static function mysqlDate($date) {
*
* @param array Uploaded file info (from $_FILES)
*
- * @return bool true if file has been uploaded, false otherwise
+ * @return bool
+ * true if file has been uploaded, false otherwise
*/
public static function asciiFile($elementValue) {
if ((isset($elementValue['error']) && $elementValue['error'] == 0) ||
*
* @param array Uploaded file info (from $_FILES)
*
- * @return bool whether file has been uploaded properly and is now in UTF-8
+ * @return bool
+ * whether file has been uploaded properly and is now in UTF-8
*/
public static function utf8File($elementValue) {
$success = FALSE;
*
* @param array Uploaded file info (from $_FILES)
*
- * @return bool true if file has been uploaded, false otherwise
+ * @return bool
+ * true if file has been uploaded, false otherwise
*/
public static function htmlFile($elementValue) {
if ((isset($elementValue['error']) && $elementValue['error'] == 0) ||
* @param array $options
* The daoName and fieldName (optional ).
*
- * @return boolean true if object exists
+ * @return boolean
+ * true if object exists
* @static
*/
public static function objectExists($value, $options) {
*
* @param array $date
*
- * @return bool true if valid date
+ * @return bool
+ * true if valid date
* @static
*/
public static function qfDate($date) {
/**
* @param string|NULL $value
- * @return string SQL expression, e.g. "it\'s great" (with-quotes) or NULL (without-quotes)
+ * @return string
+ * SQL expression, e.g. "it\'s great" (with-quotes) or NULL (without-quotes)
*/
protected function escapeString($value) {
return $value === NULL ? 'NULL' : '"' . CRM_Core_DAO::escapeString($value) . '"';
}
/**
- * @return string SQL statement
+ * @return string
+ * SQL statement
*/
public function toSQL() {
$columns = "`" . implode('`,`', $this->columns) . "`";
* PHP NULL's will be treated as SQL NULL's. The PHP string "null" will be treated as a string.
*
* @throws CRM_Core_Exception
- * @return string SQL expression
+ * @return string
+ * SQL expression
*/
public function interpolate($expr, $args) {
if ($args === NULL) {
/**
* @param string|NULL $value
- * @return string SQL expression, e.g. "it\'s great" (with-quotes) or NULL (without-quotes)
+ * @return string
+ * SQL expression, e.g. "it\'s great" (with-quotes) or NULL (without-quotes)
*/
protected function escapeString($value) {
return $value === NULL ? 'NULL' : '"' . CRM_Core_DAO::escapeString($value) . '"';
}
/**
- * @return string SQL statement
+ * @return string
+ * SQL statement
*/
public function toSQL() {
if ($this->selects) {
* @param string $var
* The string to be echoed.
*
- * @return string $var
+ * @return string
*/
public function ping($var) {
$session = CRM_Core_Session::singleton();
* @param bool $loadCMSBootstrap
*
* @throws SoapFault
- * @return string The SOAP Client key
+ * @return string
+ * The SOAP Client key
* @static
*/
public function authenticate($name, $pass, $loadCMSBootstrap = FALSE) {
/**
* Function returns the string for the order by clause
*
- * @return string the order by clause
+ * @return string
+ * the order by clause
*/
public function orderBy() {
if (empty($this->_vars[$this->_currentSortID])) {
* @param int $dir
* The direction of the sort.
*
- * @return string the string to append to the url
+ * @return string
+ * the string to append to the url
* @static
*/
public static function sortIDValue($index, $dir) {
/**
* Getter for currentSortID
*
- * @return int returns of the current sort id
+ * @return int
+ * returns of the current sort id
* @acccess public
*/
public function getCurrentSortID() {
/**
* Getter for currentSortDirection
*
- * @return int returns of the current sort direction
+ * @return int
+ * returns of the current sort direction
* @acccess public
*/
public function getCurrentSortDirection() {
* @param $a
* @param $b
*
- * @return int (-1 or 1)
+ * @return int
+ * (-1 or 1)
*/
public static function cmpFunc($a, $b) {
$cmp_order = array('weight', 'id', 'title', 'name');
* Length of valid variables.
*
*
- * @return string returns the manipulated string
+ * @return string
+ * returns the manipulated string
* @static
*/
public static function munge($name, $char = '_', $len = 63) {
* membership_payment returns MembershipPayment
* @param string $string
*
- * @return string string
+ * @return string
+ * string
*/
public static function convertStringToCamel($string) {
$fragments = explode('_', $string);
* @param int $len
* Length of valid variables.
*
- * @return string Randomized Variable Name
+ * @return string
+ * Randomized Variable Name
* @static
*/
public static function rename($name, $len = 4) {
* @param \char|string $char $char the character used to demarcate the componets
*
*
- * @return string the last component
+ * @return string
+ * the last component
* @static
*/
public static function getClassName($string, $char = '_') {
* @param bool $utf8
* Attempt utf8 match on failure (default yes).
*
- * @return boolean true if string is ascii
+ * @return boolean
+ * true if string is ascii
* @static
*/
public static function isAscii($str, $utf8 = TRUE) {
* @param array $regexRules
* Regular expression to be matched w/ replacements.
*
- * @return array $match array of strings w/ corresponding redacted outputs
+ * @return array
+ * array of strings w/ corresponding redacted outputs
* @static
*/
public static function regex($str, $regexRules) {
* @param string $url2
* The second url to be matched against.
*
- * @return boolean true if the urls match, else false
+ * @return boolean
+ * true if the urls match, else false
* @static
*/
public static function match($url1, $url2) {
* @param string $html
* The string to be converted.
*
- * @return string the converted string
+ * @return string
+ * the converted string
* @static
*/
public static function htmlToText($html) {
* @param string $full
* All alternatives as a long string (or some other text).
*
- * @return string only the first alternative found (or the text without alternatives)
+ * @return string
+ * only the first alternative found (or the text without alternatives)
*/
public static function stripAlternatives($full) {
$matches = array();
* @param string $string
* Input string to be cleaned.
*
- * @return string the cleaned string
+ * @return string
+ * the cleaned string
* @static
*/
public static function stripSpaces($string) {
* @param string $replace
* The character to replace it with.
*
- * @return string the sanitized string
+ * @return string
+ * the sanitized string
* @static
*/
static function stripPathChars(
* @param string $string
* The input string.
*
- * @return string the cleaned up string
+ * @return string
+ * the cleaned up string
* @static
*/
public static function purifyHTML($string) {
* E.g. "view all contacts". Syntax: "[prefix:]name".
* @param null $defaultPrefix
*
- * @return array (0 => string|NULL $prefix, 1 => string $value)
+ * @return array
+ * (0 => string|NULL $prefix, 1 => string $value)
*/
public static function parsePrefix($delim, $string, $defaultPrefix = NULL) {
$pos = strpos($string, $delim);
* @param int $percent
* The percentage of the user portion to be masked.
*
- * @return string returns the masked Email address
+ * @return string
+ * returns the masked Email address
*/
public static function maskEmail($email, $maskChar = '*', $percent = 50) {
list($user, $domain) = preg_split("/@/", $email);
* @param bool $case
* Boolean indicating whether you want the comparison to be case sensitive or not.
*
- * @return boolean TRUE (string are identical); FALSE (strings are not identical)
+ * @return boolean
+ * TRUE (string are identical); FALSE (strings are not identical)
*/
public static function compareStr($strOne, $strTwo, $case) {
if ($case == TRUE) {
*
* @param string $url
* URL with HTML entities.
- * @return string URL without HTML entities
+ * @return string
+ * URL without HTML entities
*/
public static function unstupifyUrl($htmlUrl) {
return str_replace('&', '&', $htmlUrl);
/**
* What menu path are we currently on. Called for the primary tpl
*
- * @return string the current menu path
+ * @return string
+ * the current menu path
*/
public static function currentPath() {
$config = CRM_Core_Config::singleton();
* @param array $params
* List of parameters.
*
- * @return string url
+ * @return string
+ * url
*/
public static function crmURL($params) {
$p = CRM_Utils_Array::value('p', $params);
/**
* Returns wiki (alternate) documentation URL base.
*
- * @return string documentation url
+ * @return string
+ * documentation url
*/
public static function getWikiBaseURL() {
// FIXME: move this to configuration at some stage
*
* @param string $url
*
- * @return string $url, clean url
+ * @return string
+ * , clean url
*/
public static function cleanUrl($url) {
if (!$url) {
* @param bool $addLanguagePart
* @param bool $removeLanguagePart
*
- * @return string $url, formatted url.
+ * @return string
+ * , formatted url.
*/
static function languageNegotiationURL(
$url,
* @param string $destination
* If present, add destination to querystring (works for Drupal only).
*
- * @return string - loginURL for the current CMS
+ * @return string
+ * loginURL for the current CMS
* @static
*/
public abstract function getLoginURL($destination = '');
/**
* Get currently logged in user uf id.
*
- * @return int $userID logged in user uf id.
+ * @return int
+ * $userID logged in user uf id.
*/
public function getLoggedInUfID() {
}
/**
* Get currently logged in user unique identifier - this tends to be the email address or user name.
*
- * @return string $userID logged in user unique identifier
+ * @return string
+ * logged in user unique identifier
*/
public function getLoggedInUniqueIdentifier() {
}
* Note there is already a function getUFId which takes $username as a param - we could add $user
* as a second param to it but it seems messy - just overloading it because the name is taken
* @param object $user
- * @return int $ufid - user ID of UF System
+ * @return int
+ * $ufid - user ID of UF System
*/
public function getBestUFID($user = NULL) {
if ($user) {
* the function
*
* @param object $user
- * @return string $uniqueIdentifier - unique identifier from the UF System
+ * @return string
+ * unique identifier from the UF System
*/
public function getBestUFUniqueIdentifier($user = NULL) {
if ($user) {
*
* @param CRM_Core_Form $form
* Form object representing the 'current' form - to which the user will be returned.
- * @return string $destination destination value for URL
+ * @return string
+ * destination value for URL
*
*/
/**
* @param string $destination
* If present, add destination to querystring (works for Drupal only).
*
- * @return string - loginURL for the current CMS
+ * @return string
+ * loginURL for the current CMS
* @static
*/
public function getLoginURL($destination = '') {
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
*
- * @return bool TRUE if we support this operation in this CMS, FALSE otherwise
+ * @return bool
+ * TRUE if we support this operation in this CMS, FALSE otherwise
*/
public function addScriptUrl($url, $region) {
$params = array('group' => JS_LIBRARY, 'weight' => 10);
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
*
- * @return bool TRUE if we support this operation in this CMS, FALSE otherwise
+ * @return bool
+ * TRUE if we support this operation in this CMS, FALSE otherwise
*/
public function addScript($code, $region) {
$params = array('type' => 'inline', 'group' => JS_LIBRARY, 'weight' => 10);
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
*
- * @return bool TRUE if we support this operation in this CMS, FALSE otherwise
+ * @return bool
+ * TRUE if we support this operation in this CMS, FALSE otherwise
*/
public function addStyleUrl($url, $region) {
if ($region != 'html-header') {
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
*
- * @return bool TRUE if we support this operation in this CMS, FALSE otherwise
+ * @return bool
+ * TRUE if we support this operation in this CMS, FALSE otherwise
*/
public function addStyle($code, $region) {
if ($region != 'html-header') {
* @param mix $action
* The default action if one is pre-specified.
*
- * @return string the url to post the form
+ * @return string
+ * the url to post the form
*/
public function postURL($action) {
if (!empty($action)) {
/**
* Get the locale set in the hosting CMS
*
- * @return string with the locale or null for none
+ * @return string
+ * with the locale or null for none
*/
public function getUFLocale() {
// return CiviCRM’s xx_YY locale that either matches Drupal’s Chinese locale
/**
* Check is user logged in.
*
- * @return boolean true/false.
+ * @return boolean
*/
public function isUserLoggedIn() {
$isloggedIn = FALSE;
/**
* Get currently logged in user uf id.
*
- * @return int $userID logged in user uf id.
+ * @return int
+ * $userID logged in user uf id.
*/
public function getLoggedInUfID() {
$ufID = NULL;
* @param bool $addLanguagePart
* @param bool $removeLanguagePart
*
- * @return string $url, formatted url.
+ * @return string
+ * , formatted url.
* @static
*/
public function languageNegotiationURL($url, $addLanguagePart = TRUE, $removeLanguagePart = FALSE) {
/**
* Get a list of all installed modules, including enabled and disabled ones
*
- * @return array CRM_Core_Module
+ * @return array
+ * CRM_Core_Module
*/
public function getModules() {
$result = array();
/**
* Over-ridable function to get timezone as a string eg.
- * @return string Timezone e.g. 'America/Los_Angeles'
+ * @return string
+ * Timezone e.g. 'America/Los_Angeles'
*/
public function getTimeZoneString() {
global $user;
* @param bool $maintenance
* For maintenance mode.
*
- * @return void prints content on stdout
+ * @return void
+ * prints content on stdout
*/
public function theme(&$content, $print = FALSE, $maintenance = FALSE) {
// TODO: Simplify; this was copied verbatim from CiviCRM 3.4's multi-UF theming function, but that's more complex than necessary
*
* @param CRM_Core_Form $form
* Form object representing the 'current' form - to which the user will be returned.
- * @return string $destination destination value for URL
+ * @return string
+ * destination value for URL
*
*/
public function getLoginDestination(&$form) {
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
*
- * @return bool TRUE if we support this operation in this CMS, FALSE otherwise
+ * @return bool
+ * TRUE if we support this operation in this CMS, FALSE otherwise
*/
public function addScriptUrl($url, $region) {
// CRM-15450 - D6 doesn't order internal/external links correctly so we can't use drupal_add_js
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
*
- * @return bool TRUE if we support this operation in this CMS, FALSE otherwise
+ * @return bool
+ * TRUE if we support this operation in this CMS, FALSE otherwise
*/
public function addScript($code, $region) {
// CRM-15450 - ensure scripts are in correct order
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
*
- * @return bool TRUE if we support this operation in this CMS, FALSE otherwise
+ * @return bool
+ * TRUE if we support this operation in this CMS, FALSE otherwise
*/
public function addStyleUrl($url, $region) {
if ($region != 'html-header' || !$this->formatResourceUrl($url)) {
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
*
- * @return bool TRUE if we support this operation in this CMS, FALSE otherwise
+ * @return bool
+ * TRUE if we support this operation in this CMS, FALSE otherwise
*/
public function addStyle($code, $region) {
return FALSE;
* @param mix $action
* The default action if one is pre-specified.
*
- * @return string the url to post the form
+ * @return string
+ * the url to post the form
*/
public function postURL($action) {
if (!empty($action)) {
/**
* Get the locale set in the hosting CMS
*
- * @return string with the locale or null for none
+ * @return string
+ * with the locale or null for none
*/
public function getUFLocale() {
// return CiviCRM’s xx_YY locale that either matches Drupal’s Chinese locale
/**
* Check is user logged in.
*
- * @return boolean true/false.
+ * @return boolean
*/
public function isUserLoggedIn() {
$isloggedIn = FALSE;
/**
* Get currently logged in user uf id.
*
- * @return int $userID logged in user uf id.
+ * @return int
+ * $userID logged in user uf id.
*/
public function getLoggedInUfID() {
$ufID = NULL;
* @param bool $addLanguagePart
* @param bool $removeLanguagePart
*
- * @return string $url, formatted url.
+ * @return string
+ * , formatted url.
* @static
*/
public function languageNegotiationURL($url, $addLanguagePart = TRUE, $removeLanguagePart = FALSE) {
/**
* Get a list of all installed modules, including enabled and disabled ones
*
- * @return array CRM_Core_Module
+ * @return array
+ * CRM_Core_Module
*/
public function getModules() {
$result = array();
* @param string $destination
* If present, add destination to querystring (works for Drupal only).
*
- * @return string - loginURL for the current CMS
+ * @return string
+ * loginURL for the current CMS
* @static
*/
public function getLoginURL($destination = '') {
/**
* Over-ridable function to get timezone as a string eg.
- * @return string Timezone e.g. 'America/Los_Angeles'
+ * @return string
+ * Timezone e.g. 'America/Los_Angeles'
*/
public function getTimeZoneString() {
global $user;
*
* @param CRM_Core_Form $form
* Form object representing the 'current' form - to which the user will be returned.
- * @return string $destination destination value for URL
+ * @return string
+ * destination value for URL
*
*/
public function getLoginDestination(&$form) {
* @param string $destination
* If present, add destination to querystring (works for Drupal only).
*
- * @return string - loginURL for the current CMS
+ * @return string
+ * loginURL for the current CMS
* @static
*/
public function getLoginURL($destination = '') {
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
*
- * @return bool TRUE if we support this operation in this CMS, FALSE otherwise
+ * @return bool
+ * TRUE if we support this operation in this CMS, FALSE otherwise
*/
public function addScriptUrl($url, $region) {
$options = array('group' => JS_LIBRARY, 'weight' => 10);
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
*
- * @return bool TRUE if we support this operation in this CMS, FALSE otherwise
+ * @return bool
+ * TRUE if we support this operation in this CMS, FALSE otherwise
*/
public function addScript($code, $region) {
$options = array('type' => 'inline', 'group' => JS_LIBRARY, 'weight' => 10);
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
*
- * @return bool TRUE if we support this operation in this CMS, FALSE otherwise
+ * @return bool
+ * TRUE if we support this operation in this CMS, FALSE otherwise
*/
public function addStyleUrl($url, $region) {
if ($region != 'html-header') {
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
*
- * @return bool TRUE if we support this operation in this CMS, FALSE otherwise
+ * @return bool
+ * TRUE if we support this operation in this CMS, FALSE otherwise
*/
public function addStyle($code, $region) {
if ($region != 'html-header') {
/**
* Get currently logged in user uf id.
*
- * @return int $userID logged in user uf id.
+ * @return int
+ * $userID logged in user uf id.
*/
public function getLoggedInUfID() {
if ($id = \Drupal::currentUser()->id()) {
/**
* @param string dir base civicrm directory
* Return default Site Settings
- * @return array array
+ * @return array
+ * array
* - $url, (Joomla - non admin url)
* - $siteName,
* - $siteRoot
*
* @param url (reference)
*
- * @return bool: TRUE for internal paths, FALSE for external. The drupal_add_js fn is able to add js more
+ * @return bool
+ * TRUE for internal paths, FALSE for external. The drupal_add_js fn is able to add js more
* efficiently if it is known to be in the drupal site
*/
public function formatResourceUrl(&$url) {
*
* @param string $url
* Potential resource url based on standard folder assumptions.
- * @return string $url with civicrm-core directory appended if not standard civi dir
+ * @return string
+ * with civicrm-core directory appended if not standard civi dir
*/
public function appendCoreDirectoryToResourceBase($url) {
global $civicrm_root;
* @param bool $forceBackend
* a gross joomla hack.
*
- * @return string an HTML string containing a link to the given path.
+ * @return string
+ * an HTML string containing a link to the given path.
*
*/
function url(
/**
* Get currently logged in user unique identifier - this tends to be the email address or user name.
*
- * @return string $userID logged in user unique identifier
+ * @return string
+ * logged in user unique identifier
*/
public function getLoggedInUniqueIdentifier() {
global $user;
/**
* Get a list of all installed modules, including enabled and disabled ones
*
- * @return array CRM_Core_Module
+ * @return array
+ * CRM_Core_Module
*
*/
public function getModules() {
*
* @param string $url
*
- * @return string $url, formatted url.
+ * @return string
+ * , formatted url.
* @static
*/
public function languageNegotiationURL($url, $addLanguagePart = TRUE, $removeLanguagePart = FALSE) {
/**
* Get the locale set in the hosting CMS
*
- * @return string with the locale or null for none
+ * @return string
+ * with the locale or null for none
*
*/
public function getUFLocale() {
* @param mix $action
* The default action if one is pre-specified.
*
- * @return string the url to post the form
+ * @return string
+ * the url to post the form
*/
public function postURL($action) {
if (!empty($action)) {
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
*
- * @return bool TRUE if we support this operation in this CMS, FALSE otherwise
+ * @return bool
+ * TRUE if we support this operation in this CMS, FALSE otherwise
*/
public function addScriptUrl($url, $region) {
return FALSE;
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
*
- * @return bool TRUE if we support this operation in this CMS, FALSE otherwise
+ * @return bool
+ * TRUE if we support this operation in this CMS, FALSE otherwise
*/
public function addScript($code, $region) {
return FALSE;
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
*
- * @return bool TRUE if we support this operation in this CMS, FALSE otherwise
+ * @return bool
+ * TRUE if we support this operation in this CMS, FALSE otherwise
*/
public function addStyleUrl($url, $region) {
if ($region == 'html-header') {
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
*
- * @return bool TRUE if we support this operation in this CMS, FALSE otherwise
+ * @return bool
+ * TRUE if we support this operation in this CMS, FALSE otherwise
*/
public function addStyle($code, $region) {
if ($region == 'html-header') {
*
* @param bool $forceBackend
*
- * @return string an HTML string containing a link to the given path.
+ * @return string
+ * an HTML string containing a link to the given path.
*/
function url(
$path = NULL, $query = NULL, $absolute = TRUE,
* @param $action
* The default action if one is pre-specified.
*
- * @return string the url to post the form
+ * @return string
+ * the url to post the form
*/
public function postURL($action) {
if (!empty($action)) {
/**
* Get the locale set in the hosting CMS
*
- * @return string the used locale or null for none
+ * @return string
+ * the used locale or null for none
*/
public function getUFLocale() {
if (defined('_JEXEC')) {
/**
* Check is user logged in.
*
- * @return boolean true/false.
+ * @return boolean
*/
public function isUserLoggedIn() {
$user = JFactory::getUser();
/**
* Get currently logged in user uf id.
*
- * @return int logged in user uf id.
+ * @return int
+ * logged in user uf id.
*/
public function getLoggedInUfID() {
$user = JFactory::getUser();
/**
* Get currently logged in user unique identifier - this tends to be the email address or user name.
*
- * @return string $userID logged in user unique identifier
+ * @return string
+ * logged in user unique identifier
*/
public function getLoggedInUniqueIdentifier() {
$user = JFactory::getUser();
/**
* Get a list of all installed modules, including enabled and disabled ones
*
- * @return array CRM_Core_Module
+ * @return array
+ * CRM_Core_Module
*/
public function getModules() {
$result = array();
* @param string $destination
* If present, add destination to querystring (works for Drupal only).
*
- * @return string - loginURL for the current CMS
+ * @return string
+ * loginURL for the current CMS
* @static
*/
public function getLoginURL($destination = '') {
*
* @param $dir
*
- * @return array array
+ * @return array
+ * array
* - $url, (Joomla - non admin url)
* - $siteName,
* - $siteRoot
* @param string $str
* The permission to check.
*
- * @return boolean true if yes, else false
+ * @return boolean
+ * true if yes, else false
* @static
*/
public function checkPermission($str) {
* @param string $fragment
* A fragment identifier (named anchor) to append to the link.
*
- * @return string an HTML string containing a link to the given path.
+ * @return string
+ * an HTML string containing a link to the given path.
*
*/
public function url($path = NULL, $query = NULL, $absolute = TRUE, $fragment = NULL) {
*
* @param the default action if one is pre-specified
*
- * @return string the url to post the form
+ * @return string
+ * the url to post the form
*/
public function postURL($action) {
return NULL;
* @param string $pass
* Login password.
*
- * @return array Result array
+ * @return array
+ * Result array
*/
public function &authenticate($name, $pass) {
if (isset(self::$ufClass)) {
/**
* Get the locale set in the hosting CMS
*
- * @return null as the language is set elsewhere
+ * @return null
+ * as the language is set elsewhere
*/
public function getUFLocale() {
return NULL;
* If present, add destination to querystring (works for Drupal only).
*
* @throws Exception
- * @return string - loginURL for the current CMS
+ * @return string
+ * loginURL for the current CMS
* @static
*/
public function getLoginURL($destination = '') {
* @param mix $action
* The default action if one is pre-specified.
*
- * @return string the url to post the form
+ * @return string
+ * the url to post the form
*/
/**
* @param mix $action
* @param bool $forceBackend
* a gross joomla hack.
*
- * @return string an HTML string containing a link to the given path.
+ * @return string
+ * an HTML string containing a link to the given path.
*
*/
/**
/**
* Get the locale set in the hosting CMS
*
- * @return string with the locale or null for none
+ * @return string
+ * with the locale or null for none
*/
/**
* @return string
/**
* Get a list of all installed modules, including enabled and disabled ones
*
- * @return array CRM_Core_Module
+ * @return array
+ * CRM_Core_Module
*/
/**
* @return array
* If present, add destination to querystring (works for Drupal only).
*
* @throws Exception
- * @return string - loginURL for the current CMS
+ * @return string
+ * loginURL for the current CMS
* @static
*/
public function getLoginURL($destination = '') {
/**
* Over-ridable function to get timezone as a string eg.
- * @return string Timezone e.g. 'America/Los_Angeles'
+ * @return string
+ * Timezone e.g. 'America/Los_Angeles'
*/
public function getTimeZoneString() {
// This class extends Drupal, but we don't want Drupal's behavior; reproduce CRM_Utils_System_Base::getTimeZoneString
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
*
- * @return bool TRUE if we support this operation in this CMS, FALSE otherwise
+ * @return bool
+ * TRUE if we support this operation in this CMS, FALSE otherwise
*/
public function addScriptUrl($url, $region) {
return FALSE;
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
*
- * @return bool TRUE if we support this operation in this CMS, FALSE otherwise
+ * @return bool
+ * TRUE if we support this operation in this CMS, FALSE otherwise
*/
public function addScript($code, $region) {
return FALSE;
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
*
- * @return bool TRUE if we support this operation in this CMS, FALSE otherwise
+ * @return bool
+ * TRUE if we support this operation in this CMS, FALSE otherwise
*/
public function addStyleUrl($url, $region) {
return FALSE;
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
*
- * @return bool TRUE if we support this operation in this CMS, FALSE otherwise
+ * @return bool
+ * TRUE if we support this operation in this CMS, FALSE otherwise
*/
public function addStyle($code, $region) {
return FALSE;
* @param mix $action
* The default action if one is pre-specified.
*
- * @return string the url to post the form
+ * @return string
+ * the url to post the form
* @static
*/
public function postURL($action) {
*
* @param bool $forceBackend
*
- * @return string an HTML string containing a link to the given path.
+ * @return string
+ * an HTML string containing a link to the given path.
*/
function url(
$path = NULL,
/**
* Get the locale set in the hosting CMS
*
- * @return string with the locale or null for none
+ * @return string
+ * with the locale or null for none
*/
public function getUFLocale() {
// WPML plugin
/**
* Check is user logged in.
*
- * @return boolean true/false.
+ * @return boolean
*/
public function isUserLoggedIn() {
$isloggedIn = FALSE;
/**
* Get currently logged in user uf id.
*
- * @return int $userID logged in user uf id.
+ * @return int
+ * $userID logged in user uf id.
*/
public function getLoggedInUfID() {
$ufID = NULL;
/**
* Get currently logged in user unique identifier - this tends to be the email address or user name.
*
- * @return string $userID logged in user unique identifier
+ * @return string
+ * logged in user unique identifier
*/
public function getLoggedInUniqueIdentifier() {
$user = $this->getLoggedInUserObject();
* @param string $destination
* If present, add destination to querystring (works for Drupal only).
*
- * @return string - loginURL for the current CMS
+ * @return string
+ * loginURL for the current CMS
*
*/
public function getLoginURL($destination = '') {
/**
* Return the current WordPress version if relevant function exists
*
- * @return string - version number
+ * @return string
+ * version number
*
*/
public function getVersion() {
/**
* Get timezone as a string
- * @return string Timezone e.g. 'America/Los_Angeles'
+ * @return string
+ * Timezone e.g. 'America/Los_Angeles'
*/
public function getTimeZoneString() {
return get_option('timezone_string');
* @param string $str
* The string to search.
*
- * @return boolean Was there a match
+ * @return boolean
+ * Was there a match
* @static
*/
public static function token_match($type, $var, &$str) {
*
* @param bool $escapeSmarty
*
- * @return string The processed string
+ * @return string
+ * The processed string
* @static
*/
public static function &token_replace($type, $var, $value, &$str, $escapeSmarty = FALSE) {
* @param string $token_type
* A string indicating the the type of token to be used in the expression.
*
- * @return string regular expression sutiable for using in preg_replace
+ * @return string
+ * regular expression sutiable for using in preg_replace
* @static
*/
private static function tokenRegex($token_type) {
* @param string $string
* A string that needs to be escaped from smarty parsing.
*
- * @return string the escaped string
+ * @return string
+ * the escaped string
* @static
*/
private static function tokenEscapeSmarty($string) {
* @param null $knownTokens
* @param bool $escapeSmarty
*
- * @return string The processed string
+ * @return string
+ * The processed string
* @static
*/
public static function &replaceDomainTokens(
*
* @param bool $escapeSmarty
*
- * @return string The processed string
+ * @return string
+ * The processed string
* @static
*/
public static function &replaceOrgTokens($str, &$org, $html = FALSE, $escapeSmarty = FALSE) {
* @param null $knownTokens
* @param bool $escapeSmarty
*
- * @return string The processed sstring
+ * @return string
+ * The processed sstring
* @static
*/
public static function &replaceMailingTokens(
*
* @param bool $escapeSmarty
*
- * @return string The processed string
+ * @return string
+ * The processed string
* @static
*/
public static function &replaceActionTokens(
*
* @param bool $escapeSmarty
*
- * @return string The processed string
+ * @return string
+ * The processed string
* @static
*/
public static function &replaceContactTokens(
*
* @param bool $escapeSmarty
*
- * @return string The processed string
+ * @return string
+ * The processed string
* @static
*/
public static function &replaceHookTokens(
* @param string $tokenHtml
* @param array $entity
* @param string $entityType
- * @return string html parsed through smarty
+ * @return string
+ * html parsed through smarty
*/
public static function parseThroughSmarty($tokenHtml, $entity, $entityType = 'contact') {
if (defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY) {
* this routine will remove the extra backslashes and braces
*
* @param $str ref to the string that will be scanned and modified
- * @return void this function works directly on the string that is passed
+ * @return void
+ * this function works directly on the string that is passed
* @access public
* @static
*/
* The contact ID.
* @param string hash The security hash of the unsub event
*
- * @return string The processed string
+ * @return string
+ * The processed string
* @static
*/
public static function &replaceUnsubscribeTokens(
* The contact ID.
* @param string hash The security hash of the resub event
*
- * @return string The processed string
+ * @return string
+ * The processed string
* @static
*/
public static function &replaceResubscribeTokens(
* @param bool $html
* Replace tokens with html or plain text.
*
- * @return string The processed string
+ * @return string
+ * The processed string
* @static
*/
public static function &replaceSubscribeTokens($str, $group, $url, $html) {
* @param string $str
* The string with tokens to be replaced.
*
- * @return string The processed string
+ * @return string
+ * The processed string
* @static
*/
public static function &replaceSubscribeInviteTokens($str) {
* @param bool $html
* Replace tokens with html or plain text.
*
- * @return string The processed string
+ * @return string
+ * The processed string
* @static
*/
public static function &replaceWelcomeTokens($str, $group, $html) {
* @param string $str
* The string to search.
*
- * @return array Array of tokens that weren't replaced
+ * @return array
+ * Array of tokens that weren't replaced
* @static
*/
public static function &unmatchedTokens(&$str) {
* @param bool $escapeSmarty
* @param bool $returnEmptyToken
*
- * @return string The processed string
+ * @return string
+ * The processed string
* @static
*/
public static function &replaceComponentTokens(&$str, $contact, $components, $escapeSmarty = FALSE, $returnEmptyToken = TRUE) {
* @param string $string
* The input string to parse for tokens.
*
- * @return array $tokens array of tokens mentioned in field
+ * @return array
+ * array of tokens mentioned in field
* @access public
* @static
*/
* Function to determine which values to retrieve to insert into tokens. The heavy resemblance between this function
* and getTokens appears to be historical rather than intentional and should be reviewed
* @param $string
- * @return array fields to pass in as return properties when populating token
+ * @return array
+ * fields to pass in as return properties when populating token
*
*/
public static function getReturnProperties(&$string) {
* @param string $className
* Sent as context to the hook.
* @param string $jobID
- * @return array contactDetails with hooks swapped out
+ * @return array
+ * contactDetails with hooks swapped out
*/
public function getAnonymousTokenDetails($contactIDs = array(
0),
* @param null $knownTokens
* @param bool $escapeSmarty
*
- * @return string The processed string
+ * @return string
+ * The processed string
* @static
*/
public static function &replaceUserTokens($str, $knownTokens = NULL, $escapeSmarty = FALSE) {
* @param array $knownTokens
* Array of tokens present.
* @param bool $escapeSmarty
- * @return string string with replacements made
+ * @return string
+ * string with replacements made
*/
public static function replaceEntityTokens($entity, $entityArray, $str, $knownTokens = array(), $escapeSmarty = FALSE) {
if (!$knownTokens || empty($knownTokens[$entity])) {
* @param array $membership
* An api result array for a single membership.
* @param bool $escapeSmarty
- * @return string token replacement
+ * @return string
+ * token replacement
*/
public static function getMembershipTokenReplacement($token, $membership, $escapeSmarty = FALSE) {
$entity = 'membership';
}
/**
- * @return array: legacy_token => new_token
+ * @return array
+ * legacy_token => new_token
*/
public static function legacyContactTokens() {
return array(
*
* @param string $name
*
- * @return array (ref)
+ * @return array
+ * (ref)
*
*/
public function &createNode($name) {
* @param string $recipient
* The address of the recipient.
*
- * @return string The VERP encoded address
+ * @return string
+ * The VERP encoded address
* @static
*/
public static function encode($sender, $recipient) {
* @param string $address
* The address to be decoded.
*
- * @return array The tuple ($sender, $recipient)
+ * @return array
+ * The tuple ($sender, $recipient)
* @static
*/
public static function &verpdecode($address) {
* @param bool addSequence should we add a unique sequence number to the end of the key
* @param bool ignoreKey should we not set a qfKey for this controller (for standalone forms)
*
- * @return void.
+ * @return void
+ *
*/
public function run($formName, $formLabel = NULL, $arguments = NULL) {
if (is_array($arguments)) {
*
* @param $file
*
- * @return array (0 => SimpleXMLElement|FALSE, 1 => errorMessage|FALSE)
+ * @return array
+ * (0 => SimpleXMLElement|FALSE, 1 => errorMessage|FALSE)
*/
public static function parseFile($file) {
$xml = FALSE; // SimpleXMLElement
*
* @param $string
*
- * @return array (0 => SimpleXMLElement|FALSE, 1 => errorMessage|FALSE)
+ * @return array
+ * (0 => SimpleXMLElement|FALSE, 1 => errorMessage|FALSE)
*/
public static function parseString($string) {
$xml = FALSE; // SimpleXMLElement
* @param ZipArchive $zip
* @param $expected
*
- * @return string or FALSE
+ * @return string
+ * or FALSE
*/
static public function guessBasedir(ZipArchive $zip, $expected) {
$candidate = FALSE;
* An unhandled exception.
* @param array $apiRequest
* The full description of the API request.
- * @return array (API response)
+ * @return array
+ * (API response)
*/
public function formatApiException($e, $apiRequest) {
$data = $e->getExtraParams();
/**
* @param array $apiRequest
* The full description of the API request.
- * @return array structured response data (per civicrm_api3_create_success)
+ * @return array
+ * structured response data (per civicrm_api3_create_success)
* @see civicrm_api3_create_success
* @throws \API_Exception
*/
* Who knows? ...
*
* @throws \API_Exception
- * @return array the request descriptor; keys:
+ * @return array
+ * the request descriptor; keys:
* - version: int
* - entity: string
* - action: string
/**
* @param int $id
* e.g. file ID.
- * @return array (0 => bool $isValid, 1 => string $entityTable, 2 => int $entityId)
+ * @return array
+ * (0 => bool $isValid, 1 => string $entityTable, 2 => int $entityId)
*/
public function getDelegate($id) {
$query = \CRM_Core_DAO::executeQuery($this->lookupDelegateSql, array(
* The API provider responsible for this request.
* @param array $apiRequest
* The full API request.
- * @return bool True if a new nested transaction is required; false if active tx may be used
+ * @return bool
+ * True if a new nested transaction is required; false if active tx may be used
*/
public function isNested($apiProvider, $apiRequest) {
if ($this->isForceRollback($apiProvider, $apiRequest)) {
/**
* Get a list of all activities in the case
*
- * @return array list of activity records (api/v3 format)
+ * @return array
+ * list of activity records (api/v3 format)
*/
public function getActivities() {
if ($this->activities === NULL) {
*
* @param array $keys
* List of properties by which to index activities.
- * @return array list of activity records (api/v3 format), indexed by $keys
+ * @return array
+ * list of activity records (api/v3 format), indexed by $keys
*/
public function getActivityIndex($keys) {
$key = implode(";", $keys);
* Content; each row in the row csv should start with two cells:.
* - cell 0: the test name
* - cell 1: the test status
- * @return array (string $testName => string $status)
+ * @return array
+ * (string $testName => string $status)
*/
public static function parseResults($csvContent) {
$fh = fopen('php://memory', 'r+');
/**
* @param array $tests
- * @return array (string $testName => string $status)
+ * @return array
+ * (string $testName => string $status)
*/
public function run($tests) {
$envTests = implode(' ', $tests);
/**
* @param string $content
* Xml data.
- * @return array (string $testName => string $status)
+ * @return array
+ * (string $testName => string $status)
*/
public static function parseXmlResults($content) {
$xml = simplexml_load_string($content);
/**
* @param string $content
* Json stream.
- * @return array (string $testName => string $status)
+ * @return array
+ * (string $testName => string $status)
*/
public static function parseJsonResults($content) {
$records = self::parseJsonStream($content);
}
/**
- * @return array (string $file => string $class)
+ * @return array
+ * (string $file => string $class)
*/
public static function findTestClasses($paths) {
$testClasses = array();
/**
* @param array $testClasses
- * @return array each element is an array with keys:
+ * @return array
+ * each element is an array with keys:
* - file: string
* - class: string
* - method: string
* - file_paths
* - db_config
*
- * @return array An array of check summaries. Each array contains the keys 'title', 'severity', and 'details'.
+ * @return array
+ * An array of check summaries. Each array contains the keys 'title', 'severity', and 'details'.
*/
public function checkAll(array $config) {
return array_merge($this->checkSystem($config['file_paths']), $this->checkDatabase($config['db_config']));
* @todo other output modifiers include contact_type
*
* @param array $apiRequest
- * @return array getfields output
+ * @return array
+ * getfields output
*/
function _civicrm_api3_api_getfields(&$apiRequest) {
if (strtolower($apiRequest['action'] == 'getfields')) {
*
* @param $result
*
- * @return boolean true if error, false otherwise
+ * @return boolean
+ * true if error, false otherwise
* @static void
* @access public
*/
* @param string $entity
* Entity name in various formats e.g. Contribution, contribution,
* OptionValue, option_value, UFJoin, uf_join.
- * @return string $entity
+ * @return string
* Entity name in underscore separated format.
*
* @fixme Why isn't this called first thing in civicrm_api wrapper?
*
* @param array $params
*
- * @return array of newly created acl property values.
+ * @return array
+ * of newly created acl property values.
* @access public
*/
function civicrm_api3_acl_create($params) {
*
* @param array $params
*
- * @return array of retrieved acl property values.
+ * @return array
+ * of retrieved acl property values.
* @access public
*/
function civicrm_api3_acl_get($params) {
*
* @param array $params
*
- * @return array of deleted values.
+ * @return array
+ * of deleted values.
* @access public
*/
function civicrm_api3_acl_delete($params) {
*
* @param array $params
*
- * @return array of newly created acl_role property values.
+ * @return array
+ * of newly created acl_role property values.
* @access public
*/
function civicrm_api3_acl_role_create($params) {
*
* @param array $params
*
- * @return array of retrieved acl_role property values.
+ * @return array
+ * of retrieved acl_role property values.
* @access public
*/
function civicrm_api3_acl_role_get($params) {
*
* @param array $params
*
- * @return array of deleted values.
+ * @return array
+ * of deleted values.
* @access public
*/
function civicrm_api3_acl_role_delete($params) {
* Array containing id of the action_schedule.
* to be deleted
*
- * @return array API result array
+ * @return array
+ * API result array
*
* @access public
*/
* {@getfields activity_create}
*
* @throws API_Exception
- * @return array Array containing 'is_error' to denote success or failure and details of the created activity
+ * @return array
+ * Array containing 'is_error' to denote success or failure and details of the created activity
*
* @example ActivityCreate.php Standard create example
* @example Activity/ContactRefCustomField.php Create example including setting a contact reference custom field
* @param array $params
* API request parameters.
* @param array $activities
- * @return array new activities list
+ * @return array
+ * new activities list
*/
function _civicrm_api3_activity_get_formatResult($params, $activities) {
$returns = CRM_Utils_Array::value('return', $params, array());
*
* @throws API_Exception
* @throws Exception
- * @return array $error array with errors
+ * @return array
+ * array with errors
*/
function _civicrm_api3_activity_check_params(&$params) {
*
* @param array $params
*
- * @return array of newly created activity contact records.
+ * @return array
+ * of newly created activity contact records.
* @access public
*/
function civicrm_api3_activity_contact_create($params) {
*
* @param array $params
*
- * @return array Api Result
+ * @return array
+ * Api Result
*
* @example ActivityContact.php
* @access public
* @param array $params
* An associative array of name/value pairs.
*
- * @return array details of found tags else error
+ * @return array
+ * details of found tags else error
*
* @access public
*/
/**
* @deprecated api notice
- * @return string to indicate this entire api entity is deprecated
+ * @return string
+ * to indicate this entire api entity is deprecated
*/
function _civicrm_api3_activity_type_deprecation() {
return 'The activity_type api is deprecated. Please use the option_value api instead.';
*
* @param array $params
*
- * @return array $activityTypes activity types keyed by id
+ * @return array
+ * activity types keyed by id
* @access public
*
* @example ActivityTypeGet.php
* Associated array of fields.
* $params['option_value_id'] is required for updation of activity type
*
- * @return array $activityType created / updated activity type
+ * @return array
+ * created / updated activity type
*
* @access public
*
* @param array $params
* Array including id of activity_type to delete.
- * @return array API result array
+ * @return array
+ * API result array
*
* @access public
*
*
* @param array $params
*
- * @return array of newly created tag property values.
+ * @return array
+ * of newly created tag property values.
* @access public
*/
function civicrm_api3_address_create(&$params) {
* {@getfields address_delete}
* {@example AddressDelete.php 0}
*
- * @return array api result array
+ * @return array
+ * api result array
* @access public
*/
function civicrm_api3_address_delete($params) {
* @param array $params
* An associative array of name/value pairs.
*
- * @return array details of found addresses else error
+ * @return array
+ * details of found addresses else error
* {@getfields address_get}
* @access public
*/
* Create an attachment
*
* @param array $params
- * @return array of newly created file property values.
+ * @return array
+ * of newly created file property values.
* @access public
* @throws API_Exception validation errors
*/
/**
* @param array $params
- * @return array per APIv3
+ * @return array
+ * per APIv3
* @throws API_Exception validation errors
*/
function civicrm_api3_attachment_get($params) {
/**
* @param array $params
- * @return array (0 => int $id, 1 => array $file, 2 => array $entityFile, 3 => string $name, 4 => string $content, 5 => string $moveFile, 6 => $isTrusted, 7 => bool $returnContent)
+ * @return array
+ * (0 => int $id, 1 => array $file, 2 => array $entityFile, 3 => string $name, 4 => string $content, 5 => string $moveFile, 6 => $isTrusted, 7 => bool $returnContent)
* - array $file: whitelisted fields that can pass through directly to civicrm_file
* - array $entityFile: whitelisted fields that can pass through directly to civicrm_entity_file
* - string $name: the printable name
}
/**
- * @return array list of fields (indexed by name)
+ * @return array
+ * list of fields (indexed by name)
*/
function _civicrm_api3_attachment_getfields() {
$fileFields = CRM_Core_DAO_File::fields();
*
* @param array $params
*
- * @return array of newly created batch property values.
+ * @return array
+ * of newly created batch property values.
* @access public
*/
function civicrm_api3_batch_create($params) {
*
* @param array $params
*
- * @return array of retrieved batch property values.
+ * @return array
+ * of retrieved batch property values.
* @access public
*/
function civicrm_api3_batch_get($params) {
*
* @param array $params
*
- * @return array of deleted values.
+ * @return array
+ * of deleted values.
* @access public
*/
function civicrm_api3_batch_delete($params) {
* (reference) Associative array of property.
* name/value pairs to insert in new 'campaign'
*
- * @return array campaign array
+ * @return array
+ * campaign array
* {@getfields campaign_create}
* @access public
*/
* property_name=>value pairs. If $params is set
* as null, all campaigns will be returned
*
- * @return array Array of matching campaigns
+ * @return array
+ * Array of matching campaigns
* @access public
* {@getfields campaign_get}
*/
* (reference) array containing id of the group.
* to be deleted
*
- * @return array (reference) returns flag true if successful, error
+ * @return array
+ * (reference) returns flag true if successful, error
* message otherwise
* {@getfields campaign_delete}
* @access public
* 'details' => str // html format
*
* @throws API_Exception
- * @return array api result array
+ * @return array
+ * api result array
*
* @access public
* {@getfields case_create}
* {@getfields case_get}
*
* @throws API_Exception
- * @return array (get mode, case_id provided): Array with case details, case roles, case activity ids, (search mode, case_id not provided): Array of cases found
+ * @return array
+ * (get mode, case_id provided): Array with case details, case roles, case activity ids, (search mode, case_id not provided): Array of cases found
* @access public
* @todo Erik Hommel 16 dec 2010 check if all DB fields are returned
*/
/**
* @deprecated api notice
- * @return array of deprecated actions
+ * @return array
+ * of deprecated actions
*/
function _civicrm_api3_case_deprecation() {
return array('activity_create' => 'Case api "activity_create" action is deprecated. Use the activity api instead.');
* 'contact_id' => int // case client
*
* @throws API_Exception
- * @return array api result array
+ * @return array
+ * api result array
*
* @access public
*/
* 'move_to_trash' => bool (defaults to false)
*
* @throws API_Exception
- * @return boolean: true if success, else false
+ * @return boolean
+ * true if success, else false
* {@getfields case_delete}
* @access public
*/
*
* @param $options
*
- * @return array case object
+ * @return array
+ * case object
*/
function _civicrm_api3_case_read($caseId, $options) {
$return = CRM_Utils_Array::value('return', $options, array());
* {@getfields case_type_create}
*
* @throws API_Exception
- * @return array API result array
+ * @return array
+ * API result array
*
* @static void
* @access public
*
* @param array $params
*
- * @return array $caseTypes case types keyed by id
+ * @return array
+ * case types keyed by id
* @access public
*/
function civicrm_api3_case_type_get($params) {
* @param array $params
* Array including id of case_type to delete.
- * @return array API result array
+ * @return array
+ * API result array
*
* @access public
*
/**
* @deprecated api notice
- * @return string to indicate this entire api entity is deprecated
+ * @return string
+ * to indicate this entire api entity is deprecated
*/
function _civicrm_api3_constant_deprecation() {
return 'The constant api is deprecated as of CiviCRM 4.4. Please use the getoptions api action instead.';
* @throws API_Exception
* @example ContactCreate.php Example of Create Call
*
- * @return array API Result Array
+ * @return array
+ * API Result Array
*
* @static void
* @access public
*
* @param array input parameters
*
- * @return array API Result Array
+ * @return array
+ * API Result Array
* (@getfields contact_get}
* @static void
* @access public
* @param array $params
* (reference ) input parameters, contact_id element required.
*
- * @return array API Result Array
+ * @return array
+ * API Result Array
* @access public
*
* @example ContactDelete.php
/**
* @deprecated api notice
- * @return array of deprecated actions
+ * @return array
+ * of deprecated actions
*/
function _civicrm_api3_contact_deprecation() {
return array('getquick' => 'The "getquick" action is deprecated in favor of "getlist".');
* A 'safe' value skips the merge if there are no conflicts. Does a force merge otherwise.}
* {boolean auto_flip wether to let api decide which contact to retain and which to delete.}
*
- * @return array API Result Array
+ * @return array
+ * API Result Array
*
* @static void
* @access public
* (reference) Associative array of property.
* name/value pairs to insert in new 'contact_type'
*
- * @return array contact_type array
+ * @return array
+ * contact_type array
*
* @access public
*/
* property_name=>value pairs. If $params is set
* as null, all contact_types will be returned
*
- * @return array Array of matching contact_types
+ * @return array
+ * Array of matching contact_types
* @access public
*/
function civicrm_api3_contact_type_get($params) {
* Array containing id of the group.
* to be deleted
*
- * @return array API Result Array
+ * @return array
+ * API Result Array
*
* @access public
*/
* (reference ) input parameters.
*
* @throws API_Exception
- * @return array Api result array
+ * @return array
+ * Api result array
* @static void
* @access public
* @example ContributionCreate.php
* @param array $params
* (reference ) input parameters.
*
- * @return boolean true if success, else false
+ * @return boolean
+ * true if success, else false
* @static void
* @access public
* {@getfields Contribution_delete}
* @param array $params
* (reference ) input parameters.
*
- * @return array of contributions, if error an array with an error id and error message
+ * @return array
+ * of contributions, if error an array with an error id and error message
* @static void
* @access public
* {@getfields Contribution_get}
* @param array $params
* (reference ) input parameters.
*
- * @return array (reference ) contribution of created or updated record (or a civicrm error)
+ * @return array
+ * (reference ) contribution of created or updated record (or a civicrm error)
* @static void
* @access public
*
* {@getfields Contribution_sendconfirmation}
*
* @throws Exception
- * @return array Api result array
+ * @return array
+ * Api result array
* @static void
* @access public
*/
* {@getfields Contribution_completetransaction}
*
* @throws API_Exception
- * @return array Api result array
+ * @return array
+ * Api result array
* @static void
* @access public
*/
* name/value pairs to insert in new 'contribution_page'
* @example ContributionPageCreate.php Std Create example
*
- * @return array api result array
+ * @return array
+ * api result array
* {@getfields contribution_page_create}
* @access public
*/
* @param array $params
* Array of one or more valid property_name=>value pairs.
*
- * @return array API Result array Array of matching contribution_pages
+ * @return array
+ * API Result array Array of matching contribution_pages
* {@getfields contribution_page_get}
* @access public
*/
* Array containing id of the group.
* to be deleted
*
- * @return array API result Array
+ * @return array
+ * API result Array
* {@getfields contribution_page_delete}
* @access public
*/
* (reference) array containing id of the group.
* to be deleted
*
- * @return array API result array
+ * @return array
+ * API result array
* {@getfields contribution_page_delete}
* @access public
*/
* name/value pairs to insert in new 'contribution_recur'
* @example ContributionRecurCreate.php Std Create example
*
- * @return array api result array
+ * @return array
+ * api result array
* {@getfields contribution_recur_create}
* @access public
*/
* property_name=>value pairs. If $params is set
* as null, all contribution_recurs will be returned
*
- * @return array API result Array of matching contribution_recurs
+ * @return array
+ * API result Array of matching contribution_recurs
* {@getfields contribution_recur_get}
* @access public
*/
* @param array $params
* (reference) array containing id of the recurring contribution.
*
- * @return boolean returns true is successfully cancelled
+ * @return boolean
+ * returns true is successfully cancelled
*/
function civicrm_api3_contribution_recur_cancel($params) {
* Array containing id of the group.
* to be deleted
*
- * @return array API result array
+ * @return array
+ * API result array
* message otherwise
* {@getfields contribution_recur_delete}
* @access public
*
* @example ContributionSoftCreate.php Standard Create Example //FIXME
*
- * @return array API result array
+ * @return array
+ * API result array
* {@getfields contribution_soft_create}
* @access public
*/
*
* @example ContributionSoftDelete.php Standard Delete Example
*
- * @return boolean | error true if successfull, error otherwise
+ * @return boolean
+ * | error true if successfull, error otherwise
* {@getfields contribution_soft_delete}
* @access public
*/
* @param array $params
* An associative array of name/value pairs.
*
- * @return array api result
+ * @return array
+ * api result
* {@getfields contribution_soft_get}
* @access public
*/
*
* @example CountryCreate.php Standard Create Example
*
- * @return array API result array
+ * @return array
+ * API result array
* {@getfields country_create}
* @access public
*/
*
* @example CountryDelete.php Standard Delete Example
*
- * @return boolean | error true if successfull, error otherwise
+ * @return boolean
+ * | error true if successfull, error otherwise
* {@getfields country_delete}
* @access public
*/
* @param array $params
* An associative array of name/value pairs.
*
- * @return array api result array
+ * @return array
+ * api result array
* {@getfields country_get}
* @access public
*/
* @param array $errors
* Collect validation errors.
*
- * @return array Validation errors
+ * @return array
+ * Validation errors
* @todo remove this function - not in use but need to review functionality before
* removing as it might be useful in wrapper layer
*/
*
* @param array id of the group to be deleted
*
- * @return Null if success
+ * @return Null
+ * if success
* @access public
* {@getfields CustomGroup_delete}
* @example CustomGroupDelete.php
* {@example OptionValueGet.php 0}
* @example OptionValueGet.php
*
- * @return array details of found Option Values
+ * @return array
+ * details of found Option Values
* {@getfields OptionValue_get}
* @access public
*/
*
* @param array $params
*
- * @return array of newly created option_value property values.
+ * @return array
+ * of newly created option_value property values.
* {@getfields OptionValue_create}
* @access public
*/
*
* {@example ReportTemplateDelete.php 0}
*
- * @return array Api result
+ * @return array
+ * Api result
* {@getfields ReportTemplate_create}
* @access public
*/
* If you do not know the ID, you may use group name : field name, for example 'return.foo_stuff:my_field' => 1
*
* @throws API_Exception
- * @return array.
+ * @return array
+ *
*
* @access public
*/
* Array of property name/value.
* pairs for the Dashlet.
*
- * @return array Array containing 'is_error' to denote success or failure and details of the created activity
+ * @return array
+ * Array containing 'is_error' to denote success or failure and details of the created activity
*
*/
function civicrm_api3_dashboard_create($params) {
*
* @param array $params
*
- * @return array API result array
+ * @return array
+ * API result array
* {@getfields email_create}
* @access public
*/
*
* @example EmailDelete.php Standard Delete Example
*
- * @return boolean | error true if successfull, error otherwise
+ * @return boolean
+ * | error true if successfull, error otherwise
* {@getfields email_delete}
* @access public
*/
* @param array $params
* An associative array of name/value pairs.
*
- * @return array api result array
+ * @return array
+ * api result array
* {@getfields email_get}
* @access public
*/
/**
* @deprecated api notice
* @param array entities
- * @return array of deprecated api entities
+ * @return array
+ * of deprecated api entities
*/
function _civicrm_api3_entity_deprecation($entities) {
$deprecated = array();
* @param <type> $params
* @param string $op
*
- * @return array <type>
+ * @return array
+ * <type>
*/
function _civicrm_api3_entity_tag_common($params, $op = 'add') {
* Allowed @params array keys are:
* {@getfields event_create}
*
- * @return array API result Array.
+ * @return array
+ * API result Array.
* @access public
*/
function civicrm_api3_event_create($params) {
* An associative array of name/value property values of civicrm_event.
* {@getfields event_get}
*
- * @return Array of all found event property values.
+ * @return Array
+ * of all found event property values.
* @access public
*
*/
* @param array $paramsArray containing event_id to be deleted.
* Array containing event_id to be deleted.
*
- * @return boolean true if success, error otherwise
+ * @return boolean
+ * true if success, error otherwise
* @access public
* note API has legacy support for 'event_id'
* {@getfields event_delete}
* - keys: mixed; array of string, eg array("com.example.myextension1", "com.example.myextension2") or string with comma-delimited list
* using 'keys' should be more performant than making multiple API calls with 'key'
*
- * @return array API result
+ * @return array
+ * API result
* @static void
* @access public
* @example ExtensionInstall.php
/**
* Upgrade an extension - runs upgrade_N hooks and system.flush
*
- * @return array API result
+ * @return array
+ * API result
* @static void
* @access public
*
* - keys: mixed; array of string, eg array("com.example.myextension1", "com.example.myextension2") or string with comma-delimited list
* using 'keys' should be more performant than making multiple API calls with 'key'
*
- * @return array API result
+ * @return array
+ * API result
* @static void
* @access public
* @example ExtensionEnable.php
* - keys: mixed; array of string, eg array("com.example.myextension1", "com.example.myextension2") or string with comma-delimited list
* using 'keys' should be more performant than making multiple API calls with 'key'
*
- * @return array API result
+ * @return array
+ * API result
* @static void
* @access public
* @example ExtensionDisable.php
* using 'keys' should be more performant than making multiple API calls with 'key'
* - removeFiles: bool, whether to remove source tree; default: FALSE
*
- * @return array API result
+ * @return array
+ * API result
* @static void
* @access public
* @example ExtensionUninstall.php
* - url: string eg "http://repo.com/myextension-1.0.zip"
*
* @throws API_Exception
- * @return array API result
+ * @return array
+ * API result
* @static void
* @access public
* @example ExtensionDownload.php
* - local: bool, whether to rescan local filesystem (default: TRUE)
* - remote: bool, whether to rescan remote repository (default: TRUE)
*
- * @return array API result
+ * @return array
+ * API result
* @static void
* @access public
* @example ExtensionRefresh.php
*
* @param array $params
*
- * @return array API result
+ * @return array
+ * API result
* @static void
* @access public
* @example ExtensionGet.php
*
* @param array $params
* API request params with 'key' or 'keys'.
- * @return array of extension keys
+ * @return array
+ * of extension keys
* @throws API_Exception
*/
function _civicrm_api3_getKeys($params) {
* @param array $params
* An associative array of name/value property values of civicrm_file.
*
- * @return array of newly created file property values.
+ * @return array
+ * of newly created file property values.
* @access public
*/
function civicrm_api3_file_create($params) {
* @param array $params
* An associative array of name/value property values of civicrm_file.
*
- * @return Array of all found file object property values.
+ * @return Array
+ * of all found file object property values.
* @access public
*/
function civicrm_api3_file_get($params) {
* @param array $paramsAn array of name/value property values of civicrm_file.
* An array of name/value property values of civicrm_file.
*
- * @return array of updated file object property values
+ * @return array
+ * of updated file object property values
* @access public
*/
function civicrm_api3_file_update($params) {
*
* @param array $params
*
- * @return array API result array
+ * @return array
+ * API result array
* @access public
*/
function civicrm_api3_file_delete($params) {
*
* @param array $params
*
- * @return array of newly created financial_account property values.
+ * @return array
+ * of newly created financial_account property values.
* @access public
*/
function civicrm_api3_financial_account_create($params) {
*
* @param array $params
*
- * @return array of retrieved financial_account property values.
+ * @return array
+ * of retrieved financial_account property values.
* @access public
*/
function civicrm_api3_financial_account_get($params) {
*
* @param array $params
*
- * @return array of deleted values.
+ * @return array
+ * of deleted values.
* @access public
*/
function civicrm_api3_financial_account_delete($params) {
*
* @param array $params
*
- * @return array of newly created financial_type property values.
+ * @return array
+ * of newly created financial_type property values.
* @access public
*/
function civicrm_api3_financial_type_create($params) {
*
* @param array $params
*
- * @return array of retrieved financial_type property values.
+ * @return array
+ * of retrieved financial_type property values.
* @access public
*/
function civicrm_api3_financial_type_get($params) {
*
* @param array $params
*
- * @return array of deleted values.
+ * @return array
+ * of deleted values.
* @access public
*/
function civicrm_api3_financial_type_delete($params) {
* - version: string
* - function: callback (mixed)
* - params: array, varies
- * @return array API success object
+ * @return array
+ * API success object
*/
function civicrm_api3_generic_getfields($apiRequest) {
static $results = array();
* Api request as an array. Keys are.
*
* @throws API_Exception
- * @return integer count of results
+ * @return integer
+ * count of results
*/
function civicrm_api3_generic_getcount($apiRequest) {
$apiRequest['params']['options']['is_count'] = TRUE;
* @param array $apiRequest
* Api request as an array. Keys are.
*
- * @return integer count of results
+ * @return integer
+ * count of results
*/
function civicrm_api3_generic_getsingle($apiRequest) {
// so the first entity is always result['values'][0]
* @param array $apiRequest
* Api request as an array. Keys are.
*
- * @return integer count of results
+ * @return integer
+ * count of results
*/
function civicrm_api3_generic_getvalue($apiRequest) {
$apiRequest['params']['sequential'] = 1;
* Api request as an array.
*
* @throws API_Exception
- * @return array API result (int 0 or 1)
+ * @return array
+ * API result (int 0 or 1)
*/
function civicrm_api3_generic_getrefcount($apiRequest) {
$entityToClassMap = CRM_Core_DAO_AllCoreTables::daoToClass();
* @param array $apiRequest
* Api request as an array. Keys are.
*
- * @return integer count of results
+ * @return integer
+ * count of results
*/
function civicrm_api3_generic_replace($apiRequest) {
return _civicrm_api3_generic_replace($apiRequest['entity'], $apiRequest['params']);
* @param array $apiRequest
* Api request as an array.
*
- * @return array of results
+ * @return array
+ * of results
*/
function civicrm_api3_generic_getoptions($apiRequest) {
// Resolve aliases
* Associative array of property.
* name/value pairs to insert in new 'grant'
*
- * @return array grant array
+ * @return array
+ * grant array
* {@getfields grant_create}
* @access public
*/
* property_name=>value pairs. If $params is set
* as null, all grants will be returned
*
- * @return array Array of matching grants
+ * @return array
+ * Array of matching grants
* {@getfields grant_get}
* @access public
*/
* Array containing id of the group.
* to be deleted
*
- * @return array API Result Array
+ * @return array
+ * API Result Array
* {@getfields grant_delete}
* @access public
*/
* Associative array of property.
* name/value pairs to insert in new 'group'
*
- * @return array API result array
+ * @return array
+ * API result array
* @example GroupCreate.php
* {@getfields group_create}
* @access public
* property_name=>value pairs. If $params is set
* as null, all groups will be returned
*
- * @return array Array of matching groups
+ * @return array
+ * Array of matching groups
* @example GroupGet.php
* {@getfields group_get}
* @access public
* Array containing id of the group.
* to be deleted
*
- * @return array API result array
+ * @return array
+ * API result array
* @example GroupDelete.php
* {@getfields group_delete}
*
* Name value pair of contact information.
* {@getfields GroupContact_get}
*
- * @return array list of groups, given contact subsribed to
+ * @return array
+ * list of groups, given contact subsribed to
*/
function civicrm_api3_group_contact_get($params) {
* "status" (optional) : one of "Added", "Pending" or "Removed" (default is "Added")
* {@example GroupContactCreate.php 0}
*
- * @return array Information about operation results
+ * @return array
+ * Information about operation results
*
* On success, the return array will be structured as follows:
* <code>array(
*
* @param <type> $params
*
- * @return array <type>
+ * @return array
+ * <type>
* @deprecated
*/
function civicrm_api3_group_contact_delete($params) {
/**
* @deprecated api notice
- * @return array of deprecated actions
+ * @return array
+ * of deprecated actions
*/
function _civicrm_api3_group_contact_deprecation() {
return array(
* An array containing at least child_group_id or parent_group_id.
* {@getfields GroupNesting_get}
*
- * @return array list of group nesting records
+ * @return array
+ * list of group nesting records
*/
function civicrm_api3_group_nesting_get($params) {
* @param array $params
* Parameters array - allowed array keys include:.
*
- * @return array TBD
+ * @return array
+ * TBD
* {@getfields GroupNesting_create
* @todo Work out the return value.
*/
* Parameters array - allowed array keys include:.
* {@getfields GroupNesting_delete}
*
- * @return array API Success or fail array
+ * @return array
+ * API Success or fail array
*
* @todo Work out the return value.
*/
* {@getfields GroupOrganization_get}
* @example GroupOrganizationGet.php
*
- * @return array list of groups, given contact subsribed to
+ * @return array
+ * list of groups, given contact subsribed to
*/
function civicrm_api3_group_organization_get($params) {
return _civicrm_api3_basic_get('CRM_Contact_DAO_GroupOrganization', $params);
* @param array $params
* With 'id' = ID of the Group Organization to be deleted.
*
- * @return array API Result
+ * @return array
+ * API Result
* {@getfields GroupOrganization_delete}
* @example GroupOrganizationDelete.php
* @access public
*
* @param array $params
*
- * @return array of newly created IM property values.
+ * @return array
+ * of newly created IM property values.
* @access public
*/
function civicrm_api3_im_create($params) {
* @param array $params
* {@getfields im_delete}
*
- * @return array API result Array
+ * @return array
+ * API result Array
* @access public
* @todo convert to using Basic delete - BAO function non standard
*/
* @param array $params
* An associative array of name/value pairs.
*
- * @return array details of found IM
+ * @return array
+ * details of found IM
*
* @access public
*/
/**
* Retrieve one or more job
* @param array input parameters
- * @return array api result array
+ * @return array
+ * api result array
* {@getfields email_get}
* @access public
*/
*
* @param array $params
*
- * @return array API Result Array
+ * @return array
+ * API Result Array
* {@getfields Job_delete}
* @static void
* @access public
* @param array $params
* (reference ) input parameters.
*
- * @return array API Result Array
+ * @return array
+ * API Result Array
*
* @static void
* @access public
* @param array $params
* (reference ) input parameters.
*
- * @return array API Result Array
+ * @return array
+ * API Result Array
* {@getfields contact_geocode}
*
* @static void
* now - the time to use, in YmdHis format
* - makes testing a bit simpler since we can simulate past/future time
*
- * @return boolean true if success, else false
+ * @return boolean
+ * true if success, else false
* @static void
* @access public
*
* instanceId - Integer - the report instance ID
* resetVal - Integer - should we reset form state (always true)?
*
- * @return boolean true if success, else false
+ * @return boolean
+ * true if success, else false
* @static void
* @access public
*
*
* @param array $params
*
- * @return boolean true if success, else false
+ * @return boolean
+ * true if success, else false
* @static
* @access public
*/
* @param array $params
* (reference ) input parameters.
*
- * @return boolean true if success, else false
+ * @return boolean
+ * true if success, else false
* @static
* @access public
*
* @param array $params
* (reference ) input parameters.
*
- * @return array (reference ) array of properties, if error an array with an error id and error message
+ * @return array
+ * (reference ) array of properties, if error an array with an error id and error message
* @access public
*/
function civicrm_api3_job_process_participant($params) {
* @param array $params
* Input parameters NOT USED.
*
- * @return boolean true if success, else false
+ * @return boolean
+ * true if success, else false
* @static void
* @access public
*/
* @param array $params
* (reference ) input parameters.
*
- * @return boolean true if success, else false
+ * @return boolean
+ * true if success, else false
* @static void
* @access public
*/
* A 'safe' value skips the merge if there are no conflicts. Does a force merge otherwise.}
* {boolean auto_flip wether to let api decide which contact to retain and which to delete.}
*
- * @return array API Result Array
+ * @return array
+ * API Result Array
*
* @static void
* @access public
* @param array $params
* (reference ) - sends in various config parameters to decide what needs to be cleaned.
*
- * @return boolean true if success, else false
+ * @return boolean
+ * true if success, else false
* @static void
* @access public
*/
* name/value pairs to insert in new 'line_item'
* @example LineItemCreate.php Std Create example
*
- * @return array api result array
+ * @return array
+ * api result array
* {@getfields line_item_create}
* @access public
*/
* Array of one or more valid property_name=>value pairs. If $params is set.
* as null, all line_items will be returned (default limit is 25)
*
- * @return array Array of matching line_items
+ * @return array
+ * Array of matching line_items
* {@getfields line_item_get}
* @access public
*/
* Array containing id of the group.
* to be deleted
*
- * @return array API result array
+ * @return array
+ * API result array
* {@getfields line_item_delete}
* @access public
*/
* name/value pairs to insert in new 'loc_block'
* @example LocBlockCreate.php Std Create example
*
- * @return array api result array
+ * @return array
+ * api result array
* {@getfields loc_block_create}
* @access public
*/
* Array of one or more valid property_name=>value pairs. If $params is set.
* as null, all loc_blocks will be returned (default limit is 25)
*
- * @return array Array of matching loc_blocks
+ * @return array
+ * Array of matching loc_blocks
* {@getfields loc_block_get}
* @access public
*/
* @param array $params
* Array containing id of the record to be deleted.
*
- * @return array API result array
+ * @return array
+ * API result array
* {@getfields loc_block_delete}
* @access public
*/
*
* @param array $params
*
- * @return array API result array
+ * @return array
+ * API result array
* {@getfields email_create}
* @access public
*/
*
* @example LocationTypeDelete.php Standard Delete Example
*
- * @return array API result array
+ * @return array
+ * API result array
* {@getfields LocationType_delete}
* @access public
*/
* @param array $params
* An associative array of name/value pairs.
*
- * @return array api result
+ * @return array
+ * api result
* {@getfields LocationType_get}
* @access public
*/
* name/value pairs to insert in new 'mail_settings'
* @example mail_settingsCreate.php Std Create example
*
- * @return array api result array
+ * @return array
+ * api result array
* {@getfields mail_settings_create}
* @access public
*/
* property_name=>value pairs. If $params is set
* as null, all mail_settings will be returned
*
- * @return array Array of matching mail_settings
+ * @return array
+ * Array of matching mail_settings
* {@getfields mail_settings_get}
* @access public
*/
* Array containing id of the group.
* to be deleted
*
- * @return array api result array
+ * @return array
+ * api result array
* {@getfields mail_settings_delete}
* @access public
*/
* @param array $params
* @param array $ids
*
- * @return array API Success Array
+ * @return array
+ * API Success Array
*/
function civicrm_api3_mailing_create($params, $ids = array()) {
if (CRM_Mailing_Info::workflowEnabled()) {
* @param array $params
* @param array $ids
*
- * @return array API Success Array
+ * @return array
+ * API Success Array
*/
function civicrm_api3_mailing_delete($params, $ids = array()) {
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
/**
* @deprecated api notice
- * @return array of deprecated actions
+ * @return array
+ * of deprecated actions
*/
function _civicrm_api3_mailing_deprecation() {
return array('event_confirm' => 'Mailing api "event_confirm" action is deprecated. Use the mailing_event_confirm api instead.');
* @param array $params
* @param array $ids
*
- * @return array API Success Array
+ * @return array
+ * API Success Array
*/
function civicrm_api3_mailing_a_b_create($params) {
return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
* @param array $params
* @param array $ids
*
- * @return array API Success Array
+ * @return array
+ * API Success Array
*/
function civicrm_api3_mailing_a_b_delete($params) {
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
* @param array $params
*
* @throws API_Exception
- * @return array of newly created mailing_component property values.
+ * @return array
+ * of newly created mailing_component property values.
* @access public
*/
function civicrm_api3_mailing_component_create($params) {
*
* @param array $params
*
- * @return array of retrieved mailing_component property values.
+ * @return array
+ * of retrieved mailing_component property values.
* @access public
*/
function civicrm_api3_mailing_component_get($params) {
* @param array $params
*
* @throws API_Exception
- * @return array of deleted values.
+ * @return array
+ * of deleted values.
* @access public
*/
function civicrm_api3_mailing_component_delete($params) {
* - key: type, value: Delivered | Bounced - optional, defaults to Delivered
* - Future extensions will include: Opened, Clicked, Forwarded
*
- * @return array API result
+ * @return array
+ * API result
* @static void
* @access public
* @example CRM/Mailing/BAO/Mailing.php
* - key: type, value: Delivered | Bounced - optional, defaults to Delivered
* - Future extensions will include: Opened, Clicked, Forwarded
*
- * @return array API result
+ * @return array
+ * API result
* @static void
* @access public
* @example CRM/Mailing/BAO/Mailing.php
* name/value pairs to insert in new 'survey'
*
* @throws Exception
- * @return array api result array
+ * @return array
+ * api result array
* {@getfields mailing_event_confirm_create}
* @access public
*/
* name/value pairs to insert in new 'survey'
*
* @throws Exception
- * @return array api result array
+ * @return array
+ * api result array
* {@getfields mailing_event_confirm_create}
* @access public
*/
* Associative array of property.
* name/value pairs to insert in new 'survey'
*
- * @return array api result array
+ * @return array
+ * api result array
* {@getfields mailing_event_subscribe_create}
* @access public
*/
* name/value pairs to insert in new 'survey'
*
* @throws API_Exception
- * @return array api result array
+ * @return array
+ * api result array
* {@getfields mailing_event_subscribe_create}
* @access public
*/
* Associative array of property.
* name/value pairs to insert in new 'survey'
*
- * @return array api result array
+ * @return array
+ * api result array
* {@getfields mailing_event_unsubscribe_create}
* @access public
*/
/**
* @deprecated api notice
- * @return string to indicate this entire api entity is deprecated
+ * @return string
+ * to indicate this entire api entity is deprecated
*/
function _civicrm_api3_mailing_group_deprecation() {
return 'The mailing_group api is deprecated. Use the mailing_event apis instead.';
* Array of one or more valid.
* @param array $ids
*
- * @return array API return Array of matching mailing jobs
+ * @return array
+ * API return Array of matching mailing jobs
* {@getfields mailing_job_get}
* @access public
*/
* Array of one or more valid.
* @param array $ids
*
- * @return array API return Array of matching mailing jobs
+ * @return array
+ * API return Array of matching mailing jobs
* {@getfields mailing_recipient_get}
* @access public
*/
* @param $params
* Array array holding id - Id of the contact membership to be deleted.
*
- * @return array api result
+ * @return array
+ * api result
* {@getfields membership_delete}
* @access public
*/
* @param array $params
* An associative array of name/value property values of civicrm_membership.
*
- * @return array of newly created membership property values.
+ * @return array
+ * of newly created membership property values.
* {@getfields membership_create}
* @access public
*/
* options affecting the desired results; has legacy support
* for just passing the contact_id itself as the argument
*
- * @return Array of all found membership property values.
+ * @return Array
+ * of all found membership property values.
* @access public
* @todo needs some love - basically only a get for a given contact right now
* {@getfields membership_get}
* @param int $membershipTypeId
* @param $activeOnly
*
- * @return array result for calling function
+ * @return array
+ * result for calling function
*/
function _civicrm_api3_membership_get_customv2behaviour(&$params, $membershipTypeId, $activeOnly) {
// get the membership for the given contact ID
* @param $membershipValues
* @param int $contactID
*
- * @return array result for calling function
+ * @return array
+ * result for calling function
*/
function _civicrm_api3_membership_relationsship_get_customv2behaviour(&$params, $membershipValues, $contactID) {
$relationships = array();
* @param array $params
* An associative array of name/value property values of civicrm_membership_block.
*
- * @return array $result newly created or updated membership type property values.
+ * @return array
+ * newly created or updated membership type property values.
* @access public
* {getfields MembershipBlock_get}
*/
* An associative array of name/value property values of civicrm_membership_block.
* {getfields MembershipBlock_get}
*
- * @return array api result array of all found membership block property values.
+ * @return array
+ * api result array of all found membership block property values.
* @access public
*/
function civicrm_api3_membership_block_get($params) {
*
* @param array $params
*
- * @return array api result array
+ * @return array
+ * api result array
* @access public
* {getfields MembershipBlock_delete}
*/
* @param array $params
* (reference ) input parameters.
*
- * @return array (reference ) membership_payment_id of created or updated record
+ * @return array
+ * (reference ) membership_payment_id of created or updated record
* {@getfields MembershipPayment_create}
* @example MembershipPaymentCreate.php
* @access public
* @param array $params
* Input parameters.
*
- * @return array array of properties, if error an array with an error id and error message
+ * @return array
+ * array of properties, if error an array with an error id and error message
* @example MembershipPaymentGet
* {@getfields MembershipPayment_get}
* @access public
* @param array $params
* An associative array of name/value property values of civicrm_membership_status.
*
- * @return array of newly created membership status property values.
+ * @return array
+ * of newly created membership status property values.
* {@getfields MembershipStatus_create}
* @access public
*/
* @param array $params
* An associative array of name/value property values of civicrm_membership_status.
*
- * @return Array of all found membership status property values.
+ * @return Array
+ * of all found membership status property values.
* {@getfields MembershipStatus_get}
* @access public
*/
* An associative array of name/value property values of civicrm_membership_status.
* @deprecated - should just use create
*
- * @return array of updated membership status property values
+ * @return array
+ * of updated membership status property values
* @access public
*/
function &civicrm_api3_membership_status_update($params) {
* @param array Params array containing 'id' - Id of the membership status to be deleted
* {@getfields MembershipStatus_delete}
*
- * @return array i
+ * @return array
+ * i
* @access public
*/
function civicrm_api3_membership_status_delete($params) {
*
* @throws API_Exception
*
- * @return Array Array of status id and status name
+ * @return Array
+ * Array of status id and status name
* @public
*/
function civicrm_api3_membership_status_calc($membershipParams) {
* @param array $params
* An associative array of name/value property values of civicrm_membership_type.
*
- * @return array $result newly created or updated membership type property values.
+ * @return array
+ * newly created or updated membership type property values.
* @access public
* {getfields MembershipType_get}
*/
* An associative array of name/value property values of civicrm_membership_type.
* {getfields MembershipType_get}
*
- * @return Array of all found membership type property values.
+ * @return Array
+ * of all found membership type property values.
* @access public
*/
function civicrm_api3_membership_type_get($params) {
*
* @param array $params
*
- * @return boolean true if success, else false
+ * @return boolean
+ * true if success, else false
* @access public
* {getfields MembershipType_delete}
*/
/**
* @param array $params
*
- * @return boolean | error true if successfull, error otherwise
+ * @return boolean
+ * | error true if successfull, error otherwise
* {@getfields message_template_delete}
* @access public
*/
* @param array $params
* An associative array of name/value pairs.
*
- * @return array api result array
+ * @return array
+ * api result array
* {@getfields message_template_get}
* @access public
*/
* An associative array of name/value property values of civicrm_note.
* {@getfields note_create}
*
- * @return array API result array
+ * @return array
+ * API result array
* @access public
* @example NoteCreate.php Create example
*
* @param array $params
* Input parameters.
*
- * @return array array of properties,
+ * @return array
+ * array of properties,
* if error an array with an error id and error message
* {@getfields note_get}
* @static void
* @param array $params
* Associative array; only required 'id' parameter is used.
*
- * @return array Nested associative array beginning with direct children of given note.
+ * @return array
+ * Nested associative array beginning with direct children of given note.
*/
function &civicrm_api3_note_tree_get($params) {
* (reference) Associative array of property.
* name/value pairs to insert in new 'survey'
*
- * @return array survey array
+ * @return array
+ * survey array
*
* @access public
*/
* Array containing id of the group.
* to be deleted
*
- * @return array API Result Array
+ * @return array
+ * API Result Array
* message otherwise
* {@getfields OptionGroup_delete}
* @access public
* {@example OptionValueGet.php 0}
* @example OptionValueGet.php
*
- * @return array details of found Option Values
+ * @return array
+ * details of found Option Values
* {@getfields OptionValue_get}
* @access public
*/
* @param array $params
*
* @throws API_Exception
- * @return array of newly created option_value property values.
+ * @return array
+ * of newly created option_value property values.
* {@getfields OptionValue_create}
* @access public
*/
*
* {@example OptionValueDelete.php 0}
*
- * @return array Api result
+ * @return array
+ * Api result
* {@getfields OptionValue_create}
* @access public
*/
* @param array $params
* An associative array of name/value property values of civicrm_participant.
*
- * @return array apiresult
+ * @return array
+ * apiresult
* {@getfields participant_create}
* @access public
*/
* @param array $params
* (reference ) input parameters.
*
- * @return array (reference ) array of properties, if error an array with an error id and error message
+ * @return array
+ * (reference ) array of properties, if error an array with an error id and error message
* {@getfields participant_get}
* @access public
*/
* @example ParticipantPaymentCreate.php
* {@example ParticipantPaymentCreate.php 0}
*
- * @return array of newly created payment property values.
+ * @return array
+ * of newly created payment property values.
* {@getfields ParticipantPayment_create}
* @access public
*/
*
* @param array $params
*
- * @return array API result
+ * @return array
+ * API result
* @example ParticipantPaymentDelete.php
* {@getfields ParticipantPayment_delete}
* @access public
* @param array $params
* Input parameters.
*
- * @return array array of properties, if error an array with an error id and error message
+ * @return array
+ * array of properties, if error an array with an error id and error message
* @example ParticipantPaymentGet
* {@getfields ParticipantPayment_get}
* @access public
* Associative array of property.
* name/value pairs to insert in new 'participant_status'
*
- * @return array participant_status array
+ * @return array
+ * participant_status array
* {@getfields ParticipantStatusType_create}
* @example ParticipantStatusTypeCreate.php
* @access public
* property_name=>value pairs. If $params is set
* as null, all participant_statuses will be returned
*
- * @return array Array of matching participant_statuses
+ * @return array
+ * Array of matching participant_statuses
* {@getfields ParticipantStatusType_get}
* @example ParticipantStatusTypeGet.php
* @access public
* (reference) array containing id of the group.
* to be deleted
*
- * @return array api result array
+ * @return array
+ * api result array
* {@getfields ParticipantStatusType_delete}
* @example ParticipantStatusTypeDelete.php
* @access public
*
* @param array $params
*
- * @return array of newly created PaymentProcessor property values.
+ * @return array
+ * of newly created PaymentProcessor property values.
* @access public
*/
function civicrm_api3_payment_processor_create($params) {
* @param array $params
* {@getfields payment_processor_delete}
*
- * @return array API result Array
+ * @return array
+ * API result Array
* @access public
*/
function civicrm_api3_payment_processor_delete($params) {
* @param array $params
* An associative array of name/value pairs.
*
- * @return array details of found PaymentProcessor
+ * @return array
+ * details of found PaymentProcessor
* @access public
*/
function civicrm_api3_payment_processor_get($params) {
*
* @param id of payment_processor type $id
*
- * @return array API Result Array
+ * @return array
+ * API Result Array
* {@getfields PaymentProcessorType_delete}
* @static void
* @access public
*
* @param array $params
*
- * @return array of newly created phone property values.
+ * @return array
+ * of newly created phone property values.
* @access public
*/
function civicrm_api3_phone_create($params) {
*
* @param array $params
*
- * @return array Api Result
+ * @return array
+ * Api Result
* {@getfields phone_delete}
* @example PhoneDelete.php
* @access public
* @param array $params
* An associative array of name/value pairs.
*
- * @return array details of found phones else error
+ * @return array
+ * details of found phones else error
* @access public
* This function has been declared there instead than in api/v3/Phone.php for no specific reasons, beside to demonstrate this feature (that might be useful in your module, eg if you want to implement a civicrm_api ('Phone','Dial') that you would then simply put in your module under api/v3/Phone/Dial.php .
*/
* pairs for the activity.
* {@getfields pledge_create}
*
- * @return array Array containing 'is_error' to denote success or failure and details of the created pledge
+ * @return array
+ * Array containing 'is_error' to denote success or failure and details of the created pledge
*
* @example PledgeCreate.php Standard create example
*
* @param array $params
* Array included 'pledge_id' of pledge to delete.
*
- * @return boolean true if success, else false
+ * @return boolean
+ * true if success, else false
* @static void
* {@getfields pledge_delete}
* @example PledgeDelete.php
* @param array $params
* Input parameters. Use interrogate for possible fields.
*
- * @return array array of pledges, if error an array with an error id and error message
+ * @return array
+ * array of pledges, if error an array with an error id and error message
* {@getfields pledge_get}
* @example PledgeGet.php
* @access public
* {@getfields PledgePayment_create}
* @example PledgePaymentCreate.php
*
- * @return array API Result
+ * @return array
+ * API Result
* @static void
* @access public
*/
* {@getfields PledgePayment_delete}
* @example PledgePaymentDelete.php
*
- * @return array API result
+ * @return array
+ * API result
* @static void
* @access public
*/
* {@getfields PledgePayment_get}
* @example PledgePaymentGet.php *
*
- * @return array (reference ) array of pledges, if error an array with an error id and error message
+ * @return array
+ * (reference ) array of pledges, if error an array with an error id and error message
* @static void
* @access public
*/
*
* @param array $params
*
- * @return array fields valid for other functions
+ * @return array
+ * fields valid for other functions
*/
function civicrm_api3_pledge_payment_get_spec(&$params) {
$params['option.create_new'] = array('title' => "Create new field rather than update an unpaid payment");
* @param array $params
*
* @throws API_Exception
- * @return array of newly created premium property values.
+ * @return array
+ * of newly created premium property values.
* @access public
*/
function civicrm_api3_premium_create($params) {
*
* @param array $params
*
- * @return array of retrieved premium property values.
+ * @return array
+ * of retrieved premium property values.
* @access public
*/
function civicrm_api3_premium_get($params) {
* @param array $params
*
* @throws API_Exception
- * @return array of deleted values.
+ * @return array
+ * of deleted values.
* @access public
*/
function civicrm_api3_premium_delete($params) {
* name/value pairs to insert in new 'price_field'
* @example PriceFieldCreate.php Std Create example
*
- * @return array api result array
+ * @return array
+ * api result array
* {@getfields price_field_create}
* @access public
*/
* Array of one or more valid property_name=>value pairs. If $params is set.
* as null, all price_fields will be returned (default limit is 25)
*
- * @return array Array of matching price_fields
+ * @return array
+ * Array of matching price_fields
* {@getfields price_field_get}
* @access public
*/
* Array containing id of the group.
* to be deleted
*
- * @return array API result array
+ * @return array
+ * API result array
* {@getfields price_field_delete}
* @access public
*/
* name/value pairs to insert in new 'price_field_value'
* @example PriceFieldValueCreate.php Std Create example
*
- * @return array api result array
+ * @return array
+ * api result array
* {@getfields price_field_value_create}
* @access public
*/
* Array of one or more valid property_name=>value pairs. If $params is set.
* as null, all price_field_values will be returned (default limit is 25)
*
- * @return array Array of matching price_field_values
+ * @return array
+ * Array of matching price_field_values
* {@getfields price_field_value_get}
* @access public
*/
* Array containing id of the group.
* to be deleted
*
- * @return array API result array
+ * @return array
+ * API result array
* {@getfields price_field_value_delete}
* @access public
*/
* name/value pairs to insert in new 'price_set'
* @example PriceSetCreate.php Std Create example
*
- * @return array api result array
+ * @return array
+ * api result array
* {@getfields price_set_create}
* @access public
*/
* Array of one or more valid property_name=>value pairs. If $params is set.
* as null, all price_sets will be returned (default limit is 25)
*
- * @return array Array of matching price_sets
+ * @return array
+ * Array of matching price_sets
* {@getfields price_set_get}
* @access public
*/
* Array containing id of the group.
* to be deleted
*
- * @return array API result array
+ * @return array
+ * API result array
* {@getfields price_set_delete}
* @access public
*/
*
* @param array $params
*
- * @return array of newly created print_label property values.
+ * @return array
+ * of newly created print_label property values.
* @access public
*/
function civicrm_api3_print_label_create($params) {
*
* @param array $params
*
- * @return array of retrieved print_label property values.
+ * @return array
+ * of retrieved print_label property values.
* @access public
*/
function civicrm_api3_print_label_get($params) {
*
* @param array $params
*
- * @return array of deleted values.
+ * @return array
+ * of deleted values.
* @access public
*/
function civicrm_api3_print_label_delete($params) {
* @param array $params
*
* @throws API_Exception
- * @return array of newly created product property values.
+ * @return array
+ * of newly created product property values.
* @access public
*/
function civicrm_api3_product_create($params) {
*
* @param array $params
*
- * @return array of retrieved product property values.
+ * @return array
+ * of retrieved product property values.
* @access public
*/
function civicrm_api3_product_get($params) {
* @param array $params
*
* @throws API_Exception
- * @return array of deleted values.
+ * @return array
+ * of deleted values.
* @access public
*/
function civicrm_api3_product_delete($params) {
* @param array $params
*
* @throws API_Exception
- * @return array API result array
+ * @return array
+ * API result array
*/
function civicrm_api3_profile_submit($params) {
$profileID = _civicrm_api3_profile_getProfileID($params['profile_id']);
* @param string $fieldName
* API field name.
*
- * @return string BAO Field Name
+ * @return string
+ * BAO Field Name
*/
function _civicrm_api3_profile_translate_fieldnames_for_bao($fieldName) {
$fieldName = str_replace('url', 'URL', $fieldName);
* Associative array of property name/value.
* pairs to update profile field values
*
- * @return array Updated Contact/ Activity object|CRM_Error
+ * @return array
+ * Updated Contact/ Activity object|CRM_Error
*
*
*/
/**
* @deprecated api notice
- * @return array of deprecated actions
+ * @return array
+ * of deprecated actions
*/
function _civicrm_api3_profile_deprecation() {
return array(
* @throws API_Exception
* @example RelationshipCreate.php Std Create example
*
- * @return array API Result Array
+ * @return array
+ * API Result Array
* {@getfields relationship_create}
* @static void
* @access public
*
* @param array $params
*
- * @return array API Result Array
+ * @return array
+ * API Result Array
* {@getfields relationship_delete}
* @example RelationshipDelete.php Delete Example
*
* - if you pass in contact_id - it just returns all relationships for 'contact_id'
* - if you don't pass in contact_id then it does a filter on the relationship table (DAO based search)
*
- * @return Array API Result Array
+ * @return Array
+ * API Result Array
* {@getfields relationship_get}
* @example RelationshipGet.php
* @access public
*
* @param id of relationship type $id
*
- * @return array API Result Array
+ * @return array
+ * API Result Array
* {@getfields RelationshipType_delete}
* @static void
* @access public
* @param array $params
* Input parameters.
*
- * @return array details of found instances
+ * @return array
+ * details of found instances
* @access public
*/
function civicrm_api3_report_instance_get($params) {
*
* @param array $params
*
- * @return array of newly created report instance property values.
+ * @return array
+ * of newly created report instance property values.
* @access public
*/
function civicrm_api3_report_instance_create($params) {
*
* @param array $params
*
- * @return array Api result
+ * @return array
+ * Api result
* @access public
*/
function civicrm_api3_report_instance_delete($params) {
* {@example OptionValueGet.php 0}
* @example OptionValueGet.php
*
- * @return array details of found Option Values
+ * @return array
+ * details of found Option Values
* {@getfields OptionValue_get}
* @access public
*/
*
* @param array $params
*
- * @return array of newly created option_value property values.
+ * @return array
+ * of newly created option_value property values.
* {@getfields OptionValue_create}
* @access public
*/
*
* {@example ReportTemplateDelete.php 0}
*
- * @return array Api result
+ * @return array
+ * Api result
* {@getfields ReportTemplate_create}
* @access public
*/
* @param array $params
* Input parameters.
*
- * @return array details of found instances
+ * @return array
+ * details of found instances
* @access public
*/
function civicrm_api3_report_template_getrows($params) {
* @param array $params
* Input parameters.
*
- * @return array details of found instances
+ * @return array
+ * details of found instances
* @access public
*/
function _civicrm_api3_report_template_getrows_spec(&$params) {
* name/value pairs + other vars as applicable - see getfields for more
* @example SettingCreate.php Std Create example
*
- * @return array api result array
+ * @return array
+ * api result array
* {@getfields setting_create}
* @access public
*/
* Array of one or more valid.
* property_name=>value pairs.
*
- * @return array Array of matching settings
+ * @return array
+ * Array of matching settings
* {@getfields setting_get}
* @access public
*/
* (reference) Array of one or more valid.
* property_name=>value pairs.
*
- * @return array Array of matching settings
+ * @return array
+ * Array of matching settings
* {@getfields setting_get}
* @access public
*/
*
* @param array $params
*
- * @return array of newly created sms_provider property values.
+ * @return array
+ * of newly created sms_provider property values.
* @access public
*/
function civicrm_api3_sms_provider_create($params) {
*
* @param array $params
*
- * @return array of retrieved sms_provider property values.
+ * @return array
+ * of retrieved sms_provider property values.
* @access public
*/
function civicrm_api3_sms_provider_get($params) {
*
* @param array $params
*
- * @return array of deleted values.
+ * @return array
+ * of deleted values.
* @access public
*/
function civicrm_api3_sms_provider_delete($params) {
* name/value pairs to insert in new 'survey'
* @example SurveyCreate.php Std Create example
*
- * @return array api result array
+ * @return array
+ * api result array
* {@getfields survey_create}
* @access public
*/
* property_name=>value pairs. If $params is set
* as null, all surveys will be returned
*
- * @return array API result Array of matching surveys
+ * @return array
+ * API result Array of matching surveys
* {@getfields survey_get}
* @access public
*/
* Array containing id of the group.
* to be deleted
*
- * @return array api result array
+ * @return array
+ * api result array
* {@getfields survey_delete}
* @access public
*/
/**
* @deprecated api notice
- * @return string to indicate this entire api entity is deprecated
+ * @return string
+ * to indicate this entire api entity is deprecated
*/
function _civicrm_api3_survey_respondant_deprecation() {
return 'The survey_respondant api is not currently supported.';
* @param array $params
* (reference ) input parameters.
*
- * @return array (reference ) contribution_id of created or updated record
+ * @return array
+ * (reference ) contribution_id of created or updated record
* @static void
* @access public
* @deprecated - api currently not supported
* - triggers: bool, whether to drop/create SQL triggers; default: FALSE
* - session: bool, whether to reset the CiviCRM session data; defaul: FALSE
*
- * @return boolean true if success, else false
+ * @return boolean
+ * true if success, else false
* @static void
* @access public
* @example SystemFlush.php
* System.Check API
*
* @param array $params
- * @return array API result descriptor; return items are alert codes/messages
+ * @return array
+ * API result descriptor; return items are alert codes/messages
* @see civicrm_api3_create_success
* @see civicrm_api3_create_error
* @throws API_Exception
*
* @param array $params
*
- * @return array of newly created tag property values.
+ * @return array
+ * of newly created tag property values.
* {@getfields tag_create}
* @access public
*/
*
* @example TagDelete.ph
*
- * @return array API result array
+ * @return array
+ * API result array
* {@getfields tag_delete}
* @access public
*/
* @param array $params
* An associative array of name/value pairs.
*
- * @return array details of found tags else error
+ * @return array
+ * details of found tags else error
* {@getfields tag_get}
* @access public
*/
*
* @throws API_Exception
*
- * @return array Newly created $ufFieldArray
+ * @return array
+ * Newly created $ufFieldArray
*
* @access public
* {@getfields UFField_create}
*
* @param array $params
*
- * @return array fields valid for other functions
+ * @return array
+ * fields valid for other functions
*/
function _civicrm_api3_uf_field_create_spec(&$params) {
$params['option.autoweight'] = array(
* property_name=>value pairs. If $params is set
* as null, all surveys will be returned
*
- * @return array (reference) Array
+ * @return array
+ * (reference) Array
* {@getfields UFField_get
* @example UFFieldGet.php
* @access public
* @param $params
* Array Associative array of property name/value pairs to insert in group.
*
- * @return array API result array
+ * @return array
+ * API result array
* {@getfields UFGroup_create}
* @example UFGroupCreate.php
* @access public
* property_name=>value pairs. If $params is set
* as null, all surveys will be returned
*
- * @return array Array of matching profiles
+ * @return array
+ * Array of matching profiles
* {@getfields UFGroup_get}
* @example UFGroupGet.php
* @access public
* @param array $params
* Assoc array of name/value pairs.
*
- * @return array CRM_Core_DAO_UFJoin Array
+ * @return array
+ * CRM_Core_DAO_UFJoin Array
* @access public
* @example UFJoinCreate.php
* {@getfields UFJoin_create}
* @param array $params
* (reference) an assoc array of name/value pairs.
*
- * @return array $result CiviCRM Result Array or null
+ * @return array
+ * CiviCRM Result Array or null
* @todo Delete function missing
* @access public
* {getfields UFJoin_get}
*
* @param array $params
*
- * @return array $result
+ * @return array
* @access public
* {@getfields UFMatch_get}
* @example UFMatchGet.php
* name/value pairs to insert in new 'survey'
* @example UFMatch.php Std Create example
*
- * @return array api result array
+ * @return array
+ * api result array
* {@getfields uf_match_create}
* @access public
*/
* name/value pairs to insert in new 'survey'
* @example UFMatch.php Std Create example
*
- * @return array api result array
+ * @return array
+ * api result array
* {@getfields uf_match_create}
* @access public
*/
*
* @param array $params
*
- * @return array of newly created website property values.
+ * @return array
+ * of newly created website property values.
* @access public
* @todo convert to using basic create - BAO function non-std
*/
* {@getfields website_delete}
* @example WebsiteDelete.php Std Delete Example
*
- * @return array API result Array
+ * @return array
+ * API result Array
* @access public
* @todo convert to using Basic delete - BAO function non standard
*/
* @param array $params
* An associative array of name/value pairs.
*
- * @return array details of found websites
+ * @return array
+ * details of found websites
*
* @access public
*/
* Array containing id of the word_replacement.
* to be deleted
*
- * @return array api result array
+ * @return array
+ * api result array
*
* @access public
*/
* @param array $keyoptions
* List of required fields options. One of the options is required.
*
- * @return null or throws error if there the required fields not present
+ * @return null
+ * or throws error if there the required fields not present
* @
*/
function civicrm_api3_verify_one_mandatory($params, $daoName = NULL, $keyoptions = array()) {
* @param bool $verifyDAO
*
* @throws API_Exception
- * @return null or throws error if there the required fields not present
+ * @return null
+ * or throws error if there the required fields not present
*
* @todo see notes on _civicrm_api3_check_required_fields regarding removing $daoName param
*/
* @param array $data
*
* @throws API_Exception
- * @return array <type>
+ * @return array
+ * <type>
*/
function civicrm_api3_create_error($msg, $data = array()) {
$data['is_error'] = 1;
* Additional values to be added to top level of result array(.
* - this param is currently used for legacy behaviour support
*
- * @return array $result
+ * @return array
*/
function civicrm_api3_create_success($values = 1, $params = array(), $entity = NULL, $action = NULL, &$dao = NULL, $extraReturnValues = array()) {
$result = array();
* @param array $params
* @param array $values
*
- * @return Bool $valueFound
+ * @return Bool
*/
function _civicrm_api3_store_values(&$fields, &$params, &$values) {
$valueFound = FALSE;
* @param string $action
*
* @throws API_Exception
- * @return array $options options extracted from params
+ * @return array
+ * options extracted from params
*/
function _civicrm_api3_get_options_from_params(&$params, $queryObject = FALSE, $entity = '', $action = '') {
$is_count = FALSE;
* @param string $bao_name
* @param array $params
*
- * @return array API result array
+ * @return array
+ * API result array
* @throws API_Exception
*/
function _civicrm_api3_basic_delete($bao_name, &$params) {
* @param array $params
* Assoc array of input parameters for this transaction.
*
- * @return array the result in an nice formatted array (or an error object)
+ * @return array
+ * the result in an nice formatted array (or an error object)
* @abstract
*/
function doDirectPayment(&$params) {
/**
* @param array $fields
* List of fields to include in the profile.
- * @return int field id
+ * @return int
+ * field id
*/
protected function createUFGroup($fields) {
$ufGroup = CRM_Core_DAO::createTestObject('CRM_Core_DAO_UFGroup');
/**
* Get PaymentExpress IPN for a single transaction
- * @return array array representing a Paypal IPN POST
+ * @return array
+ * array representing a Paypal IPN POST
*/
public function getPaypalExpressTransactionIPN() {
return array(
/**
* Get IPN results from follow on IPN transactions
- * @return array array representing a Paypal IPN POST
+ * @return array
+ * array representing a Paypal IPN POST
*/
public function getSubsequentPaypalExpressTransaction() {
return array(
class CRM_Core_Permission_BaseTest extends CiviUnitTestCase {
/**
- * @return array (0 => input to translatePermission, 1 => expected output from translatePermission)
+ * @return array
+ * (0 => input to translatePermission, 1 => expected output from translatePermission)
*/
public function translateData() {
$cases = array();
class CRM_Core_Permission_GenericTest extends CiviUnitTestCase {
/**
- * @return array of CRM_Core_Permission_Base
+ * @return array
+ * of CRM_Core_Permission_Base
*/
public function permissionClasses() {
$cases = array();
class CRM_Core_Permission_JoomlaTest extends CiviUnitTestCase {
/**
- * @return array (0 => input to translatePermission, 1 => expected output from translatePermission)
+ * @return array
+ * (0 => input to translatePermission, 1 => expected output from translatePermission)
*/
public function translateData() {
$cases = array();
* 'sql-insert'|'bao-create' how to add the example record.
* @param string $outcome
* 'rollback'|'implicit-commit'|'explicit-commit' how to finish transaction.
- * @return int cid
+ * @return int
+ * cid
*/
public function createContactWithTransaction($nesting, $insert, $outcome) {
if ($nesting != 'reuse-tx' && $nesting != 'nest-tx') {
* See assertContactsMix.
* @param string $outcome
* 'rollback'|'implicit-commit'|'explicit-commit' how to finish transaction.
- * @return int cid
+ * @return int
+ * cid
*/
public function runBatch($nesting, $callbacks, $existsByOffset, $outcome) {
if ($nesting != 'reuse-tx' && $nesting != 'nest-tx') {
}
/**
- * @return array (localVersion, versionInfo, expectedResult)
+ * @return array
+ * (localVersion, versionInfo, expectedResult)
*/
public function newerVersionDataProvider() {
$data = array();
}
/**
- * @return array (localVersion, versionInfo, expectedResult)
+ * @return array
+ * (localVersion, versionInfo, expectedResult)
*/
public function securityUpdateDataProvider() {
$data = array();
* @param int $id
* Id of the PayPal Pro payment processor.
* to be deleted
- * @return boolean true if payment processor deleted, false otherwise
+ * @return boolean
+ * true if payment processor deleted, false otherwise
*
*/
public function delete($id) {
* @param string $field
* Selector.
* @param string $contactType
- * @return array of contact attributes (id, names, email)
+ * @return array
+ * of contact attributes (id, names, email)
*/
public function createDialogContact($field = 'contact_id', $contactType = 'Individual') {
$selectId = 's2id_' . $this->getAttribute($field . '@id');
* @url string url to parse or retrieve current url if null
*
* @param null $url
- * @return array returns an associative array containing any of the various components
+ * @return array
+ * returns an associative array containing any of the various components
* of the URL that are present. Querystring elements are returned in sub-array (elements.queryString)
* http://php.net/manual/en/function.parse-url.php
*/
* @param bool $membershipsRequired
* @internal param \can $User define pageTitle, hash and rand values for later data verification
*
- * @return null $pageId of newly created online contribution page.
+ * @return null
+ * of newly created online contribution page.
*/
function webtestAddContributionPage(
$hash = NULL,
/**
* @param bool $perClass
* @param null $object
- * @return bool TRUE if the populate logic runs; FALSE if it is skipped
+ * @return bool
+ * TRUE if the populate logic runs; FALSE if it is skipped
*/
protected static function _populateDB($perClass = FALSE, &$object = NULL) {
* so the distinction between set
* up & tested functions is clearer
*
- * @return array api Result
+ * @return array
+ * api Result
*/
public function createTestEntity() {
return $entity = $this->callAPISuccess($this->entity, 'create', $this->params);
* @param array parameters for civicrm_contact_add api function call
* @param int sequence number if creating multiple organizations
*
- * @return int id of Organisation created
+ * @return int
+ * id of Organisation created
*/
public function organizationCreate($params = array(), $seq = 0) {
if (!$params) {
* @param array parameters for civicrm_contact_add api function call
* @param int sequence number if creating multiple individuals
*
- * @return int id of Individual created
+ * @return int
+ * id of Individual created
*/
public function individualCreate($params = array(), $seq = 0) {
$params = array_merge($this->sampleContact('Individual', $seq), $params);
* @param array parameters for civicrm_contact_add api function call
* @param int sequence number if creating multiple households
*
- * @return int id of Household created
+ * @return int
+ * id of Household created
*/
public function householdCreate($params = array(), $seq = 0) {
$params = array_merge($this->sampleContact('Household', $seq), $params);
* @param enum contact type: Individual, Organization
* @param int sequence number for the values of this type
*
- * @return array properties of sample contact (ie. $params for API call)
+ * @return array
+ * properties of sample contact (ie. $params for API call)
*/
public function sampleContact($contact_type, $seq = 0) {
$samples = array(
*
* @throws Exception
*
- * @return int id of Household created
+ * @return int
+ * id of Household created
*/
private function _contactCreate($params) {
$result = $this->callAPISuccess('contact', 'create', $params);
* @param array $params
* Array of contact id and event id values.
*
- * @return int $id of participant created
+ * @return int
+ * $id of participant created
*/
public function participantCreate($params) {
if (empty($params['contact_id'])) {
/**
* Create Payment Processor
*
- * @return object of Payment Processsor
+ * @return object
+ * of Payment Processsor
*/
public function processorCreate() {
$processorParams = array(
* Create contribution page
*
* @param array $params
- * @return object of contribution page
+ * @return object
+ * of contribution page
*/
public function contributionPageCreate($params) {
$this->_pageParams = array(
* Create Tag
*
* @param array $params
- * @return array result of created tag
+ * @return array
+ * result of created tag
*/
public function tagCreate($params = array()) {
$defaults = array(
* @param int $cID
* Contact_id.
*
- * @return int id of created contribution
+ * @return int
+ * id of created contribution
*/
public function pledgeCreate($cID) {
$params = array(
* @param int $trxnID
* @param int $paymentInstrumentID
* @param bool $isFee
- * @return int id of created contribution
+ * @return int
+ * id of created contribution
*/
public function contributionCreate($cID, $cTypeID = 1, $invoiceID = 67890, $trxnID = 12345, $paymentInstrumentID = 1, $isFee = TRUE) {
$params = array(
*
* @param int $invoiceID
* @param int $trxnID
- * @return int id of created contribution
+ * @return int
+ * id of created contribution
*/
public function onlineContributionCreate($params, $financialType, $invoiceID = 67890, $trxnID = 12345) {
$contribParams = array(
* @param array $params
* Name-value pair for an event.
*
- * @return array $event
+ * @return array
*/
public function eventCreate($params = array()) {
// if no contact was passed, make up a dummy event creator
*
* @param int $participantID
* @param int $contributionID
- * @return int $id of created payment
+ * @return int
+ * $id of created payment
*/
public function participantPaymentCreate($participantID, $contributionID = NULL) {
//Create Participant Payment record With Values
* Add a Location
*
* @param int $contactID
- * @return int location id of created location
+ * @return int
+ * location id of created location
*/
public function locationAdd($contactID) {
$address = array(
* Add a Group
*
* @param array $params
- * @return int groupId of created group
+ * @return int
+ * groupId of created group
*/
public function groupCreate($params = array()) {
$params = array_merge(array(
* @params array to add group
*
* @param array $params
- * @return int groupId of created group
+ * @return int
+ * groupId of created group
*/
public function groupContactCreate($groupID, $totalCount = 10) {
$params = array('group_id' => $groupID);
* Add a UF Join Entry
*
* @param array $params
- * @return int $id of created UF Join
+ * @return int
+ * $id of created UF Join
*/
public function ufjoinCreate($params = NULL) {
if ($params === NULL) {
* @param string $filename
* $file __FILE__.
*
- * @return array $ids ids of created objects
+ * @return array
+ * ids of created objects
*/
public function entityCustomGroupWithSingleFieldCreate($function, $filename) {
$params = array('title' => $function);
* Create note
*
* @param int $cId
- * @return array $note
+ * @return array
*/
public function noteCreate($cId) {
$params = array(
* Generate a temporary folder
*
* @param string $prefix
- * @return string $string
+ * @return string
*/
public function createTempDir($prefix = 'test-') {
$tempDir = CRM_Utils_File::tempdir($prefix);
*
* @param array $params
*
- * @return int $contactID id of created contact
+ * @return int
+ * $contactID id of created contact
*/
public static function create($params) {
require_once "CRM/Contact/BAO/Contact.php";
* a contact of type Individual
*
* @param array $params
- * @return int $contactID id of created Individual
+ * @return int
+ * $contactID id of created Individual
*/
public static function createIndividual($params = NULL) {
//compose the params, when not passed
*
* @param int $contactID
* Id of the contact to delete.
- * @return boolean true if contact deleted, false otherwise
+ * @return boolean
+ * true if contact deleted, false otherwise
*/
public static function delete($contactID) {
require_once 'CRM/Contact/BAO/Contact.php';
* @param int $contributionPageId
* Id of the Contribution Page.
* to be deleted
- * @return boolean true if Contribution Page deleted, false otherwise
+ * @return boolean
+ * true if Contribution Page deleted, false otherwise
*/
public static function delete($contributionPageId) {
require_once "CRM/Contribute/DAO/ContributionPage.php";
* @param null $extends
* @param bool $isMultiple
*
- * @return object of created group
+ * @return object
+ * of created group
*/
public static function createGroup($group, $extends = NULL, $isMultiple = FALSE) {
if (empty($group)) {
* @deprecated use parent object create fn
* @param array $params
* @param null $fields
- * @return object of created field
+ * @return object
+ * of created field
*/
public static function createField($params, $fields = NULL) {
if (empty($params)) {
* Helper function to delete custom group
* @deprecated use function on parent class
* @param object Custom Group to delete
- * @return boolean true if Group deleted, false otherwise
+ * @return boolean
+ * true if Group deleted, false otherwise
*/
public static function deleteGroup($params) {
require_once 'CRM/Core/BAO/CustomGroup.php';
* Helper function to delete an Event
*
* @param int $eventId
- * @return boolean true if event deleted, false otherwise
+ * @return boolean
+ * true if event deleted, false otherwise
*/
public static function delete($eventId) {
return CRM_Event_BAO_Event::del($eventId);
* @param int $contributionPageId
* Id of the Contribution Page.
* to be deleted
- * @return array of created pcp block
+ * @return array
+ * of created pcp block
*
*/
public function create($contributionPageId) {
* @param array key value pair
* pcpBlockId - id of the PCP Block Id, profileID - id of Supporter Profile
* to be deleted
- * @return boolean true if success, false otherwise
+ * @return boolean
+ * true if success, false otherwise
*
*/
public function delete($params) {
* Helper function to delete a participant
*
* @param int $participantId
- * @return boolean true if participant deleted, false otherwise
+ * @return boolean
+ * true if participant deleted, false otherwise
*/
public static function delete($participantId) {
require_once 'CRM/Event/BAO/Participant.php';
* Helper function to create
* a payment processor of type Paypal Pro
*
- * @return int $paymentProcessor id of created payment processor@todo this appears not to be working but because it doesn't extend the test class
+ * @return int
+ * $paymentProcessor id of created payment processor@todo this appears not to be working but because it doesn't extend the test class
* callAPISuccess won't work
* I have duplicated this on the main test class as a work around
*/
* @param int $id
* Id of the PayPal Pro payment processor.
* to be deleted
- * @return boolean true if payment processor deleted, false otherwise
+ * @return boolean
+ * true if payment processor deleted, false otherwise
*/
public static function delete($id) {
$pp = new CRM_Financial_DAO_PaymentProcessor();
}
/**
- * @return array of contact details
+ * @return array
+ * of contact details
*/
public function _testOfflineContribution() {
// Create a contact to be used as soft creditor
* @param string $downloadDir
* Download dir.
*
- * @return string downloaded file path.
+ * @return string
+ * downloaded file path.
*/
public function downloadCSV($selector, $fileName = 'CiviCRM_Contact_Search.csv', $downloadDir = '/tmp') {
// File download path.
* @param string $component
* Component name.
*
- * @return string import url
+ * @return string
+ * import url
*/
private function _getImportComponentUrl($component) {
$importComponentUrl = array(
* @param array $rows
* @param string $contactType
*
- * @return array $contactIds imported contact ids
+ * @return array
+ * imported contact ids
*/
public function _getImportedContactIds($rows, $contactType = 'Individual') {
$contactIds = array();
* @param string $lastName
* @param int $externalId
*
- * @return int external id
+ * @return int
+ * external id
*/
public function _addContact($firstName, $lastName, $externalId) {
$this->openCiviPage('contact/add', 'reset=1&ct=Individual');
*
* @param array $params
*
- * @return array event details of newly created event
+ * @return array
+ * event details of newly created event
*/
public function _addNewEvent($params = array()) {
if (empty($params)) {
* @param array $params
* Parameters to create an event.
*
- * @return array $params event details of newly created event
+ * @return array
+ * event details of newly created event
*/
public function _addNewEvent($params = array()) {
/**
* Get all the files in the API directory for the relevant version which contain API functions
- * @return array $files array of php files in the directory excluding helper files
+ * @return array
+ * array of php files in the directory excluding helper files
*/
public function getAllFilesinAPIDir() {
$files = array();
/**
* Get all api exposed functions that are expected to conform to standards
- * @return array $functionlist
+ * @return array
*/
public function getAllAPIStdFunctions() {
$functionlist = get_defined_functions();
*
* @param bool $sequential
*
- * @return array Entities that cannot be retrieved by ID
+ * @return array
+ * Entities that cannot be retrieved by ID
*/
public static function toBeSkipped_getByID($sequential = FALSE) {
return array('MailingContact');
/**
* Generate list of entities to test for get by id functions
* @param bool $sequential
- * @return array Entities to be skipped
+ * @return array
+ * Entities to be skipped
*/
public static function toBeSkipped_automock($sequential = FALSE) {
$entitiesWithoutGet = array('MailingContact', 'EntityTag', 'Participant', 'ParticipantPayment', 'Setting', 'SurveyRespondant', 'MailingRecipients', 'CustomSearch', 'Extension', 'ReportTemplate', 'System');
*
* @throws API_Exception
* @throws Exception
- * @return bool TRUE or FALSE depending on the outcome of the authorization check
+ * @return bool
+ * TRUE or FALSE depending on the outcome of the authorization check
*/
public function runPermissionCheck($entity, $action, $params, $throws = FALSE) {
$dispatcher = new \Symfony\Component\EventDispatcher\EventDispatcher();
projects / civicrm-core.git / commitdiff