INFRA-132 - Comment grammar cleanup

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

diff --git a/CRM/Core/BAO/Website.php b/CRM/Core/BAO/Website.php
index bb8e1587d335aa0f195f40cc7c3244fb23f76070..ff08619fd1167c1996e17673ffdb7afd79b01d6d 100644 (file)
--- a/CRM/Core/BAO/Website.php
+++ b/CRM/Core/BAO/Website.php
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -39,15 +39,15 @@
 class CRM_Core_BAO_Website extends CRM_Core_DAO_Website {
 
   /**
-   * takes an associative array and adds im
+   * Takes an associative array and adds im
    *
-   * @param array  $params         (reference ) an assoc array of name/value pairs
+   * @param array $params
+   *   (reference ) an assoc array of name/value pairs.
    *
    * @return object       CRM_Core_BAO_Website object on success, null otherwise
-   * @access public
    * @static
    */
-  static function add(&$params) {
+  public static function add(&$params) {
     $hook = empty($params['id']) ? 'create' : 'edit';
     CRM_Utils_Hook::pre($hook, 'Website', CRM_Utils_Array::value('id', $params), $params);
 
@@ -60,18 +60,19 @@ class CRM_Core_BAO_Website extends CRM_Core_DAO_Website {
   }
 
   /**
-   * process website
+   * Process website
    *
-   * @param array $params associated array
-   * @param int $contactID contact id
+   * @param array $params
+   *   Associated array.
+   * @param int $contactID
+   *   Contact id.
    *
    * @param $skipDelete
    *
    * @return void
-   * @access public
    * @static
    */
-  static function create(&$params, $contactID, $skipDelete) {
+  public static function create(&$params, $contactID, $skipDelete) {
     if (empty($params)) {
       return FALSE;
     }
@@ -113,12 +114,13 @@ class CRM_Core_BAO_Website extends CRM_Core_DAO_Website {
   /**
    * Delete website
    *
-   * @param array $ids website ids
+   * @param array $ids
+   *   Website ids.
    *
    * @return void
    * @static
    */
-  static function del($ids) {
+  public static function del($ids) {
     $query = 'DELETE FROM civicrm_website WHERE id IN ( ' . implode(',', $ids) . ')';
     CRM_Core_DAO::executeQuery($query);
     // FIXME: we should return false if the del was unsuccessful
@@ -129,13 +131,13 @@ class CRM_Core_BAO_Website extends CRM_Core_DAO_Website {
    * Given the list of params in the params array, fetch the object
    * and store the values in the values array
    *
-   * @param array entityBlock input parameters to find object
+   * @param array $params
+   * @param $values
    *
    * @return boolean
-   * @access public
    * @static
    */
-  static function &getValues(&$params, &$values) {
+  public static function &getValues(&$params, &$values) {
     $websites            = array();
     $website             = new CRM_Core_DAO_Website();
     $website->contact_id = $params['contact_id'];
@@ -156,13 +158,15 @@ class CRM_Core_BAO_Website extends CRM_Core_DAO_Website {
   /**
    * Get all the websites for a specified contact_id
    *
-   * @param int $id the contact id
+   * @param int $id
+   *   The contact id.
+   *
+   * @param bool $updateBlankLocInfo
    *
    * @return array  the array of website details
-   * @access public
    * @static
    */
-  static function allWebsites($id, $updateBlankLocInfo = FALSE) {
+  public static function allWebsites($id, $updateBlankLocInfo = FALSE) {
     if (!$id) {
       return NULL;
     }
@@ -192,4 +196,3 @@ SELECT  id, website_type_id
     return $websites;
   }
 }
-