From 46e550227837ce7fc420bd5b51d98d3f8b9075c3 Mon Sep 17 00:00:00 2001 From: "Timothy J. Warren" Date: Tue, 18 Feb 2014 15:16:34 -0500 Subject: [PATCH] Update docs [ci skip] --- docs/classes.svg | 186 +- docs/classes/BadConnectionException.html | 13 +- docs/classes/BadDBDriverException.html | 13 +- docs/classes/DB_PDO.html | 146 +- docs/classes/DB_Util.html | 41 +- docs/classes/Firebird.html | 83 +- docs/classes/Firebird_Result.html | 104 +- docs/classes/Firebird_SQL.html | 45 +- docs/classes/Firebird_Util.html | 38 +- docs/classes/MySQL.html | 33 +- docs/classes/MySQL_SQL.html | 47 +- docs/classes/MySQL_Util.html | 38 +- docs/classes/ODBC.html | 37 +- docs/classes/ODBC_SQL.html | 45 +- docs/classes/ODBC_Util.html | 36 +- docs/classes/PgSQL.html | 25 +- docs/classes/PgSQL_SQL.html | 45 +- docs/classes/PgSQL_Util.html | 38 +- docs/classes/Query_Builder.html | 334 ++- docs/classes/Query_Parser.html | 60 +- docs/classes/SQLite.html | 41 +- docs/classes/SQLite_SQL.html | 45 +- docs/classes/SQLite_Util.html | 50 +- docs/classes/iDB_SQL.html | 52 +- docs/classes/iQuery_Builder.html | 192 +- docs/css/template.css | 16 +- docs/deprecated.html | 4 +- docs/errors.html | 4 +- docs/graph_class.html | 4 +- docs/js/template.js | 20 +- docs/markers.html | 4 +- docs/namespaces/global.html | 18 +- docs/packages/Default.html | 4 +- docs/packages/Query.Drivers.html | 14 +- docs/packages/Query.Query.html | 10 +- docs/packages/Query.html | 36 +- docs/structure.xml | 2794 +++++++++++----------- 37 files changed, 2542 insertions(+), 2173 deletions(-) diff --git a/docs/classes.svg b/docs/classes.svg index 93c9ed5..8b68774 100644 --- a/docs/classes.svg +++ b/docs/classes.svg @@ -22,25 +22,25 @@ \\DB_PDO - -«abstract» -DB_PDO + +«abstract» +DB_PDO \\PDO - -\PDO + +\PDO \\DB_PDO->\\PDO - - + + \\DB_Util - -«abstract» -DB_Util + +«abstract» +DB_Util \\Query_Parser @@ -64,173 +64,173 @@ \\ODBC_SQL - -ODBC_SQL + +ODBC_SQL \\iDB_SQL - -iDB_SQL + +iDB_SQL \\ODBC_SQL->\\iDB_SQL - - + + \\ODBC - -ODBC + +ODBC \\ODBC->\\DB_PDO - - + + \\ODBC_Util - -ODBC_Util + +ODBC_Util \\ODBC_Util->\\DB_Util - - + + \\SQLite_SQL - -SQLite_SQL + +SQLite_SQL \\SQLite_SQL->\\iDB_SQL - - - - -\\SQLite_Util - -SQLite_Util - - -\\SQLite_Util->\\DB_Util - - + + -\\SQLite - -SQLite +\\SQLite + +SQLite -\\SQLite->\\DB_PDO - - +\\SQLite->\\DB_PDO + + - -\\Firebird_Util - -Firebird_Util + +\\SQLite_Util + +SQLite_Util - -\\Firebird_Util->\\DB_Util - - - - -\\Firebird_SQL - -Firebird_SQL - - -\\Firebird_SQL->\\iDB_SQL - - + +\\SQLite_Util->\\DB_Util + + -\\Firebird_Result +\\Firebird_Result Firebird_Result -\\PDOStatement +\\PDOStatement \PDOStatement -\\Firebird_Result->\\PDOStatement +\\Firebird_Result->\\PDOStatement + +\\Firebird_SQL + +Firebird_SQL + + +\\Firebird_SQL->\\iDB_SQL + + + + +\\Firebird_Util + +Firebird_Util + + +\\Firebird_Util->\\DB_Util + + + \\Firebird - -Firebird + +Firebird \\Firebird->\\DB_PDO - - + + \\PgSQL - -PgSQL + +PgSQL \\PgSQL->\\DB_PDO - - + + \\PgSQL_Util - -PgSQL_Util + +PgSQL_Util \\PgSQL_Util->\\DB_Util - - + + \\PgSQL_SQL - -PgSQL_SQL + +PgSQL_SQL \\PgSQL_SQL->\\iDB_SQL - - + + \\MySQL - -MySQL + +MySQL \\MySQL->\\DB_PDO - - + + \\MySQL_Util - -MySQL_Util + +MySQL_Util \\MySQL_Util->\\DB_Util - - + + \\MySQL_SQL - -MySQL_SQL + +MySQL_SQL \\MySQL_SQL->\\iDB_SQL - - + + \\BadDBDriverException diff --git a/docs/classes/BadConnectionException.html b/docs/classes/BadConnectionException.html index 948289b..661afb1 100644 --- a/docs/classes/BadConnectionException.html +++ b/docs/classes/BadConnectionException.html @@ -49,15 +49,20 @@
-
+
+
+ +
+
+
    + generated on 2014-02-18T15:15:22-05:00.
    diff --git a/docs/classes/BadDBDriverException.html b/docs/classes/BadDBDriverException.html index 0631539..a4b34f6 100644 --- a/docs/classes/BadDBDriverException.html +++ b/docs/classes/BadDBDriverException.html @@ -49,15 +49,20 @@
    -
    +
    +
    + +
    +
    +
      + generated on 2014-02-18T15:15:22-05:00.
      diff --git a/docs/classes/DB_PDO.html b/docs/classes/DB_PDO.html index 497ddb8..ce6b6fa 100644 --- a/docs/classes/DB_PDO.html +++ b/docs/classes/DB_PDO.html @@ -49,14 +49,20 @@
      -
      +
      +
      + +
      +
      +
      -
      +

      Return schemas for databases that list them

      get_schemas() : array
      @@ -243,7 +256,7 @@ the connection/database
      get_system_tables()
      array
      -
      +

      Return list of sequences for the current database, if they exist

      get_sequences() : array
      @@ -253,7 +266,7 @@ the connection/database
      get_system_tables()
      array
      -
      +

      Retreives an array of non-user-created tables for the connection/database

      get_system_tables() : array
      @@ -264,7 +277,7 @@ the connection/database
      array
      -
      +

      Return list of tables for the current database

      get_tables() : array
      @@ -274,7 +287,7 @@ the connection/database
      array
      -
      +

      Return list of triggers for the current database

      get_triggers() : array
      @@ -284,7 +297,7 @@ the connection/database
      array
      -
      +

      Retrieve list of data types for the database

      get_types() : array
      @@ -294,7 +307,7 @@ the connection/database
      array
      -
      +

      Return list of views for the current database

      get_views() : array
      @@ -304,9 +317,9 @@ the connection/database
      array
      -
      +

      Create sql for batch insert

      -
      insert_batch(string $table, array $data) : string
      +
      insert_batch(string $table, array $data = array()) : string
      @@ -323,7 +336,7 @@ the connection/database
      string
      -
      +

      Return the number of rows returned for a SELECT query

      num_rows() : int
      @@ -337,7 +350,7 @@ the connection/database
      int
      -
      +

      Create and execute a prepared statement with the provided parameters

      prepare_execute(string $sql, array $params) : \PDOStatement
      @@ -356,7 +369,7 @@ the connection/database
      \PDOStatement
      -
      +

      Simplifies prepared statements for database queries

      prepare_query(string $sql, array $data) : mixed
      @@ -381,7 +394,7 @@ the connection/database mixedPDOStatement / FALSE
      -
      +

      Surrounds the string with the databases identifier escape characters

      quote_ident(mixed $ident) : string
      @@ -396,7 +409,7 @@ the connection/database
      string
      -
      +

      Quote database table name, and set prefix

      quote_table(string $table) : string
      @@ -411,7 +424,7 @@ the connection/database
      string
      -
      +

      Empty the passed table

      truncate(string $table) : void
      @@ -424,7 +437,7 @@ the connection/database
      -
      +

      Sets the table prefix on the passed string

      _prefix(string $str) : string
      @@ -439,56 +452,65 @@ the connection/database
      string
      -
      -

      Helper method for quote_ident

      -
      _quote(mixed $str) : mixed
      -
      -
      -
      -

      Parameters

      -
      -

      $str

      -mixed -
      -

      Returns

      -
      mixed
      -
      -

      - Properties

      - 
      + Properties + 

      $last_query

      $last_query 
      +
      +

      Default

      +
      +
      - 
      + 

      $sql

      $sql 
      +
      +

      Default

      +
      +
      - 
      + 

      $table_prefix

      $table_prefix 
      +
      +

      Default

      +
      ''
      +
      - 
      + 

      $util

      $util 
      +
      +

      Default

      +
      +
      - 
      + 

      $escape_char

      $escape_char 
      +
      +

      Default

      +
      '"'
      +
      - 
      + 

      $statement

      $statement 
      +
      +

      Default

      +
      +
      @@ -498,9 +520,9 @@ the connection/database
      + generated on 2014-02-18T15:15:22-05:00.
      diff --git a/docs/classes/DB_Util.html b/docs/classes/DB_Util.html index 70590a3..a52e2d9 100644 --- a/docs/classes/DB_Util.html +++ b/docs/classes/DB_Util.html @@ -49,12 +49,17 @@
      -
      +
      +
      + +
      +
      +
      -
      +

      Return an SQL file with the database data as insert statements

      backup_data() : string
      @@ -144,7 +149,7 @@
      string
      -
      +

      Return an SQL file with the database table structure

      backup_structure() : string
      @@ -158,9 +163,9 @@
      string
      -
      +

      Get database-specific sql to create a new table

      -
      create_table(string $name, array $columns, array $constraints, array $indexes) : string
      +
      create_table(string $name, array $columns, array $constraints = array(), array $indexes = array()) : string
      @@ -189,7 +194,7 @@
      string
      -
      +

      Get database-specific sql to drop a table

      delete_table(string $name) : string
      @@ -209,10 +214,14 @@

      - Properties

      - 
      + Properties + 

      Reference to the current connection object

      $conn 
      +
      +

      Default

      +
      +
      @@ -222,9 +231,9 @@
      + generated on 2014-02-18T15:15:22-05:00.
      diff --git a/docs/classes/Firebird.html b/docs/classes/Firebird.html index 5da2acd..e8abd90 100644 --- a/docs/classes/Firebird.html +++ b/docs/classes/Firebird.html @@ -49,12 +49,17 @@
      -
      +
      +
      + +
      +
      +
      • - Methods + Methods
      • - Properties + Properties
        • » Protected @@ -89,7 +94,7 @@ the last query executed">
          $statement_link
 
            
 
          • 
