Overview

Namespaces

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

Classes

  • AbstractEntity
  • AbstractField
  • AbstractProperty
  • Asset
  • Category
  • CategoryField
  • CategoryPosts
  • Channel
  • Comment
  • Entry
  • Field
  • Fieldtype
  • File
  • GridCol
  • GridRow
  • JoinableScope
  • MatrixCol
  • MatrixRow
  • Member
  • MemberField
  • PlayaEntry
  • RelationshipEntry
  • Site
  • Title
  • UploadPref

Interfaces

  • FileInterface

Traits

  • GlobalAttributeVisibilityTrait
  • JoinableTrait
  • Overview
  • Namespace
  • Class
  • Tree

Class Entry

Model for the channel_titles table, joined with channel_data

Illuminate\Database\Eloquent\Model
Extended by rsanchez\Deep\Model\AbstractEntity
Extended by rsanchez\Deep\Model\Title uses rsanchez\Deep\Model\JoinableTrait, rsanchez\Deep\Model\GlobalAttributeVisibilityTrait
Extended by rsanchez\Deep\Model\Entry

Direct known subclasses

rsanchez\Deep\Model\PlayaEntry, rsanchez\Deep\Model\RelationshipEntry
Namespace: rsanchez\Deep\Model
Located at Model/Entry.php
Methods summary
public static
# setFieldRepository( rsanchez\Deep\Repository\FieldRepository $fieldRepository )

Set the global FieldRepository

Set the global FieldRepository

Parameters

$fieldRepository
rsanchez\Deep\Repository\FieldRepository
$fieldRepository
public Illuminate\Database\Eloquent\Builder
# newQuery( boolean $excludeDeleted = true )

Joins with the channel data table, and eager load channels, fields and fieldtypes

Parameters

$excludeDeleted
boolean
$excludeDeleted

Returns

Illuminate\Database\Eloquent\Builder

Overrides

rsanchez\Deep\Model\Title::newQuery()
public rsanchez\Deep\Collection\TitleCollection
# newCollection( array $models = array() )

Parameters

$models
array
$models

Returns

rsanchez\Deep\Collection\TitleCollection

Overrides

rsanchez\Deep\Model\Title::newCollection()
protected array
# getArrayableAttributes( )

Get an attribute array of all arrayable attributes.

Get an attribute array of all arrayable attributes.

Returns

array
public
# toArray( )
public Illuminate\Database\Eloquent\Builder
# scopeSearch( Illuminate\Database\Eloquent\Builder $query, string $fieldName, string $value )

Filter by Custom Field Search

Filter by Custom Field Search

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$fieldName
string
$fieldName
$value
string
$value

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeSearchString( Illuminate\Database\Eloquent\Builder $query, string $fieldName, string $string )

Filter by custom field search: string parameter

Filter by custom field search: string parameter

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$fieldName
string
$fieldName
$string
string
$string

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeTagparams( Illuminate\Database\Eloquent\Builder $query, array $parameters, array $request = array() )

Apply an array of parameters

Apply an array of parameters

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$parameters
array
$parameters
$request
array
$request array of request variables, for instance $_REQUEST

Returns

Illuminate\Database\Eloquent\Builder

Overrides

rsanchez\Deep\Model\Title::scopeTagparams()
public Illuminate\Database\Eloquent\Builder
# scopeTagparam( Illuminate\Database\Eloquent\Builder $query, string $key, string $value )

Apply a single parameter

Apply a single parameter

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$key
string
$key snake_cased parameter name
$value
string
$value scope parameters in string form, eg. 1|2|3

Returns

Illuminate\Database\Eloquent\Builder

Overrides

rsanchez\Deep\Model\Title::scopeTagparam()
protected Illuminate\Database\Eloquent\Builder
# scopeWhereFieldHandler( Illuminate\Database\Eloquent\Builder $query, string $method, array $args )

Translates a custom field name to field_id_x and performs a where query

Translates a custom field name to field_id_x and performs a where query

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$method
string
$method the where method to use
$args
array
$args the where query arguments

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeOrderByField( Illuminate\Database\Eloquent\Builder $query, string $fieldName, string $direction = 'asc' )

