Merge pull request #6458 from totten/4.6-toxic-list
[civicrm-core.git] / CRM / Contact / BAO / RelationshipType.php
index cdcf3717a7fbd500f9c2c4e5895ad433e11cf9d4..131e47e3e75a370c3d098818fafcc41b2a4b20d8 100644 (file)
@@ -3,7 +3,7 @@
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
  | 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
+ * @copyright CiviCRM LLC (c) 2004-2015
  * $Id$
  *
  */
 class CRM_Contact_BAO_RelationshipType extends CRM_Contact_DAO_RelationshipType {
 
   /**
-   * Class constructor
+   * Class constructor.
    */
   public function __construct() {
     parent::__construct();
   }
 
   /**
-   * Fetch object based on array of properties
+   * Fetch object based on array of properties.
    *
    * @param array $params
    *   (reference ) an assoc array of name/value pairs.
    * @param array $defaults
    *   (reference ) an assoc array to hold the flattened values.
    *
-   * @return CRM_Contact_BAO_RelationshipType object
-   * @static
+   * @return CRM_Contact_BAO_RelationshipType
    */
   public static function retrieve(&$params, &$defaults) {
     $relationshipType = new CRM_Contact_DAO_RelationshipType();
@@ -64,7 +63,7 @@ class CRM_Contact_BAO_RelationshipType extends CRM_Contact_DAO_RelationshipType
   }
 
   /**
-   * Update the is_active flag in the db
+   * Update the is_active flag in the db.
    *
    * @param int $id
    *   Id of the database record.
@@ -73,14 +72,13 @@ class CRM_Contact_BAO_RelationshipType extends CRM_Contact_DAO_RelationshipType
    *
    * @return Object
    *   DAO object on sucess, null otherwise
-   * @static
    */
   public static function setIsActive($id, $is_active) {
     return CRM_Core_DAO::setFieldValue('CRM_Contact_DAO_RelationshipType', $id, 'is_active', $is_active);
   }
 
   /**
-   * Add the relationship type in the db
+   * Add the relationship type in the db.
    *
    * @param array $params
    *   (reference ) an assoc array of name/value pairs.
@@ -88,7 +86,6 @@ class CRM_Contact_BAO_RelationshipType extends CRM_Contact_DAO_RelationshipType
    *   The array that holds all the db ids.
    *
    * @return CRM_Contact_DAO_RelationshipType
-   * @static
    */
   public static function add(&$params, &$ids) {
     //to change name, CRM-3336
@@ -135,13 +132,12 @@ class CRM_Contact_BAO_RelationshipType extends CRM_Contact_DAO_RelationshipType
   }
 
   /**
-   * Delete Relationship Types
+   * Delete Relationship Types.
    *
    * @param int $relationshipTypeId
    *
    * @throws CRM_Core_Exception
    * @return mixed
-   * @static
    */
   public static function del($relationshipTypeId) {
     // make sure relationshipTypeId is an integer
@@ -151,7 +147,6 @@ class CRM_Contact_BAO_RelationshipType extends CRM_Contact_DAO_RelationshipType
       throw new CRM_Core_Exception(ts('Invalid relationship type'));
     }
 
-
     //check dependencies
 
     // delete all relationships
@@ -165,7 +160,12 @@ UPDATE civicrm_membership_type
   SET  relationship_type_id = NULL
  WHERE relationship_type_id = %1
 ";
-    $params = array(1 => array(CRM_Core_DAO::VALUE_SEPARATOR . $relationshipTypeId . CRM_Core_DAO::VALUE_SEPARATOR, 'String'));
+    $params = array(
+      1 => array(
+        CRM_Core_DAO::VALUE_SEPARATOR . $relationshipTypeId . CRM_Core_DAO::VALUE_SEPARATOR,
+        'String',
+      ),
+    );
     CRM_Core_DAO::executeQuery($query, $params);
 
     //fixed for CRM-3323
@@ -180,4 +180,5 @@ UPDATE civicrm_membership_type
     $relationshipType->id = $relationshipTypeId;
     return $relationshipType->delete();
   }
+
 }