tflori/orm

API Reference

ORM

• BulkInsert
• DbConfig
• Entity
• EntityFetcher
• EntityManager
• Event
• Exception
• Helper
• Namer
• ObserverInterface
• Relation

ORM\Dbal

• Column
• Dbal
• Error
• Expression
• Mysql
• Other
• Pgsql
• Sqlite
• Table
• Type
• TypeInterface

ORM\Dbal\Error

• InvalidJson
• NoBoolean
• NoDateTime
• NoNumber
• NoString
• NotAllowed
• NoTime
• NotNullable
• NotValid
• TooLong

ORM\Dbal\Type

• Boolean
• DateTime
• Enum
• Json
• Number
• Set
• Text
• Time
• VarChar

ORM\Entity

• GeneratesPrimaryKeys

ORM\EntityFetcher

• CallableFilter
• FilterInterface

ORM\Event

• Changed
• Deleted
• Deleting
• Fetched
• Inserted
• Inserting
• Saved
• Saving
• Updated
• UpdateEvent
• Updating

ORM\Exception

• IncompletePrimaryKey
• InvalidArgument
• InvalidConfiguration
• InvalidName
• InvalidRelation
• InvalidType
• NoConnection
• NoEntity
• NoEntityManager
• NoOperator
• NotJoined
• NotScalar
• UndefinedRelation
• UnknownColumn
• UnsupportedDriver

ORM\Observer

• AbstractObserver
• CallbackObserver

ORM\QueryBuilder

• Parenthesis
• ParenthesisInterface
• QueryBuilder
• QueryBuilderInterface

ORM\Relation

• ManyToMany
• Morphed
• OneToMany
• OneToOne
• Owner
• ParentChildren

ORM\Testing

• EntityFetcherMock
• EntityManagerMock

ORM\Testing\EntityFetcherMock

• Result
• ResultRepository

ORM\Observer\AbstractObserver

Implements: ORM\ObserverInterface

AbstractObserver for entity events

When a handler returns false it will cancel other event handlers and if applicable stops the execution (saving, inserting, updating and deleting can be canceled).

Methods

• handle Handles the $event.

ORM\Observer\AbstractObserver::handle

public function handle( ORM\Event $event ): boolean

Handles the $event.

Return false to stop event execution.

Visibility: this method is public.
Returns: this method returns boolean

Parameters

ORM\Dbal\Type\Boolean

Extends: ORM\Dbal\Type

Boolean data type

Properties

Methods

• __construct Boolean constructor
• factory Returns a new Type object
• fits Check if this type fits to $columnDefinition
• getBoolean Get the string representation for boolean
• validate Check if $value is valid for this type

ORM\Dbal\Type\Boolean::__construct

public function __construct( ORM\Dbal\Dbal $dbal )

Boolean constructor

Visibility: this method is public.

Parameters

ORM\Dbal\Type\Boolean::factory

public static function factory(
    ORM\Dbal\Dbal $dbal, array $columnDefinition
): static

Returns a new Type object

This method is only for types covered by mapping. Use fromDefinition instead for custom types.

Static: this method is static.
Visibility: this method is public.
Returns: this method returns static

Parameters

ORM\Dbal\Type\Boolean::fits

public static function fits( array $columnDefinition ): boolean

Check if this type fits to $columnDefinition

Static: this method is static.
Visibility: this method is public.
Returns: this method returns boolean

Parameters

ORM\Dbal\Type\Boolean::getBoolean

protected function getBoolean( boolean $bool ): string

Get the string representation for boolean

Visibility: this method is protected.
Returns: this method returns string

Parameters

ORM\Dbal\Type\Boolean::validate

public function validate( $value ): boolean|ORM\Dbal\Error

Check if $value is valid for this type

Visibility: this method is public.
Returns: this method returns boolean|\ORM\Dbal\Error

Parameters

ORM\BulkInsert

Properties

Methods

• __construct BulkInsert constructor.
• add Add an entity to the bulk insert.
• execute Executes the bulk insert.
• finish Insert the outstanding entities and return all synced objects.
• getLimit
• limit Limit the amount of entities inserted at once.
• noAutoIncrement Disable updating the primary key by auto increment.
• noUpdates Disable updating entities after insert
• onSync Executes $callback after insert
• updateEntities Enable updating entities after insert
• useAutoincrement Enable updating the primary keys from autoincrement

ORM\BulkInsert::__construct

public function __construct(
    ORM\Dbal\Dbal $dbal, string $class, integer $limit = 20
)

BulkInsert constructor.

Visibility: this method is public.

Parameters

ORM\BulkInsert::add

public function add( ORM\Entity $entities )

Add an entity to the bulk insert.

Visibility: this method is public.
Throws: this method may throw \ORM\Exception\InvalidArgument

Parameters

ORM\BulkInsert::execute

protected function execute()

Executes the bulk insert.

Visibility: this method is protected.

ORM\BulkInsert::finish

public function finish(): array<\ORM\Entity>

Insert the outstanding entities and return all synced objects.

Visibility: this method is public.
Returns: this method returns array<mixed,\ORM\Entity>

ORM\BulkInsert::getLimit

public function getLimit(): integer

Visibility: this method is public.
Returns: this method returns integer

ORM\BulkInsert::limit

public function limit( integer $limit ): $this

Limit the amount of entities inserted at once.

Visibility: this method is public.
Returns: this method returns $this

Parameters

ORM\BulkInsert::noAutoIncrement

public function noAutoIncrement(): $this

Disable updating the primary key by auto increment.

Caution: If this is disabled updating could cause a IncompletePrimaryKey exception.

Visibility: this method is public.
Returns: this method returns $this

ORM\BulkInsert::noUpdates

public function noUpdates(): $this

Disable updating entities after insert

Visibility: this method is public.
Returns: this method returns $this

ORM\BulkInsert::onSync

public function onSync( callable $callback = null ): $this

Executes $callback after insert

Provides an array of the just inserted entities in first argument.

Visibility: this method is public.
Returns: this method returns $this

Parameters

ORM\BulkInsert::updateEntities

public function updateEntities(): $this

Enable updating entities after insert

Caution: This option will need to update the primary key by autoincrement which maybe is not supported by your db access layer (DBAL).

Visibility: this method is public.
Returns: this method returns $this

ORM\BulkInsert::useAutoincrement

public function useAutoincrement(): $this

Enable updating the primary keys from autoincrement

Caution: Your db access layer (DBAL) may not support this feature.

Visibility: this method is public.
Returns: this method returns $this

ORM\EntityFetcher\CallableFilter

Implements: ORM\EntityFetcher\FilterInterface

Properties

Methods

• __construct
• apply Apply this filter to $fetcher

