* 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
*
* @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.
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;
*
* @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
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;
*
* @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
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;
}
}
}
- // else didn't find it
+ // Else didn't find it.
return true;
}
*
* @since 1.0.0
*
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
* @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) {
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;
}