protected $_id;
/**
- * The default values for form fields
+ * The default values for form fields.
*
* @var int
*/
protected $_values;
/**
- * The name of the BAO object for this form
+ * The name of the BAO object for this form.
*
* @var string
*/
protected $_BAOName;
/**
- * Basic setup
+ * Basic setup.
*/
public function preProcess() {
$this->_id = $this->get('id');
}
/**
- * Add standard buttons
+ * Add standard buttons.
*
* @return void
*/
class CRM_Admin_Form_CMSUser extends CRM_Core_Form {
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
class CRM_Admin_Form_ContactType extends CRM_Admin_Form {
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Global form rule
+ * Global form rule.
*
* @param array $fields
* The input form values.
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Global form rule
+ * Global form rule.
*
* @param array $fields
* The input form values.
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
}
/**
- * Build the form object
+ * Build the form object.
*
* @param bool $check
*
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
class CRM_Admin_Form_LabelFormats extends CRM_Admin_Form {
/**
- * Label Format ID
+ * Label Format ID.
*/
protected $_id = NULL;
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
class CRM_Admin_Form_LocationType extends CRM_Admin_Form {
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
class CRM_Admin_Form_MailSettings extends CRM_Admin_Form {
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Add local and global form rules
+ * Add local and global form rules.
*
*
* @return void
}
/**
- * Global validation rules for the form
+ * Global validation rules for the form.
*
* @param array $fields
* Posted values of the form.
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
class CRM_Admin_Form_Mapping extends CRM_Admin_Form {
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
class CRM_Admin_Form_Navigation extends CRM_Admin_Form {
/**
- * The parent id of the navigation menu
+ * The parent id of the navigation menu.
*/
protected $_currentParentID = NULL;
/**
- * Default values
+ * Default values.
*/
protected $_defaults = array();
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
class CRM_Admin_Form_OptionGroup extends CRM_Admin_Form {
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
class CRM_Admin_Form_Options extends CRM_Admin_Form {
/**
- * The option group name
+ * The option group name.
*
* @var array
*/
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Global form rule
+ * Global form rule.
*
* @param array $fields
* The input form values.
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
}
/**
- * Build the form object
+ * Build the form object.
*
* @param bool $check
*
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return Void
}
/**
- * Save a payment processor
+ * Save a payment processor.
*
* @param $values
* @param int $domainID
}
/**
- * Build the form object
+ * Build the form object.
*
* @param bool $check
*
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
class CRM_Admin_Form_PdfFormats extends CRM_Admin_Form {
/**
- * PDF Page Format ID
+ * PDF Page Format ID.
*/
protected $_id = NULL;
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
*/
class CRM_Admin_Form_Preferences_Contribute extends CRM_Admin_Form_Preferences {
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
class CRM_Admin_Form_PreferencesDate extends CRM_Admin_Form {
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Global validation rules for the form
+ * Global validation rules for the form.
*
* @param array $fields
* Posted values of the form.
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
class CRM_Admin_Form_RelationshipType extends CRM_Admin_Form {
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
class CRM_Admin_Form_ScheduleReminders extends CRM_Admin_Form {
/**
- * Scheduled Reminder ID
+ * Scheduled Reminder ID.
*/
protected $_id = NULL;
public $_freqUnits;
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Global form rule
+ * Global form rule.
*
* @param array $fields
* The input form values.
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
protected $_components;
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Global form rule
+ * Global form rule.
*
* @param array $fields
* The input form values.
class CRM_Admin_Form_Setting_Date extends CRM_Admin_Form_Setting {
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
);
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
protected $_currencySymbols;
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
class CRM_Admin_Form_Setting_Mail extends CRM_Admin_Form_Setting {
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
class CRM_Admin_Form_Setting_Mapping extends CRM_Admin_Form_Setting {
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Global form rule
+ * Global form rule.
*
* @param array $fields
* The input form values.
public $_uploadMaxSize;
/**
- * Basic setup
+ * Basic setup.
*/
public function preProcess() {
$config = CRM_Core_Config::singleton();
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Global form rule
+ * Global form rule.
*
* @param array $fields
* The input form values.
class CRM_Admin_Form_Setting_Path extends CRM_Admin_Form_Setting {
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
);
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
protected $_testButtonName;
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
}
/**
- * Global validation rules for the form
+ * Global validation rules for the form.
*
* @param array $fields
* Posted values of the form.
protected $_uf = NULL;
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
protected $_oldSiteName;
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
);
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
protected $_isTagSet;
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Global validation rules for the form
+ * Global validation rules for the form.
*
* @param array $values
* Posted values of the form.
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
}
/**
- * Return menu tree as json data for editing
+ * Return menu tree as json data for editing.
*/
public static function getNavigationList() {
echo CRM_Core_BAO_Navigation::buildNavigation(TRUE, FALSE);
}
/**
- * Build status message while
+ * Build status message while.
* enabling/ disabling various objects
*/
public static function getStatusMsg() {
public $useLivePageJS = TRUE;
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
static $_links = NULL;
/**
- * Get BAO Name
+ * Get BAO Name.
*
* @return string
* Classname of BAO.
}
/**
- * Get action Links
+ * Get action Links.
*
* @return array
* (reference) of action links
}
/**
- * Get name of edit form
+ * Get name of edit form.
*
* @return string
* Classname of edit form.
}
/**
- * Get edit form name
+ * Get edit form name.
*
* @return string
* name of this page.
class CRM_Admin_Page_EventTemplate extends CRM_Core_Page_Basic {
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
static $_links = NULL;
/**
- * Get BAO Name
+ * Get BAO Name.
*
* @return string
* Classname of BAO.
}
/**
- * Get action Links
+ * Get action Links.
*
* @return array
* (reference) of action links
}
/**
- * Get name of edit form
+ * Get name of edit form.
*
* @return string
* Classname of edit form.
}
/**
- * Get edit form name
+ * Get edit form name.
*
* @return string
* name of this page.
class CRM_Admin_Page_Extensions extends CRM_Core_Page_Basic {
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
}
/**
- * Get BAO Name
+ * Get BAO Name.
*
* @return string
* Classname of BAO.
}
/**
- * Get action Links
+ * Get action Links.
*
* @return array
* (reference) of action links
}
/**
- * Browse all options
+ * Browse all options.
*
*
* @return void
}
/**
- * Get name of edit form
+ * Get name of edit form.
*
* @return string
* Classname of edit form.
}
/**
- * Get edit form name
+ * Get edit form name.
*
* @return string
* name of this page.
}
/**
- * Get userContext params
+ * Get userContext params.
*
* @param int $mode
* Mode that we are in.
}
/**
- * Handle the final step of the queue
+ * Handle the final step of the queue.
*
* @param \CRM_Queue_TaskContext $ctx
*/
class CRM_Admin_Page_Job extends CRM_Core_Page_Basic {
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
static $_links = NULL;
/**
- * Get BAO Name
+ * Get BAO Name.
*
* @return string
* Classname of BAO.
}
/**
- * Get action Links
+ * Get action Links.
*
* @return array
* (reference) of action links
}
/**
- * Get name of edit form
+ * Get name of edit form.
*
* @return string
* Classname of edit form.
}
/**
- * Get edit form name
+ * Get edit form name.
*
* @return string
* name of this page.
class CRM_Admin_Page_JobLog extends CRM_Core_Page_Basic {
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
static $_links = NULL;
/**
- * Get BAO Name
+ * Get BAO Name.
*
* @return string
* Classname of BAO.
}
/**
- * Get action Links
+ * Get action Links.
*
* @return array
* (reference) of action links
}
/**
- * Get name of edit form
+ * Get name of edit form.
*
* @return string
* Classname of edit form.
}
/**
- * Get edit form name
+ * Get edit form name.
*
* @return string
* name of this page.
public $useLivePageJS = TRUE;
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
static $_links = NULL;
/**
- * Get BAO Name
+ * Get BAO Name.
*
* @return string
* Classname of BAO.
}
/**
- * Get action Links
+ * Get action Links.
*
* @return array
* (reference) of action links
}
/**
- * Get name of edit form
+ * Get name of edit form.
*
* @return string
* Classname of edit form.
}
/**
- * Get edit form name
+ * Get edit form name.
*
* @return string
* name of this page.
public $useLivePageJS = TRUE;
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
static $_links = NULL;
/**
- * Get BAO Name
+ * Get BAO Name.
*
* @return string
* Classname of BAO.
}
/**
- * Get action Links
+ * Get action Links.
*
* @return array
* (reference) of action links
}
/**
- * Get name of edit form
+ * Get name of edit form.
*
* @return string
* Classname of edit form.
}
/**
- * Get edit form name
+ * Get edit form name.
*
* @return string
* name of this page.
public $useLivePageJS = TRUE;
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
static $_links = NULL;
/**
- * Get BAO Name
+ * Get BAO Name.
*
* @return string
* Classname of BAO.
}
/**
- * Get action Links
+ * Get action Links.
*
* @return array
* (reference) of action links
}
/**
- * Get name of edit form
+ * Get name of edit form.
*
* @return string
* Classname of edit form.
}
/**
- * Get edit form name
+ * Get edit form name.
*
* @return string
* name of this page.
public $useLivePageJS = TRUE;
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
static $_links = NULL;
/**
- * Get BAO
+ * Get BAO.
*
* @return string
* Classname of BAO.
}
/**
- * Get action Links
+ * Get action Links.
*
* @return array
* (reference) of action links
}
/**
- * Get name of edit form
+ * Get name of edit form.
*
* @return string
* Classname of edit form.
}
/**
- * Get form name for edit form
+ * Get form name for edit form.
*
* @return string
* name of this page.
}
/**
- * Get form name for delete form
+ * Get form name for delete form.
*
* @return string
* name of this page.
}
/**
- * Get name of delete form
+ * Get name of delete form.
*
* @return string
* Classname of delete form.
}
/**
- * Run the basic page
+ * Run the basic page.
*
* @return void
*/
class CRM_Admin_Page_MessageTemplates extends CRM_Core_Page_Basic {
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
}
/**
- * Get BAO Name
+ * Get BAO Name.
*
* @return string
* Classname of BAO.
}
/**
- * Get action Links
+ * Get action Links.
*
* @return array
* (reference) of action links
}
/**
- * Get name of edit form
+ * Get name of edit form.
*
* @return string
* Classname of edit form.
}
/**
- * Get edit form name
+ * Get edit form name.
*
* @return string
* name of this page.
class CRM_Admin_Page_Navigation extends CRM_Core_Page_Basic {
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
static $_links = NULL;
/**
- * Get BAO Name
+ * Get BAO Name.
*
* @return string
* Classname of BAO.
}
/**
- * Get action Links
+ * Get action Links.
*
* @return array|NULL
* (reference) of action links
}
/**
- * Get name of edit form
+ * Get name of edit form.
*
* @return string
* Classname of edit form.
}
/**
- * Get edit form name
+ * Get edit form name.
*
* @return string
* name of this page.
}
/**
- * Browse all menus
+ * Browse all menus.
*/
public function browse() {
// assign home id to the template
public $useLivePageJS = TRUE;
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
static $_links = NULL;
/**
- * The option group name
+ * The option group name.
*
* @var array
*/
static $_gLabel = NULL;
/**
- * The option group id
+ * The option group id.
*
* @var array
*/
static $_gId = NULL;
/**
- * A boolean determining if you can add options to this group in the GUI
+ * A boolean determining if you can add options to this group in the GUI.
*
* @var boolean
*/
}
/**
- * Get BAO Name
+ * Get BAO Name.
*
* @return string
* Classname of BAO.
}
/**
- * Get action Links
+ * Get action Links.
*
* @return array
* (reference) of action links
}
/**
- * Browse all options
+ * Browse all options.
*
*
* @return void
}
/**
- * Get name of edit form
+ * Get name of edit form.
*
* @return string
* Classname of edit form.
}
/**
- * Get edit form name
+ * Get edit form name.
*
* @return string
* name of this page.
class CRM_Admin_Page_PaymentProcessor extends CRM_Core_Page_Basic {
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
static $_links = NULL;
/**
- * Get BAO Name
+ * Get BAO Name.
*
* @return string
* Classname of BAO.
}
/**
- * Get action Links
+ * Get action Links.
*
* @return array
* (reference) of action links
}
/**
- * Get name of edit form
+ * Get name of edit form.
*
* @return string
* Classname of edit form.
}
/**
- * Get edit form name
+ * Get edit form name.
*
* @return string
* name of this page.
class CRM_Admin_Page_PaymentProcessorType extends CRM_Core_Page_Basic {
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
static $_links = NULL;
/**
- * Get BAO Name
+ * Get BAO Name.
*
* @return string
* Classname of BAO.
}
/**
- * Get action Links
+ * Get action Links.
*
* @return array
* (reference) of action links
}
/**
- * Get name of edit form
+ * Get name of edit form.
*
* @return string
* Classname of edit form.
}
/**
- * Get edit form name
+ * Get edit form name.
*
* @return string
* name of this page.
public $useLivePageJS = TRUE;
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
static $_links = NULL;
/**
- * Get BAO Name
+ * Get BAO Name.
*
* @return string
* Classname of BAO.
}
/**
- * Get action Links
+ * Get action Links.
*
* @return array
* (reference) of action links
}
/**
- * Get name of edit form
+ * Get name of edit form.
*
* @return string
* Classname of edit form.
}
/**
- * Get edit form name
+ * Get edit form name.
*
* @return string
* name of this page.
}
/**
- * Browse all PDF Page Formats
+ * Browse all PDF Page Formats.
*
* @param null $action
*
class CRM_Admin_Page_Persistent extends CRM_Core_Page {
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
private static $_customizeActionLinks;
/**
- * Get action Links
+ * Get action Links.
*
* @return array
* (reference) of action links
}
/**
- * Browse all options
+ * Browse all options.
*
*
* @return void
class CRM_Admin_Page_PreferencesDate extends CRM_Core_Page_Basic {
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
static $_links = NULL;
/**
- * Get BAO Name
+ * Get BAO Name.
*
* @return string
* Classname of BAO.
}
/**
- * Get action Links
+ * Get action Links.
*
* @return array
* (reference) of action links
}
/**
- * Get name of edit form
+ * Get name of edit form.
*
* @return string
* Classname of edit form.
}
/**
- * Get edit form name
+ * Get edit form name.
*
* @return string
* name of this page.
public $useLivePageJS = TRUE;
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
static $_links = NULL;
/**
- * Get BAO Name
+ * Get BAO Name.
*
* @return string
* Classname of BAO.
}
/**
- * Get action Links
+ * Get action Links.
*
* @return array
* (reference) of action links
}
/**
- * Get name of edit form
+ * Get name of edit form.
*
* @return string
* Classname of edit form.
}
/**
- * Get edit form name
+ * Get edit form name.
*
* @return string
* name of this page.
public $useLivePageJS = TRUE;
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
static $_links = NULL;
/**
- * Get BAO Name
+ * Get BAO Name.
*
* @return string
* Classname of BAO.
}
/**
- * Get action Links
+ * Get action Links.
*
* @return array
* (reference) of action links
}
/**
- * Get name of edit form
+ * Get name of edit form.
*
* @return string
* Classname of edit form.
}
/**
- * Get edit form name
+ * Get edit form name.
*
* @return string
* name of this page.
public $useLivePageJS = TRUE;
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
static $_links = NULL;
/**
- * Get BAO
+ * Get BAO.
*
* @return string
* Classname of BAO.
}
/**
- * Get action Links
+ * Get action Links.
*
* @return array
* (reference) of action links
}
/**
- * Get name of edit form
+ * Get name of edit form.
*
* @return string
* Classname of edit form.
}
/**
- * Get form name for edit form
+ * Get form name for edit form.
*
* @return string
* name of this page.
}
/**
- * Get form name for delete form
+ * Get form name for delete form.
*
* @return string
* name of this page.
}
/**
- * Get name of delete form
+ * Get name of delete form.
*
* @return string
* Classname of delete form.
public $border = 0;
/**
- * This function is called to create name label pdf
+ * This function is called to create name label pdf.
*
* @param array $participants
* Associated array with participant info.
}
/**
- * Funtion to create structure and add meta data according to layout
+ * Funtion to create structure and add meta data according to layout.
*
* @param array $row
* Row element that needs to be formatted.
}
/**
- * Helper function to print images
+ * Helper function to print images.
*
* @param string $img
* Image url.
class CRM_Badge_BAO_Layout extends CRM_Core_DAO_PrintLabel {
/**
- * Class constructor
+ * Class constructor.
*/
public function __construct() {
parent::__construct();
}
/**
- * Takes a bunch of params that are needed to match certain criteria and
+ * Takes a bunch of params that are needed to match certain criteria and.
* retrieves the relevant objects. It also stores all the retrieved
* values in the default array
*
}
/**
- * Add a name label
+ * Add a name label.
*
* @param array $params
* Reference array contains the values submitted by the form.
}
/**
- * Delete name labels
+ * Delete name labels.
*
* @param int $printLabelId
* ID of the name label to be deleted.
}
/**
- * get the list of print labels
+ * get the list of print labels.
*
* @return array
* list of labels
}
/**
- * Build layout structure
+ * Build layout structure.
*
* @param array $params
* Associated array of submitted values.
}
/**
- * Decode encoded data and return as an array
+ * Decode encoded data and return as an array.
*
* @param json $jsonData
* Json object.
const FIELD_ROWCOUNT = 6;
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
class CRM_Badge_Page_Layout extends CRM_Core_Page_Basic {
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
static $_links = NULL;
/**
- * Get BAO Name
+ * Get BAO Name.
*
* @return string
* Classname of BAO.
}
/**
- * Get action Links
+ * Get action Links.
*
* @return array
* (reference) of action links
}
/**
- * Get name of edit form
+ * Get name of edit form.
*
* @return string
* Classname of edit form.
}
/**
- * Get edit form name
+ * Get edit form name.
*
* @return string
* name of this page.
class CRM_Batch_BAO_Batch extends CRM_Batch_DAO_Batch {
/**
- * Cache for the current batch object
+ * Cache for the current batch object.
*/
static $_batch = NULL;
static $_exportFormat = NULL;
/**
- * Create a new batch
+ * Create a new batch.
*
* @param array $params
* @param array $ids
}
/**
- * Retrieve the information about the batch
+ * Retrieve the information about the batch.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
}
/**
- * Get profile id associated with the batch type
+ * Get profile id associated with the batch type.
*
* @param int $batchTypeId
* Batch type id.
}
/**
- * Generate batch name
+ * Generate batch name.
*
* @return string
* batch name
}
/**
- * Create entity batch entry
+ * Create entity batch entry.
*
* @param array $params
* @return array
}
/**
- * Remove entries from entity batch
+ * Remove entries from entity batch.
* @param array $params
* @return CRM_Batch_DAO_EntityBatch
*/
}
/**
- * Delete batch entry
+ * Delete batch entry.
*
* @param int $batchId
* Batch id.
}
/**
- * wrapper for ajax batch selector
+ * wrapper for ajax batch selector.
*
* @param array $params
* Associated array for params record id.
}
/**
- * Get list of batches
+ * Get list of batches.
*
* @param array $params
* Associated array for params.
}
/**
- * Get count of batches
+ * Get count of batches.
*
* @param array $params
* Associated array for params.
}
/**
- * Format where clause for getting lists of batches
+ * Format where clause for getting lists of batches.
*
* @param array $params
* Associated array for params.
}
/**
- * Define action links
+ * Define action links.
*
* @param null $context
*
}
/**
- * Get batch list
+ * Get batch list.
*
* @return array
* all batches excluding batches with data entry in progress
/**
- * Calculate sum of all entries in a batch
+ * Calculate sum of all entries in a batch.
* Used to validate and update item_count and total when closing an accounting batch
*
* @param array $batchIds
}
/**
- * Format markup for comparing two totals
+ * Format markup for comparing two totals.
*
* @param $actual
* calculated total
}
/**
- * Retrieve financial items assigned for a batch
+ * Retrieve financial items assigned for a batch.
*
* @param int $entityID
* @param array $returnValues
}
/**
- * Get batch names
+ * Get batch names.
* @param string $batchIds
*
* @return array
}
/**
- * Function get batch statuses
+ * Function get batch statuses.
*
* @param string $batchIds
*
}
/**
- * Build the form object
+ * Build the form object.
*
* @return void
*/
}
/**
- * Process the form submission
+ * Process the form submission.
*
*
* @return void
class CRM_Batch_Form_Entry extends CRM_Core_Form {
/**
- * Maximum profile fields that will be displayed
+ * Maximum profile fields that will be displayed.
*/
protected $_rowCount = 1;
/**
- * Batch id
+ * Batch id.
*/
protected $_batchId;
/**
- * Batch information
+ * Batch information.
*/
protected $_batchInfo = array();
/**
- * Store the profile id associated with the batch type
+ * Store the profile id associated with the batch type.
*/
protected $_profileId;
public $_fields = array();
/**
- * Build all the data structures needed to build the form
+ * Build all the data structures needed to build the form.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Form validations
+ * Form validations.
*
* @param array $params
* Posted values of the form.
}
/**
- * Override default cancel action
+ * Override default cancel action.
*/
public function cancelAction() {
// redirect to batch listing
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
}
/**
- * Process contribution records
+ * Process contribution records.
*
* @param array $params
* Associated array of submitted values.
}
/**
- * Process membership records
+ * Process membership records.
*
* @param array $params
* Associated array of submitted values.
}
/**
- * Update contact information
+ * Update contact information.
*
* @param array $value
* Associated array of submitted values.
class CRM_Batch_Page_AJAX {
/**
- * Save record
+ * Save record.
*/
public function batchSave() {
// save the entered information in 'data' column
}
/**
- * Retrieve records
+ * Retrieve records.
*/
public static function getBatchList() {
$sortMapper = array(
class CRM_Batch_Page_Batch extends CRM_Core_Page_Basic {
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
static $_links = NULL;
/**
- * Get BAO Name
+ * Get BAO Name.
*
* @return string
* Classname of BAO.
}
/**
- * Get action Links
+ * Get action Links.
*
*/
public function &links() {
}
/**
- * Get name of edit form
+ * Get name of edit form.
*
* @return string
* Classname of edit form.
}
/**
- * Get edit form name
+ * Get edit form name.
*
* @return string
* name of this page.
static $_description;
/**
- * Called by the request object to translate a string into a mask
+ * Called by the request object to translate a string into a mask.
*
* @param string $str
* The action to be resolved.
}
/**
- * Given a string determine the bitmask for this specific string
+ * Given a string determine the bitmask for this specific string.
*
* @param string $item
* The input action to process.
SET reminder.reference_date = {$dateField}
WHERE reminder.action_schedule_id = %1 AND reminder.reference_date IS NOT NULL AND reminder.reference_date != {$dateField}
";
- }
+ }
CRM_Core_DAO::executeQuery($query, array(1 => array($actionSchedule->id, 'Integer')));
}
/**
- * Validate the address fields based on the address options enabled
+ * Validate the address fields based on the address options enabled.
* in the Address Settings
*
* @param array $fields
public $_single = FALSE;
/**
- * Component clause
+ * Component clause.
*/
public $_componentClause;
/**
- * Build all the data structures needed to build the form
+ * Build all the data structures needed to build the form.
*
* @param
*
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
class CRM_Event_Form_Task_Batch extends CRM_Event_Form_Task {
/**
- * The title of the group
+ * The title of the group.
*
* @var string
*/
protected $_title;
/**
- * Maximum profile fields that will be displayed
+ * Maximum profile fields that will be displayed.
*/
protected $_maxFields = 9;
/**
- * Variable to store redirect path
+ * Variable to store redirect path.
*/
protected $_userContext;
protected $_fromStatusIds;
/**
- * Build all the data structures needed to build the form
+ * Build all the data structures needed to build the form.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
protected $_single = FALSE;
/**
- * Build all the data structures needed to build the form
+ * Build all the data structures needed to build the form.
*
* @return void
*/
}
/**
- * Build the form object
+ * Build the form object.
*
*
* @return void
}
/**
- * Process the form after the input has been submitted and validated
+ * Process the form after the input has been submitted and validated.
*
*
* @return void
class CRM_PCP_BAO_PCP extends CRM_PCP_DAO_PCP {
/**
- * The action links that we need to display for the browse screen
+ * The action links that we need to display for the browse screen.
*
* @var array
*/
}
/**
- * Add or update either a Personal Campaign Page OR a PCP Block
+ * Add or update either a Personal Campaign Page OR a PCP Block.
*
* @param array $params
* Reference array contains the values submitted by the form.
}
/**
- * Get the Display name of a contact for a PCP
+ * Get the Display name of a contact for a PCP.
*
* @param int $id
* Id for the PCP.
}
/**
- * Return PCP Block info for dashboard
+ * Return PCP Block info for dashboard.
*
* @param int $contactId
*
}
/**
- * Show the total amount for Personal Campaign Page on thermometer
+ * Show the total amount for Personal Campaign Page on thermometer.
*
* @param array $pcpId
* Contains the pcp ID.
}
/**
- * Get action links
+ * Get action links.
*
* @return array
* (reference) of action links
}
/**
- * Delete the campaign page
+ * Delete the campaign page.
*
* @param int $id
* Campaign page id.
}
/**
- * Build the form object
+ * Build the form object.
*
* @param CRM_Core_Form $form
* Form object.
/**
- * Add PCP form elements to a form
+ * Add PCP form elements to a form.
*
* @param int $pcpId
* @param CRM_Core_Page $page
}
/**
- * Process a PCP contribution
+ * Process a PCP contribution.
*
* @param int $pcpId
* @param $component
}
/**
- * Get pcp block is active
+ * Get pcp block is active.
*
* @param int $pcpId
* @param $component
}
/**
- * Get pcp block is enabled for component page
+ * Get pcp block is enabled for component page.
*
* @param int $pageId
* @param $component
}
/**
- * Find out if the PCP block is in use by one or more PCP page
+ * Find out if the PCP block is in use by one or more PCP page.
*
* @param int $id
* Pcp block id.
}
/**
- * Obtain the title of page associated with a pcp
+ * Obtain the title of page associated with a pcp.
*
* @param int $pcpId
* @param $component
}
/**
- * Get supporter profile id
+ * Get supporter profile id.
*
* @param int $component_id
* @param string $component
}
/**
- * Get owner notification id
+ * Get owner notification id.
*
* @param int $component_id
* @param $component
return $ownerNotificationId;
}
}
+
}
static private $_singleton = NULL;
/**
- * Singleton function used to manage this object
+ * Singleton function used to manage this object.
*
* @param string $mode
* The mode of operation: live or test.
}
/**
- * Prepare a set of search fields
+ * Prepare a set of search fields.
*
* @param CRM_Core_Form $form
* Modifiable.
}
/**
- * Get a list of summary data points
+ * Get a list of summary data points.
*
* @return mixed; NULL or array with keys:
* - summary: string
}
/**
- * Get a list of displayable columns
+ * Get a list of displayable columns.
*
* @return array, keys are printable column headers and values are SQL column names
*/
}
/**
- * Construct a full SQL query which returns one page worth of results
+ * Construct a full SQL query which returns one page worth of results.
*
* @param int $offset
* @param int $rowcount
}
/**
- * Construct a SQL SELECT clause
+ * Construct a SQL SELECT clause.
*
* @return string, sql fragment with SELECT arguments
*/
}
/**
- * Construct a SQL FROM clause
+ * Construct a SQL FROM clause.
*
* @return string, sql fragment with FROM and JOIN clauses
*/
}
/**
- * Construct a SQL WHERE clause
+ * Construct a SQL WHERE clause.
*
* @param bool $includeContactIDs
*
}
/**
- * Determine the Smarty template for the search screen
+ * Determine the Smarty template for the search screen.
*
* @return string, template path (findable through Smarty template path)
*/
}
/**
- * Modify the content of each row
+ * Modify the content of each row.
*
* @param array $row
* Modifiable SQL result row.
}
/**
- * Build test suite dynamically
+ * Build test suite dynamically.
*/
public static function suite() {
$inst = self::getInstance();
}
/**
- * Build test suite dynamically
+ * Build test suite dynamically.
*/
public static function suite() {
$inst = self::getInstance();
}
/**
- * Pass zero as an id and make sure no Assignees are retrieved
+ * Pass zero as an id and make sure no Assignees are retrieved.
*/
public function testRetrieveAssigneeIdsByActivityIdNoId() {
$activity = $this->activityCreate();
}
/**
- * Pass null as an id and make sure no Assignees are retrieved
+ * Pass null as an id and make sure no Assignees are retrieved.
*/
public function testRetrieveAssigneeIdsByActivityIdNullId() {
$activity = $this->activityCreate();
}
/**
- * Pass a string as an id and make sure no Assignees are retrieved
+ * Pass a string as an id and make sure no Assignees are retrieved.
*/
public function testRetrieveAssigneeIdsByActivityIdString() {
$activity = $this->activityCreate();
}
/**
- * Pass zero as an id and make sure no Assignees are retrieved
+ * Pass zero as an id and make sure no Assignees are retrieved.
*/
public function testGetAssigneeNamesNoId() {
$activity = $this->activityCreate();
}
/**
- * Pass Null as an id and make sure no Assignees are retrieved
+ * Pass Null as an id and make sure no Assignees are retrieved.
*/
public function testGetAssigneeNamesNullId() {
$activity = $this->activityCreate();
}
/**
- * Test getActivitiesCount BAO method
+ * Test getActivitiesCount BAO method.
*/
public function testGetActivitiesCountforAdminDashboard() {
$op = new PHPUnit_Extensions_Database_Operation_Insert();
}
/**
- * Test getActivitiesCount BAO method
+ * Test getActivitiesCount BAO method.
*/
public function testGetActivitiesCountforNonAdminDashboard() {
$op = new PHPUnit_Extensions_Database_Operation_Insert();
}
/**
- * Test getActivitiesCount BAO method
+ * Test getActivitiesCount BAO method.
*/
public function testGetActivitiesCountforContactSummary() {
$op = new PHPUnit_Extensions_Database_Operation_Insert();
}
/**
- * Test getActivitiesCount BAO method
+ * Test getActivitiesCount BAO method.
*/
public function testGetActivitiesCountforContactSummaryWithNoActivities() {
$op = new PHPUnit_Extensions_Database_Operation_Insert();
}
/**
- * Test getActivities BAO method
+ * Test getActivities BAO method.
*/
public function testGetActivitiesforAdminDashboard() {
$op = new PHPUnit_Extensions_Database_Operation_Insert();
}
/**
- * Test getActivities BAO method
+ * Test getActivities BAO method.
*/
public function testGetActivitiesforNonAdminDashboard() {
$op = new PHPUnit_Extensions_Database_Operation_Insert();
}
/**
- * Test getActivities BAO method
+ * Test getActivities BAO method.
*/
public function testGetActivitiesforContactSummary() {
$op = new PHPUnit_Extensions_Database_Operation_Insert();
}
/**
- * Test getActivities BAO method
+ * Test getActivities BAO method.
*/
public function testGetActivitiesforContactSummaryWithNoActivities() {
$op = new PHPUnit_Extensions_Database_Operation_Insert();
}
/**
- * Build test suite dynamically
+ * Build test suite dynamically.
*/
public static function suite() {
$inst = self::getInstance();
}
/**
- * Test Import
+ * Test Import.
*/
public function testProcessMembership() {
$form = new CRM_Batch_Form_Entry();
}
/**
- * Test Contribution Import
+ * Test Contribution Import.
*/
public function testProcessContribution() {
$this->offsetDefaultPriceSet();
}
/**
- * Data provider for test process membership
+ * Data provider for test process membership.
* @return array
*/
public function getMembershipData() {
}
/**
- * Build test suite dynamically
+ * Build test suite dynamically.
*/
public static function suite() {
$inst = self::getInstance();
/**
- * Edit the definition of ForkableCaseType
+ * Edit the definition of ForkableCaseType.
*/
public function testForkable() {
$caseTypeId = CRM_Core_DAO::getFieldValue('CRM_Case_DAO_CaseType', 'ForkableCaseType', 'id', 'name');
}
/**
- * Normalize the whitespace in an XML document
+ * Normalize the whitespace in an XML document.
*
* @param string $xml
* @return string
}
/**
- * Build test suite dynamically
+ * Build test suite dynamically.
*/
public static function suite() {
$inst = self::getInstance();
}
/**
- * Helper for testing timestamp manipulation
+ * Helper for testing timestamp manipulation.
*
* Create a contact and perform a series of steps with it; after each
* step, ensure that the contact's modified_date has increased.
}
/**
- * Search with only type
+ * Search with only type.
* success expected.
*/
public function testSearchWithType() {
}
/**
- * Search with only subtype
+ * Search with only subtype.
* success expected.
*/
public function testSearchWithSubype() {
}
/**
- * Search with type as well as subtype
+ * Search with type as well as subtype.
* success expected.
*/
public function testSearchWithTypeSubype() {
}
/**
- * Search with invalid type or subtype
+ * Search with invalid type or subtype.
*/
public function testSearchWithInvalidData() {
// for invalid type
}
/**
- * Search with wrong type or subtype
+ * Search with wrong type or subtype.
*/
public function testSearchWithWrongdData() {
}
/**
- * Methods create Contact with valid data
+ * Methods create Contact with valid data.
* success expected
*/
public function testCreateContact() {
}
/**
- * Update the contact with no subtype to a valid subtype
+ * Update the contact with no subtype to a valid subtype.
* success expected
*/
public function testUpdateContactNosubtypeToValid() {
}
/**
- * Update the contact with subtype to another valid subtype
+ * Update the contact with subtype to another valid subtype.
* success expected
*/
public function testUpdateContactSubtype() {
}
/**
- * Methods create relationshipType with valid data
+ * Methods create relationshipType with valid data.
* success expected
*/
public function testRelationshipTypeAddIndiviParent() {
}
/**
- * Methods create relationshipe within same contact type with invalid Relationships
+ * Methods create relationshipe within same contact type with invalid Relationships.
*/
public function testRelationshipCreateInvalidWithinSameType() {
//check for Individual to Parent
}
/**
- * Methods create relationshipe within diff contact type with invalid Relationships
+ * Methods create relationshipe within diff contact type with invalid Relationships.
*/
public function testRelCreateInvalidWithinDiffTypeSpocorIndivi() {
//check for Sponcer to Individual
}
/**
- * Methods create relationshipe within same contact type with valid data
+ * Methods create relationshipe within same contact type with valid data.
* success expected
*/
public function testRelationshipCreateWithinSameType() {
}
/**
- * Methods create relationshipe within different contact type with valid data
+ * Methods create relationshipe within different contact type with valid data.
* success expected
*/
public function testRelCreateWithinDiffTypeSponsorIndivi() {
class CRM_Contact_BAO_GroupContactCacheTest extends CiviUnitTestCase {
/**
- * Manually add and remove contacts from a smart group
+ * Manually add and remove contacts from a smart group.
*/
public function testManualAddRemove() {
// Create smart group $g
}
/**
- * Assert that the cache for a group contains exactly the listed contacts
+ * Assert that the cache for a group contains exactly the listed contacts.
*
* @param array $expectedContactIds
* Array(int).
}
/**
- * Load saved search sql files into the DB
+ * Load saved search sql files into the DB.
*/
public function loadSavedSearches() {
$dsn = CRM_Core_Config::singleton()->dsn;
}
/**
- * Check that we get a successful result querying for home address
+ * Check that we get a successful result querying for home address.
* CRM-14263 search builder failure with search profile & address in criteria
*/
public function testSearchProfileHomeCityCRM14263() {
}
/**
- * Check that we get a successful result querying for home address
+ * Check that we get a successful result querying for home address.
* CRM-14263 search builder failure with search profile & address in criteria
*/
public function testSearchProfileHomeCityNoResultsCRM14263() {
}
/**
- * Build test suite dynamically
+ * Build test suite dynamically.
*/
public static function suite() {
$inst = self::getInstance();
}
/**
- * Display sort name during
+ * Display sort name during.
* contribution batch update through profile
* sortName();
*/
}
/**
- * Add premium during online Contribution
+ * Add premium during online Contribution.
*
* AddPremium();
*/
}
/**
- * Build test suite dynamically
+ * Build test suite dynamically.
*/
public static function suite() {
$inst = self::getInstance();
/**
- * Test store function for country
+ * Test store function for country.
*/
public function testStoreCountry() {
$params = array();
}
/**
- * Test store function for file
+ * Test store function for file.
*/
public function atestStoreFile() {
$params = array();
}
/**
- * Test store function for state province
+ * Test store function for state province.
*/
public function testStoreStateProvince() {
$params = array();
}
/**
- * Test store function for date
+ * Test store function for date.
*/
public function testStoreDate() {
$params = array();
}
/**
- * Test store function for rich text editor
+ * Test store function for rich text editor.
*/
public function testStoreRichTextEditor() {
$params = array();
}
/**
- * Test getEntityValues function for stored value
+ * Test getEntityValues function for stored value.
*/
public function testgetEntityValues() {
}
/**
- * Testing Activity Generation through Entity Recursion
+ * Testing Activity Generation through Entity Recursion.
*/
public function testActivityGeneration() {
//Activity set initial params
}
/**
- * Testing Event Generation through Entity Recursion
+ * Testing Event Generation through Entity Recursion.
*/
public function testEventGeneration() {
//Event set initial params
}
/**
- * Randomly pick among two options
+ * Randomly pick among two options.
*/
public function testPick_rand() {
$communityMessages = new CRM_Core_CommunityMessages(
}
/**
- * Setup an active module with a malformed entity declaration
+ * Setup an active module with a malformed entity declaration.
*/
public function testInvalidDeclarationModule() {
// create first managed entity ('foo')
}
/**
- * Setup an active module with a malformed entity declaration
+ * Setup an active module with a malformed entity declaration.
*/
public function testMissingName() {
// create first managed entity ('foo')
}
/**
- * Setup an active module with a malformed entity declaration
+ * Setup an active module with a malformed entity declaration.
*/
public function testMissingEntity() {
// create first managed entity ('foo')
}
/**
- * Create a single post dated payment as a recurring transaction
+ * Create a single post dated payment as a recurring transaction.
*/
public function testCreateSinglePostDated() {
$start_date = date('Ymd', strtotime("+ 1 week"));
}
/**
- * Test the LoadObjects function with recurring membership data
+ * Test the LoadObjects function with recurring membership data.
*/
public function testLoadMembershipObjects() {
$this->_setUpMembershipObjects();
}
/**
- * Test the LoadObjects function with recurring membership data
+ * Test the LoadObjects function with recurring membership data.
*/
public function testLoadMembershipObjectsLoadAll() {
$this->_setUpMembershipObjects();
}
/**
- * Test the LoadObjects function with recurring membership data
+ * Test the LoadObjects function with recurring membership data.
*/
public function testsendMailMembershipObjects() {
$this->_setUpMembershipObjects();
}
/**
- * Test the LoadObjects function with recurring membership data
+ * Test the LoadObjects function with recurring membership data.
*/
public function testsendMailMembershipWithoutLoadObjects() {
$this->_setUpMembershipObjects();
}
/**
- * Test that loadObjects works with participant values
+ * Test that loadObjects works with participant values.
*/
public function testLoadParticipantObjects() {
$this->_setUpParticipantObjects();
}
/**
- * Test the LoadObjects function with a participant
+ * Test the LoadObjects function with a participant.
*/
public function testComposeMailParticipant() {
$this->_setUpParticipantObjects();
}
/**
- * Test the LoadObjects function with recurring membership data
+ * Test the LoadObjects function with recurring membership data.
*/
public function testsendMailParticipantObjectsCheckLog() {
$this->_setUpParticipantObjects();
}
/**
- * Test the LoadObjects function with recurring membership data
+ * Test the LoadObjects function with recurring membership data.
*/
public function testsendMailParticipantObjectsNoMail() {
$this->_setUpParticipantObjects();
}
/**
- * Test that loadObjects works with participant values
+ * Test that loadObjects works with participant values.
*/
public function testLoadPledgeObjects() {
$this->_setUpPledgeObjects();
}
/**
- * Test that loadObjects works with participant values
+ * Test that loadObjects works with participant values.
*/
public function testLoadPledgeObjectsInvalidPledgeID() {
$this->_setUpPledgeObjects();
}
/**
- * Test the LoadObjects function with a pledge
+ * Test the LoadObjects function with a pledge.
*/
public function testsendMailPledge() {
$this->_setUpPledgeObjects();
}
/**
- * Prepare for membership test
+ * Prepare for membership test.
*/
public function _setUpMembershipObjects() {
try {
}
/**
- * Set up participant requirements for test
+ * Set up participant requirements for test.
*/
public function _setUpParticipantObjects() {
$event = $this->eventCreate(array('is_email_confirm' => 1));
}
/**
- * Set up participant requirements for test
+ * Set up participant requirements for test.
*/
public function _setUpPledgeObjects() {
$this->_pledgeId = $this->pledgeCreate($this->_contactId);
}
/**
- * Get PaymentExpress IPN for a single transaction
+ * Get PaymentExpress IPN for a single transaction.
* @return array
* array representing a Paypal IPN POST
*/
}
/**
- * Get IPN results from follow on IPN transactions
+ * Get IPN results from follow on IPN transactions.
* @return array
* array representing a Paypal IPN POST
*/
}
/**
- * Test that each of the major content formats are correctly evaluated
+ * Test that each of the major content formats are correctly evaluated.
*/
public function testAllTypes() {
CRM_Core_Region::instance('testAllTypes')->add(array(
}
/**
- * Test in which an outer function makes multiple calls to inner functions
+ * Test in which an outer function makes multiple calls to inner functions.
* but then rolls back the entire set.
*
* @param string $createStyle
}
/**
- * Perform a series of operations within smaller transactions
+ * Perform a series of operations within smaller transactions.
*
* @param string $nesting
* 'reuse-tx'|'nest-tx' how to construct transaction.
}
/**
- * Build test suite dynamically
+ * Build test suite dynamically.
*/
public static function suite() {
$inst = self::getInstance();
}
/**
- * helper function to record participant with paid contribution
+ * helper function to record participant with paid contribution.
* @param $feeTotal
* @param $actualPaidAmt
*
}
/**
- * Build test suite dynamically
+ * Build test suite dynamically.
*/
public static function suite() {
$inst = self::getInstance();
}
/**
- * Build test suite dynamically
+ * Build test suite dynamically.
*/
public static function suite() {
$inst = self::getInstance();
}
/**
- * Install an extension with a valid type name
+ * Install an extension with a valid type name.
*/
public function testInstallDisableUninstall() {
$manager = $this->system->getManager();
}
/**
- * Install an extension with a valid type name
+ * Install an extension with a valid type name.
*/
public function testInstallDisableEnable() {
$manager = $this->system->getManager();
}
/**
- * Install an extension with a valid type name
+ * Install an extension with a valid type name.
*/
public function testInstallDisableUninstall() {
$manager = $this->system->getManager();
}
/**
- * Install an extension with a valid type name
+ * Install an extension with a valid type name.
*/
public function testInstallDisableEnable() {
$manager = $this->system->getManager();
}
/**
- * Install an extension with a valid type name
+ * Install an extension with a valid type name.
*/
public function testInstallDisableUninstall() {
$manager = $this->system->getManager();
}
/**
- * Install an extension with a valid type name
+ * Install an extension with a valid type name.
*/
public function testInstallDisableEnable() {
$manager = $this->system->getManager();
}
/**
- * Install an extension with a valid type name
+ * Install an extension with a valid type name.
*/
public function testInstallDisableUninstall() {
$manager = $this->system->getManager();
}
/**
- * Install an extension with a valid type name
+ * Install an extension with a valid type name.
*/
public function testInstallDisableEnable() {
$manager = $this->system->getManager();
}
/**
- * Install an extension with an invalid type name
+ * Install an extension with an invalid type name.
*
* @expectedException CRM_Extension_Exception
*/
}
/**
- * Install an extension with a valid type name
+ * Install an extension with a valid type name.
*
* Note: We initially install two extensions but then toggle only
* the second. This controls for bad SQL queries which hit either
}
/**
- * Install an extension with a valid type name
+ * Install an extension with a valid type name.
*/
public function testInstall_Disable_Enable() {
$testingTypeManager = $this->getMock('CRM_Extension_Manager_Interface');
}
/**
- * Install an extension with a valid type name
+ * Install an extension with a valid type name.
*/
public function testEnableBare() {
$testingTypeManager = $this->getMock('CRM_Extension_Manager_Interface');
}
/**
- * Get the status of an unknown extension
+ * Get the status of an unknown extension.
*/
public function testStatusUnknownKey() {
$testingTypeManager = $this->getMock('CRM_Extension_Manager_Interface');
}
/**
- * Install a module and then replace it with new code
+ * Install a module and then replace it with new code.
*
* Note that some metadata changes between versions -- the original has
* file="oddball", and the upgrade has file="newextension".
*/
protected $_permissionedGroup;
/**
- * AS disabled group the contact has permission to
+ * AS disabled group the contact has permission to.
* @var unknown
*/
protected $_permissionedDisabledGroup;
}
/**
- * ACL Group hook
+ * ACL Group hook.
*/
public function testGroupListAclGroupHookDisabled() {
$this->_params['status'] = 2;
}
/**
- * ACL Group hook
+ * ACL Group hook.
*/
public function testGroupListAclGroupHookDisabledFound() {
$this->_params['status'] = 2;
}
/**
- * ACL Group hook
+ * ACL Group hook.
*/
public function testGroupListAclGroupHookDisabledNotFound() {
$this->_params['status'] = 2;
/**
- * ACL Group hook
+ * ACL Group hook.
*/
public function testGroupListAclGroupHook() {
$this->setHookAndRequest('access CiviCRM', 'hook_civicrm_aclGroup');
}
/**
- * ACL Group hook
+ * ACL Group hook.
*/
public function testGroupListAclGroupHookTitleNotFound() {
$this->_params['title'] = 'n';
}
/**
- * ACL Group hook
+ * ACL Group hook.
*/
public function testGroupListAclGroupHookTitleFound() {
$this->_params['title'] = 'p';
}
/**
- * ACL Group hook
+ * ACL Group hook.
*/
public function testGroupListAclGroupHookAll() {
$this->_params['status'] = 3;
}
/**
- * ACL Group hook
+ * ACL Group hook.
*/
public function testGroupListAclGroupHookEnabled() {
$this->_params['status'] = 1;
}
/**
- * Implements ACLGroup hook
+ * Implements ACLGroup hook.
* aclGroup function returns a list of permitted groups
* @param string $type
* @param int $contactID
/**
- * Basic send
+ * Basic send.
*/
public function testSend() {
$contact_params_1 = array(
}
/**
- * Build test suite dynamically
+ * Build test suite dynamically.
*/
public static function suite() {
$inst = self::getInstance();
/**
- * Get the contribution
+ * Get the contribution.
* page id from the membership record
*/
public function testgetContributionPageId() {
}
/**
- * Delete related memberships
+ * Delete related memberships.
*/
public function testdeleteRelatedMemberships() {
$contactId = Contact::createIndividual();
}
/**
- * Renew membership with change in membership type
+ * Renew membership with change in membership type.
*/
public function testRenewMembership() {
$contactId = Contact::createIndividual();
}
/**
- * Renew stale membership
+ * Renew stale membership.
*/
public function testStaleMembership() {
$statusId = 3;
}
/**
- * Build test suite dynamically
+ * Build test suite dynamically.
*/
public static function suite() {
$inst = self::getInstance();
class CRM_Member_Form_MembershipTest extends CiviUnitTestCase {
/**
- * Test setup for every test
+ * Test setup for every test.
*
* Connect to the database, truncate the tables that will be used
* and redirect stdin to a temporary file
*/
class CRM_Member_Import_Parser_MembershipTest extends CiviUnitTestCase {
/**
- * Membership type name used in test function
+ * Membership type name used in test function.
* @var String
*/
protected $_membershipTypeName = NULL;
/**
- * Membership type id used in test function
+ * Membership type id used in test function.
* @var String
*/
protected $_membershipTypeID = NULL;
}
/**
- * Test Import
+ * Test Import.
*/
public function testImport() {
$contactId = $this->individualCreate();
}
/**
- * Build params
+ * Build params.
*/
private function pcpBlockParams() {
$contribPage = CRM_Core_DAO::createTestObject('CRM_Contribute_DAO_ContributionPage');
}
/**
- * Build params
+ * Build params.
*/
private function pcpParams() {
$contact = CRM_Core_DAO::createTestObject('CRM_Contact_DAO_Contact');
}
/**
- * Build test suite dynamically
+ * Build test suite dynamically.
*/
public static function suite() {
$inst = self::getInstance();
}
/**
- * Retrieve a payment based on a Null pledge id
+ * Retrieve a payment based on a Null pledge id.
*/
public function testRetrieveStringPledgeID() {
$payment = CRM_Core_DAO::createTestObject('CRM_Pledge_BAO_PledgePayment');
}
/**
- * Test that payment retrieve wrks based on known pledge id
+ * Test that payment retrieve wrks based on known pledge id.
*/
public function testRetrieveKnownPledgeID() {
$payment = CRM_Core_DAO::createTestObject('CRM_Pledge_BAO_PledgePayment');
}
/**
- * Delete Payments payments for one pledge
+ * Delete Payments payments for one pledge.
*/
public function testDeletePledgePaymentsNormal() {
$payment = CRM_Core_DAO::createTestObject('CRM_Pledge_BAO_PledgePayment');
}
/**
- * Pass Null Id for a payment deletion for one pledge
+ * Pass Null Id for a payment deletion for one pledge.
*/
public function testDeletePledgePaymentsNullId() {
$payment = CRM_Core_DAO::createTestObject('CRM_Pledge_BAO_PledgePayment');
}
/**
- * Pass Zero Id for a payment deletion for one pledge
+ * Pass Zero Id for a payment deletion for one pledge.
*/
public function testDeletePaymentsZeroId() {
$payment = CRM_Core_DAO::createTestObject('CRM_Pledge_BAO_PledgePayment');
}
/**
- * Retrieve a payment based on a Null pledge id random string
+ * Retrieve a payment based on a Null pledge id random string.
*/
public function testRetrieveStringPledgeID() {
$defaults = array();
}
/**
- * Test that payment retrieve wrks based on known pledge id
+ * Test that payment retrieve wrks based on known pledge id.
*/
public function testRetrieveKnownPledgeID() {
$params = array(
}
/**
- * Build test suite dynamically
+ * Build test suite dynamically.
*/
public static function suite() {
$inst = self::getInstance();
}
/**
- * Build test suite dynamically
+ * Build test suite dynamically.
*/
public static function suite() {
$inst = self::getInstance();
/* Define a list of queue providers which should be tested */
/**
- * Return a list of persistent and transient queue providers
+ * Return a list of persistent and transient queue providers.
*/
public function getQueueSpecs() {
$queueSpecs = array();
/* Define a list of queue providers which should be tested */
/**
- * Return a list of persistent and transient queue providers
+ * Return a list of persistent and transient queue providers.
*/
public function getQueueSpecs() {
$queueSpecs = array();
}
/**
- * Claim an item from the queue and release it back for subsequent processing
+ * Claim an item from the queue and release it back for subsequent processing.
*
* @dataProvider getQueueSpecs
* @param $queueSpec
}
/**
- * Test that item leases expire at the expected time
+ * Test that item leases expire at the expected time.
*
* @dataProvider getQueueSpecs
* @param $queueSpec
}
/**
- * Test that item leases can be ignored
+ * Test that item leases can be ignored.
*
* @dataProvider getQueueSpecs
* @param $queueSpec
}
/**
- * Test that queue content is not reset when reset is omitted
+ * Test that queue content is not reset when reset is omitted.
*
* @dataProvider getQueueSpecs
* @param $queueSpec
}
/**
- * Spot check a few fields that should appear in schema
+ * Spot check a few fields that should appear in schema.
*/
public function testGetSchema() {
$schema = CRM_UF_Page_ProfileEditor::getSchema(array('IndividualModel', 'ActivityModel'));
}
/**
- * Build test suite dynamically
+ * Build test suite dynamically.
*/
public static function suite() {
$inst = self::getInstance();
}
/**
- * Add and remove two items from the same cache instance
+ * Add and remove two items from the same cache instance.
*/
public function testSameInstance() {
$a = new CRM_Utils_Cache_SqlGroup(array(
}
/**
- * Add item to one cache instance then read with another
+ * Add item to one cache instance then read with another.
*/
public function testTwoInstance() {
$a = new CRM_Utils_Cache_SqlGroup(array(
class CRM_Utils_GlobalStackTest extends CiviUnitTestCase {
/**
- * Temporarily override global variables and ensure that the variable data
+ * Temporarily override global variables and ensure that the variable data.
* is set as expected (before/during/after the override).
*/
public function testPushPop() {
}
/**
- * Build test suite dynamically
+ * Build test suite dynamically.
*/
public static function suite() {
$inst = self::getInstance();
}
/**
- * 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 $testCase
* @param string $daoName
}
/**
- * 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 $testCase
* @param $daoName
* @param $searchParams
protected $_webtest = FALSE;
/**
- * Constructor
+ * Constructor.
*
* @param CiviSeleniumTestCase|CiviUnitTestCase $unit_test The currently running test
* @param bool $startImmediately
}
/**
- * Start writing emails to db instead of current option
+ * Start writing emails to db instead of current option.
*/
public function start() {
if ($this->_webtest) {
*/
/**
- * Check contents of mail log
+ * Check contents of mail log.
*
* @param array $strings
* Strings that should be included.
}
/**
- * Check that mail log is empty
+ * Check that mail log is empty.
* @param string $prefix
*/
public function assertMailLogEmpty($prefix = '') {
}
/**
- * Remove any sent messages from the log
+ * Remove any sent messages from the log.
*/
public function clearMessages() {
if ($this->_webtest) {
protected $loggedInAs = NULL;
/**
- * Constructor
+ * Constructor.
*
* Because we are overriding the parent class constructor, we
* need to show the same arguments as exist in the constructor of
}
/**
- * Authenticate as drupal user
+ * Authenticate as drupal user.
* @param $user : (str) the key 'user' or 'admin', or a literal username
* @param $pass : (str) if $user is a literal username and not 'user' or 'admin', supply the password
*/
}
/**
- * Click on a link or button
+ * Click on a link or button.
* Wait for the page to load
* Wait for an element to be present
* @param $element
}
/**
- * Click a link or button and wait for an ajax dialog to load
+ * Click a link or button and wait for an ajax dialog to load.
* @param string $element
* @param string $waitFor
*/
}
/**
- * Click a link or button and wait for ajax content to load or refresh
+ * Click a link or button and wait for ajax content to load or refresh.
* @param string $element
* @param string $waitFor
*/
}
/**
- * Wait for all ajax snippets to finish loading
+ * Wait for all ajax snippets to finish loading.
*/
public function waitForAjaxContent() {
$this->waitForElementNotPresent('css=.blockOverlay');
}
/**
- * Call the API on the local server
+ * Call the API on the local server.
* (kind of defeats the point of a webtest - see CRM-11889)
* @param $entity
* @param $action
}
/**
- * Call the API on the remote server
+ * Call the API on the remote server.
* Experimental - currently only works if permissions on remote site allow anon user to access ajax api
* @see CRM-11889
* @param $entity
}
/**
- * Ensures the required CiviCRM components are enabled
+ * Ensures the required CiviCRM components are enabled.
* @param $components
*/
public function enableComponents($components) {
}
/**
- * Add a contact with the given first and last names and either a given email
+ * Add a contact with the given first and last names and either a given email.
* (when specified), a random email (when true) or no email (when unspecified or null).
*
* @param string $fname
}
/**
- * Types text into a ckEditor rich text field in a form
+ * Types text into a ckEditor rich text field in a form.
*
* @param string $fieldName
* Form field name (as assigned by PHP buildForm class).
}
/**
- * Types option label and name into a table of multiple choice options
+ * Types option label and name into a table of multiple choice options.
* (for price set fields of type select, radio, or checkbox)
* TODO: extend for custom field multiple choice table input
*
}
/**
- * Use a contact EntityRef field to add a new contact
+ * Use a contact EntityRef field to add a new contact.
* @param string $field
* Selector.
* @param string $contactType
}
/**
- * Generic function to check that strings are present in the page
+ * Generic function to check that strings are present in the page.
*
* @strings array array of strings or a single string
*
}
/**
- * Returns a single argument from the url query
+ * Returns a single argument from the url query.
* @param $arg
* @param null $url
* @return null
}
/**
- * Generic function to compare expected values after an api call to retrieved
+ * Generic function to compare expected values after an api call to retrieved.
* DB values.
*
* @param string $daoName
}
/**
- * 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
}
/**
- * Add new Financial Account
+ * Add new Financial Account.
* @param $financialAccountTitle
* @param bool $financialAccountDescription
* @param bool $accountingCode
}
/**
- * Edit Financial Account
+ * Edit Financial Account.
* @param $editfinancialAccount
* @param bool $financialAccountTitle
* @param bool $financialAccountDescription
}
/**
- * Delete Financial Account
+ * Delete Financial Account.
* @param $financialAccountTitle
*/
public function _testDeleteFinancialAccount($financialAccountTitle) {
}
/**
- * Verify data after ADD and EDIT
+ * Verify data after ADD and EDIT.
* @param $verifyData
*/
public function _assertFinancialAccount($verifyData) {
}
/**
- * Give the specified permissions
+ * Give the specified permissions.
* Note: this function logs in as 'admin' (logging out if necessary)
* @param $permission
*/
}
/**
- * Ensure we have a default mailbox set up for CiviMail
+ * Ensure we have a default mailbox set up for CiviMail.
*/
public function setupDefaultMailbox() {
$this->openCiviPage('admin/mailSettings', 'action=update&id=1&reset=1');
}
/**
- * Type and select first occurance of autocomplete
+ * Type and select first occurance of autocomplete.
* @param $fieldName
* @param $label
* @param bool $multiple
}
/**
- * Select multiple options
+ * Select multiple options.
* @param $fieldid
* @param $params
*/
}
/**
- * Attempt to get information about what went wrong if we encounter an error when loading a page
+ * Attempt to get information about what went wrong if we encounter an error when loading a page.
*/
public function checkForErrorsOnPage() {
foreach (array('Access denied', 'Page not found') as $err) {
class CiviTestSuite extends PHPUnit_Framework_TestSuite {
/**
- * Simple name based constructor
+ * Simple name based constructor.
* @param string $theClass
* @param string $name
*/
}
/**
- * Test suite setup
+ * Test suite setup.
*/
protected function setUp() {
//print __METHOD__ . "\n";
}
/**
- * Test suite teardown
+ * Test suite teardown.
*/
protected function tearDown() {
//print __METHOD__ . "\n";
}
/**
- * suppress failed test error issued by phpunit when it finds
+ * suppress failed test error issued by phpunit when it finds.
* a test suite with no tests
*/
public function testNothing() {
*/
protected $_apiversion = API_LATEST_VERSION;
/**
- * Database has been initialized
+ * Database has been initialized.
*
* @var boolean
*/
private static $dbInit = FALSE;
/**
- * Database connection
+ * Database connection.
*
* @var PHPUnit_Extensions_Database_DB_IDatabaseConnection
*/
protected $_dbconn;
/**
- * The database name
+ * The database name.
*
* @var string
*/
static protected $_dbName;
/**
- * Track tables we have modified during a test
+ * Track tables we have modified during a test.
*/
protected $_tablesToTruncate = array();
protected $origExtensionSystem;
/**
- * Constructor
+ * Constructor.
*
* Because we are overriding the parent class constructor, we
* need to show the same arguments as exist in the constructor of
}
/**
- * Create database connection for this instance
+ * Create database connection for this instance.
*
* Initialize the test database if it hasn't been initialized
*
}
/**
- * Required implementation of abstract method
+ * Required implementation of abstract method.
*/
protected function getDataSet() {
}
}
/**
- * Common setup functions for all unit tests
+ * Common setup functions for all unit tests.
*/
protected function setUp() {
$session = CRM_Core_Session::singleton();
}
/**
- * Read everything from the datasets directory and insert into the db
+ * Read everything from the datasets directory and insert into the db.
*/
public function loadAllFixtures() {
$fixturesDir = __DIR__ . '/../../fixtures';
}
/**
- * Emulate a logged in user since certain functions use that
+ * Emulate a logged in user since certain functions use that.
* value to store a record in the DB (like activity)
* CRM-8180
*/
}
/**
- * Create default domain contacts for the two domains added during test class
+ * Create default domain contacts for the two domains added during test class.
* database population.
*/
public function createDomainContacts() {
}
/**
- * Common teardown functions for all unit tests
+ * Common teardown functions for all unit tests.
*/
protected function tearDown() {
error_reporting(E_ALL & ~E_NOTICE);
}
/**
- * Generic function to compare expected values after an api call to retrieved
+ * Generic function to compare expected values after an api call to retrieved.
* DB values.
*
* @daoName string DAO Name of object we're evaluating.
}
/**
- * 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
}
/**
- * Assert that a SQL query returns a given value
+ * Assert that a SQL query returns a given value.
*
* The first argument is an expected value. The remaining arguments are passed
* to CRM_Core_DAO::singleValueQuery
}
/**
- * wrap api functions
+ * wrap api functions.
* so we can ensure they succeed & throw exceptions without litterering the test with checks
*
* @param string $entity
}
/**
- * This function exists to wrap api functions
+ * This function exists to wrap api functions.
* so we can ensure they succeed, generate and example & throw exceptions without litterering the test with checks
*
* @param string $entity
}
/**
- * This function exists to wrap api functions
+ * This function exists to wrap api functions.
* so we can ensure they fail where expected & throw exceptions without litterering the test with checks
* @param string $entity
* @param string $action
}
/**
- * Helper function for getting sample contact properties
+ * Helper function for getting sample contact properties.
*
* @param string $contact_type
* enum contact type: Individual, Organization
}
/**
- * Delete Membership Type
+ * Delete Membership Type.
*
* @param array $params
*/
}
/**
- * Delete Relatinship Type
+ * Delete Relatinship Type.
*
* @param int $relationshipTypeID
*/
}
/**
- * Create Participant
+ * Create Participant.
*
* @param array $params
* Array of contact id and event id values.
}
/**
- * Create Payment Processor
+ * Create Payment Processor.
*
* @return CRM_Financial_DAO_PaymentProcessor
* instance of Payment Processsor
}
/**
- * Create contribution page
+ * Create contribution page.
*
* @param array $params
* @return array
}
/**
- * Create Tag
+ * Create Tag.
*
* @param array $params
* @return array
}
/**
- * Delete Tag
+ * Delete Tag.
*
* @param int $tagId
* Id of the tag to be deleted.
}
/**
- * Create contribution
+ * Create contribution.
*
* @param int $cID
* Contact_id.
}
/**
- * Delete contribution
+ * Delete contribution.
*
* @param int $pledgeId
*/
}
/**
- * Create contribution
+ * Create contribution.
*
* @param int $cID
* Contact_id.
}
/**
- * Create online contribution
+ * Create online contribution.
*
* @param array $params
* @param int $financialType
}
/**
- * Delete contribution
+ * Delete contribution.
*
* @param int $contributionId
*
}
/**
- * Create an Event
+ * Create an Event.
*
* @param array $params
* Name-value pair for an event.
}
/**
- * Delete event
+ * Delete event.
*
* @param int $id
* ID of the event.
}
/**
- * Delete participant
+ * Delete participant.
*
* @param int $participantID
*
}
/**
- * Create participant payment
+ * Create participant payment.
*
* @param int $participantID
* @param int $contributionID
}
/**
- * Delete participant payment
+ * Delete participant payment.
*
* @param int $paymentID
*/
}
/**
- * Add a Location
+ * Add a Location.
*
* @param int $contactID
* @return int
}
/**
- * Delete Locations of contact
+ * Delete Locations of contact.
*
* @param array $params
* Parameters.
}
/**
- * Add a Location Type
+ * Add a Location Type.
*
* @param array $params
* @return CRM_Core_DAO_LocationType
}
/**
- * Delete a Location Type
+ * Delete a Location Type.
*
* @param int $locationTypeId
*/
}
/**
- * Add a Group
+ * Add a Group.
*
* @param array $params
* @return int
/**
- * Function to add a Group
+ * Function to add a Group.
*
* @params array to add group
*
}
/**
- * Delete a Group
+ * Delete a Group.
*
* @param int $gid
*/
}
/**
- * Create a UFField
+ * Create a UFField.
* @param array $params
*/
public function uFFieldCreate($params = array()) {
}
/**
- * Add a UF Join Entry
+ * Add a UF Join Entry.
*
* @param array $params
* @return int
}
/**
- * Delete a UF Join Entry
+ * Delete a UF Join Entry.
*
* @param array $params
* with missing uf_group_id
}
/**
- * Create Group for a contact
+ * Create Group for a contact.
*
* @param int $contactId
*/
}
/**
- * Delete Group for a contact
+ * Delete Group for a contact.
*
* @param int $contactId
*/
}
/**
- * Create Activity
+ * Create Activity.
*
* @param array $params
* @return array|int
}
/**
- * Create an activity type
+ * Create an activity type.
*
* @param array $params
* Parameters.
}
/**
- * Delete activity type
+ * Delete activity type.
*
* @param int $activityTypeId
* Id of the activity type.
}
/**
- * Create custom group
+ * Create custom group.
*
* @param array $params
* @return array|int
}
/**
- * Create custom group with multi fields
+ * Create custom group with multi fields.
* @param array $params
* @return array|int
*/
}
/**
- * Create custom group with multi fields
+ * Create custom group with multi fields.
* @param array $params
* @return array
*/
}
/**
- * Delete custom group
+ * Delete custom group.
*
* @param int $customGroupID
*
}
/**
- * Create custom field
+ * Create custom field.
*
* @param array $params
* (custom_group_id) is required.
}
/**
- * Delete custom field
+ * Delete custom field.
*
* @param int $customFieldID
*
}
/**
- * Create note
+ * Create note.
*
* @param int $cId
* @return array
}
/**
- * Enable CiviCampaign Component
+ * Enable CiviCampaign Component.
*/
public function enableCiviCampaign() {
CRM_Core_BAO_ConfigSetting::enableComponent('CiviCampaign');
}
/**
- * Delete note
+ * Delete note.
*
* @param array $params
*
}
/**
- * Create custom field with Option Values
+ * Create custom field with Option Values.
*
* @param array $customGroup
* @param string $name
}
/**
- * Get formatted values in the actual and expected result
+ * Get formatted values in the actual and expected result.
* @param array $actual
* Actual calculated values.
* @param array $expected
}
/**
- * Generate a temporary folder
+ * Generate a temporary folder.
*
* @param string $prefix
* @return string
}
/**
- * Temporarily replace the singleton extension with a different one
+ * Temporarily replace the singleton extension with a different one.
* @param \CRM_Extension_System $system
*/
public function setExtensionSystem(CRM_Extension_System $system) {
}
/**
- * Create an instance of the paypal processor
+ * Create an instance of the paypal processor.
* @todo this isn't a great place to put it - but really it belongs on a class that extends
* this parent class & we don't have a structure for that yet
* There is another function to this effect on the PaypalPro test but it appears to be silently failing
}
/**
- * Set up initial recurring payment allowing subsequent IPN payments
+ * Set up initial recurring payment allowing subsequent IPN payments.
*/
public function setupRecurringPaymentProcessorTransaction() {
$contributionRecur = $this->callAPISuccess('contribution_recur', 'create', array(
}
/**
- * Helper function to create new mailing
+ * Helper function to create new mailing.
* @return mixed
*/
public function createMailing() {
}
/**
- * Helper function to delete mailing
+ * Helper function to delete mailing.
* @param $id
*/
public function deleteMailing($id) {
}
/**
- * Wrap the entire test case in a transaction
+ * Wrap the entire test case in a transaction.
*
* Only subsequent DB statements will be wrapped in TX -- this cannot
* retroactively wrap old DB statements. Therefore, it makes sense to
*/
class Contact extends CiviUnitTestCase {
/**
- * Helper function to create
+ * Helper function to create.
* a contact
*
* @param array $params
}
/**
- * Helper function to delete a contact
+ * Helper function to delete a contact.
*
* @param int $contactID
* Id of the contact to delete.
*/
class ContributionPage extends PHPUnit_Framework_Testcase {
/**
- * Helper function to create
+ * Helper function to create.
* a Contribution Page
*
* @param int $id
}
/**
- * Helper function to delete a Contribution Page
+ * Helper function to delete a Contribution Page.
*
* @param int $contributionPageId
* Id of the Contribution Page.
*/
class Custom extends CiviUnitTestCase {
/**
- * Helper function to create Custom Group
+ * Helper function to create Custom Group.
*
* @deprecated - use functions on test case parent class
*
}
/**
- * Helper function to create Custom Field
+ * Helper function to create Custom Field.
* @deprecated use parent object create fn
* @param array $params
* @param null $fields
}
/**
- * Helper function to delete custom field
+ * Helper function to delete custom field.
*
* @deprecated use function on parent class
*
}
/**
- * Helper function to delete custom group
+ * Helper function to delete custom group.
*
* @deprecated use function on parent class
*
}
/**
- * Helper function to delete an Event
+ * Helper function to delete an Event.
*
* @param int $eventId
* @return bool
*/
class Membership extends PHPUnit_Framework_Testcase {
/**
- * Helper function to create membership type
+ * Helper function to create membership type.
*/
public function createMembershipType() {
$orgId = Contact::createOrganisation();
}
/**
- * Helper function to create membership block for contribution page
+ * Helper function to create membership block for contribution page.
* @param $membershipType
* @param $contributionPageId
* @return $this
}
/**
- * Helper function to delete the membership block
+ * Helper function to delete the membership block.
* @param $blcokId
*/
public function deleteMembershipBlock($blcokId) {
*/
class Participant extends PHPUnit_Framework_Testcase {
/**
- * Helper function to create a Participant
+ * Helper function to create a Participant.
*
* @param int $contactId
* @param int $eventId
}
/**
- * Helper function to delete a participant
+ * Helper function to delete a participant.
*
* @param int $participantId
* @return bool
}
/**
- * Called before the test functions will be executed
+ * Called before the test functions will be executed.
* this function is defined in PHPUnit_TestCase and overwritten
* here
*/
}
/**
- * Called after the test functions are executed
+ * Called after the test functions are executed.
* this function is defined in PHPUnit_TestCase and overwritten
* here.
*/
}
/**
- * test the toString function
+ * test the toString function.
*/
public function testHello() {
$result = $this->abc;
class Utils {
/**
- * PDO for the database
+ * PDO for the database.
* @var PDO
*/
public $pdo;
/**
- * Construct an object for this database
+ * Construct an object for this database.
* @param $host
* @param $port
* @param $user
}
/**
- * Prepare and execute a query
+ * Prepare and execute a query.
*
* If the query fails, output a diagnostic message
* @param string $query
}
/**
- * 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
}
/**
- * create a contact and return the contact id
+ * create a contact and return the contact id.
* @param string $firstName
* @param string $lastName
*
}
/**
- * 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
}
/**
- * 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
*
}
/**
- * randomly generates data for a specific custom field
+ * randomly generates data for a specific custom field.
* @param int $contact_id
* @param int $group_id
*/
}
/**
- * Build test suite dynamically
+ * Build test suite dynamically.
*/
public static function suite() {
$inst = self::getInstance();
}
/**
- * function to check match for sumbit Advance Search
+ * function to check match for sumbit Advance Search.
* @param string $firstName
*/
public function submitSearch($firstName) {
}
/**
- * function to fill basic search detail
+ * function to fill basic search detail.
* @param string $firstName
* @param string $groupName
* @param $tagName
}
/**
- * 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) {
}
/**
- * function to fill activity search block in advance search
+ * function to fill activity search block in advance search.
* @param $firstName
*/
public function addActivitySearchDetail($firstName) {
}
/**
- * function to fill demographic search details
+ * function to fill demographic search details.
*/
public function addDemographicSearchDetail() {
// fill birth date range
}
/**
- * function to fill contribution search details
+ * function to fill contribution search details.
* @param $firstName
*/
public function addContributionSearchDetail($firstName) {
}
/**
- * function to fill participant search details
+ * function to fill participant search details.
*/
public function addParticipantSearchDetail() {
// fill event name
}
/**
- * function to fill member search details
+ * function to fill member search details.
* @param $firstName
*/
public function addMemberSearchDetail($firstName) {
}
/**
- * function to fill member search details
+ * function to fill member search details.
* @param $firstName
*/
public function addPledgeSearchDetail($firstName) {
}
/**
- * Test that option to create a cms user is present on a contact who
+ * Test that option to create a cms user is present on a contact who.
* does not have a cms account already (in this case, a new
* contact).
*/
}
/**
- * Enter values in an inline edit block and save
+ * Enter values in an inline edit block and save.
*
* @param string $block
* selector.
}
/**
- * Helper FN
+ * Helper FN.
* @param null $firstName
* @param null $lastName
* @param null $organizationName
}
/**
- * Helper FN
+ * Helper FN.
* to create new membership type
* @param $membershipOrganization
*/
}
/**
- * Enter form values in a Search Builder row
+ * Enter form values in a Search Builder row.
* @param $set
* @param $row
* @param $entity
}
/**
- * common function for doing offline contribution
+ * common function for doing offline contribution.
* @param array $params
* @param string $firstName
* @param string $lastName
}
/**
- * this functionality is broken hence skipping the test
+ * this functionality is broken hence skipping the test.
*/
public function skiptestAuthenticatedMultipleEvent() {
}
/**
- * this functionality is broken hence skipping the test
+ * this functionality is broken hence skipping the test.
*/
public function skiptestAnonymousMultipleEvent() {
// This is the path where our testing install resides.
}
/**
- * Check for Valid Street Address
+ * Check for Valid Street Address.
*/
public function testValidStreetAddressParsing() {
$this->webtestLogin();
}
/**
- * Check for Invalid Street Address
+ * Check for Invalid Street Address.
*/
public function testInvalidStreetAddressParsing() {
$this->webtestLogin();
}
/**
- * Check Street Address when Address Parsing is Disabled
+ * Check Street Address when Address Parsing is Disabled.
*/
public function testStreetAddress() {
$this->webtestLogin();
}
/**
- * Helper function to provide data for contact import for Household
+ * Helper function to provide data for contact import for Household.
* Duplicate Matching.
*
* @param $householdFields
}
/**
- * Helper function to add new contact
+ * Helper function to add new contact.
*
* @param string $firstName
* @param string $lastName
}
/**
- * Helper function to add new event
+ * Helper function to add new event.
*
* @param array $params
*
}
/**
- * Helper function to provide data for multiple relationship import
+ * Helper function to provide data for multiple relationship import.
* for Individuals.
*
* @return array
}
/**
- * Helper function to add new event
+ * Helper function to add new event.
*
* @param array $params
* Parameters to create an event.
class WebTest_Release_ReleaseTestCase extends CiviSeleniumTestCase {
/**
- * Constructor
+ * Constructor.
*
* Because we are overriding the parent class constructor, we
* need to show the same arguments as exist in the constructor of
}
/**
- * Submit a request with an API key that exists but does not correspond to
+ * Submit a request with an API key that exists but does not correspond to.
* a real user. Submit in "?entity=X&action=X" notation
*/
public function testNotCMSUser_entityAction() {
}
/**
- * Function tests that an empty where hook returns no results
+ * Function tests that an empty where hook returns no results.
*/
public function testContactGetNoResultsHook() {
$this->hookClass->setHook('civicrm_aclWhereClause', array($this, 'aclWhereHookNoResults'));
}
/**
- * Function tests all results are returned
+ * Function tests all results are returned.
*/
public function testContactGetAllResultsHook() {
$this->hookClass->setHook('civicrm_aclWhereClause', array($this, 'aclWhereHookAllResults'));
}
/**
- * Function tests that deleted contacts are not returned
+ * Function tests that deleted contacts are not returned.
*/
public function testContactGetPermissionHookNoDeleted() {
$this->callAPISuccess('contact', 'create', array('id' => 2, 'is_deleted' => 1));
}
/**
- * Test permissions limited by hook
+ * Test permissions limited by hook.
*/
public function testContactGetHookLimitingHook() {
$this->hookClass->setHook('civicrm_aclWhereClause', array($this, 'aclWhereOnlySecond'));
}
/**
- * Check that id works as a filter
+ * Check that id works as a filter.
*/
public function testContactGetIDFilter() {
$this->hookClass->setHook('civicrm_aclWhereClause', array($this, 'aclWhereHookAllResults'));
}
/**
- * Check that address IS returned
+ * Check that address IS returned.
*/
public function testContactGetAddressReturned() {
$this->hookClass->setHook('civicrm_aclWhereClause', array($this, 'aclWhereOnlySecond'));
}
/**
- * Check that pledge IS not returned
+ * Check that pledge IS not returned.
*/
public function testContactGetPledgeIDNotReturned() {
$this->hookClass->setHook('civicrm_aclWhereClause', array($this, 'aclWhereHookAllResults'));
}
/**
- * Check that pledge IS not an allowable filter
+ * Check that pledge IS not an allowable filter.
*/
public function testContactGetPledgeIDNotFiltered() {
$this->hookClass->setHook('civicrm_aclWhereClause', array($this, 'aclWhereHookAllResults'));
}
/**
- * No results returned
+ * No results returned.
* @param $type
* @param $tables
* @param $whereTables
}
/**
- * All results returned
+ * All results returned.
* @implements CRM_Utils_Hook::aclWhereClause
* @param $type
* @param $tables
}
/**
- * Full results returned
+ * Full results returned.
* @implements CRM_Utils_Hook::aclWhereClause
* @param $type
* @param $tables
}
/**
- * Check if required fields are not passed
+ * Check if required fields are not passed.
*/
public function testActivityCreateWithoutRequired() {
$params = array(
}
/**
- * test that get functioning does filtering
+ * test that get functioning does filtering.
*/
public function testGetFilter() {
$params = array(
}
/**
- * test that get functioning does filtering
+ * test that get functioning does filtering.
*/
public function testGetStatusID() {
$params = array(
}
/**
- * test that get functioning does filtering
+ * test that get functioning does filtering.
*/
public function testGetFilterMaxDate() {
$params = array(
}
/**
- * Check activity deletion without activity type
+ * Check activity deletion without activity type.
*/
public function testDeleteActivityWithoutActivityType() {
$params = array('id' => 1);
}
/**
- * Check activity deletion with incorrect data
+ * Check activity deletion with incorrect data.
*/
public function testDeleteActivityWithIncorrectActivityType() {
$params = array(
}
/**
- * Check activity deletion with correct data
+ * Check activity deletion with correct data.
*/
public function testDeleteActivity() {
$result = $this->callAPISuccess('activity', 'create', $this->_params);
}
/**
- * Check if required fields are not passed
+ * Check if required fields are not passed.
*/
public function testActivityUpdateWithoutRequired() {
$params = array(
}
/**
- * Check with incorrect required fields
+ * Check with incorrect required fields.
*/
public function testActivityUpdateWithIncorrectContactActivityType() {
$params = array(
}
/**
- * Check activity update with status
+ * Check activity update with status.
*/
public function testActivityUpdateWithStatus() {
$activity = $this->callAPISuccess('activity', 'create', $this->_params);
}
/**
- * Create an address with a master ID and ensure that a relationship is created
+ * Create an address with a master ID and ensure that a relationship is created.
*/
public function testCreateAddressWithMasterRelationshipHousehold() {
$householdID = $this->householdCreate();
}
/**
- * Create an address with a master ID and ensure that a relationship is created
+ * Create an address with a master ID and ensure that a relationship is created.
*/
public function testCreateAddressWithMasterRelationshipOrganization() {
$address = $this->callAPISuccess('address', 'create', $this->_params);
}
/**
- * Create an address with a master ID and ensure that a relationship is created
+ * Create an address with a master ID and ensure that a relationship is created.
*/
public function testCreateAddressWithMasterRelationshipChangingOrganization() {
$address = $this->callAPISuccess('address', 'create', $this->_params);
}
/**
- * test address deletion
+ * test address deletion.
*/
public function testDeleteAddress() {
//check there are no address to start with
private static $instance = NULL;
/**
- * Simple name based constructor
+ * Simple name based constructor.
+ *
* @param string $theClass
* @param string $name
*/
}
/**
- * Build test suite dynamically
+ * Build test suite dynamically.
*/
public static function suite() {
$inst = self::getInstance();
class api_v3_CRM11793Test extends CiviUnitTestCase {
/**
- * Test setup for every test
+ * Test setup for every test.
*
* Connect to the database, truncate the tables that will be used
* and redirect stdin to a temporary file
protected $_apiversion = 3;
/**
- * Test setup for every test
+ * Test setup for every test.
*
* Connect to the database, truncate the tables that will be used
* and redirect stdin to a temporary file
}
/**
- * Verify that attempt to create individual contact with first
+ * Verify that attempt to create individual contact with first.
* and last names and email succeeds
*/
public function testCreateIndividualWithNameEmail() {
}
/**
- * Verify that attempt to create individual contact with no data fails
+ * Verify that attempt to create individual contact with no data fails.
*/
public function testCreateIndividualWithOutNameEmail() {
$params = array(
}
/**
- * Verify that attempt to create individual contact with first
+ * Verify that attempt to create individual contact with first.
* and last names, email and location type succeeds
*/
public function testCreateIndividualWithNameEmailLocationType() {
}
/**
- * Verify successful update of organization contact
+ * Verify successful update of organization contact.
*/
public function testUpdateOrganizationWithAll() {
// Insert a row in civicrm_contact creating organization contact
}
/**
- * Test to check return works OK
+ * Test to check return works OK.
*/
public function testContactGetReturnValues() {
$extraParams = array('nick_name' => 'Bob', 'phone' => '456', 'email' => 'e@mail.com');
}
/**
- * Verify attempt to create individual with chained arrays
+ * Verify attempt to create individual with chained arrays.
*/
public function testGetIndividualWithChainedArrays() {
$ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__);
}
/**
- * test TrueFalse format
+ * test TrueFalse format.
*/
public function testContactCreateFormatIsSuccessFalse() {
}
/**
- * test Single Entity format
+ * test Single Entity format.
*/
public function testContactGetSingle_entity_array() {
$this->createContactFromXML();
}
/**
- * Test add methods with valid data
+ * Test add methods with valid data.
* success expected
*/
public function testContactCreate() {
/**
- * Test add with invalid data
+ * Test add with invalid data.
*/
public function testContactAddInvalidData() {
/**
- * Test update with no subtype to valid subtype
+ * Test update with no subtype to valid subtype.
* success expected
*/
public function testContactUpdateNoSubtypeValid() {
/**
- * Test update with no subtype to invalid subtype
+ * Test update with no subtype to invalid subtype.
*/
public function testContactUpdateNoSubtypeInvalid() {
}
/**
- * Test update with no subtype to valid subtype
+ * Test update with no subtype to valid subtype.
* success expected
*/
public function testContactUpdateSubtypeValid() {
}
/**
- * Test update with no subtype to invalid subtype
+ * Test update with no subtype to invalid subtype.
*/
public function testContactUpdateSubtypeInvalid() {
protected $contribution_result = NULL;
protected $_priceSetParams = array();
/**
- * Payment processor details
+ * Payment processor details.
* @var array
*/
protected $_paymentProcessor = array();
/**
- * Test form submission with basic price set
+ * Test form submission with basic price set.
*/
public function testSubmit() {
$this->setUpContributionPage();
}
/**
- * Test submit with a membership block in place
+ * Test submit with a membership block in place.
*/
public function testSubmitMembershipBlockNotSeparatePayment() {
$this->setUpMembershipContributionPage();
}
/**
- * Test submit with a membership block in place
+ * Test submit with a membership block in place.
*/
public function testSubmitMembershipBlockIsSeparatePayment() {
$this->setUpMembershipContributionPage(TRUE);
}
/**
- * Test submit with a membership block in place
+ * Test submit with a membership block in place.
*/
public function testSubmitMembershipBlockTwoTypesIsSeparatePayment() {
$this->_ids['membership_type'] = array($this->membershipTypeCreate(array('minimum_fee' => 6)));
}
/**
- * Test submit with a membership block in place
+ * Test submit with a membership block in place.
*/
public function testSubmitMembershipBlockIsSeparatePaymentPaymentProcessor() {
$this->setUpMembershipContributionPage(TRUE);
}
/**
- * Set up membership contribution page
+ * Set up membership contribution page.
* @param bool $isSeparatePayment
*/
public function setUpMembershipContributionPage($isSeparatePayment = FALSE) {
}
/**
- * Help function to set up contribution page with some defaults
+ * Help function to set up contribution page with some defaults.
*/
public function setUpContributionPage() {
$contributionPageResult = $this->callAPISuccess($this->_entity, 'create', $this->params);
}
/**
- * Test get methods
+ * Test get methods.
* @todo - this might be better broken down into more smaller tests
*/
public function testGetContributionSoft() {
}
/**
- * Function tests that additional financial records are created when fee amount is recorded
+ * Function tests that additional financial records are created when fee amount is recorded.
*/
public function testCreateContributionSoft() {
$params = array(
}
/**
- * To Update Soft Contribution
+ * To Update Soft Contribution.
*
*/
public function testCreateUpdateContributionSoft() {
}
/**
- * Test checks that passing in line items suppresses the create mechanism
+ * Test checks that passing in line items suppresses the create mechanism.
*/
public function testCreateContributionChainedLineItems() {
$params = array(
}
/**
- * Test create with valid payment instument
+ * Test create with valid payment instument.
*/
public function testCreateContributionWithPaymentInstrument() {
$params = $this->_params + array('payment_instrument' => 'EFT');
}
/**
- * Create test with unique field name on source
+ * Create test with unique field name on source.
*/
public function testCreateContributionSource() {
}
/**
- * Create test with unique field name on source
+ * Create test with unique field name on source.
*/
public function testCreateDefaultNow() {
}
/**
- * Function tests that additional financial records are created when online contribution with pending option
+ * Function tests that additional financial records are created when online contribution with pending option.
* is created
*/
public function testCreateContributionPendingOnline() {
}
/**
- * Function tests that financial records are updated when Payment Instrument is changed
+ * Function tests that financial records are updated when Payment Instrument is changed.
*/
public function testCreateUpdateContributionPaymentInstrument() {
$instrumentId = $this->_addPaymentInstrument();
}
/**
- * Function tests that financial records are added when Contribution is Refunded
+ * Function tests that financial records are added when Contribution is Refunded.
*/
public function testCreateUpdateContributionRefund() {
$contribParams = array(
}
/**
- * Function tests invalid contribution status change
+ * Function tests invalid contribution status change.
*/
public function testCreateUpdateContributionInValidStatusChange() {
$contribParams = array(
}
/**
- * Function tests that financial records are added when Pending Contribution is Canceled
+ * Function tests that financial records are added when Pending Contribution is Canceled.
*/
public function testCreateUpdateContributionCancelPending() {
$contribParams = array(
}
/**
- * Function tests that financial records are added when Financial Type is Changed
+ * Function tests that financial records are added when Financial Type is Changed.
*/
public function testCreateUpdateContributionChangeFinancialType() {
$contribParams = array(
}
/**
- * To Update Contribution
+ * To Update Contribution.
* CHANGE: we require the API to do an incremental update
*/
public function testCreateUpdateContribution() {
}
/**
- * Test completing a transaction via the API
+ * Test completing a transaction via the API.
*
* Note that we are creating a logged in user because email goes out from
* that person
}
/**
- * Test completing a transaction with an event via the API
+ * Test completing a transaction with an event via the API.
*
* Note that we are creating a logged in user because email goes out from
* that person
}
/**
- * Test membership is renewed when transaction completed
+ * Test membership is renewed when transaction completed.
*/
public function testCompleteTransactionMembershipPriceSet() {
$this->createPriceSetWithPage('membership');
}
/**
- * Test membership is renewed when transaction completed
+ * Test membership is renewed when transaction completed.
*/
public function testCompleteTransactionMembershipPriceSetTwoTerms() {
$this->createPriceSetWithPage('membership');
}
/**
- * Set up a pending transaction with a specific price field id
+ * Set up a pending transaction with a specific price field id.
* @param int $priceFieldValueID
*/
public function setUpPendingContribution($priceFieldValueID) {
}
/**
- * Test sending a mail via the API
+ * Test sending a mail via the API.
*/
public function testSendMail() {
$mut = new CiviMailUtils($this, TRUE);
}
/**
- * Test sending a mail via the API
+ * Test sending a mail via the API.
*/
public function testSendMailEvent() {
$mut = new CiviMailUtils($this, TRUE);
}
/**
- * Check with no array
+ * Check with no array.
*/
public function testCustomFieldCreateNoArray() {
$fieldParams = NULL;
}
/**
- * Check with no label
+ * Check with no label.
*/
public function testCustomFieldCreateWithoutLabel() {
$customGroup = $this->customGroupCreate(array('extends' => 'Individual', 'title' => 'text_test_group'));
}
/**
- * Check with edit
+ * Check with edit.
*/
public function testCustomFieldCreateWithEdit() {
$customGroup = $this->customGroupCreate(array('extends' => 'Individual', 'title' => 'text_test_group'));
}
/**
- * Check without groupId
+ * Check without groupId.
*/
public function testCustomFieldCreateWithoutGroupID() {
$fieldParams = array(
}
/**
- * Test using example code
+ * Test using example code.
*/
/*function testCustomFieldCreateExample( )
{
}
/**
- * Test custom field with existing option group
+ * Test custom field with existing option group.
*/
public function testCustomFieldExistingOptionGroup() {
$customGroup = $this->customGroupCreate(array('extends' => 'Organization', 'title' => 'test_group'));
///////////////// civicrm_custom_field_delete methods
/**
- * Check with no array
+ * Check with no array.
*/
public function testCustomFieldDeleteNoArray() {
$params = NULL;
}
/**
- * Check without Field ID
+ * Check without Field ID.
*/
public function testCustomFieldDeleteWithoutFieldID() {
$params = array();
}
/**
- * Check without valid array
+ * Check without valid array.
*/
public function testCustomFieldDelete() {
$customGroup = $this->customGroupCreate(array('extends' => 'Individual', 'title' => 'test_group'));
}
/**
- * Check for Option Value
+ * Check for Option Value.
*/
public function testCustomFieldOptionValueDelete() {
$customGroup = $this->customGroupCreate(array('extends' => 'Contact', 'title' => 'ABC'));
///////////////// civicrm_custom_group_create methods
/**
- * Check with empty array
+ * Check with empty array.
* note that these tests are of marginal value so should not be included in copy & paste
* code. The SyntaxConformance is capable of testing this for all entities on create
* & delete (& it would be easy to add if not there)
}
/**
- * Check with empty array
+ * Check with empty array.
*/
public function testCustomGroupCreateNoExtends() {
$params = array(
}
/**
- * Check with empty array
+ * Check with empty array.
*/
public function testCustomGroupCreateInvalidExtends() {
$params = array(
}
/**
- * Check with a string instead of array for extends
+ * Check with a string instead of array for extends.
*/
public function testCustomGroupCreateExtendsString() {
$params = array(
}
/**
- * Check with valid array
+ * Check with valid array.
*/
public function testCustomGroupCreate() {
$params = array(
}
/**
- * Check with valid array
+ * Check with valid array.
*/
public function testCustomGroupGetFields() {
$params = array(
}
/**
- * Check with style missing from params array
+ * Check with style missing from params array.
*/
public function testCustomGroupCreateNoStyle() {
$params = array(
}
/**
- * Check with not array
+ * Check with not array.
*/
public function testCustomGroupCreateNotArray() {
$params = NULL;
}
/**
- * Check without title
+ * Check without title.
*/
public function testCustomGroupCreateNoTitle() {
$params = array(
}
/**
- * Check for household without weight
+ * Check for household without weight.
*/
public function testCustomGroupCreateHouseholdNoWeight() {
$params = array(
}
/**
- * Check for Contribution Donation
+ * Check for Contribution Donation.
*/
public function testCustomGroupCreateContributionDonation() {
$params = array(
}
/**
- * Check with valid array
+ * Check with valid array.
*/
public function testCustomGroupCreateGroup() {
$params = array(
///////////////// civicrm_custom_group_delete methods
/**
- * Check without GroupID
+ * Check without GroupID.
*/
public function testCustomGroupDeleteWithoutGroupID() {
$customGroup = $this->callAPIFailure('custom_group', 'delete', array());
}
/**
- * Check with no array
+ * Check with no array.
*/
public function testCustomGroupDeleteNoArray() {
$params = NULL;
}
/**
- * Check with valid custom group id
+ * Check with valid custom group id.
*/
public function testCustomGroupDelete() {
$customGroup = $this->customGroupCreate(array('extends' => 'Individual', 'title' => 'test_group'));
}
/**
- * Main success get function
+ * Main success get function.
*/
public function testGetCustomGroupSuccess() {
}
/**
- * Test that custom fields is returned for correct contact type only
+ * Test that custom fields is returned for correct contact type only.
*/
public function testGetFields() {
$result = $this->callAPISuccess('Contact', 'getfields', array());
// Retrieve Methods
/**
- * Retrieve Valid custom Data added to Individual Contact Type
+ * Retrieve Valid custom Data added to Individual Contact Type.
*/
public function testRetrieveValidCustomDataToIndividual() {
protected $_apiversion = 3;
/**
- * Test setup for every test
+ * Test setup for every test.
*
* Connect to the database, truncate the tables that will be used
* and redirect stdin to a temporary file
protected $_apiversion = 3;
/**
- * Test setup for every test
+ * Test setup for every test.
*
* Connect to the database, truncate the tables that will be used
* and redirect stdin to a temporary file
}
/**
- * Test that an event with a price set can be created
+ * Test that an event with a price set can be created.
*/
public function testCreatePaidEvent() {
//@todo alter API so that an integer is converted to an array
}
/**
- * Test that passing in Unique field names works
+ * Test that passing in Unique field names works.
*/
public function testCreateEventSuccessUniqueFieldNames() {
$this->_params[0]['event_start_date'] = $this->_params[0]['start_date'];
}
/**
- * Trying to delete an event with participants should return error
+ * Trying to delete an event with participants should return error.
*/
public function testDeleteWithExistingParticipant() {
$contactID = $this->individualCreate();
}
/**
- * Check checkbox type custom fields are created correctly
+ * Check checkbox type custom fields are created correctly.
* We want to ensure they are saved with separators as appropriate
*/
public function testCreateCustomCheckboxGrant() {
}
/**
- * This is a test to check if setting fields one at a time alters other fields
+ * This is a test to check if setting fields one at a time alters other fields.
* Issues Hit so far =
* 1) Currency keeps getting reset to USD - BUT this may be the only enabled currency
* - in which case it is valid
protected $_groupId1;
/**
- * Set up for group contact tests
+ * Set up for group contact tests.
*
* @todo set up calls function that doesn't work @ the moment
*/
///////////////// civicrm_group_organization_create methods
/**
- * Check with valid params
+ * Check with valid params.
*/
public function testGroupOrganizationCreate() {
$params = array(
}
/**
- * Check with empty params array
+ * Check with empty params array.
*/
public function testGroupOrganizationCreateWithEmptyParams() {
$params = array();
}
/**
- * Check with invalid params
+ * Check with invalid params.
*/
public function testGroupOrganizationCreateParamsNotArray() {
$params = 'group_org';
}
/**
- * Check with invalid params keys
+ * Check with invalid params keys.
*/
public function testGroupOrganizationCreateWithInvalidKeys() {
$params = array(
}
/**
- * Check mailing is sent
+ * Check mailing is sent.
*/
public function testProcessMailing() {
$this->createContactsInGroup(10, $this->_groupID);
}
/**
- * Test creation
+ * Test creation.
*/
public function testCreateMailSettings() {
$this->callAPISuccessGetCount('mail_settings', array(), 1);
}
/**
- * Test caches cleared adequately
+ * Test caches cleared adequately.
*/
public function testCreateUpdateMailSettings() {
$result = $this->callAPISuccess('MailSettings', 'create', $this->params);
}
/**
- * Test get method
+ * Test get method.
*/
public function testGetMailSettings() {
$this->callAPIAndDocument('MailSettings', 'create', $this->params, __FUNCTION__, __FILE__);
}
/**
- * Test chained delete
+ * Test chained delete.
*/
public function testGetMailSettingsChainDelete() {
$description = "demonstrates get + delete in the same call";
}
/**
- * Test that trying to delete membership status while membership still exists creates error
+ * Test that trying to delete membership status while membership still exists creates error.
*/
public function testDeleteWithMembershipError() {
$membershipStatusID = $this->membershipStatusCreate();
}
/**
- * Change custom field using update
+ * Change custom field using update.
*/
public function testUpdateWithCustom() {
$ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__);
}
/**
- * Test that if membership join date is not set it defaults to today
+ * Test that if membership join date is not set it defaults to today.
*/
public function testEmptyJoinDate() {
unset($this->_params['join_date'], $this->_params['is_override']);
}
/**
- * Test that if membership end date is not set it defaults to correct end date
+ * Test that if membership end date is not set it defaults to correct end date.
* - rolling
*/
public function testEmptyEndDateFixed() {
}
/**
- * Test that if membership end date is not set it defaults to correct end date
+ * Test that if membership end date is not set it defaults to correct end date.
* - rolling
*/
public function testEmptyEndDateRolling() {
}
/**
- * Test create function succeeds
+ * Test create function succeeds.
*/
public function testCreate() {
$result = $this->callAPIAndDocument('MessageTemplate', 'create', $this->params, __FUNCTION__, __FILE__);
}
/**
- * Check the delete function succeeds
+ * Check the delete function succeeds.
*/
public function testDelete() {
$entity = $this->createTestEntity();
}
/**
- * Good to test option group as a representative on the Camel Case
+ * Good to test option group as a representative on the Camel Case.
*/
public function testGetOptionGroupGetFields() {
$result = $this->callAPISuccess('option_group', 'getfields', array());
}
/**
- * Test the error message when a failure is due to a key duplication issue
+ * Test the error message when a failure is due to a key duplication issue.
*/
public function testGetOptionCreateFailOnDuplicate() {
$params = array(
}
/**
- * Success test for updating an existing Option Group
+ * Success test for updating an existing Option Group.
*/
public function testCreateUpdateOptionGroup() {
$result = $this->callAPISuccess($this->_entity, 'create', $this->_params);
}
/**
- * Success test for deleting an existing Option Group
+ * Success test for deleting an existing Option Group.
*/
public function testDeleteOptionGroup() {
$result = $this->callAPISuccess($this->_entity, 'create', $this->_params);
}
/**
- * Test limit param
+ * Test limit param.
*/
public function testGetOptionValueLimit() {
$params = array();
}
/**
- * Test offset param
+ * Test offset param.
*/
public function testGetOptionValueOffSet() {
}
/**
- * Test offset param
+ * Test offset param.
*/
public function testGetSingleValueOptionValueSort() {
$description = "demonstrates use of Sort param (available in many api functions). Also, getsingle";
}
/**
- * Check that component continues to be honoured
+ * Check that component continues to be honoured.
*/
public function testCreateOptionSpecifyComponent() {
$result = $this->callAPISuccess('option_group', 'get', array(
}
/**
- * Check that component string is honoured
+ * Check that component string is honoured.
*/
public function testCreateOptionSpecifyComponentString() {
$result = $this->callAPISuccess('option_group', 'get', array(
}
/**
- * Check with valid array
+ * Check with valid array.
*/
public function testPaymentCreate() {
//Create Contribution & get contribution ID
}
/**
- * Check with empty array
+ * Check with empty array.
*/
public function testPaymentUpdateEmpty() {
$params = array();
}
/**
- * Check financial records for offline Participants
+ * Check financial records for offline Participants.
*/
public function testPaymentOffline() {
}
/**
- * Check financial records for online Participant
+ * Check financial records for online Participant.
*/
public function testPaymentOnline() {
}
/**
- * Check financial records for online Participant pay later scenario
+ * Check financial records for online Participant pay later scenario.
*/
public function testPaymentPayLaterOnline() {
}
/**
- * Check with empty array
+ * Check with empty array.
*/
public function testPaymentDeleteWithEmptyParams() {
$params = array();
}
/**
- * Check with wrong id
+ * Check with wrong id.
*/
public function testPaymentDeleteWithWrongID() {
$params = array(
}
/**
- * Check with valid array
+ * Check with valid array.
*/
public function testPaymentDelete() {
///////////////// civicrm_participant_get methods
/**
- * Check with wrong params type
+ * Check with wrong params type.
*/
public function testGetWrongParamsType() {
$params = 'a string';
}
/**
- * Check with params id
+ * Check with params id.
*/
public function testGetParamsAsIdOnly() {
$params = array(
}
/**
- * Check with params id
+ * Check with params id.
*/
public function testGetNestedEventGet() {
//create a second event & add participant to it.
}
/**
- * Check Participant Get respects return properties
+ * Check Participant Get respects return properties.
*/
public function testGetWithReturnProperties() {
$params = array(
}
/**
- * Check with complete array
+ * Check with complete array.
*/
public function testCreateAllParams() {
$params = $this->_params;
}
/**
- * Check with complete array
+ * Check with complete array.
*/
public function testUpdate() {
$participantId = $this->participantCreate(array(
}
/**
- * Check with empty array
+ * Check with empty array.
*/
public function testUpdateEmptyParams() {
$params = array();
}
/**
- * Check with Invalid participantId
+ * Check with Invalid participantId.
*/
public function testUpdateWithWrongParticipantId() {
$params = array(
}
/**
- * Check with Invalid ContactId
+ * Check with Invalid ContactId.
*/
public function testUpdateWithWrongContactId() {
$participantId = $this->participantCreate(array(
}
/**
- * Test creation of a participant with an associated contribution
+ * Test creation of a participant with an associated contribution.
*/
public function testCreateParticipantWithPayment() {
$description = "single function to create contact w partipation & contribution. Note that in the
///////////////// civicrm_payment_processor_add methods
/**
- * Check with no name
+ * Check with no name.
*/
public function testPaymentProcessorCreateWithoutName() {
$payProcParams = array(
}
/**
- * Create payment processor
+ * Create payment processor.
*/
public function testPaymentProcessorCreate() {
$params = $this->_params;
}
/**
- * Test using example code
+ * Test using example code.
*/
public function testPaymentProcessorCreateExample() {
require_once 'api/v3/examples/PaymentProcessor/Create.php';
///////////////// civicrm_payment_processor_delete methods
/**
- * Check payment processor delete
+ * Check payment processor delete.
*/
public function testPaymentProcessorDelete() {
$id = $this->testPaymentProcessorCreate();
///////////////// civicrm_payment_processor_type_add methods
/**
- * Check with no name
+ * Check with no name.
*/
public function testPaymentProcessorTypeCreateWithoutName() {
$payProcParams = array(
}
/**
- * Create payment processor type
+ * Create payment processor type.
*/
public function testPaymentProcessorTypeCreate() {
$params = array(
}
/**
- * Test using example code
+ * Test using example code.
*/
public function testPaymentProcessorTypeCreateExample() {
require_once 'api/v3/examples/PaymentProcessorType/Create.php';
///////////////// civicrm_payment_processor_type_delete methods
/**
- * Check with empty array
+ * Check with empty array.
*/
public function testPaymentProcessorTypeDeleteEmpty() {
$params = array();
}
/**
- * Check with No array
+ * Check with No array.
*/
public function testPaymentProcessorTypeDeleteParamsNotArray() {
$result = $this->callAPIFailure('payment_processor_type', 'delete', 'string');
}
/**
- * Check if required fields are not passed
+ * Check if required fields are not passed.
*/
public function testPaymentProcessorTypeDeleteWithoutRequired() {
$params = array(
}
/**
- * Check with incorrect required fields
+ * Check with incorrect required fields.
*/
public function testPaymentProcessorTypeDeleteWithIncorrectData() {
$result = $this->callAPIFailure('payment_processor_type', 'delete', array('id' => 'abcd'));
}
/**
- * Check payment processor type delete
+ * Check payment processor type delete.
*/
public function testPaymentProcessorTypeDelete() {
$payProcType = $this->paymentProcessorTypeCreate();
///////////////// civicrm_payment_processor_type_update
/**
- * Check with empty array
+ * Check with empty array.
*/
public function testPaymentProcessorTypeUpdateEmpty() {
$params = array();
}
/**
- * Check with No array
+ * Check with No array.
*/
public function testPaymentProcessorTypeUpdateParamsNotArray() {
$result = $this->callAPIFailure('payment_processor_type', 'create', 'string');
}
/**
- * Check with all parameters
+ * Check with all parameters.
*/
public function testPaymentProcessorTypeUpdate() {
// create sample payment processor type.
///////////////// civicrm_payment_processor_types_get methods
/**
- * Check with empty array
+ * Check with empty array.
*/
public function testPaymentProcessorTypesGetEmptyParams() {
$results = $this->callAPISuccess('payment_processor_type', 'get', array());
}
/**
- * Test that passing in a single variable works
+ * Test that passing in a single variable works.
*/
public function testGetSinglePledgePayment() {
$createparams = array(
}
/**
- * Test that creating a payment will add the contribution ID
+ * Test that creating a payment will add the contribution ID.
*/
public function testCreatePledgePayment() {
//check that 5 pledge payments exist at the start
}
/**
- * Test checks behaviour when more payments are created than should be possible
+ * Test checks behaviour when more payments are created than should be possible.
*/
public function testCreatePledgePaymentAllCreated() {
$params = array(
}
/**
- * Test that creating a payment will add the contribution ID where only one pledge payment
+ * Test that creating a payment will add the contribution ID where only one pledge payment.
* in schedule
*/
public function testCreatePledgePaymentWhereOnlyOnePayment() {
}
/**
- * Test that pledge with weekly schedule calculates dates correctly
+ * Test that pledge with weekly schedule calculates dates correctly.
*/
public function testCreatePledgeWeeklySchedule() {
$params = array(
}
/**
- * Test that pledge with weekly schedule calculates dates correctly
+ * Test that pledge with weekly schedule calculates dates correctly.
*/
public function testCreatePledgeMontlySchedule() {
$params = array(
}
/**
- * Test that status is set to pending
+ * Test that status is set to pending.
*/
public function testCreatePledgeNoStatus() {
}
/**
- * Update Pledge
+ * Update Pledge.
*/
public function testCreateUpdatePledge() {
// we test 'sequential' param here too
}
/**
- * Std is to accept id
+ * Std is to accept id.
*/
public function testDeletePledgeUseID() {
}
/**
- * Test to make sure empty get returns nothing
+ * Test to make sure empty get returns nothing.
* Note that the function gives incorrect results if no pledges exist as it does a
* contact search instead - test only checks that the get finds the one existing
*/
////////////// test $this->callAPISuccess3_profile_get //////////////////
/**
- * Check Without ProfileId
+ * Check Without ProfileId.
*/
public function testProfileGetWithoutProfileId() {
$params = array(
}
/**
- * Check with no invalid profile Id
+ * Check with no invalid profile Id.
*/
public function testProfileGetInvalidProfileId() {
$params = array(
}
/**
- * Check with success
+ * Check with success.
*/
public function testProfileGet() {
$pofileFieldValues = $this->_createIndividualContact();
}
/**
- * Check contact activity profile without activity id
+ * Check contact activity profile without activity id.
*/
public function testContactActivityGetWithoutActivityId() {
list($params, $expected) = $this->_createContactWithActivity();
}
/**
- * Check contact activity profile wrong activity id
+ * Check contact activity profile wrong activity id.
*/
public function testContactActivityGetWrongActivityId() {
list($params, $expected) = $this->_createContactWithActivity();
}
/**
- * Check contact activity profile with wrong activity type
+ * Check contact activity profile with wrong activity type.
*/
public function testContactActivityGetWrongActivityType() {
//flush cache by calling with reset
}
/**
- * Check contact activity profile with success
+ * Check contact activity profile with success.
*/
public function testContactActivityGetSuccess() {
list($params, $expected) = $this->_createContactWithActivity();
/////////////// test $this->callAPISuccess3_profile_set //////////////////
/**
- * Check Without ProfileId
+ * Check Without ProfileId.
*/
public function testProfileSubmitWithoutProfileId() {
$params = array(
}
/**
- * Check with no invalid profile Id
+ * Check with no invalid profile Id.
*/
public function testProfileSubmitInvalidProfileId() {
$params = array(
}
/**
- * Check with missing required field in profile
+ * Check with missing required field in profile.
*/
public function testProfileSubmitCheckProfileRequired() {
$pofileFieldValues = $this->_createIndividualContact();
}
/**
- * Check with success
+ * Check with success.
*/
public function testProfileSubmit() {
$pofileFieldValues = $this->_createIndividualContact();
}
/**
- * Test that the fields are returned in the right order despite the faffing around that goes on
+ * Test that the fields are returned in the right order despite the faffing around that goes on.
*/
public function testMembershipGetFieldsOrder() {
$result = $this->callAPISuccess('profile', 'getfields', array(
}
/**
- * Set is deprecated but we need to ensure it still works
+ * Set is deprecated but we need to ensure it still works.
*/
public function testLegacySet() {
$pofileFieldValues = $this->_createIndividualContact();
}
/**
- * Check contact activity profile without activity id
+ * Check contact activity profile without activity id.
*/
public function testContactActivitySubmitWithoutActivityId() {
list($params, $expected) = $this->_createContactWithActivity();
}
/**
- * Check contact activity profile wrong activity id
+ * Check contact activity profile wrong activity id.
*/
public function testContactActivitySubmitWrongActivityId() {
list($params, $expected) = $this->_createContactWithActivity();
}
/**
- * Check contact activity profile with wrong activity type
+ * Check contact activity profile with wrong activity type.
*/
public function testContactActivitySubmitWrongActivityType() {
//flush cache by calling with reset
}
/**
- * Check contact activity profile with success
+ * Check contact activity profile with success.
*/
public function testContactActivitySubmitSuccess() {
list($params, $expected) = $this->_createContactWithActivity();
}
/**
- * Check profile apply Without ProfileId
+ * Check profile apply Without ProfileId.
*/
public function testProfileApplyWithoutProfileId() {
$params = array(
}
/**
- * Check profile apply with no invalid profile Id
+ * Check profile apply with no invalid profile Id.
*/
public function testProfileApplyInvalidProfileId() {
$params = array(
}
/**
- * Check with success
+ * Check with success.
*/
public function testProfileApply() {
$pofileFieldValues = $this->_createIndividualContact();
}
/**
- * Create a profile
+ * Create a profile.
*/
public function _createIndividualProfile() {
protected $_apiversion = 3;
protected $_cId_a;
/**
- * Second individual
+ * Second individual.
* @var integer
*/
protected $_cId_a_2;
///////////////// civicrm_relationship_create methods
/**
- * Check with empty array
+ * Check with empty array.
*/
public function testRelationshipCreateEmpty() {
$this->callAPIFailure('relationship', 'create', array());
}
/**
- * Check if required fields are not passed
+ * Check if required fields are not passed.
*/
public function testRelationshipCreateWithoutRequired() {
$params = array(
}
/**
- * Check with incorrect required fields
+ * Check with incorrect required fields.
*/
public function testRelationshipCreateWithIncorrectData() {
}
/**
- * Check relationship creation with invalid Relationship
+ * Check relationship creation with invalid Relationship.
*/
public function testRelationshipCreatInvalidRelationship() {
// both the contact of type Individual
}
/**
- * Check relationship already exists
+ * Check relationship already exists.
*/
public function testRelationshipCreateAlreadyExists() {
$params = array(
}
/**
- * Check relationship already exists
+ * Check relationship already exists.
*/
public function testRelationshipCreateUpdateAlreadyExists() {
$params = array(
/**
- * Check relationship creation
+ * Check relationship creation.
*/
public function testRelationshipCreate() {
$params = array(
}
/**
- * Ensure disabling works
+ * Ensure disabling works.
*/
public function testRelationshipUpdate() {
$result = $this->callAPISuccess('relationship', 'create', $this->_params);
}
/**
- * Check relationship creation
+ * Check relationship creation.
*/
public function testRelationshipCreateEmptyEndDate() {
$params = array(
}
/**
- * Check relationship creation with custom data
+ * Check relationship creation with custom data.
*/
public function testRelationshipCreateWithCustomData() {
$customGroup = $this->createCustomGroup();
///////////////// civicrm_relationship_delete methods
/**
- * Check with empty array
+ * Check with empty array.
*/
public function testRelationshipDeleteEmpty() {
$params = array();
}
/**
- * Check if required fields are not passed
+ * Check if required fields are not passed.
*/
public function testRelationshipDeleteWithoutRequired() {
$params = array(
}
/**
- * Check with incorrect required fields
+ * Check with incorrect required fields.
*/
public function testRelationshipDeleteWithIncorrectData() {
$params = array(
}
/**
- * Check relationship creation
+ * Check relationship creation.
*/
public function testRelationshipDelete() {
$params = array(
///////////////// civicrm_relationship_update methods
/**
- * Check with empty array
+ * Check with empty array.
*/
public function testRelationshipUpdateEmpty() {
$result = $this->callAPIFailure('relationship', 'create', array(),
}
/**
- * Check if required fields are not passed
+ * Check if required fields are not passed.
*/
/**
- * Check relationship update
+ * Check relationship update.
*/
public function testRelationshipCreateDuplicate() {
$relParams = array(
}
/**
- * Test using various operators
+ * Test using various operators.
*/
public function testGetTypeOperators() {
$relTypeParams = array(
}
/**
- * Check with invalid relationshipType Id
+ * Check with invalid relationshipType Id.
*/
public function testRelationshipTypeAddInvalidId() {
$relTypeParams = array(
}
/**
- * Check with valid data with relationshipTypes
+ * Check with valid data with relationshipTypes.
*/
public function testGetRelationshipWithRelTypes() {
$relParams = array(
///////////////// civicrm_relationship_type_add methods
/**
- * Check with no name
+ * Check with no name.
*/
public function testRelationshipTypeCreateWithoutName() {
$relTypeParams = array(
}
/**
- * Check with no contact type
+ * Check with no contact type.
*/
public function testRelationshipTypeCreateWithoutContactType() {
$relTypeParams = array(
}
/**
- * Create relationship type
+ * Create relationship type.
*/
public function testRelationshipTypeCreate() {
$params = array(
}
/**
- * Test using example code
+ * Test using example code.
*/
public function testRelationshipTypeCreateExample() {
require_once 'api/v3/examples/RelationshipType/Create.php';
}
/**
- * Check if required fields are not passed
+ * Check if required fields are not passed.
*/
public function testRelationshipTypeDeleteWithoutRequired() {
$params = array(
}
/**
- * Check with incorrect required fields
+ * Check with incorrect required fields.
*/
public function testRelationshipTypeDeleteWithIncorrectData() {
$params = array(
}
/**
- * Check relationship type delete
+ * Check relationship type delete.
*/
public function testRelationshipTypeDelete() {
$id = $this->_relationshipTypeCreate();
///////////////// civicrm_relationship_type_update
/**
- * Check with empty array
+ * Check with empty array.
*/
public function testRelationshipTypeUpdateEmpty() {
$params = array();
}
/**
- * Check with no contact type
+ * Check with no contact type.
*/
public function testRelationshipTypeUpdateWithoutContactType() {
// create sample relationship type.
}
/**
- * Check with all parameters
+ * Check with all parameters.
*/
public function testRelationshipTypeUpdate() {
// create sample relationship type.
///////////////// civicrm_relationship_types_get methods
/**
- * Check with empty array
+ * Check with empty array.
*/
public function testRelationshipTypesGetEmptyParams() {
$firstRelTypeParams = array(
/**
* /**
- * Check getfields works
+ * Check getfields works.
*/
public function testGetFields() {
$description = 'Demonstrate return from getfields - see subfolder for variants';
}
/**
- * Test that getfields will filter on group
+ * Test that getfields will filter on group.
*/
public function testGetFieldsGroupFilters() {
$params = array('filters' => array('group' => 'multisite'));
}
/**
- * Check getfields works
+ * Check getfields works.
*/
public function testCreateSetting() {
$description = "shows setting a variable for a given domain - if no domain is set current is assumed";
}
/**
- * Check getfields works
+ * Check getfields works.
*/
public function testCreateInvalidSettings() {
$params = array(
}
/**
- * Check getfields works
+ * Check getfields works.
*/
public function testCreateInvalidBooleanSettings() {
$params = array(
}
/**
- * Check getfields works
+ * Check getfields works.
*/
public function testCreateSettingMultipleDomains() {
$description = "shows setting a variable for all domains";
}
/**
- * Check that setting defined in extension can be retrieved
+ * Check that setting defined in extension can be retrieved.
*/
public function testGetExtensionSetting() {
$this->hookClass->setHook('civicrm_alterSettingsFolders', array($this, 'setExtensionMetadata'));
}
/**
- * Use getValue against a config setting
+ * Use getValue against a config setting.
*/
public function testGetValueConfigSetting() {
$params = array(
}
/**
- * Function tests reverting a specific parameter
+ * Function tests reverting a specific parameter.
*/
public function testRevert() {
$params = array(
}
/**
- * Tests filling missing params
+ * Tests filling missing params.
*/
public function testFill() {
$domparams = array(
}
/**
- * Test create function succeeds
+ * Test create function succeeds.
*/
public function testCreateSurvey() {
$result = $this->callAPIAndDocument('survey', 'create', $this->params, __FUNCTION__, __FILE__);
}
/**
- * Check the delete function succeeds
+ * Check the delete function succeeds.
*/
public function testDeleteSurvey() {
$entity = $this->createTestEntity();
}
/**
- * Generate list of entities to test for get by id functions
+ * Generate list of entities to test for get by id functions.
* @param bool $sequential
* @return array
* Entities to be skipped
}
/**
- * Create two entities and make sure we can fetch them individually by ID
+ * Create two entities and make sure we can fetch them individually by ID.
*
* @dataProvider entities_get
*
}
/**
- * Check that get fetches an appropriate number of results
+ * Check that get fetches an appropriate number of results.
*
* @param string $entityName
* Name of entity to test.
///////////////// civicrm_domain_get methods
/**
- * Test system flush
+ * Test system flush.
*/
public function testFlush() {
// Note: this operation actually flushes several different caches; we don't
}
/**
- * Test system log function
+ * Test system log function.
*/
public function testSystemLog() {
$this->callAPISuccess('system', 'log', array('level' => 'info', 'message' => 'We wish you a merry Christmas'));
}
/**
- * Test system log function
+ * Test system log function.
*/
public function testSystemLogNoLevel() {
$this->callAPISuccess('system', 'log', array('message' => 'We wish you a merry Christmas', 'level' => 'alert'));
*/
protected $ids = array();
/**
- * Tag id
+ * Tag id.
* @var integer
*/
protected $tag = array();
}
/**
- * Online and offline contrbution from above created contrbution page
+ * Online and offline contrbution from above created contrbution page.
*/
public function testCreateContributionOnline() {
$this->setUpContributionPage();
}
/**
- * Updation of contrbution
+ * Updation of contrbution.
* Function tests that line items, financial records are updated when contribution amount is changed
*/
public function testCreateUpdateContributionChangeTotal() {
}
/**
- * Deleting field
+ * Deleting field.
*/
public function testDeleteUFField() {
$ufField = $this->callAPISuccess('uf_field', 'create', $this->_params);
}
/**
- * Updating group
+ * Updating group.
*/
public function testUpdateUFGroup() {
$params = array(
}
/**
- * Find uf join group id
+ * Find uf join group id.
*/
public function testFindUFGroupId() {
$params = array(
}
/**
- * Find uf join id
+ * Find uf join id.
*/
public function testGetUFJoinId() {
$params = array(
}
/**
- * Fetch contact id by uf id
+ * Fetch contact id by uf id.
*/
public function testGetUFMatchID() {
$params = array(
}
/**
- * Fetch uf id by contact id
+ * Fetch uf id by contact id.
*/
public function testGetUFID() {
$params = array(
/**
- * Test GET DAO function returns DAO
+ * Test GET DAO function returns DAO.
*/
public function testGetDAO() {
$params = array(
}
/**
- * Test GET BAO function returns BAO when it exists
+ * Test GET BAO function returns BAO when it exists.
*/
public function testGetBAO() {
$params = array(
}
/**
- * Test retrieval of metadata
+ * Test retrieval of metadata.
*/
public function testGetMetadata() {
$result = $this->callAPIAndDocument($this->_entity, 'get', array(
}
/**
- * Test retrieval of label metadata
+ * Test retrieval of label metadata.
*/
public function testGetFields() {
$result = $this->callAPIAndDocument($this->_entity, 'getfields', array('action' => 'get'), __FUNCTION__, __FILE__);