/**
* Build the form object.
- *
- *
- * @return void
*/
public function buildQuickForm() {
/**
* Add local and global form rules.
- *
- *
- * @return void
*/
public function addRules() {
$this->addFormRule(array('CRM_Contribute_Form_Task_PickProfile', 'formRule'));
/**
* Process the form after the input has been submitted and validated.
- *
- *
- * @return void
*/
public function postProcess() {
$params = $this->exportValues();
/**
* Build all the data structures needed to build the form.
- *
- * @return void
*/
public function preProcess() {
parent::preprocess();
}
/**
- * 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() {
//
- // just need to add a javacript to popup the window for printing
+ // just need to add a javascript to popup the window for printing
//
$this->addButtons(array(
array(
/**
* Process the form after the input has been submitted and validated.
- *
- *
- * @return void
*/
public function postProcess() {
// redirect to the main search page after printing is over
/**
* Build all the data structures needed to build the form.
- *
- * @return void
*/
public function preProcess() {
}
/**
* Build all the data structures needed to build the form.
- *
- * @return void
*/
public function preProcess() {
parent::preProcess();
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
$this->addButtons(array(
*/
/**
- * This class provides the functionality to email a group of
- * contacts.
+ * This class provides the functionality to email a group of contacts.
*/
class CRM_Contribute_Form_Task_Status extends CRM_Contribute_Form_Task {
/**
* Build all the data structures needed to build the form.
- *
- * @return void
*/
public function preProcess() {
$id = CRM_Utils_Request::retrieve('id', 'Positive',
/**
* Build the form object.
- *
- *
- * @return void
*/
public function buildQuickForm() {
$status = CRM_Contribute_PseudoConstant::contributionStatus();
/**
* Process the form after the input has been submitted and validated.
- *
- *
- * @return void
*/
public function postProcess() {
$params = $this->controller->exportValues($this->_name);
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class generates form components for processing a contribution
- *
+ * This class generates form components for processing a contribution.
*/
class CRM_Contribute_Form_UpdateBilling extends CRM_Core_Form {
protected $_crid = NULL;
/**
* Set variables up before form is built.
- *
- * @return void
*/
public function preProcess() {
$this->_mid = CRM_Utils_Request::retrieve('mid', 'Integer', $this, FALSE);
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
$type = 'next';
/**
* Process the form.
- *
- * @return void
*/
public function postProcess() {
$params = $this->controller->exportValues($this->_name);
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
* It delegates the work to lower level subclasses and integrates the changes
* back in. It also uses a lot of functionality with the CRM API's, so any change
* made here could potentially affect the API etc. Be careful, be aware, use unit tests.
- *
*/
class CRM_Contribute_Form_UpdateSubscription extends CRM_Core_Form {
}
/**
- * Set default values for the form. Note that in edit/view mode
- * the default values are retrieved from the database
- *
+ * Set default values for the form.
*
- * @return void
+ * Note that in edit/view mode the default values are retrieved from the database.
*/
public function setDefaultValues() {
/**
* Actually build the components of the form.
- *
- * @return void
*/
public function buildQuickForm() {
// CRM-16398: If current recurring contribution got > 1 lineitems then make amount field readonly
}
/**
- * called after the user submits the form.
- *
- *
- * @return void
+ * Called after the user submits the form.
*/
public function postProcess() {
// store the submitted values in an array
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Contribute_Import_Controller extends CRM_Core_Controller {
/**
* Class constructor.
*
- * @param null $title
+ * @param string $title
* @param bool|int $action
* @param bool $modal
*/
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Contribute_Import_Field {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
parent::buildQuickForm();
/**
* Process the uploaded file.
- *
- * @return void
*/
public function postProcess() {
$this->storeFormValues(array(
*
* @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_Contribute_Import_Form_MapField extends CRM_Import_Form_MapField {
/**
* Set variables up before form is built.
- *
- * @return void
*/
public function preProcess() {
$this->_mapperFields = $this->get('fields');
/**
* 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 preview the file and extract some summary statistics.
*/
public function postProcess() {
$params = $this->controller->exportValues('MapField');
*
* @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_Contribute_Import_Form_Preview extends CRM_Import_Form_Preview {
/**
* Set variables up before form is built.
- *
- * @return void
*/
public function preProcess() {
$skipColumnHeader = $this->controller->exportValue('DataSource', 'skipColumnHeader');
}
/**
- * 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 preview the file and extract some summary statistics.
*/
public function postProcess() {
$fileName = $this->controller->exportValue('DataSource', 'uploadFile');
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class summarizes the import results
+ * This class summarizes the import results.
*/
class CRM_Contribute_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
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
abstract class CRM_Contribute_Import_Parser extends CRM_Import_Parser {
* set the active fields array to this list
*
* @param array $fieldKeys mapped array of values
- *
- * @return void
*/
public function setActiveFields($fieldKeys) {
$this->_activeFieldCount = count($fieldKeys);
* @param string $fileName
* @param array $header
* @param array $data
- *
- * @return void
*/
public static function exportCSV($fileName, $header, $data) {
$output = array();
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
/**
* The initializer code, called before the processing
- *
- * @return void
*/
public function init() {
$fields = CRM_Contribute_BAO_Contribution::importableFields($this->_contactType, FALSE);
}
/**
- * The initializer code, called before the processing
- *
- * @return void
+ * The initializer code, called before the processing.
*/
public function fini() {
}
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Contribute_Info extends CRM_Core_Component_Info {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
}
/**
- * make a copy of a contribution page, including
- * all the fields in the page
- *
- * @return void
+ * Make a copy of a contribution page, including all the fields in the page.
*/
public function copy() {
$gid = CRM_Utils_Request::retrieve('gid', 'Positive',
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
* Main page for viewing Recurring Contributions.
- *
*/
class CRM_Contribute_Page_ContributionRecur extends CRM_Core_Page {
/**
* View details of a recurring contribution.
- *
- * @return void
*/
public function view() {
$recur = new CRM_Contribute_DAO_ContributionRecur();
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * Page for displaying list of Payment-Instrument
+ * Page for displaying list of Payment-Instrument.
*/
class CRM_Contribute_Page_DashBoard extends CRM_Core_Page {
/**
- * Heart of the viewing process. The runner gets all the meta data for
- * the contact and calls the appropriate type of page to view.
+ * Heart of the viewing process.
*
- * @return void
+ * The runner gets all the meta data for the contact and calls the appropriate type of page to view.
*/
public function preProcess() {
CRM_Utils_System::setTitle(ts('CiviContribute'));
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * Page for displaying list of Premiums
+ * Page for displaying list of Premiums.
*/
class CRM_Contribute_Page_ManagePremiums extends CRM_Core_Page_Basic {
* This method is called after the page is created. It checks for the
* type of action and executes that action.
* Finally it calls the parent's run method.
- *
- * @return void
*/
public function run() {
/**
* Browse all custom data groups.
- *
- *
- * @return void
*/
public function browse() {
// get all custom groups sorted by weight
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Contribute_Page_PaymentInfo extends CRM_Core_Page {
public function preProcess() {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * Page for displaying list of Premiums
+ * Page for displaying list of Premiums.
*/
class CRM_Contribute_Page_Premium extends CRM_Core_Page_Basic {
* This method is called after the page is created. It checks for the
* type of action and executes that action.
* Finally it calls the parent's run method.
- *
- * @return void
*/
public function run() {
// get the requested action
}
/**
- * @return void
+ * Browse function.
*/
public function browse() {
// get all custom groups sorted by weight
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Contribute_Page_SubscriptionStatus extends CRM_Core_Page {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Contribute_Page_Tab extends CRM_Core_Page {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Contribute_Page_UserDashboard extends CRM_Contact_Page_View_UserDashBoard {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class holds all the Pseudo constants that are specific to Contributions. This avoids
- * polluting the core class and isolates the mass mailer class
+ * This class holds all the Pseudo constants that are specific to Contributions.
+ *
+ * This avoids polluting the core class and isolates the mass mailer class.
*/
class CRM_Contribute_PseudoConstant extends CRM_Core_PseudoConstant {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
* State machine for managing different states of the Import process.
- *
*/
class CRM_Contribute_StateMachine_ContributionPage extends CRM_Core_StateMachine {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Contribute_StateMachine_Search extends CRM_Core_StateMachine {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * class to represent the actions that can be performed on a group of contacts
- * used by the search forms
+ * Class to represent the actions that can be performed on a group of contacts.
*
+ * Used by the search forms.
*/
class CRM_Contribute_Task {
const DELETE_CONTRIBUTIONS = 1, PRINT_CONTRIBUTIONS = 2, EXPORT_CONTRIBUTIONS = 3, BATCH_CONTRIBUTIONS = 4, EMAIL_CONTACTS = 5, UPDATE_STATUS = 6, PDF_RECEIPT = 7;
projects / civicrm-core.git / commitdiff