Class: ABSTDatabaseTable

Source Location: /databases/ABSTDatabaseTable.class.php

Class Overview

Author(s):

Daniel Plücken <daniel@debakel.net>

Version:

0.1.85

Copyright:

Copyright (C) 2004 Daniel Plücken <daniel@debakel.net>
This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License.
This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

Variables

Methods

Child classes:

MySQLDatabaseTable

Class Details

[line 38]

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	0.1.85
copyright:	Copyright (C) 2004 Daniel Plücken <daniel@debakel.net> This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
abstract:
license:	GNU Lesser General Public License

[ Top ]

Class Variables

$auto_increment_field = null

[line 137]

Holds the fieldname of the auto increment Column.

Tags:

access:

private

Type:

string

[ Top ]

$fieldname = array()

[line 67]

Carries the fieldnames of this databasetable.

Tags:

access:

public

Type:

array

[ Top ]

$field_can_be_null = array()

[line 81]

Carries the field properties whether they can be NULL.

Tags:

access:

public

Type:

array

[ Top ]

$field_flags_stored = false

[line 102]

Will be set to true if the field flags become stored.

Tags:

access:

private

Type:

boolean

[ Top ]

$field_has_auto_increment = array()

[line 95]

Carries the field properties whether they have auto increment.

Tags:

access:

public

Type:

array

[ Top ]

$field_is_primary_member = array()

[line 88]

Carries the field properties whether they are a member of a primary key.

Tags:

access:

public

Type:

array

[ Top ]

$field_names_stored = false

[line 74]

Will be set to true if the fieldnames become stored.

Tags:

access:

private

Type:

boolean

[ Top ]

$insert_id = null

[line 123]

Stores the last insert id of the underlying database table.

Tags:

access:

public

Type:

integer

[ Top ]

$last_query =

[line 116]

Stores the last query made to the underlying database table.

Tags:

access:

public

Type:

string

[ Top ]

$name =

[line 46]

The name of the databasetable.

Tags:

access:

public

Type:

string

[ Top ]

$overruled_fieldnames = false

[line 144]

Shows whether the fieldnames are overruled.

Tags:

access:

private

Type:

boolean

[ Top ]

$parent =

[line 109]

Refers to the database in which this relation lies.

Tags:

access:

private

Type:

Database

[ Top ]

$primary_key = null

[line 130]

Holds the field members of the primary key of this table object.

Tags:

access:

private

Type:

array

[ Top ]

Class Methods

constructor ABSTDatabaseTable [line 156]

void ABSTDatabaseTable(
)

Fake-Constructor

Tags:

version:	1.0
since:	0.1.3
access:	public

[ Top ]

method addField [line 342]

void addField(

&$obj_ref, object
$obj_ref)

Adds a field's reference to this object of a database table.

Tags:

version:	1.0
since:	0.1.2
access:	public

Parameters:

object	$obj_ref
	&$obj_ref

[ Top ]

method addFieldname [line 358]

void addFieldname(
string
$string)

Adds a field's reference to this object of a database table.

Tags:

version:	1.0
since:	0.1.2
access:	public

Parameters:

string

$string

[ Top ]

method addJoin [line 301]

void addJoin(

&$obj_ref, object
$obj_ref)

Adds a join's reference to this object of a database table.

Tags:

version:	1.0
since:	0.1.4
access:	public

Parameters:

object	$obj_ref	Should be a reference of a join object.
	&$obj_ref

[ Top ]

method getFieldnames [line 386]

array getFieldnames(
)

Returns the table's fieldnames.

Tags:

version:	1.0
since:	0.1.2
access:	public

Overridden in child classes as:

MySQLDatabaseTable::getFieldnames(): Returns the table's fieldnames. If you want you can get the fieldnames enclosed in backticks.

[ Top ]

method getInsertID [line 443]

integer &getInsertID(
)

Returns the last insert id that was made to the underlying database table.

Tags:

version:	1.0
since:	0.1.82
access:	public

[ Top ]

method getLastQuery [line 400]

array getLastQuery(
)

Returns the last stored database query.

Tags:

version:	1.0
since:	0.1.1
access:	public

[ Top ]

method getName [line 372]

string getName(
)

Returns the name of the database table.

Tags:

version:	1.0
since:	0.1.0
access:	public

[ Top ]

method getParent [line 414]

Database &getParent(
)

Returns the parent object of this object.

Tags:

version:	1.0
since:	0.1.2
access:	public

[ Top ]

method getPrimaryKey [line 459]

void getPrimaryKey(
)

This method has to be implement in a subclass!

Tags:

version:	1.0
abstract:
since:	0.1.85
access:	public

Overridden in child classes as:

MySQLDatabaseTable::getPrimaryKey(): Returns all field members of the primary key of this database table.

[ Top ]

method getResourceID [line 428]

object &getResourceID(
)

Returns the id of the connection resource to the database host.

Tags:

version:	1.0
since:	0.1.81
access:	public

[ Top ]

method setName [line 244]

void setName(
string
$string)

Sets the name of the databasetable.

Tags:

version:	1.0
since:	0.1.0
access:	public

Parameters:

string

$string

The name the database table should get.

[ Top ]

method setParent [line 260]

void setParent(

&$obj_ref, string
$obj_ref)

Sets the parent of this object.

Tags:

version:	1.1
since:	0.1.2
access:	public

Parameters:

string	$obj_ref	Should be a reference of a database object.
	&$obj_ref

[ Top ]

method __contructor [line 178]

ABSTDatabaseTable __contructor(
[string
$name = ""], string
$kind, [Database
$parent = ""])

Constructor

Tags:

version:	1.2
since:	0.1.3
access:	public

Parameters:

string	$name
string	$kind
Database	$parent

[ Top ]

Documentation generated on Thu, 05 Jun 2008 19:09:42 +0200 by phpDocumentor 1.4.1