-
$access_method
-
Access method, eg. btree, hash etc.
-
$activated
-
True if maintainer has been activated
-
$affectedrowcount
-
Number of rows affected by query
-
$args
-
Arguments to pass to the function
-
$arg_types
-
-
addcolumn
-
Return SQL which will create a column in this table. The $column passed in is actually a field object.
-
addcolumn
-
Return SQL which will create a column in this table. The $column passed in is actually a field object.
-
addconstraint
-
Add a constraint to the schema information.
-
addfield
-
Add a field to the table.
-
addfunction
-
Add a function to the schema information.
-
addsequence
-
Add a sequence to the schema information.
-
addtable
-
Add a table to the schema information.
-
addtrigger
-
Add a trigger to the schema information.
-
add_database
-
Constructor Add a new base to our list of datasources. The dbtype and the name are the only mandatory parameters.
-
affectedrows
-
Return the number of rows affected by a query.
-
affectedrows
-
This method must be defined in the child class.
-
ALL
-
Run getchema() in recusrive mode - follow foreign keys
-
autosequence
-
Auto-detect sequences for integer fields. The technique is to assume sequences are named after the field in the form: 'seq_{fieldname}' and if so then this sequence is associated with the given field named {fieldname}.
-
$cache
-
Sequence cache size
-
$cksrc
-
Check constraint source
-
$clustered
-
True if index is clustered
-
$connected
-
Flag true if database was connected ok
-
$constraints
-
-
$constraints
-
Array of constraints on this table
-
$constraints
-
-
$current_row
-
An array containing the current DB row
-
$current_row
-
Current record/row
-
capable_of
-
Return database capabilities. There are specific capabilities which the diff code needs to query, and this method should be overridden in the specific database module to answer those questions.
-
capable_of
-
Return database capabilities. There are specific capabilities which the diff code needs to query, and this method should be overridden in the specific database module to answer those questions.
-
clear
-
Clear query - Wipe all of the current query definitions.
-
commit
-
Commit a DB transaction
-
commit
-
Commit open database transaction
-
commit
-
Commit the currently open database transaction.
-
connect
-
Connects to the database which has been selected in the mode specified, or non-peristent otherwise.
-
connect
-
This method must be defined in the child class.
-
connected
-
Returns connected status of named database, or the currently selected one if no name given.
-
constraints_match
-
Return true if field constraints match those passed in.
-
constraint_exists
-
Returns true if named constraint exists.
-
convert_boolean_syntax
-
Make conversions of boolean syntax found in the SQL string and return the 'standardised' SQL. This assumes that Axyl SQL will be written in the form 'WHERE foo=TRUE'.
-
create
-
-
create
-
Return SQL to create this field in a table. This represents a portion of the CREATE TABLE script pertaining to this field and it comprises field name, type, and constraints.
-
create
-
-
create
-
Return SQL required to create this trigger.
-
create
-
Return the SQL which will create this table.
-
create
-
Return SQL required to create this index.
-
create
-
Return SQL required to create this constraint outside the table
-
create
-
Return Postgres SQL required to create this sequence.
-
create
-
Return SQL required to create this index.
-
create
-
Return the SQL which will create this Postgres table.
-
create
-
Return SQL required to create this trigger.
-
create
-
Return SQL required to create this function.
-
create_constraints
-
Return SQL to create all constraints for this field..
-
create_constraints
-
Return the SQL which will create the constraints on this table.
-
create_indexes
-
Return the SQL which will create the indexes on this table.
-
create_inline
-
Return SQL required to create this as an inline table constraint
-
current_sequencevalue
-
Return the current sequence value, given a sequence name, the table and the field it applies to.
-
current_sequencevalue
-
Return the current sequence value, given a sequence name, the table and the field it applies to.
-
current_sequencevalue
-
Get the current sequence value.
-
$database
-
The name of the database containing the table
-
$database
-
An array of database objects. All databases we can use as datasources
-
$database_version
-
-
$dbid
-
Unique identifier for database access
-
$db_name_default
-
Default database name
-
$db_name_selected
-
Name of currently selected database
-
$defaultval
-
-
$deferrable
-
True if constraint is deferrable
-
$deferred
-
True if constraint is initially deferred
-
$delete_action
-
Action to take on delete
-
$detail_tables
-
Array of detail tables. Master-detail relationship.
-
$do_autosequence
-
If true we auto-detect sequences for integer fields,
-
database
-
Define a database. This is a parent class to all of the supported
-
database
-
Constructor
-
database-defs.php
-
-
datasources
-
Constructor
-
datasources
-
Datasources A datasources class is just a bunch of databases. If you want to access a database, register it in here first, then you can select it to perform queries on later.
-
db-mssql-server.php
-
-
db-mysql.php
-
-
db-odbc.php
-
-
db-oracle.php
-
-
db-postgres.php
-
-
dbcommand
-
Execute a DB command
-
dbconstraint
-
Defines a database constraint.
-
dbconstraint
-
-
dbdelete
-
Constructor Create a new DB Delete object.
-
dbdelete
-
DB Delete class A special case of the dbquery class. This is for deleting rows from the database.
-
dbfield
-
-
dbfield
-
Class describing a database field of a table.
-
dbfunction
-
-
dbfunction
-
Defines a database function (procedure).
-
dbid
-
Returns the database resource ID of the given database name.
-
dbindex
-
Defines a database index.
-
dbindex
-
-
dbinsert
-
DB Insert class A special case of the dbtablemod class.
-
dbinsert
-
Constructor Create a new DB Insert object. This is for inserting a record into the database.
-
dbquery
-
DB Query class This class is the one which executes queries against the connected database.
-
dbquery
-
Constructor Create a new DB Query object.
-
dbrecords
-
DB Records class Renders a query into data and allows access to the data either directly or via the usual get first,last,next,previous cursor navigation.
-
dbrecords
-
Constructor Create a new DB Records object.
-
dbrecordset
-
A wrapper which caters for queries which will return a record set identifier for returning data.
-
dbrows
-
Constructor Create a new DB Rows object.
-
dbrows
-
DB Rows class Renders a query into data and allows access to the data either directly or via the usual get first,last,next,previous cursor navigation.
-
dbselect
-
Constructor Create a new DB Select object. This is for selecting rows from the database, and returning fields from those rows.
-
dbselect
-
DB Select class A special case of the dbrecords class.
-
dbseq
-
DB seq class A class which allows the management and use of sequences.
-
dbseq
-
Create a new object to manage a sequence, optionally specifying the sequence name..
-
dbsequence
-
Defines a database sequence.
-
dbsequence
-
-
dbtable
-
Construct a table of given name and array of primary key fields.
-
dbtable
-
Class describing a database table.
-
dbtablemod
-
Constructor Create a new DB Insert object. This is for inserting a record into the database.
-
dbtablemod
-
DB tablemod class Parent class for classes which only modify a single table. This means either update or inserts. This class is provided so we can define a common method for sequence definition.
-
dbtrigger
-
Defines a database trigger.
-
dbtrigger
-
-
dbtype
-
Returns the database type of the given database name.
-
dbupdate
-
DB Update class A special case of the dbquery class. This is for updating data in particular rows in the database.
-
dbupdate
-
Constructor Create a new DB Select object.
-
DB_dbconstraint
-
Defines a database constraint.
-
DB_dbconstraint
-
-
DB_dbfield
-
-
DB_dbfield
-
Class describing a database field of a Postgres table.
-
DB_dbfunction
-
-
DB_dbfunction
-
Defines a database function (procedure).
-
DB_dbindex
-
-
DB_dbindex
-
Defines a database index.
-
DB_dbsequence
-
-
DB_dbsequence
-
Defines a database sequence.
-
DB_dbtable
-
Construct a table of given name and array of primary key fields.
-
DB_dbtable
-
Class describing a Postgres database table. Inherits the standard dbtable class properties and methods, but adds in the getschema specifics for acquiring Postgres table info from the metadata, and provides a specific create() method.
-
DB_dbtrigger
-
-
DB_dbtrigger
-
Defines a database trigger.
-
DB_schema
-
Class describing a Postgres database schema.
-
DB_schema
-
Create a schema (database) of given name. The name should be a valid existing database name that is currently connected.
-
db_value_from_bool
-
Return a suitable database field value to contain the value for the given boolean.
-
db_value_from_bool
-
Return a suitable database field value to contain the value for the given boolean.
-
DEFAULT_DATASOURCE
-
Default datasource for queries @see add_database()
-
detail_table
-
Associates a detail table with the maintained table. This defines
-
diff
-
Produce the SQL required to morph the schema described in the passed dbschema object $db, into the schema we have in this current object.
-
disable_autosequence
-
Specify that the maintainer should not auto-detect sequences which
-
disconnect
-
Disconnect the currently selected database.
-
disconnect
-
This method must be defined in the child class.
-
drop
-
-
drop
-
-
drop
-
Return SQL to drop this function.
-
drop
-
-
drop
-
Return the SQL to drop this table.
-
drop
-
-
drop
-
-
drop
-
-
drop
-
Return the SQL to drop this field.
-
dropcolumn
-
Return SQL to drop a column from the table. The $column passed is actually a field object.
-
dump
-
Dump this entire schema description to stdout.
-
dump
-
Dump ascii description of this trigger to stdout.
-
dump
-
Dump ascii description of this function to stdout.
-
dump
-
Dump ascii description of this constraint to stdout.
-
dump
-
Dump field description to stdout.
-
dump
-
Dump field description to stdout.
-
dump
-
Dump ascii description of this index to stdout.
-
dump
-
-
dump
-
Dump the table description to stdout.
-
$groupby
-
The GROUP BY clause
-
generic_type
-
Return the generic type of the field. The generic types are as
-
generic_type
-
Return the generic type of the field. The generic types are as
-
getconstraint
-
Returns constraint object of given name
-
getfield
-
Returns field object of given name
-
getfieldbynum
-
Returns field object of given attnum (order number)
-
getfieldnum
-
Returns field number of given field name
-
getfunction
-
Returns function object of given name
-
getfunctions
-
Populates our array of functions with all user functions in this schema.
-
getindex
-
Returns index object of given name
-
getkeyfieldnames
-
Returns list of names of keyfields as array
-
getlabelfield
-
Returns a candidate label field name according to some fairly simple heuristics. This would be a field suitable for displaying in a listbox which is somewhat more informative than a keyfield. If nothing is found then the key is used as fallback.
-
getnonkeyfieldnames
-
Returns list of names of non-keyfields as array
-
getschema
-
Acquires the schema from database metadata.
-
getschema
-
Acquire all of the schema details.
-
getschema
-
Acquires the schema from database metadata.
-
getschema
-
Acquires the schema from database metadata.
-
getschema
-
Acquires the schema from database metadata.
-
getschema
-
Acquires the schema from database metadata.
-
getschema
-
Acquires the schema from database metadata.
-
getschema
-
Get schema info for sequence
-
getschema
-
Acquires the table fields and constraints which apply to it.
-
getschema
-
Obtain index schema information.
-
getschema
-
Obtain function schema information.
-
getschema
-
Obtain trigger schema information.
-
getschema
-
Obtain constraint schema information.
-
getschema_table
-
Acquire the schema details of a specific database table. This method is provided to cater for the common requirement of acquiring details for a specific table, without having to endure the overhead of reading all of the database schema metadata to get it.
-
getschema_table
-
Acquire the schema details of a specific Postgres table. This method is provided to cater for the common requirement of acquiring details for a specific table, without having to endure the overhead of reading all of the database schema metadata to get it.
-
getsequence
-
Returns seqeuence object of given name
-
getsequences
-
Populates schema sequences.
-
getsequences
-
Populates our array of sequences with all user sequences in this schema.
-
gettable
-
Returns table object of given name
-
gettables
-
Populates our array of tables with all tables in this schema.
-
gettables
-
Populates schema tables.
-
gettrigger
-
Returns trigger object of given name
-
gettriggers
-
Populates schema triggers.
-
gettriggers
-
Populates our array of triggers with all user triggers in this schema.
-
getversion
-
Acquire the database version.
-
getversion
-
Acquire the Postgres database version. We make some gross assumptions here with regard to standard local Postgres setup. Change as necessary.
-
get_current
-
Get current row If current query is invalid, try to execute it first, then do a get_first(). If query is then valid, return the current row.
-
get_first
-
Get current row If current query is invalid, try to execute it first, then do a get_first(). If query is then valid, return the current row.
-
get_last
-
Get last row If current query is invalid, try to execute it first, then get the last row from the resultset.
-
get_last_sql
-
Returns SQL statement most recently executed on the current DB.
-
get_next
-
Get next row If current query is invalid, try to execute it first, then get the next row from the resultset.
-
get_next_sequencevalue
-
A wrapper to get the next sequence value from a named sequence..
-
get_previous
-
Get previous row If current query is invalid, try to execute it first, then get the previous row from the resultset.
-
get_row
-
Get row Return the given database row from the resultset. Uses the get_row_raw() method applicable to this class.
-
groupby
-
Define group by field list The fields can be an array, or a delimited list. If the latter, then default delimiter is a comma, unless you specify your own.
-
$schema
-
Database schema
-
$schema
-
Reference to the schema object this belongs to
-
$sequencename
-
The name of the sequence
-
$sequences
-
-
$show_recfilter
-
If true we include a built-in record filter
-
$show_statusbar
-
If true, status bar is displayed
-
$sql
-
The formatted SQL query itself @see build()
-
$src
-
-
$start
-
Sequence start
-
$strict
-
-
schema
-
Class describing a database schema. This object hold ALL the information
-
schema
-
Create a schema (database) of given name. The name should be a valid existing database name that is currently connected. It will be selected to ensure the correct data is obtained.
-
schema-defs.php
-
-
SchemaObject
-
Constructor Every schema object must belong to a schema. This is passed as the first argument, as an object reference. It must also have a name, and this is always passed as the second argument, a string.
-
SchemaObject
-
Defines a virtual object which is used to denote something which is a part of an existing database schema.
-
select
-
This will connect it if it isn't already connected. Calling this with no database name will select the default one. Returns the database unique identifier, or false if none was selected.
-
set
-
Set the vars for this function
-
set
-
Set constraint variables.
-
set
-
Define field assignments Defines the field assignment clauses for UPDATE and INSERT queries.
-
set
-
Set the vars for this trigger
-
set
-
Set index variables.
-
setdefault
-
Return SQL to set the default for given field on this table.
-
setnullconstraint
-
Return SQL to set the NULL/NOT NULL constraint..
-
setnullconstraint
-
Return SQL to set the NULL/NOT NULL constraint..
-
set_allowed_groups
-
Restrict access. Use this method to restrict maintainer access to the specified group membership. This will cause the RESPONSE to be sent without any content.
-
set_char_encoding
-
This method must be defined in the child class.
-
set_char_encoding
-
Set the database character encoding. This affects the encoding of characters in the database.
-
set_datestyle
-
This method must be defined in the child class.
-
set_datestyle
-
Set the database date style. This affect the format that dates will be displayed in, and the format they are submitted in.
-
set_datetimeformat
-
Sets a datetime format string for a specified field. This influences the formatting of displayed dates and/or times in that field.
-
set_dbversion
-
Set the database version
-
set_default
-
Internal function to set the name of the default database.
-
set_disabledfields
-
Specify that the given fields should be disabled, not editable. Field is seen on screen, but is not modifiable.
-
set_encrypted_passwords
-
Whether passwords are encrypted or not. If true then we just apply the standard MD5 algorithm to the content.
-
set_fieldblurb
-
Associates a string of text 'blurb' with the field. This will be presented just sitting below the field as explanatory text.
-
set_fieldcss
-
Sets the CSS style/class for a field.
-
set_fielddisplayproc
-
Associates a function with the field which will be called when data is displayed to format the content. Only really useful for text/memo/numeric fields. The function should accept a string content parameter, and return the re-formatted string content.
-
set_fieldlabel
-
Sets the label of the field, which then takes the place of the default naming which uses a proper-cased version of the field name, with underscores replaced by spaces.
-
set_fieldpostproc
-
Associates a function with the field which will be called when data is POSTed to format the content. Only really useful for text/memo/numeric fields. The function should accept a string content parameter, and return the re-formatted string content.
-
set_fieldsequence
-
Associates a named sequence with a field. This is so we can create new records using that sequence to populate the record field.
-
set_fieldsize
-
Sets the size of the field in pixels, width x height
-
set_fieldtexttype
-
Sets the type of a text field. This is a generic type and the
-
set_formenctype
-
Specify the maintainers form encoding type. This will enable us to use file upload fields within the maintainer.
-
set_formfieldwidget
-
Use given user interface element for maintaining specified table field.
-
set_formname
-
Set the name of the form we should use. Sometimes this is useful when other entities are using the same form.
-
set_hiddenbuttons
-
Specify that the given buttons should be hidden. BY default all the usual buttons are available. This method allows you to list those which should NOT be shown. Possible button names are: 'save', 'reset', 'add', 'remove', 'cancel', 'refresh'.
-
set_hiddenfields
-
Specify that the given fields should be hidden, not editable. Value will be submitted on POST (save) via hidden field in form.
-
set_labelfields
-
Associates a list of fieldnames on a table to use as the label for a drop-down select reference. This is mainly so you can specify meaningful label strings for drop-down selects on foreign keyed fields, although it will work on any table, not just FKs.
-
set_nonblankfields
-
Specify that the given field should be non-blank. This causes a check to be made on form submit and if any field is empty (nullstring) then a warning message is displayed and submit is prevented.
-
set_omittedfields
-
Specify that the given field should be omitted from the form
-
set_sequencevalue
-
Set a sequence value.
-
set_sequencevalue
-
This method must be defined in the child class.
-
set_sequencevalue
-
Set the sequence value, given a sequence name, the table and the field it applies to.
-
set_sql
-
Set the SQL statement In this case we re-execute the SQL automatically.
-
set_sql
-
Set the SQL statement
-
set_title
-
Set the title of this maintainer. The default is derived from the name of the maintained table, with 'Maintenance' appended. Otherwise set your own title using this method.
-
set_viewonlyfields
-
Specify that the given field should be displayed on the form as text (view-only) but will not be submitted with the form.
-
SQL
-
Given an Axyl SQL query object, build the SQL string from it in suitable format for the currently connected database server.
-
SQL
-
Given an Axyl SQL query object, build the SQL string from it in suitable format for the currently connected database server.
-
sqlquery
-
SQLquery class An SQL Statement Text Container.
-
sqlquery
-
Constructor Create a new SQL Query object.
-
start_transaction
-
Start a DB transaction. Alias for begin_transaction()