Class ClassBuilder in namespace com\setasign\Konquadrat\Config\Builder in Konquadrat API Reference

Index

\com\setasign\Konquadrat
1. Config
  1. Builder
    1. ClassBuilder
    2. DatabaseBuilder

com\setasign\Konquadrat\Config\Builder

ClassBuilder

File: /Konquadrat/src/Config/Builder/ClassBuilder.php

Class hierarchy

ClassBuilder

Summary

Constants

FIELD_TYPES_WITHOUT_DEFAULT

private const ClassBuilder::FIELD_TYPES_WITHOUT_DEFAULT = array ( 0 => 'select', 1 => 'text', 2 => 'multiLangText', 3 => 'smarty', 4 => 'xml', )

Properties

$generatedClassesDirectory

protected ClassBuilder::$generatedClassesDirectory

$languages

protected ClassBuilder::$languages

$missingFiles

protected \com\setasign\SetaFramework\Config\Config[] ClassBuilder::$missingFiles = array()

$traitDirectory

protected ClassBuilder::$traitDirectory

Methods

__construct()

public ClassBuilder::__construct (

string $configDirectory,
string $traitDirectory,
string $generatedClassesDirectory,
string[] $languages

)

The constructor

Parameters

$configDirectory : string
$traitDirectory : string
$generatedClassesDirectory : string: The directory to which the class files should be written to
$languages : string[]

Exceptions

Throws \com\setasign\Konquadrat\Exception

build()

public ClassBuilder::build (

\com\setasign\SetaFramework\Config\Config $config

): void

Parameters

$config : \com\setasign\SetaFramework\Config\Config

Exceptions

Throws \com\setasign\Konquadrat\Exception

createFiles()

protected ClassBuilder::createFiles (

string $id,
\com\setasign\SetaFramework\Config\Config $config,
\com\setasign\Konquadrat\Object\ObjectConfig $objectConfig

): void

Parameters

$id : string
$config : \com\setasign\SetaFramework\Config\Config
$objectConfig : \com\setasign\Konquadrat\Object\ObjectConfig

Exceptions

Throws \com\setasign\Konquadrat\Exception

createObject()

protected ClassBuilder::createObject (

bool $isTemplate,
string $id,
\com\setasign\SetaFramework\Config\Config $object,
\com\setasign\Konquadrat\Object\ObjectConfig $objectConfig

): void

Parameters

$isTemplate : bool
$id : string
$object : \com\setasign\SetaFramework\Config\Config
$objectConfig : \com\setasign\Konquadrat\Object\ObjectConfig

Exceptions

Throws \com\setasign\Konquadrat\Exception

getClassDocBlock()

protected ClassBuilder::getClassDocBlock (

string $id,
\com\setasign\SetaFramework\Config\Config $object,
\com\setasign\Konquadrat\Object\ObjectConfig $objectConfig

): string

Parameters

$id : string
$object : \com\setasign\SetaFramework\Config\Config
$objectConfig : \com\setasign\Konquadrat\Object\ObjectConfig

Exceptions

Throws \com\setasign\Konquadrat\Exception

getFieldConstants()

protected ClassBuilder::getFieldConstants (

string $name,
\com\setasign\SetaFramework\Config\Config $field

): string

Parameters

$name : string
$field : \com\setasign\SetaFramework\Config\Config

Exceptions

Throws \com\setasign\Konquadrat\Exception

getFieldHelperMethods()

protected ClassBuilder::getFieldHelperMethods (

string $name,
\com\setasign\SetaFramework\Config\Config $field,
\com\setasign\Konquadrat\Object\ObjectConfig $objectConfig

): string

Parameters

$name : string
$field : \com\setasign\SetaFramework\Config\Config
$objectConfig : \com\setasign\Konquadrat\Object\ObjectConfig

Exceptions

Throws \com\setasign\Konquadrat\Exception

getFieldMethodPhpDoc()

protected ClassBuilder::getFieldMethodPhpDoc (

string $name,
\com\setasign\SetaFramework\Config\Config $field

): string

Parameters

$name : string
$field : \com\setasign\SetaFramework\Config\Config

getFieldPhpDoc()

protected ClassBuilder::getFieldPhpDoc (

string $name,
\com\setasign\SetaFramework\Config\Config $field,
\com\setasign\Konquadrat\Object\ObjectConfig $objectConfig

): string

Parameters

$name : string
$field : \com\setasign\SetaFramework\Config\Config
$objectConfig : \com\setasign\Konquadrat\Object\ObjectConfig

Exceptions

Throws \com\setasign\Konquadrat\Exception

getFileHeader()

protected ClassBuilder::getFileHeader (

string $fileType,
string $id,
string $subNamespace

): string

Parameters

$fileType : string
$id : string
$subNamespace : string

getHelperMethodsPhpDoc()

protected ClassBuilder::getHelperMethodsPhpDoc (

string $name,
\com\setasign\Konquadrat\Object\ObjectConfig $objectConfig

): string

Parameters

$name : string
$objectConfig : \com\setasign\Konquadrat\Object\ObjectConfig

getUseTraits()

protected ClassBuilder::getUseTraits (

string $id,
array $uses,
array $replaces

): string

Parameters

$id : string
$uses : array
$replaces : array