INFRA-132 - Comment grammar cleanup
[civicrm-core.git] / CRM / Core / BAO / SchemaHandler.php
index 1da5fcdb32e4e06b984e101ae6e0061f46373cf3..4fa3c4dc1d6df8cb4016c1bf90624836757e090f 100644 (file)
@@ -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;
@@ -363,10 +363,11 @@ ALTER TABLE {$tableName}
   /**
    * Delete a civiCRM-table
    *
-   * @param String $tableName
+   * @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
    */