PhpMyObject
[ class tree: PhpMyObject ] [ index: PhpMyObject ] [ all elements ]

Class: PMO_Table

Source Location: /fichiers/v0.15/PMO_core/PMO_Table.php

Interface Overview


This interface defines the methods a class must implement to provide a working table class capable of describing and working with a database table.


Author(s):

Methods



Class Details

[line 50]
This interface defines the methods a class must implement to provide a working table class capable of describing and working with a database table.



Tags:

see:  PMO_MyTable


[ Top ]


Class Methods


method get [line 170]

void get( $attributename)

return an attribute in the datastructure of object array is attribute => value



Tags:

throws:  Exception
access:  public


Parameters:

   $attributename  

[ Top ]

method getAutoincrement [line 73]

string|NULL getAutoincrement( )

retrieves the autoincrement field if it exists and returns it



Tags:

access:  public


[ Top ]

method getClassname [line 192]

FALSE getClassname( )

return the class name used to instanciate a PMO_Object corresponding to this PMO_Table



Tags:

access:  public


[ Top ]

method getColumns [line 125]

array getColumns( )

retrieve an array that contains all the name of the columns of the table [0]=>nameofcolumn



Tags:

throws:  Exception
access:  public


[ Top ]

method getFk [line 108]

array|FALSE getFk( )

retrieve all the foreign key of the object and return them in an array



Tags:

access:  public


[ Top ]

method getPerm [line 142]

string getPerm( $attributename)

return Perm of an attribute r=read, w=write



Tags:

throws:  Exception
access:  public


Parameters:

   $attributename  

[ Top ]

method getPk [line 82]

array getPk( )

retrieve all the primary key of the object and return them in an array



Tags:

throws:  Exception
access:  public


[ Top ]

method getTableName [line 58]

string getTableName( )

retrieve the tablename of the object



Tags:

throws:  Exception
access:  public


[ Top ]

method isPk [line 65]

boolean isPk( $pk)

check if the column is a primary key or not



Tags:

access:  public


Parameters:

   $pk  

[ Top ]

method issetAttribute [line 184]

boolean issetAttribute( $attributename)

check if an attribute exist or not in the table_alias



Tags:

access:  public


Parameters:

   $attributename  

[ Top ]

method persist [line 211]

TRUE persist( )

create a PMO_MyTable_xxx class at the first execution time, and flush it to the disk.

This class describe the data structure of tables, their primary keys, columns aliases and the class name to used to instanciate the PMO_Object.




Tags:

access:  public


[ Top ]

method set [line 199]

void set( $attributevalue)

set the attribute "Field" with a value



Tags:

access:  public


Parameters:

array   $attributevalue  

[ Top ]

method setFk [line 100]

void setFk( $attributename, $array)

set the forein keys of object with an array

array($tablename=>$keyname)

return void




Tags:

access:  public


Parameters:

   $attributename  
array   $array  

[ Top ]

method setPerm [line 148]

void setPerm( $attributename, $value)

set Perm of an attribute r=read, w=write



Tags:

throws:  Exception
access:  public


Parameters:

   $attributename  
   $value  

[ Top ]

method setPermForAll [line 153]

void setPermForAll( $value)

set Perm for all attributes r=read, w=write



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setPk [line 90]

void setPk( $attributename)

set the primary keys of object with an array

return void




Tags:

access:  public


Parameters:

   $attributename  

[ Top ]

method setTableName [line 115]

void setTableName( $tablename)

set the tablename of the object



Tags:

access:  public


Parameters:

   $tablename  

[ Top ]


Documentation generated on Wed, 15 Oct 2008 09:18:10 -0400 by phpDocumentor 1.4.1