*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
- */
-
-/**
- *
- * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_ACL_Form_ACL extends CRM_Admin_Form {
/**
* 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() {
// note this also resets any ACL cache
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
-/**
- *
- * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
- */
class CRM_ACL_Form_ACLBasic extends CRM_Admin_Form {
/**
* Set default values for the form.
- *
- *
- * @return void
*/
public function setDefaultValues() {
$defaults = array();
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
parent::buildQuickForm();
/**
* Process the form submission.
- *
- *
- * @return void
*/
public function postProcess() {
CRM_ACL_BAO_Cache::resetCache();
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
- */
-
-/**
- *
- * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_ACL_Form_EntityRole 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_ACL_BAO_Cache::resetCache();
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
/**
* Process the form submission.
- *
- * @return void
*/
public function postProcess() {
$params = $this->controller->exportValues($this->_name);
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
- */
-
-/**
- *
- * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_ACL_Page_ACL 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
/**
* Browse all acls.
- *
- * @return void
*/
public function browse() {
// get all acl's sorted by weight
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
- */
-
-/**
- *
- * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_ACL_Page_ACLBasic 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
/**
* Browse all acls.
- *
- * @return void
*/
public function browse() {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
- */
-
-/**
- *
- * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_ACL_Page_EntityRole 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
/**
* Browse all acls.
- *
- * @return void
*/
public function browse() {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
*/
class CRM_Activity_BAO_Query {
/**
* Build select for Case.
*
- * @param $query
+ * @param CRM_Contact_BAO_Query $query
*/
public static function select(&$query) {
if (!empty($query->_returnProperties['activity_id'])) {
}
/**
- * Given a list of conditions in query generate the required.
- * where clause
+ * Given a list of conditions in query generate the required where clause.
*
* @param $query
- *
- * @return void
*/
public static function where(&$query) {
foreach (array_keys($query->_params) as $id) {
/**
* Where clause for a single field.
*
- * @param $values
- * @param $query
- * @return void
+ * @param array $values
+ * @param CRM_Contact_BAO_Query $query
*/
public static function whereClauseSingle(&$values, &$query) {
list($name, $op, $value, $grouping) = $values;
/**
* Add all the elements shared between case activity search and advanced search.
*
- *
* @param CRM_Core_Form $form
- * @return void
*/
public static function buildSearchForm(&$form) {
$activityOptions = CRM_Core_PseudoConstant::activityType(TRUE, TRUE, FALSE, 'label', TRUE);
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class generates form components for Activity
- *
+ * This class generates form components for Activity.
*/
class CRM_Activity_Form_Activity extends CRM_Contact_Form_Task {
/**
* Build the form object.
- *
- * @return void
*/
public function preProcess() {
CRM_Core_Form_RecurringEntity::preProcess('civicrm_activity');
}
/**
- * Set default values for the form. For edit/view mode
- * the default values are retrieved from the database
- *
+ * Set default values for the form.
*
- * @return void
+ * For edit/view mode the default values are retrieved from the database.
*/
public function setDefaultValues() {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class handle activity view mode
- *
+ * This class handle activity view mode.
*/
class CRM_Activity_Form_ActivityView extends CRM_Core_Form {
/**
* Set variables up before form is built.
- *
- * @return void
*/
public function preProcess() {
//get the activity values
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
$this->addButtons(array(
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
- */
-
-/**
- * Files required
*/
/**
- * This file is for activity search
+ * This file is for activity search.
*/
class CRM_Activity_Form_Search extends CRM_Core_Form_Search {
/**
* Processing needed for buildForm and later.
- *
- * @return void
*/
public function preProcess() {
$this->set('searchFormName', 'Search');
/**
* Build the form object.
- *
- *
- * @return void
*/
public function buildQuickForm() {
parent::buildQuickForm();
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * Class for activity task actions
- *
+ * Class for activity task actions.
*/
class CRM_Activity_Form_Task extends CRM_Core_Form {
/**
* Build all the data structures needed to build the form.
- *
- * @param
- *
- * @return void
*/
public function preProcess() {
self::preProcessCommon($this);
}
/**
+ * Common pre-process function.
+ *
* @param CRM_Core_Form $form
* @param bool $useTable
*/
* Button type for the form after processing.
* @param string $backType
* @param bool $submitOnce
- *
- * @return void
*/
public function addDefaultButtons($title, $nextType = 'next', $backType = 'back', $submitOnce = FALSE) {
$this->addButtons(array(
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
/**
* Build the form object.
- *
- *
- * @return void
*/
public function buildQuickForm() {
// add select for tag
/**
* Process the form after the input has been submitted and validated.
- *
- *
- * @return void
*/
public function postProcess() {
//get the submitted values in an array
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
/**
* Build all the data structures needed to build the form.
- *
- * @return void
*/
public function preProcess() {
/*
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
/**
* 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->addDefaultButtons(ts('Delete Activities'), 'done');
/**
* Process the form after the input has been submitted and validated.
- *
- *
- * @return void
*/
public function postProcess() {
$deleted = $failed = 0;
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id: Email.php 26615 2010-03-21 21:05:35Z kurund $
- *
*/
/**
- * This class provides the functionality to email a group of
- * contacts.
+ * This class provides the functionality to email a group of contacts.
*/
class CRM_Activity_Form_Task_Email extends CRM_Activity_Form_Task {
/**
* Build all the data structures needed to build the form.
- *
- * @return void
*/
public function preProcess() {
CRM_Contact_Form_Task_EmailCommon::preProcessFromAddress($this);
/**
* Build the form object.
- *
- *
- * @return void
*/
public function buildQuickForm() {
//enable form element
/**
* Process the form after the input has been submitted and validated.
- *
- *
- * @return void
*/
public function postProcess() {
CRM_Contact_Form_Task_EmailCommon::postProcess($this);
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
/**
* 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->add('text', 'unclosed_case_id', ts('Select Case'), array('class' => 'huge'), TRUE);
/**
* Add local and global form rules.
- *
- *
- * @return void
*/
public function addRules() {
}
/**
* Process the form after the input has been submitted and validated.
- *
- *
- * @return void
*/
public function postProcess() {
$formparams = $this->exportValues();
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class provides the functionality to email a group of contacts
+ * This class provides the functionality to email a group of contacts.
*/
class CRM_Activity_Form_Task_PickOption extends CRM_Activity_Form_Task {
/**
* Build all the data structures needed to build the form.
- *
- * @return void
*/
public function preProcess() {
/*
/**
* Build the form object.
- *
- *
- * @return void
*/
public function buildQuickForm() {
$this->addElement('checkbox', 'with_contact', ts('With Contact'));
/**
* Add local and global form rules.
- *
- *
- * @return void
*/
public function addRules() {
$this->addFormRule(array('CRM_Activity_Form_Task_PickOption', 'formRule'));
/**
* Process the form after the input has been submitted and validated.
- *
- *
- * @return void
*/
public function postProcess() {
// Clear any formRule errors from Email form in case they came back here via Cancel button
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class provides the functionality for batch profile update for Activity
+ * This class provides the functionality for batch profile update for Activity.
*/
class CRM_Activity_Form_Task_PickProfile extends CRM_Activity_Form_Task {
/**
* Build all the data structures needed to build the form.
- *
- * @return void
*/
public function preProcess() {
/*
/**
* Build the form object.
- *
- *
- * @return void
*/
public function buildQuickForm() {
$types = array('Activity');
/**
* Add local and global form rules.
- *
- *
- * @return void
*/
public function addRules() {
$this->addFormRule(array('CRM_Activity_Form_Task_PickProfile', 'formRule'));
/**
* Process the form after the input has been submitted and validated.
- *
- *
- * @return void
*/
public function postProcess() {
$params = $this->exportValues();
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class provides the functionality to print activity records
+ * This class provides the functionality to print activity records.
*/
class CRM_Activity_Form_Task_Print extends CRM_Activity_Form_Task {
/**
* 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.
+ *
+ * Consists of
* - displaying the QILL (query in local language)
* - displaying elements for saving the search
- *
- *
- * @return void
*/
public function buildQuickForm() {
//
/**
* 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
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
protected $_tags;
/**
- * Build the form object
- *
- *
- * @return void
+ * Build the form object.
*/
public function buildQuickForm() {
// add select for tag
/**
* Process the form after the input has been submitted and validated.
- *
- *
- * @return void
*/
public function postProcess() {
//get the submitted values in an array
*/
/**
- * This class provides the functionality to sms a group of
- * contacts.
+ * This class provides the functionality to sms a group of contacts.
*/
class CRM_Activity_Form_Task_SMS extends CRM_Activity_Form_Task {
/**
* 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() {
//enable form element
/**
* Process the form after the input has been submitted and validated.
- *
- *
- * @return void
*/
public function postProcess() {
CRM_Contact_Form_Task_SMSCommon::postProcess($this);
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
/**
* 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(
*
* @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_Activity_Import_Form_DataSource extends CRM_Import_Form_DataSource {
/**
* 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_Activity_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
+ * 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_Activity_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
+ * 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_Activity_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_Activity_Import_Parser extends CRM_Import_Parser {
}
/**
- * Given a list of the importable field keys that the user has selected
- * set the active fields array to this list
+ * Given a list of the importable field keys that the user has selected set the active fields array to this list.
*
* @param array $fieldKeys
- *
- * @return void
*/
public function setActiveFields($fieldKeys) {
$this->_activeFieldCount = count($fieldKeys);
* @param CRM_Core_Session $store
*
* @param int $mode
- *
- * @return void
*/
public function set($store, $mode = self::MODE_SUMMARY) {
$store->set('fileSize', $this->_fileSize);
* @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$
- *
*/
-require_once 'api/api.php';
/**
- * class to parse activity csv files
+ * Class to parse activity csv files.
*/
class CRM_Activity_Import_Parser_Activity extends CRM_Activity_Import_Parser {
/**
* Class constructor.
- * @param $mapperKeys
+ *
+ * @param array $mapperKeys
* @param null $mapperLocType
* @param null $mapperPhoneType
*/
}
/**
- * The initializer code, called before the processing
- *
- * @return void
+ * The initializer code, called before the processing.
*/
public function init() {
$activityContact = CRM_Activity_BAO_ActivityContact::import();
}
/**
- * 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$
- *
*/
/**
- * Main page for viewing activities
- *
+ * Main page for viewing activities,
*/
class CRM_Activity_Page_Tab extends CRM_Core_Page {
/**
* Browse all activities for a particular contact.
- *
- * @return void
*/
public function browse() {
$this->assign('admin', FALSE);
}
/**
- * 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() {
$this->_contactId = CRM_Utils_Request::retrieve('cid', 'Positive', $this, TRUE);
/**
* Perform actions and display for activities.
- *
- * @return void
*/
public function run() {
$context = CRM_Utils_Request::retrieve('context', 'String', $this);
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class is for building event(participation) block on user dashboard
+ * This class is for building event(participation) block on user dashboard.
*/
class CRM_Activity_Page_UserDashboard extends CRM_Contact_Page_View_UserDashBoard {
}
/**
- * the main function that is called when the page
- * loads, it decides the which action has to be taken for the page.
+ * The main function that is called when the page loads.
*
- * @return void
+ * It decides the which action has to be taken for the page.
*/
public function run() {
parent::preProcess();
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * Base class for admin forms
+ * Base class for admin forms.
*/
class CRM_Admin_Form extends CRM_Core_Form {
/**
* Add standard buttons.
- *
- * @return void
*/
public function buildQuickForm() {
if ($this->_action & CRM_Core_Action::VIEW || $this->_action & CRM_Core_Action::PREVIEW) {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
* This class generates form components for Synchronizing CMS Users
- *
*/
class CRM_Admin_Form_CMSUser extends CRM_Core_Form {
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
/**
* Process the form submission.
- *
- *
- * @return void
*/
public function postProcess() {
CRM_Core_BAO_CMSUser::synchronize();
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class generates form components for ContactSub Type
- *
+ * This class generates form components for ContactSub Type.
*/
class CRM_Admin_Form_ContactType 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 Extensions
- *
+ * This class generates form components for Extensions.
*/
class CRM_Admin_Form_Extensions extends CRM_Admin_Form {
/**
- * For pre-processing
- *
- * @return void
+ * Form pre-processing.
*/
public function preProcess() {
parent::preProcess();
/**
* Set default values for the form.
- * the default values are retrieved from the database
- *
- *
- * @return void
*/
public function setDefaultValues() {
$defaults = array();
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
switch ($this->_action) {
/**
* Process the form submission.
- *
- *
- * @return void
*/
public function postProcess() {
CRM_Utils_System::flushCache();
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id: $
- *
*/
/**
- *
+ * Class for configuring jobs.
*/
class CRM_Admin_Form_Job 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() {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class generates form components for Label Format Settings
- *
+ * This class generates form components for Label Format Settings.
*/
class CRM_Admin_Form_LabelFormats 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 Location Type
- *
+ * This class generates form components for Location Type.
*/
class CRM_Admin_Form_LocationType 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('CRM_Core_DAO_LocationType');
projects / civicrm-core.git / commitdiff