/**
* Returns total number of rows for the query.
*
- * @param
+ * @param string $action
*
* @return int
* Total number of rows
}
/**
- * @param array <String,SimpleXMLElement> $xml
+ * Class constructor.
+ *
+ * @param array $allCaseTypes
+ * @param array $xml
*/
public function __construct($allCaseTypes = NULL, $xml = array()) {
$this->allCaseTypes = $allCaseTypes;
}
/**
+ * Retrieve case.
+ *
* @param string $caseType
- * @return SimpleXMLElement|FALSE
+ *
+ * @return FALSE|\SimpleXMLElement
+ * @throws \CRM_Core_Exception
*/
public function retrieve($caseType) {
// check if xml definition is defined in db
}
/**
+ * Retrieve file.
+ *
* @param string $caseType
* @return SimpleXMLElement|FALSE
*/
}
/**
+ * Find xml file.
+ *
* @param string $caseType
* @return null|string
* file path
}
/**
- * Given an id, extract the formValues of the saved search
+ * Given an id, extract the formValues of the saved search.
*
* @param int $id
* The id of the saved search.
}
/**
+ * Get search parameters.
+ *
* @param int $id
*
* @return array
}
/**
+ * Contact IDS Sql (whatever that means!).
+ *
* @param int $id
*
* @return string
}
/**
+ * Get from where email (whatever that means!).
+ *
* @param int $id
*
* @return array
}
/**
- * Given a saved search compute the clause and the tables
- * and store it for future use
+ * Given a saved search compute the clause and the tables and store it for future use.
*/
public function buildClause() {
$fv = unserialize($this->form_values);
}
}
+ /**
+ * Save the search.
+ *
+ * @param bool $hook
+ */
public function save($hook = TRUE) {
// first build the computed fields
$this->buildClause();
/**
* Given a label and a set of normalized POST
* formValues, create a smart group with that
+ *
+ * @param array $params
+ *
+ * @return \CRM_Contact_DAO_SavedSearch
*/
public static function create(&$params) {
$savedSearch = new CRM_Contact_DAO_SavedSearch();
return $savedSearch;
}
+ /**
+ * Assign test value.
+ *
+ * @param string $fieldName
+ * @param array $fieldDef
+ * @param int $counter
+ */
protected function assignTestValue($fieldName, &$fieldDef, $counter) {
if ($fieldName == 'form_values') {
// A dummy value for form_values.
/**
* Construct the search query.
+ *
+ * @param int $offset
+ * @param int $rowcount
+ * @param null $sort
+ * @param bool $includeContactIDs
+ * @param bool $justIDs
+ *
+ * @return string
*/
public function all(
$offset = 0, $rowcount = 0, $sort = NULL,
/**
* Construct the search query.
+ *
+ * @param int $offset
+ * @param int $rowcount
+ * @param string $sort
+ * @param bool $includeContactIDs
+ * @param bool $onlyIDs
+ *
+ * @return string
*/
public function all(
$offset = 0, $rowcount = 0, $sort = NULL,
/**
* Class constructor.
+ *
+ * @param array $mapperKeys
+ * @param int $mapperLocType
+ * @param int $mapperPhoneType
+ * @param int $mapperImProvider
+ * @param int $mapperRelated
+ * @param int $mapperRelatedContactType
+ * @param array $mapperRelatedContactDetails
+ * @param int $mapperRelatedContactLocType
+ * @param int $mapperRelatedContactPhoneType
+ * @param int $mapperRelatedContactImProvider
+ * @param int $mapperWebsiteType
+ * @param int $mapperRelatedContactWebsiteType
*/
public function __construct(
&$mapperKeys, $mapperLocType = NULL, $mapperPhoneType = NULL, $mapperImProvider = NULL, $mapperRelated = NULL, $mapperRelatedContactType = NULL, $mapperRelatedContactDetails = NULL, $mapperRelatedContactLocType = NULL, $mapperRelatedContactPhoneType = NULL, $mapperRelatedContactImProvider = NULL,
}
/**
- * The initializer code, called before the processing
+ * The initializer code, called before the processing.
*/
public function init() {
$contactFields = CRM_Contact_BAO_Contact::importableFields($this->_contactType);
/**
* Method for creating contact.
+ *
+ * @param array $formatted
+ * @param array $contactFields
+ * @param int $onDuplicate
+ * @param int $contactId
+ * @param bool $requiredCheck
+ * @param int $dedupeRuleGroupID
+ *
+ * @return array|bool|\CRM_Contact_BAO_Contact|\CRM_Core_Error|null
*/
public function createContact(&$formatted, &$contactFields, $onDuplicate, $contactId = NULL, $requiredCheck = TRUE, $dedupeRuleGroupID = NULL) {
$dupeCheck = FALSE;
/**
* Carry out batch merges.
+ *
+ * @param \CRM_Queue_TaskContext $ctx
+ * @param int $rgid
+ * @param int $gid
+ * @param string $mode
+ * @param bool $autoFlip
+ * @param int $batchLimit
+ * @param int $isSelected
+ *
+ * @return int
*/
public static function callBatchMerge(CRM_Queue_TaskContext $ctx, $rgid, $gid = NULL, $mode = 'safe', $autoFlip = TRUE, $batchLimit = 1, $isSelected = 2) {
$result = CRM_Dedupe_Merger::batchMerge($rgid, $gid, $mode, $autoFlip, $batchLimit, $isSelected);
/**
* Returns total number of rows for the query.
*
- * @param
+ * @param int $action
*
* @return int
* Total number of rows
}
/**
- * @param $dao
- * @return string|NULL
+ * Pick SMS phone number.
+ *
+ * @param int $smsToContactId
+ *
+ * @return NULL|string
*/
protected static function pickSmsPhoneNumber($smsToContactId) {
$toPhoneNumbers = CRM_Core_BAO_Phone::allPhones($smsToContactId, FALSE, 'Mobile', array(
/**
* Get contact tags.
+ *
+ * @param int $contactID
+ * @param bool $count
+ *
+ * @return array
*/
public static function getContactTags($contactID, $count = FALSE) {
$contactTags = array();
* @param string $orderBy
* @param null $orderProfiles
*
+ * @param bool $eventProfile
+ *
* @return array
- * the fields that belong to this ufgroup(s)
+ * The fields that belong to this ufgroup(s)
+ * @throws \Exception
*/
public static function getFields(
$id,
/**
* Check if running in upgrade mode.
+ *
+ * @param string $path
+ *
+ * @return bool
*/
public static function isUpgradeMode($path = NULL) {
if (defined('CIVICRM_UPGRADE_ACTIVE')) {
* @param array $entities
* @param bool $default
* //CRM-15427.
+ * @param string $usedFor
*/
public function addProfileSelector($name, $label, $allowCoreTypes, $allowSubTypes, $entities, $default = FALSE, $usedFor = NULL) {
// Output widget
/**
* Function that will add date and time.
+ *
+ * @param string $name
+ * @param string $label
+ * @param bool $required
+ * @param null $attributes
*/
public function addDateTime($name, $label, $required = FALSE, $attributes = NULL) {
$addTime = array('addTime' => TRUE);
/**
* Add currency element to the form.
+ *
+ * @param string $name
+ * @param null $label
+ * @param bool $required
+ * @param string $defaultCurrency
+ * @param bool $freezeCurrency
*/
public function addCurrency(
$name = 'currency',
/**
* Process the form submission.
+ *
+ * @param array $params
+ * @param string $type
+ * @param array $linkedEntities
+ *
+ * @throws \CiviCRM_API3_Exception
*/
public static function postProcess($params = array(), $type, $linkedEntities = array()) {
//Check entity_id not present in params take it from class variable
/**
* This function fetches the menu items from xml and xmlMenu hooks.
*
- * @param boolen $fetchFromXML
+ * @param boolean $fetchFromXML
* Fetch the menu items from xml and not from cache.
*
* @return array
*
* Function is from Authorize.Net sample code, and used to avoid using
* PHP5 XML functions
+ *
+ * @param string $haystack
+ * @param string $start
+ * @param string $end
+ *
+ * @return bool|string
*/
public function _substring_between(&$haystack, $start, $end) {
if (strpos($haystack, $start) === FALSE || strpos($haystack, $end) === FALSE) {
}
/**
+ * Map fields from params array.
+ *
* This function is set up and put here to make the mapping of fields
- * from the params object as visually clear as possible for easy editing
+ * as visually clear as possible for easy editing
*
* Comment out irrelevant fields
+ *
+ * @param array $params
+ *
+ * @return array
*/
public function mapProcessorFieldstoParams($params) {
/*concatenate full customer name first - code from EWAY gateway
/**
* This function sends request and receives response from
* the processor
+ *
+ * @param array $params
+ *
+ * @return array|object
+ * @throws \Exception
*/
public function doDirectPayment(&$params) {
if ($params['is_recur'] == TRUE) {
- CRM_Core_Error::fatal(ts('%1 - recurring payments not implemented', array(1 => $paymentProcessor)));
+ CRM_Core_Error::fatal(ts('First Data - recurring payments not implemented'));
}
if (!defined('CURLOPT_SSLCERT')) {
}
/**
- * Validate the payment instrument values before passing it to the payment processor
- * We want this to be overrideable by the payment processor, and default to using
+ * Validate the payment instrument values before passing it to the payment processor.
+ *
+ * We want this to be able to be overridden by the payment processor, and default to using
* this object's validCreditCard for credit cards (implemented as the default in the Payment class).
+ *
+ * @param int $payment_processor_id
+ * @param array $values
+ * @param array $errors
+ * @param int $billing_profile_id
*/
public static function validatePaymentInstrument($payment_processor_id, $values, &$errors, $billing_profile_id) {
$payment = Civi\Payment\System::singleton()->getById($payment_processor_id);
}
// end function doDirectPayment
-
/**
* This function checks the PayJunction response code.
*
+ * @param array $response
+ *
* @return bool
*/
public function isError(&$response) {
}
/**
- * This method is handles the response that will be invoked by the
- * notification or request sent by the payment processor.
+ * Main notification processing method.
+ *
* hex string from paymentexpress is passed to this function as hex string. Code based on googleIPN
* mac_key is only passed if the processor is pxaccess as it is used for decryption
* $dps_method is either pxaccess or pxpay
+ *
+ * @param string $dps_method
+ * @param array $rawPostData
+ * @param string $dps_url
+ * @param string $dps_user
+ * @param string $dps_key
+ * @param string $mac_key
+ *
+ * @throws \Exception
*/
public static function main($dps_method, $rawPostData, $dps_url, $dps_user, $dps_key, $mac_key) {
* Get the permissions defined in the hook_civicrm_permission implementation
* in all enabled CiviCRM module extensions.
*
+ * @param bool $descriptions
+ *
* @return array
* Array of permissions, in the same format as CRM_Core_Permission::getCorePermissions().
*/
/**
* Setter for name.
+ *
+ * @param string $name
*/
public function setName($name) {
$this->_name = $name;
/**
* Return payment update Query.
+ *
+ * @param string $tableName
+ * @param int $mainContactId
+ * @param int $otherContactId
+ *
+ * @return array
*/
public static function paymentSql($tableName, $mainContactId, $otherContactId) {
$sqls = array();
* Based on the provided two contact_ids and a set of tables, move the
* belongings of the other contact to the main one.
*
+ * @param int $mainId
+ * @param int $otherId
+ * @param bool $tables
+ * @param array $tableOperations
*/
public static function moveContactBelongings($mainId, $otherId, $tables = FALSE, $tableOperations = array()) {
$cidRefs = self::cidRefs();
* This is sometimes called in a loop (during event search).
*
* We cache the values to prevent repeated calls to the db.
+ *
+ * @param int $id
+ *
+ * @return bool
*/
public static function usesPriceSet($id) {
static $usesPriceSet = array();
}
/**
- * @param $updatedAmount
- * @param $paidAmount
+ * Record adjusted amount.
+ *
+ * @param int $updatedAmount
+ * @param int $paidAmount
* @param int $contributionId
+ *
+ * @param int $taxAmount
+ * @param bool $updateAmountLevel
+ *
+ * @return bool|\CRM_Core_BAO_FinancialTrxn
*/
public static function recordAdjustedAmt($updatedAmount, $paidAmount, $contributionId, $taxAmount = NULL, $updateAmountLevel = NULL) {
$pendingAmount = CRM_Core_BAO_FinancialTrxn::getBalanceTrxnAmt($contributionId);
}
/**
- * Create the labels (pdf)
+ * Create the labels (pdf).
+ *
* It assumes the participants are from the same event
*
* @param array $participants
- *
- * @return;
*/
public function run(&$participants) {
// fetch the 1st participant, and take her event to retrieve its attributes
* @param bool $useDedupeRules
* Force usage of dedupe rules.
*
- * @return void
+ * @return int
*/
public static function checkRegistration($fields, &$self, $isAdditional = FALSE, $returnContactId = FALSE, $useDedupeRules = FALSE) {
// CRM-3907, skip check for preview registrations
/**
* Class constructor.
+ *
+ * @param array $mapperKeys
+ * @param null $mapperLocType
+ * @param null $mapperPhoneType
*/
public function __construct(&$mapperKeys, $mapperLocType = NULL, $mapperPhoneType = NULL) {
parent::__construct();
}
/**
- * The initializer code, called before the processing
- *
- * @return void
+ * The initializer code, called before the processing.
*/
public function init() {
$fields = CRM_Event_BAO_Participant::importableFields($this->_contactType, FALSE);
/**
* The function unsets static part of the string, if token is the dynamic part.
+ *
* Example: 'Hello {contact.first_name}' => converted to => '{contact.first_name}'
* i.e 'Hello Alan' => converted to => 'Alan'
+ *
+ * @param string $parsedString
+ * @param string $defaultGreeting
+ * @param bool $addressMergeGreetings
+ * @param string $greetingType
+ *
+ * @return mixed
*/
public static function _trimNonTokens(
&$parsedString, $defaultGreeting,
* Contribution object.
* @param bool $taxTrxnID
*
- * @return void
+ * @param int $trxnId
+ *
+ * @return CRM_Financial_DAO_FinancialItem
*/
public static function add($lineItem, $contribution, $taxTrxnID = FALSE, $trxnId = NULL) {
$contributionStatuses = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
}
/**
- * Create the financial Items and financial enity trxn.
+ * Create the financial Items and financial entity trxn.
*
* @param array $params
* Associated array to create financial items.
* @param array $trxnIds
* Financial item ids.
*
- * @return object
+ * @return CRM_Financial_DAO_FinancialItem
*/
public static function create(&$params, $ids = NULL, $trxnIds = NULL) {
$financialItem = new CRM_Financial_DAO_FinancialItem();
/**
* Returns total number of rows for the query.
*
- * @param
+ * @param int $action
*
* @return int
* Total number of rows
/**
* Set variables up before form is built.
+ *
+ * @param CRM_Core_Form $form
*/
abstract public function preProcess(&$form);
/**
- * This is function is called by the form object to get the DataSource's
- * form snippet. It should add all fields necesarry to get the data
- * uploaded to the temporary table in the DB.
+ * This is function is called by the form object to get the DataSource's form snippet.
*
- * @param CRM_Core_Form $form
+ * It should add all fields necessary to get the data uploaded to the temporary table in the DB.
*
- * @return void
- * (operates directly on form argument)
+ * @param CRM_Core_Form $form
*/
abstract public function buildQuickForm(&$form);
/**
* Process the form submission.
+ *
+ * @param array $params
+ * @param string $db
+ * @param CRM_Core_Form $form
*/
abstract public function postProcess(&$params, &$db, &$form);
/**
* Process the form submission.
+ *
+ * @param array $params
+ * @param string $db
+ * @param \CRM_Core_Form $form
*/
public function postProcess(&$params, &$db, &$form) {
$file = $params['uploadFile']['name'];
/**
* Process the form submission.
+ *
+ * @param array $params
+ * @param string $db
+ * @param \CRM_Core_Form $form
*/
public function postProcess(&$params, &$db, &$form) {
$importJob = new CRM_Contact_Import_ImportJob(
}
/**
+ * Replace tokens.
*
- * get mailing object and replaces subscribeInvite,
- * domain and mailing tokens
+ * Get mailing object and replaces subscribeInvite, domain and mailing tokens.
+ *
+ * @param array $mailing
*/
public static function tokenReplace(&$mailing) {
$domain = CRM_Core_BAO_Domain::getDomain();
}
/**
+ * Get data to resolve tokens.
+ *
+ * @param array $token_a
+ * @param bool $html
+ * @param array $contact
+ * @param string $verp
+ * @param array $urls
+ * @param int $event_queue_id
*
- * getTokenData receives a token from an email
- * and returns the appropriate data for the token
+ * @return bool|mixed|null|string
*/
private function getTokenData(&$token_a, $html = FALSE, &$contact, &$verp, &$urls, $event_queue_id) {
$type = $token_a['type'];
}
/**
- * Create a security hash from the job, email and contact ids
+ * Create a security hash from the job, email and contact ids.
+ *
+ * @param array $params
*
* @return int
* The hash
}
/**
- * Verify that a queue event exists with the specified id/job id/hash
+ * Verify that a queue event exists with the specified id/job id/hash.
*
* @param int $job_id
* The job ID of the event to find.
/**
* Delete the campaign page.
*
- * @param int $id
+ * @param int
* Campaign page id.
- *
- * @return;
*/
public static function deleteById($id) {
CRM_Utils_Hook::pre('delete', 'Campaign', $id, CRM_Core_DAO::$_nullArray);
}
/**
- * Approve / Reject the campaign page
+ * Approve / Reject the campaign page.
*
* @param int $id
* Campaign page id.
*
* @param $is_active
- *
- * @return;
*/
public static function setIsActive($id, $is_active) {
switch ($is_active) {
/**
* Returns total number of rows for the query.
*
- * @param
+ * @param int $action
*
* @return int
* Total number of rows
public function summary();
/**
+ * Get contact IDs.
+ *
* List of contact ids that match the current input parameters
* Used by different tasks. Will be also used to optimize the
* 'all' query below to avoid excessive LEFT JOIN blowup
+ *
+ * @param int $offset
+ * @param int $rowcount
+ * @param string $sort
+ *
+ * @return
*/
public function contactIDs($offset = 0, $rowcount = 0, $sort = NULL);
/**
- * Retrieve all the values that match the current input parameters
- * Used by the selector
+ * Retrieve all the values that match the current input parameters used by the selector.
+ *
+ * @param int $offset
+ * @param int $rowcount
+ * @param string $sort
+ * @param bool $includeContactIDs
+ *
+ * @return
*/
public function all(
$offset = 0, $rowcount = 0, $sort = NULL,
/**
* The where clause for the query.
+ *
+ * @param bool $includeContactIDs
*/
public function where($includeContactIDs = FALSE);
/**
* Send an SMS Message via the API Server.
+ *
+ * @param array $recipients
+ * @param string $header
+ * @param string $message
+ * @param int $dncID
*/
abstract public function send($recipients, $header, $message, $dncID = NULL);
public function setPostUpgradeMessage(&$postUpgradeMessage, $rev) {
}
-
/**
* (Queue Task Callback)
+ *
+ * @param \CRM_Queue_TaskContext $ctx
+ * @param string $rev
+ *
+ * @return bool
*/
public static function runSql(CRM_Queue_TaskContext $ctx, $rev) {
$upgrade = new CRM_Upgrade_Form();
}
/**
- * Syntactic sugar for adding a task which (a) is in this class and (b) has
- * a high priority.
+ * Syntactic sugar for adding a task.
+ *
+ * Task is (a) in this class and (b) has a high priority.
*
* After passing the $funcName, you can also pass parameters that will go to
* the function. Note that all params must be serializable.
+ *
+ * @param string $title
+ * @param string $funcName
*/
protected function addTask($title, $funcName) {
$queue = CRM_Queue_Service::singleton()->load(array(
/**
* Change index and add missing constraints for civicrm_contribution_recur.
+ *
+ * @param \CRM_Queue_TaskContext $ctx
+ *
+ * @return bool
*/
public function addMissingConstraints(CRM_Queue_TaskContext $ctx) {
$query = "SHOW KEYS FROM `civicrm_contribution_recur` WHERE key_name = 'UI_contrib_payment_instrument_id'";
/**
* Update financial_account_id for bad data in financial_trxn table.
* CRM-12844
+ *
+ * @param \CRM_Queue_TaskContext $ctx
+ *
+ * @return bool
*/
public function updateFinancialTrxnData(CRM_Queue_TaskContext $ctx) {
$upgrade = new CRM_Upgrade_Form();
/**
* Replace contribution_type to financial_type in table.
- * civicrm_saved_search and Structure civicrm_report_instance
+ *
+ * Civicrm_saved_search and Structure civicrm_report_instance
+ *
+ * @param \CRM_Queue_TaskContext $ctx
+ * @param string $query
+ * @param string $table
+ *
+ * @return bool
*/
public function replaceContributionTypeId(CRM_Queue_TaskContext $ctx, $query, $table) {
$dao = CRM_Core_DAO::executeQuery($query);
}
/**
- * returns the list of fields that can be exported.
+ * Returns the list of fields that can be exported.
+ *
+ * @param bool $prefix
*
* @return array
*/
* @param string $seperator
* (optional) String to be appended after open/close tags.
*
- *
* @return string
* XML fragment representing $list.
*/
}
/**
- * @param $subset
- * @param $superset
+ * Is array A a subset of array B.
+ *
+ * @param array $subset
+ * @param array $superset
+ *
* @return bool
* TRUE if $subset is a subset of $superset
*/
}
/**
- * convert associative array names to values.
- * and vice-versa.
+ * Convert associative array names to values and vice-versa.
*
* This function is used by both the web form layer and the api. Note that
* the api needs the name => value conversion, also the view layer typically
* requires value => name conversion
+ *
+ * @param array $defaults
+ * @param string $property
+ * @param $lookup
+ * @param $reverse
+ *
+ * @return bool
*/
public static function lookupValue(&$defaults, $property, $lookup, $reverse) {
$id = $property . '_id';
/**
* This hook is called when a query string of the CSV Batch export is generated.
+ *
+ * @param string $query
+ *
+ * @return mixed
*/
public static function batchQuery(&$query) {
return self::singleton()->invoke(1, $query, self::$_nullObject,
/**
* This hook is called when the entries of the CSV Batch export are mapped.
+ *
+ * @param array $results
+ * @param array $items
+ *
+ * @return mixed
*/
public static function batchItems(&$results, &$items) {
return self::singleton()->invoke(2, $results, $items,
/**
* Split a large array of contactIDs into more manageable smaller chunks.
+ *
+ * @param array $contactIDs
+ *
+ * @return array
*/
public function &splitContactIDs(&$contactIDs) {
// contactIDs could be a real large array, so we split it up into
/**
* Given a set of contact IDs get the values.
+ *
+ * @param array $contactIDs
+ * @param array $additionalContactIDs
*/
public function getValues(&$contactIDs, &$additionalContactIDs) {
/**
* Some kind of numbery-looky-printy thing.
+ *
+ * @param string $size
+ * @param bool $checkForPostMax
+ *
+ * @return int
*/
public static function formatUnitSize($size, $checkForPostMax = FALSE) {
if ($size) {
/**
* Build a url for pager links.
+ *
+ * @param string $key
+ * @param string $value
+ *
+ * @return string
*/
public function makeURL($key, $value) {
$href = CRM_Utils_System::makeURL($key, TRUE);
/**
* Add element to form.
+ *
+ * @param CRM_Core_Form $form
*/
public static function add(&$form) {
$error = NULL;
/**
* Replace existing greeting tokens in message/subject.
+ *
+ * @param string $tokenString
+ * @param array $contactDetails
+ * @param int $contactId
+ * @param string $className
+ * @param bool $escapeSmarty
*/
public static function replaceGreetingTokens(&$tokenString, $contactDetails = NULL, $contactId = NULL, $className = NULL, $escapeSmarty = FALSE) {
}
/**
- * @param $actionSchedule
+ * Parse repetition interval.
+ *
* @return int|string
*/
protected function parseRepetitionInterval() {
}
/**
- * @param $actionSchedule
- * @param $contactTableAlias
+ * Prepare language filter.
+ *
+ * @param string $contactTableAlias
* @return string
*/
protected function prepareLanguageFilter($contactTableAlias) {
/**
* Invoke function.
*
+ * @param mixed $arg1
+ *
* @return mixed
*/
public function __invoke($arg1 = NULL) {
* during bootstrap -- in particular, defaults cannot be loaded. For a very small number of settings,
* we must define defaults before the system bootstraps.
*
+ * @param string $entity
+ *
* @return array
*/
private static function getSystemDefaults($entity) {
/**
* Load up settings metadata from files.
+ *
+ * @param array $metaDataFolder
+ *
+ * @return array
*/
protected static function loadSettingsMetadata($metaDataFolder) {
$settingMetaData = array();
* To perform a bulk lookup before rendering tokens, override this
* function and return the prefetched data.
*
+ * @param \Civi\Token\Event\TokenValueEvent $e
+ *
* @return mixed
*/
public function prefetch(TokenValueEvent $e) {
/**
* Auto-convert between different formats
+ *
+ * @param string $format
+ *
+ * @return $this
*/
public function fill($format = NULL) {
if ($format === NULL) {
*/
/**
- * get a randomly generated string
+ * Get a randomly generated string.
+ *
+ * @param int $size
+ *
+ * @return string
*/
private function randomString($size = 32) {
$string = "";
}
/**
- * @param $exists
+ * Assert the attachment exists.
+ *
+ * @param bool $exists
* @param array $apiResult
*/
protected function assertAttachmentExistence($exists, $apiResult) {
}
/**
+ * Create contacts in group.
+ *
* @param int $count
* @param int $groupID
+ * @param string $domain
*/
public function createContactsInGroup($count, $groupID, $domain = 'nul.example.com') {
for ($i = 1; $i <= $count; $i++) {
projects / civicrm-core.git / commitdiff