CRM/Contact/Form/Edit/Household.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * Auxilary class to provide support to the Contact Form class. Does this by implementing
  38  * a small set of static methods
  39  *
  40  */
  41 class CRM_Contact_Form_Edit_Household {
  42
  43   /**
  44    * This function provides the HTML form elements that are specific
  45    * to the Household Contact Type
  46    *
  47    * @param CRM_Core_Form $form
  48    *   Form object.
  49    * @param int $inlineEditMode
  50    *   ( 1 for contact summary.
  51    * top bar form and 2 for display name edit )
  52    *
  53    * @return void
  54    */
  55   public static function buildQuickForm(&$form, $inlineEditMode = NULL) {
  56     $attributes = CRM_Core_DAO::getAttribute('CRM_Contact_DAO_Contact');
  57
  58     $form->applyFilter('__ALL__', 'trim');
  59
  60     if (!$inlineEditMode || $inlineEditMode == 1) {
  61       // household_name
  62       $form->add('text', 'household_name', ts('Household Name'), $attributes['household_name']);
  63     }
  64
  65     if (!$inlineEditMode || $inlineEditMode == 2) {
  66       // nick_name
  67       $form->addElement('text', 'nick_name', ts('Nickname'), $attributes['nick_name']);
  68       $form->addElement('text', 'contact_source', ts('Source'), CRM_Utils_Array::value('source', $attributes));
  69     }
  70
  71     if (!$inlineEditMode) {
  72       $form->add('text', 'external_identifier', ts('External ID'), $attributes['external_identifier'], FALSE);
  73       $form->addRule('external_identifier',
  74         ts('External ID already exists in Database.'),
  75         'objectExists',
  76         array('CRM_Contact_DAO_Contact', $form->_contactId, 'external_identifier')
  77       );
  78     }
  79   }
  80
  81   /**
  82    * Add rule for household
  83    *
  84    * @param array $fields
  85    *   Array of form values.
  86    * @param array $files
  87    *   Unused.
  88    * @param int $contactID
  89    *
  90    * @return array|bool $error@static
  91    */
  92   public static function formRule($fields, $files, $contactID = NULL) {
  93     $errors = array();
  94     $primaryID = CRM_Contact_Form_Contact::formRule($fields, $errors, $contactID);
  95
  96     // make sure that household name is set
  97     if (empty($fields['household_name'])) {
  98       $errors['household_name'] = 'Household Name should be set.';
  99     }
 100
 101     //check for duplicate - dedupe rules
 102     CRM_Contact_Form_Contact::checkDuplicateContacts($fields, $errors, $contactID, 'Household');
 103
 104     return empty($errors) ? TRUE : $errors;
 105   }
 106 }