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 Title

Model for the channel_titles table

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

Direct known subclasses

rsanchez\Deep\Model\Entry

Indirect known subclasses

rsanchez\Deep\Model\PlayaEntry, rsanchez\Deep\Model\RelationshipEntry
Namespace: rsanchez\Deep\Model
Located at Model/Title.php
Methods summary
public Illuminate\Database\Eloquent\Relations\HasOne
# author( )

Define the Author Eloquent relationship

Define the Author Eloquent relationship

Returns

Illuminate\Database\Eloquent\Relations\HasOne
public Illuminate\Database\Eloquent\Relations\HasManyThrough
# categories( )

Define the Categories Eloquent relationship

Define the Categories Eloquent relationship

Returns

Illuminate\Database\Eloquent\Relations\HasManyThrough
public rsanchez\Deep\Relations\HasOneFromRepository
# chan( )

Define the Channel Eloquent relationship

Define the Channel Eloquent relationship

Returns

rsanchez\Deep\Relations\HasOneFromRepository
public Illuminate\Database\Eloquent\Relations\HasMany
# comments( )

Define the Comments Eloquent relationship

Define the Comments Eloquent relationship

Returns

Illuminate\Database\Eloquent\Relations\HasMany
public
# __call( mixed $name, mixed $args )

Invoke any invokeable attributes

public string|integer
# getId( )

Get the entity ID (eg. entry_id or row_id)

Get the entity ID (eg. entry_id or row_id)

Returns

string|integer
public string|null
# getType( )

Get the entity type (eg. 'matrix' or 'grid' or 'entry')

Get the entity type (eg. 'matrix' or 'grid' or 'entry')

Returns

string|null
public
# getChannelAttribute( )

Alias chan to channel

Alias chan to channel

Var

\rsanchez\Deep\Model\Channel
public static
# setChannelRepository( rsanchez\Deep\Repository\ChannelRepository $channelRepository )

Set the global ChannelRepository

Set the global ChannelRepository

Parameters

$channelRepository
rsanchez\Deep\Repository\ChannelRepository
$channelRepository
public static
# setSiteRepository( rsanchez\Deep\Repository\SiteRepository $siteRepository )

Set the global SiteRepository

Set the global SiteRepository

Parameters

$siteRepository
rsanchez\Deep\Repository\SiteRepository
$siteRepository
public static
# setHydratorFactory( rsanchez\Deep\Hydrator\HydratorFactory $hydratorFactory )

Set the global HydratorFactory

Set the global HydratorFactory

Parameters

$hydratorFactory
rsanchez\Deep\Repository\HydratorFactory
$hydratorFactory
protected static
# joinTables( )
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
public rsanchez\Deep\Collection\TitleCollection
# newCollection( array $models = array() )

Hydrate the collection after creation

Parameters

$models
array
$models

Returns

rsanchez\Deep\Collection\TitleCollection
public
# hydrateCollection( rsanchez\Deep\Collection\AbstractTitleCollection $collection )

Loop through all the hydrators to set Entry custom field attributes

Loop through all the hydrators to set Entry custom field attributes

Parameters

$collection
rsanchez\Deep\Collection\TitleCollection
$collection
public
# attributesToArray( )
public Carbon\Carbon
# getEntryDateAttribute( integer $value )

Get the entry_date column as a Carbon object

Get the entry_date column as a Carbon object

Parameters

$value
integer
$value unix time

Returns

Carbon\Carbon
public Carbon\Carbon|null
# getExpirationDateAttribute( integer $value )

Get the expiration_date column as a Carbon object, or null if there is no expiration date

Get the expiration_date column as a Carbon object, or null if there is no expiration date

Parameters

$value
integer
$value unix time

Returns

Carbon\Carbon|null
public Carbon\Carbon|null
# getCommentExpirationDateAttribute( integer $value )

Get the comment_expiration_date column as a Carbon object, or null if there is no expiration date

Get the comment_expiration_date column as a Carbon object, or null if there is no expiration date

Parameters

$value
integer
$value unix time

Returns

Carbon\Carbon|null
public Carbon\Carbon|null
# getRecentCommentDateAttribute( integer $value )

Get the recent_comment_date column as a Carbon object, or null if there is no expiration date

Get the recent_comment_date column as a Carbon object, or null if there is no expiration date

Parameters

$value
integer
$value unix time

Returns

Carbon\Carbon|null
public Carbon\Carbon
# getEditDateAttribute( integer $value )

Get the edit_date column as a Carbon object

Get the edit_date column as a Carbon object

Parameters

$value
integer
$value unix time

Returns

Carbon\Carbon
public string|null
# getPageUriAttribute( )

