INFRA-132 - Comment grammar cleanup

[civicrm-core.git] / CRM / Core / BAO / Domain.php

diff --git a/CRM/Core/BAO/Domain.php b/CRM/Core/BAO/Domain.php
index a987897673579d61b6ebc29f6731affc75e00750..ad04e30ce3dc74a5b74b654c405e08502566786c 100644 (file)
--- a/CRM/Core/BAO/Domain.php
+++ b/CRM/Core/BAO/Domain.php
@@ -51,14 +51,15 @@ class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain {
   /**
    * 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
+   * @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_Core_DAO_Domain object
-   * @access public
    * @static
    */
-  static function retrieve(&$params, &$defaults) {
+  public static function retrieve(&$params, &$defaults) {
     return CRM_Core_DAO::commonRetrieve('CRM_Core_DAO_Domain', $params, $defaults);
   }
 
@@ -68,10 +69,9 @@ class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain {
    * @param null $reset
    *
    * @return null|object CRM_Core_BAO_Domain
-   * @access public
    * @static
    */
-  static function &getDomain($reset = null) {
+  public static function &getDomain($reset = NULL) {
     static $domain = NULL;
     if (!$domain || $reset) {
       $domain = new CRM_Core_BAO_Domain();
@@ -83,20 +83,21 @@ class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain {
     return $domain;
   }
 
- /**
-  * Change active domain (ie. to perform a temporary action) such as changing
-  * config for all domains
-  *
-  * Switching around the global domain variable is very risky business. This
-  * is ONLY used as a hack to allow CRM_Core_BAO_Setting::setItems to manipulate
-  * the civicrm_domain.config_backend in multiple domains. When/if config_backend
-  * goes away, this hack should be removed.
-  *
-  * @param integer $domainID id for domain you want to set as current
-  * @deprecated
-  * @see http://issues.civicrm.org/jira/browse/CRM-11204
-  */
-  static function setDomain($domainID) {
+  /**
+   * Change active domain (ie. to perform a temporary action) such as changing
+   * config for all domains
+   *
+   * Switching around the global domain variable is very risky business. This
+   * is ONLY used as a hack to allow CRM_Core_BAO_Setting::setItems to manipulate
+   * the civicrm_domain.config_backend in multiple domains. When/if config_backend
+   * goes away, this hack should be removed.
+   *
+   * @param int $domainID
+   *   Id for domain you want to set as current.
+   * @deprecated
+   * @see http://issues.civicrm.org/jira/browse/CRM-11204
+   */
+  public static function setDomain($domainID) {
     CRM_Core_Config::domainID($domainID);
     self::getDomain($domainID);
     CRM_Core_Config::singleton(TRUE, TRUE);
@@ -109,9 +110,9 @@ class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain {
    * @deprecated
    * @see CRM_Core_BAO_Domain::setDomain
    */
-  static function resetDomain() {
-    CRM_Core_Config::domainID(null, true);
-    self::getDomain(null, true);
+  public static function resetDomain() {
+    CRM_Core_Config::domainID(NULL, TRUE);
+    self::getDomain(NULL, TRUE);
     CRM_Core_Config::singleton(TRUE, TRUE);
   }
 
@@ -120,7 +121,7 @@ class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain {
    *
    * @return null|string
    */
-  static function version($skipUsingCache = false) {
+  public static function version($skipUsingCache = FALSE) {
     return CRM_Core_DAO::getFieldValue('CRM_Core_DAO_Domain',
       CRM_Core_Config::domainID(),
       'version',
@@ -135,13 +136,12 @@ class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain {
    * @param NULL
    *
    * @return array        Location::getValues
-   * @access public
    */
-  function &getLocationValues() {
+  public function &getLocationValues() {
     if ($this->_location == NULL) {
-      $domain = self::getDomain(null);
+      $domain = self::getDomain(NULL);
       $params = array(
-        'contact_id' => $domain->contact_id
+        'contact_id' => $domain->contact_id,
       );
       $this->_location = CRM_Core_BAO_Location::getValues($params, TRUE);
 
@@ -159,9 +159,8 @@ class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain {
    * @param int $id
    *
    * @return array domain
-   * @access public
    */
-  static function edit(&$params, &$id) {
+  public static function edit(&$params, &$id) {
     $domain = new CRM_Core_DAO_Domain();
     $domain->id = $id;
     $domain->copyValues($params);
@@ -175,9 +174,8 @@ class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain {
    * @param array $params
    *
    * @return array domain
-   * @access public
    */
-  static function create($params) {
+  public static function create($params) {
     $domain = new CRM_Core_DAO_Domain();
     $domain->copyValues($params);
     $domain->save();
@@ -187,7 +185,7 @@ class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain {
   /**
    * @return bool
    */
-  static function multipleDomains() {
+  public static function multipleDomains() {
     $session = CRM_Core_Session::singleton();
 
     $numberDomains = $session->get('numberDomains');
@@ -205,7 +203,7 @@ class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain {
    * @return array name & email for domain
    * @throws Exception
    */
-  static function getNameAndEmail($skipFatal = FALSE) {
+  public static function getNameAndEmail($skipFatal = FALSE) {
     $fromEmailAddress = CRM_Core_OptionGroup::values('from_email_address', NULL, NULL, NULL, ' AND is_default = 1');
     if (!empty($fromEmailAddress)) {
       foreach ($fromEmailAddress as $key => $value) {
@@ -233,7 +231,7 @@ class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain {
    *
    * @return bool|null|object|string
    */
-  static function addContactToDomainGroup($contactID) {
+  public static function addContactToDomainGroup($contactID) {
     $groupID = self::getGroupId();
 
     if ($groupID) {
@@ -248,7 +246,7 @@ class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain {
   /**
    * @return bool|null|object|string
    */
-  static function getGroupId() {
+  public static function getGroupId() {
     static $groupID = NULL;
 
     if ($groupID) {
@@ -271,7 +269,7 @@ class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain {
         CRM_Core_Config::domainID(), 'name'
       );
       $groupID = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Group',
-        $title, 'id', 'title', true
+        $title, 'id', 'title', TRUE
       );
       if (empty($groupID) && !empty($title)) {
         $groupParams = array(
@@ -291,7 +289,7 @@ class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain {
    *
    * @return bool
    */
-  static function isDomainGroup($groupId) {
+  public static function isDomainGroup($groupId) {
     $domainGroupID = self::getGroupId();
     return $domainGroupID == $groupId ? TRUE : FALSE;
   }
@@ -299,7 +297,7 @@ class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain {
   /**
    * @return array
    */
-  static function getChildGroupIds() {
+  public static function getChildGroupIds() {
     $domainGroupID = self::getGroupId();
     $childGrps = array();
 
@@ -315,7 +313,7 @@ class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain {
    *
    * @return array
    */
-  static function getContactList() {
+  public static function getContactList() {
     $siteGroups = CRM_Core_BAO_Domain::getChildGroupIds();
     $siteContacts = array();
 
@@ -334,4 +332,3 @@ class CRM_Core_BAO_Domain extends CRM_Core_DAO_Domain {
     return $siteContacts;
   }
 }
-