Titan Framework: Native Classes Reference
\

\ApiEntity

Load XML definitions files and instanciate a API Entity artefact.

This class derivate (but not extends) the class Form for appliance on REST-Like API bus.

Summary

Methods
Properties
Constants
__construct()
getFile()
getTable()
setTable()
getPrimary()
getCodeColumn()
useCode()
getFields()
getId()
setId()
getCode()
setCode()
getField()
takeOutField()
getFieldByColumn()
recovery()
load()
save()
delete()
getResume()
json()
getNextKey()
toApi()
fromApi()
$fields
No constants found
No protected methods found
$file
$primary
$itemId
$codeColumn
$code
$table
N/A
No private methods found
No private properties found
N/A

Properties

$fields

$fields :

Type

$file

$file :

Type

$primary

$primary :

Type

$itemId

$itemId :

Type

$codeColumn

$codeColumn :

Type

$code

$code :

Type

$table

$table :

Type

Methods

__construct()

__construct()

getFile()

getFile()

getTable()

getTable()

setTable()

setTable(  $table)

Parameters

$table

getPrimary()

getPrimary()

getCodeColumn()

getCodeColumn()

useCode()

useCode()

getFields()

getFields()

getId()

getId()

setId()

setId(  $itemId)

Parameters

$itemId

getCode()

getCode()

setCode()

setCode(  $code)

Parameters

$code

getField()

getField(  $assign = FALSE)

Parameters

$assign

takeOutField()

takeOutField(  $assign)

Parameters

$assign

getFieldByColumn()

getFieldByColumn(  $column)

Parameters

$column

recovery()

recovery(  $data = FALSE)

Parameters

$data

load()

load(  $id,   $ownerOnly = FALSE,   $user = NULL)

Parameters

$id
$ownerOnly
$user

save()

save(  $user,   $id = NULL)

Parameters

$user
$id

delete()

delete(  $id = NULL,   $permanent = TRUE,   $ownerOnly = FALSE,   $user = NULL)

Parameters

$id
$permanent
$ownerOnly
$user

getResume()

getResume(  $friendly = FALSE)

Parameters

$friendly

json()

json()

getNextKey()

getNextKey(  $array)

Parameters

$array

toApi()

toApi(  $field,   $itemId = NULL)

Parameters

$field
$itemId

fromApi()

fromApi(  $field,   $value)

Parameters

$field
$value