Get the page_uri of the entry

Get the page_uri of the entry

Returns

string|null
public string
# getChannelNameAttribute( )

Get the channel_name of the entry's channel

Get the channel_name of the entry's channel

Returns

string
public string
# getChannelShortNameAttribute( )

Get the channel_name of the entry's channel

Get the channel_name of the entry's channel

Returns

string
public string
# getUsernameAttribute( )

Get the username of the entry's author

Get the username of the entry's author

Returns

string
public
# save( array $options = array() )

Save the entry (not yet supported)

Save the entry (not yet supported)

Parameters

$options
array
$options
public Illuminate\Database\Eloquent\Builder
# scopeCategory( Illuminate\Database\Eloquent\Builder $query, dynamic $categoryId )

Filter by Category ID

Filter by Category ID

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$categoryId
dynamic
string $categoryId

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeRelatedCategories( Illuminate\Database\Eloquent\Builder $query, integer $entryId )

Get entries that are share one or more categories with the specified entry ID

Get entries that are share one or more categories with the specified entry ID

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$entryId
integer
$entryId

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeRelatedCategoriesUrlTitle( Illuminate\Database\Eloquent\Builder $query, string $urlTitle )

Get entries that are share one or more categories with the specified entry url title

Get entries that are share one or more categories with the specified entry url title

Parameters

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

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeAllCategories( Illuminate\Database\Eloquent\Builder $query, dynamic $categoryId )

Filter out entries without all Category IDs

Filter out entries without all Category IDs

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$categoryId
dynamic
string $categoryId

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeNotAllCategories( Illuminate\Database\Eloquent\Builder $query, dynamic $categoryId )

Filter out entries without all Category IDs

Filter out entries without all Category IDs

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$categoryId
dynamic
string $categoryId

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeNotCategory( Illuminate\Database\Eloquent\Builder $query, dynamic $categoryId )

Filter by not Category ID

Filter by not Category ID

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$categoryId
dynamic
string $categoryId

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeCategoryName( Illuminate\Database\Eloquent\Builder $query, dynamic $categoryName )

Filter by Category Name

Filter by Category Name

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$categoryName
dynamic
string $categoryName

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeNotCategoryName( Illuminate\Database\Eloquent\Builder $query, dynamic $categoryName )

Filter by not Category Name

Filter by not Category Name

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$categoryName
dynamic
string $categoryName

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeCategoryGroup( Illuminate\Database\Eloquent\Builder $query, dynamic $groupId )

Filter by Category Group

Filter by Category Group

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$groupId
dynamic
string $groupId

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeNotCategoryGroup( Illuminate\Database\Eloquent\Builder $query, dynamic $groupId )

Filter by Not Category Group

Filter by Not Category Group

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$groupId
dynamic
string $groupId

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeChannel( Illuminate\Database\Eloquent\Builder $query, dynamic $channelName )

Filter by Channel Name

Filter by Channel Name

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$channelName
dynamic
string $channelName

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeNotChannel( Illuminate\Database\Eloquent\Builder $query, dynamic $channelName )

Filter by not Channel Name

Filter by not Channel Name

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$channelName
dynamic
string $channelName

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeChannelId( Illuminate\Database\Eloquent\Builder $query, dynamic $channelId )

Filter by Channel ID

Filter by Channel ID

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$channelId
dynamic
int $channelId

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeNotChannelId( Illuminate\Database\Eloquent\Builder $query, dynamic $channelId )

Filter by not Channel ID

Filter by not Channel ID

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$channelId
dynamic
int $channelId

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeAuthorId( Illuminate\Database\Eloquent\Builder $query, dynamic $authorId )

Filter by Author ID

Filter by Author ID

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$authorId
dynamic
int $authorId

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeNotAuthorId( Illuminate\Database\Eloquent\Builder $query, dynamic $authorId )

Filter by not Author ID

Filter by not Author ID

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$authorId
dynamic
int $authorId

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeShowExpired( Illuminate\Database\Eloquent\Builder $query, boolean $showExpired = true )

Filter out Expired Entries

Filter out Expired Entries

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$showExpired
boolean
$showExpired

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeShowFutureEntries( Illuminate\Database\Eloquent\Builder $query, boolean $showFutureEntries = true )

Filter out Future Entries

Filter out Future Entries

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$showFutureEntries
boolean
$showFutureEntries

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeSiteId( Illuminate\Database\Eloquent\Builder $query, integer $siteId )

Filter by site ID

Filter by site ID

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$siteId
integer
$siteId

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeFixedOrder( Illuminate\Database\Eloquent\Builder $query, dynamic $fixedOrder )

Set a Fixed Order