ORM\EntityFetcher\CallableFilter::__construct

public function __construct( callable $filter )

Visibility: this method is public.

Parameters

ORM\EntityFetcher\CallableFilter::apply

public function apply( ORM\EntityFetcher $fetcher ): void

Apply this filter to $fetcher

Visibility: this method is public.
Returns: this method returns void

Parameters

ORM\Observer\CallbackObserver

Extends: ORM\Observer\AbstractObserver

AbstractObserver for entity events

When a handler returns false it will cancel other event handlers and if applicable stops the execution (saving, inserting, updating and deleting can be canceled).

Properties

Methods

• handle Handles the $event.
• off Remove all listeners for $event
• on Register a new $listener for $event

ORM\Observer\CallbackObserver::handle

public function handle( ORM\Event $event ): boolean

Handles the $event.

Return false to stop event execution.

Visibility: this method is public.
Returns: this method returns boolean

Parameters

ORM\Observer\CallbackObserver::off

public function off( $event ): $this

Remove all listeners for $event

Visibility: this method is public.
Returns: this method returns $this

Parameters

ORM\Observer\CallbackObserver::on

public function on( $event, callable $listener ): $this

Register a new $listener for $event

Visibility: this method is public.
Returns: this method returns $this

Parameters

ORM\Event\Changed

Extends: ORM\Event

Constants

Properties

Methods

• __construct
• __get
• stop

ORM\Event\Changed::__construct

public function __construct(
    ORM\Entity $entity, $attribute, $oldValue, $newValue
)

Visibility: this method is public.

Parameters

ORM\Event\Changed::__get

public function __get( $name )

Visibility: this method is public.

Parameters

ORM\Event\Changed::stop

public function stop()

Visibility: this method is public.

ORM\Dbal\Column

Describes a column of a database table

Properties

Methods

• __construct Column constructor.
• __get Get attributes from column
• getDefault Get the default value of the column
• getName Get the name of the column
• getNullable Get the nullable status of the column
• getRegisteredType Get the registered type for $columnDefinition
• getType Determine and return the type
• hasDefault Check if default value is given
• isNullable Check if the column is nullable
• registerType Register $type for describe
• validate Check if $value is valid for this type

ORM\Dbal\Column::__construct

public function __construct( ORM\Dbal\Dbal $dbal, array $columnDefinition )

Column constructor.

Visibility: this method is public.

Parameters

ORM\Dbal\Column::__get

public function __get( string $name ): mixed

Get attributes from column

Visibility: this method is public.
Returns: this method returns mixed

Parameters

ORM\Dbal\Column::getDefault

public function getDefault(): mixed

Get the default value of the column

Visibility: this method is public.
Returns: this method returns mixed

ORM\Dbal\Column::getName

public function getName(): string

Get the name of the column

Visibility: this method is public.
Returns: this method returns string

ORM\Dbal\Column::getNullable

public function getNullable(): boolean

Get the nullable status of the column

Visibility: this method is public.
Returns: this method returns boolean

ORM\Dbal\Column::getRegisteredType

protected static function getRegisteredType( array $columnDefinition ): string

Get the registered type for $columnDefinition

Static: this method is static.
Visibility: this method is protected.
Returns: this method returns string

Parameters

ORM\Dbal\Column::getType

public function getType(): ORM\Dbal\Type

Determine and return the type

Visibility: this method is public.
Returns: this method returns \ORM\Dbal\Type

ORM\Dbal\Column::hasDefault

public function hasDefault(): boolean

Check if default value is given

Visibility: this method is public.
Returns: this method returns boolean

ORM\Dbal\Column::isNullable

public function isNullable(): boolean

Check if the column is nullable

Visibility: this method is public.
Returns: this method returns boolean

ORM\Dbal\Column::registerType

public static function registerType( string $type )

Register $type for describe

Static: this method is static.
Visibility: this method is public.

Parameters

ORM\Dbal\Column::validate

public function validate( $value ): boolean|ORM\Dbal\Error

Check if $value is valid for this type

Visibility: this method is public.
Returns: this method returns boolean|\ORM\Dbal\Error

Parameters

ORM\Dbal\Type\DateTime

Extends: ORM\Dbal\Type

Date and datetime data type

Constants

Properties

Methods

• __construct DateTime constructor
• factory Returns a new Type object
• fits Check if this type fits to $columnDefinition
• getPrecision
• validate Check if $value is valid for this type

ORM\Dbal\Type\DateTime::__construct

public function __construct(
    integer $precision = null, boolean $dateOnly = false
)

DateTime constructor

Visibility: this method is public.

Parameters

ORM\Dbal\Type\DateTime::factory

public static function factory(
    ORM\Dbal\Dbal $dbal, array $columnDefinition
): static

Returns a new Type object

This method is only for types covered by mapping. Use fromDefinition instead for custom types.

Static: this method is static.
Visibility: this method is public.
Returns: this method returns static

Parameters

ORM\Dbal\Type\DateTime::fits

public static function fits( array $columnDefinition ): boolean

Check if this type fits to $columnDefinition

Static: this method is static.
Visibility: this method is public.
Returns: this method returns boolean

Parameters

ORM\Dbal\Type\DateTime::getPrecision

public function getPrecision(): integer

Visibility: this method is public.
Returns: this method returns integer

ORM\Dbal\Type\DateTime::validate

public function validate( $value ): boolean|ORM\Dbal\Error

Check if $value is valid for this type

Visibility: this method is public.
Returns: this method returns boolean|\ORM\Dbal\Error

Parameters

ORM\Dbal\Dbal

Base class for database abstraction

Properties

Methods

• __construct Dbal constructor.
• assertSameType
• beginTransaction Begin a transaction or create a savepoint
• buildDeleteStatement
• buildInsert Build an insert statement for $rows
• buildSetClause
• buildUpdateStatement
• commit Commit the current transaction or decrease the savepoint counter
• delete Delete rows from $table using $where conditions
• deleteEntity Delete $entity from database
• describe Describe a table
• escapeBoolean Escape a boolean for query
• escapeDateTime Escape a date time object for query
• escapeDouble Escape a double for Query
• escapeIdentifier Returns $identifier quoted for use in a sql statement
• escapeInteger Escape an integer for query
• escapeNULL Escape NULL for query
• escapeString Escape a string for query
• escapeValue Returns $value formatted to use in a sql statement.
• extractParenthesis Extract content from parenthesis in $type
• insert
• insertAndSync Insert $entities and update with default values from database
• insertAndSyncWithAutoInc Insert $entities and sync with auto increment primary key
• insertEntities Insert $entities into database
• normalizeType Normalize $type
• rollback Rollback the current transaction or save point
• setOption Set $option to $value
• syncInserted Sync the $entities after insert
• update Update $table using $where to set $updates
• updateAutoincrement Update the autoincrement value

