* @param bool $appendDatesToTitle
* @param bool $forceAll
*
- * @return mixed $campaigns a set of campaigns.@access public
+ * @return mixed $campaigns a set of campaigns.
+ * @access public
*/
public static function getCampaigns(
$includeId = NULL,
* @param int $interviewerId
* @param array $statusIds
*
- * @return array $activityDetails array of survey activity.@static
+ * @return array $activityDetails array of survey activity.
+ * @static
*/
static function voterActivityDetails(
$surveyId, $voterIds, $interviewerId = NULL,
* @param null $statusIds
* @param null $voterIds
* @param bool $onlyCount
- * @return array $activities an array of survey activity.@static
+ * @return array $activities an array of survey activity.
+ * @static
*/
static function getSurveyActivities(
$surveyId,
* This function retrieve all option groups which are created as a result set
*
* @param string $valueColumnName
- * @return array $resultSets an array of option groups.@static
+ * @return array $resultSets an array of option groups.
+ * @static
*/
public static function getResultSets($valueColumnName = 'title') {
$resultSets = array();
*
* @param int $surveyId
* Survey id.
- * @return array $responseOptions an array of option values@static
+ * @return array $responseOptions an array of option values
+ * @static
*/
public static function getResponsesOptions($surveyId) {
$responseOptions = array();
* @param int $surveyId
* @param bool $enclosedInUL
* @param string $extraULName
- * @return array|string $url array of permissioned links@static
+ * @return array|string $url array of permissioned links
+ * @static
*/
public static function buildPermissionLinks($surveyId, $enclosedInUL = FALSE, $extraULName = 'more') {
$menuLinks = array();
* @param int $file
* Email sent.
*
- * @return array|void $activity object of newly creted activity via email@access public
+ * @return array|void $activity object of newly creted activity via email
+ * @access public
*/
public static function recordActivityViaEmail($file) {
if (!file_exists($file) ||
* @param array $returnProperties
* Array of return elements.
*
- * @return array $contactDetails array of contact info.@static
+ * @return array $contactDetails array of contact info.
+ * @static
*/
public static function contactDetails($componentIds, $componentName, $returnProperties = array()) {
$contactDetails = array();
* @param array $addresses
* Associated array of.
*
- * @return array $contactNames associated array of contact names@static
+ * @return array $contactNames associated array of contact names
+ * @static
*/
public static function getAddressShareContactNames(&$addresses) {
$contactNames = array();
* @param int $groupOrganizationID
* Group organization id that needs to be deleted.
*
- * @return mixed|null $results no of deleted group organization on success, false otherwise@access public
+ * @return mixed|null $results no of deleted group organization on success, false otherwise
+ * @access public
*/
public static function deleteGroupOrganization($groupOrganizationID) {
$results = NULL;
* @param $contactIds
* Contact Ids.
*
- * @return array $currentEmployer array of the current employer@static
+ * @return array $currentEmployer array of the current employer
+ * @static
*/
public static function getCurrentEmployer($contactIds) {
$contacts = implode(',', $contactIds);
* @param int $contactId
* Contact id if doing update.
*
- * @return bool $primaryID email/openId@static
+ * @return bool $primaryID email/openId
+ * @static
*/
public static function formRule($fields, &$errors, $contactId = NULL) {
$config = CRM_Core_Config::singleton();
* @param array $params
* of key value consist of address blocks.
*
- * @return array $parseSuccess as array of sucess/fails for each address block@static
+ * @return array $parseSuccess as array of sucess/fails for each address block
+ * @static
*/
public function parseAddress(&$params) {
$parseSuccess = $parsedFields = array();
* @param array $parseResult
* An array of address blk instance and its status.
*
- * @return null|string $statusMsg string status message for all address blocks.@static
+ * @return null|string $statusMsg string status message for all address blocks.
+ * @static
*/
public static function parseAddressStatusMsg($parseResult) {
$statusMsg = NULL;
* Unused.
* @param int $contactID
*
- * @return array|bool $error@static
+ * @return array|bool $error
+ * @static
*/
public static function formRule($fields, $files, $contactID = NULL) {
$errors = array();
* @param array $errors
* List of errors to be posted back to the form.
*
- * @return array $errors@static
+ * @return array $errors
+ * @static
*/
public static function formRule($fields, $errors) {
$hasData = $hasPrimary = $errors = array();
* @param array $errors
* List of errors to be posted back to the form.
*
- * @return array $errors@static
+ * @return array $errors
+ * @static
*/
public static function formRule($fields, $errors) {
$hasData = $hasPrimary = $errors = array();
* @param array $errors
* List of errors to be posted back to the form.
*
- * @return array $errors@static
+ * @return array $errors
+ * @static
*/
public static function formRule($fields, $errors) {
$hasData = $hasPrimary = $errors = array();
* @param array $errors
* List of errors to be posted back to the form.
*
- * @return array $errors@static
+ * @return array $errors
+ * @static
*/
public static function formRule($fields, $errors) {
$hasData = $hasPrimary = $errors = array();
*
* @param int $id
*
- * @return mixed|null $results no of deleted Contribution on success, false otherwise@access public
+ * @return mixed|null $results no of deleted Contribution on success, false otherwise
+ * @access public
* @static
*/
public static function deleteContribution($id) {
* for inactive fields : CRM-5369
*
*
- * @return mixed $customOptionGroup@static
+ * @return mixed $customOptionGroup
+ * @static
*/
public static function &customOptionGroup($includeFieldIds = NULL) {
static $customOptionGroup = NULL;
* @param int $smartGroupId
* Smart group id.
*
- * @return array $returnFields associated array of elements@static
+ * @return array $returnFields associated array of elements
+ * @static
*/
public static function getFormattedFields($smartGroupId) {
$returnFields = array();
* @param int $customfieldId
* Related file id.
*
- * @return null|string $customGroupName all custom group names@static
+ * @return null|string $customGroupName all custom group names
+ * @static
*/
public static function getCustomGroupName($customfieldId) {
if ($customFieldId = CRM_Core_BAO_CustomField::getKeyID($customfieldId)) {
* Row no of the fields.
*
*
- * @return array $returnFields formatted associated array of elements@static
+ * @return array $returnFields formatted associated array of elements
+ * @static
*/
public static function formattedFields(&$params, $row = FALSE) {
$fields = array();
* @param int $menuID
* Menu id.
*
- * @return int $weight string@static
+ * @return int $weight string
+ * @static
*/
public static function calculateWeight($parentID = NULL, $menuID = NULL) {
$domainID = CRM_Core_Config::domainID();
* @param bool $showStatus
* Do we need to set status or not.
*
- * @return mixed|NULL $return no of deleted notes on success, FALSE otherwise@access public
+ * @return mixed|NULL $return no of deleted notes on success, FALSE otherwise
+ * @access public
* @static
*/
public static function del($id, $showStatus = TRUE) {
/**
* Get the tags that are not children of a tagset.
*
- * @return array $tags associated array of tag name and id@access public
+ * @return array $tags associated array of tag name and id
+ * @access public
* @static
*/
public static function getTagsNotInTagset() {
* @param $fields
* @param $defaults
*
- * @return mixed $defaults@static
+ * @return mixed $defaults
+ * @static
*/
public static function setRegisterDefaults(&$fields, &$defaults) {
$config = CRM_Core_Config::singleton();
* @param array $hide
* Initial value of hide array.
*
- * @return \CRM_Core_ShowHideBlocks the newly created object@access public
+ * @return \CRM_Core_ShowHideBlocks the newly created object
+ * @access public
*/
public function __construct($show = NULL, $hide = NULL) {
if (!empty($show)) {
*
* @param array $params
*
- * @return array (rule field => weight) array and threshold associated to rule group@access public
+ * @return array (rule field => weight) array and threshold associated to rule group
+ * @access public
*/
public static function dedupeRuleFieldsWeight($params) {
$rgBao = new CRM_Dedupe_BAO_RuleGroup();
* @param bool $returnWaitingCount
* @param bool $considerTestParticipant
*
- * @return bool|int|null|string 1. false => If event having some empty spaces.@static
+ * @return bool|int|null|string 1. false => If event having some empty spaces.
+ * @static
*/
static function eventFull(
$eventId,
*
* @param bool $isForward
*
- * @return array (reference) array array ref that hold array refs to the verp info, urls, and headers@access private
+ * @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) {
$config = CRM_Core_Config::singleton();
*
* @param bool $isSMS
*
- * @return array $report array content/component.@access public
+ * @return array $report array content/component.
+ * @access public
*/
public static function getMailingContent(&$report, &$form, $isSMS = FALSE) {
$htmlHeader = $textHeader = NULL;
*
* @param int $id
*
- * @return mixed $results no of deleted Instance on success, false otherwise@access public
+ * @return mixed $results no of deleted Instance on success, false otherwise
+ * @access public
*/
public static function del($id = NULL) {
$dao = new CRM_Report_DAO_ReportInstance();
* @internal param \csvString $string the title of the link to be displayed for the export
* @internal param \perPage $int the number of items displayed per page
*
- * @return \CRM_Utils_Pager the newly created and initialized pager object@access public
+ * @return \CRM_Utils_Pager the newly created and initialized pager object
+ * @access public
*/
public function __construct($params) {
if ($params['status'] === NULL) {
* @param string $string
* The input string to parse for tokens.
*
- * @return array $tokens array of tokens mentioned in field@access public
+ * @return array $tokens array of tokens mentioned in field
+ * @access public
* @static
*/
public static function getTokens($string) {
* {@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@access public
+ * @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
*/
function civicrm_api3_case_get($params) {
*
* @param <type> $params
*
- * @return array <type>@deprecated
+ * @return array <type>
+ * @deprecated
*/
function civicrm_api3_group_contact_delete($params) {
$params['status'] = CRM_Utils_Array::value('status', $params, empty($params['skip_undelete']) ? 'Removed' : 'Deleted');
*
* @param <type> $params
*
- * @return array|int <type>@deprecated
+ * @return array|int <type>
+ * @deprecated
*/
function civicrm_api3_group_contact_pending($params) {
$params['status'] = 'Pending';