*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class provides the functionality to save a search
+ * This class provides the functionality to save a search.
+ *
* Saved Searches are used for saving frequently used queries
*/
class CRM_Contact_Form_Task_SaveSearch extends CRM_Contact_Form_Task {
/**
* Build all the data structures needed to build the form.
- *
- * @return void
*/
public function preProcess() {
$this->_id = NULL;
}
/**
- * Build the form object - it consists of
+ * Build the form object.
+ *
+ * It consists of
* - displaying the QILL (query in local language)
* - displaying elements for saving the search
- *
- *
- * @return void
*/
public function buildQuickForm() {
// get the qill
/**
* Process the form after the input has been submitted and validated.
- *
- *
- * @return void
*/
public function postProcess() {
// saved search form values
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class provides the functionality to update a saved search
- *
+ * This class provides the functionality to update a saved search.
*/
class CRM_Contact_Form_Task_SaveSearch_Update extends CRM_Contact_Form_Task_SaveSearch {
/**
* Build all the data structures needed to build the form.
- *
- * @return void
*/
public function preProcess() {
parent::preProcess();
/**
* Set default values for the form.
- * the default values are retrieved from the database
- *
- *
- * @return void
*/
public function setDefaultValues() {
/**
* Set variables up before form is built.
- *
- * @return void
*/
public function preProcess() {
parent::preProcess();
*/
/**
- * This class generates form components generic to useradd
- *
+ * This class generates form components generic to useradd.
*/
class CRM_Contact_Form_Task_Useradd extends CRM_Core_Form {
}
/**
- * Set default values for the form. Note that in edit/view mode
- * the default values are retrieved from the database
- *
- *
- * @return void
+ * Set default values for the form.
*/
public function setDefaultValues() {
$defaults = array();
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
$element = $this->add('text', 'name', ts('Full Name'), array('class' => 'huge'));
}
/**
- *
- * @return void
+ * Post process function.
*/
public function postProcess() {
// store the submitted values in an array
/**
* Validation Rule.
- *
*/
public static function usernameRule($params) {
$config = CRM_Core_Config::singleton();
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Contact_Import_Controller extends CRM_Core_Controller {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class delegates to the chosen DataSource to grab the data to be
- * imported.
+ * This class delegates to the chosen DataSource to grab the data to be imported.
*/
class CRM_Contact_Import_Form_DataSource extends CRM_Core_Form {
/**
* Set variables up before form is built.
- *
- * @return void
*/
public function preProcess() {
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
}
/**
- * Call the DataSource's postProcess method to take over
- * and then setup some common data structures for the next step
- *
- * @return void
+ * Call the DataSource's postProcess method.
*/
public function postProcess() {
$this->controller->resetPage('MapField');
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class gets the name of the file to upload
+ * This class gets the name of the file to upload.
*/
class CRM_Contact_Import_Form_MapField extends CRM_Import_Form_MapField {
/**
* Set variables up before form is built.
- *
- * @return void
*/
public function preProcess() {
$dataSource = $this->get('dataSource');
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
//to save the current mappings
}
/**
- * Process the mapped fields and map it into the uploaded file
- * preview the file and extract some summary statistics
- *
- * @return void
+ * Process the mapped fields and map it into the uploaded file.
*/
public function postProcess() {
$params = $this->controller->exportValues('MapField');
/**
* Format custom field name.
- * combine group and field name to avoid conflict.
*
- * @param $fields
+ * Combine group and field name to avoid conflict.
*
- * @return void
+ * @param array $fields
+ *
+ * @return array
*/
public function formatCustomFieldName(&$fields) {
//CRM-2676, replacing the conflict for same custom field name from different custom group.
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class previews the uploaded file and returns summary
- * statistics
+ * This class previews the uploaded file and returns summary statistics.
*/
class CRM_Contact_Import_Form_Preview extends CRM_Import_Form_Preview {
/**
* Set variables up before form is built.
- *
- * @return void
*/
public function preProcess() {
//get the data from the session
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
$this->addElement('text', 'newGroupName', ts('Name for new group'));
}
/**
- * Process the mapped fields and map it into the uploaded file
- * preview the file and extract some summary statistics
- *
- * @return void
+ * Process the mapped fields and map it into the uploaded file.
*/
public function postProcess() {
}
/**
- * Process the mapped fields and map it into the uploaded file
- * preview the file and extract some summary statistics
- *
- * @return void
+ * Process the mapped fields and map it into the uploaded file.
*/
public function postProcessOld() {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class summarizes the import results
+ * This class summarizes the import results.
*/
class CRM_Contact_Import_Form_Summary extends CRM_Import_Form_Summary {
/**
* Set variables up before form is built.
- *
- * @return void
*/
public function preProcess() {
// set the error message path to display
/**
* Clean up the import table we used.
- *
- * @return void
*/
public function postProcess() {
$dao = new CRM_Core_DAO();
projects / civicrm-core.git / commitdiff