ORM\Dbal\Dbal::__construct

public function __construct(
    ORM\EntityManager $entityManager, array $options = array()
)

Dbal constructor.

Visibility: this method is public.

Parameters

ORM\Dbal\Dbal::assertSameType

protected static function assertSameType(
    array<\ORM\Entity> $entities
): boolean

Static: this method is static.
Visibility: this method is protected.
Returns: this method returns boolean
Throws: this method may throw \ORM\Exception\InvalidArgument

Parameters

ORM\Dbal\Dbal::beginTransaction

public function beginTransaction(): boolean

Begin a transaction or create a savepoint

Visibility: this method is public.
Returns: this method returns boolean

ORM\Dbal\Dbal::buildDeleteStatement

protected function buildDeleteStatement( $table, array $where )

Visibility: this method is protected.

Parameters

ORM\Dbal\Dbal::buildInsert

protected function buildInsert( string $table, array $rows ): string

Build an insert statement for $rows

Visibility: this method is protected.
Returns: this method returns string

Parameters

ORM\Dbal\Dbal::buildSetClause

protected function buildSetClause( array $updates )

Visibility: this method is protected.

Parameters

ORM\Dbal\Dbal::buildUpdateStatement

protected function buildUpdateStatement( $table, array $where, array $updates )

Visibility: this method is protected.

Parameters

ORM\Dbal\Dbal::commit

public function commit( boolean $all = false ): boolean

Commit the current transaction or decrease the savepoint counter

Actually nothing will be committed if there are savepoints. Instead the counter will be decreased and the commited savepoint will still be rolled back when you call rollback afterwards.

Hopefully that gives a hint why save points are no transactions and what the limitations are.

Begin transaction
  updates / inserts for transaction1
  Create savepoint transaction1
    updates / inserts for transaction2
    Create savepoint transaction2
      updates / inserts for transaction3
    <no commit here but you called commit for transaction3>
    updates / inserts for transaction2
  rollback of transaction2 to savepoint of transaction1
  update / inserts for transaction1
commit of transaction1

Visibility: this method is public.
Returns: this method returns boolean

Parameters

ORM\Dbal\Dbal::delete

public function delete( string $table, array $where ): integer

Delete rows from $table using $where conditions

Where conditions can be an array of key => value pairs to check for equality or an array of expressions.

Examples: $dbal->delete('someTable', ['id' => 23]) $dbal->delete('user', ['name = \'john\'', 'OR email=\'john.doe@example.com\''])

Tip: Use the query builder to construct where conditions: $em->query('user')->where('name', 'john')->orWhere('email', '...')->delete();

Visibility: this method is public.
Returns: this method returns integer
Response description: The number of deleted rows

Parameters

ORM\Dbal\Dbal::deleteEntity

public function deleteEntity( ORM\Entity $entity ): boolean

Delete $entity from database

This method does not delete from the map - you can still receive the entity via fetch.

Visibility: this method is public.
Returns: this method returns boolean

Parameters

ORM\Dbal\Dbal::describe

public function describe(
    string $table
): ORM\Dbal\Table|array<\ORM\Dbal\Column>

Describe a table

Visibility: this method is public.
Returns: this method returns \ORM\Dbal\Table|array<mixed,\ORM\Dbal\Column>
Throws: this method may throw \ORM\Exception\UnsupportedDriver or \ORM\Exception

Parameters

ORM\Dbal\Dbal::escapeBoolean

protected function escapeBoolean( boolean $value ): string

Escape a boolean for query

Visibility: this method is protected.
Returns: this method returns string

Parameters

ORM\Dbal\Dbal::escapeDateTime

protected function escapeDateTime( DateTime $value ): mixed

Escape a date time object for query

Visibility: this method is protected.
Returns: this method returns mixed

Parameters

ORM\Dbal\Dbal::escapeDouble

protected function escapeDouble( double $value ): string

Escape a double for Query

Visibility: this method is protected.
Returns: this method returns string

Parameters

ORM\Dbal\Dbal::escapeIdentifier

public function escapeIdentifier( string $identifier ): string

Returns $identifier quoted for use in a sql statement

Visibility: this method is public.
Returns: this method returns string

Parameters

ORM\Dbal\Dbal::escapeInteger

protected function escapeInteger( integer $value ): string

Escape an integer for query

Visibility: this method is protected.
Returns: this method returns string

Parameters

ORM\Dbal\Dbal::escapeNULL

protected function escapeNULL(): string

Escape NULL for query

Visibility: this method is protected.
Returns: this method returns string

ORM\Dbal\Dbal::escapeString

protected function escapeString( string $value ): string

Escape a string for query

Visibility: this method is protected.
Returns: this method returns string

Parameters

ORM\Dbal\Dbal::escapeValue

public function escapeValue( $value ): string

Returns $value formatted to use in a sql statement.

Visibility: this method is public.
Returns: this method returns string
Throws: this method may throw \ORM\Exception\NotScalar

Parameters

ORM\Dbal\Dbal::extractParenthesis

protected function extractParenthesis( string $type ): string

Extract content from parenthesis in $type

Visibility: this method is protected.
Returns: this method returns string

Parameters

ORM\Dbal\Dbal::insert

public function insert( $table, array $rows )

Visibility: this method is public.

Parameters

ORM\Dbal\Dbal::insertAndSync

public function insertAndSync( ORM\Entity $entities ): boolean

Insert $entities and update with default values from database

The entities have to be from same type otherwise a InvalidArgument will be thrown.

Visibility: this method is public.
Returns: this method returns boolean
Throws: this method may throw \ORM\Exception\InvalidArgument

Parameters

ORM\Dbal\Dbal::insertAndSyncWithAutoInc

public function insertAndSyncWithAutoInc(
    ORM\Entity $entities
): integer|boolean

Insert $entities and sync with auto increment primary key

The entities have to be from same type otherwise a InvalidArgument will be thrown.

Visibility: this method is public.
Returns: this method returns integer|boolean
Throws: this method may throw \ORM\Exception\UnsupportedDriver or \ORM\Exception\InvalidArgument

Parameters

ORM\Dbal\Dbal::insertEntities

public function insertEntities( ORM\Entity $entities ): boolean

Insert $entities into database

The entities have to be from same type otherwise a InvalidArgument will be thrown.

Visibility: this method is public.
Returns: this method returns boolean

Parameters

ORM\Dbal\Dbal::normalizeType

protected function normalizeType( string $type ): string

Normalize $type

The type returned by mysql is for example VARCHAR(20) - this function converts it to varchar

