CRM-15849: fix translation string, comments
[civicrm-core.git] / CRM / Contact / BAO / GroupOrganization.php
index e46a56e14b716084b3813375d840351e6f30fd48..848157d02629694dc1f381f0fe2fd4a4a3e19187 100644 (file)
@@ -23,7 +23,7 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  *
@@ -44,11 +44,10 @@ class CRM_Contact_BAO_GroupOrganization extends CRM_Contact_DAO_GroupOrganizatio
   /**
    * 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
    */
   public static function add(&$params) {
     $formattedValues = array();
@@ -69,12 +68,12 @@ 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
    */
   public static function formatValues(&$params, &$formatedValues) {
     if (!empty($params['group_organization'])) {
@@ -93,11 +92,10 @@ 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
    */
   public static function dataExists($params) {
     // return if no data present
@@ -125,9 +123,7 @@ class CRM_Contact_BAO_GroupOrganization extends CRM_Contact_DAO_GroupOrganizatio
    *
    * @param int $contactID
    *
-   * @return boolean
-   * @access public
-   * @static
+   * @return bool
    */
   public static function hasGroupAssociated($contactID) {
     $orgID = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_GroupOrganization',
@@ -142,9 +138,11 @@ 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
    */
   public static function deleteGroupOrganization($groupOrganizationID) {
     $results = NULL;
@@ -155,5 +153,5 @@ class CRM_Contact_BAO_GroupOrganization extends CRM_Contact_DAO_GroupOrganizatio
 
     return $results;
   }
-}
 
+}