Overview

Namespaces

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

Classes

  • AbstractFieldCollection
  • AbstractTitleCollection
  • AssetCollection
  • CategoryCollection
  • CategoryFieldCollection
  • ChannelCollection
  • EntryCollection
  • FieldCollection
  • FileCollection
  • GridColCollection
  • GridRowCollection
  • MatrixColCollection
  • MatrixRowCollection
  • MemberFieldCollection
  • PlayaCollection
  • RelationshipCollection
  • SiteCollection
  • TitleCollection
  • UploadPrefCollection

Interfaces

  • FilterableInterface

Traits

  • FilterableTrait
  • Overview
  • Namespace
  • Class
  • Tree

Class AbstractTitleCollection

Collection of \rsanchez\Deep\Model\Title

Illuminate\Database\Eloquent\Collection
Extended by rsanchez\Deep\Collection\AbstractTitleCollection implements rsanchez\Deep\Collection\FilterableInterface uses rsanchez\Deep\Collection\FilterableTrait

Direct known subclasses

rsanchez\Deep\Collection\TitleCollection

Indirect known subclasses

rsanchez\Deep\Collection\EntryCollection, rsanchez\Deep\Collection\PlayaCollection, rsanchez\Deep\Collection\RelationshipCollection
Abstract
Namespace: rsanchez\Deep\Collection
Located at Collection/AbstractTitleCollection.php
Methods summary
public static rsanchez\Deep\Collection\AbstractTitleCollection
# create( array $models, rsanchez\Deep\Repository\ChannelRepository $channelRepository )

Instantiate a collection of models

Instantiate a collection of models

Parameters

$models
array
$models
$channelRepository
rsanchez\Deep\Repository\ChannelRepository
$channelRepository

Returns

rsanchez\Deep\Collection\AbstractTitleCollection
public rsanchez\Deep\Collection\AbstractTitleCollection
# createChildCollection( array $models )

Create a new collection using the current instance's properties as injected dependencies.

Create a new collection using the current instance's properties as injected dependencies.

Useful when making a collection of a subset of this collection

Parameters

$models
array
$models

Returns

rsanchez\Deep\Collection\AbstractTitleCollection
public
# setChannelRepository( rsanchez\Deep\Repository\ChannelRepository $channelRepository )

Set the Channel Repository

Set the Channel Repository

Parameters

$channelRepository
rsanchez\Deep\Repository\ChannelRepository
$channelRepository
public
# setChannels( rsanchez\Deep\Collection\ChannelCollection $channels )

Set the channels used by this collection

Set the channels used by this collection

Parameters

$channels
rsanchez\Deep\Collection\ChannelCollection
$channels
public rsanchez\Deep\Collection\ChannelCollection
# getChannels( )

Get the channels used by this collection

Get the channels used by this collection

Returns

rsanchez\Deep\Collection\ChannelCollection
public array
# getEntryIds( )

Get all the entry Ids from this collection. This includes both the entries directly in this collection, and entries found in Playa/Relationship fields

Get all the entry Ids from this collection. This includes both the entries directly in this collection, and entries found in Playa/Relationship fields

Returns

array
public
# addEntryId( string|integer $entryId )

Add an additional entry id to this collection

Add an additional entry id to this collection

Parameters

$entryId
string|integer
$entryId
public
# addEntryIds( array $entryIds )

Add additional entry ids to this collection

Add additional entry ids to this collection

Parameters

$entryIds
array
$entryIds
public boolean
# hasCustomFields( )

Whether or not this collection supports custom fields

Whether or not this collection supports custom fields

Returns

boolean
public
# toJson( mixed $options = 0 )
Methods inherited from rsanchez\Deep\Collection\FilterableInterface
__invoke(), createClone(), filterByAttribute(), filterByAttributeComparison(), filterByAttributeContains(), filterByAttributeIn(), filterByAttributeInString(), filterById(), limit(), offset(), sortByAttribute(), sortByFixedOrder(), tagparams()
Methods used from rsanchez\Deep\Collection\FilterableTrait
(), (), (), (), (), (), (), (), (), (), (), (), (), ()
Properties summary
protected array $entryIds array()
#

All of the entry IDs in this collection (including related entries)

All of the entry IDs in this collection (including related entries)

protected rsanchez\Deep\Collection\ChannelCollection $channels
#

Channels used by this collection

Channels used by this collection

API documentation generated by ApiGen 2.8.0