CRM/Contact/Form/Edit/Household.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   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 form object
  48    * @param int $inlineEditMode ( 1 for contact summary
  49    * top bar form and 2 for display name edit )
  50    *
  51    * @access public
  52    * @return void
  53    */
  54   public static function buildQuickForm(&$form, $inlineEditMode = NULL) {
  55     $attributes = CRM_Core_DAO::getAttribute('CRM_Contact_DAO_Contact');
  56
  57     $form->applyFilter('__ALL__', 'trim');
  58
  59     if ( !$inlineEditMode || $inlineEditMode == 1 ) {
  60       // household_name
  61       $form->add('text', 'household_name', ts('Household Name'), $attributes['household_name']);
  62     }
  63
  64     if ( !$inlineEditMode || $inlineEditMode == 2 ) {
  65       // nick_name
  66       $form->addElement('text', 'nick_name', ts('Nickname'), $attributes['nick_name']);
  67       $form->addElement('text', 'contact_source', ts('Source'), CRM_Utils_Array::value('source', $attributes));
  68     }
  69
  70     if ( !$inlineEditMode ) {
  71       $form->add('text', 'external_identifier', ts('External ID'), $attributes['external_identifier'], FALSE);
  72       $form->addRule('external_identifier',
  73         ts('External ID already exists in Database.'),
  74         'objectExists',
  75         array('CRM_Contact_DAO_Contact', $form->_contactId, 'external_identifier')
  76       );
  77     }
  78   }
  79
  80   /**
  81    * Add rule for household
  82    *
  83    * @param array $fields array of form values
  84    * @param array $files - unused
  85    * @param int $contactID
  86    *
  87    * @return array|bool $error@static
  88    * @public
  89    */
  90   static function formRule($fields, $files, $contactID = NULL) {
  91     $errors = array();
  92     $primaryID = CRM_Contact_Form_Contact::formRule($fields, $errors, $contactID);
  93
  94     // make sure that household name is set
  95     if (empty($fields['household_name'])) {
  96       $errors['household_name'] = 'Household Name should be set.';
  97     }
  98
  99     //check for duplicate - dedupe rules
 100     CRM_Contact_Form_Contact::checkDuplicateContacts($fields, $errors, $contactID, 'Household');
 101
 102     return empty($errors) ? TRUE : $errors;
 103   }
 104 }
 105