Order by custom field

Order by custom field

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$fieldName
string
$fieldName
$direction
string
$direction

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeWhereField( Illuminate\Database\Eloquent\Builder $query )

Where custom field equals

Where custom field equals

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeOrWhereField( Illuminate\Database\Eloquent\Builder $query )

Or where custom field equals

Or where custom field equals

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeWhereFieldBetween( Illuminate\Database\Eloquent\Builder $query )

Where custom field is between

Where custom field is between

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeOrWhereFieldBetween( Illuminate\Database\Eloquent\Builder $query )

Or where custom field is between

Or where custom field is between

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeWhereFieldNotBetween( Illuminate\Database\Eloquent\Builder $query )

Where custom field is not between

Where custom field is not between

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeOrWhereFieldNotBetween( Illuminate\Database\Eloquent\Builder $query )

Or where custom field is not between

Or where custom field is not between

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeWhereFieldIn( Illuminate\Database\Eloquent\Builder $query )

Where custom field is in

Where custom field is in

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeOrWhereFieldIn( Illuminate\Database\Eloquent\Builder $query )

Or where custom field is in

Or where custom field is in

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeWhereFieldNotIn( Illuminate\Database\Eloquent\Builder $query )

Where custom field is not in

Where custom field is not in

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeOrWhereFieldNotIn( Illuminate\Database\Eloquent\Builder $query )

Or where custom field is not in

Or where custom field is not in

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeWhereFieldNull( Illuminate\Database\Eloquent\Builder $query )

Where custom field is null

Where custom field is null

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeOrWhereFieldNull( Illuminate\Database\Eloquent\Builder $query )

Or where custom field is null

Or where custom field is null

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeWhereFieldNotNull( Illuminate\Database\Eloquent\Builder $query )

Where custom field is not null

Where custom field is not null

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeOrWhereFieldNotNull( Illuminate\Database\Eloquent\Builder $query )

Or where custom field is not null

Or where custom field is not null

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query

Returns

Illuminate\Database\Eloquent\Builder
protected Illuminate\Database\Eloquent\Builder
# scopeWhereFieldContainsHandler( Illuminate\Database\Eloquent\Builder $query, string $fieldName, mixed $value, string $boolean = 'and', boolean $not = false, boolean $wholeWord = false )

Translates a custom field name to field_id_x and performs a where like/regexp query

Translates a custom field name to field_id_x and performs a where like/regexp query

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$fieldName
string
$fieldName
$value
mixed
$value
$boolean
string
$boolean
$not
boolean
$not
$wholeWord
boolean
$wholeWord

Returns

Illuminate\Database\Eloquent\Builder
protected Illuminate\Database\Eloquent\Builder
# scopeWhereFieldContainsManyHandler( Illuminate\Database\Eloquent\Builder $query, string $fieldName, array $values, string $boolean = 'and', boolean $not = false, boolean $wholeWord = false )

Like scopeWhereFieldContainsHandler, but with many values

Like scopeWhereFieldContainsHandler, but with many values

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$fieldName
string
$fieldName
$values
array
$values
$boolean
string
$boolean
$not
boolean
$not
$wholeWord
boolean
$wholeWord

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeWhereFieldContains( Illuminate\Database\Eloquent\Builder $query, string $fieldName, mixed $value )

Where field contains

Where field contains

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$fieldName
string
$fieldName
$value
mixed
$value

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeWhereFieldDoesNotContain( Illuminate\Database\Eloquent\Builder $query, string $fieldName, mixed $value )

Where field does not contain

Where field does not contain

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$fieldName
string
$fieldName
$value
mixed
$value

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeOrWhereFieldContains( Illuminate\Database\Eloquent\Builder $query, string $fieldName, mixed $value )

Or where field contains

Or where field contains

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$fieldName
string
$fieldName
$value
mixed
$value

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeOrWhereFieldDoesNotContain( Illuminate\Database\Eloquent\Builder $query, string $fieldName, mixed $value )

Or where field does not contain

