INFRA-132 - CRM/Contact - Convert single-line @param to multi-line
[civicrm-core.git] / CRM / Contact / BAO / 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 class CRM_Contact_BAO_Household extends CRM_Contact_DAO_Contact {
36
37 /**
38 * This is a contructor of the class.
39 */
40 public function __construct() {
41 parent::__construct();
42 }
43
44 /**
45 * Update the household with primary contact id
46 *
47 * @param int $primaryContactId
48 * Null if deleting primary contact.
49 * @param int $contactId
50 * Contact id.
51 *
52 * @return Object DAO object on success
53 * @static
54 */
55 public static function updatePrimaryContact($primaryContactId, $contactId) {
56 $queryString = "UPDATE civicrm_contact
57 SET primary_contact_id = ";
58
59 $params = array();
60 if ($primaryContactId) {
61 $queryString .= '%1';
62 $params[1] = array($primaryContactId, 'Integer');
63 }
64 else {
65 $queryString .= "null";
66 }
67
68 $queryString .= " WHERE id = %2";
69 $params[2] = array($contactId, 'Integer');
70
71 return CRM_Core_DAO::executeQuery($queryString, $params);
72 }
73 }