Visibility: this method is protected.
Returns: this method returns string

Parameters

ORM\Dbal\Dbal::rollback

public function rollback(): boolean

Rollback the current transaction or save point

Visibility: this method is public.
Returns: this method returns boolean

ORM\Dbal\Dbal::setOption

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

Set $option to $value

Visibility: this method is public.
Returns: this method returns $this

Parameters

ORM\Dbal\Dbal::syncInserted

protected function syncInserted( ORM\Entity $entities )

Sync the $entities after insert

Visibility: this method is protected.

Parameters

ORM\Dbal\Dbal::update

public function update(
    string $table, array $where, array $updates, array $joins = array()
): integer

Update $table using $where to set $updates

Simple usage: update('table', ['id' => 23], ['name' => 'John Doe'])

For advanced queries with parenthesis, joins (if supported from your DBMS) etc. use QueryBuilder:

$em->query('table')
 ->where('birth_date', '>', EM::raw('DATE_SUB(NOW(), INTERVAL 18 YEARS)'))
 ->update(['teenager' => true]);

Visibility: this method is public.
Returns: this method returns integer
Response description: The number of affected rows
Throws: this method may throw \ORM\Exception\UnsupportedDriver

Parameters

ORM\Dbal\Dbal::updateAutoincrement

protected function updateAutoincrement( ORM\Entity $entity, $value )

Update the autoincrement value

Visibility: this method is protected.

Parameters

ORM\DbConfig

Describes a database configuration

Properties

Methods

• __construct Constructor
• getDsn Get the data source name

ORM\DbConfig::__construct

public function __construct(
    string $type, string $name, string $user = null, string $pass = null, 
    string $host = null, string $port = null, array $attributes = array()
)

Constructor

The constructor gets all parameters to establish a database connection and configure PDO instance.

Example:

$dbConfig = new DbConfig('mysql', 'my_db', 'my_user', 'my_secret', null, null, [
    \PDO::MYSQL_ATTR_INIT_COMMAND => 'SET NAMES utf8'
]);

Visibility: this method is public.

Parameters

ORM\DbConfig::getDsn

public function getDsn(): string

Get the data source name

Visibility: this method is public.
Returns: this method returns string

ORM\Event\Deleted

Extends: ORM\Event

Constants

Properties

ORM\Event\Deleting

Extends: ORM\Event

Constants

Properties

ORM\Entity

Implements:

Definition of an entity

The instance of an entity represents a row of the table and the statics variables and methods describe the database table.

This is the main part where your configuration efforts go. The following properties and methods are well documented in the manual under https://tflori.github.io/orm/entityDefinition.html.

See Also:

• Entity Definition

Constants

Properties

Methods

• __construct Constructor
• __get
• __isset Check if a column is defined
• __serialize
• __set
• __unserialize
• addRelated Add relations for $relation to $entities
• boot Boot the class
• bootIfNotBooted Boot the class if it not already booted
• bootTraits Boot the traits of the class
• delete Delete the entity
• deleteRelated Delete relations for $relation to $entities
• describe Get a description for this table.
• detachObserver Stop observing the class by $observer
• disableValidator Disable validator
• enableValidator Enable validator
• exists Returns whether or not the entity exists in database
• fetch Fetches related objects
• fill Fill the entity with $data
• generatePrimaryKey Generates a primary key
• getAttribute Get the value from $attribute
• getAttributeName Get the column name of $attribute
• getColumnName Get the column name of $attribute
• getDirty Get an array of attributes that changed
• getNamingSchemeColumn
• getNamingSchemeMethods
• getNamingSchemeTable
• getPrimaryKey Get the primary key
• getPrimaryKeyVars Get the primary key vars
• getRelated Get related objects
• getRelation Get the definition for $relation
• getTableName Get the table name
• getTableNameTemplate
• hasLoaded Check if $relation got loaded already
• hasPrimaryKey Check if the entity has has a complete primary key
• insertEntity Insert the row in the database
• isAutoIncremented Check if the table has a auto increment column
• isDirty Checks if entity or $attribute got changed
• isValid Check if the current data is valid
• isValidatorEnabled Check if the validator is enabled
• load Load the related objects of $relation
• observeBy Observe the class using $observer
• onChange Empty event handler
• onInit Empty event handler
• postPersist Empty event handler
• postUpdate Empty event handler
• prePersist Empty event handler
• preUpdate Empty event handler
• query Create an entityFetcher for this entity
• registerGlobalFilter Register a filter that is added to every fetcher for this entity
• reset Resets the entity or $attribute to original data
• resetRelated Resets all loaded relations or $relation
• save Save the entity to EntityManager
• serialize String representation of data
• setAttribute Set $attribute to $value
• setEntityManager
• setNamingSchemeColumn
• setNamingSchemeMethods
• setNamingSchemeTable
• setRelated Set $relation to $entity
• setTableNameTemplate
• toArray Get an array of the entity
• toArrayPreventRecursion
• unserialize Constructs the object
• updateEntity Update the row in the database
• validate Validate $value for $attribute
• validateArray Validate $data

ORM\Entity::__construct

final public function __construct(
    array<mixed> $data = array(), 
    ORM\EntityManager $entityManager = null, boolean $fromDatabase = false
)

Constructor

It calls ::onInit() after initializing $data and $originalData.

Visibility: this method is public.

Parameters

ORM\Entity::__get

public function __get( string $attribute ): mixed|null

Visibility: this method is public.
Returns: this method returns mixed|null

Parameters

See Also:

• self::getAttribute

  ORM\Entity::__isset

public function __isset( $attribute ): boolean

Check if a column is defined

Visibility: this method is public.
Returns: this method returns boolean

Parameters

ORM\Entity::__serialize

public function __serialize()

Visibility: this method is public.

ORM\Entity::__set

public function __set( string $attribute, $value )

Visibility: this method is public.

Parameters

See Also:

• self::getAttribute

  ORM\Entity::__unserialize

public function __unserialize( array $data )

Visibility: this method is public.

Parameters

ORM\Entity::addRelated

public function addRelated(
    string $relation, array<\ORM\Entity> $entities
)

Add relations for $relation to $entities

This method is only for many-to-many relations.

This method does not take care about already existing relations and will fail hard.

Visibility: this method is public.

Parameters

ORM\Entity::boot

protected static function boot()

Boot the class

Static: this method is static.
Visibility: this method is protected.

ORM\Entity::bootIfNotBooted

public static function bootIfNotBooted()

Boot the class if it not already booted

Static: this method is static.
Visibility: this method is public.

ORM\Entity::bootTraits

protected static function bootTraits()

Boot the traits of the class

