PHP Class atk4\data\Field_SQL

Inheritance: extends Field, implements atk4\dsql\Expressionable
Show file Open project: atk4/data

Public Properties

Property Type Description
$actual string | null Actual field name.

Public Methods

Method Description
getDSQLExpression ( atk\dsql\Expression $expression ) : atk\dsql\Expression When field is used as expression, this method will be called.
normalize ( mixed $value ) : mixed SQL fields are allowed to have expressions inside of them.
useAlias ( ) : boolean Should this field use alias?

Method Details

getDSQLExpression() public method

When field is used as expression, this method will be called.
public getDSQLExpression ( atk\dsql\Expression $expression ) : atk\dsql\Expression
$expression atk\dsql\Expression
return atk\dsql\Expression

normalize() public method

SQL fields are allowed to have expressions inside of them.
public normalize ( mixed $value ) : mixed
$value mixed
return mixed

useAlias() public method

Should this field use alias?
public useAlias ( ) : boolean
return boolean

Property Details

$actual public property

Actual field name.
public string|null $actual
return string | null