return parent::getTemplateFileName();
}
- // check if user has already signed this petition
/**
+ * check if user has already signed this petition
* @param array $params
*/
public function redirectIfSigned($params) {
// docs inherited from interface
protected $keyword = 'campaign';
- // docs inherited from interface
/**
+ * docs inherited from interface
* @return array
*/
public function getInfo() {
}
- // docs inherited from interface
/**
+ * docs inherited from interface
* @param bool $getAllUnconditionally
*
* @return array
}
- // docs inherited from interface
/**
+ * docs inherited from interface
* @return null
*/
public function getUserDashboardElement() {
return NULL;
}
- // docs inherited from interface
/**
+ * docs inherited from interface
* @return null
*/
public function registerTab() {
return NULL;
}
- // docs inherited from interface
/**
+ * docs inherited from interface
* @return null
*/
public function registerAdvancedSearchPane() {
return NULL;
}
- // docs inherited from interface
/**
- * @return null
+ * @inheritdoc
*/
public function getActivityTypes() {
return NULL;
}
- // add shortcut to Create New
/**
+ * add shortcut to Create New
* @param $shortCuts
*/
public function creatNewShortcut(&$shortCuts) {
// docs inherited from interface
protected $keyword = 'case';
- // docs inherited from interface
/**
+ * docs inherited from interface
* @return array
*/
public function getInfo() {
return $result;
}
- // docs inherited from interface
/**
+ * docs inherited from interface
* @return array
* @throws CRM_Core_Exception
*/
return $entities;
}
- // docs inherited from interface
/**
+ * docs inherited from interface
* @param bool $getAllUnconditionally
*
* @return array
return $result;
}
- // docs inherited from interface
/**
+ * docs inherited from interface
* @return array
*/
public function getUserDashboardElement() {
return array();
}
- // docs inherited from interface
/**
+ * docs inherited from interface
* @return array
*/
public function registerTab() {
);
}
- // docs inherited from interface
/**
+ * docs inherited from interface
* @return array
*/
public function registerAdvancedSearchPane() {
);
}
- // docs inherited from interface
/**
+ * docs inherited from interface
* @return null
*/
public function getActivityTypes() {
return NULL;
}
- // add shortcut to Create New
/**
+ * add shortcut to Create New
* @param $shortCuts
*/
public function creatNewShortcut(&$shortCuts) {
private $_settings = array();
- // Input: The base filename without the .xml extension
- // Output: An array of settings.
/**
+ * Input: The base filename without the .xml extension
+ * Output: An array of settings.
* @param string $filename
*
* @return array
return $sql;
}
- // Alters the date display in the Activity Date Column. We do this after we already have
- // the result so that sorting on the date column stays pertinent to the numeric date value
/**
+ * Alters the date display in the Activity Date Column. We do this after we already have
+ * the result so that sorting on the date column stays pertinent to the numeric date value
* @param $row
*/
public function alterRow(&$row) {
$row['activity_date'] = CRM_Utils_Date::customFormat($row['activity_date'], '%B %E%f, %Y %l:%M %P');
}
- // Regular JOIN statements here to limit results to contacts who have activities.
/**
+ * Regular JOIN statements here to limit results to contacts who have activities.
* @return string
*/
public function from() {
return CRM_Core_DAO::composeQuery($where, $params, TRUE);
}
- // override this method to define the contact query object
- // used for creating $sql
/**
+ * override this method to define the contact query object
+ * used for creating $sql
* @return null
*/
public function getQueryObj() {
// docs inherited from interface
protected $keyword = 'contribute';
- // docs inherited from interface
/**
+ * docs inherited from interface
* Provides base information about the component.
* Needs to be implemented in component's information
* class.
);
}
- // docs inherited from interface
/**
+ * docs inherited from interface
* Provides permissions that are used by component.
* Needs to be implemented in component's information
* class.
);
}
- // docs inherited from interface
/**
+ * docs inherited from interface
* Provides information about user dashboard element
* offered by this component.
*
);
}
- // docs inherited from interface
/**
+ * docs inherited from interface
* Provides information about user dashboard element
* offered by this component.
*
);
}
- // docs inherited from interface
/**
+ * docs inherited from interface
* Provides information about advanced search pane
* offered by this component.
*
);
}
- // docs inherited from interface
/**
+ * docs inherited from interface
* Provides potential activity types that this
* component might want to register in activity history.
* Needs to be implemented in component's information
return NULL;
}
- // add shortcut to Create New
/**
+ * add shortcut to Create New
* @param $shortCuts
* @param $newCredit
*/
public function __construct() {
}
- // TODO: this is the most rudimentary possible hack. CG config should
- // eventually be made into a first-class object.
/**
- * @param is $config
+ * TODO: this is the most rudimentary possible hack. CG config should
+ * eventually be made into a first-class object.
+ *
+ * @param object $config
*/
public function setConfig($config) {
$this->config = $config;
* Class CRM_Exception
*/
class CRM_Exception extends PEAR_Exception {
- // Redefine the exception so message isn't optional
/**
+ * Redefine the exception so message isn't optional
* Supported signatures:
* - PEAR_Exception(string $message);
* - PEAR_Exception(string $message, int $code);
/**
* Status code of various types of errors
- * @var const
*/
const FATAL_ERROR = 2;
const DUPLICATE_CONTACT = 8001;
self::abend(1);
}
- // this function is used to trap and print errors
- // during system initialization time. Hence the error
- // message is quite ugly
/**
+ * this function is used to trap and print errors
+ * during system initialization time. Hence the error
+ * message is quite ugly
+ *
* @param $pearError
*/
public static function simpleHandler($pearError) {
$this->errorData = $errorData + array('error_code' => $error_code);
}
- // custom string representation of object
/**
+ * custom string representation of object
* @return string
*/
public function __toString() {
return $lineSets;
}
- // function to copy custom data of the
- // initial contribution into its recurring contributions
/**
+ * copy custom data of the initial contribution into its recurring contributions
* @param int $recurId
* @param int $targetContributionId
*/
}
}
- // function to copy soft credit record of first recurring contribution
- // and add new soft credit against $targetContributionId
/**
+ * copy soft credit record of first recurring contribution
+ * and add new soft credit against $targetContributionId
+ *
* @param int $recurId
* @param int $targetContributionId
*/
return TRUE;
}
- // ignore for now, more elaborate error handling later.
/**
+ * ignore for now, more elaborate error handling later.
* @param $response
*
* @return object
}
- // ignore for now, more elaborate error handling later.
/**
+ * ignore for now, more elaborate error handling later.
* @param $response
*
* @return mixed
// function checkConfig( $mode ) // CiviCRM V1.9 Declaration
- // CiviCRM V2.0 Declaration
/**
+ * CiviCRM V2.0 Declaration
* This function checks to see if we have the right config values
*
* @internal param string $mode the mode we are operating in (live or test)
* Class CRM_Core_Smarty_Permissions
*/
class CRM_Core_Smarty_Permissions {
- // non-static adapter for CRM_Core_Permission::check
/**
+ * non-static adapter for CRM_Core_Permission::check
* @param $offset
*
* @return bool
<?php
-// TODO: How to handle NULL values/records?
/**
+ * TODO: How to handle NULL values/records?
* Class CRM_Dedupe_BAO_QueryBuilder_IndividualGeneral
*/
class CRM_Dedupe_BAO_QueryBuilder_IndividualGeneral extends CRM_Dedupe_BAO_QueryBuilder {
<?php
-// TODO: How to handle NULL values/records?
/**
+ * TODO: How to handle NULL values/records?
* Class CRM_Dedupe_BAO_QueryBuilder_IndividualSupervised
*/
class CRM_Dedupe_BAO_QueryBuilder_IndividualSupervised extends CRM_Dedupe_BAO_QueryBuilder {
}
}
- // Function to determine if a given query set contains inclusive or exclusive set of weights.
- // The function assumes that the query set is already ordered by weight in desc order.
/**
+ * Function to determine if a given query set contains inclusive or exclusive set of weights.
+ * The function assumes that the query set is already ordered by weight in desc order.
* @param $tableQueries
* @param $threshold
* @param array $exclWeightSum
return array($totalCombinations == 1, $totalCombinations <= 0);
}
- // sort queries by number of records for the table associated with them
/**
+ * sort queries by number of records for the table associated with them
* @param $tableQueries
*/
public static function orderByTableCount(&$tableQueries) {
*/
class CRM_Dedupe_Merger {
- // FIXME: consider creating a common structure with cidRefs() and eidRefs()
- // FIXME: the sub-pages references by the URLs should
- // be loaded dynamically on the merge form instead
/**
+ * FIXME: consider creating a common structure with cidRefs() and eidRefs()
+ * FIXME: the sub-pages references by the URLs should
+ * be loaded dynamically on the merge form instead
* @return array
*/
public static function relTables() {
* Class CRM_Event_Cart_BAO_Conference
*/
class CRM_Event_Cart_BAO_Conference {
- //XXX assumes we don't allow a contact to register for the same conference more than once
- //XXX flattens the object tree for convenient templating
/**
+ * XXX assumes we don't allow a contact to register for the same conference more than once
+ * XXX flattens the object tree for convenient templating
* @param int $main_event_participant_id
*
* @return array|null
public $contribution_id = NULL;
public $cart = NULL;
- //XXX
/**
+ * XXX
* @param null $participant
*/
public function __construct($participant = NULL) {
return "Participant {$this->participant->get_participant_index()}";
}
- //XXX poor name
/**
+ * XXX poor name
* @param $participant
*
* @return CRM_Event_Cart_Form_MerParticipant
// docs inherited from interface
protected $keyword = 'event';
- // docs inherited from interface
/**
+ * docs inherited from interface
* @return array
*/
public function getInfo() {
);
}
- // docs inherited from interface
/**
+ * docs inherited from interface
* @param bool $getAllUnconditionally
*
* @return array
);
}
- // docs inherited from interface
/**
+ * docs inherited from interface
* @return array
*/
public function getUserDashboardElement() {
);
}
- // docs inherited from interface
/**
+ * docs inherited from interface
* @return array
*/
public function registerTab() {
);
}
- // docs inherited from interface
/**
+ * docs inherited from interface
* @return array
*/
public function registerAdvancedSearchPane() {
);
}
- // docs inherited from interface
/**
+ * docs inherited from interface
* @return array
*/
public function getActivityTypes() {
return $types;
}
- // add shortcut to Create New
/**
+ * add shortcut to Create New
* @param $shortCuts
* @param $newCredit
*/
}
}
- // Override to assemble the appropriate subset of financial data for the specific export format
/**
+ * Override to assemble the appropriate subset of financial data for the specific export format
* @param array $exportParams
*
* @return mixed
return 'txt';
}
- // Override this if appropriate
/**
+ * Override this if appropriate
* @return null
*/
public function getTemplateFileName() {
// docs inherited from interface
protected $keyword = 'grant';
- // docs inherited from interface
/**
+ * docs inherited from interface
* @return array
*/
public function getInfo() {
}
- // docs inherited from interface
/**
+ * docs inherited from interface
* @param bool $getAllUnconditionally
*
* @return array
);
}
- // docs inherited from interface
/**
+ * docs inherited from interface
* @return null
*/
public function getUserDashboardElement() {
return NULL;
}
- // docs inherited from interface
/**
+ * docs inherited from interface
* @return null
*/
public function getUserDashboardObject() {
return NULL;
}
- // docs inherited from interface
/**
+ * docs inherited from interface
* @return array
*/
public function registerTab() {
);
}
- // docs inherited from interface
/**
+ * docs inherited from interface
* @return array
*/
public function registerAdvancedSearchPane() {
);
}
- // docs inherited from interface
/**
+ * docs inherited from interface
* @return null
*/
public function getActivityTypes() {
return NULL;
}
- // add shortcut to Create New
/**
+ * add shortcut to Create New
* @param $shortCuts
*/
public function creatNewShortcut(&$shortCuts) {
return $eq->N;
}
- // note that $job_id is used only as a variable in the temp table construction
- // and does not play a role in the queries generated
/**
+ * note that $job_id is used only as a variable in the temp table construction
+ * and does not play a role in the queries generated
* @param int $job_id
* (misnomer) a nonce value used to name temporary tables.
* @param int $mailing_id
}
}
- // post process to determine if the parent job
- // as well as the mailing is complete after the run
/**
+ * post process to determine if the parent job
+ * as well as the mailing is complete after the run
* @param null $mode
*/
public static function runJobs_post($mode = NULL) {
}
- // before we run jobs, we need to split the jobs
/**
+ * before we run jobs, we need to split the jobs
* @param int $offset
* @param null $mode
*/
}
}
- // Split the parent job into n number of child job based on an offset
- // If null or 0 , we create only one child job
/**
+ * Split the parent job into n number of child job based on an offset
+ * If null or 0 , we create only one child job
* @param int $offset
*/
public function split_job($offset = 200) {
protected $keyword = 'mailing';
- // docs inherited from interface
/**
+ * docs inherited from interface
* @return array
*/
public function getInfo() {
) ? TRUE : FALSE;
}
- // docs inherited from interface
/**
+ * docs inherited from interface
* @param bool $getAllUnconditionally
*
* @return array
}
- // docs inherited from interface
/**
+ * docs inherited from interface
* @return null
*/
public function getUserDashboardElement() {
return NULL;
}
- // docs inherited from interface
/**
+ * docs inherited from interface
* @return array
*/
public function registerTab() {
);
}
- // docs inherited from interface
/**
+ * docs inherited from interface
* @return array
*/
public function registerAdvancedSearchPane() {
);
}
- // docs inherited from interface
/**
+ * docs inherited from interface
* @return null
*/
public function getActivityTypes() {
return NULL;
}
- // add shortcut to Create New
/**
+ * add shortcut to Create New
* @param $shortCuts
*/
public function creatNewShortcut(&$shortCuts) {
// docs inherited from interface
protected $keyword = 'member';
- // docs inherited from interface
/**
+ * docs inherited from interface
* Provides base information about the component.
* Needs to be implemented in component's information
* class.
}
- // docs inherited from interface
/**
+ * docs inherited from interface
* Provides permissions that are used by component.
* Needs to be implemented in component's information
* class.
);
}
- // docs inherited from interface
/**
+ * docs inherited from interface
* Provides information about user dashboard element
* offered by this component.
*
);
}
- // docs inherited from interface
/**
+ * docs inherited from interface
* Provides information about user dashboard element
* offered by this component.
*
);
}
- // docs inherited from interface
/**
+ * docs inherited from interface
* Provides information about advanced search pane
* offered by this component.
*
);
}
- // docs inherited from interface
/**
+ * docs inherited from interface
* Provides potential activity types that this
* component might want to register in activity history.
* Needs to be implemented in component's information
return NULL;
}
- // add shortcut to Create New
/**
+ * add shortcut to Create New
* @param $shortCuts
* @param $newCredit
*/
return 'civicrm/admin/pcp';
}
- //@TODO this function changed, debug this at runtime
/**
+ * @TODO this function changed, debug this at runtime
* @param $whereClause
* @param array $whereParams
*/
}
- // docs inherited from interface
/**
+ * docs inherited from interface
* Provides permissions that are used by component.
* Needs to be implemented in component's information
* class.
);
}
- // docs inherited from interface
/**
+ * docs inherited from interface
* Provides information about user dashboard element
* offered by this component.
*
);
}
- // docs inherited from interface
/**
+ * docs inherited from interface
* Provides information about user dashboard element
* offered by this component.
*
);
}
- // docs inherited from interface
/**
+ * docs inherited from interface
* Provides information about advanced search pane
* offered by this component.
*
);
}
- // docs inherited from interface
/**
+ * docs inherited from interface
* Provides potential activity types that this
* component might want to register in activity history.
* Needs to be implemented in component's information
return NULL;
}
- // add shortcut to Create New
/**
+ * add shortcut to Create New
* @param $shortCuts
*/
public function creatNewShortcut(&$shortCuts) {
}
}
- // a formrule function to ensure that fields selected in group_by
- // (if any) should only be the ones present in display/select fields criteria;
- // note: works if and only if any custom field selected in group_by.
/**
+ * a formrule function to ensure that fields selected in group_by
+ * (if any) should only be the ones present in display/select fields criteria;
+ * note: works if and only if any custom field selected in group_by.
* @param $fields
* @param array $ignoreFields
*
return $errors;
}
- // Note: $fieldName param allows inheriting class to build operationPairs
- // specific to a field.
/**
+ * Note: $fieldName param allows inheriting class to build operationPairs
+ * specific to a field.
* @param string $type
* @param null $fieldName
*
$this->assign('statistics', $this->statistics($rows));
}
- // override this method to build your own statistics
/**
+ * override this method to build your own statistics
* @param $rows
*
* @return array
return $statistics;
}
- //Override to set limit is 10
/**
+ * Override to set limit is 10
* @param int $rowCount
*/
public function limit($rowCount = self::ROW_COUNT_LIMIT) {
parent::limit($rowCount);
}
- //Override to set pager with limit is 10
/**
+ * Override to set pager with limit is 10
* @param int $rowCount
*/
public function setPager($rowCount = self::ROW_COUNT_LIMIT) {
$this->_groupBy = "GROUP BY {$this->_aliases['civicrm_contribution']}.contact_id, YEAR({$this->_aliases['civicrm_contribution']}.receive_date)";
}
- //Override to set limit is 10
/**
+ * Override to set limit is 10
* @param int $rowCount
*/
public function limit($rowCount = self::ROW_COUNT_LIMIT) {
parent::limit($rowCount);
}
- //Override to set pager with limit is 10
/**
+ * Override to set pager with limit is 10
* @param int $rowCount
*/
public function setPager($rowCount = self::ROW_COUNT_LIMIT) {
return array($relationshipRows, $relatedContactIds);
}
- // Override "This Year" $op options
/**
+ * Override "This Year" $op options
* @param string $type
* @param null $fieldName
*
}
}
- // Override "This Year" $op options
/**
+ * Override "This Year" $op options
* @param string $type
* @param null $fieldName
*
}
}
- // Override "This Year" $op options
/**
+ * Override "This Year" $op options
* @param string $type
* @param null $fieldName
*
parent::preProcess();
}
- //Add The statistics
/**
+ * Add The statistics
* @param $rows
*
* @return array
$this->_groupBy = " GROUP BY {$this->_aliases['civicrm_event']}.id";
}
- //get participants information for events
/**
+ * get participants information for events
* @return array
*/
public function participantInfo() {
// docs inherited from interface
protected $keyword = 'report';
- // docs inherited from interface
/**
+ * docs inherited from interface
* Provides base information about the component.
* Needs to be implemented in component's information
* class.
}
- // docs inherited from interface
/**
+ * docs inherited from interface
* Provides permissions that are used by component.
* Needs to be implemented in component's information
* class.
}
- // docs inherited from interface
/**
+ * docs inherited from interface
* Provides information about user dashboard element
* offered by this component.
*
return NULL;
}
- // docs inherited from interface
/**
+ * docs inherited from interface
* Provides information about user dashboard element
* offered by this component.
*
return NULL;
}
- // docs inherited from interface
/**
+ * docs inherited from interface
* Provides information about advanced search pane
* offered by this component.
*
return NULL;
}
- // docs inherited from interface
/**
+ * docs inherited from interface
* Provides potential activity types that this
* component might want to register in activity history.
* Needs to be implemented in component's information
return NULL;
}
- // add shortcut to Create New
/**
+ * add shortcut to Create New
* @param $shortCuts
*/
public function creatNewShortcut(&$shortCuts) {
}
}
- //unset default filters
/**
+ * unset default filters
* @param $defaults
*/
public static function unsetFilters(&$defaults) {
}
}
- // get instance count for a template
/**
+ * get instance count for a template
* @param $optionVal
*
* @return int|null|string
$this->addTask('Update Line Item Data', 'updateLineItemData', $rev);
}
- //CRM-11636
/**
+ * CRM-11636
* @return bool
*/
public function assignFinancialTypeToPriceRecords() {
$this->table($contactIDs, 'civicrm_group_contact', $fields, 'contact_id', NULL);
}
- // TODO - support group inheritance
- // Parent child group ids are encoded in a text string
/**
+ * TODO - support group inheritance
+ * Parent child group ids are encoded in a text string
* @param $contactIDs
*/
public function group(&$contactIDs) {
$this->savedSearch($groupIDs);
}
- // TODO - support search builder and custom saved searches
/**
+ * TODO - support search builder and custom saved searches
* @param $groupIDs
*/
public function savedSearch(&$groupIDs) {
return self::simple(array('message' => "PONG: $key"));
}
- // Generates values needed for error messages
/**
+ * Generates values needed for error messages
* @param string $message
*
* @return array
return $values;
}
- // Generates values needed for non-error responses.
/**
+ * Generates values needed for non-error responses.
* @param array $params
*
* @return array
return TRUE;
}
- // allow between 4-6 digits as postal code since india needs 6 and US needs 5 (or
- // if u disregard the first 0, 4 (thanx excel!)
- // FIXME: we need to figure out how to localize such rules
/**
+ * allow between 4-6 digits as postal code since india needs 6 and US needs 5 (or
+ * if u disregard the first 0, 4 (thanx excel!)
+ * FIXME: we need to figure out how to localize such rules
* @param $value
*
* @return bool
$this->extraParams = $extraParams + array('error_code' => $error_code);
}
- // custom string representation of object
/**
+ * custom string representation of object
* @return string
*/
public function __toString() {
$this->extraParams = $extraParams + array('error_code' => $error_code);
}
- // custom string representation of object
/**
+ * custom string representation of object
* @return string
*/
public function __toString() {
);
}
- // helper function to record participant with paid contribution
/**
+ * helper function to record participant with paid contribution
* @param $feeTotal
* @param $actualPaidAmt
*
return CiviDBAssert::assertDBState($this, $daoName, $id, $match, $delete);
}
- // Request a record from the DB by seachColumn+searchValue. Success if a record is found.
/**
+ * Request a record from the DB by seachColumn+searchValue. Success if a record is found.
* @param string $daoName
* @param $searchValue
* @param $returnColumn
return CiviDBAssert::assertDBNotNull($this, $daoName, $searchValue, $returnColumn, $searchColumn, $message);
}
- // Request a record from the DB by seachColumn+searchValue. Success if returnColumn value is NULL.
/**
+ * Request a record from the DB by seachColumn+searchValue. Success if returnColumn value is NULL.
* @param string $daoName
* @param $searchValue
* @param $returnColumn
return CiviDBAssert::assertDBNull($this, $daoName, $searchValue, $returnColumn, $searchColumn, $message);
}
- // Request a record from the DB by id. Success if row not found.
/**
+ * Request a record from the DB by id. Success if row not found.
* @param string $daoName
* @param int $id
* @param $message
return CiviDBAssert::assertDBRowNotExist($this, $daoName, $id, $message);
}
- // Compare a single column value in a retrieved DB record to an expected value
/**
+ * Compare a single column value in a retrieved DB record to an expected value
* @param string $daoName
* @param $searchValue
* @param $returnColumn
);
}
- // Compare all values in a single retrieved DB record to an array of expected values
/**
+ * Compare all values in a single retrieved DB record to an array of expected values
* @param string $daoName
* @param array $searchParams
* @param $expectedValues
}
}
- // Request a record from the DB by seachColumn+searchValue. Success if a record is found.
/**
+ * Request a record from the DB by seachColumn+searchValue. Success if a record is found.
* @param string $daoName
* @param $searchValue
* @param $returnColumn
return $value;
}
- // Request a record from the DB by seachColumn+searchValue. Success if returnColumn value is NULL.
/**
+ * Request a record from the DB by seachColumn+searchValue. Success if returnColumn value is NULL.
* @param string $daoName
* @param $searchValue
* @param $returnColumn
$this->assertNull($value, $message);
}
- // Request a record from the DB by id. Success if row not found.
/**
+ * Request a record from the DB by id. Success if row not found.
* @param string $daoName
* @param int $id
* @param null $message
$this->assertNull($value, $message);
}
- // Request a record from the DB by id. Success if row not found.
/**
+ * Request a record from the DB by id. Success if row not found.
* @param string $daoName
* @param int $id
* @param null $message
$this->assertEquals($id, $value, $message);
}
- // Compare a single column value in a retrieved DB record to an expected value
/**
+ * Compare a single column value in a retrieved DB record to an expected value
* @param string $daoName
* @param $searchValue
* @param $returnColumn
$this->assertEquals($value, $expectedValue, $message);
}
- // Compare all values in a single retrieved DB record to an array of expected values
/**
+ * Compare all values in a single retrieved DB record to an array of expected values
* @param string $daoName
* @param array $searchParams
* @param $expectedValues
$this->assertElementContainsText("css=div." . $destination['name'], $fields['values'][$field_to_move]['label'], "Moved value does not display in the new fieldset on the contact record");
}
- //moves a field from one field to another
/**
+ * moves a field from one field to another
* @param $field_to_move
* @param int $from_group_id
* @param int $to_group_id
$this->assertTrue($this->isElementPresent("CustomField-" . $field_to_move), "The moved custom field does not display on the new fieldset page");
}
- //create a contact and return the contact id
/**
+ * create a contact and return the contact id
* @param string $firstName
* @param string $lastName
*
return $cid;
}
- //Get all custom field values for a given contact and custom group id using the api
/**
+ * Get all custom field values for a given contact and custom group id using the api
* @param int $contact_id
* @param int $group_id
* @param bool $reset_cache
return $results;
}
- //creates a new custom group and fields in that group, and returns the group Id
/**
+ * creates a new custom group and fields in that group, and returns the group Id
* @param $prefix
*
* @return null
return $group_id;
}
- //Creates a custom field group for a specific entity type and returns the custom group Id
/**
+ * Creates a custom field group for a specific entity type and returns the custom group Id
* @param string $prefix
* @param string $entity
*
return $this->urlArg('gid');
}
- //Adds a new custom field to a specfied custom field group, using the given
- //datatype and widget.
/**
+ * Adds a new custom field to a specfied custom field group, using the given
+ * datatype and widget.
* @param int $group_id
* @param string $type
* @param string $widget
return $results['id'];
}
- //Populates $count options for a custom field on the add custom field page
/**
+ * Populates $count options for a custom field on the add custom field page
* @param int $count
* @param string $prefix
* @param array $values
}
}
- //randomly generates data for a specific custom field
/**
+ * randomly generates data for a specific custom field
* @param int $contact_id
* @param int $group_id
*/
}
}
- //function to check match for sumbit Advance Search
/**
+ * function to check match for sumbit Advance Search
* @param string $firstName
*/
public function submitSearch($firstName) {
$this->assertElementNotContainsText("xpath=//div[@class='crm-search-results']//table/tbody/tr[1]/td[6]", $stateBeforeSort);
}
- // function to fill basic search detail
/**
+ * function to fill basic search detail
* @param string $firstName
* @param string $groupName
* @param $tagName
$this->check("preferred_communication_method[2]");
}
- // function to fill address search block values in advance search
/**
+ * function to fill address search block values in advance search
* @param $firstName
*/
public function addAddressSearchDetail($firstName) {
$this->select2("state_province", "Alaska", TRUE);
}
- // function to fill activity search block in advance search
/**
+ * function to fill activity search block in advance search
* @param $firstName
*/
public function addActivitySearchDetail($firstName) {
$this->check("civicrm_gender_Male_2");
}
- //function to fill contribution search details
/**
+ * function to fill contribution search details
* @param $firstName
*/
public function addContributionSearchDetail($firstName) {
$this->type("participant_fee_amount_high", "150");
}
- // function to fill member search details
/**
+ * function to fill member search details
* @param $firstName
*/
public function addMemberSearchDetail($firstName) {
$this->webtestFillDate("member_end_date_high", "+2 year");
}
- // function to fill member search details
/**
+ * function to fill member search details
* @param $firstName
*/
public function addPledgeSearchDetail($firstName) {
$this->select("pledge_financial_type_id", "Donation");
}
- // function to create contact with details (contact details, address, Constituent information ...)
/**
+ * function to create contact with details (contact details, address, Constituent information ...)
* @param null $firstName
*/
public function createDetailContact($firstName = NULL) {
require_once 'CiviTest/CiviSeleniumTestCase.php';
-//Tests for the ability to add a CMS user from a contact's record
-//See http://issues.civicrm.org/jira/browse/CRM-8723
/**
+ * Tests for the ability to add a CMS user from a contact's record
+ * See http://issues.civicrm.org/jira/browse/CRM-8723
* Class WebTest_Contact_CreateCmsUserFromContactTest
*/
class WebTest_Contact_CreateCmsUserFromContactTest extends CiviSeleniumTestCase {
$this->_searchBuilder("Postal Code", "100[0-9]", $sortName, "RLIKE");
}
- // function to create contact with details (contact details, address, Constituent information ...)
/**
+ * function to create contact with details (contact details, address, Constituent information ...)
* @param null $firstName
*/
public function createDetailContact($firstName = NULL) {
$this->_verifyAmounts($checkScenario5);
}
- //common function for doing offline contribution
/**
+ * common function for doing offline contribution
* @param array $params
* @param string $firstName
* @param string $lastName
$this->assertTrue($this->isTextPresent("The contribution record has been processed."), "Status message didn't show up after saving!");
}
- //common function for verifing total_amount, and non_deductible_amount
/**
+ * common function for verifing total_amount, and non_deductible_amount
* @param $verifyData
*/
public function _verifyAmounts($verifyData) {
require_once 'ReleaseTestCase.php';
-// name of the class doesn't end with Test on purpose - this way this
-// webtest is not picked up by the suite, since it needs to run
-// on specially prepare sandbox
-// more details: http://wiki.civicrm.org/confluence/display/CRMDOC/Release+testing+script
/**
+ * name of the class doesn't end with Test on purpose - this way this
+ * webtest is not picked up by the suite, since it needs to run
+ * on specially prepare sandbox
+ * more details: http://wiki.civicrm.org/confluence/display/CRMDOC/Release+testing+script
* Class WebTest_Release_InstallScript
*/
class WebTest_Release_InstallScript extends WebTest_Release_ReleaseTestCase {
require_once 'CiviTest/CiviSeleniumTestCase.php';
-// name of the class doesn't end with Test on purpose - this way this
-// webtest is not picked up by the suite, since it needs to run
-// on specially prepare sandbox
-// more details: http://wiki.civicrm.org/confluence/display/CRMDOC/Release+testing+script
/**
+ * name of the class doesn't end with Test on purpose - this way this
+ * webtest is not picked up by the suite, since it needs to run
+ * on specially prepare sandbox
+ * more details: http://wiki.civicrm.org/confluence/display/CRMDOC/Release+testing+script
* Class WebTest_Release_ReleaseTestCase
*/
class WebTest_Release_ReleaseTestCase extends CiviSeleniumTestCase {
require_once 'ReleaseTestCase.php';
-// name of the class doesn't end with Test on purpose - this way this
-// webtest is not picked up by the suite, since it needs to run
-// on specially prepare sandbox
-// more details: http://wiki.civicrm.org/confluence/display/CRMDOC/Release+testing+script
/**
+ * name of the class doesn't end with Test on purpose - this way this
+ * webtest is not picked up by the suite, since it needs to run
+ * on specially prepare sandbox
+ * more details: http://wiki.civicrm.org/confluence/display/CRMDOC/Release+testing+script
* Class WebTest_Release_UpgradeScript
*/
class WebTest_Release_UpgradeScript extends WebTest_Release_ReleaseTestCase {
projects / civicrm-core.git / commitdiff