Static: this method is static.
Visibility: this method is protected.

ORM\Entity::delete

public function delete(): $this

Delete the entity

You might want to implement soft deletes by overriding this method.

Visibility: this method is public.
Returns: this method returns $this

ORM\Entity::deleteRelated

public function deleteRelated(
    string $relation, array<\ORM\Entity> $entities
)

Delete relations for $relation to $entities

This method is only for many-to-many relations.

Visibility: this method is public.

Parameters

ORM\Entity::describe

public static function describe(): ORM\Dbal\Table|array<\ORM\Dbal\Column>

Get a description for this table.

Static: this method is static.
Visibility: this method is public.
Returns: this method returns \ORM\Dbal\Table|array<mixed,\ORM\Dbal\Column>

ORM\Entity::detachObserver

public static function detachObserver( ORM\Observer\AbstractObserver $observer )

Stop observing the class by $observer

Static: this method is static.
Visibility: this method is public.

Parameters

See Also:

• \ORM\EntityManager::detach()

  ORM\Entity::disableValidator

public static function disableValidator( boolean $disable = true )

Disable validator

Static: this method is static.
Visibility: this method is public.

Parameters

ORM\Entity::enableValidator

public static function enableValidator( boolean $enable = true )

Enable validator

Static: this method is static.
Visibility: this method is public.

Parameters

ORM\Entity::exists

public function exists(): boolean

Returns whether or not the entity exists in database

Visibility: this method is public.
Returns: this method returns boolean

ORM\Entity::fetch

public function fetch(
    string $relation, boolean $getAll = false
): ORM\Entity|array<\ORM\Entity>|ORM\EntityFetcher

Fetches related objects

For relations with cardinality many it returns an EntityFetcher. Otherwise it returns the entity.

It will throw an error for non owner when the key is incomplete.

Visibility: this method is public.
Returns: this method returns \ORM\Entity|array<mixed,\ORM\Entity>|\ORM\EntityFetcher

Parameters

ORM\Entity::fill

public function fill(
    array $data, boolean $ignoreUnknown = false, boolean $checkMissing = false
)

Fill the entity with $data

When $checkMissing is set to true it also proves that the absent columns are nullable.

Visibility: this method is public.
Throws: this method may throw \ORM\Exception\UnknownColumn or \ORM\Dbal\Error

Parameters

ORM\Entity::generatePrimaryKey

protected function generatePrimaryKey()

Generates a primary key

This method should only be executed from save method.

Visibility: this method is protected.

ORM\Entity::getAttribute

public function getAttribute( string $attribute ): mixed|null

Get the value from $attribute

If there is a custom getter this method get called instead.

Visibility: this method is public.
Returns: this method returns mixed|null

Parameters

See Also:

• Working with entities

ORM\Entity::getAttributeName

public static function getAttributeName( string $column ): string

Get the column name of $attribute

The column names can not be specified by template. Instead they are constructed by $columnPrefix and enforced to $namingSchemeColumn.

ATTENTION: If your overwrite this method remember that getColumnName(getColumnName($name)) have to be exactly the same as getColumnName($name).

Static: this method is static.
Visibility: this method is public.
Returns: this method returns string

Parameters

ORM\Entity::getColumnName

public static function getColumnName( string $attribute ): string

Get the column name of $attribute

The column names can not be specified by template. Instead they are constructed by $columnPrefix and enforced to $namingSchemeColumn.

ATTENTION: If your overwrite this method remember that getColumnName(getColumnName($name)) have to be exactly the same as getColumnName($name).

Static: this method is static.
Visibility: this method is public.
Returns: this method returns string

Parameters

ORM\Entity::getDirty

public function getDirty(): array

Get an array of attributes that changed

This method works on application level. Meaning it is showing additional attributes defined in ::$includedAttributes and and hiding ::$excludedAttributes.

Visibility: this method is public.
Returns: this method returns array

ORM\Entity::getNamingSchemeColumn

public static function getNamingSchemeColumn(): string

Warning: this method is deprecated. This means that this method will likely be removed in a future version.
Static: this method is static.
Visibility: this method is public.
Returns: this method returns string

ORM\Entity::getNamingSchemeMethods

public static function getNamingSchemeMethods(): string

Warning: this method is deprecated. This means that this method will likely be removed in a future version.
Static: this method is static.
Visibility: this method is public.
Returns: this method returns string

ORM\Entity::getNamingSchemeTable

public static function getNamingSchemeTable(): string

Warning: this method is deprecated. This means that this method will likely be removed in a future version.
Static: this method is static.
Visibility: this method is public.
Returns: this method returns string

ORM\Entity::getPrimaryKey

public function getPrimaryKey(): array

Get the primary key

Visibility: this method is public.
Returns: this method returns array
Throws: this method may throw \ORM\Exception\IncompletePrimaryKey

ORM\Entity::getPrimaryKeyVars

public static function getPrimaryKeyVars(): array

Get the primary key vars

The primary key can consist of multiple columns. You should configure the vars that are translated to these columns.

Static: this method is static.
Visibility: this method is public.
Returns: this method returns array

ORM\Entity::getRelated

public function getRelated( string $relation, boolean $refresh = false ): mixed

Get related objects

The difference between getRelated and fetch is that getRelated stores the fetched entities. To refresh set $refresh to true.

Visibility: this method is public.
Returns: this method returns mixed

Parameters

ORM\Entity::getRelation

public static function getRelation( string $name ): ORM\Relation

Get the definition for $relation

It normalize the short definition form and create a Relation object from it.

Static: this method is static.
Visibility: this method is public.
Returns: this method returns \ORM\Relation
Throws: this method may throw \ORM\Exception\UndefinedRelation

Parameters

ORM\Entity::getTableName

public static function getTableName(): string

Get the table name

The table name is constructed by $tableNameTemplate and $namingSchemeTable. It can be overwritten by $tableName.

Static: this method is static.
Visibility: this method is public.
Returns: this method returns string

ORM\Entity::getTableNameTemplate

public static function getTableNameTemplate(): string

Warning: this method is deprecated. This means that this method will likely be removed in a future version.
Static: this method is static.
Visibility: this method is public.
Returns: this method returns string

ORM\Entity::hasLoaded

public function hasLoaded( string $relation ): boolean

Check if $relation got loaded already

Visibility: this method is public.
Returns: this method returns boolean

Parameters

ORM\Entity::hasPrimaryKey

public function hasPrimaryKey(): boolean

Check if the entity has has a complete primary key

Visibility: this method is public.
Returns: this method returns boolean

ORM\Entity::insertEntity

private function insertEntity( boolean $hasPrimaryKey ): ORM\Event\Inserted|null

Insert the row in the database

