SALT
Back to top  

DAO for information_schema.tables of mysql instances

package salt\dao
inherited_from \salt\Base

 Methods

Return a text for a field

COLUMN(string $fieldName, mixed $format = NULL) : string
InheritedStatic

Parameters

$fieldName

string

the fieldName to display

$format

mixed

(Optional, NULL) the format to use

Returns

stringViewHelper HTML protected text to display for $fieldName in $format

Return an HTML tag for modify a field value

FORM(mixed $format = NULL) : \salt\_InternalFieldAccess
Inherited

Parameters

$format

mixed

(Optional, NULL) format to use

Returns

\salt\_InternalFieldAccessan object for access registered ViewHelper

Return a text for a field value

VIEW(mixed $format = NULL) : \salt\_InternalFieldAccess
Inherited

Parameters

$format

mixed

(Optional, NULL) format to use

Returns

\salt\_InternalFieldAccessan object for access registered ViewHelper

Construct a new Identifiable object

__construct() 
Inherited

Have to be called by child classes for having an internal ID

Return the value of field or extra field of object.

__get(string $fieldName) : mixed
Inherited

Can also return an _InternalFieldAccess if $fieldName is FORM or VIEW

Parameters

$fieldName

string

Returns

mixedthe value of the field

Set a field value

__set(string $fieldName, mixed $value) 
Inherited

Parameters

$fieldName

string

the field to change

$value

mixed

the value

Check object state is not in forbidden states

checkNotState(integer|array<mixed,integer> $state, string $message = NULL) 
Inherited

Parameters

$state

integerarray<mixed,integer>

forbidden states for the object

$message

string

error message for exception

Exceptions

\Exception if the object is in one of the forbidden states

Check object state is in allowed states

checkState(integer|array<mixed,integer> $state) 
Inherited

Parameters

$state

integerarray<mixed,integer>

expected states for the object

Exceptions

\Exception if the object is not in one of the expected states

Retrieve an object by ID on a database

getById(\salt\DBHelper $db, mixed $id) : static | NULL
Inherited

Parameters

$db

\salt\DBHelper

The database to search object

$id

mixed

a value of the id field

Returns

staticNULLthe first object with this id. All fields are loaded. Return NULL if no object found

Retrieve a list of object on a database

getByIds(\salt\DBHelper $DB, array<mixed,mixed> $ids) : array<mixed,static>
Inherited

Parameters

$DB

\salt\DBHelper

database to search objects

$ids

array<mixed,mixed>

list of value to search

Returns

array<mixed,static>associative array : id => object

Retrieve a Field by field name

getField(string $fieldName, boolean $createIfNotExists = FALSE) : \salt\Field
Inherited

Parameters

$fieldName

string

field name registered with metadata() or extra field constructor parameter

$createIfNotExists

boolean

if TRUE, create extra field if not exists, throw Exception otherwise

Returns

\salt\Field

Get all Field declared in ::metadata()

getFieldsMetadata() : array<mixed,\salt\Field>
Inherited

Returns

array<mixed,\salt\Field>list of all Field metadata : fieldName => Field

Get the value of the ID field. The ID field is registered with ::registerId()

getId() : mixed
Inherited

Returns

mixedvalue of id field

Get the name of the ID field registered with ::registerId()

getIdField() : string
Inherited

Returns

stringfield name

Get the internal unique id

getInternalId() : integer
Inherited

Returns

integerUnique ID of an instance

Return all modified field since object creation

getModifiedFields() : array<mixed,mixed>
Inherited

Returns

array<mixed,mixed>fieldName => value

Create and return a new object of the same type

getNew(array<mixed,string> $extraFields = NULL) : static
Inherited

Parameters

$extraFields

array<mixed,string>

array of fieldName to add to the instance

Returns

static

Return the tablename registered with ::registerTableName()

getTableName() : string
Inherited

Returns

stringthe table name

doing some stuff after creating table

initAfterCreateTable() : array<mixed,static>
Inherited

Returns

array<mixed,static>objects to create in table

Check object is loaded from a database

isLoaded() : boolean
Inherited

Returns

booleanTRUE if the object have been loaded for a database by PDO

Check object has been modified

