tflori/orm

» API Reference » ORM\Namer

ORM\Namer

Table of Contents

• Abstract
• Methods
  • $namer->__construct - Namer constructor.
  • $namer->forceNamingScheme - Enforce $namingScheme to $name
  • $namer->getAttributeName - Get the attribute name with $namingScheme or default naming scheme
  • $namer->getColumnName - Get the column name with $namingScheme or default naming scheme
  • $namer->getMethodName - Get the method name with $namingScheme or default naming scheme
  • $namer->getTableName - Get the table name for $reflection
  • $namer->setOption - Set $option to $value
  • $namer->substitute - Substitute a $template with $values

Abstract

Namer is for naming errors, columns, tables and methods

Namer is an artificial word and is more a name giver. We just don’t wanted to write so much.

Methods

ORM\Namer::__construct

public function __construct(array $options = [])

Namer constructor.

Parameters

ORM\Namer::__construct

↑ top

ORM\Namer::forceNamingScheme

public function forceNamingScheme(string $name, string $namingScheme): string

Enforce $namingScheme to $name

Supported naming schemes: snake_case, snake_lower, SNAKE_UPPER, Snake_Ucfirst, camelCase, StudlyCaps, lower and UPPER.

Parameters

ORM\Namer::forceNamingScheme

↑ top

ORM\Namer::getAttributeName

public function getAttributeName(
    string $name, 
    mixed $prefix = null, 
    string $namingScheme = null, 
): string

Get the attribute name with $namingScheme or default naming scheme

Parameters

ORM\Namer::getAttributeName

↑ top

ORM\Namer::getColumnName

public function getColumnName(
    string $class, 
    string $attribute, 
    string $prefix = null, 
    string $namingScheme = null, 
): string

Get the column name with $namingScheme or default naming scheme

Parameters

ORM\Namer::getColumnName

↑ top

ORM\Namer::getMethodName

public function getMethodName(string $name, string $namingScheme = null): string

Get the method name with $namingScheme or default naming scheme

Parameters

ORM\Namer::getMethodName

↑ top

ORM\Namer::getTableName

public function getTableName(
    string $class, 
    string $template = null, 
    string $namingScheme = null, 
): string

Get the table name for $reflection

Parameters

ORM\Namer::getTableName

↑ top

ORM\Namer::setOption

public function setOption(string $option, mixed $value): $this

Set $option to $value

Parameters

ORM\Namer::setOption

↑ top

ORM\Namer::substitute

public function substitute(
    string $template, 
    array $values = [], 
    string $arrayGlue = ', 
    ', 
): string

Substitute a $template with $values

$values is a key value pair array. The value should be a string or an array o

Parameters

ORM\Namer::substitute

↑ top