Visibility: this method is private.
Returns: this method returns \ORM\Event\Inserted|null
Throws: this method may throw \ORM\Exception\IncompletePrimaryKey

Parameters

ORM\Entity::isAutoIncremented

public static function isAutoIncremented(): boolean

Check if the table has a auto increment column

Static: this method is static.
Visibility: this method is public.
Returns: this method returns boolean

ORM\Entity::isDirty

public function isDirty( string $attribute = null ): boolean

Checks if entity or $attribute got changed

Visibility: this method is public.
Returns: this method returns boolean

Parameters

ORM\Entity::isValid

public function isValid(): boolean|array<\ORM\Dbal\Error>

Check if the current data is valid

Returns boolean true when valid otherwise an array of Errors.

Visibility: this method is public.
Returns: this method returns boolean|array<mixed,\ORM\Dbal\Error>

ORM\Entity::isValidatorEnabled

public static function isValidatorEnabled(): boolean

Check if the validator is enabled

Static: this method is static.
Visibility: this method is public.
Returns: this method returns boolean

ORM\Entity::load

public function load( string $relation ): $this

Load the related objects of $relation

Nested relations can be loaded by separating them by “.” for example load all articles with comments from a user ($this): $user->load('articles.comments').

Visibility: this method is public.
Returns: this method returns $this

Parameters

ORM\Entity::observeBy

public static function observeBy(
    $observer = null
): ORM\Observer\CallbackObserver|null

Observe the class using $observer

If AbstractObserver is omitted it returns a new CallbackObserver. Usage example:

$em->observe(User::class)
    ->on('inserted', function (User $user) { ... })
    ->on('deleted', function (User $user) { ... });

