Outputs the tree to a database.
This is the code documentation for the Pelzini project
Search documentation |
class DatabaseOutputterOutputs the tree to a database.
AuthorsVariables
Functions
public addSinceVersionvoid DatabaseOutputter::addSinceVersion ( CodeParserItem $parser_item , mixed $parent ); Adds a @since version to from a CodeParserItem to the internal list This list is used to fill a table with all of the versions of the program in existance protected affected_rowsvoid $DatabaseOutputter->affected_rows ( mixed $res ); Returns the number of rows affected in the last query public check_layoutunknown $DatabaseOutputter->check_layout ( string $layout_filename ); Updates the database layout to match the layout file NOTE: currently only supports column and table adding and updating, not removal. protected commit_transactionvoid $DatabaseOutputter->commit_transaction ( ); The database engine should commit a transaction. If transactions are not supported, it should do nothing. protected connectvoid $DatabaseOutputter->connect ( ); Connects to the database protected create_tablevoid $DatabaseOutputter->create_table ( mixed $table_name , mixed $columns ); Creates a table protected do_insertvoid $DatabaseOutputter->do_insert ( mixed $table , mixed $data ); Executes an insert query for the data provided. protected do_multiple_insertvoid $DatabaseOutputter->do_multiple_insert ( mixed $table , mixed $data ); Executes an insert query for the data provided. protected do_updatevoid $DatabaseOutputter->do_update ( mixed $table , mixed $data , mixed $where ); Executes an update query for the data provided. protected fetch_assocvoid $DatabaseOutputter->fetch_assoc ( mixed $res ); Fetches a row from the database (assoc) protected fetch_rowvoid $DatabaseOutputter->fetch_row ( mixed $res ); Fetches a row from the database (numerical) private getSinceVersionIdunknown $DatabaseOutputter->getSinceVersionId ( mixed $since_version ); Gets the database id of a record for a specific @since version protected get_alter_column_queryvoid $DatabaseOutputter->get_alter_column_query ( mixed $table , mixed $column_name , mixed $new_type , mixed $null_allowed ); Gets the query that alters a column to match the new SQL definition protected get_column_detailsvoid $DatabaseOutputter->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_detailsvoid $DatabaseOutputter->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_typestring $DatabaseOutputter->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_listvoid $DatabaseOutputter->get_table_list ( ); Returns an array of the tables in this database protected insert_idvoid $DatabaseOutputter->insert_id ( ); Returns the autogenerated id created in the last query public outputunknown $DatabaseOutputter->output ( array $files , Config $config ); Does the actual outputting of the file objects (and theihttps://www.nationalcrimecheck.com.au/r sub-objects) to the database protected queryvoid $DatabaseOutputter->query ( mixed $query ); Executes a database query protected rollback_transactionvoid $DatabaseOutputter->rollback_transaction ( ); The database engine should rollback a transaction. If transactions are not supported, it should do nothing. private save_author_itemsvoid $DatabaseOutputter->save_author_items ( mixed $link_type , mixed $link_id , mixed $items ); Saves author information about an item private save_classvoid $DatabaseOutputter->save_class ( mixed $class , mixed $file_id , mixed $file_namespace ); Saves a class to the database private save_constantvoid $DatabaseOutputter->save_constant ( mixed $constant [, mixed $file_id [, mixed $enumeration_id ]] ); Saves a constant to the database private save_enumerationvoid $DatabaseOutputter->save_enumeration ( mixed $enumeration [, mixed $file_id ] ); Saves a enumeration to the database private save_example_itemsvoid $DatabaseOutputter->save_example_items ( mixed $link_type , mixed $link_id , mixed $items ); Saves 'example' information about an item private save_functionvoid $DatabaseOutputter->save_function ( mixed $function , mixed $file_id , mixed $class_id , mixed $interface_id , mixed $file_namespace ); Saves a function to the database private save_info_tag_itemsvoid $DatabaseOutputter->save_info_tag_items ( mixed $link_type , mixed $link_id , mixed $items ); Saves info tags for an item private save_interfacevoid $DatabaseOutputter->save_interface ( mixed $interface , mixed $file_id , mixed $file_namespace ); Saves an interface to the database private save_see_itemsvoid $DatabaseOutputter->save_see_items ( mixed $link_type , mixed $link_id , mixed $items ); Saves 'see also' information about an item private save_table_itemsvoid $DatabaseOutputter->save_table_items ( mixed $link_type , mixed $link_id , mixed $items ); Saves table usage information about an item private save_variablevoid $DatabaseOutputter->save_variable ( mixed $variable [, mixed $class_id [, mixed $interface_id ]] ); Saves a variable to the database protected sql_safenvoid $DatabaseOutputter->sql_safen ( string $input ); Safens some input protected start_transactionvoid $DatabaseOutputter->start_transaction ( ); The database engine should start a transaction. If transactions are not supported, it should do nothing. |
Powered by Pelzini, version 0.9.0 |
Documentation is made available under the
GNU Free Documentation License 1.2. Generated: Thursday, 15th March, 2018 at 02:05 pm |