isModified() : boolean
Inherited

Returns

booleanTRUE if the object have been modified

Check object is new : so, not loaded from a database

isNew() : boolean
Inherited

Returns

booleanTRUE if the object have been created with a new ...()

Check object is a readonly object

isReadonly() : boolean
Inherited

Returns

booleanTRUE if the object is readonly (Base::meta() is a readonly object)

Retrieve a singleton instance for access to metadata

meta() : static
InheritedStatic

Returns

statica singleton instance of the object

Find missing tables name

missingTables(\salt\DBHelper $db, array<mixed,string> $tableNames) : array<mixed,string>
Static

Parameters

$db

\salt\DBHelper

database to use

$tableNames

array<mixed,string>

list of table name to check

Returns

array<mixed,string>list of missing tables

Make the object readonly. All changes will throw an exception.

readonly() 
Inherited

Register a child class of ViewHelper for the class

registerHelper(string $class) 
InheritedStatic

Parameters

$class

string

class name of ViewHelper that will by used in $this->VIEW/FORM/COLUMN

Register the fieldName will be returned by getId()

registerId(string $fieldName) 
InheritedStatic
see

Parameters

$fieldName

string

a field name registered in metadata()

Register the table name of the object in database

registerTableName(string $table) 
InheritedStatic

Parameters

$table

string

the table name that will be used in query generation

Register metadata of object

metadata() 

Sub classes have to implement this method for declaring all metadata

see
inherited_from \salt\Base::metadata()

Register metadata of object

metadata() : array<mixed,\salt\Field>
Inherited

Sub classes have to implement this method for declaring all metadata

see
see
see
see

Returns

array<mixed,\salt\Field>

Check a field exist

checkFieldExists(string $fieldName, boolean $forValue = FALSE, boolean $doNotThrowException = FALSE) : boolean
Inherited

Parameters

$fieldName

string

$forValue

boolean

also check field is loaded and value can be retrieve

$doNotThrowException

boolean

return FALSE if field does not exists instead of throwing exception

Exceptions

\Exception if field don't exists or is not loaded (if $forValue)

Returns

booleanTRUE if field exists

Initialize the class by calling metadata() (once by class) and setting default values (once by instance) if needed

initMetadata(array<mixed,string> $loadedFields = NULL, array<mixed,string> $extraFields = NULL) 
Inherited

Parameters

$loadedFields

array<mixed,string>

fields loaded by a query for this object

$extraFields

array<mixed,string>

fields to add to new instance only

Exceptions

\Exception if metadata() function don't return an array of Field

 Properties

 

All extra fields which are returned by a query and are not declared in metadata

$_saltExtraFields : array<mixed,mixed>

Default

array()
content array of extraFieldName => value
 

Extra fields metadata

$_saltExtraFieldsMetadata : array<mixed,\salt\Field>

Default

array()
content array of extraFieldName => Field
 

Contains values initially loaded from database or for new object (not in database)

$_saltLoadValues : array<mixed,mixed>

Default

array()
content array of fieldName => value
 

Metadata of all classes

$_saltMetadata : array<mixed,mixed>

Default

array()
Static
content 
array of class name => array(
		'fields' => array(field name => Field),
		'tablename' => table name,
		'idfield' => id field name,
		'singleton' => empty instance,
)
 

Current object state : self::STATE_*

$_saltState : integer

Default

self::STATE_NONE
 

Modified values for object loaded from database

$_saltValues : array<mixed,mixed>

Default

array()
content array of fieldName => value
 

current instance id

$_salt_id : integer

Default

 

last instance id

$_salt_id_sequence : integer

Default

0
Static

 Constants

 

State of a deleted object

STATE_DELETED = 40 
 

State of an object created and populated by PDO fetch

STATE_LOADED = 20 
 

State of an object created by PDO but not populated yet

STATE_LOADING = 21 
 

State of a modified object after being loaded by PDO

STATE_MODIFIED = 30 
 

State of a new created objet

STATE_NEW = 10 
 

State of a not initialized objet

STATE_NONE = 0 
 

A special state for objet singleton returned by meta() function. Throw an exception if a setter is called

STATE_READONLY = 50