*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Bridge_OG_CiviCRM {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Bridge_OG_Utils {
const aclEnabled = 1, syncFromCiviCRM = 1;
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Campaign_BAO_Campaign extends CRM_Campaign_DAO_Campaign {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
-require_once 'CRM/Campaign/DAO/Survey.php';
/**
- * Class CRM_Campaign_BAO_Survey
+ * Class CRM_Campaign_BAO_Survey.
*/
class CRM_Campaign_BAO_Survey extends CRM_Campaign_DAO_Survey {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Campaign_Config extends CRM_Core_Component_Config {
}
*
* @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$
- *
*/
/**
- * This class generates form components for adding a petition
- *
+ * This class generates form components for adding a petition.
*/
class CRM_Campaign_Form_Petition extends CRM_Core_Form {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
class CRM_Campaign_Form_Survey_TabHeader {
/**
+ * Build tab header.
+ *
* @param CRM_Core_Form $form
*
* @return array
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Campaign_Info extends CRM_Core_Component_Info {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * Page for displaying Campaigns
+ * Page for displaying Campaigns.
*/
class CRM_Campaign_Page_DashBoard extends CRM_Core_Page {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * Page for displaying Petition Signatures
+ * Page for displaying Petition Signatures.
*/
class CRM_Campaign_Page_Petition extends CRM_Core_Page {
public function browse() {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Campaign_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 voters.
- * used by the search forms
+ * class to represent the actions that can be performed on a group of voters.
*
+ * Used by the search forms.
*/
class CRM_Campaign_Task {
const INTERVIEW = 1, RESERVE = 2, RELEASE = 3, PRINT_VOTERS = 4;
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class generates form components for OpenCase Activity
- *
+ * This class generates form components for OpenCase Activity.
*/
class CRM_Case_Form_Activity_LinkCases {
/**
}
/**
- * Set default values for the form. For edit/view mode
- * the default values are retrieved from the database
- *
+ * Set default values for the form.
*
* @param CRM_Core_Form $form
*
- * @return void
+ * @return array
*/
public static function setDefaultValues(&$form) {
return $defaults = array();
*
* @param CRM_Core_Form $form
* @param array $params
- *
- * @return void
*/
public static function beginPostProcess(&$form, &$params) {
}
*
* @param CRM_Core_Form $form
* @param array $params
- * @param $activity
- *
- * @return void
+ * @param CRM_Activity_BAO_Activity $activity
*/
public static function endPostProcess(&$form, &$params, &$activity) {
$activityId = $activity->id;
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class generates form components for OpenCase Activity
- *
+ * This class generates form components for OpenCase Activity.
*/
class CRM_Case_Form_Activity_OpenCase {
*
*
* @param CRM_Core_Form $form
- *
- * @return void
*/
public static function setDefaultValues(&$form) {
$defaults = array();
*
* @param CRM_Core_Form $form
* @param array $params
- *
- * @return void
*/
public static function beginPostProcess(&$form, &$params) {
if ($form->_context == 'caseActivity') {
/**
* Process the form submission.
*
- *
- * @param $form
+ * @param CRM_Core_Form $form
* @param array $params
- *
- * @return void
*/
public static function endPostProcess(&$form, &$params) {
if ($form->_context == 'caseActivity') {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class generates form components for building activity to a case
- *
+ * This class generates form components for building activity to a case.
*/
class CRM_Case_Form_ActivityToCase extends CRM_Core_Form {
/**
* Build all the data structures needed to build the form.
- *
- * @return void
*/
public function preProcess() {
$this->_activityId = CRM_Utils_Request::retrieve('activityId', 'Positive', CRM_Core_DAO::$_nullObject);
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
$this->add('text', 'file_on_case_unclosed_case_id', ts('Select Case'), array('class' => 'huge'), TRUE);
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class does pre processing for viewing an activity or their revisions
- *
+ * This class does pre processing for viewing an activity or their revisions.
*/
class CRM_Case_Form_ActivityView extends CRM_Core_Form {
/**
* Process the view.
- *
- *
- * @return void
*/
public function preProcess() {
$contactID = CRM_Utils_Request::retrieve('cid', 'Integer', $this, TRUE);
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class generates form components for case activity
- *
+ * This class generates form components for case activity.
*/
class CRM_Case_Form_Case extends CRM_Core_Form {
/**
* Build the form object.
- *
- * @return void
*/
public function preProcess() {
}
/**
- * Set default values for the form. For edit/view mode
- * the default values are retrieved from the database
- *
- *
- * @return void
+ * Set default values for the form.
*/
public function setDefaultValues() {
if ($this->_action & CRM_Core_Action::DELETE || $this->_action & CRM_Core_Action::RENEW) {
/**
* Add local and global form rules.
*
- *
- * @return void
+ * @return bool
*/
public function addRules() {
if ($this->_action & CRM_Core_Action::DELETE || $this->_action & CRM_Core_Action::RENEW) {
/**
* Process the form submission.
- *
- *
- * @return void
*/
public function postProcess() {
$transaction = new CRM_Core_Transaction();
*
* @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_Case_Form_CustomData extends CRM_Core_Form {
* Pre processing work done here.
*
* gets session variables for table name, id of entity in table, type of entity and stores them.
- *
- * @param
- *
- * @return void
*/
public function preProcess() {
$this->_groupID = CRM_Utils_Request::retrieve('groupID', 'Positive', $this, TRUE);
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
// make this form an upload since we dont know if the custom data injected dynamically
/**
* Process the user submitted custom data values.
- *
- *
- * @return void
*/
public function postProcess() {
$params = $this->controller->exportValues($this->_name);
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class assigns the current case to another client
- *
+ * This class assigns the current case to another client.
*/
class CRM_Case_Form_EditClient extends CRM_Core_Form {
/**
* Build all the data structures needed to build the form.
- *
- * @return void
*/
public function preProcess() {
$cid = CRM_Utils_Request::retrieve('cid', 'Positive', $this, TRUE);
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
$this->addEntityRef('reassign_contact_id', ts('Select Contact'), array('create' => TRUE), TRUE);
/**
* Process the form.
- *
- * @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 case report
- *
+ * This class generates form components for case report.
*/
class CRM_Case_Form_Report extends CRM_Core_Form {
/**
* Build the form object.
- *
- * @return void
*/
public function preProcess() {
$this->_caseID = CRM_Utils_Request::retrieve('caseid', 'Integer', $this, TRUE);
/**
* 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 file is for Case search
+ * This file is for Case search.
*/
class CRM_Case_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();
* done.
* The processing consists of using a Selector / Controller framework for getting the
* search results.
- *
- * @param
- *
- * @return void
*/
public function postProcess() {
if ($this->_done) {
}
/**
- * add the rules (mainly global rules) for form.
+ * Add the rules (mainly global rules) for form.
+ *
* All local rules are added near the element
*
- * @return void
* @see valid_date
*/
public function addRules() {
* @param array $fields
* Posted values of the form.
*
- * @return void
+ * @return array|bool
*/
public static function formRule($fields) {
$errors = array();
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class generates task actions for CiviEvent
- *
+ * This class generates task actions for CiviEvent.
*/
class CRM_Case_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);
* 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$
- *
*/
/**
- * This class provides the functionality to delete a group of
- * case records. This class provides functionality for the actual
- * deletion.
+ * This class provides the functionality to delete a group of case records.
*/
class CRM_Case_Form_Task_Delete extends CRM_Case_Form_Task {
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
$this->addDefaultButtons(ts('Delete Cases'), '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$
- *
*/
/**
/**
* 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() {
//
/**
* 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$
- *
*/
/**
- * This class provides the functionality to restore a group of
- * participations. This class provides functionality for the actual
- * deletion.
+ * This class provides the functionality to restore a group of participations.
*/
class CRM_Case_Form_Task_Restore extends CRM_Case_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() {
$this->addDefaultButtons(ts('Restore Cases'), 'done');
/**
* Process the form after the input has been submitted and validated.
- *
- *
- * @return void
*/
public function postProcess() {
$restoredCases = $failed = 0;
projects / civicrm-core.git / commitdiff