Set a Fixed Order

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$fixedOrder
dynamic
int $fixedOrder

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeSticky( Illuminate\Database\Eloquent\Builder $query, boolean $sticky = true )

Set Sticky Entries to appear first

Set Sticky Entries to appear first

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$sticky
boolean
$sticky

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeEntryId( Illuminate\Database\Eloquent\Builder $query, dynamic $entryId )

Filter by Entry ID

Filter by Entry ID

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$entryId
dynamic
string $entryId

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeNotEntryId( Illuminate\Database\Eloquent\Builder $query, dynamic $notEntryId )

Filter by Not Entry ID

Filter by Not Entry ID

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$notEntryId
dynamic
string $notEntryId

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeEntryIdFrom( Illuminate\Database\Eloquent\Builder $query, integer $entryIdFrom )

Filter out entries before the specified Entry ID

Filter out entries before the specified Entry ID

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$entryIdFrom
integer
$entryIdFrom

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeEntryIdTo( Illuminate\Database\Eloquent\Builder $query, integer $entryIdTo )

Filter out entries after the specified Entry ID

Filter out entries after the specified Entry ID

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$entryIdTo
integer
$entryIdTo

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeGroupId( Illuminate\Database\Eloquent\Builder $query, dynamic $groupId )

Filter by Member Group ID

Filter by Member Group ID

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$groupId
dynamic
int $groupId

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeNotGroupId( Illuminate\Database\Eloquent\Builder $query, dynamic $notGroupId )

Filter by Not Member Group ID

Filter by Not Member Group ID

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$notGroupId
dynamic
int $notGroupId

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeLimit( Illuminate\Database\Eloquent\Builder $query, integer $limit )

Limit the number of results

Limit the number of results

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$limit
integer
$limit

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeOffset( Illuminate\Database\Eloquent\Builder $query, integer $offset )

Offset the results

Offset the results

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$offset
integer
$offset

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeShowPages( Illuminate\Database\Eloquent\Builder $query, boolean|string $showPages = true )

Filter by Page

Filter by Page

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$showPages
boolean|string
$showPages

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeShowPagesOnly( Illuminate\Database\Eloquent\Builder $query, boolean|string $showPagesOnly = true )

Filter by Pages Only

Filter by Pages Only

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$showPagesOnly
boolean|string
$showPagesOnly

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeStartOn( Illuminate\Database\Eloquent\Builder $query, integer|DateTime $startOn )

Filter out entries before the specified date

Filter out entries before the specified date

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$startOn
integer|DateTime
$startOn unix time

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeStatus( Illuminate\Database\Eloquent\Builder $query, dynamic $status )

Filter by Entry Status

Filter by Entry Status

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$status
dynamic
string $status

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeNotStatus( Illuminate\Database\Eloquent\Builder $query, dynamic $status )

Filter by Entry Status

Filter by Entry Status

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$status
dynamic
string $status

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeStopBefore( Illuminate\Database\Eloquent\Builder $query, integer|DateTime $stopBefore )

Filter out entries after the specified date

Filter out entries after the specified date

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$stopBefore
integer|DateTime
$stopBefore unix time

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeUrlTitle( Illuminate\Database\Eloquent\Builder $query, dynamic $urlTitle )

Filter by URL Title

Filter by URL Title

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$urlTitle
dynamic
string $urlTitle

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeUsername( Illuminate\Database\Eloquent\Builder $query, dynamic $username )

Filter by Member Username

Filter by Member Username

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$username
dynamic
string $username

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeYear( Illuminate\Database\Eloquent\Builder $query, integer $year )

Filter by Year

Filter by Year

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$year
integer
$year

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeMonth( Illuminate\Database\Eloquent\Builder $query, string|integer $month )

Filter by Month

Filter by Month

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$month
string|integer
$month

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeDay( Illuminate\Database\Eloquent\Builder $query, string|integer $day )

Filter by Day

Filter by Day

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$day
string|integer
$day

Returns

Illuminate\Database\Eloquent\Builder
protected
# scopeArrayFromString( Illuminate\Database\Eloquent\Builder $query, string $string, string $scope )

Call the specified scope, exploding a pipe-delimited string into an array Calls the not version of the scope if the string begins with not eg 'not 4|5|6'

Call the specified scope, exploding a pipe-delimited string into an array Calls the not version of the scope if the string begins with not eg 'not 4|5|6'

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$string
string
$string ex '4|5|6' 'not 4|5|6'
$scope
string
$scope the name of the scope, ex. AuthorId
public Illuminate\Database\Eloquent\Builder
# scopeAuthorIdString( Illuminate\Database\Eloquent\Builder $query, string $string )

