WordPress 4.3
[autoinstalls/wordpress.git] / wp-admin / install-helper.php
index c654a92b061dfa1170217931b78d5daa89a10278..1a3ced5e51ebf2125754e5e2d66aad76224926fe 100644 (file)
  * needing to use these functions a lot, you might experience time outs. If you
  * do, then it is advised to just write the SQL code yourself.
  *
- * <code>
- * check_column('wp_links', 'link_description', 'mediumtext');
- * if (check_column($wpdb->comments, 'comment_author', 'tinytext'))
- *     echo "ok\n";
- *
- * $error_count = 0;
- * $tablename = $wpdb->links;
- * // check the column
- * if (!check_column($wpdb->links, 'link_description', 'varchar(255)')) {
- *     $ddl = "ALTER TABLE $wpdb->links MODIFY COLUMN link_description varchar(255) NOT NULL DEFAULT '' ";
- *     $q = $wpdb->query($ddl);
- * }
- *
- * if (check_column($wpdb->links, 'link_description', 'varchar(255)')) {
- *     $res .= $tablename . ' - ok <br />';
- * } else {
- *     $res .= 'There was a problem with ' . $tablename . '<br />';
- *     ++$error_count;
- * }
- * </code>
+ *     check_column( 'wp_links', 'link_description', 'mediumtext' );
+ *     if ( check_column( $wpdb->comments, 'comment_author', 'tinytext' ) ) {
+ *         echo "ok\n";
+ *     }
+ *
+ *     $error_count = 0;
+ *     $tablename = $wpdb->links;
+ *     // Check the column.
+ *     if ( ! check_column($wpdb->links, 'link_description', 'varchar( 255 )' ) ) {
+ *         $ddl = "ALTER TABLE $wpdb->links MODIFY COLUMN link_description varchar(255) NOT NULL DEFAULT '' ";
+ *         $q = $wpdb->query( $ddl );
+ *     }
+ *
+ *     if ( check_column( $wpdb->links, 'link_description', 'varchar( 255 )' ) ) {
+ *         $res .= $tablename . ' - ok <br />';
+ *     } else {
+ *         $res .= 'There was a problem with ' . $tablename . '<br />';
+ *         ++$error_count;
+ *     }
  *
  * @package WordPress
  * @subpackage Plugin
@@ -44,7 +43,7 @@ if ( ! function_exists('maybe_create_table') ) :
  *
  * @since 1.0.0
  *
- * @uses $wpdb
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param string $table_name Database table name.
  * @param string $create_ddl Create database table SQL.
@@ -57,9 +56,10 @@ function maybe_create_table($table_name, $create_ddl) {
                        return true;
                }
        }
-       //didn't find it try to create it.
+       // Didn't find it, so try to create it.
        $wpdb->query($create_ddl);
-       // we cannot directly tell that whether this succeeded!
+
+       // We cannot directly tell that whether this succeeded!
        foreach ($wpdb->get_col("SHOW TABLES",0) as $table ) {
                if ($table == $table_name) {
                        return true;
@@ -75,7 +75,7 @@ if ( ! function_exists('maybe_add_column') ) :
  *
  * @since 1.0.0
  *
- * @uses $wpdb
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param string $table_name Database table name
  * @param string $column_name Table column name
@@ -90,9 +90,11 @@ function maybe_add_column($table_name, $column_name, $create_ddl) {
                        return true;
                }
        }
-       //didn't find it try to create it.
+
+       // Didn't find it, so try to create it.
        $wpdb->query($create_ddl);
-       // we cannot directly tell that whether this succeeded!
+
+       // We cannot directly tell that whether this succeeded!
        foreach ($wpdb->get_col("DESC $table_name",0) as $column ) {
                if ($column == $column_name) {
                        return true;
@@ -107,7 +109,7 @@ endif;
  *
  * @since 1.0.0
  *
- * @uses $wpdb
+ * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param string $table_name Table name
  * @param string $column_name Column name
@@ -118,9 +120,11 @@ function maybe_drop_column($table_name, $column_name, $drop_ddl) {
        global $wpdb;
        foreach ($wpdb->get_col("DESC $table_name",0) as $column ) {
                if ($column == $column_name) {
-                       //found it try to drop it.
+
+                       // Found it, so try to drop it.
                        $wpdb->query($drop_ddl);
-                       // we cannot directly tell that whether this succeeded!
+
+                       // We cannot directly tell that whether this succeeded!
                        foreach ($wpdb->get_col("DESC $table_name",0) as $column ) {
                                if ($column == $column_name) {
                                        return false;
@@ -128,7 +132,7 @@ function maybe_drop_column($table_name, $column_name, $drop_ddl) {
                        }
                }
        }
-       // else didn't find it
+       // Else didn't find it.
        return true;
 }
 
@@ -150,13 +154,15 @@ function maybe_drop_column($table_name, $column_name, $drop_ddl) {
  *
  * @since 1.0.0
  *
+ * @global wpdb $wpdb
+ *
  * @param string $table_name Table name
- * @param string $col_name Column name
- * @param string $col_type Column type
- * @param bool $is_null Optional. Check is null.
- * @param mixed $key Optional. Key info.
- * @param mixed $default Optional. Default value.
- * @param mixed $extra Optional. Extra value.
+ * @param string $col_name   Column name
+ * @param string $col_type   Column type
+ * @param bool   $is_null    Optional. Check is null.
+ * @param mixed  $key        Optional. Key info.
+ * @param mixed  $default    Optional. Default value.
+ * @param mixed  $extra      Optional. Extra value.
  * @return bool True, if matches. False, if not matching.
  */
 function check_column($table_name, $col_name, $col_type, $is_null = null, $key = null, $default = null, $extra = null) {
@@ -167,7 +173,8 @@ function check_column($table_name, $col_name, $col_type, $is_null = null, $key =
        foreach ($results as $row ) {
 
                if ($row->Field == $col_name) {
-                       // got our column, check the params
+
+                       // Got our column, check the params.
                        if (($col_type != null) && ($row->Type != $col_type)) {
                                ++$diffs;
                        }