-
Backend
-
Behaviors
-
FormController
-
ImportExportController
-
ListController
-
RelationController
- FormController
- ImportExportController
- ListController
- RelationController
- ReorderController
- UserPreferencesModel
-
-
Classes
-
Dashboard
-
NavigationManager
-
WidgetManager
- AuthManager
- BackendController
- Controller
- ControllerBehavior
- DashboardManager
- DashboardWidgetBase
- FilterScope
- FilterWidgetBase
- FormField
- FormTabs
- FormWidgetBase
- ListColumn
- LoginCustomization
- MainMenuItem
- NavigationManager
- ReportDataSourceBase
- ReportDataSourceManager
- ReportWidgetBase
- RoleManager
- RolePermission
- SettingsController
- SideMenuItem
- Skin
- StaticReportWidgetContainer
- VueComponentBase
- WidgetBase
- WidgetManager
- WildcardController
-
-
Controllers
-
Database
-
Facades
-
FilterWidgets
-
FormWidgets
-
Helpers
-
Models
-
BrandSetting
-
ExportModel
-
ImportModel
- AccessLog
- BrandSetting
- Dashboard
- EditorSetting
- ExportModel
- ImportModel
- Preference
- ReportDataCache
- User
- UserGroup
- UserPreference
- UserPreferenceModel
- UserRole
- UserThrottle
-
-
ReportWidgets
-
Skins
-
Traits
-
VueComponents
-
Widgets
-
Filter
-
Form
-
Lists
-
Table
- Filter
- Form
- Lists
- ListStructure
- ReportContainer
- RoleImpersonator
- Search
- SiteSwitcher
- Table
- Toolbar
-
- ServiceProvider
-
-
Cms
-
Classes
-
Controller
-
EditorExtension
-
Layout
-
Page
-
Partial
-
Theme
- AjaxResponse
- Asset
- CmsCompoundObject
- CmsController
- CmsDemoTrafficDataGenerator
- CmsException
- CmsObject
- CmsObjectCache
- CmsObjectCollection
- CmsReportDataSource
- CmsStatusDataSource
- CodeBase
- CodeParser
- ComponentBase
- ComponentBehavior
- ComponentHelpers
- ComponentManager
- ComponentModuleBase
- ComponentPartial
- Content
- Controller
- EditorExtension
- Layout
- LayoutCode
- Meta
- Page
- PageCode
- PageManager
- Partial
- PartialCode
- PartialStack
- PartialWatcher
- Router
- Snippet
- SnippetManager
- Theme
- ThemeManager
- ThisVariable
- TrafficLogger
-
-
Components
-
Console
-
Controllers
-
Database
-
Facades
-
FormWidgets
-
Helpers
-
Models
-
ReportWidgets
-
Traits
-
Twig
- AjaxPartialTokenParser
- ComponentNode
- ComponentTokenParser
- ContentNode
- ContentTokenParser
- DebugExtension
- DefaultNode
- DefaultTokenParser
- Extension
- FlashNode
- FlashTokenParser
- FrameworkNode
- FrameworkTokenParser
- GetAttrAdjuster
- GetAttrNode
- Loader
- MetaNode
- MetaTokenParser
- PageNode
- PageTokenParser
- PartialNode
- PartialTokenParser
- PlaceholderNode
- PlaceholderTokenParser
- PutNode
- PutTokenParser
- ScriptsNode
- ScriptsTokenParser
- StylesNode
- StylesTokenParser
-
VueComponents
-
Widgets
- ServiceProvider
-
-
Editor
-
Behaviors
-
Classes
-
Controllers
-
Traits
-
VueComponents
- ServiceProvider
-
-
Media
-
Classes
-
Controllers
-
FormWidgets
-
Helpers
-
Twig
-
Widgets
- ServiceProvider
-
-
System
-
Behaviors
-
Classes
-
PresetManager
-
SiteManager
-
UiManager
-
UpdateManager
- AppBase
- CombineAssets
- DependencyResolver
- DriverBehavior
- ErrorHandler
- MailManager
- ManifestCache
- MarkupExtensionItem
- MarkupManager
- ModelBehavior
- PagerElement
- PluginBase
- PluginManager
- PresetManager
- ProductDetail
- RateLimiter
- ResizeImageItem
- ResizeImages
- SettingsManager
- SettingsMenuItem
- SiteManager
- SystemController
- SystemReportDataSource
- UiElement
- UiManager
- UpdateManager
- VersionManager
-
-
Console
- ComposerScript
- OctoberAbout
- OctoberDown
- OctoberFresh
- OctoberMigrate
- OctoberMirror
- OctoberOptimize
- OctoberPasswd
- OctoberUp
- OctoberUpdate
- OctoberUtil
- OctoberUtilCommands
- OctoberUtilPatches
- OctoberUtilRefitLang
- PluginCheck
- PluginDisable
- PluginEnable
- PluginInstall
- PluginList
- PluginRefresh
- PluginRemove
- PluginSeed
- PluginTest
- ProjectSync
-
Controllers
-
Database
-
Facades
-
Helpers
-
Middleware
-
Models
-
ReportWidgets
-
Traits
-
Twig
-
Widgets
- ServiceProvider
-
-
Tailor
-
Behaviors
-
Classes
-
Blueprint
-
BlueprintIndexer
-
EditorExtension
-
Relations
-
SchemaBuilder
-
Scopes
- Blueprint
- BlueprintCollection
- BlueprintErrorData
- BlueprintException
- BlueprintIndexer
- BlueprintModel
- BlueprintVerifier
- ComponentVariable
- ContentFieldBase
- EditorExtension
- FieldManager
- Fieldset
- NavigationItem
- PermissionItem
- RecordIndexer
- SchemaBuilder
- SchemaPruner
-
-
Components
-
Console
-
ContentFields
-
Controllers
-
Models
-
EntryRecord
-
GlobalRecord
-
RecordImport
- ContentSchema
- EntryRecord
- GlobalRecord
- NestedFormItem
- PreviewToken
- RecordExport
- RecordImport
- RepeaterItem
-
-
Traits
-
VueComponents
- ServiceProvider
-
-
Events
-
backend
-
ajax
-
brand
-
files
-
filter
-
form
-
list
-
menu
-
page
-
roles
-
site
-
user
-
-
cms
-
ajax
-
block
-
combiner
-
component
-
internalTrafficStatistics
-
object
-
page
-
pageLookup
-
resizer
-
router
-
sitePicker
-
template
-
theme
- extendTwig
-
-
deferredBinding
-
editor
-
extension
-
-
exception
-
halcyon
-
datasource
-
-
mailer
-
media
-
model
-
auth
-
filter
-
form
-
relation
-
/docs/api/model/relation/add
-
/docs/api/model/relation/associate
- attach
-
/docs/api/model/relation/beforeadd
-
/docs/api/model/relation/beforeassociate
- beforeAttach
- beforeDetach
-
/docs/api/model/relation/beforedissociate
-
/docs/api/model/relation/beforeremove
- detach
-
/docs/api/model/relation/dissociate
-
/docs/api/model/relation/remove
-
-
/docs/api/model/afterboot
-
/docs/api/model/aftercreate
-
/docs/api/model/afterdelete
-
/docs/api/model/afterfetch
-
/docs/api/model/afterinit
- afterRelation
- afterRestore
-
/docs/api/model/aftersave
- afterTrash
-
/docs/api/model/afterupdate
- afterValidate
-
/docs/api/model/beforecreate
-
/docs/api/model/beforedelete
-
/docs/api/model/beforefetch
- beforeGetAttribute
- beforeRelation
- beforeReplicate
- beforeRestore
-
/docs/api/model/beforesave
- beforeSetAttribute
-
/docs/api/model/beforeupdate
- beforeValidate
- extendBlueprint
- getAttribute
- newInstance
- saveInternal
- setAttribute
-
-
pages
-
snippet
-
-
site
-
system
-
assets
- beforeAddAsset
-
/docs/api/system/assets/beforebundleasset
-
console
-
mirror
-
-
mail
-
reportwidgets
-
resizer
-
settings
-
site
-
updater
- extendConfigFile
- extendTwig
-
-
tailor
-
user
-
-
Library
-
Argon
-
Assetic
-
Asset
-
Cache
-
Exception
-
Factory
-
Filter
-
Traits
-
Util
- README
- AsseticServiceProvider
- AssetManager
- AssetWriter
- Combiner
- FilterManager
-
-
Auth
-
Combine
-
Composer
-
Config
-
Database
-
Attach
-
Concerns
-
Connections
-
Connectors
-
Factories
-
Models
-
Relations
-
Schema
-
Scopes
-
Traits
-
Updates
- README
- Builder
- Collection
- DatabaseServiceProvider
- Dongle
- ExpandoModel
- MigrationServiceProvider
- Model
- ModelBehavior
- ModelException
- MorphPivot
- NestedTreeScope
- Pivot
- QueryBuilder
- Replicator
- SortableScope
- TreeCollection
- Updater
-
-
Element
-
Filter
-
Form
-
Lists
-
Navigation
- ElementBase
- ElementHolder
-
-
Events
-
Exception
-
Extension
-
Filesystem
-
Flash
-
Foundation
-
Bootstrap
-
Console
-
Exception
-
Http
-
Middleware
- Kernel
-
-
Providers
- Application
-
-
Halcyon
-
Concerns
-
Datasource
-
Exception
-
Processors
-
Traits
- README
- Builder
- Collection
- HalcyonServiceProvider
- Model
-
-
Html
-
Mail
-
Network
-
Parse
-
Resize
-
Router
-
Scaffold
-
Support
-
Debug
-
Facades
-
Traits
- README
- Arr
- ClassLoader
- Collection
- Facade
- ModuleServiceProvider
- SafeCollection
- ServiceProvider
- Singleton
- Str
-
-
Translation
-
Validation
-
- Documentation
- API
- Tailor
- Models
- EntryRecord
Tailor\Models\EntryRecord
Overview
EntryRecord model for content
Extends
- Tailor\Classes\BlueprintModel
- Model
- October\Rain\Database\Model
- Illuminate\Database\Eloquent\Model
Implements
- Illuminate\Contracts\Support\Arrayable
- ArrayAccess
- Illuminate\Contracts\Support\CanBeEscapedWhenCastToString
- Illuminate\Contracts\Broadcasting\HasBroadcastChannel
- Illuminate\Contracts\Support\Jsonable
- JsonSerializable
- Illuminate\Contracts\Queue\QueueableEntity
- Illuminate\Contracts\Routing\UrlRoutable
- Stringable
Public Properties
public array $rules
rules for validation
public array $attributeNames
attributeNames of custom attributes
public array $customMessages
customMessages of custom error messages
public string $contentGroupFrom
contentGroupFrom attribute
public array $fieldModifiers
fieldModifiers are attributes that are hard coded by the model but can still extend the model using their content fields.
public bool $validationForced
validationForced is an internal marker to indicate if force option was used.
Show inherited public properties
Inherited Public Properties
- $implement - behaviors for this model. (defined in October\Rain\Database\Model)
- $attributes - are public so behaviors can modify them. (defined in October\Rain\Database\Model)
- $trimStrings - will trim all string attributes of whitespace. (defined in October\Rain\Database\Model)
- $incrementing - Indicates if the IDs are auto-incrementing. (defined in Illuminate\Database\Eloquent\Model)
- $preventsLazyLoading - Indicates whether lazy loading will be prevented on this model. (defined in Illuminate\Database\Eloquent\Model)
- $exists - Indicates if the model exists. (defined in Illuminate\Database\Eloquent\Model)
- $wasRecentlyCreated - Indicates if the model was inserted during the current request lifecycle. (defined in Illuminate\Database\Eloquent\Model)
- $snakeAttributes - Indicates whether attributes are snake cased on arrays. (defined in Illuminate\Database\Eloquent\Model)
- $encrypter - The encrypter instance that is used to encrypt attributes. (defined in Illuminate\Database\Eloquent\Model)
- $manyMethods - The many to many relationship methods. (defined in Illuminate\Database\Eloquent\Model)
- $timestamps - Indicates if the model should be timestamped. (defined in Illuminate\Database\Eloquent\Model)
- $hasOne - related record, inverse of belongsTo. (defined in October\Rain\Database\Model)
- $hasMany - related records, inverse of belongsTo. (defined in October\Rain\Database\Model)
-
$belongsTo - another record with a local key attribute
protected $belongsTo = [ 'parent' => [Category::class, 'key' => 'parent_id'] ]; (defined in October\Rain\Database\Model)
- $belongsToMany - to multiple records using a join table. (defined in October\Rain\Database\Model)
-
$morphTo - another record using local key and type attributes
protected $morphTo = [ 'pictures' => [] ]; (defined in October\Rain\Database\Model)
- $morphOne - related record, inverse of morphTo. (defined in October\Rain\Database\Model)
- $morphMany - related records, inverse of morphTo. (defined in October\Rain\Database\Model)
- $morphToMany - to multiple records using a join table. (defined in October\Rain\Database\Model)
- $morphedByMany - to a polymorphic, inverse many-to-many relationship. (defined in October\Rain\Database\Model)
- $attachOne - file attachment. (defined in October\Rain\Database\Model)
- $attachMany - file attachments. (defined in October\Rain\Database\Model)
- $hasManyThrough - is related records through another record. (defined in October\Rain\Database\Model)
- $hasOneThrough - is a related record through another record. (defined in October\Rain\Database\Model)
- $sessionKey - is a unique session key used for deferred binding. (defined in October\Rain\Database\Model)
Protected Properties
protected array $fillable
fillable fields, in addition to those dynamically added by content fields
protected array $dates
dates attributes that should be mutated to dates
protected array $propagatable
propagatable list of attributes to propagate to other sites.
protected string|null $draftableSaveMode
draftableSaveMode for saving the draft.
protected array $draftableSaveAttrs
draftableSaveAttrs contains draft notes.
protected int $moveToNewParentId
moveToNewParentId indicates if the model should be aligned to new parent.
protected EntryBlueprint $blueprintCache
protected bool $forceDeleting
forceDeleting indicates if the model is currently force deleting.
protected Illuminate\Support\MessageBag $validationErrors
validationErrors message bag instance containing validation error messages
protected array $validationDefaultAttrNames
validationDefaultAttrNames default custom attribute names
Show inherited protected properties
Inherited Protected Properties
- $isBlueprintExtended - prevents multiple extensions. (defined in Tailor\Classes\BlueprintModel)
- $savingOptions - used by the {@link save()} method. (defined in October\Rain\Database\Model)
- $connection - The connection name for the model. (defined in Illuminate\Database\Eloquent\Model)
- $table - The table associated with the model. (defined in Illuminate\Database\Eloquent\Model)
- $primaryKey - The primary key for the model. (defined in Illuminate\Database\Eloquent\Model)
- $keyType - The "type" of the primary key ID. (defined in Illuminate\Database\Eloquent\Model)
- $with - The relations to eager load on every query. (defined in Illuminate\Database\Eloquent\Model)
- $withCount - The relationship counts that should be eager loaded on every query. (defined in Illuminate\Database\Eloquent\Model)
- $perPage - The number of models to return for pagination. (defined in Illuminate\Database\Eloquent\Model)
- $escapeWhenCastingToString - Indicates that the object's string representation should be escaped when __toString is invoked. (defined in Illuminate\Database\Eloquent\Model)
- $resolver - The connection resolver instance. (defined in Illuminate\Database\Eloquent\Model)
- $dispatcher - The event dispatcher instance. (defined in Illuminate\Database\Eloquent\Model)
- $booted - The array of booted models. (defined in Illuminate\Database\Eloquent\Model)
- $traitInitializers - The array of trait initializers that will be called on each new instance. (defined in Illuminate\Database\Eloquent\Model)
- $globalScopes - The array of global scopes on the model. (defined in Illuminate\Database\Eloquent\Model)
- $ignoreOnTouch - The list of models classes that should not be affected with touch. (defined in Illuminate\Database\Eloquent\Model)
- $modelsShouldPreventLazyLoading - Indicates whether lazy loading should be restricted on all models. (defined in Illuminate\Database\Eloquent\Model)
- $lazyLoadingViolationCallback - The callback that is responsible for handling lazy loading violations. (defined in Illuminate\Database\Eloquent\Model)
- $modelsShouldPreventSilentlyDiscardingAttributes - Indicates if an exception should be thrown instead of silently discarding non-fillable attributes. (defined in Illuminate\Database\Eloquent\Model)
- $discardedAttributeViolationCallback - The callback that is responsible for handling discarded attribute violations. (defined in Illuminate\Database\Eloquent\Model)
- $modelsShouldPreventAccessingMissingAttributes - Indicates if an exception should be thrown when trying to access a missing attribute on a retrieved model. (defined in Illuminate\Database\Eloquent\Model)
- $missingAttributeViolationCallback - The callback that is responsible for handling missing attribute violations. (defined in Illuminate\Database\Eloquent\Model)
- $isBroadcasting - Indicates if broadcasting is currently enabled. (defined in Illuminate\Database\Eloquent\Model)
- $original - The model attribute's original state. (defined in Illuminate\Database\Eloquent\Model)
- $changes - The changed model attributes. (defined in Illuminate\Database\Eloquent\Model)
- $casts - The attributes that should be cast. (defined in Illuminate\Database\Eloquent\Model)
- $classCastCache - The attributes that have been cast using custom classes. (defined in Illuminate\Database\Eloquent\Model)
- $attributeCastCache - The attributes that have been cast using "Attribute" return type mutators. (defined in Illuminate\Database\Eloquent\Model)
- $primitiveCastTypes - The built-in, primitive cast types supported by Eloquent. (defined in Illuminate\Database\Eloquent\Model)
- $dateFormat - The storage format of the model's date columns. (defined in Illuminate\Database\Eloquent\Model)
- $appends - The accessors to append to the model's array form. (defined in Illuminate\Database\Eloquent\Model)
- $mutatorCache - The cache of the mutated attributes for each class. (defined in Illuminate\Database\Eloquent\Model)
- $attributeMutatorCache - The cache of the "Attribute" return type marked mutated attributes for each class. (defined in Illuminate\Database\Eloquent\Model)
- $getAttributeMutatorCache - The cache of the "Attribute" return type marked mutated, gettable attributes for each class. (defined in Illuminate\Database\Eloquent\Model)
- $setAttributeMutatorCache - The cache of the "Attribute" return type marked mutated, settable attributes for each class. (defined in Illuminate\Database\Eloquent\Model)
- $castTypeCache - The cache of the converted cast types. (defined in Illuminate\Database\Eloquent\Model)
- $dispatchesEvents - The event map for the model. (defined in Illuminate\Database\Eloquent\Model)
- $observables - User exposed observable events. (defined in Illuminate\Database\Eloquent\Model)
- $relations - The loaded relationships for the model. (defined in Illuminate\Database\Eloquent\Model)
- $touches - The relationships that should be touched on save. (defined in Illuminate\Database\Eloquent\Model)
- $relationResolvers - The relation resolver callbacks. (defined in Illuminate\Database\Eloquent\Model)
- $ignoreTimestampsOn - The list of models classes that have timestamps temporarily disabled. (defined in Illuminate\Database\Eloquent\Model)
- $hidden - The attributes that should be hidden for serialization. (defined in Illuminate\Database\Eloquent\Model)
- $visible - The attributes that should be visible in serialization. (defined in Illuminate\Database\Eloquent\Model)
- $guarded - The attributes that aren't mass assignable. (defined in Illuminate\Database\Eloquent\Model)
- $unguarded - Indicates if all mass assignment is enabled. (defined in Illuminate\Database\Eloquent\Model)
- $guardableColumns - The actual columns that exist on the database and can be guarded. (defined in Illuminate\Database\Eloquent\Model)
- $eventsBooted - is an array of models booted events. (defined in October\Rain\Database\Model)
- $jsonable - attribute names that are json encoded and decoded from the database. (defined in October\Rain\Database\Model)
- $relationTypes - expected, used to cycle and verify relationships. (defined in October\Rain\Database\Model)
- $emitterSingleEventCollection - of events to be fired once only. (defined in October\Rain\Database\Model)
- $emitterEventCollection - of all registered events. (defined in October\Rain\Database\Model)
- $emitterEventSorted - collection. (defined in October\Rain\Database\Model)
- $extensionData - contains class reflection information, including behaviors. (defined in October\Rain\Database\Model)
- $extendableStaticMethods - is a collection of static methods used by behaviors. (defined in October\Rain\Database\Model)
- $extendableGuardProperties - indicates if dynamic properties can be created. (defined in October\Rain\Database\Model)
Public Methods
public addPropagatable()
public addPropagatable(array|string|null $attributes = null): void
addPropagatable attributes for the model.
public addValidationRule()
public addValidationRule($name, $definition): void
addValidationRule will append a rule to the stack and reset the value as a processed array
public afterBoot()
public afterBoot(): void
public beforeCreate()
public beforeCreate(): void
public beforeUpdate()
public beforeUpdate(): void
public static bootDraftableModel()
public static bootDraftableModel(): void
bootDraftableModel trait for a model.
public static bootMultisite()
public static bootMultisite(): void
bootMultisite trait for a model.
public static bootNestedTree()
public static bootNestedTree(): void
bootNestedTree disables the inherited trait
public static bootSoftDelete()
public static bootSoftDelete(): void
bootSoftDelete trait for a model.
public static bootVersionableModel()
public static bootVersionableModel(): void
bootVersionableModel trait for a model.
public canDeleteMultisiteRelation()
public canDeleteMultisiteRelation($name, $type = null): bool
canDeleteMultisiteRelation checks if a relation has the potential to be shared with the current model. If there are 2 or more records in existence, then this method will prevent the cascading deletion of relations.
See Also
public countDrafts()
public countDrafts(): int
countDrafts will return the number of available drafts.
public countVersions()
public countVersions(): int
countVersions will return the number of available versions.
public createNewDraft()
public createNewDraft($attrs = []): void
public defineFilterScopes()
public defineFilterScopes($host): void
public defineFormFields()
public defineFormFields($host): void
public defineListColumns()
public defineListColumns($host): void
public definePrimaryFormFields()
public definePrimaryFormFields($host): void
public defineSecondaryFormFields()
public defineSecondaryFormFields($host): void
public deleteDescendants()
public deleteDescendants(): void
deleteDescendants deletes a branch off the tree, shifting all the elements on the right back to the left so the counts work.
public deleteForSite()
public deleteForSite($siteId = null): void
deleteForSite runs the delete command on a model for another site, useful for cleaning up records for other sites when the parent is deleted.
public duplicateRecord()
public duplicateRecord(): void
public errors()
public errors(): Illuminate\Support\MessageBag
errors gets validation error message collection for the Model
public extendDeferredContentModel()
public extendDeferredContentModel($model): void
public static extendInSection()
public static extendInSection($handle, $callback): void
public static extendInSectionUuid()
public static extendInSectionUuid($uuid, $callback): void
public findForSite()
public findForSite($siteId = null): void
findForSite will locate a record for a specific site.
public findOrCreateForSite()
public findOrCreateForSite($siteId = null): void
public static findSingleForSection()
public static findSingleForSection($handle): Tailor\Models\EntryRecord
public static findSingleForSectionUuid()
public static findSingleForSectionUuid($uuid): Tailor\Models\EntryRecord
public forceDelete()
public forceDelete(): void
forceDelete on a soft deleted model.
public forceSave()
public forceSave($options = null, $sessionKey = null): bool
forceSave the model even if validation fails
public getAll()
public getAll($columns = 0 => '*']): [October\Rain\Database\Collection
getAll returns all nodes and children.
public getAllChildren()
public getAllChildren(): October\Rain\Database\Collection
getAllChildren returns all children down the tree.
public getAllChildrenAndSelf()
public getAllChildrenAndSelf(): October\Rain\Database\Collection
getAllChildrenAndSelf returns all children and self.
public getBlueprintDefinition()
public getBlueprintDefinition(): Tailor\Classes\Blueprint\EntryBlueprint
public getChildCount()
public getChildCount(): int
getChildCount returns number of all children below it.
public getChildren()
public getChildren(): October\Rain\Database\Collection
getChildren returns direct child nodes.
public getContentGroupOptions()
public getContentGroupOptions(): void
public getDeletedAtColumn()
public getDeletedAtColumn(): string
getDeletedAtColumn gets the name of the "deleted at" column.
public getDepth()
public getDepth(): int
getDepth column value.
public getDepthColumnName()
public getDepthColumnName(): string
public getDraftId()
public getDraftId(): string
public getDraftModeColumn()
public getDraftModeColumn(): int
getDraftModeColumn returns the value of the draft column.
public getDraftModeColumnName()
public getDraftModeColumnName(): string
getDraftModeColumnName gets the name of the "draft_mode" column.
public getDraftName()
public getDraftName(): string
public getDraftNotes()
public getDraftNotes(): string
public getDraftRecords()
public getDraftRecords(): void
public getEagerChildren()
public getEagerChildren(): October\Rain\Database\Collection
getEagerChildren returns direct child nodes, with ->children eager loaded.
public getEagerRoot()
public getEagerRoot(): October\Rain\Database\Collection
getEagerRoot returns a list of all root nodes, with children eager loaded.
public getEntryTypeAttribute()
public getEntryTypeAttribute(): void
public getEntryTypeNameAttribute()
public getEntryTypeNameAttribute(): void
public getIsVersionColumn()
public getIsVersionColumn(): string
getIsVersionColumn gets the name of the "is_version" column.
public getLeaves()
public getLeaves(): October\Rain\Database\Collection
getLeaves returns all final nodes without children.
public getLeft()
public getLeft(): int
getLeft column value.
public getLeftColumnName()
public getLeftColumnName(): string
public getLeftSibling()
public getLeftSibling(): October\Rain\Database\Model
public getLevel()
public getLevel(): int
getLevel returns the level of this node in the tree. Root level is 0.
public getMorphClass()
public getMorphClass(): string
getMorphClass adds dynamic table support
public getMultisiteConfig()
public getMultisiteConfig($key, $default = null): void
getMultisiteConfig returns an sync option configured for multisite
public getMultisiteSyncSites()
public getMultisiteSyncSites(): array
public getParent()
public getParent(): October\Rain\Database\Collection
getParent returns the direct parent node.
public getParentColumnName()
public getParentColumnName(): string
public getParentId()
public getParentId(): int
getParentId gets value of the model parent_id column.
public getParentIdOptions()
public getParentIdOptions(): void
public getParents()
public getParents(): October\Rain\Database\Collection
getParents returns all parents up the tree.
public getParentsAndSelf()
public getParentsAndSelf(): October\Rain\Database\Collection
getParentsAndSelf returns all parents up the tree and self.
public getQualifiedDeletedAtColumn()
public getQualifiedDeletedAtColumn(): string
getQualifiedDeletedAtColumn gets the fully qualified "deleted at" column.
public getQualifiedDepthColumnName()
public getQualifiedDepthColumnName(): string
public getQualifiedDraftModeColumnName()
public getQualifiedDraftModeColumnName(): string
getQualifiedDraftModeColumnName gets the fully qualified "draft_mode" column.
public getQualifiedIsVersionColumn()
public getQualifiedIsVersionColumn(): string
getQualifiedIsVersionColumn gets the fully qualified "is_version" column.
public getQualifiedLeftColumnName()
public getQualifiedLeftColumnName(): string
public getQualifiedParentColumnName()
public getQualifiedParentColumnName(): string
public getQualifiedRightColumnName()
public getQualifiedRightColumnName(): string
public getQualifiedSiteIdColumn()
public getQualifiedSiteIdColumn(): string
getQualifiedSiteIdColumn gets the fully qualified "site id" column.
public getRight()
public getRight(): int
getRight column value.
public getRightColumnName()
public getRightColumnName(): string
public getRightSibling()
public getRightSibling(): October\Rain\Database\Model
public getRoot()
public getRoot(): October\Rain\Database\Model
getRoot returns the root node starting from the current node.
public getRootList()
public getRootList( $column, $key = null, $indent = ' ' ): array
getRootList returns an array column/key pair of all root nodes, with children eager loaded.
public getSiblings()
public getSiblings(): October\Rain\Database\Collection
getSiblings returns all siblings (parent's children).
public getSiblingsAndSelf()
public getSiblingsAndSelf(): October\Rain\Database\Collection
public getSiteIdColumn()
public getSiteIdColumn(): string
getSiteIdColumn gets the name of the "site id" column.
public getStatusCodeAttribute()
public getStatusCodeAttribute(): void
public getStatusCodeOptions()
public getStatusCodeOptions(): void
getStatusNameOptions
public getVersionRecords()
public getVersionRecords(): void
public static inSection()
public static inSection($handle): void
public static inSectionUuid()
public static inSectionUuid($uuid): void
public initializeDeferredContentModel()
public initializeDeferredContentModel(): void
bootDeferredContentModel trait for a model.
public initializeDraftableModel()
public initializeDraftableModel(): void
public initializeHasEntryBlueprint()
public initializeHasEntryBlueprint(): void
bootNestedTree constructor
public initializeMultisite()
public initializeMultisite(): void
public initializeNestedTree()
public initializeNestedTree(): void
initializeNestedTree disables the inherited trait
public initializeNestedTreeModel()
public initializeNestedTreeModel(): void
initializeNestedTreeModel constructor
public initializeValidation()
public initializeValidation(): void
initializeValidation for this model
public initializeVersionableModel()
public initializeVersionableModel(): void
public isAttributePropagatable()
public isAttributePropagatable($attribute): bool
public isAttributeRequired()
public isAttributeRequired( string $attribute, bool $checkDependencies = true ): bool
isAttributeRequired determines if an attribute is required based on the validation rules. checkDependencies checks the attribute dependencies (for required_if & required_with rules). Note that it will only be checked up to the next level, if another dependent rule is found then it will just assume the field is required.
public isChild()
public isChild(): bool
isChild returns true if this is a child node.
public isDescendantOf()
public isDescendantOf(NestedSet $other): bool
isDescendantOf returns true if node is a descendant.
public isDraftStatus()
public isDraftStatus(): bool
public isEntryEnabledByDefault()
public isEntryEnabledByDefault(): bool
public isEntrySingle()
public isEntrySingle(): bool
public isEntryStream()
public isEntryStream(): bool
public isEntryStructure()
public isEntryStructure(): bool
public isFirstDraftStatus()
public isFirstDraftStatus(): bool
public isInsideSubtree()
public isInsideSubtree(Model $node): bool
isInsideSubtree checks if the supplied node is inside the subtree of this model.
public isLeaf()
public isLeaf(): bool
isLeaf returns true if this is a leaf node (end of a branch).
public isMultisiteEnabled()
public isMultisiteEnabled(): bool
isMultisiteEnabled allows for programmatic toggling
public isMultisiteSyncEnabled()
public isMultisiteSyncEnabled(): bool
public isRoot()
public isRoot(): bool
isRoot returns true if this is a root node.
public isSoftDelete()
public isSoftDelete(): bool
isSoftDelete helper method to check if the model is currently being hard or soft deleted, useful in events.
public isUnsavedDraftStatus()
public isUnsavedDraftStatus(): bool
public isVersionStatus()
public isVersionStatus(): bool
public makeChildOf()
public makeChildOf($node): October\Rain\Database\Model
makeChildOf makes model node a child of specified node.
public makeRoot()
public makeRoot(): October\Rain\Database\Model
makeRoot makes this model a root node.
public moveAfter()
public moveAfter($node): October\Rain\Database\Model
moveAfter moves to the model to after (right) a specified node.
public moveBefore()
public moveBefore($node): October\Rain\Database\Model
moveBefore moves to the model to before (left) specified node.
public moveLeft()
public moveLeft(): October\Rain\Database\Model
moveLeft finds the left sibling and move to left of it.
public moveRight()
public moveRight(): October\Rain\Database\Model
moveRight finds the right sibling and move to the right of it.
public moveToNewParent()
public moveToNewParent(): void
moveToNewParent will realign the nesting if the parent identifier is dirty.
public multisiteAfterCreate()
public multisiteAfterCreate(): void
multisiteAfterCreate constructor event used internally
public multisiteAfterDelete()
public multisiteAfterDelete(): void
public multisiteBeforeSave()
public multisiteBeforeSave(): void
multisiteBeforeSave constructor event used internally
public multisiteSaveComplete()
public multisiteSaveComplete(): void
multisiteSaveComplete constructor event used internally
public newCollection()
public newCollection($models = []): void
newCollection returns a custom TreeCollection collection.
public newOtherSiteQuery()
public newOtherSiteQuery(): void
public static onlyTrashed()
public static onlyTrashed(): Illuminate\Database\Eloquent\Builder|static
onlyTrashed gets a new query builder that only includes soft deletes.
public propagateToSite()
public propagateToSite($siteId, $otherModel = null): void
propagateToSite will save propagated fields to other records
public removeValidationRule()
public removeValidationRule($name, $definition): void
removeValidationRule removes a validation rule from the stack and resets the value as a processed array
public resetTreeNesting()
public resetTreeNesting(): void
resetTreeNesting can be used to repair corrupt or missing tree definitions, it will flatten and heal the necessary columns, all parent and child associations are retained.
public resetTreeOrphans()
public resetTreeOrphans(): void
resetTreeOrphans can be used to locate orphaned records, those that refer to a parent_id value where the associated record no longer exists, and promote them to be visible in the collection again, by setting the parent column to null.
public restore()
public restore(): bool|null
restore a soft-deleted model instance.
public restoreDescendants()
public restoreDescendants(): void
restoreDescendants of the current node.
public restoreVersionSnapshot()
public restoreVersionSnapshot($toModel): void
public static restored()
public static restored(Closure|string $callback): void
restored registers a restored model event with the dispatcher.
public static restoring()
public static restoring(Closure|string $callback): void
restoring registers a restoring model event with the dispatcher.
public saveAsFirstDraft()
public saveAsFirstDraft($attrs = []): void
public savePropagate()
public savePropagate($options = null, $sessionKey = null): bool
savePropagate the model, including to other sites
public saveVersionSnapshot()
public saveVersionSnapshot($attrs = []): void
public scopeAllChildren()
public scopeAllChildren( $query, $includeSelf = false ): Illuminate\Database\Query\Builder
scopeAllChildren sets of all children & nested children.
public scopeApplyDraftStatus()
public scopeApplyDraftStatus($query): void
scopeApplyPublished
public scopeApplyExpiredStatus()
public scopeApplyExpiredStatus($query): void
scopeApplyPublished
public scopeApplyHiddenStatus()
public scopeApplyHiddenStatus($query): void
public scopeApplyOtherSiteRoot()
public scopeApplyOtherSiteRoot( Illuminate\Database\Eloquent\Builder $query, string|\Illuminate\Database\Eloquent\Model $idOrModel ): Illuminate\Database\Eloquent\Builder
scopeApplyOtherSiteRoot is used to resolve a model using its ID or its root ID. For example, finding a model using attributes from another site, or finding all connected models for all sites.
public scopeApplyPublishedStatus()
public scopeApplyPublishedStatus($query): void
scopeApplyPublished
public scopeApplyScheduledStatus()
public scopeApplyScheduledStatus($query): void
scopeApplyPublished
public scopeApplyStatusFromFilter()
public scopeApplyStatusFromFilter($query, $scope): void
public scopeApplyVisibleFrontend()
public scopeApplyVisibleFrontend($query): void
scopeApplyVisibleFrontend adds visibility to the front end with support for preview tokens
public scopeGetAllRoot()
public scopeGetAllRoot($query): October\Rain\Database\Collection
scopeGetAllRoot returns a list of all root nodes, without eager loading.
public scopeGetNested()
public scopeGetNested($query): Collection
scopeGetNested is a non-chaining scope, returns an eager loaded hierarchy tree. Children are eager loaded inside the $model->children relation.
public scopeLeaves()
public scopeLeaves($query): Illuminate\Database\Query\Builder
scopeLeaves returns all final nodes without children.
public scopeListsNested()
public scopeListsNested( string $column, string $key, string $indent = null, $indent = ' ' ): array
scopeListsNested gets an array with values of a given column. Values are indented according to their depth.
public scopeParents()
public scopeParents( $query, $includeSelf = false ): Illuminate\Database\Eloquent\Builder
scopeParents returns a prepared query with all parents up the tree.
public scopeSiblings()
public scopeSiblings( $query, $includeSelf = false ): Illuminate\Database\Eloquent\Builder
scopeSiblings filters targeting all children of the parent, except self.
public scopeWithoutNode()
public scopeWithoutNode($query, $node): Illuminate\Database\Query\Builder
scopeWithoutNode extracts a certain node object from the current query expression.
public scopeWithoutRoot()
public scopeWithoutRoot($query): Illuminate\Database\Query\Builder
scopeWithoutRoot extracts first root (from the current node context) from current query expression.
public scopeWithoutSelf()
public scopeWithoutSelf($query): Illuminate\Database\Query\Builder
scopeWithoutSelf extracts current node (self) from current query expression.
public setDefaultContentGroup()
public setDefaultContentGroup($defaultGroup = null): void
setDefaultContentGroup populate the default content group for new records
public setDefaultLeftAndRight()
public setDefaultLeftAndRight(): void
setDefaultLeftAndRight columns
public setDepth()
public setDepth(): October\Rain\Database\Model
setDepth sets the depth attribute.
public setDraftAutosave()
public setDraftAutosave($attrs): void
public setDraftCommit()
public setDraftCommit($attrs): void
public setDraftPublish()
public setDraftPublish(): void
public setValidationAttributeName()
public setValidationAttributeName(string $attr, string $name): void
setValidationAttributeName programmatically sets the validation attribute names, will take
lower priority to model defined attribute names found in $attributeNames
public setValidationAttributeNames()
public setValidationAttributeNames(array $attributeNames): void
setValidationAttributeNames programmatically sets multiple validation attribute names
public shiftSiblingsForRestore()
public shiftSiblingsForRestore(): void
shiftSiblingsForRestore allocates a slot for the the current node between its siblings.
public static softDeleted()
public static softDeleted(Closure|string $callback): void
softDeleted registers a "trashed" model event callback with the dispatcher.
public storeNewParent()
public storeNewParent(): void
storeNewParent handles if the parent column is modified so it can be realigned.
public trashed()
public trashed(): bool
trashed determines if the model instance has been soft-deleted.
public useDrafts()
public useDrafts(): bool
public useMultisite()
public useMultisite(): bool
public useMultisiteSync()
public useMultisiteSync(): bool
public useNestedTreeStructure()
public useNestedTreeStructure(): bool
useNestedTreeStructure only for primary records
public useVersions()
public useVersions(): bool
public validate()
public validate( $rules = null, $customMessages = null, $attributeNames = null ): bool
validate the model instance
public static validated()
public static validated(Closure|string $callback): void
validated create a new native event for handling afterValidate()
public static validating()
public static validating(Closure|string $callback): void
validating creates a new native event for handling beforeValidate()
public static withTrashed()
public static withTrashed(): Illuminate\Database\Eloquent\Builder|static
withTrashed gets a new query builder that includes soft deletes.
Inherited Public Methods
- __call() - (defined in October\Rain\Database\Model)
- __callStatic() - Handle dynamic static method calls into the model. (defined in Illuminate\Database\Eloquent\Model)
- __construct() - (defined in October\Rain\Database\Model)
- __get() - (defined in October\Rain\Database\Model)
- __isset() - determines if an attribute or relation exists on the model. (defined in October\Rain\Database\Model)
- __set() - (defined in October\Rain\Database\Model)
- __sleep() - prepare the object for serialization. (defined in October\Rain\Database\Model)
- __toString() - Convert the model to its string representation. (defined in Illuminate\Database\Eloquent\Model)
- __unset() - Unset an attribute on the model. (defined in Illuminate\Database\Eloquent\Model)
- __wakeup() - when a model is being unserialized, check if it needs to be booted. (defined in October\Rain\Database\Model)
- addCasts() - adds attribute casts for the model. (defined in October\Rain\Database\Model)
- addDateAttribute() - adds a datetime attribute to convert to an instance. (defined in October\Rain\Database\Model)
- addDynamicMethod() - programmatically adds a method to the extendable class. (defined in October\Rain\Database\Model)
- addDynamicProperty() - programmatically adds a property to the extendable class. (defined in October\Rain\Database\Model)
- addFillable() - attributes for the model. (defined in October\Rain\Database\Model)
- addGlobalScope() - Register a new global scope on the model. (defined in Illuminate\Database\Eloquent\Model)
- addJsonable() - attributes for the model. (defined in October\Rain\Database\Model)
- addObservableEvents() - Add an observable event name. (defined in Illuminate\Database\Eloquent\Model)
- addVisible() - attributes for the model. (defined in October\Rain\Database\Model)
- all() - Get all of the models from the database. (defined in Illuminate\Database\Eloquent\Model)
- alwaysPush() - pushes the first level of relations even if the parent. (defined in October\Rain\Database\Model)
- append() - Append attributes to query when building a query. (defined in Illuminate\Database\Eloquent\Model)
- asExtension() - is short hand for
getClassExtension()
method, except takes the short. (defined in October\Rain\Database\Model) - attachMany() - defines an attachment one-to-many relationship. (defined in October\Rain\Database\Model)
- attachOne() - defines an attachment one-to-one relationship. (defined in October\Rain\Database\Model)
- attributesToArray() - converts the model's attributes to an array. (defined in October\Rain\Database\Model)
- belongsTo() - defines an inverse one-to-one or many relationship. Overridden from. (defined in October\Rain\Database\Model)
- belongsToMany() - defines a many-to-many relationship. (defined in October\Rain\Database\Model)
- bindDeferred() - binds a deferred relationship to the supplied record. (defined in October\Rain\Database\Model)
- bindEvent() - creates a new event binding. (defined in October\Rain\Database\Model)
- bindEventOnce() - creates a new event binding that fires once only. (defined in October\Rain\Database\Model)
- broadcastChannel() - Get the broadcast channel name that is associated with the given entity. (defined in Illuminate\Database\Eloquent\Model)
- broadcastChannelRoute() - Get the broadcast channel route definition that is associated with the given entity. (defined in Illuminate\Database\Eloquent\Model)
- cacheMutatedAttributes() - Extract and cache all the mutated attributes of a class. (defined in Illuminate\Database\Eloquent\Model)
- callNamedScope() - Apply the given named scope if possible. (defined in Illuminate\Database\Eloquent\Model)
- cancelDeferred() - cancels all deferred bindings to this model. (defined in October\Rain\Database\Model)
- clearBootedModels() - Clear the list of booted models so they will be re-booted. (defined in Illuminate\Database\Eloquent\Model)
- clearExtendedClasses() - (defined in October\Rain\Database\Model)
- commitDeferred() - commits all deferred bindings to this model. (defined in October\Rain\Database\Model)
- create() - a new model and return the instance. (defined in October\Rain\Database\Model)
- created() - Register a created model event with the dispatcher. (defined in Illuminate\Database\Eloquent\Model)
- creating() - Register a creating model event with the dispatcher. (defined in Illuminate\Database\Eloquent\Model)
- delete() - Delete the model from the database. (defined in Illuminate\Database\Eloquent\Model)
- deleteOrFail() - Delete the model from the database within a transaction. (defined in Illuminate\Database\Eloquent\Model)
- deleteQuietly() - Delete the model from the database without raising any events. (defined in Illuminate\Database\Eloquent\Model)
- deleted() - Register a deleted model event with the dispatcher. (defined in Illuminate\Database\Eloquent\Model)
- deleting() - Register a deleting model event with the dispatcher. (defined in Illuminate\Database\Eloquent\Model)
- destroy() - Destroy the models for the given IDs. (defined in Illuminate\Database\Eloquent\Model)
- discardChanges() - Discard attribute changes and reset the attributes to their original state. (defined in Illuminate\Database\Eloquent\Model)
- duplicateWithRelations() - replicates a model with special multisite duplication logic. (defined in October\Rain\Database\Model)
- encryptUsing() - Set the encrypter instance that will be used to encrypt attributes. (defined in Illuminate\Database\Eloquent\Model)
- escapeWhenCastingToString() - Indicate that the object's string representation should be escaped when __toString is invoked. (defined in Illuminate\Database\Eloquent\Model)
- extend() - this object properties upon construction. (defined in October\Rain\Database\Model)
- extendClassWith() - dynamically extends a class with a specified behavior. (defined in October\Rain\Database\Model)
- extendWithBlueprint() - (defined in Tailor\Classes\BlueprintModel)
- extendableCall() - magic method for
__call()
. (defined in October\Rain\Database\Model) - extendableCallStatic() - magic method for
__callStatic()
. (defined in October\Rain\Database\Model) - extendableConstruct() - should be called as part of the constructor. (defined in October\Rain\Database\Model)
- extendableDestruct() - should be called when serializing the object. (defined in October\Rain\Database\Model)
- extendableExtendCallback() - is a helper method for
::extend()
static method. (defined in October\Rain\Database\Model) - extendableGet() - magic method for
__get()
. (defined in October\Rain\Database\Model) - extendableSet() - magic method for
__set()
. (defined in October\Rain\Database\Model) - fetched() - creates a new native event for handling afterFetch(). (defined in October\Rain\Database\Model)
- fetching() - creates a new native event for handling beforeFetch(). (defined in October\Rain\Database\Model)
- fill() - Fill the model with an array of attributes. (defined in Illuminate\Database\Eloquent\Model)
- fillJsonAttribute() - Set a given JSON attribute on the model. (defined in Illuminate\Database\Eloquent\Model)
- fillable() - Set the fillable attributes for the model. (defined in Illuminate\Database\Eloquent\Model)
- fireEvent() - and call the listeners. (defined in October\Rain\Database\Model)
- flushEventListeners() - removes all of the event listeners for the model. (defined in October\Rain\Database\Model)
- forceFill() - Fill the model with an array of attributes. Force mass assignment. (defined in Illuminate\Database\Eloquent\Model)
- fresh() - Reload a fresh model instance from the database. (defined in Illuminate\Database\Eloquent\Model)
- freshTimestamp() - Get a fresh timestamp for the model. (defined in Illuminate\Database\Eloquent\Model)
- freshTimestampString() - Get a fresh timestamp for the model. (defined in Illuminate\Database\Eloquent\Model)
- fromDateTime() - Convert a DateTime to a storable string. (defined in Illuminate\Database\Eloquent\Model)
- fromEncryptedString() - Decrypt the given encrypted string. (defined in Illuminate\Database\Eloquent\Model)
- fromFloat() - Decode the given float. (defined in Illuminate\Database\Eloquent\Model)
- fromJson() - Decode the given JSON back into an array or object. (defined in Illuminate\Database\Eloquent\Model)
- getActualClassNameForMorph() - Retrieve the actual class name for a given morph class. (defined in Illuminate\Database\Eloquent\Model)
- getAppends() - Get the accessors that are being appended to model arrays. (defined in Illuminate\Database\Eloquent\Model)
- getAttribute() - from the model. (defined in October\Rain\Database\Model)
- getAttributeValue() - gets a plain attribute (not a relationship). (defined in October\Rain\Database\Model)
- getAttributes() - Get all of the current attributes on the model. (defined in Illuminate\Database\Eloquent\Model)
- getBlueprintAttribute() - (defined in Tailor\Classes\BlueprintModel)
- getBlueprintGroup() - (defined in Tailor\Classes\BlueprintModel)
- getBlueprintGroupAttribute() - (defined in Tailor\Classes\BlueprintModel)
- getBlueprintUuid() - (defined in Tailor\Classes\BlueprintModel)
- getCasts() - Get the casts array. (defined in Illuminate\Database\Eloquent\Model)
- getChanges() - Get the attributes that were changed when the model was last saved. (defined in Illuminate\Database\Eloquent\Model)
- getClassExtension() - returns a behavior object from an extendable class, example:. (defined in October\Rain\Database\Model)
- getClassMethodAsReflector() - (defined in October\Rain\Database\Model)
- getClassMethods() - gets a list of class methods, extension equivalent of get_class_methods(). (defined in October\Rain\Database\Model)
- getConnection() - Get the database connection for the model. (defined in Illuminate\Database\Eloquent\Model)
- getConnectionName() - Get the current connection name for the model. (defined in Illuminate\Database\Eloquent\Model)
- getConnectionResolver() - Get the connection resolver instance. (defined in Illuminate\Database\Eloquent\Model)
- getContentFieldsetDefinition() - (defined in Tailor\Classes\BlueprintModel)
- getCreatedAtColumn() - Get the name of the "created at" column. (defined in Illuminate\Database\Eloquent\Model)
- getDateFormat() - Get the format for database stored dates. (defined in Illuminate\Database\Eloquent\Model)
- getDates() - returns the attributes that should be converted to dates. (defined in October\Rain\Database\Model)
- getDirty() - Get the attributes that have been changed since the last sync. (defined in Illuminate\Database\Eloquent\Model)
- getDynamicProperties() - returns all dynamic properties and their values. (defined in October\Rain\Database\Model)
- getEventDispatcher() - Get the event dispatcher instance. (defined in Illuminate\Database\Eloquent\Model)
- getFieldsetColumnNames() - (defined in Tailor\Classes\BlueprintModel)
- getFieldsetDefinition() - (defined in Tailor\Classes\BlueprintModel)
- getFillable() - Get the fillable attributes for the model. (defined in Illuminate\Database\Eloquent\Model)
- getForeignKey() - Get the default foreign key name for the model. (defined in Illuminate\Database\Eloquent\Model)
- getGlobalScope() - Get a global scope registered with the model. (defined in Illuminate\Database\Eloquent\Model)
- getGlobalScopes() - Get the global scopes for this class instance. (defined in Illuminate\Database\Eloquent\Model)
- getGuarded() - Get the guarded attributes for the model. (defined in Illuminate\Database\Eloquent\Model)
- getHidden() - Get the hidden attributes for the model. (defined in Illuminate\Database\Eloquent\Model)
- getIncrementing() - Get the value indicating whether the IDs are incrementing. (defined in Illuminate\Database\Eloquent\Model)
- getJsonable() - attributes name. (defined in October\Rain\Database\Model)
- getKey() - Get the value of the model's primary key. (defined in Illuminate\Database\Eloquent\Model)
- getKeyName() - Get the primary key for the model. (defined in Illuminate\Database\Eloquent\Model)
- getKeyType() - Get the auto-incrementing key type. (defined in Illuminate\Database\Eloquent\Model)
- getMutatedAttributes() - Get the mutated attributes for a given instance. (defined in Illuminate\Database\Eloquent\Model)
- getObservableEvents() - as their names. (defined in October\Rain\Database\Model)
- getOriginal() - Get the model's original attribute values. (defined in Illuminate\Database\Eloquent\Model)
- getPerPage() - Get the number of models to return per page. (defined in Illuminate\Database\Eloquent\Model)
- getQualifiedCreatedAtColumn() - Get the fully qualified "created at" column. (defined in Illuminate\Database\Eloquent\Model)
- getQualifiedKeyName() - Get the table qualified key name. (defined in Illuminate\Database\Eloquent\Model)
- getQualifiedUpdatedAtColumn() - Get the fully qualified "updated at" column. (defined in Illuminate\Database\Eloquent\Model)
- getQueueableConnection() - Get the queueable connection for the entity. (defined in Illuminate\Database\Eloquent\Model)
- getQueueableId() - Get the queueable identity for the entity. (defined in Illuminate\Database\Eloquent\Model)
- getQueueableRelations() - Get the queueable relationships for the entity. (defined in Illuminate\Database\Eloquent\Model)
- getRawOriginal() - Get the model's raw original attribute values. (defined in Illuminate\Database\Eloquent\Model)
- getRelation() - Get a specified relationship. (defined in Illuminate\Database\Eloquent\Model)
- getRelationDefinition() - returns relationship details from a supplied name. (defined in October\Rain\Database\Model)
- getRelationDefinitions() - returns relationship details for all relations. (defined in October\Rain\Database\Model)
- getRelationSimpleValue() - returns a relation key value(s), not as an object. (defined in October\Rain\Database\Model)
- getRelationType() - returns a relationship type based on a supplied name. (defined in October\Rain\Database\Model)
- getRelationValue() - Get a relationship. (defined in Illuminate\Database\Eloquent\Model)
- getRelations() - Get all the loaded relations for the instance. (defined in Illuminate\Database\Eloquent\Model)
- getRouteKey() - Get the value of the model's route key. (defined in Illuminate\Database\Eloquent\Model)
- getRouteKeyName() - Get the route key for the model. (defined in Illuminate\Database\Eloquent\Model)
- getSaveOption() - returns an option used while saving the model. (defined in October\Rain\Database\Model)
- getTable() - Get the table associated with the model. (defined in Illuminate\Database\Eloquent\Model)
- getTouchedRelations() - Get the relationships that are touched on save. (defined in Illuminate\Database\Eloquent\Model)
- getUpdatedAtColumn() - Get the name of the "updated at" column. (defined in Illuminate\Database\Eloquent\Model)
- getVisible() - Get the visible attributes for the model. (defined in Illuminate\Database\Eloquent\Model)
- guard() - Set the guarded attributes for the model. (defined in Illuminate\Database\Eloquent\Model)
- handleDiscardedAttributeViolationUsing() - Register a callback that is responsible for handling discarded attribute violations. (defined in Illuminate\Database\Eloquent\Model)
- handleLazyLoadingViolationUsing() - Register a callback that is responsible for handling lazy loading violations. (defined in Illuminate\Database\Eloquent\Model)
- handleMissingAttributeViolationUsing() - Register a callback that is responsible for handling lazy loading violations. (defined in Illuminate\Database\Eloquent\Model)
- hasAppended() - Return whether the accessor attribute has been appended. (defined in Illuminate\Database\Eloquent\Model)
- hasAttributeGetMutator() - Determine if a "Attribute" return type marked get mutator exists for an attribute. (defined in Illuminate\Database\Eloquent\Model)
- hasAttributeMutator() - Determine if a "Attribute" return type marked mutator exists for an attribute. (defined in Illuminate\Database\Eloquent\Model)
- hasAttributeSetMutator() - Determine if an "Attribute" return type marked set mutator exists for an attribute. (defined in Illuminate\Database\Eloquent\Model)
- hasCast() - Determine whether an attribute should be cast to a native type. (defined in Illuminate\Database\Eloquent\Model)
- hasDeferred() - returns true if a deferred record exists for a relation. (defined in October\Rain\Database\Model)
- hasGetMutator() - determines if a get mutator exists for an attribute. (defined in October\Rain\Database\Model)
- hasGlobalScope() - Determine if a model has a global scope. (defined in Illuminate\Database\Eloquent\Model)
- hasMany() - defines a one-to-many relationship. (defined in October\Rain\Database\Model)
- hasManyThrough() - defines a has-many-through relationship. (defined in October\Rain\Database\Model)
- hasNamedScope() - Determine if the model has a given scope. (defined in Illuminate\Database\Eloquent\Model)
- hasOne() - defines a one-to-one relationship. (defined in October\Rain\Database\Model)
- hasOneThrough() - define a has-one-through relationship. (defined in October\Rain\Database\Model)
- hasRelation() - checks if model has a relationship by supplied name. (defined in October\Rain\Database\Model)
- hasSetMutator() - determines if a set mutator exists for an attribute. (defined in October\Rain\Database\Model)
- implementClassWith() - will implement an extension using non-interference and should. (defined in October\Rain\Database\Model)
- is() - Determine if two models have the same ID and belong to the same table. (defined in Illuminate\Database\Eloquent\Model)
- isClassExtendedWith() - checks if extendable class is extended with a behavior object. (defined in October\Rain\Database\Model)
- isClassInstanceOf() - checks if the class implements the supplied interface methods. (defined in October\Rain\Database\Model)
- isClean() - Determine if the model or all the given attribute(s) have remained the same. (defined in Illuminate\Database\Eloquent\Model)
- isDeferrable() - returns true if a relation exists and can be deferred. (defined in October\Rain\Database\Model)
- isDirty() - Determine if the model or any of the given attribute(s) have been modified. (defined in Illuminate\Database\Eloquent\Model)
- isFillable() - Determine if the given attribute may be mass assigned. (defined in Illuminate\Database\Eloquent\Model)
- isGuarded() - Determine if the given key is guarded. (defined in Illuminate\Database\Eloquent\Model)
- isIgnoringTimestamps() - Determine if the given model is ignoring timestamps / touches. (defined in Illuminate\Database\Eloquent\Model)
- isIgnoringTouch() - Determine if the given model is ignoring touches. (defined in Illuminate\Database\Eloquent\Model)
- isJsonable() - checks if an attribute is jsonable or not. (defined in October\Rain\Database\Model)
- isNot() - Determine if two models are not the same. (defined in Illuminate\Database\Eloquent\Model)
- isRelation() - Determine if the given key is a relationship method on the model. (defined in Illuminate\Database\Eloquent\Model)
- isRelationPushable() - determines whether the specified relation should be saved. (defined in October\Rain\Database\Model)
- isRelationTypeSingular() - returns true if the relation is expected to return. (defined in October\Rain\Database\Model)
- isUnguarded() - Determine if the current state is "unguarded". (defined in Illuminate\Database\Eloquent\Model)
- joiningTable() - Get the joining table name for a many-to-many relation. (defined in Illuminate\Database\Eloquent\Model)
- joiningTableSegment() - Get this model's half of the intermediate table name for belongsToMany relationships. (defined in Illuminate\Database\Eloquent\Model)
- jsonSerialize() - Convert the object into something JSON serializable. (defined in Illuminate\Database\Eloquent\Model)
- jsonable() - attributes set for the model. (defined in October\Rain\Database\Model)
- load() - Eager load relations on the model. (defined in Illuminate\Database\Eloquent\Model)
- loadAggregate() - Eager load relation's column aggregations on the model. (defined in Illuminate\Database\Eloquent\Model)
- loadAvg() - Eager load relation average column values on the model. (defined in Illuminate\Database\Eloquent\Model)
- loadCount() - Eager load relation counts on the model. (defined in Illuminate\Database\Eloquent\Model)
- loadExists() - Eager load related model existence values on the model. (defined in Illuminate\Database\Eloquent\Model)
- loadMax() - Eager load relation max column values on the model. (defined in Illuminate\Database\Eloquent\Model)
- loadMin() - Eager load relation min column values on the model. (defined in Illuminate\Database\Eloquent\Model)
- loadMissing() - Eager load relations on the model if they are not already eager loaded. (defined in Illuminate\Database\Eloquent\Model)
- loadMorph() - Eager load relationships on the polymorphic relation of a model. (defined in Illuminate\Database\Eloquent\Model)
- loadMorphAggregate() - Eager load relationship column aggregation on the polymorphic relation of a model. (defined in Illuminate\Database\Eloquent\Model)
- loadMorphAvg() - Eager load relationship average column values on the polymorphic relation of a model. (defined in Illuminate\Database\Eloquent\Model)
- loadMorphCount() - Eager load relationship counts on the polymorphic relation of a model. (defined in Illuminate\Database\Eloquent\Model)
- loadMorphMax() - Eager load relationship max column values on the polymorphic relation of a model. (defined in Illuminate\Database\Eloquent\Model)
- loadMorphMin() - Eager load relationship min column values on the polymorphic relation of a model. (defined in Illuminate\Database\Eloquent\Model)
- loadMorphSum() - Eager load relationship column summations on the polymorphic relation of a model. (defined in Illuminate\Database\Eloquent\Model)
- loadSum() - Eager load relation's column summations on the model. (defined in Illuminate\Database\Eloquent\Model)
- make() - a new model and return the instance. (defined in October\Rain\Database\Model)
- makeHidden() - Make the given, typically visible, attributes hidden. (defined in Illuminate\Database\Eloquent\Model)
- makeHiddenIf() - Make the given, typically visible, attributes hidden if the given truth test passes. (defined in Illuminate\Database\Eloquent\Model)
- makeRelation() - returns a relation class object, supporting nested relations with. (defined in October\Rain\Database\Model)
- makeVisible() - Make the given, typically hidden, attributes visible. (defined in Illuminate\Database\Eloquent\Model)
- makeVisibleIf() - Make the given, typically hidden, attributes visible if the given truth test passes. (defined in Illuminate\Database\Eloquent\Model)
- mergeCasts() - Merge new casts with existing casts on the model. (defined in Illuminate\Database\Eloquent\Model)
- mergeFillable() - Merge new fillable attributes with existing fillable attributes on the model. (defined in Illuminate\Database\Eloquent\Model)
- mergeGuarded() - Merge new guarded attributes with existing guarded attributes on the model. (defined in Illuminate\Database\Eloquent\Model)
- methodExists() - checks if a method exists, extension equivalent of method_exists(). (defined in October\Rain\Database\Model)
- morphMany() - defines a polymorphic one-to-many relationship. (defined in October\Rain\Database\Model)
- morphOne() - defines a polymorphic one-to-one relationship. (defined in October\Rain\Database\Model)
- morphTo() - defines a polymorphic, inverse one-to-one or many relationship. (defined in October\Rain\Database\Model)
- morphToMany() - defines a polymorphic many-to-many relationship. (defined in October\Rain\Database\Model)
- morphedByMany() - defines a polymorphic many-to-many inverse relationship. (defined in October\Rain\Database\Model)
- newEloquentBuilder() - for the model. (defined in October\Rain\Database\Model)
- newFromBuilder() - creates a new model instance that is existing. (defined in October\Rain\Database\Model)
- newInstance() - creates a new instance of the given model. (defined in October\Rain\Database\Model)
- newModelQuery() - Get a new query builder that doesn't have any global scopes or eager loading. (defined in Illuminate\Database\Eloquent\Model)
- newPivot() - as a generic pivot model instance. (defined in October\Rain\Database\Model)
- newQuery() - Get a new query builder for the model's table. (defined in Illuminate\Database\Eloquent\Model)
- newQueryForRestoration() - Get a new query to restore one or more models by their queueable IDs. (defined in Illuminate\Database\Eloquent\Model)
- newQueryWithoutRelationships() - Get a new query builder with no relationships loaded. (defined in Illuminate\Database\Eloquent\Model)
- newQueryWithoutScope() - Get a new query instance without a given scope. (defined in Illuminate\Database\Eloquent\Model)
- newQueryWithoutScopes() - Get a new query builder that doesn't have any global scopes. (defined in Illuminate\Database\Eloquent\Model)
- newRelationPivot() - instance specific to a relation. (defined in October\Rain\Database\Model)
- newReplicationInstance() - returns a new instance used by the replicator. (defined in October\Rain\Database\Model)
- observe() - Register observers with the model. (defined in Illuminate\Database\Eloquent\Model)
- offsetExists() - Determine if the given attribute exists. (defined in Illuminate\Database\Eloquent\Model)
- offsetGet() - Get the value for a given offset. (defined in Illuminate\Database\Eloquent\Model)
- offsetSet() - Set the value for a given offset. (defined in Illuminate\Database\Eloquent\Model)
- offsetUnset() - Unset the value for a given offset. (defined in Illuminate\Database\Eloquent\Model)
- on() - Begin querying the model on a given connection. (defined in Illuminate\Database\Eloquent\Model)
- onWriteConnection() - Begin querying the model on the write connection. (defined in Illuminate\Database\Eloquent\Model)
- only() - Get a subset of the model's attributes. (defined in Illuminate\Database\Eloquent\Model)
- originalIsEquivalent() - Determine if the new and old values for a given key are equivalent. (defined in Illuminate\Database\Eloquent\Model)
- preventAccessingMissingAttributes() - Prevent accessing missing attributes on retrieved models. (defined in Illuminate\Database\Eloquent\Model)
- preventLazyLoading() - Prevent model relationships from being lazy loaded. (defined in Illuminate\Database\Eloquent\Model)
- preventSilentlyDiscardingAttributes() - Prevent non-fillable attributes from being silently discarded. (defined in Illuminate\Database\Eloquent\Model)
- preventsAccessingMissingAttributes() - Determine if accessing missing attributes is disabled. (defined in Illuminate\Database\Eloquent\Model)
- preventsLazyLoading() - Determine if lazy loading is disabled. (defined in Illuminate\Database\Eloquent\Model)
- preventsSilentlyDiscardingAttributes() - Determine if discarding guarded attribute fills is disabled. (defined in Illuminate\Database\Eloquent\Model)
- propertyExists() - checks if a property exists, extension equivalent of
property_exists()
. (defined in October\Rain\Database\Model) - push() - saves the model and all of its relationships. (defined in October\Rain\Database\Model)
- pushQuietly() - Save the model and all of its relationships without raising any events to the parent model. (defined in Illuminate\Database\Eloquent\Model)
- qualifyColumn() - Qualify the given column name by the model's table. (defined in Illuminate\Database\Eloquent\Model)
- qualifyColumns() - Qualify the given columns with the model's table. (defined in Illuminate\Database\Eloquent\Model)
- query() - Begin querying the model. (defined in Illuminate\Database\Eloquent\Model)
- refresh() - Reload the current model instance with fresh attributes from the database. (defined in Illuminate\Database\Eloquent\Model)
- registerGlobalScopes() - Register the global scopes for this builder instance. (defined in Illuminate\Database\Eloquent\Model)
- reguard() - Enable the mass assignment restrictions. (defined in Illuminate\Database\Eloquent\Model)
- relationLoaded() - Determine if the given relation is loaded. (defined in Illuminate\Database\Eloquent\Model)
- relationResolver() - Get the dynamic relation resolver if defined or inherited, or return null. (defined in Illuminate\Database\Eloquent\Model)
- relationsToArray() - Get the model's relationships in array form. (defined in Illuminate\Database\Eloquent\Model)
- reload() - the model attributes from the database. (defined in October\Rain\Database\Model)
- reloadRelations() - (defined in October\Rain\Database\Model)
- removeObservableEvents() - Remove an observable event name. (defined in Illuminate\Database\Eloquent\Model)
- replicate() - Clone the model into a new, non-existing instance. (defined in Illuminate\Database\Eloquent\Model)
- replicateQuietly() - Clone the model into a new, non-existing instance without raising any events. (defined in Illuminate\Database\Eloquent\Model)
- replicateWithRelations() - replicates the model into a new, non-existing instance, (defined in October\Rain\Database\Model)
- replicating() - Register a replicating model event with the dispatcher. (defined in Illuminate\Database\Eloquent\Model)
- resolveChildRouteBinding() - Retrieve the child model for a bound value. (defined in Illuminate\Database\Eloquent\Model)
- resolveConnection() - Resolve a connection instance. (defined in Illuminate\Database\Eloquent\Model)
- resolveRelationUsing() - Define a dynamic relation resolver. (defined in Illuminate\Database\Eloquent\Model)
- resolveRouteBinding() - Retrieve the model for a bound value. (defined in Illuminate\Database\Eloquent\Model)
- resolveRouteBindingQuery() - Retrieve the model for a bound value. (defined in Illuminate\Database\Eloquent\Model)
- resolveSoftDeletableChildRouteBinding() - Retrieve the child model for a bound value. (defined in Illuminate\Database\Eloquent\Model)
- resolveSoftDeletableRouteBinding() - Retrieve the model for a bound value. (defined in Illuminate\Database\Eloquent\Model)
- retrieved() - Register a retrieved model event with the dispatcher. (defined in Illuminate\Database\Eloquent\Model)
- save() - the model to the database. (defined in October\Rain\Database\Model)
- saveOrFail() - Save the model to the database within a transaction. (defined in Illuminate\Database\Eloquent\Model)
- saveQuietly() - Save the model to the database without raising any events. (defined in Illuminate\Database\Eloquent\Model)
- saved() - Register a saved model event with the dispatcher. (defined in Illuminate\Database\Eloquent\Model)
- saving() - Register a saving model event with the dispatcher. (defined in Illuminate\Database\Eloquent\Model)
- setAppends() - Set the accessors to append to model arrays. (defined in Illuminate\Database\Eloquent\Model)
- setAttribute() - sets a given attribute on the model. (defined in October\Rain\Database\Model)
- setBlueprintGroup() - (defined in Tailor\Classes\BlueprintModel)
- setBlueprintUuid() - (defined in Tailor\Classes\BlueprintModel)
- setConnection() - Set the connection associated with the model. (defined in Illuminate\Database\Eloquent\Model)
- setConnectionResolver() - Set the connection resolver instance. (defined in Illuminate\Database\Eloquent\Model)
- setCreatedAt() - Set the value of the "created at" attribute. (defined in Illuminate\Database\Eloquent\Model)
- setDateFormat() - Set the date format used by the model. (defined in Illuminate\Database\Eloquent\Model)
- setEventDispatcher() - Set the event dispatcher instance. (defined in Illuminate\Database\Eloquent\Model)
- setHidden() - Set the hidden attributes for the model. (defined in Illuminate\Database\Eloquent\Model)
- setIncrementing() - Set whether IDs are incrementing. (defined in Illuminate\Database\Eloquent\Model)
- setKeyName() - Set the primary key for the model. (defined in Illuminate\Database\Eloquent\Model)
- setKeyType() - Set the data type for the primary key. (defined in Illuminate\Database\Eloquent\Model)
- setObservableEvents() - Set the observable event names. (defined in Illuminate\Database\Eloquent\Model)
- setPerPage() - Set the number of models to return per page. (defined in Illuminate\Database\Eloquent\Model)
- setRawAttributes() - Set the array of model attributes. No checking is done. (defined in Illuminate\Database\Eloquent\Model)
- setRelation() - Set the given relationship on the model. (defined in Illuminate\Database\Eloquent\Model)
- setRelations() - Set the entire relations array on the model. (defined in Illuminate\Database\Eloquent\Model)
- setTable() - Set the table associated with the model. (defined in Illuminate\Database\Eloquent\Model)
- setTouchedRelations() - Set the relationships that are touched on save. (defined in Illuminate\Database\Eloquent\Model)
- setUpdatedAt() - Set the value of the "updated at" attribute. (defined in Illuminate\Database\Eloquent\Model)
- setVisible() - Set the visible attributes for the model. (defined in Illuminate\Database\Eloquent\Model)
- shouldBeStrict() - Indicate that models should prevent lazy loading, silently discarding attributes, and accessing missing attributes. (defined in Illuminate\Database\Eloquent\Model)
- syncChanges() - Sync the changed attributes. (defined in Illuminate\Database\Eloquent\Model)
- syncOriginal() - Sync the original attributes with the current. (defined in Illuminate\Database\Eloquent\Model)
- syncOriginalAttribute() - Sync a single original attribute with its current value. (defined in Illuminate\Database\Eloquent\Model)
- syncOriginalAttributes() - Sync multiple original attribute with their current values. (defined in Illuminate\Database\Eloquent\Model)
- through() - Create a pending has-many-through or has-one-through relationship. (defined in Illuminate\Database\Eloquent\Model)
- toArray() - Convert the model instance to an array. (defined in Illuminate\Database\Eloquent\Model)
- toJson() - Convert the model instance to JSON. (defined in Illuminate\Database\Eloquent\Model)
- totallyGuarded() - Determine if the model is totally guarded. (defined in Illuminate\Database\Eloquent\Model)
- touch() - Update the model's update timestamp. (defined in Illuminate\Database\Eloquent\Model)
- touchOwners() - Touch the owning relations of the model. (defined in Illuminate\Database\Eloquent\Model)
- touchQuietly() - Update the model's update timestamp without raising any events. (defined in Illuminate\Database\Eloquent\Model)
- touches() - Determine if the model touches a given relation. (defined in Illuminate\Database\Eloquent\Model)
- unbindDeferred() - unbinds a deferred relationship to the supplied record. (defined in October\Rain\Database\Model)
- unbindEvent() - destroys an event binding. (defined in October\Rain\Database\Model)
- unguard() - Disable all mass assignable restrictions. (defined in Illuminate\Database\Eloquent\Model)
- unguarded() - Run the given callable while being unguarded. (defined in Illuminate\Database\Eloquent\Model)
- unsetConnectionResolver() - Unset the connection resolver for models. (defined in Illuminate\Database\Eloquent\Model)
- unsetEventDispatcher() - Unset the event dispatcher for models. (defined in Illuminate\Database\Eloquent\Model)
- unsetRelation() - Unset a loaded relationship. (defined in Illuminate\Database\Eloquent\Model)
- unsetRelations() - Unset all the loaded relations for the instance. (defined in Illuminate\Database\Eloquent\Model)
- update() - Update the model in the database. (defined in Illuminate\Database\Eloquent\Model)
- updateOrFail() - Update the model in the database within a transaction. (defined in Illuminate\Database\Eloquent\Model)
- updateQuietly() - Update the model in the database without raising any events. (defined in Illuminate\Database\Eloquent\Model)
- updateTimestamps() - Update the creation and update timestamps. (defined in Illuminate\Database\Eloquent\Model)
- updated() - Register an updated model event with the dispatcher. (defined in Illuminate\Database\Eloquent\Model)
- updating() - Register an updating model event with the dispatcher. (defined in Illuminate\Database\Eloquent\Model)
- usesTimestamps() - Determine if the model uses timestamps. (defined in Illuminate\Database\Eloquent\Model)
- wasChanged() - Determine if the model or any of the given attribute(s) were changed when the model was last saved. (defined in Illuminate\Database\Eloquent\Model)
- with() - Begin querying a model with eager loading. (defined in Illuminate\Database\Eloquent\Model)
- withoutBroadcasting() - Execute a callback without broadcasting any model events for all model types. (defined in Illuminate\Database\Eloquent\Model)
- withoutEvents() - Execute a callback without firing any model events for any model type. (defined in Illuminate\Database\Eloquent\Model)
- withoutRelations() - Duplicate the instance and unset all the loaded relations. (defined in Illuminate\Database\Eloquent\Model)
- withoutTimestamps() - Disable timestamps for the current class during the given callback scope. (defined in Illuminate\Database\Eloquent\Model)
- withoutTimestampsOn() - Disable timestamps for the given model classes during the given callback scope. (defined in Illuminate\Database\Eloquent\Model)
- withoutTouching() - Disables relationship model touching for the current class during given callback scope. (defined in Illuminate\Database\Eloquent\Model)
- withoutTouchingOn() - Disables relationship model touching for the given model classes during given callback scope. (defined in Illuminate\Database\Eloquent\Model)
Protected Methods
protected applyCoreColumnModifiers()
protected applyCoreColumnModifiers($host): void
applyCoreColumnModifiers will transfer modified attributes from the blueprint to the core column definition. For example, the title column.
protected applyCoreFieldModifiers()
protected applyCoreFieldModifiers($host): void
applyCoreFieldModifiers will transfer modified attributes from the blueprint to the core field definition. For example, the title placeholder value or the is_enabled default state.
protected defineMultisiteRelation()
protected defineMultisiteRelation($name, $type = null): void
defineMultisiteRelation will modify defined relations on this model so they share
their association using the shared identifier (site_root_id
). Only these relation
types support relation sharing: belongsToMany
, belongsTo
, hasOne
, hasMany
,
attachOne
, attachMany
.
protected defineMultisiteRelations()
protected defineMultisiteRelations(): void
defineMultisiteRelations will spin over every relation and apply propagation config
protected findOtherSiteModel()
protected findOtherSiteModel($siteId = null): void
protected getOtherBoundary()
protected getOtherBoundary($node, $target, $position): int
getOtherBoundary calculates the other boundary.
protected getParentIdOptionsFromQuery()
protected getParentIdOptionsFromQuery($query): void
protected getPrimaryBoundary()
protected getPrimaryBoundary($node, $target, $position): int
getPrimaryBoundary calculates the boundary.
protected getRelationValidationValue()
protected getRelationValidationValue($relationName): void
getRelationValidationValue handles attachments that validate differently to their simple values
protected getSortedBoundaries()
protected getSortedBoundaries($node, $target, $position): array
getSortedBoundaries calculates a sorted boundaries array.
protected getValidationAttributes()
protected getValidationAttributes(): array
getValidationAttributes returns the model data used for validation
protected getVersionableTransferAttributes()
protected getVersionableTransferAttributes(): void
protected isModelUsingSameSite()
protected isModelUsingSameSite($siteId = null): void
protected static makeValidator()
protected static makeValidator( $data, $rules, $customMessages, $attributeNames, $connection = null ): Illuminate\Validation\Validator
makeValidator instantiates the validator used by the validation process, depending if the class is being used inside or outside of Laravel. Optional connection string to make the validator use a different database connection than the default connection.
protected moveTo()
protected moveTo( mixed $target, string $position ): October\Rain\Database\Model
moveTo is a handler for all node alignments.
protected newNestedTreeQuery()
protected newNestedTreeQuery(): void
newNestedTreeQuery creates a new query for nested sets
protected performDeleteOnModel()
protected performDeleteOnModel(): void
performDeleteOnModel performs the actual delete query on this model instance.
protected performMove()
protected performMove($node, $target, $position): int
performMove executes the SQL query associated with the update of the indexes affected by the move operation.
protected performRestoreOnRelations()
protected performRestoreOnRelations(): void
performRestoreOnRelations locates relations with softDelete flag and cascades the restore event.
protected performSoftDeleteOnRelations()
protected performSoftDeleteOnRelations(): void
performSoftDeleteOnRelations locates relations with softDelete flag and cascades the delete event.
protected processRuleFieldNames()
protected processRuleFieldNames(array $rules): array
processRuleFieldNames processes field names in a rule array
Converts any field names using array notation (ie. field[child]
) into dot notation (ie. field.child
)
protected processValidationRules()
protected processValidationRules($rules): void
protected processValidationUniqueRule()
protected processValidationUniqueRule( string $definition, string $fieldName ): string
processValidationUniqueRule rebuilds the unique validation rule to force for the existing key exclusion for existing models. It also checks for unique rules without a table name and includes the table name, since this is required by Laravel but not October.
protected resolveMoveTarget()
protected resolveMoveTarget($targetId): October\Rain\Database\Model|null
protected runSoftDelete()
protected runSoftDelete(): void
runSoftDelete performs the actual delete query on this model instance.
protected setPublishingDates()
protected setPublishingDates($useDate): void
protected validateMove()
protected validateMove($node, $target, $position): void
validateMove validates a proposed move and returns true if changes are needed.
Show inherited protected methods
Inherited Protected Methods
- addCastAttributesToArray() - Add the casted attributes to the attributes array. (defined in Illuminate\Database\Eloquent\Model)
- addDateAttributesToArray() - Add the date attributes to the attributes array. (defined in Illuminate\Database\Eloquent\Model)
- addJsonableAttributesToArray() - (defined in October\Rain\Database\Model)
- addMutatedAttributesToArray() - Add the mutated attributes to the attributes array. (defined in Illuminate\Database\Eloquent\Model)
- afterCreate() - handles the "created" model event. (defined in October\Rain\Database\Model)
- afterDelete() - handles the "deleted" model event. (defined in October\Rain\Database\Model)
- afterFetch() - handles the "fetched" model event. (defined in October\Rain\Database\Model)
- afterInit() - is called after the model is constructed, a nicer version. (defined in October\Rain\Database\Model)
- afterRelation() - beforeRelation is fired on the relation model instance after it is created. (defined in October\Rain\Database\Model)
- afterSave() - handles the "saved" model event. (defined in October\Rain\Database\Model)
- afterUpdate() - handles the "updated" model event. (defined in October\Rain\Database\Model)
- asDate() - Return a timestamp as DateTime object with time set to 00:00:00. (defined in Illuminate\Database\Eloquent\Model)
- asDateTime() - returns a timestamp as DateTime object. (defined in October\Rain\Database\Model)
- asDecimal() - Return a decimal as string. (defined in Illuminate\Database\Eloquent\Model)
- asJson() - Encode the given value as JSON. (defined in Illuminate\Database\Eloquent\Model)
- asTimestamp() - Return a timestamp as unix timestamp. (defined in Illuminate\Database\Eloquent\Model)
- beforeDelete() - handles the "deleting" model event. (defined in October\Rain\Database\Model)
- beforeFetch() - handles the "fetching" model event. (defined in October\Rain\Database\Model)
- beforeRelation() - is fired on the relation object before it is created. (defined in October\Rain\Database\Model)
- beforeReplicate() - (defined in October\Rain\Database\Model)
- beforeSave() - handles the "saving" model event. (defined in October\Rain\Database\Model)
- boot() - Bootstrap the model and its traits. (defined in Illuminate\Database\Eloquent\Model)
- bootIfNotBooted() - Check if the model needs to be booted and if so, do it. (defined in Illuminate\Database\Eloquent\Model)
- bootNicerEvents() - to this model, in the format of method overrides. (defined in October\Rain\Database\Model)
- bootTraits() - Boot all of the bootable traits on the model. (defined in Illuminate\Database\Eloquent\Model)
- booted() - Perform any actions required after the model boots. (defined in Illuminate\Database\Eloquent\Model)
- booting() - Perform any actions required before the model boots. (defined in Illuminate\Database\Eloquent\Model)
- castAttribute() - Cast an attribute to a native PHP type. (defined in Illuminate\Database\Eloquent\Model)
- castAttributeAsEncryptedString() - Cast the given attribute to an encrypted string. (defined in Illuminate\Database\Eloquent\Model)
- castAttributeAsJson() - Cast the given attribute to JSON. (defined in Illuminate\Database\Eloquent\Model)
- childRouteBindingRelationshipName() - Retrieve the child route model binding relationship name for the given child type. (defined in Illuminate\Database\Eloquent\Model)
- commitDeferredAfter() - is used internally to commit all deferred bindings after saving. (defined in October\Rain\Database\Model)
- commitDeferredBefore() - is used internally to commit all deferred bindings before saving. (defined in October\Rain\Database\Model)
- commitDeferredOfType() - is an internal method for committing deferred relations. (defined in October\Rain\Database\Model)
- decrement() - Decrement a column's value by a given amount. (defined in Illuminate\Database\Eloquent\Model)
- decrementQuietly() - Decrement a column's value by a given amount without raising any events. (defined in Illuminate\Database\Eloquent\Model)
- deviateClassCastableAttribute() - Increment or decrement the given attribute using the custom cast class. (defined in Illuminate\Database\Eloquent\Model)
- emitterEventSortEvents() - sorts the listeners for a given event by priority. (defined in October\Rain\Database\Model)
- extendableIsAccessible() - checks if a property is accessible, property equivalent. (defined in October\Rain\Database\Model)
- extendableIsSettingDynamicProperty() - returns true if a dynamic. (defined in October\Rain\Database\Model)
- extensionExtractImplements() - will return classes to implement. (defined in October\Rain\Database\Model)
- extensionExtractMethods() - extracts the available methods from a behavior and adds it. (defined in October\Rain\Database\Model)
- fillableFromArray() - Get the fillable attributes of a given array. (defined in Illuminate\Database\Eloquent\Model)
- filterModelEventResults() - Filter the model event results. (defined in Illuminate\Database\Eloquent\Model)
- finishSave() - Perform any actions that are necessary after the model is saved. (defined in Illuminate\Database\Eloquent\Model)
- fireCustomModelEvent() - Fire a custom model event for the given event. (defined in Illuminate\Database\Eloquent\Model)
- fireModelEvent() - Fire the given event for the model. (defined in Illuminate\Database\Eloquent\Model)
- forwardCallTo() - Forward a method call to the given object. (defined in Illuminate\Database\Eloquent\Model)
- forwardDecoratedCallTo() - Forward a method call to the given object, returning $this if the forwarded call returned itself. (defined in Illuminate\Database\Eloquent\Model)
- getArrayAttributeByKey() - Get an array attribute or return an empty array if it is not set. (defined in Illuminate\Database\Eloquent\Model)
- getArrayAttributeWithValue() - Get an array attribute with the given key and value set. (defined in Illuminate\Database\Eloquent\Model)
- getArrayableAppends() - Get all of the appendable values that are arrayable. (defined in Illuminate\Database\Eloquent\Model)
- getArrayableAttributes() - Get an attribute array of all arrayable attributes. (defined in Illuminate\Database\Eloquent\Model)
- getArrayableItems() - Get an attribute array of all arrayable values. (defined in Illuminate\Database\Eloquent\Model)
- getArrayableRelations() - Get an attribute array of all arrayable relations. (defined in Illuminate\Database\Eloquent\Model)
- getAttributeFromArray() - Get an attribute from the $attributes array. (defined in Illuminate\Database\Eloquent\Model)
- getAttributeMarkedMutatorMethods() - Get all of the "Attribute" return typed attribute mutator methods. (defined in Illuminate\Database\Eloquent\Model)
- getAttributesForInsert() - Get all of the current attributes on the model for an insert operation. (defined in Illuminate\Database\Eloquent\Model)
- getCastType() - Get the type of cast for a model attribute. (defined in Illuminate\Database\Eloquent\Model)
- getClassCastableAttributeValue() - Cast the given attribute using a custom cast class. (defined in Illuminate\Database\Eloquent\Model)
- getDeferrableRelationTypes() - returns all possible relation types that can be deferred. (defined in October\Rain\Database\Model)
- getDeferredBindingRecords() - returns any outstanding binding records for this model. (defined in October\Rain\Database\Model)
- getEnumCaseFromValue() - Get an enum case instance from a given class and value. (defined in Illuminate\Database\Eloquent\Model)
- getEnumCastableAttributeValue() - Cast the given attribute to an enum. (defined in Illuminate\Database\Eloquent\Model)
- getExtendableMethodFromDynamicMethods() - (defined in October\Rain\Database\Model)
- getExtendableMethodFromExtensions() - (defined in October\Rain\Database\Model)
- getKeyForSaveQuery() - Get the primary key value for a save query. (defined in Illuminate\Database\Eloquent\Model)
- getKeyForSelectQuery() - Get the primary key value for a select query. (defined in Illuminate\Database\Eloquent\Model)
- getMorphs() - Get the polymorphic relationship columns. (defined in Illuminate\Database\Eloquent\Model)
- getMutatorMethods() - Get all of the attribute mutator methods. (defined in Illuminate\Database\Eloquent\Model)
- getOriginalWithoutRewindingModel() - Get the model's original attribute values. (defined in Illuminate\Database\Eloquent\Model)
- getRelationCaller() - finds the calling function name from the stack trace. (defined in October\Rain\Database\Model)
- getRelationCustomClass() - returns a custom relation class name for. (defined in October\Rain\Database\Model)
- getRelationDefaults() - returns default relation arguments for a given type. (defined in October\Rain\Database\Model)
- getRelationshipFromMethod() - Get a relationship value from a method. (defined in Illuminate\Database\Eloquent\Model)
- getStorableEnumValue() - Get the storable value from the given enum. (defined in Illuminate\Database\Eloquent\Model)
- guessBelongsToManyRelation() - Get the relationship name of the belongsToMany relationship. (defined in Illuminate\Database\Eloquent\Model)
- guessBelongsToRelation() - Guess the "belongs to" relationship name. (defined in Illuminate\Database\Eloquent\Model)
- handleLazyLoadingViolation() - Handle a lazy loading violation. (defined in Illuminate\Database\Eloquent\Model)
- handleRelation() - looks for the relation and does the correct magic as Eloquent would require. (defined in October\Rain\Database\Model)
- hasChanges() - Determine if any of the given attributes were changed when the model was last saved. (defined in Illuminate\Database\Eloquent\Model)
- increment() - Increment a column's value by a given amount. (defined in Illuminate\Database\Eloquent\Model)
- incrementOrDecrement() - Run the increment or decrement method on the model. (defined in Illuminate\Database\Eloquent\Model)
- incrementQuietly() - Increment a column's value by a given amount without raising any events. (defined in Illuminate\Database\Eloquent\Model)
- initializeModelEvent() - is called every time the model is constructed. (defined in October\Rain\Database\Model)
- initializeTraits() - Initialize any initializable traits on the model. (defined in Illuminate\Database\Eloquent\Model)
- insertAndSetId() - Insert the given attributes and set the ID on the model. (defined in Illuminate\Database\Eloquent\Model)
- isClassCastable() - Determine if the given key is cast using a custom class. (defined in Illuminate\Database\Eloquent\Model)
- isClassDeviable() - Determine if the key is deviable using a custom class. (defined in Illuminate\Database\Eloquent\Model)
- isClassSerializable() - Determine if the key is serializable using a custom class. (defined in Illuminate\Database\Eloquent\Model)
- isCustomDateTimeCast() - Determine if the cast type is a custom date time cast. (defined in Illuminate\Database\Eloquent\Model)
- isDateAttribute() - Determine if the given attribute is a date or date castable. (defined in Illuminate\Database\Eloquent\Model)
- isDateCastable() - Determine whether a value is Date / DateTime castable for inbound manipulation. (defined in Illuminate\Database\Eloquent\Model)
- isDateCastableWithCustomFormat() - Determine whether a value is Date / DateTime custom-castable for inbound manipulation. (defined in Illuminate\Database\Eloquent\Model)
- isDecimalCast() - Determine if the cast type is a decimal cast. (defined in Illuminate\Database\Eloquent\Model)
- isEncryptedCastable() - Determine whether a value is an encrypted castable for inbound manipulation. (defined in Illuminate\Database\Eloquent\Model)
- isEnumCastable() - Determine if the given key is cast using an enum. (defined in Illuminate\Database\Eloquent\Model)
- isGuardableColumn() - Determine if the given column is a valid, guardable column. (defined in Illuminate\Database\Eloquent\Model)
- isImmutableCustomDateTimeCast() - Determine if the cast type is an immutable custom date time cast. (defined in Illuminate\Database\Eloquent\Model)
- isJsonCastable() - Determine whether a value is JSON castable for inbound manipulation. (defined in Illuminate\Database\Eloquent\Model)
- isStandardDateFormat() - Determine if the given value is a standard date format. (defined in Illuminate\Database\Eloquent\Model)
- makeRelationInternal() - is used internally to create a new related instance. It also. (defined in October\Rain\Database\Model)
- mergeAttributesFromAttributeCasts() - Merge the cast class attributes back into the model. (defined in Illuminate\Database\Eloquent\Model)
- mergeAttributesFromCachedCasts() - Merge the cast class and attribute cast attributes back into the model. (defined in Illuminate\Database\Eloquent\Model)
- mergeAttributesFromClassCasts() - Merge the cast class attributes back into the model. (defined in Illuminate\Database\Eloquent\Model)
- morphEagerTo() - defines a polymorphic, inverse one-to-one or many relationship. (defined in October\Rain\Database\Model)
- morphInstanceTo() - defines a polymorphic, inverse one-to-one or many relationship. (defined in October\Rain\Database\Model)
- mutateAttribute() - Get the value of an attribute using its mutator. (defined in Illuminate\Database\Eloquent\Model)
- mutateAttributeForArray() - Get the value of an attribute using its mutator for array conversion. (defined in Illuminate\Database\Eloquent\Model)
- mutateAttributeMarkedAttribute() - Get the value of an "Attribute" return type marked attribute using its mutator. (defined in Illuminate\Database\Eloquent\Model)
- newBaseQueryBuilder() - instance for the connection. (defined in October\Rain\Database\Model)
- newBelongsTo() - Instantiate a new BelongsTo relationship. (defined in Illuminate\Database\Eloquent\Model)
- newBelongsToMany() - Instantiate a new BelongsToMany relationship. (defined in Illuminate\Database\Eloquent\Model)
- newHasMany() - Instantiate a new HasMany relationship. (defined in Illuminate\Database\Eloquent\Model)
- newHasManyThrough() - Instantiate a new HasManyThrough relationship. (defined in Illuminate\Database\Eloquent\Model)
- newHasOne() - Instantiate a new HasOne relationship. (defined in Illuminate\Database\Eloquent\Model)
- newHasOneThrough() - Instantiate a new HasOneThrough relationship. (defined in Illuminate\Database\Eloquent\Model)
- newMorphMany() - Instantiate a new MorphMany relationship. (defined in Illuminate\Database\Eloquent\Model)
- newMorphOne() - Instantiate a new MorphOne relationship. (defined in Illuminate\Database\Eloquent\Model)
- newMorphTo() - Instantiate a new MorphTo relationship. (defined in Illuminate\Database\Eloquent\Model)
- newMorphToMany() - Instantiate a new MorphToMany relationship. (defined in Illuminate\Database\Eloquent\Model)
- newRelatedInstance() - Create a new model instance for a related model. (defined in Illuminate\Database\Eloquent\Model)
- newRelatedThroughInstance() - Create a new model instance for a related "through" model. (defined in Illuminate\Database\Eloquent\Model)
- normalizeCastClassResponse() - Normalize the response from a custom class caster. (defined in Illuminate\Database\Eloquent\Model)
- parseCasterClass() - Parse the given caster class, removing any arguments. (defined in Illuminate\Database\Eloquent\Model)
- performDeleteOnRelations() - locates relations with delete flag and cascades the. (defined in October\Rain\Database\Model)
- performInsert() - Perform a model insert operation. (defined in Illuminate\Database\Eloquent\Model)
- performUpdate() - Perform a model update operation. (defined in Illuminate\Database\Eloquent\Model)
- registerModelEvent() - Register a model event with the dispatcher. (defined in Illuminate\Database\Eloquent\Model)
- registerObserver() - Register a single observer with the model. (defined in Illuminate\Database\Eloquent\Model)
- resolveCasterClass() - Resolve the custom caster class for a given key. (defined in Illuminate\Database\Eloquent\Model)
- resolveChildRouteBindingQuery() - Retrieve the child model query for a bound value. (defined in Illuminate\Database\Eloquent\Model)
- saveInternal() - is an internal method that saves the model to the database. (defined in October\Rain\Database\Model)
- serializeClassCastableAttribute() - Serialize the given attribute using the custom cast class. (defined in Illuminate\Database\Eloquent\Model)
- serializeDate() - Prepare a date for array / JSON serialization. (defined in Illuminate\Database\Eloquent\Model)
- setAttributeMarkedMutatedAttributeValue() - Set the value of a "Attribute" return type marked attribute using its mutator. (defined in Illuminate\Database\Eloquent\Model)
- setClassCastableAttribute() - Set the value of a class castable attribute. (defined in Illuminate\Database\Eloquent\Model)
- setEnumCastableAttribute() - Set the value of an enum castable attribute. (defined in Illuminate\Database\Eloquent\Model)
- setKeysForSaveQuery() - Set the keys for a save update query. (defined in Illuminate\Database\Eloquent\Model)
- setKeysForSelectQuery() - Set the keys for a select query. (defined in Illuminate\Database\Eloquent\Model)
- setMutatedAttributeValue() - Set the value of an attribute using its mutator. (defined in Illuminate\Database\Eloquent\Model)
- setRelationSimpleValue() - sets a relation value directly from its attribute. (defined in October\Rain\Database\Model)
- throwBadMethodCallException() - Throw a bad method call exception for the given method. (defined in Illuminate\Database\Eloquent\Model)
- throwMissingAttributeExceptionIfApplicable() - Either throw a missing attribute exception or return null depending on Eloquent's configuration. (defined in Illuminate\Database\Eloquent\Model)
- transformModelValue() - Transform a raw model value using mutators, casts, etc. (defined in Illuminate\Database\Eloquent\Model)
- validateRelationArgs() - supplied relation arguments. (defined in October\Rain\Database\Model)