-\
+\
 
            • 
 
          • 
 \Firebird
@@ -110,10 +115,10 @@ the last query executed">
            $statement_link
 
 
            
- Methods
            
-
            
+ Methods
+
            
 
            Open the link to the database
            
-
            __construct(string $dbpath, string $user, string $pass) 
            
+
            __construct(string $dbpath, string $user = 'SYSDBA', string $pass = 'masterkey', array $options = array()) 
            
 
            
 
            
 
            
@@ -130,9 +135,13 @@ the last query executed">
            $statement_link$pass
 string
 
            
+
            
+
            $options
            
+array
+
            
 
            
 
            
-
            
+
            
 
            Start a database transaction
            
 
            beginTransaction() : bool
            
 
            
@@ -142,7 +151,7 @@ the last query executed">
            $statement_linkbool
        -
        +

        Commit a database transaction

        commit() : bool
        @@ -152,7 +161,7 @@ the last query executed">
        $statement_linkbool
        -
        +

        Method to emulate PDO->errorCode

        errorCode() : array
        @@ -162,7 +171,7 @@ the last query executed">
        $statement_linkarray
        -
        +

        Method to emulate PDO->errorInfo / PDOStatement->errorInfo

        errorInfo() : array
        @@ -172,9 +181,9 @@ the last query executed">
        $statement_linkarray
        -
        +

        Create sql for batch insert

        -
        insert_batch(string $table, array $data) : string
        +
        insert_batch(string $table, array $data = array()) : string
        @@ -191,9 +200,9 @@ the last query executed">
        $statement_linkstring
        -
        +

        Emulate PDO prepare

        -
        prepare(string $query, array $options) : \Firebird
        +
        prepare(string $query, array $options = NULL) : \Firebird
        @@ -219,7 +228,7 @@ the last query executed">
        $statement_link\Firebird
        -
        +

        Prepare and execute a query

        prepare_execute(string $sql, array $args) : resource
        @@ -238,7 +247,7 @@ the last query executed">
        $statement_linkresource
        -
        +

        Bind a prepared query with arguments for executing

        prepare_query(string $sql, array $params) : NULL
        @@ -257,7 +266,7 @@ the last query executed">
        $statement_linkNULL
        -
        +

        Wrapper public function to better match PDO

        query(string $sql) : \Firebird
        @@ -281,9 +290,9 @@ the last query executed">
        $statement_link\Firebird
        -
        +

        Method to emulate PDO->quote

        -
        quote(string $str, int $param_type) : string
        +
        quote(string $str, int $param_type = NULL) : string
        @@ -300,7 +309,7 @@ the last query executed">
        $statement_linkstring
        -
        +

        Rollback a transaction

        rollBack() : bool
        @@ -310,7 +319,7 @@ the last query executed">
        $statement_linkbool
        -
        +

        Empty a database table

        truncate(string $table) 
        @@ -324,29 +333,45 @@ the last query executed">
        $statement_link

        - Properties

        - 
        + Properties + 

        Reference to the connection resource

        $conn : resource
        +
        +

        Default

        +
        +
        - 
        + 

        Reference to the last query executed

        $statement : object
        +
        +

        Default

        +
        +
        - 
        + 

        Reference to the resource returned by the last query executed

        $statement_link : resource
        +
        +

        Default

        +
        +
        - 
        + 

        Reference to the current transaction

        $trans : resource
        +
        +

        Default

        +
        +
        @@ -356,9 +381,9 @@ the last query executed
        + generated on 2014-02-18T15:15:22-05:00.
        diff --git a/docs/classes/Firebird_Result.html b/docs/classes/Firebird_Result.html index 184a528..3e6cc47 100644 --- a/docs/classes/Firebird_Result.html +++ b/docs/classes/Firebird_Result.html @@ -49,12 +49,17 @@
        -
        +
        +
        + +
        +
        +
        -
        +

        Invalidate method for data consistency

        -
        bindColumn(mixed $column, $param, int $type, mixed $maxlen, array $driverdata) : NULL
        +
        bindColumn(mixed $column, mixed $param, int $type = NULL, mixed $maxlen = NULL, array $driverdata = NULL) : NULL
        @@ -136,7 +141,10 @@ the query

        $column

        mixed
        -

        $param

        +
        +

        $param

        +mixed +

        $type

        int @@ -153,9 +161,9 @@ the query
        NULL
        -
        +

        Invalidate method for data consistency

        -
        bindParam(mixed $parameter, $variable, int $data_type, mixed $maxlen, array $driverdata) : NULL
        +
        bindParam(mixed $parameter, mixed $variable, int $data_type = NULL, mixed $maxlen = NULL, array $driverdata = NULL) : NULL
        @@ -164,7 +172,10 @@ the query

        $parameter

        mixed
        -

        $variable

        +
        +

        $variable

        +mixed +

        $data_type

        int @@ -181,9 +192,9 @@ the query
        NULL
        -
        +

        Invalidate method for data consistency

        -
        bindValue(mixed $parameter, $variable, int $data_type) : NULL
        +
        bindValue(mixed $parameter, mixed $variable, int $data_type = NULL) : NULL
        @@ -192,7 +203,10 @@ the query

        $parameter

        mixed
        -

        $variable

        +
        +

        $variable

        +mixed +

        $data_type

        int @@ -201,7 +215,7 @@ the query
        NULL
        -
        +

        Method to emulate PDOStatement->errorCode

        errorCode() : string
        @@ -211,7 +225,7 @@ the query
        string
        -
        +

        Method to emulate PDO->errorInfo / PDOStatement->errorInfo

        errorInfo() : array
        @@ -221,9 +235,9 @@ the query
        array
        -
        +

        Run a prepared statement query

        -
        execute(array $args) : bool
        +
        execute(array $args = NULL) : bool
        @@ -236,9 +250,9 @@ the query
        bool
        -
        +

        Emulate PDO fetch public function

        -
        fetch(int $fetch_style, $cursor_orientation, $cursor_offset) : mixed
        +
        fetch(int $fetch_style = \PDO::FETCH_ASSOC, mixed $cursor_orientation = \PDO::FETCH_ORI_NEXT, mixed $cursor_offset = NULL) : mixed
        @@ -247,15 +261,21 @@ the query

        $fetch_style

        int
        -

        $cursor_orientation

        -

        $cursor_offset

        +
        +

        $cursor_orientation

        +mixed +
        +
        +

        $cursor_offset

        +mixed +

        Returns

        mixed
        -
        +

        Emulate PDO fetchAll public function

        -
        fetchAll(int $fetch_style, mixed $statement, mixed $ctor_args) : mixed
        +
        fetchAll(int $fetch_style = \PDO::FETCH_ASSOC, mixed $statement = NULL, mixed $ctor_args = NULL) : mixed
        @@ -276,9 +296,9 @@ the query
        mixed
        -
        +

        Emulate PDOStatement::fetchColumn

        -
        fetchColumn(int $column_num) : mixed
        +
        fetchColumn(int $column_num = 0) : mixed
        @@ -291,9 +311,9 @@ the query
        mixed
        -
        +

        Emulate PDOStatement::fetchObject, but only for the default use

        -
        fetchObject(string $class_name, array $ctor_args) : \stdClass
        +
        fetchObject(string $class_name = 'stdClass', array $ctor_args = array()) : \stdClass
        @@ -310,7 +330,7 @@ the query
        \stdClass
        -
        +

        Return the number of rows affected by the previous query

        rowCount() : int
        @@ -321,10 +341,14 @@ the query

        - Properties

        - 
        + Properties + 

        Data pulled from query

        $result 
        +
        +

        Default

        +
        array()
        +
        @@ -334,15 +358,23 @@ the query
        - 
        + 

        Current row in result array

        $row : int
        +
        +

        Default

        +
        +
        - 
        + 

        Reference to fbird resource

        $statement : resource
        +
        +

        Default

        +
        +
        @@ -352,9 +384,9 @@ the query
        + generated on 2014-02-18T15:15:22-05:00.
        diff --git a/docs/classes/Firebird_SQL.html b/docs/classes/Firebird_SQL.html index cf103d4..0f1d835 100644 --- a/docs/classes/Firebird_SQL.html +++ b/docs/classes/Firebird_SQL.html @@ -49,11 +49,16 @@
        -
        +
        +
        + +
        +
        +
        -
        +

        Get the query plan for the sql query

        explain(string $sql) : string
        @@ -136,7 +141,7 @@
        string
        -
        +

        Return sql to list functions

        function_list() : string
        @@ -146,9 +151,9 @@
        string
        -
        +

        Limit clause

        -
        limit(string $sql, int $limit, int $offset) : string
        +
        limit(string $sql, int $limit, int $offset = FALSE) : string
        @@ -169,7 +174,7 @@
        string
        -
        +

        Return sql to list stored procedures

        procedure_list() : string
        @@ -179,7 +184,7 @@
        string
        -
        +

        Random ordering keyword

        random() : string
        @@ -189,7 +194,7 @@
        string
        -
        +

        Return sql to list sequences

        sequence_list() : string
        @@ -199,7 +204,7 @@
        string
        -
        +

        Returns sql to list system tables

        system_table_list() : string
        @@ -209,7 +214,7 @@
        string
        -
        +

        Returns sql to list tables

        table_list() : string
        @@ -219,7 +224,7 @@
        string
        -
        +

        Returns sql to list triggers

        trigger_list() : string
        @@ -229,7 +234,7 @@
        string
        -
        +

        SQL to show list of field types

        type_list() : string
        @@ -239,7 +244,7 @@
        string
        -
        +

        Returns sql to list views

        view_list() : string
        @@ -255,9 +260,9 @@
        + generated on 2014-02-18T15:15:22-05:00.
        diff --git a/docs/classes/Firebird_Util.html b/docs/classes/Firebird_Util.html index 94b18f4..ac0c9ea 100644 --- a/docs/classes/Firebird_Util.html +++ b/docs/classes/Firebird_Util.html @@ -49,11 +49,16 @@
        -
        +
        +
        + +
        +
        +
        • - Methods + Methods
          • Save a reference to the current connection object
            __construct()
          • Create an SQL backup file for the current database's data
            backup_data()
            • @@ -66,7 +71,7 @@
            • -\ +\
            • \Firebird_Util @@ -87,20 +92,23 @@

              - Methods

              -
              + Methods +

              Save a reference to the current connection object

              -
              __construct($conn) : void
              +
              __construct(object $conn) : void

              Parameters

              -

              $conn

              +
              +

              $conn

              +object +
              -
              +

              Create an SQL backup file for the current database's data

              -
              backup_data(array $exclude, bool $system_tables) : string
              +
              backup_data(array $exclude = array(), bool $system_tables = FALSE) : string
              @@ -117,7 +125,7 @@
              string
              -
              +

              Create an SQL backup file for the current database's structure

              backup_structure() : string
              @@ -127,9 +135,9 @@
              string
              -
              +

              Convienience public function to generate sql for creating a db table

              -
              create_table(string $name, array $fields, array $constraints, array $indexes) : string
              +
              create_table(string $name, array $fields, array $constraints = array(), array $indexes = array()) : string
              @@ -154,7 +162,7 @@
              string
              -
              +

              Drop the selected table

              delete_table(string $name) : string
              @@ -175,9 +183,9 @@
              + generated on 2014-02-18T15:15:22-05:00.
              diff --git a/docs/classes/MySQL.html b/docs/classes/MySQL.html index 4362dc1..8f3dd64 100644 --- a/docs/classes/MySQL.html +++ b/docs/classes/MySQL.html @@ -49,19 +49,24 @@
              -
              +
              +
              + +
              +
              +
              • - Methods + Methods
              • - Properties + Properties
                • » Protected @@ -72,7 +77,7 @@
                  • -\ +\
                  • \MySQL @@ -93,10 +98,10 @@

                    - Methods

                    -
                    + Methods +

                    Connect to MySQL Database

                    -
                    __construct(string $dsn, string $username, string $password, array $options) 
                    +
                    __construct(string $dsn, string $username = null, string $password = null, array $options = array()) 
                    @@ -119,7 +124,7 @@
                    -
                    +

                    Empty a table

                    truncate(string $table) 
                    @@ -133,10 +138,14 @@

                  - Properties

                  - 
                  + Properties + 

                  Set the backtick as the MySQL escape character

                  $escape_char : string
                  +
                  +

                  Default

                  +
                  '`'
                  +
                  @@ -146,9 +155,9 @@
                  + generated on 2014-02-18T15:15:22-05:00.
                diff --git a/docs/classes/MySQL_SQL.html b/docs/classes/MySQL_SQL.html index a70011f..192f3e5 100644 --- a/docs/classes/MySQL_SQL.html +++ b/docs/classes/MySQL_SQL.html @@ -49,11 +49,16 @@
                -
                +
                +
                + +
                +
                +
                -
                +

                Get the query plan for the sql query

                explain(string $sql) : string
                @@ -136,7 +141,7 @@
                string
                -
                +

                Return sql to list functions

                function_list() : string
                @@ -146,9 +151,9 @@
                string
                -
                +

                Limit clause

                -
                limit(string $sql, int $limit, int $offset) : string
                +
                limit(string $sql, int $limit, int $offset = FALSE) : string
                @@ -169,7 +174,7 @@
                string
                -
                +

                Return sql to list stored procedures

                procedure_list() : string
                @@ -179,7 +184,7 @@
                string
                -
                +

                Random ordering keyword

                random() : string
                @@ -189,7 +194,7 @@
                string
              -
              +

              Return sql to list sequences

              sequence_list() : NULL
              @@ -199,7 +204,7 @@
              NULL
          -
          +

          Overridden in MySQL class

          system_table_list() : string
          @@ -209,9 +214,9 @@
          string
          -
          +

          Returns sql to list tables

          -
          table_list(string $database) : string
          +
          table_list(string $database = '') : string
          @@ -224,7 +229,7 @@
          string
          -
          +

          Returns sql to list triggers

          trigger_list() : string
          @@ -234,7 +239,7 @@
          string
          -
          +

          SQL to show list of field types

          type_list() : string
          @@ -244,7 +249,7 @@
          string
          -
          +

          Returns sql to list views

          view_list() : string
          @@ -260,9 +265,9 @@
          + generated on 2014-02-18T15:15:22-05:00.
          diff --git a/docs/classes/MySQL_Util.html b/docs/classes/MySQL_Util.html index 93a4ae0..a9c2ad1 100644 --- a/docs/classes/MySQL_Util.html +++ b/docs/classes/MySQL_Util.html @@ -49,11 +49,16 @@
          -
          +
          +
          + +
          +
          +
          • - Methods + Methods
            • Save a reference to the current connection object
              __construct()
            • Create an SQL backup file for the current database's data
              backup_data()
              • @@ -66,7 +71,7 @@
              • -\ +\
              • \MySQL_Util @@ -87,20 +92,23 @@

                - Methods

                -
                + Methods +

                Save a reference to the current connection object

                -
                __construct($conn) : void
                +
                __construct(object $conn) : void

                Parameters

                -

                $conn

                +
                +

                $conn

                +object +
                -
                +

                Create an SQL backup file for the current database's data

                -
                backup_data(array $exclude) : string
                +
                backup_data(array $exclude = array()) : string
                @@ -113,7 +121,7 @@
                string
                -
                +

                Create an SQL backup file for the current database's structure

                backup_structure() : string
                @@ -123,9 +131,9 @@
                string
                -
                +

                Convienience public function for creating a new MySQL table

                -
                create_table(string $name, array $columns, array $constraints, array $indexes) : string
                +
                create_table(string $name, array $columns, array $constraints = array(), array $indexes = array()) : string
                @@ -150,7 +158,7 @@
                string
                -
                +

                Convience public function for droping a table

                delete_table(string $name) : string
                @@ -171,9 +179,9 @@
                + generated on 2014-02-18T15:15:22-05:00.
                diff --git a/docs/classes/ODBC.html b/docs/classes/ODBC.html index ed25873..ca281e4 100644 --- a/docs/classes/ODBC.html +++ b/docs/classes/ODBC.html @@ -49,12 +49,17 @@
                -
                +
                +
                + +
                +
                +
                • - Methods + Methods
                • - Properties + Properties
                  • » Protected @@ -73,7 +78,7 @@
                    • -\ +\
                    • \ODBC @@ -94,10 +99,10 @@

                      - Methods

                      -
                      + Methods +

                      Use ODBC to connect to a database

                      -
                      __construct(string $dsn, string $username, string $password, array $options) 
                      +
                      __construct(string $dsn, string $username = null, string $password = null, array $options = array()) 
                      @@ -120,9 +125,9 @@
                      -
                      +

                      Create sql for batch insert

                      -
                      insert_batch(string $table, array $data) : string
                      +
                      insert_batch(string $table, array $data = array()) : string
                      @@ -139,7 +144,7 @@
                      string
                      -
                      +

                      Empty the current database

                      truncate(string $table) : void
                      @@ -153,10 +158,14 @@

                      - Properties

                      - 
                      + Properties + 

                      Don't define the escape char - or define it in sub-drivers in a refactor

                      $escape_char 
                      +
                      +

                      Default

                      +
                      ''
                      +
                      @@ -166,9 +175,9 @@
                      + generated on 2014-02-18T15:15:22-05:00.
                  diff --git a/docs/classes/ODBC_SQL.html b/docs/classes/ODBC_SQL.html index aa5362c..b12e468 100644 --- a/docs/classes/ODBC_SQL.html +++ b/docs/classes/ODBC_SQL.html @@ -49,11 +49,16 @@
                  -
                  +
                  +
                  + +
                  +
                  +
                  -
                  +

                  Get the query plan for the sql query

                  explain(string $sql) : string
                  @@ -136,7 +141,7 @@
                  string
                  -
                  +

                  Return sql to list functions

                  function_list() : NULL
                  @@ -146,9 +151,9 @@
                  NULL
                  -
                  +

                  Limit clause

                  -
                  limit(string $sql, int $limit, int $offset) : string
                  +
                  limit(string $sql, int $limit, int $offset = FALSE) : string
                  @@ -169,7 +174,7 @@
                  string
                  -
                  +

                  Return sql to list stored procedures

                  procedure_list() : NULL
                  @@ -179,7 +184,7 @@
                  NULL
                  -
                  +

                  Random ordering keyword

                  random() : string
                  @@ -189,7 +194,7 @@
                  string
                  -
                  +

                  Return sql to list sequences

                  sequence_list() : NULL
                  @@ -199,7 +204,7 @@
                  NULL
                -
                +

                Returns sql to list system tables

                system_table_list() : NULL
                @@ -209,7 +214,7 @@
                NULL
            -
            +

            Returns sql to list tables

            table_list() : NULL
            @@ -219,7 +224,7 @@
            NULL
            -
            +

            Returns sql to list triggers

            trigger_list() : NULL
            @@ -229,7 +234,7 @@
            NULL
            -
            +

            SQL to show list of field types

            type_list() : NULL
            @@ -239,7 +244,7 @@
            NULL
            -
            +

            Returns sql to list views

            view_list() : NULL
            @@ -255,9 +260,9 @@
            + generated on 2014-02-18T15:15:22-05:00.
            diff --git a/docs/classes/ODBC_Util.html b/docs/classes/ODBC_Util.html index 2a18116..7e331b6 100644 --- a/docs/classes/ODBC_Util.html +++ b/docs/classes/ODBC_Util.html @@ -49,11 +49,16 @@
            -
            +
            +
            + +
            +
            +
            • - Methods + Methods
              • Save a reference to the current connection object
                __construct()
              • Create an SQL backup file for the current database's data
                backup_data()
                • @@ -66,7 +71,7 @@
                • -\ +\
                • \ODBC_Util @@ -87,18 +92,21 @@

                  - Methods

                  -
                  + Methods +

                  Save a reference to the current connection object

                  -
                  __construct($conn) : void
                  +
                  __construct(object $conn) : void

                  Parameters

                  -

                  $conn

                  +
                  +

                  $conn

                  +object +
                  -
                  +

                  Create an SQL backup file for the current database's data

                  backup_data() : string
                  @@ -108,7 +116,7 @@
                  string
                  -
                  +

                  Create an SQL backup file for the current database's structure

                  backup_structure() : string
                  @@ -118,9 +126,9 @@
                  string
                -
                +

                Database-specific method to create a new table

                -
                create_table(string $name, array $columns, array $constraints, array $indexes) : string
                +
                create_table(string $name, array $columns, array $constraints = array(), array $indexes = array()) : string
                @@ -145,7 +153,7 @@
                string
                -
                +

                Remove a table from the database

                delete_table(string $name) : string
                @@ -166,9 +174,9 @@
                + generated on 2014-02-18T15:15:22-05:00.
                diff --git a/docs/classes/PgSQL.html b/docs/classes/PgSQL.html index e267365..5aa28cb 100644 --- a/docs/classes/PgSQL.html +++ b/docs/classes/PgSQL.html @@ -49,11 +49,16 @@
            -
            +
            +
            + +
            +
            +
            diff --git a/docs/classes/PgSQL_SQL.html b/docs/classes/PgSQL_SQL.html index 7b35e33..29e70cc 100644 --- a/docs/classes/PgSQL_SQL.html +++ b/docs/classes/PgSQL_SQL.html @@ -49,11 +49,16 @@
            -
            +
            +
            + +
            +
            +
            -
            +

            Get the query plan for the sql query

            explain(string $sql) : string
            @@ -136,7 +141,7 @@
            string
            -
            +

            Return sql to list functions

            function_list() : NULL
            @@ -146,9 +151,9 @@
            NULL
            -
            +

            Limit clause

            -
            limit(string $sql, int $limit, int $offset) : string
            +
            limit(string $sql, int $limit, int $offset = FALSE) : string
            @@ -169,7 +174,7 @@
            string
            -
            +

            Return sql to list stored procedures

            procedure_list() : string
            @@ -179,7 +184,7 @@
            string
            -
            +

            Random ordering keyword

            random() : string
            @@ -189,7 +194,7 @@
            string
            -
            +

            Return sql to list sequences

            sequence_list() : string
            @@ -199,7 +204,7 @@
            string
            -
            +

            Returns sql to list system tables

            system_table_list() : string
            @@ -209,7 +214,7 @@
            string
            -
            +

            Returns sql to list tables

            table_list() : string
            @@ -219,7 +224,7 @@
            string
            -
            +

            Returns sql to list triggers

            trigger_list() : string
            @@ -229,7 +234,7 @@
            string
            -
            +

            SQL to show list of field types

            type_list() : string
            @@ -239,7 +244,7 @@
            string
            -
            +

            Returns sql to list views

            view_list() : string
            @@ -255,9 +260,9 @@
            + generated on 2014-02-18T15:15:22-05:00.
            diff --git a/docs/classes/PgSQL_Util.html b/docs/classes/PgSQL_Util.html index 8b803ec..5d112d9 100644 --- a/docs/classes/PgSQL_Util.html +++ b/docs/classes/PgSQL_Util.html @@ -49,11 +49,16 @@
            -
            +
            +
            + +
            +
            +
            -
            +
            +

            Destructor

            +
            __destruct() 
            +
            +
            +
            +

            Retreive the number of rows in the selected table

            count_all(string $table) : int
            @@ -235,10 +251,10 @@ instantiates the specific db driver

            int
            -
            +

            Retrieve the number of results for the generated query - used in place of the get() method

            -
            count_all_results(string $table) : int
            +
            count_all_results(string $table = '') : int
            @@ -251,9 +267,9 @@ in place of the get() method
            int
            -
            +

            Deletes data from a table

            -
            delete(string $table, mixed $where) : mixed
            +
            delete(string $table, mixed $where = '') : mixed
            @@ -270,7 +286,7 @@ in place of the get() method
            mixed
            -
            +

            Adds the 'distinct' keyword to a query

            distinct() : \Query_Builder
            @@ -284,7 +300,7 @@ in place of the get() method
            \Query_Builder
            -
            +

            Tell the database to give you the query plan instead of result set

            explain() : \Query_Builder
            @@ -298,7 +314,7 @@ in place of the get() method
            \Query_Builder
            -
            +

            Specify the database table to select from

            from(string $tblname) : \Query_Builder
            @@ -317,10 +333,10 @@ in place of the get() method
            \Query_Builder
            -
            +

            Select and retrieve all records from the current table, and/or execute current compiled query

            -
            get(mixed $table, int $limit, int $offset) : object
            +
            get(mixed $table = '', int $limit = FALSE, int $offset = FALSE) : object
            @@ -338,9 +354,9 @@ execute current compiled query
            object
            -
            +

            Returns the generated 'delete' sql query

            -
            get_compiled_delete(string $table, bool $reset) : string
            +
            get_compiled_delete(string $table = "", bool $reset = TRUE) : string
            @@ -357,9 +373,9 @@ execute current compiled query
            string
            -
            +

            Returns the generated 'insert' sql query

            -
            get_compiled_insert(string $table, bool $reset) : string
            +
            get_compiled_insert(string $table, bool $reset = TRUE) : string
            @@ -376,9 +392,9 @@ execute current compiled query
            string
            -
            +

            Returns the generated 'select' sql query

            -
            get_compiled_select(string $table, bool $reset) : string
            +
            get_compiled_select(string $table = '', bool $reset = TRUE) : string
            @@ -395,9 +411,9 @@ execute current compiled query
            string
            -
            +

            Returns the generated 'update' sql query

            -
            get_compiled_update(string $table, bool $reset) : string
            +
            get_compiled_update(string $table = '', bool $reset = TRUE) : string
            @@ -414,9 +430,9 @@ execute current compiled query
            string
            -
            +

            Convience method for get() with a where clause

            -
            get_where(string $table, array $where, int $limit, int $offset) : object
            +
            get_where(string $table, array $where = array(), int $limit = FALSE, int $offset = FALSE) : object
            @@ -441,7 +457,7 @@ execute current compiled query
            object
            -
            +

            Group the results by the selected field(s)

            group_by(mixed $field) : \Query_Builder
            @@ -460,7 +476,7 @@ execute current compiled query
            \Query_Builder
            -
            +

            Ends a query group

            group_end() : \Query_Builder
            @@ -474,7 +490,7 @@ execute current compiled query
            \Query_Builder
            -
            +

            Adds a paren to the current query for query grouping

            group_start() : \Query_Builder
            @@ -488,9 +504,9 @@ execute current compiled query
            \Query_Builder
            -
            +

            Generates a 'Having' clause

            -
            having(mixed $key, mixed $val) : \Query_Builder
            +
            having(mixed $key, mixed $val = array()) : \Query_Builder
            @@ -511,9 +527,9 @@ execute current compiled query
            \Query_Builder
            -
            +

            Creates an insert clause, and executes it

            -
            insert(string $table, mixed $data) : mixed
            +
            insert(string $table, mixed $data = array()) : mixed
            @@ -530,9 +546,9 @@ execute current compiled query
            mixed
            -
            +

            Create sql for batch insert

            -
            insert_batch(string $table, array $data) : string
            +
            insert_batch(string $table, array $data = array()) : string
            @@ -549,9 +565,9 @@ execute current compiled query
            string
            -
            +

            Creates a join phrase in a compiled query

            -
            join(string $table, string $condition, string $type) : \Query_Builder
            +
            join(string $table, string $condition, string $type = '') : \Query_Builder
            @@ -576,9 +592,9 @@ execute current compiled query
            \Query_Builder
            -
            +

            Creates a Like clause in the sql statement

            -
            like(string $field, mixed $val, string $pos) : \Query_Builder
            +
            like(string $field, mixed $val, string $pos = 'both') : \Query_Builder
            @@ -603,9 +619,9 @@ execute current compiled query
            \Query_Builder
            -
            +

            Set a limit on the current sql statement

            -
            limit(int $limit, int $offset) : string
            +
            limit(int $limit, int $offset = FALSE) : string
            @@ -622,9 +638,9 @@ execute current compiled query
            string
            -
            +

            Generates a NOT LIKE clause

            -
            not_like(string $field, mixed $val, string $pos) : \Query_Builder
            +
            not_like(string $field, mixed $val, string $pos = 'both') : \Query_Builder
            @@ -649,7 +665,7 @@ execute current compiled query
            \Query_Builder
            -
            +

            Adds a paren to the current query for query grouping, prefixed with 'OR'

            or_group_start() : \Query_Builder
            @@ -664,9 +680,9 @@ prefixed with 'OR'
            \Query_Builder
            -
            +

            Generates a 'Having' clause prefixed with 'OR'

            -
            or_having(mixed $key, mixed $val) : \Query_Builder
            +
            or_having(mixed $key, mixed $val = array()) : \Query_Builder
            @@ -687,9 +703,9 @@ prefixed with 'OR'
            \Query_Builder
            -
            +

            Generates an OR Like clause

            -
            or_like(string $field, mixed $val, string $pos) : \Query_Builder
            +
            or_like(string $field, mixed $val, string $pos = 'both') : \Query_Builder
            @@ -714,7 +730,7 @@ prefixed with 'OR'
            \Query_Builder
            -
            +

            Adds a paren to the current query for query grouping, prefixed with 'OR NOT'

            or_not_group_start() : \Query_Builder
            @@ -729,9 +745,9 @@ prefixed with 'OR NOT'
            \Query_Builder
            -
            +

            Generates a OR NOT LIKE clause

            -
            or_not_like(string $field, mixed $val, string $pos) : \Query_Builder
            +
            or_not_like(string $field, mixed $val, string $pos = 'both') : \Query_Builder
            @@ -756,9 +772,9 @@ prefixed with 'OR NOT'
            \Query_Builder
            -
            +

            Where clause prefixed with "OR"

            -
            or_where(string $key, mixed $val) : \Query_Builder
            +
            or_where(string $key, mixed $val = array()) : \Query_Builder
            @@ -779,9 +795,9 @@ prefixed with 'OR NOT'
            \Query_Builder
            -
            +

            Where in statement prefixed with "or"

            -
            or_where_in(string $field, mixed $val) : \Query_Builder
            +
            or_where_in(string $field, mixed $val = array()) : \Query_Builder
            @@ -802,9 +818,9 @@ prefixed with 'OR NOT'
            \Query_Builder
            -
            +

            OR WHERE NOT IN (FOO) clause

            -
            or_where_not_in(string $field, mixed $val) : \Query_Builder
            +
            or_where_not_in(string $field, mixed $val = array()) : \Query_Builder
            @@ -825,9 +841,9 @@ prefixed with 'OR NOT'
            \Query_Builder
            -
            +

            Order the results by the selected field(s)

            -
            order_by(string $field, string $type) : \Query_Builder
            +
            order_by(string $field, string $type = "") : \Query_Builder
            @@ -848,13 +864,13 @@ prefixed with 'OR NOT'
            \Query_Builder
            -
            +

            Clear out the class variables, so the next query can be run

            reset_query() : void
            -
            +

            Specifies rows to select in a query

            select(string $fields) : \Query_Builder
            @@ -873,9 +889,9 @@ prefixed with 'OR NOT'
            \Query_Builder
            -
            +

            Selects the average value of a field from a query

            -
            select_avg(string $field, string $as) : \Query_Builder
            +
            select_avg(string $field, string $as = FALSE) : \Query_Builder
            @@ -896,9 +912,9 @@ prefixed with 'OR NOT'
            \Query_Builder
            -
            +

            Selects the maximum value of a field from a query

            -
            select_max(string $field, string $as) : \Query_Builder
            +
            select_max(string $field, string $as = FALSE) : \Query_Builder
            @@ -919,9 +935,9 @@ prefixed with 'OR NOT'
            \Query_Builder
            -
            +

            Selects the minimum value of a field from a query

            -
            select_min(string $field, string $as) : \Query_Builder
            +
            select_min(string $field, string $as = FALSE) : \Query_Builder
            @@ -942,9 +958,9 @@ prefixed with 'OR NOT'
            \Query_Builder
            -
            +

            Selects the sum of a field from a query

            -
            select_sum(string $field, string $as) : \Query_Builder
            +
            select_sum(string $field, string $as = FALSE) : \Query_Builder
            @@ -965,9 +981,9 @@ prefixed with 'OR NOT'
            \Query_Builder
            -
            +

            Sets values for inserts / updates / deletes

            -
            set(mixed $key, mixed $val) : \Query_Builder
            +
            set(mixed $key, mixed $val = NULL) : \Query_Builder
            @@ -988,9 +1004,9 @@ prefixed with 'OR NOT'
            \Query_Builder
            -
            +

            Creates an update clause, and executes it

            -
            update(string $table, mixed $data) : mixed
            +
            update(string $table, mixed $data = array()) : mixed
            @@ -1007,11 +1023,11 @@ prefixed with 'OR NOT'
            mixed
            -
            +

            Specify condition(s) in the where clause of a query Note: this function works with key / value, or a passed array with key / value pairs

            -
            where(mixed $key, mixed $val, mixed $escape) : \Query_Builder
            +
            where(mixed $key, mixed $val = array(), mixed $escape = NULL) : \Query_Builder
            @@ -1036,9 +1052,9 @@ passed array with key / value pairs
            \Query_Builder
            -
            +

            Where clause with 'IN' statement

            -
            where_in(mixed $field, mixed $val) : \Query_Builder
            +
            where_in(mixed $field, mixed $val = array()) : \Query_Builder
            @@ -1059,9 +1075,9 @@ passed array with key / value pairs
            \Query_Builder
            -
            +

            WHERE NOT IN (FOO) clause

            -
            where_not_in(string $field, mixed $val) : \Query_Builder
            +
            where_not_in(string $field, mixed $val = array()) : \Query_Builder
            @@ -1082,9 +1098,9 @@ passed array with key / value pairs
            \Query_Builder
            -
            +

            String together the sql statements for sending to the db

            -
            _compile(string $type, string $table) : \$string
            +
            _compile(string $type = '', string $table = '') : \$string
            @@ -1101,7 +1117,7 @@ passed array with key / value pairs
            \$string
            -
            +

            Helper function for returning sql strings

            _get_compile(string $type, string $table, bool $reset) 
            @@ -1126,9 +1142,9 @@ passed array with key / value pairs
            -
            +

            Simplify building having clauses

            -
            _having(mixed $key, mixed $val, string $conj) : \Query_Builder
            +
            _having(mixed $key, mixed $val = array(), string $conj = 'AND') : \Query_Builder
            @@ -1153,9 +1169,9 @@ passed array with key / value pairs
            \Query_Builder
            -