<?php
/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.5 |
+ | CiviCRM version 4.6 |
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC (c) 2004-2014 |
+--------------------------------------------------------------------+
class CRM_Pledge_Form_Search extends CRM_Core_Form_Search {
/**
- * the params that are sent to the query
+ * The params that are sent to the query
*
* @var array
- * @access protected
*/
protected $_queryParams;
/**
- * are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact
*
- * @access protected
* @var boolean
*/
protected $_single = FALSE;
/**
- * are we restricting ourselves to a single contact
+ * Are we restricting ourselves to a single contact
*
- * @access protected
* @var boolean
*/
protected $_limit = NULL;
/**
- * prefix for the controller
- *
+ * Prefix for the controller
*/
protected $_prefix = "pledge_";
protected $_defaults;
/**
- * processing needed for buildForm and later
+ * Processing needed for buildForm and later
*
* @return void
- * @access public
*/
- function preProcess() {
+ public function preProcess() {
/**
* set the button names
* we allow the controller to set force/reset externally, useful when we are being
* driven by the wizard framework
*/
- $this->_reset = CRM_Utils_Request::retrieve('reset', 'Boolean', CRM_Core_DAO::$_nullObject);
- $this->_force = CRM_Utils_Request::retrieve('force', 'Boolean', $this, FALSE);
- $this->_limit = CRM_Utils_Request::retrieve('limit', 'Positive', $this);
+ $this->_reset = CRM_Utils_Request::retrieve('reset', 'Boolean', CRM_Core_DAO::$_nullObject);
+ $this->_force = CRM_Utils_Request::retrieve('force', 'Boolean', $this, FALSE);
+ $this->_limit = CRM_Utils_Request::retrieve('limit', 'Positive', $this);
$this->_context = CRM_Utils_Request::retrieve('context', 'String', $this, FALSE, 'search');
$this->assign("context", $this->_context);
);
}
-
$this->_queryParams = CRM_Contact_BAO_Query::convertFormValues($this->_formValues);
$selector = new CRM_Pledge_Selector_Search($this->_queryParams,
$this->_action,
}
/**
- * Build the form
+ * Build the form object
*
- * @access public
*
* @return void
*/
- function buildQuickForm() {
+ public function buildQuickForm() {
parent::buildQuickForm();
$this->addElement('text', 'sort_name', ts('Pledger Name or Email'), CRM_Core_DAO::getAttribute('CRM_Contact_DAO_Contact', 'sort_name'));
* @param
*
* @return void
- * @access public
*/
- function postProcess() {
+ public function postProcess() {
if ($this->_done) {
return;
}
}
/**
- * This function is used to 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
- * @access public
* @see valid_date
*/
- function addRules() {
+ public function addRules() {
$this->addFormRule(array('CRM_Pledge_Form_Search', 'formRule'));
}
/**
- * global validation rules for the form
+ * Global validation rules for the form
*
- * @param array $fields posted values of the form
- *
- * @internal param array $errors list of errors to be posted back to the form
+ * @param array $fields
+ * Posted values of the form.
*
* @return void
- * @static
- * @access public
*/
- static function formRule($fields) {
+ public static function formRule($fields) {
$errors = array();
if (!empty($errors)) {
/**
* Set the default form values
*
- * @access protected
*
- * @return array the default array reference
+ * @return array
+ * the default array reference
*/
- function setDefaultValues() {
+ public function setDefaultValues() {
$defaults = array();
$defaults = $this->_formValues;
return $defaults;
}
- function fixFormValues() {
+ public function fixFormValues() {
if (!$this->_force) {
return;
}
/**
* @return null
*/
- function getFormValues() {
+ public function getFormValues() {
return NULL;
}
* Return a descriptive name for the page, used in wizard header
*
* @return string
- * @access public
*/
public function getTitle() {
return ts('Find Pledges');
}
}
-