Overview

Namespaces

  • rsanchez
    • Deep
      • App
        • EE
        • Laravel
          • Facade
      • Collection
      • Hydrator
      • Model
      • Plugin
      • Relations
      • Repository

Classes

  • AbstractHydrator
  • AssetsHydrator
  • DateHydrator
  • ExplodeHydrator
  • FileHydrator
  • GridHydrator
  • HydratorFactory
  • MatrixHydrator
  • ParentsHydrator
  • PipeHydrator
  • PlayaHydrator
  • RelationshipHydrator
  • SiblingsHydrator
  • WysiwygHydrator

Interfaces

  • HydratorInterface
  • Overview
  • Namespace
  • Class
  • Tree

Class AbstractHydrator

Abstract Hydrator class

Hydrators bind custom fields properties to Entry objects

rsanchez\Deep\Hydrator\AbstractHydrator implements rsanchez\Deep\Hydrator\HydratorInterface

Direct known subclasses

rsanchez\Deep\Hydrator\AssetsHydrator, rsanchez\Deep\Hydrator\DateHydrator, rsanchez\Deep\Hydrator\SiblingsHydrator, rsanchez\Deep\Hydrator\WysiwygHydrator, rsanchez\Deep\Hydrator\ExplodeHydrator, rsanchez\Deep\Hydrator\FileHydrator, rsanchez\Deep\Hydrator\GridHydrator, rsanchez\Deep\Hydrator\MatrixHydrator, rsanchez\Deep\Hydrator\ParentsHydrator, rsanchez\Deep\Hydrator\PipeHydrator, rsanchez\Deep\Hydrator\PlayaHydrator, rsanchez\Deep\Hydrator\RelationshipHydrator
Abstract
Namespace: rsanchez\Deep\Hydrator
Located at Hydrator/AbstractHydrator.php
Methods summary
public
# __construct( rsanchez\Deep\Collection\EntryCollection $collection, string $fieldtype )

Constructor

Constructor

Set the EntryCollection and load any global elements the hydrator might need

Parameters

$collection
rsanchez\Deep\Collection\EntryCollection
$collection
$fieldtype
string
$fieldtype
public
# preload( array $entryIds )

Preload any custom field data that resides in another DB table

Preload any custom field data that resides in another DB table

Parameters

$entryIds
array
$entryIds all the entry IDs in the collection (including related entries)

Implementation of

rsanchez\Deep\Hydrator\HydratorInterface::preload()
abstract public mixed
# hydrate( rsanchez\Deep\Model\AbstractEntity $entity, rsanchez\Deep\Model\AbstractProperty $property )

Hydrate the specified property (channel field or Matrix/Grid col) on the specified entity (channel entry or Matrix/Grid row)

Hydrate the specified property (channel field or Matrix/Grid col) on the specified entity (channel entry or Matrix/Grid row)

Parameters

$entity
rsanchez\Deep\Model\AbstractEntity
$entity
$property
rsanchez\Deep\Model\AbstractProperty
$property

Returns

mixed
the entity property value

Implementation of

rsanchez\Deep\Hydrator\HydratorInterface::hydrate()
Properties summary
protected rsanchez\Deep\Collection\EntryCollection $collection
#

The Entry Collection being hydrated

The Entry Collection being hydrated

protected string $fieldtype
#

The name of the fieldtype

The name of the fieldtype

API documentation generated by ApiGen 2.8.0