Or where field does not contain

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$fieldName
string
$fieldName
$value
mixed
$value

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeWhereFieldContainsWholeWord( Illuminate\Database\Eloquent\Builder $query, string $fieldName, mixed $value )

Where field contains whole word

Where field contains whole word

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$fieldName
string
$fieldName
$value
mixed
$value

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeWhereFieldDoesNotContainWholeWord( Illuminate\Database\Eloquent\Builder $query, string $fieldName, mixed $value )

Where field does not contain whole word

Where field does not contain whole word

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$fieldName
string
$fieldName
$value
mixed
$value

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeOrWhereFieldContainsWholeWord( Illuminate\Database\Eloquent\Builder $query, string $fieldName, mixed $value )

Or where field contains whole word

Or where field contains whole word

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$fieldName
string
$fieldName
$value
mixed
$value

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeOrWhereFieldDoesNotContainWholeWord( Illuminate\Database\Eloquent\Builder $query, string $fieldName, mixed $value )

Or where field does not contain whole word

Or where field does not contain whole word

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$fieldName
string
$fieldName
$value
mixed
$value

Returns

Illuminate\Database\Eloquent\Builder
Methods inherited from rsanchez\Deep\Model\Title
__call(), attributesToArray(), author(), categories(), chan(), comments(), getChannelAttribute(), getChannelNameAttribute(), getChannelShortNameAttribute(), getCommentExpirationDateAttribute(), getEditDateAttribute(), getEntryDateAttribute(), getExpirationDateAttribute(), getId(), getPageUriAttribute(), getRecentCommentDateAttribute(), getType(), getUsernameAttribute(), hydrateCollection(), joinTables(), save(), scopeAllCategories(), scopeArrayFromString(), scopeAuthorId(), scopeAuthorIdString(), scopeCategory(), scopeCategoryGroup(), scopeCategoryGroupString(), scopeCategoryName(), scopeCategoryNameString(), scopeCategoryString(), scopeChannel(), scopeChannelId(), scopeChannelString(), scopeDay(), scopeDynamicParameters(), scopeEntryId(), scopeEntryIdFrom(), scopeEntryIdString(), scopeEntryIdTo(), scopeFixedOrder(), scopeFixedOrderString(), scopeGroupId(), scopeGroupIdString(), scopeLimit(), scopeMonth(), scopeNotAllCategories(), scopeNotAuthorId(), scopeNotCategory(), scopeNotCategoryGroup(), scopeNotCategoryName(), scopeNotChannel(), scopeNotChannelId(), scopeNotEntryId(), scopeNotGroupId(), scopeNotStatus(), scopeOffset(), scopeRelatedCategories(), scopeRelatedCategoriesUrlTitle(), scopeShowExpired(), scopeShowExpiredString(), scopeShowFutureEntries(), scopeShowFutureEntriesString(), scopeShowPages(), scopeShowPagesOnly(), scopeShowPagesString(), scopeSiteId(), scopeStartOn(), scopeStatus(), scopeStatusString(), scopeSticky(), scopeStickyString(), scopeStopBefore(), scopeUrlTitle(), scopeUrlTitleString(), scopeUsername(), scopeUsernameString(), scopeWithAuthor(), scopeWithAuthorFields(), scopeWithCategories(), scopeWithCategoryFields(), scopeWithComments(), scopeWithParents(), scopeWithSiblings(), scopeYear(), setChannelRepository(), setHydratorFactory(), setSiteRepository()
Methods used from rsanchez\Deep\Model\JoinableTrait
(), (), (), ()
Methods used from rsanchez\Deep\Model\GlobalAttributeVisibilityTrait
(), (), (), (), ()
Properties summary
protected string $collectionClass '\\rsanchez\\Deep\\Collection\\EntryCollection'
#

The class used when creating a new Collection

The class used when creating a new Collection
public static rsanchez\Deep\Repository\FieldRepository $fieldRepository
#

Global Field Repository

Global Field Repository
Properties inherited from rsanchez\Deep\Model\Title
$channelRepository, $defaultChannelName, $extraHydrators, $globalHidden, $globalVisible, $hydratorFactory, $primaryKey, $siteRepository, $table
API documentation generated by ApiGen 2.8.0