CRM_Core_CodeGen_DAO

class CRM_Core_CodeGen_DAO extends CRM_Core_CodeGen_BaseTask

Create DAO ORM classes.

Properties

protected CRM_Core_CodeGen_Main $config from CRM_Core_CodeGen_BaseTask
protected $tables from CRM_Core_CodeGen_BaseTask
string $name

Methods

__construct(CRM_Core_CodeGen_Main $config, string $name, string $tsFunctionName = 'ts')

CRM_Core_CodeGen_DAO constructor.

setConfig(object $config)

TODO: this is the most rudimentary possible hack. CG config should eventually be made into a first-class object.

from CRM_Core_CodeGen_BaseTask
bool
needsUpdate()

No description

static string|NULL
extractRegex(string $file, string $regex)

Extract a single regex from a file.

from CRM_Core_CodeGen_BaseTask
bool
isApproxPhpMatch($actual, $expected)

Determine if two snippets of PHP code are approximately equivalent.

from CRM_Core_CodeGen_BaseTask
run()

Run generator.

string
getRaw()

Generate the raw PHP code for the DAO.

string
getRelFileName()

Get relative file name.

string
getAbsFileName()

Get the absolute file name.

string
getTableChecksum()

Get a unique signature for the table/schema.

Details

at line 36
__construct(CRM_Core_CodeGen_Main $config, string $name, string $tsFunctionName = 'ts')

CRM_Core_CodeGen_DAO constructor.

Parameters

CRM_Core_CodeGen_Main $config
string $name
string $tsFunctionName

in CRM_Core_CodeGen_BaseTask at line 27
setConfig(object $config)

TODO: this is the most rudimentary possible hack. CG config should eventually be made into a first-class object.

Parameters

object $config

at line 46
bool needsUpdate()

Return Value

bool TRUE if an update is needed.

in CRM_Core_CodeGen_BaseTask at line 50
static protected string|NULL extractRegex(string $file, string $regex)

Extract a single regex from a file.

Parameters

string $file File name
string $regex A pattern to match. Ex: "foo=([a-z]+)".

Return Value

string|NULL The value matched.

in CRM_Core_CodeGen_BaseTask at line 75
protected bool isApproxPhpMatch($actual, $expected)

Determine if two snippets of PHP code are approximately equivalent.

This includes exceptions to equivalence for (a) whitespace and (b) the token "GenCodeChecksum".

This is useful for determining if someone has manually mucked with one the files. However, it's not perfect -- because whitespace changes are not detected. Hence, it's good to use in combination with another heuristic.

Parameters

$actual
$expected

Return Value

bool

at line 63
run()

Run generator.

at line 89
string getRaw()

Generate the raw PHP code for the DAO.

Return Value

string

at line 111
string getRelFileName()

Get relative file name.

Return Value

string

at line 120
string getAbsFileName()

Get the absolute file name.

Return Value

string

at line 132
protected string getTableChecksum()

Get a unique signature for the table/schema.

Return Value

string