* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
*/
-
class CRM_ACL_Form_ACLBasic extends CRM_Admin_Form {
/**
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
parent::buildQuickForm();
/**
* Add local and global form rules.
- *
- *
- * @return void
*/
public function addRules() {
$this->addFormRule(array('CRM_Admin_Form_MailSettings', 'formRule'));
/**
* Process the form submission.
- *
- *
- * @return void
*/
public function postProcess() {
if ($this->_action & CRM_Core_Action::DELETE) {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class generates form components for Mapping
- *
+ * This class generates form components for Mapping.
*/
class CRM_Admin_Form_Mapping extends CRM_Admin_Form {
/**
* Build the form object.
- *
- * @return void
*/
public function preProcess() {
parent::preProcess();
/**
* Process the form submission.
- *
- *
- * @return void
*/
public function postProcess() {
// store the submitted values in an array
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
* This class generates form components for Message templates
* used by membership, contributions, event registrations, etc.
- *
*/
class CRM_Admin_Form_MessageTemplates extends CRM_Admin_Form {
// which (and whether) mailing workflow this template belongs to
/**
* Set default values for the form.
- * The default values are retrieved from the database.
- *
*
- * @return void
+ * The default values are retrieved from the database.
*/
public function setDefaultValues() {
$defaults = $this->_values;
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
/**
* Process the form submission.
- *
- *
- * @return void
*/
public function postProcess() {
if ($this->_action & CRM_Core_Action::DELETE) {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class generates form components for Navigation
- *
+ * This class generates form components for Navigation.
*/
class CRM_Admin_Form_Navigation extends CRM_Admin_Form {
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
parent::buildQuickForm();
/**
* Process the form submission.
- *
- *
- * @return void
*/
public function postProcess() {
// get the submitted form values.
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class generates form components for Option Group
- *
+ * This class generates form components for Option Group.
*/
class CRM_Admin_Form_OptionGroup extends CRM_Admin_Form {
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
parent::buildQuickForm();
/**
* Process the form submission.
- *
- *
- * @return void
*/
public function postProcess() {
CRM_Utils_System::flushCache();
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class generates form components for Options
- *
+ * This class generates form components for Options.
*/
class CRM_Admin_Form_Options extends CRM_Admin_Form {
/**
* Pre-process
- *
- * @return void
*/
public function preProcess() {
parent::preProcess();
/**
* Set default values for the form.
- *
- * @return void
*/
public function setDefaultValues() {
$defaults = parent::setDefaultValues();
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
parent::buildQuickForm();
/**
* Process the form submission.
- *
- *
- * @return void
*/
public function postProcess() {
if ($this->_action & CRM_Core_Action::DELETE) {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Admin_Form_ParticipantStatusType extends CRM_Admin_Form {
return 'ParticipantStatusType';
}
+ /**
+ * Build form.
+ */
public function buildQuickForm() {
parent::buildQuickForm();
}
/**
+ * Set default values.
+ *
* @return array
*/
public function setDefaultValues() {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id: PaymentProcessor.php 9702 2007-05-29 23:57:16Z lobo $
- *
*/
/**
- * This class generates form components for Payment Processor
- *
+ * This class generates form components for Payment Processor.
*/
class CRM_Admin_Form_PaymentProcessor extends CRM_Admin_Form {
protected $_id = NULL;
* Build the form object.
*
* @param bool $check
- *
- * @return void
*/
public function buildQuickForm($check = FALSE) {
parent::buildQuickForm();
/**
* Process the form submission.
- *
- *
- * @return Void
*/
public function postProcess() {
CRM_Utils_System::flushCache('CRM_Financial_DAO_PaymentProcessor');
/**
* Save a payment processor.
*
- * @param $values
+ * @param array $values
* @param int $domainID
- * @param $test
- *
- * @return void
+ * @param bool $test
*/
public function updatePaymentProcessor(&$values, $domainID, $test) {
$dao = new CRM_Financial_DAO_PaymentProcessor();
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id: PaymentProcessorType.php 9702 2007-05-29 23:57:16Z lobo $
- *
*/
/**
- * This class generates form components for Location Type
- *
+ * This class generates form components for Location Type.
*/
class CRM_Admin_Form_PaymentProcessorType extends CRM_Admin_Form {
protected $_id = NULL;
* Build the form object.
*
* @param bool $check
- *
- * @return void
*/
public function buildQuickForm($check = FALSE) {
parent::buildQuickForm();
/**
* Process the form submission.
- *
- *
- * @return void
*/
public function postProcess() {
CRM_Utils_System::flushCache('CRM_Financial_DAO_PaymentProcessorType');
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class generates form components for PDF Page Format Settings
- *
+ * This class generates form components for PDF Page Format Settings.
*/
class CRM_Admin_Form_PdfFormats extends CRM_Admin_Form {
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
parent::buildQuickForm();
/**
* Process the form submission.
- *
- *
- * @return void
*/
public function postProcess() {
if ($this->_action & CRM_Core_Action::DELETE) {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * customize the output to meet our specific requirements
+ * Customize the output to meet our specific requirements.
*/
class CRM_Admin_Form_Persistent extends CRM_Core_Form {
+ /**
+ * Pre-process form.
+ */
public function preProcess() {
$this->_indexID = CRM_Utils_Request::retrieve('id', 'Integer', $this, FALSE);
$this->_config = CRM_Utils_Request::retrieve('config', 'Integer', $this, 0);
}
/**
+ * Set default values.
+ *
* @return array
*/
public function setDefaultValues() {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * Base class for settings forms
- *
+ * Base class for settings forms.
*/
class CRM_Admin_Form_Preferences extends CRM_Core_Form {
protected $_system = FALSE;
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
parent::buildQuickForm();
/**
* Process the form submission.
- *
- *
- * @return void
*/
public function postProcess() {
$config = CRM_Core_Config::singleton();
/**
* Process the form submission.
- *
- *
- * @return void
*/
public function postProcessCommon() {
foreach ($this->_varNames as $groupName => $groupValues) {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class generates form components for Address Section
+ * This class generates form components for Address Section.
*/
class CRM_Admin_Form_Preferences_Address extends CRM_Admin_Form_Preferences {
public function preProcess() {
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
$this->applyFilter('__ALL__', 'trim');
/**
* Process the form submission.
- *
- *
- * @return void
*/
public function postProcess() {
if ($this->_action == CRM_Core_Action::VIEW) {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class generates form components for the display preferences
- *
+ * This class generates form components for the display preferences.
*/
class CRM_Admin_Form_Preferences_Contribute extends CRM_Admin_Form_Preferences {
protected $_settings = array(
'cvv_backoffice_required' => CRM_Core_BAO_Setting::CONTRIBUTE_PREFERENCES_NAME,
);
+
/**
* Process the form submission.
- *
- *
- * @return void
*/
public function preProcess() {
$config = CRM_Core_Config::singleton();
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
//CRM-16691: Changes made related to settings of 'CVV'.
/**
* Set default values for the form.
- * default values are retrieved from the database
- *
*
- * @return void
+ * default values are retrieved from the database
*/
public function setDefaultValues() {
$defaults = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::CONTRIBUTE_PREFERENCES_NAME, 'contribution_invoice_settings');
/**
* Process the form after the input has been submitted and validated.
- *
- *
- * @return void
*/
public function postProcess() {
// store the submitted values in an array
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id: Display.php 45499 2013-02-08 12:31:05Z kurund $
- *
*/
/**
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
$wysiwyg_options = CRM_Core_OptionGroup::values('wysiwyg_editor', FALSE, FALSE, FALSE, NULL, 'label', TRUE, FALSE, 'name');
/**
* Process the form submission.
- *
- *
- * @return void
*/
public function postProcess() {
if ($this->_action == CRM_Core_Action::VIEW) {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id: Display.php 36505 2011-10-03 14:19:56Z lobo $
- *
*/
/**
- * This class generates form components for component preferences
- *
+ * This class generates form components for component preferences.
*/
class CRM_Admin_Form_Preferences_Member extends CRM_Admin_Form_Preferences {
public function preProcess() {
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
parent::buildQuickForm();
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class generates form components for Location Type
- *
+ * This class generates form components for Location Type.
*/
class CRM_Admin_Form_PreferencesDate extends CRM_Admin_Form {
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
/**
* Process the form submission.
- *
- *
- * @return void
*/
public function postProcess() {
if (!($this->_action & CRM_Core_Action::UPDATE)) {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class generates form components for Relationship Type
- *
+ * This class generates form components for Relationship Type.
*/
class CRM_Admin_Form_RelationshipType extends CRM_Admin_Form {
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
parent::buildQuickForm();
/**
* Process the form submission.
- *
- *
- * @return void
*/
public function postProcess() {
if ($this->_action & CRM_Core_Action::DELETE) {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class generates form components for Scheduling Reminders
- *
+ * This class generates form components for Scheduling Reminders.
*/
class CRM_Admin_Form_ScheduleReminders extends CRM_Admin_Form {
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
parent::buildQuickForm();
/**
* Process the form submission.
- *
- *
- * @return void
*/
public function postProcess() {
if ($this->_action & CRM_Core_Action::DELETE) {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
*/
/**
- * This class generates form components generic to CiviCRM settings
+ * This class generates form components generic to CiviCRM settings.
*/
class CRM_Admin_Form_Setting extends CRM_Core_Form {
}
}
+ /**
+ * Get default entity.
+ *
+ * @return string
+ */
public function getDefaultEntity() {
return 'Setting';
}
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class generates form components for Component
+ * This class generates form components for Component.
*/
class CRM_Admin_Form_Setting_Component extends CRM_Admin_Form_Setting {
protected $_components;
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
CRM_Utils_System::setTitle(ts('Settings - Enable Components'));
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class generates form components for Date Formatting
- *
+ * This class generates form components for Date Formatting.
*/
class CRM_Admin_Form_Setting_Date extends CRM_Admin_Form_Setting {
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
CRM_Utils_System::setTitle(ts('Settings - Date'));
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class generates form components for Error Handling and Debugging
- *
+ * This class generates form components for Error Handling and Debugging.
*/
class CRM_Admin_Form_Setting_Debugging extends CRM_Admin_Form_Setting {
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
CRM_Utils_System::setTitle(ts(' Settings - Debugging and Error Handling '));
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class generates form components for Localization
- *
+ * This class generates form components for Localization.
*/
class CRM_Admin_Form_Setting_Localization extends CRM_Admin_Form_Setting {
// use this variable to store mappings that we compute in buildForm and also
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
$config = CRM_Core_Config::singleton();
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class generates form components for CiviMail
+ * This class generates form components for CiviMail.
*/
class CRM_Admin_Form_Setting_Mail extends CRM_Admin_Form_Setting {
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
CRM_Utils_System::setTitle(ts('Settings - CiviMail'));
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class generates form components for Mapping and Geocoding
- *
+ * This class generates form components for Mapping and Geocoding.
*/
class CRM_Admin_Form_Setting_Mapping extends CRM_Admin_Form_Setting {
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
CRM_Utils_System::setTitle(ts('Settings - Mapping and Geocoding Providers'));
}
/**
- * add the rules (mainly global rules) for form.
- * All local rules are added near the element
+ * Add the rules (mainly global rules) for form.
*
- * @return void
+ * All local rules are added near the element
*/
public function addRules() {
$this->addFormRule(array('CRM_Admin_Form_Setting_Mapping', 'formRule'));
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class generates form components for Miscellaneous
- *
+ * This class generates form components for Miscellaneous.
*/
class CRM_Admin_Form_Setting_Miscellaneous extends CRM_Admin_Form_Setting {
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
CRM_Utils_System::setTitle(ts('Misc (Undelete, PDFs, Limits, Logging, Captcha, etc.)'));
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class generates form components for File System Path
- *
+ * This class generates form components for File System Path.
*/
class CRM_Admin_Form_Setting_Path extends CRM_Admin_Form_Setting {
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
CRM_Utils_System::setTitle(ts('Settings - Upload Directories'));
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class generates form components for Smtp Server
- *
+ * This class generates form components for Smtp Server.
*/
class CRM_Admin_Form_Setting_Smtp extends CRM_Admin_Form_Setting {
protected $_testButtonName;
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
/**
* Process the form submission.
- *
- *
- * @return void
*/
public function postProcess() {
// flush caches so we reload details for future requests
/**
* Set default values for the form.
- * default values are retrieved from the database
- *
- *
- * @return void
*/
public function setDefaultValues() {
if (!$this->_defaults) {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class generates form components for Site Url
- *
+ * This class generates form components for Site Url.
*/
class CRM_Admin_Form_Setting_UF extends CRM_Admin_Form_Setting {
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
$config = CRM_Core_Config::singleton();
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
* This class generates form components for Error Handling and Debugging
- *
*/
class CRM_Admin_Form_Setting_UpdateConfigBackend extends CRM_Admin_Form_Setting {
protected $_oldBaseDir;
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
CRM_Utils_System::setTitle(ts('Settings - Cleanup Caches and Update Paths'));
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class generates form components for Site Url
- *
+ * This class generates form components for Site Url.
*/
class CRM_Admin_Form_Setting_Url extends CRM_Admin_Form_Setting {
protected $_settings = array(
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
CRM_Utils_System::setTitle(ts('Settings - Resource URLs'));
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class generates form components for Tag
- *
+ * This class generates form components for Tag.
*/
class CRM_Admin_Form_Tag extends CRM_Admin_Form {
protected $_isTagSet;
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
$this->setPageTitle($this->_isTagSet ? ts('Tag Set') : ts('Tag'));
/**
* Process the form submission.
- *
- *
- * @return void
*/
public function postProcess() {
$params = $ids = array();
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class contains all the function that are called using AJAX
+ * This class contains all the function that are called using AJAX.
*/
class CRM_Admin_Page_AJAX {
/**
- * CRM-12337 Output navigation menu as executable javascript
+ * CRM-12337 Output navigation menu as executable javascript.
+ *
* @see smarty_function_crmNavigationMenu
*/
public static function getNavigationMenu() {
}
/**
- * Process drag/move action for menu tree
+ * Process drag/move action for menu tree.
*/
public static function menuTree() {
CRM_Core_BAO_Navigation::processNavigation($_GET);
}
/**
- * Build status message while.
- * enabling/ disabling various objects
+ * Build status message while enabling/ disabling various objects.
*/
public static function getStatusMsg() {
require_once 'api/v3/utils.php';
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
class CRM_Admin_Page_APIExplorer extends CRM_Core_Page {
/**
+ * Run page.
+ *
* @return string
*/
public function run() {
}
/**
- * AJAX callback to fetch examples
+ * AJAX callback to fetch examples.
*/
public static function getExampleFile() {
global $civicrm_root;
}
/**
- * Ajax callback to display code docs
+ * Ajax callback to display code docs.
*/
public static function getDoc() {
// Verify the API handler we're talking to is valid.
}
/**
+ * Get documentation block.
+ *
* @param string $entity
* @param string|null $action
* @return array|bool
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * Dashboard page for managing Access Control
+ * Dashboard page for managing Access Control.
+ *
* For initial version, this page only contains static links - so this class is empty for now.
*/
class CRM_Admin_Page_Access extends CRM_Core_Page {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * Page for displaying Administer CiviCRM Control Panel
+ * Page for displaying Administer CiviCRM Control Panel.
*/
class CRM_Admin_Page_Admin extends CRM_Core_Page {
/**
+ * Run page.
+ *
* @return string
*/
public function run() {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * Page for configuring CKEditor options
+ * Page for configuring CKEditor options.
*
* Note that while this is implemented as a CRM_Core_Page, it is actually a form.
* Because the form needs to be submitted and refreshed via javascrit, it seemed like
);
/**
+ * Run page.
+ *
* @return string
*/
public function run() {
}
/**
+ * Get CKEditor plugins.
+ *
* @return array
*/
private function getCKPlugins() {
}
/**
+ * Get CK Editor skins.
+ *
* @return array
*/
private function getCKSkins() {
}
/**
- * Delete self::CONFIG_FILENAME
+ * Delete config file.
*/
public static function deleteConfigFile() {
$file = self::getConfigFile();
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
* 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() {
//if javascript is enabled
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * Page for displaying list of site configuration tasks with links to each setting form
+ * Page for displaying list of site configuration tasks with links to each setting form.
*/
class CRM_Admin_Page_ConfigTaskList extends CRM_Core_Page {
/**
+ * Run page.
+ *
* @return string
*/
public function run() {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * Page for displaying list of contact Subtypes
+ * Page for displaying list of contact Subtypes.
*/
class CRM_Admin_Page_ContactType extends CRM_Core_Page_Basic {
return self::$_links;
}
+ /**
+ * Run page.
+ */
public function run() {
$action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 0);
$this->assign('action', $action);
return parent::run();
}
+ /**
+ * Browse contact types.
+ */
public function browse() {
$rows = CRM_Contact_BAO_ContactType::contactTypeInfo(TRUE);
foreach ($rows as $key => $value) {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
/**
* Browse all event templates.
- *
- * @return void
*/
public function browse() {
//get all event templates.
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
/**
* Obtains the group name from url and sets the title.
- *
- * @return void
*/
public function preProcess() {
CRM_Utils_System::setTitle(ts('CiviCRM Extensions'));
/**
* Run the basic page (run essentially starts execution for that page).
- *
- * @return void
*/
public function run() {
$this->preProcess();
/**
* Browse all options.
- *
- *
- * @return void
*/
public function browse() {
$mapper = CRM_Extension_System::singleton()->getMapper();
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * Page for displaying list of jobs
+ * Page for displaying list of jobs.
*/
class CRM_Admin_Page_Job 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() {
// set title and breadcrumb
* Browse all jobs.
*
* @param null $action
- *
- * @return void
*/
public function browse($action = NULL) {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * Page for displaying list of jobs
+ * Page for displaying list of jobs.
*/
class CRM_Admin_Page_JobLog 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() {
// set title and breadcrumb
* Browse all jobs.
*
* @param null $action
- *
- * @return void
*/
public function browse($action = NULL) {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * Page for displaying list of Label Formats
+ * Page for displaying list of Label Formats.
*/
class CRM_Admin_Page_LabelFormats extends CRM_Core_Page_Basic {
* Browse all Label Format settings.
*
* @param null $action
- *
- * @return void
*/
public function browse($action = NULL) {
// Get list of configured Label Formats
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * Page for displaying list of location types
+ * Page for displaying list of location types.
*/
class CRM_Admin_Page_LocationType extends CRM_Core_Page_Basic {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * Page for displaying list of Mail account settings
+ * Page for displaying list of Mail account settings.
*/
class CRM_Admin_Page_MailSettings extends CRM_Core_Page_Basic {
/**
* Browse all mail settings.
- *
- * @return void
*/
public function browse() {
//get all mail settings.
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * Page for displaying list of categories
+ * Page for displaying list of categories.
*/
class CRM_Admin_Page_Mapping extends CRM_Core_Page_Basic {
/**
* Run the basic page.
- *
- * @return void
*/
public function run() {
$sort = 'mapping_type asc';
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * Page for displaying list of message templates
+ * Page for displaying list of message templates.
*/
class CRM_Admin_Page_MessageTemplates extends CRM_Core_Page_Basic {
/**
* Browse all entities.
- *
- * @return void
*/
public function browse() {
$action = func_num_args() ? func_get_arg(0) : NULL;
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * Page for displaying list of location types
+ * Page for displaying list of location types.
*/
class CRM_Admin_Page_Navigation extends CRM_Core_Page_Basic {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * Page for displaying list of Gender
+ * Page for displaying list of Gender.
*/
class CRM_Admin_Page_Options extends CRM_Core_Page_Basic {
/**
* Obtains the group name from url string or id from $_GET['gid'].
- * Sets the title.
*
- * @return void
+ * Sets the title.
*/
public function preProcess() {
if (!self::$_gName && !empty($this->urlPath[3])) {
/**
* Run the basic page (run essentially starts execution for that page).
- *
- * @return void
*/
public function run() {
$this->preProcess();
/**
* Browse all options.
- *
- *
- * @return void
*/
public function browse() {
if (!self::$_gName) {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Admin_Page_ParticipantStatusType extends CRM_Core_Page_Basic {
public $useLivePageJS = TRUE;
/**
+ * Get BAO name.
+ *
* @return string
*/
public function getBAOName() {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * Page for displaying list of payment processors
+ * Page for displaying list of payment processors.
*/
class CRM_Admin_Page_PaymentProcessor 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() {
// set title and breadcrumb
* Browse all payment processors.
*
* @param null $action
- *
- * @return void
*/
public function browse($action = NULL) {
// get all custom groups sorted by weight
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * Page for displaying list of payment processors
+ * Page for displaying list of payment processors.
*/
class CRM_Admin_Page_PaymentProcessorType extends CRM_Core_Page_Basic {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * Page for displaying list of PDF Page Formats
+ * Page for displaying list of PDF Page Formats.
*/
class CRM_Admin_Page_PdfFormats extends CRM_Core_Page_Basic {
* Browse all PDF Page Formats.
*
* @param null $action
- *
- * @return void
*/
public function browse($action = NULL) {
// Get list of configured PDF Page Formats
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
/**
* Run the basic page (run essentially starts execution for that page).
- *
- * @return void
*/
public function run() {
CRM_Utils_System::setTitle(ts('DB Template Strings'));
/**
* Browse all options.
- *
- *
- * @return void
*/
public function browse() {
$permission = FALSE;
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * Page for displaying list of location types
+ * Page for displaying list of location types.
*/
class CRM_Admin_Page_PreferencesDate 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() {
// set title and breadcrumb
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * Page for displaying list of relationship types
+ * Page for displaying list of relationship types.
*/
class CRM_Admin_Page_RelationshipType extends CRM_Core_Page_Basic {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * Page for displaying list of Reminders
+ * Page for displaying list of Reminders.
*/
class CRM_Admin_Page_ScheduleReminders extends CRM_Core_Page_Basic {
* Browse all Scheduled Reminders settings.
*
* @param null $action
- *
- * @return void
*/
public function browse($action = NULL) {
//CRM-16777: Do not permit access to user, for page 'Administer->Communication->Schedule Reminder',
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * Page for displaying list of categories for Settings
+ * Page for displaying list of categories for Settings.
*/
class CRM_Admin_Page_Setting extends CRM_Core_Page {
/**
+ * Run page.
+ *
* @return string
* @throws Exception
*/
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * Page for displaying list of categories
+ * Page for displaying list of categories.
*/
class CRM_Admin_Page_Tag extends CRM_Core_Page_Basic {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * Class CRM_Badge_Format_Badge
+ * Class CRM_Badge_Format_Badge.
*
* parent class for building name badges
*/
* Associated array with participant info.
* @param array $layoutInfo
* Associated array which contains meta data about format/layout.
- *
- * @return void
*/
public function createLabels(&$participants, &$layoutInfo) {
$this->pdf = new CRM_Utils_PDF_Label($layoutInfo['format'], 'mm');
* @param string $y
* @param null $w
* @param null $h
- *
- * @return void
*/
public function printImage($img, $x = '', $y = '', $w = NULL, $h = NULL) {
if (!$x) {
* @param array $params
* Associated array of submitted values.
* @param CRM_Core_Form $form
- *
- * @return void
*/
public static function buildBadges(&$params, &$form) {
// get name badge layout info
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class generates form components for name badge layout
- *
+ * This class generates form components for name badge layout.
*/
class CRM_Badge_Form_Layout extends CRM_Admin_Form {
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
if ($this->_action & CRM_Core_Action::DELETE) {
}
/**
- * Set default values for the form. MobileProvider that in edit/view mode
- * the default values are retrieved from the database
- *
- *
- * @return void
+ * Set default values for the form.
*/
public function setDefaultValues() {
if (isset($this->_id)) {
/**
* Process the form submission.
- *
- *
- * @return void
*/
public function postProcess() {
if ($this->_action & CRM_Core_Action::DELETE) {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- *
+ * Batch BAO class.
*/
class CRM_Batch_BAO_Batch extends CRM_Batch_DAO_Batch {
* Associated array of batch ids.
* @param string $exportFormat
* Export format.
- *
- * @return void
- *
*/
public static function exportFinancialBatch($batchIds, $exportFormat) {
if (empty($batchIds)) {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class provides the functionality for batch entry for contributions/memberships
+ * This class provides the functionality for batch entry for contributions/memberships.
*/
class CRM_Batch_Form_Entry extends CRM_Core_Form {
/**
* Build all the data structures needed to build the form.
- *
- * @return void
*/
public function preProcess() {
$this->_batchId = CRM_Utils_Request::retrieve('id', 'Positive', $this, TRUE);
/**
* Build the form object.
- *
- *
- * @return void
*/
public function buildQuickForm() {
if (!$this->_profileId) {
/**
* Set default values for the form.
- *
- *
- * @return void
*/
public function setDefaultValues() {
if (empty($this->_fields)) {
/**
* Process the form after the input has been submitted and validated.
- *
- *
- * @return void
*/
public function postProcess() {
$params = $this->controller->exportValues($this->_name);
* @param array $params
* Associated array of submitted values.
*
- *
- * @return void
+ * @return bool
*/
private function processContribution(&$params) {
$dates = array(
*
* @param array $value
* Associated array of submitted values.
- *
- *
- * @return void
*/
private function updateContactInfo(&$value) {
$value['preserveDBName'] = $this->_preserveDefault;
}
/**
- * Function exists purely for unit testing purposes. If you feel tempted to use this in live code
- * then it probably means there is some functionality that needs to be moved
- * out of the form layer
+ * Function exists purely for unit testing purposes.
+ *
+ * If you feel tempted to use this in live code then it probably means there is some functionality
+ * that needs to be moved out of the form layer
*
* @param array $params
*
}
/**
- * Function exists purely for unit testing purposes. If you feel tempted to use this in live code
- * then it probably means there is some functionality that needs to be moved
- * out of the form layer
+ * Function exists purely for unit testing purposes.
+ *
+ * If you feel tempted to use this in live code then it probably means there is some functionality
+ * that needs to be moved out of the form layer.
*
* @param array $params
*
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
/**
* Get action Links.
- *
*/
public function &links() {
}
/**
* Browse all entities.
- *
- * @return void
*/
public function browse() {
$status = CRM_Utils_Request::retrieve('status', 'Positive', CRM_Core_DAO::$_nullObject, FALSE, 1);
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Campaign_BAO_Petition extends CRM_Campaign_BAO_Survey {
/**
+ * Class constructor.
*/
public function __construct() {
parent::__construct();
* @param array $params
* (reference ) an assoc array of name/value pairs.
*
- * @param $sendEmailMode
+ * @param int $sendEmailMode
*
* @throws Exception
- * @return void
*/
public static function sendEmail($params, $sendEmailMode) {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Campaign_BAO_Query {
//since normal activity clause clause get collides.
/**
* If survey, campaign are involved, add the specific fields.
*
- * @param $query
- *
- * @return void
+ * @param CRM_Contact_BAO_Contact $query
*/
public static function select(&$query) {
self::$_applySurveyClause = FALSE;
* Add all the elements shared between,
* normal voter search and voter listing (GOTV form)
*
- *
* @param CRM_Core_Form $form
- * @return void
*/
public static function buildSearchForm(&$form) {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class generates form components for processing a campaign
- *
+ * This class generates form components for processing a campaign.
*/
class CRM_Campaign_Form_Campaign extends CRM_Core_Form {
/**
* Form submission of new/edit campaign is processed.
- *
- *
- * @return void
*/
public function postProcess() {
// store the submitted values in an array
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class generates form components for processing a petition signature
- *
+ * This class generates form components for processing a petition signature.
*/
class CRM_Campaign_Form_Petition_Signature extends CRM_Core_Form {
const EMAIL_THANK = 1, EMAIL_CONFIRM = 2, MODE_CREATE = 4;
/**
* Set default values for the form.
- *
- *
- * @return void
*/
public function setDefaultValues() {
$this->_defaults = array();
* @param $files
* @param $errors
*
- * @return void
* @see valid_date
+ * @return array|bool
*/
public static function formRule($fields, $files, $errors) {
$errors = array();
/**
* Form submission of petition signature.
- *
- *
- * @return void
*/
public function postProcess() {
$tag_name = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::CAMPAIGN_PREFERENCES_NAME,
* @param int $id
* @param string $name
* @param bool $viewOnly
- *
- * @return void
*/
public function buildCustom($id, $name, $viewOnly = FALSE) {
if ($id) {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * Files required
+ * Files required.
*/
class CRM_Campaign_Form_Search extends CRM_Core_Form_Search {
/**
* Processing needed for buildForm and later.
- *
- * @return void
*/
public function preProcess() {
$this->_done = FALSE;
/**
* Build the form object.
- *
- *
- * @return void
*/
public function buildQuickForm() {
parent::buildQuickForm();
* done.
* The processing consists of using a Selector / Controller framework for getting the
* search results.
- *
- * @param
- *
- * @return void
*/
public function postProcess() {
if ($this->_done) {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * Files required
+ * Files required.
*/
class CRM_Campaign_Form_Search_Campaign extends CRM_Core_Form {
/**
* Processing needed for buildForm and later.
- *
- * @return void
*/
public function preProcess() {
$this->_search = CRM_Utils_Array::value('search', $_GET);
/**
* Build the form object.
- *
- *
- * @return void
*/
public function buildQuickForm() {
if ($this->_search) {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * Files required
+ * Files required.
*/
class CRM_Campaign_Form_Search_Petition extends CRM_Core_Form {
/**
* Processing needed for buildForm and later.
- *
- * @return void
*/
public function preProcess() {
$this->_search = CRM_Utils_Array::value('search', $_GET);
/**
* Build the form object.
- *
- *
- * @return void
*/
public function buildQuickForm() {
if ($this->_search) {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * Files required
+ * Files required.
*/
class CRM_Campaign_Form_Search_Survey extends CRM_Core_Form {
/**
* Processing needed for buildForm and later.
- *
- * @return void
*/
public function preProcess() {
$this->_search = CRM_Utils_Array::value('search', $_GET);
/**
* Build the form object.
- *
- *
- * @return void
*/
public function buildQuickForm() {
if ($this->_search) {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Contact_Form_Edit_TagsAndGroups {
const GROUP = 1, TAG = 2, ALL = 3;
/**
- * build form elements.
- * params object $form object of the form
+ * Build form elements.
*
* @param CRM_Core_Form $form
* The form object that we are operating on.
* This is used in batch profile(i.e to build multiple blocks).
*
* @param string $groupElementType
- *
- * @return void
*/
public static function setDefaults($id, &$defaults, $type = self::ALL, $fieldName = NULL, $groupElementType = 'checkbox') {
$type = (int ) $type;
*
*
* @param CRM_Core_Form $form
- * @param $defaults
- *
- * @return void
+ * @param array $defaults
*/
public static function setDefaultValues(&$form, &$defaults) {
$contactEditOptions = $form->get('contactEditOptions');
projects / civicrm-core.git / commitdiff