MysqlOutputter class - Documentation for Pelzini

Info Page:

Page options:

class MysqlOutputter

Outputs the tree as MySQL

File: /processor/mysql_outputter.php
Namespace: processor
Extends: DatabaseOutputter
Available since:

Authors

Josh

Variables

Name	Visibility	Description
`$database`
`$db`
`$password`
`$server`
`$username`

Functions

Name	Visibility	Description
__construct	public	Connects to the db
__destruct	public	Closes connection to the db
affected_rows	protected	Returns the number of rows affected in the last query
commit_transaction	protected	The database engine should commit a transaction. If transactions are not supported, it should do nothing.
connect	protected	Connects to the MySQL database
create_table	protected	Creates a table
fetch_assoc	protected	Fetches a row from the database (assoc)
fetch_row	protected	Fetches a row from the database (numerical)
get_alter_column_query	protected	Gets the query that alters a column to match the new SQL definition
get_column_details	protected	Should return a multi-dimentional array of the column details
get_index_details	protected	Should return a multi-dimentional array of the index details
get_sql_type	protected	Converts an internal type into the database-specific SQL type.
get_table_list	protected	Returns an array of the tables in this database
insert_id	protected	Returns the autogenerated id created in the last query
query	protected	Executes a MySQL query
rollback_transaction	protected	The database engine should rollback a transaction. If transactions are not supported, it should do nothing.
sql_safen	protected	Safens some input
start_transaction	protected	The database engine should start a transaction. If transactions are not supported, it should do nothing.

public __construct

void $MysqlOutputter->__construct ( mixed $username , mixed $password , mixed $server , mixed $database );

Connects to the db

public __destruct

void $MysqlOutputter->__destruct ( );

Closes connection to the db

protected affected_rows

unknown $MysqlOutputter->affected_rows ( mixed $res );

Returns the number of rows affected in the last query

protected commit_transaction

void $MysqlOutputter->commit_transaction ( );

The database engine should commit a transaction. If transactions are not supported, it should do nothing.

protected connect

unknown $MysqlOutputter->connect ( );

Connects to the MySQL database

protected create_table

void $MysqlOutputter->create_table ( mixed $table_name , mixed $dest_table );

Creates a table

protected fetch_assoc

unknown $MysqlOutputter->fetch_assoc ( mixed $res );

Fetches a row from the database (assoc)

protected fetch_row

unknown $MysqlOutputter->fetch_row ( mixed $res );

Fetches a row from the database (numerical)

protected get_alter_column_query

unknown $MysqlOutputter->get_alter_column_query ( mixed $table , mixed $column_name , mixed $new_type , mixed $not_null );

Gets the query that alters a column to match the new SQL definition

protected get_column_details

unknown $MysqlOutputter->get_column_details ( mixed $table_name );

Should return a multi-dimentional array of the column details
Format:
Array [
  [0] => Array [
     'Field' => field name
     'Type' => field type, (e.g. 'serial', 'smallnum' or 'identifier')
     'NotNull' => nullable?, (true or false)
     'Key' => indexed?, ('PRI' for primary key)
     ]
   [1] => ...
   [n] => ...

protected get_index_details

unknown $MysqlOutputter->get_index_details ( mixed $table_name );

Should return a multi-dimentional array of the index details
Format:
Array [
  [0] => Array [
     'Fields' => array of field names
     ]
  [1] => ...
  [n] => ...

protected get_sql_type

string $MysqlOutputter->get_sql_type ( string $internal_type_name );

Converts an internal type into the database-specific SQL type.
The defined internal types are:
  - serial: a number that automatically increments whenever a record is added
  - smallnum: a small number. needs to be able to hold at least 32,767 possible values (e.g. a 16-bit signed integer)
  - largenum: a large number. needs to be the same size or larger than a serial type
  - string: a character field long enough to hold identifiers of objects (e.g. function names)
  - text: a field that can hold arbitary pieces of text larger than 65536 chars in length.

protected get_table_list

unknown $MysqlOutputter->get_table_list ( );

Returns an array of the tables in this database

protected insert_id

unknown $MysqlOutputter->insert_id ( );

Returns the autogenerated id created in the last query

protected query

unknown $MysqlOutputter->query ( mixed $query );

Executes a MySQL query

protected rollback_transaction

void $MysqlOutputter->rollback_transaction ( );

The database engine should rollback a transaction. If transactions are not supported, it should do nothing.

protected sql_safen

unknown $MysqlOutputter->sql_safen ( string $input );

Safens some input

protected start_transaction

void $MysqlOutputter->start_transaction ( );

The database engine should start a transaction. If transactions are not supported, it should do nothing.

Pelzini

Search documentation