PHP Класс Spot\Relation\RelationAbstract

См. ссылку: http://spot.os.ly
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$entityName
$foreignKey
$identityValue
$localKey
$mapper
$query
$queryQueue
$result

Открытые методы

Метод Описание
__call ( $func, $args ) Passthrough for missing methods on expected object result
eagerLoadOnCollection ( $relationName, Collection $collection ) : Spot\Collection Map relation results to original collection of entities
entityKey ( ) : string Get entity key field - defaults to the primary key
entityName ( ) : string Get entity name object
execute ( ) Execute query and return results
foreignKey ( ) : string Get foreign key field
identityValue ( $identityValue = null ) : mixed Get identity value
identityValuesFromCollection ( Collection $collection ) Set identity values from given collection
localKey ( ) : string Get local key field
mapper ( ) : Mapper Get Mapper object
query ( ) Get query object instance
save ( Spot\EntityInterface $entity, string $relationName, array $options = [] ) : boolean Save related entities

Защищенные методы

Метод Описание
buildQuery ( ) : Query Build query object

Описание методов

__call() публичный Метод

Passthrough for missing methods on expected object result
public __call ( $func, $args )

buildQuery() абстрактный защищенный Метод

Build query object
abstract protected buildQuery ( ) : Query
Результат Spot\Query

eagerLoadOnCollection() публичный Метод

Map relation results to original collection of entities
public eagerLoadOnCollection ( $relationName, Collection $collection ) : Spot\Collection
$collection Spot\Entity\Collection
Результат Spot\Collection

entityKey() публичный Метод

Get entity key field - defaults to the primary key
public entityKey ( ) : string
Результат string

entityName() публичный Метод

Get entity name object
public entityName ( ) : string
Результат string

execute() публичный Метод

Execute query and return results
public execute ( )

foreignKey() публичный Метод

Get foreign key field
public foreignKey ( ) : string
Результат string

identityValue() публичный Метод

Get identity value
public identityValue ( $identityValue = null ) : mixed
Результат mixed Array, string, or id

identityValuesFromCollection() абстрактный публичный Метод

Set identity values from given collection
abstract public identityValuesFromCollection ( Collection $collection )
$collection Spot\Entity\Collection

localKey() публичный Метод

Get local key field
public localKey ( ) : string
Результат string

mapper() публичный Метод

Get Mapper object
public mapper ( ) : Mapper
Результат Spot\Mapper

query() публичный Метод

Get query object instance
public query ( )

save() абстрактный публичный Метод

Save related entities
abstract public save ( Spot\EntityInterface $entity, string $relationName, array $options = [] ) : boolean
$entity Spot\EntityInterface Entity to save relation from
$relationName string Name of the relation to save
$options array Options to pass to the mappers
Результат boolean

Описание свойств

$entityName защищенное свойство

protected $entityName

$foreignKey защищенное свойство

protected $foreignKey

$identityValue защищенное свойство

protected $identityValue

$localKey защищенное свойство

protected $localKey

$mapper защищенное свойство

protected $mapper

$query защищенное свойство

protected $query

$queryQueue защищенное свойство

protected $queryQueue

$result защищенное свойство

protected $result