CRM-15849: fix translation string, comments

[civicrm-core.git] / CRM / Contact / BAO / GroupOrganization.php

diff --git a/CRM/Contact/BAO/GroupOrganization.php b/CRM/Contact/BAO/GroupOrganization.php
index 160fa60ca21caf958b18f1d70bba8b303984e9fd..848157d02629694dc1f381f0fe2fd4a4a3e19187 100644 (file)
--- a/CRM/Contact/BAO/GroupOrganization.php
+++ b/CRM/Contact/BAO/GroupOrganization.php
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -23,7 +23,7 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  *
@@ -37,20 +37,19 @@ class CRM_Contact_BAO_GroupOrganization extends CRM_Contact_DAO_GroupOrganizatio
   /**
    * Class constructor
    */
-  function __construct() {
+  public function __construct() {
     parent::__construct();
   }
 
   /**
    * Takes an associative array and creates a groupOrganization object
    *
-   * @param array  $params         (reference ) an assoc array of name/value pairs
+   * @param array $params
+   *   (reference ) an assoc array of name/value pairs.
    *
    * @return CRM_Contact_DAO_GroupOrganization
-   * @access public
-   * @static
    */
-  static function add(&$params) {
+  public static function add(&$params) {
     $formattedValues = array();
     self::formatValues($params, $formattedValues);
     $dataExists = self::dataExists($formattedValues);
@@ -69,14 +68,14 @@ class CRM_Contact_BAO_GroupOrganization extends CRM_Contact_DAO_GroupOrganizatio
   /**
    * Format the params
    *
-   * @param array  $params         (reference ) an assoc array of name/value pairs
-   * @param array  $formatedValues (reference ) an assoc array of name/value pairs
+   * @param array $params
+   *   (reference ) an assoc array of name/value pairs.
+   * @param array $formatedValues
+   *   (reference ) an assoc array of name/value pairs.
    *
    * @return void
-   * @access public
-   * @static
    */
-  static function formatValues(&$params, &$formatedValues) {
+  public static function formatValues(&$params, &$formatedValues) {
     if (!empty($params['group_organization'])) {
       $formatedValues['id'] = $params['group_organization'];
     }
@@ -93,13 +92,12 @@ class CRM_Contact_BAO_GroupOrganization extends CRM_Contact_DAO_GroupOrganizatio
   /**
    * Check if there is data to create the object
    *
-   * @param array  $params  (reference ) an assoc array of name/value pairs
+   * @param array $params
+   *   (reference ) an assoc array of name/value pairs.
    *
-   * @return boolean
-   * @access public
-   * @static
+   * @return bool
    */
-  static function dataExists($params) {
+  public static function dataExists($params) {
     // return if no data present
     if (!empty($params['organization_id']) && !empty($params['group_id'])) {
       return TRUE;
@@ -111,7 +109,7 @@ class CRM_Contact_BAO_GroupOrganization extends CRM_Contact_DAO_GroupOrganizatio
    * @param int $groupID
    * @param $defaults
    */
-  static function retrieve($groupID, &$defaults) {
+  public static function retrieve($groupID, &$defaults) {
     $dao = new CRM_Contact_DAO_GroupOrganization();
     $dao->group_id = $groupID;
     if ($dao->find(TRUE)) {
@@ -125,11 +123,9 @@ class CRM_Contact_BAO_GroupOrganization extends CRM_Contact_DAO_GroupOrganizatio
    *
    * @param int $contactID
    *
-   * @return boolean
-   * @access public
-   * @static
+   * @return bool
    */
-  static function hasGroupAssociated($contactID) {
+  public static function hasGroupAssociated($contactID) {
     $orgID = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_GroupOrganization',
       $contactID, 'group_id', 'organization_id'
     );
@@ -142,11 +138,13 @@ class CRM_Contact_BAO_GroupOrganization extends CRM_Contact_DAO_GroupOrganizatio
   /**
    * Delete Group Organization
    *
-   * @param int $groupOrganizationID group organization id that needs to be deleted
+   * @param int $groupOrganizationID
+   *   Group organization id that needs to be deleted.
    *
-   * @return mixed|null $results   no of deleted group organization on success, false otherwise@access public
+   * @return int|null
+   *   no of deleted group organization on success, false otherwise
    */
-  static function deleteGroupOrganization($groupOrganizationID) {
+  public static function deleteGroupOrganization($groupOrganizationID) {
     $results = NULL;
     $groupOrganization = new CRM_Contact_DAO_GroupOrganization();
     $groupOrganization->id = $groupOrganizationID;
@@ -155,5 +153,5 @@ class CRM_Contact_BAO_GroupOrganization extends CRM_Contact_DAO_GroupOrganizatio
 
     return $results;
   }
-}
 
+}