*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * Auxiliary class to provide support to the Contact Form class. Does this by implementing
- * a small set of static methods
+ * Auxiliary class to provide support to the Contact Form class.
*
+ * Does this by implementing a small set of static methods.
*/
class CRM_Contact_Form_Edit_Individual {
/**
- * This function provides the HTML form elements that are specific
- * to the Individual Contact Type
+ * This function provides the HTML form elements that are specific to the Individual Contact Type.
*
* @param CRM_Core_Form $form
* Form object.
* @param int $inlineEditMode
* ( 1 for contact summary.
* top bar form and 2 for display name edit )
- *
- * @return void
*/
public static function buildQuickForm(&$form, $inlineEditMode = NULL) {
$form->applyFilter('__ALL__', 'trim');
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * Auxiliary class to provide support for locking (and ignoring locks on)
- * contact records.
+ * Auxiliary class to provide support for locking (and ignoring locks on) contact records.
*/
class CRM_Contact_Form_Edit_Lock {
*
* @param CRM_Core_Form $form
* Form object.
- *
- * @return void
*/
public static function buildQuickForm(&$form) {
$form->addField('modified_date', array('type' => 'hidden', 'id' => 'modified_date', 'label' => ''));
}
/**
- * Ensure that modified_date hasn't changed in the underlying DB
+ * Ensure that modified_date has not changed in the underlying DB.
*
* @param array $fields
* The input form values.
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Contact_Form_Edit_Notes {
/**
- * build form elements.
- * params object $form object of the form
+ * Build form elements.
*
- * @param $form
+ * @param CRM_Core_Form $form
*/
public static function buildQuickForm(&$form) {
$form->applyFilter('__ALL__', 'trim');
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * form helper class for an OpenID object
+ * Form helper class for an OpenID object.
*/
class CRM_Contact_Form_Edit_OpenID {
* Block number to build.
* @param bool $blockEdit
* Is it block edit.
- *
- * @return void
*/
public static function buildQuickForm(&$form, $blockCount = NULL, $blockEdit = FALSE) {
if (!$blockCount) {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * Auxiliary class to provide support to the Contact Form class. Does this by implementing
- * a small set of static methods
+ * Auxiliary class to provide support to the Contact Form class.
*
+ * Does this by implementing a small set of static methods.
*/
class CRM_Contact_Form_Edit_Organization {
/**
- * This function provides the HTML form elements that are specific
- * to the Organization Contact Type
+ * This function provides the HTML form elements that are specific to the Organization Contact Type.
*
* @param CRM_Core_Form $form
* Form object.
* @param int $inlineEditMode
* ( 1 for contact summary.
* top bar form and 2 for display name edit )
- *
- * @return void
*/
public static function buildQuickForm(&$form, $inlineEditMode = NULL) {
$form->applyFilter('__ALL__', 'trim');
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
*/
/**
- * form helper class for a phone object
+ * Form helper class for a phone object.
*/
class CRM_Contact_Form_Edit_Phone {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * form helper class for an Website object
+ * Form helper class for an Website object.
*/
class CRM_Contact_Form_Edit_Website {
* Reference to the form object.
* @param int $blockCount
* Block number to build.
- *
- * @return void
*/
public static function buildQuickForm(&$form, $blockCount = NULL) {
if (!$blockCount) {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class generates form components for groupContact
- *
+ * This class generates form components for groupContact.
*/
class CRM_Contact_Form_GroupContact extends CRM_Core_Form {
return 'create';
}
+ /**
+ * Pre process form.
+ */
public function preProcess() {
$this->_contactId = $this->get('contactId');
$this->_groupContactId = $this->get('groupContactId');
/**
* Build the form object.
- *
- * @return void
*/
public function buildQuickForm() {
// get the list of all the groups
}
/**
- *
- * @return void
+ * Post process form.
*/
public function postProcess() {
$contactID = array($this->_contactId);
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * Parent class for inline contact forms
+ * Parent class for inline contact forms.
*/
abstract class CRM_Contact_Form_Inline extends CRM_Core_Form {
/**
* Common form elements.
- *
- * @return void
*/
public function buildQuickForm() {
CRM_Contact_Form_Inline_Lock::buildQuickForm($this, $this->_contactId);
/**
* Override default cancel action.
- *
- * @return void
*/
public function cancelAction() {
$response = array('status' => 'cancel');
/**
* Add entry to log table.
- *
- * @return void
*/
protected function log() {
CRM_Core_BAO_Log::register($this->_contactId,
/**
* Common function for all inline contact edit forms.
- * Prepares ajaxResponse
*
- * @return void
+ * Prepares ajaxResponse
*/
protected function response() {
$this->ajaxResponse = array_merge(
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * form helper class for address section
+ * Form helper class for address section.
*/
class CRM_Contact_Form_Inline_Address extends CRM_Contact_Form_Inline {
public $_addressId;
/**
+ * Class constructor.
+ *
* Since we are using same class / code to generate multiple instances
* of address block, we need to generate unique form name for each,
- * hence calling parent contructor
+ * hence calling parent constructor
*/
public function __construct() {
$locBlockNo = CRM_Utils_Request::retrieve('locno', 'Positive', CRM_Core_DAO::$_nullObject, TRUE, NULL, $_REQUEST);
/**
* Build the form object elements for an address object.
- *
- * @return void
*/
public function buildQuickForm() {
parent::buildQuickForm();
/**
* Process the form.
- *
- * @return void
*/
public function postProcess() {
$params = $this->exportValues();
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * form helper class for communication preferences inline edit section
+ * Form helper class for communication preferences inline edit section.
*/
class CRM_Contact_Form_Inline_CommunicationPreferences extends CRM_Contact_Form_Inline {
/**
* Build the form object elements for communication preferences.
- *
- * @return void
*/
public function buildQuickForm() {
parent::buildQuickForm();
/**
* Process the form.
- *
- * @return void
*/
public function postProcess() {
$params = $this->exportValues();
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * form helper class for contact info section
+ * Form helper class for contact info section.
*/
class CRM_Contact_Form_Inline_ContactInfo extends CRM_Contact_Form_Inline {
/**
* Build the form object elements.
- *
- * @return void
*/
public function buildQuickForm() {
parent::buildQuickForm();
/**
* Process the form.
- *
- * @return void
*/
public function postProcess() {
$params = $this->exportValues();
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * form helper class for contact name section
+ * Form helper class for contact name section.
*/
class CRM_Contact_Form_Inline_ContactName extends CRM_Contact_Form_Inline {
/**
* Build the form object elements.
- *
- * @return void
*/
public function buildQuickForm() {
parent::buildQuickForm();
/**
* Process the form.
- *
- * @return void
*/
public function postProcess() {
$params = $this->exportValues();
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * form helper class for custom data section
+ * Form helper class for custom data section.
*/
class CRM_Contact_Form_Inline_CustomData extends CRM_Contact_Form_Inline {
/**
* Build the form object elements for custom data.
- *
- * @return void
*/
public function buildQuickForm() {
parent::buildQuickForm();
/**
* Process the form.
- *
- * @return void
*/
public function postProcess() {
// Process / save custom data
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * form helper class for demographics section
+ * Form helper class for demographics section.
*/
class CRM_Contact_Form_Inline_Demographics extends CRM_Contact_Form_Inline {
/**
* Build the form object elements.
- *
- * @return void
*/
public function buildQuickForm() {
parent::buildQuickForm();
/**
* Process the form.
- *
- * @return void
*/
public function postProcess() {
$params = $this->exportValues();
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * form helper class for an Email object
+ * Form helper class for an Email object.
*/
class CRM_Contact_Form_Inline_Email extends CRM_Contact_Form_Inline {
/**
* Build the form object elements for an email object.
- *
- * @return void
*/
public function buildQuickForm() {
parent::buildQuickForm();
/**
* Process the form.
- *
- * @return void
*/
public function postProcess() {
$params = $this->exportValues();
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * form helper class for an IM object
+ * Form helper class for an IM object.
*/
class CRM_Contact_Form_Inline_IM extends CRM_Contact_Form_Inline {
/**
* Build the form object elements for im object.
- *
- * @return void
*/
public function buildQuickForm() {
parent::buildQuickForm();
/**
* Process the form.
- *
- * @return void
*/
public function postProcess() {
$params = $this->exportValues();
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * Auxiliary class to provide support for locking (and ignoring locks on)
- * contact records.
+ * Auxiliary class to provide support for locking (and ignoring locks on) contact records.
*/
class CRM_Contact_Form_Inline_Lock {
* @param CRM_Core_Form $form
* Form object.
* @param int $contactID
- *
- * @return void
*/
public static function buildQuickForm(&$form, $contactID) {
// We provide a value for oplock_ts to client, but JS uses it carefully
}
/**
- * Ensure that oplock_ts hasn't changed in the underlying DB
+ * Ensure that oplock_ts hasn't changed in the underlying DB.
*
* @param array $fields
* The input form values.
}
/**
- * Return any post-save data
+ * Return any post-save data.
*
* @param int $contactID
*
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * form helper class for an OpenID object
+ * Form helper class for an OpenID object.
*/
class CRM_Contact_Form_Inline_OpenID extends CRM_Contact_Form_Inline {
/**
* Build the form object elements for openID object.
- *
- * @return void
*/
public function buildQuickForm() {
parent::buildQuickForm();
/**
* Process the form.
- *
- * @return void
*/
public function postProcess() {
$params = $this->exportValues();
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * form helper class for an Phone object
+ * Form helper class for an Phone object.
*/
class CRM_Contact_Form_Inline_Phone extends CRM_Contact_Form_Inline {
/**
* Build the form object elements for phone object.
- *
- * @return void
*/
public function buildQuickForm() {
parent::buildQuickForm();
/**
* Process the form.
- *
- * @return void
*/
public function postProcess() {
$params = $this->exportValues();
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * form helper class for an Website object
+ * Form helper class for an Website object,
*/
class CRM_Contact_Form_Inline_Website extends CRM_Contact_Form_Inline {
/**
* Build the form object elements for website object.
- *
- * @return void
*/
public function buildQuickForm() {
parent::buildQuickForm();
/**
* Process the form.
- *
- * @return void
*/
public function postProcess() {
$params = $this->exportValues();
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Contact_Form_Location {
* Set variables up before form is built.
*
* @param CRM_Core_Form $form
- *
- * @return void
*/
public static function preProcess(&$form) {
$form->_addBlockName = CRM_Utils_Request::retrieve('block', 'String', CRM_Core_DAO::$_nullObject);
* Build the form object.
*
* @param CRM_Core_Form $form
- *
- * @return void
*/
public static function buildQuickForm(&$form) {
// required for subsequent AJAX requests.
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
-require_once 'api/api.php';
-
/**
- * Class CRM_Contact_Form_Merge
+ * Class CRM_Contact_Form_Merge.
*/
class CRM_Contact_Form_Merge extends CRM_Core_Form {
// the id of the contact that tere's a duplicate for; this one will
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Contact_Form_ProfileContact {
* Set variables up before form is built.
*
* @param CRM_Core_Form $form
- *
- * @return void
*/
public static function preProcess(&$form) {
$session = CRM_Core_Session::singleton();
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
*/
/**
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
- */
-
-/**
- * Files required
*/
/**
/**
* Build the common elements between the search/advanced form.
- *
- * @return void
*/
public function buildQuickForm() {
parent::buildQuickForm();
/**
* Processing needed for buildForm and later.
- *
- * @return void
*/
public function preProcess() {
// set the various class variables
/**
* Common post processing.
- *
- * @return void
*/
public function postProcess() {
/*
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
- */
-
-/**
- * Files required
*/
/**
- * advanced search, extends basic search
+ * Advanced search, extends basic search.
*/
class CRM_Contact_Form_Search_Advanced extends CRM_Contact_Form_Search {
/**
* Processing needed for buildForm and later.
- *
- * @return void
*/
public function preProcess() {
$this->set('searchFormName', 'Advanced');
/**
* Build the form object.
- *
- *
- * @return void
*/
public function buildQuickForm() {
$this->set('context', 'advanced');
);
//check if there are any custom data searchable fields
- $groupDetails = array();
$extends = array_merge(array('Contact', 'Individual', 'Household', 'Organization'),
CRM_Contact_BAO_ContactType::subTypes()
);
* The post processing of the form gets done here.
*
* Key things done during post processing are
- * - check for reset or next request. if present, skip post procesing.
+ * - check for reset or next request. if present, skip post processing.
* - now check if user requested running a saved search, if so, then
* the form values associated with the saved search are used for searching.
- * - if user has done a submit with new values the regular post submissing is
+ * - if user has done a submit with new values the regular post submitting is
* done.
* The processing consists of using a Selector / Controller framework for getting the
* search results.
- *
- * @param
- *
- * @return void
*/
public function postProcess() {
$this->set('isAdvanced', '1');
}
/**
- * Normalize the form values to make it look similar to the advanced form values
- * this prevents a ton of work downstream and allows us to use the same code for
- * multiple purposes (queries, save/edit etc)
+ * Normalize the form values to make it look similar to the advanced form values.
*
- * @return void
+ * This prevents a ton of work downstream and allows us to use the same code for
+ * multiple purposes (queries, save/edit etc)
*/
public function normalizeFormValues() {
$contactType = CRM_Utils_Array::value('contact_type', $this->_formValues);
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
- */
-
-/**
- * Files required
*/
/**
- * Base Search / View form for *all* listing of multiple
- * contacts
+ * Base Search / View form for *all* listing of multiple contacts.
*/
class CRM_Contact_Form_Search_Basic extends CRM_Contact_Form_Search {
/**
* Build the form object.
- *
- *
- * @return void
*/
public function buildQuickForm() {
// text for sort_name or email criteria
/**
* Add local and global form rules.
- *
- *
- * @return void
*/
public function addRules() {
$this->addFormRule(array('CRM_Contact_Form_Search_Basic', 'formRule'));
/**
* Processing needed for buildForm and later.
- *
- * @return void
*/
public function preProcess() {
$this->set('searchFormName', 'Basic');
/**
* This method is called for processing a submitted search form.
- *
- * @return void
*/
public function postProcess() {
$this->set('isAdvanced', '0');
}
/**
- * Normalize the form values to make it look similar to the advanced form values
- * this prevents a ton of work downstream and allows us to use the same code for
- * multiple purposes (queries, save/edit etc)
+ * Normalize the form values to make it look similar to the advanced form values.
*
- * @return void
+ * This prevents a ton of work downstream and allows us to use the same code for
+ * multiple purposes (queries, save/edit etc)
*/
public function normalizeFormValues() {
$contactType = CRM_Utils_Array::value('contact_type', $this->_formValues);
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class if for search builder processing
+ * This class is for search builder processing.
*/
class CRM_Contact_Form_Search_Builder extends CRM_Contact_Form_Search {
/**
* Build the form object.
- *
- * @return void
*/
public function preProcess() {
$this->set('searchFormName', 'Builder');
/**
* Add local and global form rules.
- *
- *
- * @return void
*/
public function addRules() {
$this->addFormRule(array('CRM_Contact_Form_Search_Builder', 'formRule'), $this);
/**
* Global validation rules for the form.
*
- * @param $values
- * @param $files
- * @param $self
+ * @param array $values
+ * @param array $files
+ * @param CRM_Core_Form $self
*
* @return array
* list of errors to be posted back to the form
/**
* Process the uploaded file.
- *
- * @return void
*/
public function postProcess() {
$this->set('isAdvanced', '2');
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Contact_Form_Search_Criteria {
/**
}
/**
- * Generate the custom Data Fields based
- * on the is_searchable
- *
+ * Generate the custom Data Fields based for those with is_searchable = 1.
*
- * @param $form
- *
- * @return void
+ * @param CRM_Contact_Form_Search $form
*/
public static function custom(&$form) {
$form->add('hidden', 'hidden_custom', 1);
$_groupTitle[$key] = $group['name'];
CRM_Core_ShowHideBlocks::links($form, $group['name'], '', '');
- $groupId = $group['id'];
foreach ($group['fields'] as $field) {
$fieldId = $field['id'];
$elementName = 'custom_' . $fieldId;
);
}
}
-
- //TODO: validate for only one state if prox_distance isset
}
/**
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Contact_Form_Search_Custom extends CRM_Contact_Form_Search {
}
/**
- * This virtual function is used to set the default values of
- * various form elements
- *
- * access public
+ * Set the default values of various form elements.
*
* @return array
* reference to the array of default values
*/
- /**
- * @return array
- */
public function setDefaultValues() {
if (method_exists($this->_customSearchClass, 'setDefaultValues')) {
return $this->_customClass->setDefaultValues();
}
/**
- * Return a descriptive name for the page, used in wizard header
+ * Return a descriptive name for the page, used in wizard header.
*
* @return string
*/
- /**
- * @return string
- */
public function getTitle() {
return ts('Custom Search');
}
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Contact_Form_Search_Custom_ActivitySearch extends CRM_Contact_Form_Search_Custom_Base implements CRM_Contact_Form_Search_Interface {
protected $_aclWhere = NULL;
/**
- * @param $formValues
- */
- /**
- * @param $formValues
+ * Class constructor.
+ *
+ * @param array $formValues
*/
public function __construct(&$formValues) {
$this->_formValues = $formValues;
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Contact_Form_Search_Custom_Base {
protected $_stateID;
/**
- * @param $formValues
+ * Class constructor.
+ *
+ * @param array $formValues
*/
public function __construct(&$formValues) {
$this->_formValues = &$formValues;
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Contact_Form_Search_Custom_Basic extends CRM_Contact_Form_Search_Custom_Base implements CRM_Contact_Form_Search_Interface {
protected $_aclWhere = NULL;
/**
- * @param $formValues
- */
- /**
- * @param $formValues
+ * Class constructor.
+ *
+ * @param array $formValues
*/
public function __construct(&$formValues) {
parent::__construct($formValues);
}
/**
- * Normalize the form values to make it look similar to the advanced form values
- * this prevents a ton of work downstream and allows us to use the same code for
- * multiple purposes (queries, save/edit etc)
+ * Normalize the form values to make it look similar to the advanced form values.
*
- * @return void
+ * This prevents a ton of work downstream and allows us to use the same code for
+ * multiple purposes (queries, save/edit etc)
*/
public function normalize() {
$contactType = CRM_Utils_Array::value('contact_type', $this->_formValues);
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Contact_Form_Search_Custom_ContribSYBNT extends CRM_Contact_Form_Search_Custom_Base implements CRM_Contact_Form_Search_Interface {
public $_permissionedComponent;
/**
+ * Class constructor.
+ *
* @param $formValues
*/
public function __construct(&$formValues) {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Contact_Form_Search_Custom_ContributionAggregate extends CRM_Contact_Form_Search_Custom_Base implements CRM_Contact_Form_Search_Interface {
public $_permissionedComponent;
/**
- * @param $formValues
+ * Class constructor.
+ *
+ * @param array $formValues
*/
public function __construct(&$formValues) {
$this->_formValues = $formValues;
}
/**
+ * Build form.
+ *
* @param CRM_Core_Form $form
*/
public function buildForm(&$form) {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Contact_Form_Search_Custom_DateAdded extends CRM_Contact_Form_Search_Custom_Base implements CRM_Contact_Form_Search_Interface {
protected $_aclWhere = NULL;
/**
- * @param $formValues
+ * Class constructor.
+ *
+ * @param array $formValues
*/
public function __construct(&$formValues) {
parent::__construct($formValues);
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Contact_Form_Search_Custom_EventAggregate extends CRM_Contact_Form_Search_Custom_Base implements CRM_Contact_Form_Search_Interface {
public $_permissionedComponent;
/**
- * @param $formValues
+ * Class constructor.
+ *
+ * @param array $formValues
*/
public function __construct(&$formValues) {
$this->_formValues = $formValues;
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Contact_Form_Search_Custom_FullText extends CRM_Contact_Form_Search_Custom_Base implements CRM_Contact_Form_Search_Interface {
protected $_foundRows = array();
/**
- * @param $formValues
+ * Class constructor.
+ *
+ * @param array $formValues
*/
public function __construct(&$formValues) {
$this->_partialQueries = array(
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
abstract class CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Contact_Form_Search_Custom_FullText_Activity extends CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery {
/**
* @param string $queryText
* @param string $entityIDTableName
+ *
* @return array
* list tables/queries (for runQueries)
*/
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Contact_Form_Search_Custom_FullText_Case extends CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Contact_Form_Search_Custom_FullText_Contact extends CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery {
}
/**
+ * Check if search is permitted.
+ *
* @return bool
*/
public function isActive() {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Contact_Form_Search_Custom_FullText_Contribution extends CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery {
}
/**
+ * Check if search is permitted.
+ *
* @return bool
*/
public function isActive() {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Contact_Form_Search_Custom_FullText_Membership extends CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery {
}
/**
+ * Check if search is permitted.
+ *
* @return bool
*/
public function isActive() {
*
* @param string $queryText
* @param string $entityIDTableName
+ *
* @return array
* list tables/queries (for runQueries)
*/
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Contact_Form_Search_Custom_FullText_Participant extends CRM_Contact_Form_Search_Custom_FullText_AbstractPartialQuery {
}
/**
+ * Check if user has permission.
+ *
* @return bool
*/
public function isActive() {
*
* @param string $queryText
* @param string $entityIDTableName
+ *
* @return array
* list tables/queries (for runQueries)
*/
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Contact_Form_Search_Custom_Group extends CRM_Contact_Form_Search_Custom_Base implements CRM_Contact_Form_Search_Interface {
protected $_aclWhere = NULL;
/**
- * @param $formValues
+ * Class constructor.
+ *
+ * @param array $formValues
*/
public function __construct(&$formValues) {
$this->_formValues = $formValues;
}
/**
+ * Define columns.
+ *
* @return array
*/
public function &columns() {
}
/**
+ * Get summary.
+ *
* @return NULL
*/
public function summary() {
}
/**
+ * Get template file.
+ *
* @return string
*/
public function templateFile() {
}
/**
- * @param $title
+ * Set title on search.
+ *
+ * @param string $title
*/
public function setTitle($title) {
if ($title) {
}
/**
+ * Build ACL clause.
+ *
* @param string $tableAlias
*/
public function buildACLClause($tableAlias = 'contact') {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Contact_Form_Search_Custom_MultipleValues extends CRM_Contact_Form_Search_Custom_Base implements CRM_Contact_Form_Search_Interface {
protected $_aclWhere = NULL;
/**
- * @param $formValues
+ * Class constructor.
+ *
+ * @param array $formValues
*/
public function __construct(&$formValues) {
parent::__construct($formValues);
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Contact_Form_Search_Custom_PostalMailing extends CRM_Contact_Form_Search_Custom_Base implements CRM_Contact_Form_Search_Interface {
protected $_aclFrom = NULL;
protected $_aclWhere = NULL;
/**
- * @param $formValues
+ * Class constructor.
+ *
+ * @param array $formValues
*/
public function __construct(&$formValues) {
parent::__construct($formValues);
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Contact_Form_Search_Custom_PriceSet extends CRM_Contact_Form_Search_Custom_Base implements CRM_Contact_Form_Search_Interface {
public $_permissionedComponent;
/**
- * @param $formValues
+ * Class constructor.
+ *
+ * @param array $formValues
*/
public function __construct(&$formValues) {
parent::__construct($formValues);
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Contact_Form_Search_Custom_Proximity extends CRM_Contact_Form_Search_Custom_Base implements CRM_Contact_Form_Search_Interface {
protected $_aclWhere = NULL;
/**
- * @param $formValues
+ * Class constructor.
+ *
+ * @param array $formValues
*
* @throws Exception
*/
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Contact_Form_Search_Custom_RandomSegment extends CRM_Contact_Form_Search_Custom_Base implements CRM_Contact_Form_Search_Interface {
protected $_aclWhere = NULL;
/**
- * @param $formValues
+ * Class constructor.
+ *
+ * @param array $formValues
*/
public function __construct(&$formValues) {
parent::__construct($formValues);
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Contact_Form_Search_Custom_Sample extends CRM_Contact_Form_Search_Custom_Base implements CRM_Contact_Form_Search_Interface {
protected $_aclFrom = NULL;
protected $_aclWhere = NULL;
/**
- * @param $formValues
+ * Class constructor.
+ *
+ * @param array $formValues
*/
public function __construct(&$formValues) {
parent::__construct($formValues);
}
/**
+ * Build form.
+ *
* @param CRM_Core_Form $form
*/
public function buildForm(&$form) {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Contact_Form_Search_Custom_TagContributions extends CRM_Contact_Form_Search_Custom_Base implements CRM_Contact_Form_Search_Interface {
public $_permissionedComponent;
/**
- * @param $formValues
+ * Class constructor.
+ *
+ * @param array $formValues
*/
public function __construct(&$formValues) {
$this->_formValues = $formValues;
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
class CRM_Contact_Form_Search_Custom_ZipCodeRange extends CRM_Contact_Form_Search_Custom_Base implements CRM_Contact_Form_Search_Interface {
protected $_aclFrom = NULL;
protected $_aclWhere = NULL;
/**
- * @param $formValues
+ * Class constructor.
+ *
+ * @param array $formValues
*/
public function __construct(&$formValues) {
parent::__construct($formValues);
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
interface CRM_Contact_Form_Search_Interface {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
*/
/**
- * This class generates form components for search-result tasks
+ * This class generates form components for search-result tasks.
*/
class CRM_Contact_Form_Task extends CRM_Core_Form {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class provides the functionality to group
- * contacts. This class provides functionality for the actual
+ * This class provides the functionality to group contacts.
+ *
+ * This class provides functionality for the actual
* addition of contacts to groups.
*/
class CRM_Contact_Form_Task_AddToGroup extends CRM_Contact_Form_Task {
/**
* Build all the data structures needed to build the form.
- *
- * @return void
*/
public function preProcess() {
// initialize the task and row fields
/**
* Build the form object.
- *
- *
- * @return void
*/
public function buildQuickForm() {
/**
* Add local and global form rules.
- *
- *
- * @return void
*/
public function addRules() {
$this->addFormRule(array('CRM_Contact_Form_task_AddToGroup', 'formRule'));
/**
* Process the form after the input has been submitted and validated.
- *
- *
- * @return void
*/
public function postProcess() {
$params = $this->controller->exportValues();
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class provides the functionality to add contact(s) to Organization
+ * This class provides the functionality to add contact(s) to Organization.
*/
class CRM_Contact_Form_Task_AddToOrganization extends CRM_Contact_Form_Task_AddToParentClass {
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class provides the functionality to delete a group of
- * contacts. This class provides functionality for the actual
- * addition of contacts to groups.
+ * This class provides the functionality to delete a group of contacts.
+ *
+ * This class provides functionality for the actual addition of contacts to groups.
+ *
+ * Wow is that copy & paste gone wrong or what? What does this class do? Anyone, anyone.
*/
class CRM_Contact_Form_Task_AddToTag extends CRM_Contact_Form_Task {
/**
* 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 the form object.
- *
- *
- * @return void
*/
public function buildQuickForm() {
// add select for preferences
/**
* 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$
- *
*/
/**
- * This class provides the functionality for batch profile update
+ * This class provides the functionality for batch profile update.
*/
class CRM_Contact_Form_Task_Batch extends CRM_Contact_Form_Task {
/**
* Build all the data structures needed to build the form.
- *
- * @return void
*/
public function preProcess() {
// initialize the task and row fields
/**
* Build the form object.
- *
- *
- * @return void
*/
public function buildQuickForm() {
$ufGroupId = $this->get('ufGroupId');
/**
* Process the form after the input has been submitted and validated.
- *
- *
- * @return void
*/
public function postProcess() {
$params = $this->exportValues();
/**
* Parse street address.
+ *
* @param array $contactValues
* Contact values.
* @param CRM_Core_Form $form
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
*/
/**
- * This class provides the functionality to delete a group of
- * contacts. This class provides functionality for the actual
- * deletion.
+ * This class provides the functionality to delete a group of contacts.
+ *
+ * This class provides functionality for the actual deletion.
*/
class CRM_Contact_Form_Task_Delete extends CRM_Contact_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() {
$label = $this->_restore ? ts('Restore Contact(s)') : ts('Delete Contact(s)');
/**
* Process the form after the input has been submitted and validated.
- *
- *
- * @return void
*/
public function postProcess() {
$session = CRM_Core_Session::singleton();
projects / civicrm-core.git / commitdiff