INFRA-132 - Comment grammar cleanup

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

diff --git a/CRM/Core/BAO/SchemaHandler.php b/CRM/Core/BAO/SchemaHandler.php
index 109a6591ccc9abe3aeaddb92d28470b3c8a99ce6..4fa3c4dc1d6df8cb4016c1bf90624836757e090f 100644 (file)
--- a/CRM/Core/BAO/SchemaHandler.php
+++ b/CRM/Core/BAO/SchemaHandler.php
@@ -51,7 +51,7 @@
  *                                             'class'         => FIELD_CLASS_TYPE,
  *                                             'primary'       => BOOLEAN,
  *                                             'required'      => BOOLEAN,
- *                                             'searchable'    => true,
+ *                                             'searchable'    => TRUE,
  *                                             'fk_table_name' => FOREIGN_KEY_TABLE_NAME,
  *                                             'fk_field_name' => FOREIGN_KEY_FIELD_NAME,
  *                                             'comment'       => COMMENT,
@@ -66,7 +66,7 @@ class CRM_Core_BAO_SchemaHandler {
    *
    * @param array $params
    *
-   * @return true if successfully created, false otherwise
+   * @return TRUE if successfully created, FALSE otherwise
    *
    * @static
    */
@@ -80,7 +80,7 @@ class CRM_Core_BAO_SchemaHandler {
     if ($config->logging) {
       // logging support
       $logging = new CRM_Logging_Schema;
-      $logging->fixSchemaDifferencesFor($params['name'], null, FALSE);
+      $logging->fixSchemaDifferencesFor($params['name'], NULL, FALSE);
     }
 
     // always do a trigger rebuild for this table
@@ -164,7 +164,7 @@ class CRM_Core_BAO_SchemaHandler {
    * @param $separator
    * @param $prefix
    *
-   * @return null|string
+   * @return NULL|string
    */
   public static function buildPrimaryKeySQL(&$params, $separator, $prefix) {
     $sql = NULL;
@@ -183,7 +183,7 @@ class CRM_Core_BAO_SchemaHandler {
    * @param $prefix
    * @param bool $indexExist
    *
-   * @return null|string
+   * @return NULL|string
    */
   public static function buildSearchIndexSQL(&$params, $separator, $prefix, $indexExist = FALSE) {
     $sql = NULL;
@@ -277,7 +277,7 @@ ALTER TABLE {$tableName}
    * @param $prefix
    * @param string $tableName
    *
-   * @return null|string
+   * @return NULL|string
    */
   public static function buildForeignKeySQL(&$params, $separator, $prefix, $tableName) {
     $sql = NULL;
@@ -353,7 +353,7 @@ ALTER TABLE {$tableName}
       }
     }
 
-    if($triggerRebuild) {
+    if ($triggerRebuild) {
       CRM_Core_DAO::triggerRebuild($params['table_name']);
     }
 
@@ -363,9 +363,11 @@ ALTER TABLE {$tableName}
   /**
    * Delete a civiCRM-table
    *
-   * @param  String  $tableName   name of the table to be created.
+   * @param string $tableName
+   *   Name of the table to be created.
    *
-   * @return true if successfully deleted, false otherwise
+   * @return bool
+   *   TRUE if successfully deleted, FALSE otherwise.
    *
    * @static
    */
@@ -515,7 +517,7 @@ MODIFY      {$columnName} varchar( $length )
           array(
             1 => $tableName,
             2 => $columnName,
-            3 => $customFieldID
+            3 => $customFieldID,
           )
         ));
     }