YANA 4 PHP FrameworkDocs For Class StructureFile

### Class StructureFile

#### Description

StructureFile

- access: public

Located in /includes/class_structurefile.php

    SerializeableObject
       |
       --InputStream
          |
          --SecureInputStream
             |
             --SecureFileStream
                |
                --ConfigFile
                   |
                   --SmlFile
                      |
                      --StructureFile

#### Method Summary

boolean checkRow (string $table, string &$row)
string getColumns (string $table)
array getForeignKeys (string $table)
int getLength (string $table, string $column)
string getPrimaryKey (string $table)
mixed getSource ()
mixed getStructure ()
string getTableByForeignKey (string $table, string $foreignKey)
array getTables ()
string getType (string $table, string $column)
boolean init ()
boolean isColumn (string $table, string $column)
boolean isForeignKey (string $table, string $column)
boolean isPrimaryKey (string $table, string $column)
boolean isReadonly ([string $table = ""], [string $column = ""])
boolean isStrict ()
boolean isTable (string $table)
mixed untaintInput (string $table, string $column, mixed $value, [int $escape = YANA_ESCAPE_NONE])

#### Methods

##### checkRow

boolean checkRow (string $table, string &$row)

checkRow

- access: public

Name | Type | Description
--- | --- | ---
$table | string |
&$row | string |

##### getColumns

string getColumns (string $table)

getColumns

- access: public

Name | Type | Description
--- | --- | ---
$table | string |

##### getForeignKeys

array getForeignKeys (string $table)

getForeignKeys

- access: public

Name | Type | Description
--- | --- | ---
$table | string |

##### getLength

int getLength (string $table, string $column)

getLength

- access: public

Name | Type | Description
--- | --- | ---
$table | string |
$column | string |

##### getPrimaryKey

string getPrimaryKey (string $table)

getPrimaryKey

- access: public

Name | Type | Description
--- | --- | ---
$table | string |

##### getSource

mixed getSource ()

getSource

- access: public

##### getStructure

mixed getStructure ()

getStructure

- access: public

##### getTableByForeignKey

string getTableByForeignKey (string $table, string $foreignKey)

getTableByForeignKey

- access: public

Name | Type | Description
--- | --- | ---
$table | string |
$foreignKey | string |

##### getTables

array getTables ()

getTables

- access: public

##### getType

string getType (string $table, string $column)

getType

- access: public

Name | Type | Description
--- | --- | ---
$table | string |
$column | string |

##### init

boolean init ()

init

- access: public

Redefinition of:

SmlFile::init()
  init

##### isColumn

boolean isColumn (string $table, string $column)

isColumn

- access: public

Name | Type | Description
--- | --- | ---
$table | string |
$column | string |

##### isForeignKey

boolean isForeignKey (string $table, string $column)

isForeignKey

- access: public

Name | Type | Description
--- | --- | ---
$table | string |
$column | string |

##### isPrimaryKey

boolean isPrimaryKey (string $table, string $column)

isPrimaryKey

- access: public

Name | Type | Description
--- | --- | ---
$table | string |
$column | string |

##### isReadonly

boolean isReadonly ([string $table = ""], [string $column = ""])

isReadonly

- access: public

Name | Type | Description
--- | --- | ---
$table | string |
$column | string |

##### isStrict

boolean isStrict ()

isStrict

- access: public

##### isTable

boolean isTable (string $table)

isTable

- access: public

Name | Type | Description
--- | --- | ---
$table | string |

##### untaintInput

mixed untaintInput (string $table, string $column, mixed $value, [int $escape = YANA_ESCAPE_NONE])

untaintInput

- access: public

Name | Type | Description
--- | --- | ---
$table | string |
$column | string |
$value | mixed |
$escape | int |

#### Inherited Methods

Inherited From SmlFile

> SmlFile::exists()
> SmlFile::get()
> SmlFile::init()
> SmlFile::insert()
> SmlFile::length()
> SmlFile::remove()
> SmlFile::set()

Inherited From ConfigFile

> ConfigFile::exists()
> ConfigFile::get()
> ConfigFile::init()
> ConfigFile::insert()
> ConfigFile::length()
> ConfigFile::remove()
> ConfigFile::reset()
> ConfigFile::set()
> ConfigFile::toString()

Inherited From SecureFileStream

> SecureFileStream::create()
> SecureFileStream::delete()
> SecureFileStream::failSafeWrite()
> SecureFileStream::insert()
> SecureFileStream::is_writeable()
> SecureFileStream::length()
> SecureFileStream::remove()
> SecureFileStream::write()

Inherited From SecureInputStream

> SecureInputStream::checksum()
> SecureInputStream::failSafeRead()
> SecureInputStream::get()
> SecureInputStream::isEmpty()
> SecureInputStream::read()
> SecureInputStream::reset()
> SecureInputStream::toString()

Inherited From InputStream

> InputStream::InputStream()
> InputStream::exists()
> InputStream::get()
> InputStream::getFilename()
> InputStream::isEmpty()
> InputStream::read()
> InputStream::resetStats()
> InputStream::toString()

Inherited From SerializeableObject

> SerializeableObject::serialize()
> SerializeableObject::toString()

Documentation generated on Sat, 16 Sep 2006 17:06:10 +0200 by phpDocumentor 1.3.0RC4

yana author: Thomas Meyerwww.all-community.de/pub