Pelzini

class DatabaseOutputter

Outputs the tree to a database.

• File: /processor/database_outputter.php
• Namespace: processor
• Extends: Outputter
• This class is abstract
• Available since:

Extending this class

<?php
/**
* New class description goes here
* 
* @author Your Name, 2024-04-26
**/
class NewClassName extends DatabaseOutputter {
    
    /**
    * Saves 'see also' information about an item
    **/
    private function save_see_items ($link_type, $link_id, $items) {
        // Method code goes here
    }
    
    /**
    * Saves info tags for an item
    **/
    private function save_info_tag_items ($link_type, $link_id, $items) {
        // Method code goes here
    }
    
    /**
    * Saves 'example' information about an item
    **/
    private function save_example_items ($link_type, $link_id, $items) {
        // Method code goes here
    }
    
    /**
    * Saves table usage information about an item
    **/
    private function save_table_items ($link_type, $link_id, $items) {
        // Method code goes here
    }
    
    /**
    * Saves author information about an item
    **/
    private function save_author_items ($link_type, $link_id, $items) {
        // Method code goes here
    }
    
    /**
    * Saves a enumeration to the database
    **/
    private function save_enumeration ($enumeration, $file_id) {
        // Method code goes here
    }
    
    /**
    * Saves a constant to the database
    **/
    private function save_constant ($constant, $file_id, $enumeration_id) {
        // Method code goes here
    }
    
    /**
    * Saves a variable to the database
    **/
    private function save_variable ($variable, $class_id, $interface_id) {
        // Method code goes here
    }
    
    /**
    * Saves an interface to the database
    **/
    private function save_interface ($interface, $file_id, $file_namespace) {
        // Method code goes here
    }
    
    /**
    * Saves a class to the database
    **/
    private function save_class ($class, $file_id, $file_namespace) {
        // Method code goes here
    }
    
    /**
    * Saves a function to the database
    **/
    private function save_function ($function, $file_id, $class_id, $interface_id, $file_namespace) {
        // Method code goes here
    }
    
    /**
    * Gets the database id of a record for a specific @since version
    **/
    private function getSinceVersionId ($since_version) {
        // Method code goes here
    }
    
    /**
    * Does the actual outputting of the file objects (and theihttps://www.nationalcrimecheck.com.au/r sub-objects) to the database
    **/
    public function output (array $files, Config $config) {
        // Method code goes here
    }
    
    /**
    * Creates a table
    **/
    protected function create_table ($table_name, $columns) {
        // Method code goes here
    }
    
    /**
    * The database engine should start a transaction. If transactions are not supported, it should do nothing.
    **/
    protected function start_transaction () {
        // Method code goes here
    }
    
    /**
    * The database engine should commit a transaction. If transactions are not supported, it should do nothing.
    **/
    protected function commit_transaction () {
        // Method code goes here
    }
    
    /**
    * The database engine should rollback a transaction. If transactions are not supported, it should do nothing.
    **/
    protected function rollback_transaction () {
        // Method code goes here
    }
    
    /**
    * Executes an insert query for the data provided.
    **/
    protected function do_insert ($table, $data) {
        // Method code goes here
    }
    
    /**
    * Executes an insert query for the data provided.
    **/
    protected function do_multiple_insert ($table, $data) {
        // Method code goes here
    }
    
    /**
    * Executes an update query for the data provided.
    **/
    protected function do_update ($table, $data, $where) {
        // Method code goes here
    }
    
    /**
    * Adds a @since version to from a {@link CodeParserItem} to the internal list
    * This list is used to fill a table with all of the versions of the program in existance
    **/
    public function addSinceVersion (CodeParserItem $parser_item, $parent) {
        // Method code goes here
    }
    
    /**
    * Updates the database layout to match the layout file
    * NOTE: currently only supports column and table adding and updating, not removal.
    **/
    public function check_layout (string $layout_filename) {
        // Method code goes here
    }
    
    /**
    * Fetches a row from the database (numerical)
    **/
    protected function fetch_row ($res) {
        // Method code goes here
    }
    
    /**
    * Fetches a row from the database (assoc)
    **/
    protected function fetch_assoc ($res) {
        // Method code goes here
    }
    
    /**
    * Returns the number of rows affected in the last query
    **/
    protected function affected_rows ($res) {
        // Method code goes here
    }
    
    /**
    * Returns the autogenerated id created in the last query
    **/
    protected function insert_id () {
        // Method code goes here
    }
    
    /**
    * Returns an array of the tables in this database
    **/
    protected function get_table_list () {
        // Method code goes here
    }
    
    /**
    * Should return a multi-dimentional array of the column details
    * Format:
    * Array [
    *   [0] =&gt; Array [
    *      'Field' =&gt; field name
    *      'Type' =&gt; field type, (e.g. 'serial', 'smallnum' or 'identifier')
    *      'NotNull' =&gt; nullable?, (true or false)
    *      'Key' =&gt; indexed?, ('PRI' for primary key)
    *      ]
    *    [1] =&gt; ...
    *    [n] =&gt; ...
    **/
    protected function get_column_details ($table_name) {
        // Method code goes here
    }
    
    /**
    * 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 function get_sql_type (string $internal_type_name) {
        // Method code goes here
    }
    
    /**
    * Gets the query that alters a column to match the new SQL definition
    **/
    protected function get_alter_column_query ($table, $column_name, $new_type, $null_allowed) {
        // Method code goes here
    }
    
    /**
    * Should return a multi-dimentional array of the index details
    * Format:
    * Array [
    *   [0] =&gt; Array [
    *      'Fields' =&gt; array of field names
    *      ]
    *   [1] =&gt; ...
    *   [n] =&gt; ...
    **/
    protected function get_index_details ($table_name) {
        // Method code goes here
    }
    
    /**
    * Safens some input
    **/
    protected function sql_safen (string $input) {
        // Method code goes here
    }
    
    /**
    * Executes a database query
    **/
    protected function query ($query) {
        // Method code goes here
    }
    
    /**
    * Connects to the database
    **/
    protected function connect () {
        // Method code goes here
    }
    
}
?>