CRM_Core_DAO::storeValues($group, $defaults);
return $group;
}
-
- return NULL;
}
/**
}
/**
- * This virtual function is used to set the default values of
- * various form elements
+ * Set the default values of various form elements.
*
* access public
*
* @return array
* reference to the array of default values
*/
- /**
- * @return array
- */
public function setDefaultValues() {
$config = CRM_Core_Config::singleton();
$defaults = array(
/**
* Attempt to match header labels with our mapper fields.
+ *
* FIXME: This is essentially the same function as parent::defaultFromHeader
*
- * @param $columnName name of column header
- * @param $patterns pattern to match for the column
+ * @param string $columnName name of column header
+ * @param array $patterns pattern to match for the column
*
* @return string
*/
}
/**
- * Function returns associated array of elements, that will be passed for search
+ * Function returns associated array of elements, that will be passed for search.
*
* @param int $smartGroupId
* Smart group id.
*/
/**
- *
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * Base class for upload-only import forms (all but Contact import)
+ * Base class for upload-only import forms (all but Contact import).
*/
abstract class CRM_Import_Form_DataSource extends CRM_Core_Form {
/**
* Set variables up before form is built.
- *
- * @return void
*/
public function preProcess() {
$this->_id = CRM_Utils_Request::retrieve('id', 'Positive', $this, FALSE);
/**
* Common form elements.
- *
- * @return void
*/
public function buildQuickForm() {
$config = CRM_Core_Config::singleton();
}
/**
- * A long-winded way to add one radio element to the form
+ * A long-winded way to add one radio element to the form.
*/
protected function addContactTypeSelector() {
//contact types option
}
/**
+ * Store form values.
+ *
* @param array $names
*/
protected function storeFormValues($names) {
}
/**
- * Common form postProcess
+ * Common form postProcess.
*
* @param string $parserClassName
*/
}
/**
- * Return a descriptive name for the page, used in wizard header
+ * Return a descriptive name for the page, used in wizard header.
*
* @return string
*/
*/
/**
- *
* @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.
+ *
* TODO: CRM-11254 - There's still a lot of duplicate code in the 5 child classes that should be moved here
*/
abstract class CRM_Import_Form_MapField extends CRM_Core_Form {
protected $_fieldUsed;
/**
- * Return a descriptive name for the page, used in wizard header
+ * Return a descriptive name for the page, used in wizard header.
*
* @return string
*/
*
* @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.
+ *
* TODO: CRM-11254 - if preProcess and postProcess functions can be reconciled between the 5 child classes,
* those classes can be removed entirely and this class will not need to be abstract
*/
abstract class CRM_Import_Form_Preview extends CRM_Core_Form {
/**
- * Return a descriptive name for the page, used in wizard header
+ * Return a descriptive name for the page, used in wizard header.
*
* @return string
*/
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class summarizes the import results
+ * This class summarizes the import results.
+ *
* TODO: CRM-11254 - if preProcess and postProcess functions can be reconciled between the 5 child classes,
* those classes can be removed entirely and this class will not need to be abstract
*/
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
$this->addButtons(array(
}
/**
- * Return a descriptive name for the page, used in wizard header
+ * Return a descriptive name for the page, used in wizard header.
*
* @return string
*/
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
abstract class CRM_Import_Parser {
/**
abstract protected function fini();
/**
- * @param $values
+ * Map field.
+ *
+ * @param array $values
*
* @return mixed
*/
abstract protected function mapField(&$values);
/**
- * @param $values
+ * Preview.
+ *
+ * @param array $values
*
* @return mixed
*/
}
/**
- * Remove single-quote enclosures from a value array (row)
+ * Remove single-quote enclosures from a value array (row).
*
* @param array $values
* @param string $enclosure
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
return self::$_singleton;
}
- public function __construct() {
- // Empty function?
- }
-
/**
* Add element to form.
*
projects / civicrm-core.git / commitdiff