Filter by Author ID string parameter

Filter by Author ID string parameter

Parameters

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

Returns

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

Filter by Category string parameter

Filter by Category string parameter

Parameters

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

Returns

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

Filter by Category Group string parameter

Filter by Category Group string parameter

Parameters

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

Returns

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

Filter by Category Name string parameter

Filter by Category Name string parameter

Parameters

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

Returns

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

Filter by Channel string parameter

Filter by Channel string parameter

Parameters

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

Returns

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

Filter by Entry ID string parameter

Filter by Entry ID string parameter

Parameters

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

Returns

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

Filter by Fixed Order string parameter

Filter by Fixed Order string parameter

Parameters

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

Returns

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

Filter by Member Group ID string parameter

Filter by Member Group ID string parameter

Parameters

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

Returns

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

Filter by Show Expired string parameter

Filter by Show Expired string parameter

Parameters

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

Returns

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

Filter by Show Future Entries string parameter

Filter by Show Future Entries string parameter

Parameters

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

Returns

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

Filter by Show Pages string parameter

Filter by Show Pages string parameter

Parameters

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

Returns

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

Filter by Status string parameter

Filter by Status string parameter

Parameters

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

Returns

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

Filter by Sticky string parameter

Filter by Sticky string parameter

Parameters

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

Returns

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

Filter by URL Title string parameter

Filter by URL Title string parameter

Parameters

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

Returns

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

Filter by Username string parameter

Filter by Username string parameter

Parameters

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

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeWithCategories( Illuminate\Database\Eloquent\Builder $query, Closure $callback = null )

Eager load categories

Eager load categories

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$callback
Closure|null
$callback eager load constraint

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeWithCategoryFields( Illuminate\Database\Eloquent\Builder $query, Closure $callback = null )

Eager load categories with custom fields

Eager load categories with custom fields

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$callback
Closure|null
$callback eager load constraint

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeWithAuthor( Illuminate\Database\Eloquent\Builder $query, Closure $callback = null )

Eager load author

Eager load author

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$callback
Closure|null
$callback eager load constraint

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeWithAuthorFields( Illuminate\Database\Eloquent\Builder $query, Closure $callback = null )

Eager load author with custom fields

Eager load author with custom fields

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$callback
Closure|null
$callback eager load constraint

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeWithComments( Illuminate\Database\Eloquent\Builder $query, Closure $callback = null )

Eager load author

Eager load author

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$callback
Closure|null
$callback eager load constraint

Returns

Illuminate\Database\Eloquent\Builder
public Illuminate\Database\Eloquent\Builder
# scopeDynamicParameters( Illuminate\Database\Eloquent\Builder $query, array $allowedParameters, array $request )

Dynamically apply scopes

Dynamically apply scopes

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$allowedParameters
array
$allowedParameters list of keys to pull from $request
$request
array
$request array of request variables, for instance $_REQUEST

Returns

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

Hydrate the parents property

Hydrate the parents property

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query

Returns

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

Hydrate the siblings property

Hydrate the siblings property

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query

Returns

Illuminate\Database\Eloquent\Builder
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
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
Methods used from rsanchez\Deep\Model\JoinableTrait
(), (), (), ()
Methods used from rsanchez\Deep\Model\GlobalAttributeVisibilityTrait
(), (), (), (), ()
Properties summary
protected string $table 'channel_titles'
#
protected string $primaryKey 'entry_id'
#
protected static array $globalHidden [ 'chan', 'site_id', 'forum_topic_id', 'ip_address', 'versioning_enabled', 'comments', ]
#

The attributes that should be hidden for arrays.

The attributes that should be hidden for arrays.

protected static array $globalVisible []
#

The attributes that should be visible in arrays.

The attributes that should be visible in arrays.

protected string $collectionClass '\\rsanchez\\Deep\\Collection\\TitleCollection'
#

The class used when creating a new Collection

The class used when creating a new Collection

protected static rsanchez\Deep\Repository\ChannelRepository $channelRepository
#

Global Channel Repository

Global Channel Repository

protected static rsanchez\Deep\Repository\SiteRepository $siteRepository
#

Global Site Repository

Global Site Repository

public static rsanchez\Deep\Hydrator\Factory $hydratorFactory
#

Hydrator Factory

Hydrator Factory

protected array $extraHydrators array()
#

List of extra hydrators to load (e.g. parents or siblings)

List of extra hydrators to load (e.g. parents or siblings)

protected string|null $defaultChannelName
#

When extending this class, set this property to automatically load from the specified channel

When extending this class, set this property to automatically load from the specified channel

API documentation generated by ApiGen 2.8.0