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 Category

Model for the categories table

Illuminate\Database\Eloquent\Model
Extended by rsanchez\Deep\Model\Category uses rsanchez\Deep\Model\JoinableTrait
Namespace: rsanchez\Deep\Model
Located at Model/Category.php
Methods summary
public rsanchez\Deep\Collection\CategoryCollection
# getChildrenAttribute( )

Get child categories NOTE: this will be empty unless you call scopeNested

Get child categories NOTE: this will be empty unless you call scopeNested

Returns

rsanchez\Deep\Collection\CategoryCollection
public boolean
# hasChildren( )

Check if the child collection is empty

Check if the child collection is empty

Returns

boolean
public static
# setCategoryFieldRepository( rsanchez\Deep\Repository\CategoryFieldRepository $categoryFieldRepository )

Set the global CategoryFieldRepository

Set the global CategoryFieldRepository

Parameters

$categoryFieldRepository
rsanchez\Deep\Repository\CategoryFieldRepository
$categoryFieldRepository
public static
# setChannelRepository( rsanchez\Deep\Repository\ChannelRepository $channelRepository )

Set the global ChannelRepository

Set the global ChannelRepository

Parameters

$channelRepository
rsanchez\Deep\Repository\ChannelRepository
$channelRepository
public Illuminate\Database\Eloquent\Builder
# scopeWithFields( Illuminate\Database\Eloquent\Builder $query )

Join with category_data

Join with category_data

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query;

Returns

Illuminate\Database\Eloquent\Builder
protected static
# joinTables( )
public Illuminate\Database\Eloquent\Relations\BelongsToMany
# entries( )

Define the entries Eloquent relationship

Define the entries Eloquent relationship

Returns

Illuminate\Database\Eloquent\Relations\BelongsToMany
public
# getAttribute( mixed $name )

Alias custom field names

Alias custom field names
public
# attributesToArray( )
public rsanchez\Deep\Collection\CategoryCollection
# newCollection( array $models = array() )

Parameters

$models
array
$models

Returns

rsanchez\Deep\Collection\CategoryCollection
public Illuminate\Database\Eloquent\Builder
# scopeCategoryId( 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
# scopeNotCategoryId( 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
# scopeCategoryIdString( Illuminate\Database\Eloquent\Builder $query, string $string )

Filter by Category ID string parameter

Filter by Category ID 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
# 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
# scopeParentOnly( Illuminate\Database\Eloquent\Builder $query, boolean $parentsOnly = true )

Parents only, no sub categories

Parents only, no sub categories

Parameters

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

Returns

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

Parents only string parameter

Parents only string parameter

Parameters

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

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
# 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
# scopeEntryChannel( 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
# scopeNotEntryChannel( 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
# scopeEntryChannelString( 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
# scopeShowEmpty( Illuminate\Database\Eloquent\Builder $query, mixed $showEmpty = true )

Filter by categories with no entries

Filter by categories with no entries

Parameters

$query
boolean
$showEmpty
$showEmpty

Returns

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

Show empty string parameter

Show empty string parameter

Parameters

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

Returns

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

Filter by expired entries

Filter by expired entries

Parameters

$query
boolean
$showExpired
$showExpired

Returns

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

Show expired string parameter

Show expired string parameter

Parameters

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

Returns

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

Show empty string parameter

Show empty string parameter

Parameters

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

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 Not Entry Status

Filter by Not Entry Status

Parameters

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

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
# 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 )

Apply an array of parameters

Apply an array of parameters

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query
$parameters
array
$parameters

Returns

Illuminate\Database\Eloquent\Builder
public
# scopeStyleString( Illuminate\Database\Eloquent\Builder $query, mixed $string )
public Illuminate\Database\Eloquent\Builder
# scopeNested( Illuminate\Database\Eloquent\Builder $query )

Order by Category Nesting

Order by Category Nesting

Parameters

$query
Illuminate\Database\Eloquent\Builder
$query

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 rsanchez\Deep\Collection\FieldCollection
# getFields( )

Get all the category custom fields

Get all the category custom fields

Returns

rsanchez\Deep\Collection\FieldCollection
Methods used from rsanchez\Deep\Model\JoinableTrait
(), (), (), ()
Properties summary
protected string $table 'categories'
#
protected string $primaryKey 'cat_id'
#
protected boolean $nested false
#

Whether to build the collection as a nested set

Whether to build the collection as a nested set
protected rsanchez\Deep\Collection\NestedCategoryCollection $childCategoryCollection
#

Collection of child categories

Collection of child categories
protected static rsanchez\Deep\Repository\CategoryFieldRepository $categoryFieldRepository
#

Global Category Field Repository

Global Category Field Repository
protected static rsanchez\Deep\Repository\ChannelRepository $channelRepository
#

Global Channel Repository

Global Channel Repository
API documentation generated by ApiGen 2.8.0