<?php
/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.5 |
+ | CiviCRM version 4.6 |
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC (c) 2004-2014 |
+--------------------------------------------------------------------+
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
-*/
+ */
/**
*
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2014
* $Id$
- *
*/
/**
* This class generates form components for search-result tasks
- *
*/
class CRM_Contact_Form_Task extends CRM_Core_Form {
/**
- * the task being performed
+ * The task being performed
*
* @var int
*/
static protected $_searchFormValues;
/**
- * build all the data structures needed to build the form
- *
- * @param
- *
- * @return void
- * @access public
+ * Build all the data structures needed to build the form.
*/
- function preProcess() {
+ public function preProcess() {
self::preProcessCommon($this);
}
/**
- * @param $form
+ * Common pre-processing function.
+ *
+ * @param CRM_Core_Form $form
* @param bool $useTable
*/
- static function preProcessCommon(&$form, $useTable = FALSE) {
+ public static function preProcessCommon(&$form, $useTable = FALSE) {
$form->_contactIds = array();
$form->_contactTypes = array();
}
}
-
if (CRM_Utils_Array::value('radio_ts', self::$_searchFormValues) == 'ts_sel'
&& ($form->_action != CRM_Core_Action::COPY)
) {
}
/**
- * Function to get the contact id for custom search
- * we are not using prev/next table incase of custom search
+ * Get the contact id for custom search.
+ *
+ * we are not using prev/next table in case of custom search
*/
public function getContactIds() {
// need to perform action on all contacts
}
$selectorName = $this->controller->selectorName();
- require_once(str_replace('_', DIRECTORY_SEPARATOR, $selectorName) . '.php');
+ require_once str_replace('_', DIRECTORY_SEPARATOR, $selectorName) . '.php';
$fv = $this->get('formValues');
$customClass = $this->get('customSearchClass');
/**
- * This function sets the default values for the form. Relationship that in edit/view action
- * the default values are retrieved from the database
+ * Set default values for the form. Relationship that in edit/view action.
*
- * @access public
+ * The default values are retrieved from the database.
*
* @return array
*/
- function setDefaultValues() {
+ public function setDefaultValues() {
$defaults = array();
return $defaults;
}
/**
- * This function is used to add the rules for form.
- *
- * @return void
- * @access public
+ * Add the rules for form.
*/
- function addRules() {
+ public function addRules() {
}
/**
- * Function to actually build the form
- *
- * @return void
- * @access public
+ * Build the form object.
*/
public function buildQuickForm() {
$this->addDefaultButtons(ts('Confirm Action'));
}
/**
- * process the form after the input has been submitted and validated
- *
- * @access public
- *
- * @return void
+ * Process the form after the input has been submitted and validated.
*/
public function postProcess() {
}
- //end of function
-
/**
- * simple shell that derived classes can call to add buttons to
- * the form with a customized title for the main Submit
+ * Simple shell that derived classes can call to add form buttons.
+ *
+ * Allows customized title for the main Submit
*
- * @param string $title title of the main button
+ * @param string $title
+ * Title of the main button.
* @param string $nextType
+ * Button type for the form after processing.
* @param string $backType
* @param bool $submitOnce
- *
- * @internal param string $type button type for the form after processing
- *
- * @return void
- * @access public
*/
- function addDefaultButtons($title, $nextType = 'next', $backType = 'back', $submitOnce = FALSE) {
+ public function addDefaultButtons($title, $nextType = 'next', $backType = 'back', $submitOnce = FALSE) {
$this->addButtons(array(
array(
'type' => $nextType,
}
/**
- * replace ids of household members in $this->_contactIds with the id of their household.
- * CRM-8338
- *
- * @access public
+ * Replace ids of household members in $this->_contactIds with the id of their household.
*
- * @return void
+ * CRM-8338
*/
public function mergeContactIdsByHousehold() {
if (empty($this->_contactIds)) {
}
// Find related households.
- $relationSelect = "SELECT contact_household.id as household_id, {$contactA} as refContact ";
+ $relationSelect = "SELECT contact_household.id as household_id, {$contactA} as refContact ";
$relationFrom = " FROM civicrm_contact contact_household
INNER JOIN civicrm_relationship crel ON crel.{$contactB} = contact_household.id AND crel.relationship_type_id = {$id} ";
// Check for active relationship status only.
- $today = date('Ymd');
- $relationActive = " AND (crel.is_active = 1 AND ( crel.end_date is NULL OR crel.end_date >= {$today} ) )";
- $relationWhere = " WHERE contact_household.is_deleted = 0 AND crel.{$contactA} IN ( {$relID} ) {$relationActive}";
- $relationGroupBy = " GROUP BY crel.{$contactA}";
+ $today = date('Ymd');
+ $relationActive = " AND (crel.is_active = 1 AND ( crel.end_date is NULL OR crel.end_date >= {$today} ) )";
+ $relationWhere = " WHERE contact_household.is_deleted = 0 AND crel.{$contactA} IN ( {$relID} ) {$relationActive}";
+ $relationGroupBy = " GROUP BY crel.{$contactA}";
$relationQueryString = "$relationSelect $relationFrom $relationWhere $relationGroupBy";
$householdsDAO = CRM_Core_DAO::executeQuery($relationQueryString);
$householdsDAO->free();
}
}
-}
+}