Documentation

ConvertorRule extends Sand
in package

Description of ConvertorRule.

Tags
author

Vítězslav Dvořák info@vitexsoftware.cz

Table of Contents

$convertor  : Convertor
$rules  : array<string|int, mixed>
Summary of rules.
$addExtId  : bool
$keepCode  : bool
$keepId  : bool
__construct()  : mixed
Conversion Rule.
addExtId()  : void
Add ExtID by Original ID Into converted.
assignConvertor()  : void
convertorClassTemplateGenerator()  : string
Convertor Rule Class template Generator.
finalizeConversion()  : bool
Actions performed after converting process.
getConvertor()  : Convertor
Get Convertor used.
getOposites()  : mixed
getRuleForColumn()  : string
getRules()  : array<string|int, mixed>
Complied Rules Getter.

Properties

$rules

Summary of rules.

public array<string|int, mixed> $rules = []

Methods

__construct()

Conversion Rule.

public __construct([Convertor &$convertor = null ][, bool $keepId = false ][, bool $addExtId = false ][, bool $keepCode = false ][, bool $handleAccounting = true ]) : mixed
Parameters
$convertor : Convertor = null

Convertor Engine

$keepId : bool = false

Keep original ID in cloned document

$addExtId : bool = false

Add automatically generated ext:id based on source

$keepCode : bool = false

Keep original code: in cloned document

$handleAccounting : bool = true

set columns "ucetni" like target or ignore it

Return values
mixed

addExtId()

Add ExtID by Original ID Into converted.

public addExtId() : void
Return values
void

convertorClassTemplateGenerator()

Convertor Rule Class template Generator.

public static convertorClassTemplateGenerator(Convertor $convertor, string $className) : string
Parameters
$convertor : Convertor
$className : string
Tags
throws
Exception
Return values
string

Generated class filename

finalizeConversion()

Actions performed after converting process.

public finalizeConversion() : bool
Return values
bool

getOposites()

public static getOposites(mixed $inProps, mixed $outProps) : mixed
Parameters
$inProps : mixed
$outProps : mixed
Return values
mixed

getRuleForColumn()

public getRuleForColumn(string $columnName) : string
Parameters
$columnName : string
Return values
string

getRules()

Complied Rules Getter.

public getRules() : array<string|int, mixed>
Return values
array<string|int, mixed>

Search results