For more information about model events please consult the [documentation](https://tflori.github.io/

Static: this method is static.
Visibility: this method is public.
Returns: this method returns \ORM\Observer\CallbackObserver|null

Parameters

See Also:

• \ORM\EntityManager::observe()

  ORM\Entity::onChange

public function onChange( string $attribute, $oldValue, $value )

Empty event handler

Get called when something is changed with magic setter.

Visibility: this method is public.

Parameters

ORM\Entity::onInit

public function onInit( boolean $new )

Empty event handler

Get called when the entity get initialized.

Visibility: this method is public.

Parameters

ORM\Entity::postPersist

public function postPersist()

Empty event handler

Get called after the entity got inserted in database.

Visibility: this method is public.

ORM\Entity::postUpdate

public function postUpdate()

Empty event handler

Get called after the entity got updated in database.

Visibility: this method is public.

ORM\Entity::prePersist

public function prePersist()

Empty event handler

Get called before the entity get inserted in database.

Visibility: this method is public.

ORM\Entity::preUpdate

public function preUpdate()

Empty event handler

Get called before the entity get updated in database.

Visibility: this method is public.

ORM\Entity::query

public static function query(): ORM\EntityFetcher

Create an entityFetcher for this entity

Static: this method is static.
Visibility: this method is public.
Returns: this method returns \ORM\EntityFetcher

ORM\Entity::registerGlobalFilter

public static function registerGlobalFilter( $filter )

Register a filter that is added to every fetcher for this entity

Static: this method is static.
Visibility: this method is public.

Parameters

ORM\Entity::reset

public function reset( string $attribute = null )

Resets the entity or $attribute to original data

Visibility: this method is public.

Parameters

ORM\Entity::resetRelated

public function resetRelated( null $relation = null )

Resets all loaded relations or $relation

Helpful to reduce the size of serializations of the object (for caching, or toArray method etc.)

Visibility: this method is public.

Parameters

ORM\Entity::save

public function save(): $this

Save the entity to EntityManager

Visibility: this method is public.
Returns: this method returns $this
Throws: this method may throw \ORM\Exception\IncompletePrimaryKey

ORM\Entity::serialize

public function serialize(): string

String representation of data

Visibility: this method is public.
Returns: this method returns string

See Also:

• http://php.net/manual/en/serializable.serialize.php

ORM\Entity::setAttribute

public function setAttribute( string $attribute, $value ): $this

Set $attribute to $value

Tries to call custom setter before it stores the data directly. If there is a setter the setter needs to store data that should be updated in the database to $data. Do not store data in $originalData as it will not be written and give wrong results for dirty checking.

The onChange event is called after something got changed.

The method throws an error when the validation fails (also when the column does not exist).

Visibility: this method is public.
Returns: this method returns $this
Throws: this method may throw \ORM\Dbal\Error

Parameters

See Also:

• Working with entities

ORM\Entity::setEntityManager

public function setEntityManager( ORM\EntityManager $entityManager ): $this

Visibility: this method is public.
Returns: this method returns $this

Parameters

ORM\Entity::setNamingSchemeColumn

public static function setNamingSchemeColumn( string $namingSchemeColumn )

Warning: this method is deprecated. This means that this method will likely be removed in a future version.
Static: this method is static.
Visibility: this method is public.

Parameters

ORM\Entity::setNamingSchemeMethods

public static function setNamingSchemeMethods( string $namingSchemeMethods )

Warning: this method is deprecated. This means that this method will likely be removed in a future version.
Static: this method is static.
Visibility: this method is public.

Parameters

ORM\Entity::setNamingSchemeTable

public static function setNamingSchemeTable( string $namingSchemeTable )

Warning: this method is deprecated. This means that this method will likely be removed in a future version.
Static: this method is static.
Visibility: this method is public.

Parameters

ORM\Entity::setRelated

public function setRelated( string $relation, ORM\Entity $entity = null )

Set $relation to $entity

This method is only for the owner of a relation.

Visibility: this method is public.

Parameters

ORM\Entity::setTableNameTemplate

public static function setTableNameTemplate( string $tableNameTemplate )

Warning: this method is deprecated. This means that this method will likely be removed in a future version.
Static: this method is static.
Visibility: this method is public.

Parameters

ORM\Entity::toArray

public function toArray(
    array $attributes = array(), boolean $includeRelations = true, 
    array $parents = array()
): array

Get an array of the entity

Visibility: this method is public.
Returns: this method returns array

Parameters

ORM\Entity::toArrayPreventRecursion

protected static function toArrayPreventRecursion(
    ORM\Entity $relatedObject, array $parents
)

Static: this method is static.
Visibility: this method is protected.

Parameters

ORM\Entity::unserialize

public function unserialize( string $serialized )

Constructs the object

Visibility: this method is public.

Parameters

See Also:

• http://php.net/manual/en/serializable.unserialize.php

ORM\Entity::updateEntity

private function updateEntity(): ORM\Event\Updated|null

Update the row in the database

Visibility: this method is private.
Returns: this method returns \ORM\Event\Updated|null

ORM\Entity::validate

public static function validate(
    string $attribute, $value
): boolean|ORM\Dbal\Error

Validate $value for $attribute

Static: this method is static.
Visibility: this method is public.
Returns: this method returns boolean|\ORM\Dbal\Error

Parameters

ORM\Entity::validateArray

public static function validateArray( array $data ): array

Validate $data

$data has to be an array of $attribute => $value

Static: this method is static.
Visibility: this method is public.
Returns: this method returns array

Parameters

ORM\EntityFetcher

Extends: ORM\QueryBuilder\QueryBuilder

Fetch entities from database

If you need more specific queries you write them yourself. If you need just more specific where clause you can pass them to the *where() methods.

Supported:

• joins with on clause (and alias)
• joins with using (and alias)
• where conditions
• parenthesis
• order by one or more columns / expressions
• group by one or more columns / expressions
• limit and offset
• modifiers

Properties

Methods

• __construct Constructor
• all Fetch an array of entities
• andParenthesis Add a parenthesis with AND
• andWhere Add a where condition with AND.
• applyFilters Apply the filters on $this
• close Close parenthesis
• column Add $column
• columns Set $columns
• convertPlaceholders Replaces questionmarks in $expression with $args
• count Get the count of the resulting items
• createRelatedJoin Create the join with $join type
• delete Execute a delete statement on the current table with current where conditions
• filter Apply an additional $filter before executing
• fullJoin Full (outer) join $tableName with $options
• getDefaultOperator Get the default operator for $value
• getEntityManager
• getExpression Get the expression
• getGlobalFilters Get the filters registered for $class
• getQuery Get the query / select statement
• getStatement Query database and return result
• getTableAndAlias Get the table name and alias for a class
• groupBy Group By $column
• insert Execute an insert statement on the current table
• join (Inner) join $tableName with $options
• joinRelated Join $relation
• leftJoin Left (outer) join $tableName with $options
• leftJoinRelated Left outer join $relation
• limit Set $limit
• modifier Add $modifier
• normalizeFilter Converts callables into a CallableFilter and class names into instances
• offset Set $offset
• one Fetch one entity
• orderBy Order By $column in $direction
• orParenthesis Add a parenthesis with OR
• orWhere Add a where condition with OR.
• orWhereIn Add a where in condition with OR.
• orWhereNotIn Add a where not in condition with OR.
• parenthesis Alias for andParenthesis
• registerGlobalFilter Register $filter globally for $class
• reset Reset the position of the cursor to the first row
• rightJoin Right (outer) join $tableName with $options
• setFetchMode Proxy to PDOStatement::setFetchMode()
• setQuery Set a raw query or use different QueryBuilder
• toClassAndAlias Get class and alias by the match from translateColumn
• translateColumn Translate attribute names in an expression to their column names
• update Execute an update statement for the current query
• where Alias for andWhere
• whereIn Add a where in condition with AND.
• whereNotIn Add a where not in condition with AND.
• wherePrefix Get the prefix for a where condition or empty if not needed
• with Load $relations after all objects are loaded
• withoutFilter Exclude $filterClass for this fetcher

ORM\EntityFetcher::__construct

public function __construct( ORM\EntityManager $entityManager, $class )

Constructor

Create a select statement for $tableName with an object oriented interface.

It uses static::$defaultEntityManager if $entityManager is not given.

Visibility: this method is public.

Parameters

ORM\EntityFetcher::all

public function all( integer $limit ): array<\ORM\Entity>

Fetch an array of entities

When no $limit is set it fetches all entities in result set.

Visibility: this method is public.
Returns: this method returns array<mixed,\ORM\Entity>

Parameters

ORM\EntityFetcher::andParenthesis

public function andParenthesis(): $this

Add a parenthesis with AND

Visibility: this method is public.
Returns: this method returns $this

ORM\EntityFetcher::andWhere

public function andWhere(
    string $column, $operator = null, string $value = null
): $this

Add a where condition with AND.

QueryBuilderInterface andWhere($column[, $operator[, $value]]);

If $column has the same amount of question marks as $value - $value is the second parameter.

If there is no third parameter and no question mark in $column then the default operator is ‘=’ and $value is the second parameter.

These calls are equal:

$query->andWhere('name', '=' , 'John Doe');
$query->andWhere('name = ?', 'John Doe');
$query->andWhere('name', 'John Doe');
$query->andWhere('name = ?', ['John Doe']);

Visibility: this method is public.
Returns: this method returns $this

Parameters

ORM\EntityFetcher::applyFilters

protected function applyFilters()

Apply the filters on $this

Visibility: this method is protected.

ORM\EntityFetcher::close

public function close(): ORM\QueryBuilder\QueryBuilderInterface|ORM\QueryBuilder\ParenthesisInterface

Close parenthesis

Visibility: this method is public.
Returns: this method returns \ORM\QueryBuilder\QueryBuilderInterface|\ORM\QueryBuilder\ParenthesisInterface

ORM\EntityFetcher::column

public function column(
    string $column, array $args = array(), string $alias = ''
): $this

Add $column

Optionally you can provide an expression with question marks as placeholders filled with $args.

Visibility: this method is public.
Returns: this method returns $this

Parameters

ORM\EntityFetcher::columns

public function columns( array $columns = null ): $this

Set $columns

Visibility: this method is public.
Returns: this method returns $this

Parameters

ORM\EntityFetcher::convertPlaceholders

protected function convertPlaceholders(
    string $expression, $args, boolean $translateCols = true
): string

Replaces questionmarks in $expression with $args

Additionally this method replaces “ClassName::var” with “alias.col” and “alias.var” with “alias.col” if $translateCols is true (default).

Visibility: this method is protected.
Returns: this method returns string

Parameters

ORM\EntityFetcher::count

public function count(): integer

Get the count of the resulting items

Visibility: this method is public.
Returns: this method returns integer

ORM\EntityFetcher::createRelatedJoin

public function createRelatedJoin( $join, $relation ): $this

Create the join with $join type

Visibility: this method is public.
Returns: this method returns $this

Parameters

ORM\EntityFetcher::delete

public function delete(): integer

Execute a delete statement on the current table with current where conditions

Visibility: this method is public.
Returns: this method returns integer
Response description: The number of deleted rows

ORM\EntityFetcher::filter

public function filter( $filter ): $this

Apply an additional $filter before executing

Visibility: this method is public.
Returns: this method returns $this

Parameters

ORM\EntityFetcher::fullJoin

public function fullJoin(
    string $tableName, $expression = '', string $alias = '', 
    array $args = array()
): $this|ORM\QueryBuilder\ParenthesisInterface

Full (outer) join $tableName with $options

When no expression got provided self get returned. If you want to get a parenthesis the parameter empty can be set to false.

ATTENTION: here the default value of empty got changed - defaults to yes

Visibility: this method is public.
Returns: this method returns $this|\ORM\QueryBuilder\ParenthesisInterface

Parameters

ORM\EntityFetcher::getDefaultOperator

private function getDefaultOperator( $value ): string

Get the default operator for $value

Arrays use IN by default - all others use =

Visibility: this method is private.
Returns: this method returns string

Parameters

ORM\EntityFetcher::getEntityManager

public function getEntityManager(): ORM\EntityManager

Visibility: this method is public.
Returns: this method returns \ORM\EntityManager

ORM\EntityFetcher::getExpression

public function getExpression(): string

Get the expression

Returns the complete expression inside this parenthesis.

Visibility: this method is public.
Returns: this method returns string

ORM\EntityFetcher::getGlobalFilters

public static function getGlobalFilters( string $class ): array

Get the filters registered for $class

A filter can be registered for the super class too.

Static: this method is static.
Visibility: this method is public.
Returns: this method returns array

Parameters

ORM\EntityFetcher::getQuery

public function getQuery(): string

Get the query / select statement

Builds the statement from current where conditions, joins, columns and so on.

Visibility: this method is public.
Returns: this method returns string

ORM\EntityFetcher::getStatement

protected function getStatement(): PDOStatement|boolean

Query database and return result

Queries the database with current query and returns the resulted PDOStatement.

If query failed it returns false. It also stores this failed result and to change the query afterwards will not change the result.

Visibility: this method is protected.
Returns: this method returns \PDOStatement|boolean

ORM\EntityFetcher::getTableAndAlias

protected function getTableAndAlias( string $class, string $alias = '' ): array

Get the table name and alias for a class

Visibility: this method is protected.
Returns: this method returns array
Response description: [$table, $alias]

Parameters

ORM\EntityFetcher::groupBy

public function groupBy( string $column, array $args = array() ): $this

Group By $column

Optionally you can provide an expression in $column with question marks as placeholders.

Visibility: this method is public.
Returns: this method returns $this

Parameters

ORM\EntityFetcher::insert

public function insert( array $rows ): integer

Execute an insert statement on the current table

Visibility: this method is public.
Returns: this method returns integer
Response description: The number of inserted rows

Parameters

ORM\EntityFetcher::join

public function join(
    string $tableName, $expression = '', string $alias = '', 
    array $args = array()
): $this|ORM\QueryBuilder\ParenthesisInterface

(Inner) join $tableName with $options

When no expression got provided a ParenthesisInterface get returned. If this parenthesis not get filled you will most likely get an error from your database. If you don’t want to get a parenthesis the parameter empty can be set to true.

Visibility: this method is public.
Returns: this method returns $this|\ORM\QueryBuilder\ParenthesisInterface

Parameters

ORM\EntityFetcher::joinRelated

public function joinRelated( $relation ): $this

Join $relation

Visibility: this method is public.
Returns: this method returns $this

Parameters

ORM\EntityFetcher::leftJoin

public function leftJoin(
    string $tableName, $expression = '', string $alias = '', 
    array $args = array()
): $this|ORM\QueryBuilder\ParenthesisInterface

Left (outer) join $tableName with $options

When no expression got provided a ParenthesisInterface get returned. If this parenthesis not get filled you will most likely get an error from your database. If you don’t want to get a parenthesis the parameter empty can be set to true.

Visibility: this method is public.
Returns: this method returns $this|\ORM\QueryBuilder\ParenthesisInterface

Parameters

ORM\EntityFetcher::leftJoinRelated

public function leftJoinRelated( $relation ): $this

Left outer join $relation

Visibility: this method is public.
Returns: this method returns $this

Parameters

ORM\EntityFetcher::limit

public function limit( integer $limit ): $this

Set $limit

Limits the amount of rows fetched from database.

Visibility: this method is public.
Returns: this method returns $this

Parameters

ORM\EntityFetcher::modifier

public function modifier( string $modifier ): $this

Add $modifier

Add query modifiers such as SQL_CALC_FOUND_ROWS or DISTINCT.

Visibility: this method is public.
Returns: this method returns $this

Parameters

ORM\EntityFetcher::normalizeFilter

protected static function normalizeFilter(
    $filter
): ORM\EntityFetcher\FilterInterface

Converts callables into a CallableFilter and class names into instances

Static: this method is static.
Visibility: this method is protected.
Returns: this method returns \ORM\EntityFetcher\FilterInterface
Throws: this method may throw \ORM\Exception\InvalidArgument

Parameters

ORM\EntityFetcher::offset

public function offset( integer $offset ): $this

Set $offset

Changes the offset (only with limit) where fetching starts in the query.

Visibility: this method is public.
Returns: this method returns $this

Parameters

ORM\EntityFetcher::one

public function one(): ORM\Entity

Fetch one entity

If there is no more entity in the result set it returns null.

Visibility: this method is public.
Returns: this method returns \ORM\Entity

ORM\EntityFetcher::orderBy

public function orderBy(
    string $column, string $direction = self::DIRECTION_ASCENDING, 
    array $args = array()
): $this

Order By $column in $direction

Optionally you can provide an expression in $column with question marks as placeholders.

Visibility: this method is public.
Returns: this method returns $this

Parameters

ORM\EntityFetcher::orParenthesis

public function orParenthesis(): $this

Add a parenthesis with OR

Visibility: this method is public.
Returns: this method returns $this

ORM\EntityFetcher::orWhere

public function orWhere(
    string $column, $operator = null, string $value = null
): $this

Add a where condition with OR.

QueryBuilderInterface orWhere($column[, $operator[, $value]]);

If $column has the same amount of question marks as $value - $value is the second parameter.

If there is no third parameter and no question mark in $column then the default operator is ‘=’ and $value is the second parameter.

These calls are equal:

$query->orWhere('name', '=' , 'John Doe');
$query->orWhere('name = ?', 'John Doe');
$query->orWhere('name', 'John Doe');
$query->orWhere('name = ?', ['John Doe']);

Visibility: this method is public.
Returns: this method returns $this

Parameters

ORM\EntityFetcher::orWhereIn

public function orWhereIn( $column, array $values ): $this

Add a where in condition with OR.

If $column is an array a composite where in statement will be created

Example: whereIn(['a', 'b'], [[42, 23], [42, 23]]) gets (a,b) IN ((42,23), (23,42)) in mysql

If $values is empty the expression will be 1 = 0 because an empty parenthesis causes an error in SQL.

Visibility: this method is public.
Returns: this method returns $this

Parameters