-
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
- Library
- Database
- Relations
- MorphToMany
October\Rain\Database\Relations\MorphToMany
Overview
MorphToMany This class is a carbon copy of Illuminate\Database\Eloquent\Relations\MorphToMany so the base October\Rain\Database\Relations\BelongsToMany class can be inherited
Extends
- October\Rain\Database\Relations\BelongsToMany
- Illuminate\Database\Eloquent\Relations\BelongsToMany
- Illuminate\Database\Eloquent\Relations\Relation
Implements
- Illuminate\Contracts\Database\Query\Builder
- Illuminate\Contracts\Database\Eloquent\Builder
Public Properties
There are no public properties in the class.
Show inherited public properties
Inherited Public Properties
- $countMode - sets this relation object is a 'count' helper. (defined in October\Rain\Database\Relations\BelongsToMany)
- $withTimestamps - Indicates if timestamps are available on the pivot table. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- $morphMap - An array to map class names to their morph names in the database. (defined in Illuminate\Database\Eloquent\Relations\Relation)
Protected Properties
protected string $morphType
morphType is type of the polymorphic relation
protected string $morphClass
morphClass is the class name of the morph type constraint
protected bool $inverse
inverse indicates if we are connecting the inverse of the relation. This primarily affects the morphClass constraint.
Show inherited protected properties
Inherited Protected Properties
- $table - The intermediate table for the relation. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- $foreignPivotKey - The foreign key of the parent model. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- $relatedPivotKey - The associated key of the relation. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- $parentKey - The key name of the parent model. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- $relatedKey - The key name of the related model. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- $relationName - The "name" of the relationship. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- $pivotColumns - The pivot table columns to retrieve. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- $pivotWheres - Any pivot table restrictions for where clauses. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- $pivotWhereIns - Any pivot table restrictions for whereIn clauses. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- $pivotWhereNulls - Any pivot table restrictions for whereNull clauses. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- $pivotValues - The default values for the pivot columns. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- $pivotCreatedAt - The custom pivot table column for the created_at timestamp. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- $pivotUpdatedAt - The custom pivot table column for the updated_at timestamp. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- $using - The class name of the custom pivot model to use for the relationship. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- $accessor - The name of the accessor to use for the "pivot" relationship. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- $query - The Eloquent query builder instance. (defined in Illuminate\Database\Eloquent\Relations\Relation)
- $parent - The parent model instance. (defined in Illuminate\Database\Eloquent\Relations\Relation)
- $related - The related model instance. (defined in Illuminate\Database\Eloquent\Relations\Relation)
- $constraints - Indicates if the relation is adding constraints. (defined in Illuminate\Database\Eloquent\Relations\Relation)
- $requireMorphMap - Prevents morph relationships without a morph map. (defined in Illuminate\Database\Eloquent\Relations\Relation)
- $selfJoinCount - The count of self joins. (defined in Illuminate\Database\Eloquent\Relations\Relation)
- $macros - The registered string macros. (defined in Illuminate\Database\Eloquent\Relations\Relation)
Public Methods
public __construct()
public __construct( string $name, string $table, string $foreignKey, string $otherKey, string $relationName, bool $inverse, $parentKey, $relatedKey, $relationName = null, $inverse = false ): void
__construct will create a new morph to many relationship instance
public addDefinedConstraints()
public addDefinedConstraints(): void
addDefinedConstraints to the relation query
public addDefinedConstraintsToQuery()
public addDefinedConstraintsToQuery($query, $args = null): void
public addDefinedConstraintsToRelation()
public addDefinedConstraintsToRelation($relation, $args = null): void
public addEagerConstraints()
public addEagerConstraints(array $models): void
addEagerConstraints sets the constraints for an eager load of the relation
public getMorphClass()
public getMorphClass(): void
getMorphClass get the class name of the parent model
public getMorphType()
public getMorphType(): void
getMorphType gets the foreign key "type" name
public getRelationExistenceQuery()
public getRelationExistenceQuery( Illuminate\Database\Eloquent\Builder $query, Illuminate\Database\Eloquent\Builder $parentQuery, array|mixed $columns = [ 0 => '*'] ): Illuminate\Database\Eloquent\Builder
getRelationExistenceQuery adds the constraints for a relationship count query.
public newPivot()
public newPivot( array $attributes = [], bool $exists = false ): Illuminate\Database\Eloquent\Relations\Pivot
newPivot creates a new pivot model instance
public newPivotQuery()
public newPivotQuery(): void
newPivotQuery creates a new query builder for the pivot table.
Inherited Public Methods
- __call() - Handle dynamic method calls to the relationship. (defined in Illuminate\Database\Eloquent\Relations\Relation)
- __callStatic() - Dynamically handle calls to the class. (defined in Illuminate\Database\Eloquent\Relations\Relation)
- __clone() - Force a clone of the underlying query builder when cloning. (defined in Illuminate\Database\Eloquent\Relations\Relation)
- add() - a model to this relationship type. (defined in October\Rain\Database\Relations\BelongsToMany)
- addConstraints() - Set the base constraints on the relation query. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- allRelatedIds() - for the related models, with deferred binding support. (defined in October\Rain\Database\Relations\BelongsToMany)
- as() - Specify the custom pivot accessor to use for the relationship. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- attach() - overrides attach() method of BelongToMany relation. (defined in October\Rain\Database\Relations\BelongsToMany)
- chunk() - Chunk the results of the query. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- chunkById() - Chunk the results of a query by comparing numeric IDs. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- create() - a new instance of this related model with deferred binding support. (defined in October\Rain\Database\Relations\BelongsToMany)
- createMany() - Create an array of new instances of the related models. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- createdAt() - Get the name of the "created at" column. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- cursor() - Get a lazy collection for the given query. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- cursorPaginate() - Paginate the given query into a cursor paginator. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- detach() - overrides detach() method of BelongToMany relation. (defined in October\Rain\Database\Relations\BelongsToMany)
- each() - Execute a callback over each item while chunking. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- enforceMorphMap() - Define the morph map for polymorphic relations and require all morphed models to be explicitly mapped. (defined in Illuminate\Database\Eloquent\Relations\Relation)
- find() - Find a related model by its primary key. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- findMany() - Find multiple related models by their primary keys. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- findOr() - Find a related model by its primary key or call a callback. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- findOrFail() - Find a related model by its primary key or throw an exception. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- findOrNew() - Find a related model by its primary key or return a new instance of the related model. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- first() - Execute the query and get the first result. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- firstOr() - Execute the query and get the first result or call a callback. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- firstOrCreate() - Get the first related record matching the attributes or create it. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- firstOrFail() - Execute the query and get the first result or throw an exception. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- firstOrNew() - Get the first related model record matching the attributes or instantiate it. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- firstWhere() - Add a basic where clause to the query, and return the first result. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- flushMacros() - Flush the existing macros. (defined in Illuminate\Database\Eloquent\Relations\Relation)
- get() - Execute the query as a "select" statement. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- getBaseQuery() - Get the base query builder driving the Eloquent builder. (defined in Illuminate\Database\Eloquent\Relations\Relation)
- getEager() - Get the relationship for eager loading. (defined in Illuminate\Database\Eloquent\Relations\Relation)
- getExistenceCompareKey() - Get the key for comparing against the parent key in "has" query. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- getForeignKey() - (defined in October\Rain\Database\Relations\BelongsToMany)
- getForeignPivotKeyName() - Get the foreign key for the relation. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- getMorphedModel() - Get the model associated with a custom polymorphic type. (defined in Illuminate\Database\Eloquent\Relations\Relation)
- getOtherKey() - (defined in October\Rain\Database\Relations\BelongsToMany)
- getParent() - Get the parent model of the relation. (defined in Illuminate\Database\Eloquent\Relations\Relation)
- getParentKeyName() - Get the parent key for the relationship. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- getPivotAccessor() - Get the name of the pivot accessor for this relationship. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- getPivotClass() - Get the class being used for pivot models. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- getPivotColumns() - Get the pivot columns for this relationship. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- getQualifiedForeignPivotKeyName() - Get the fully qualified foreign key for the relation. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- getQualifiedParentKeyName() - Get the fully qualified parent key name for the relation. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- getQualifiedRelatedKeyName() - Get the fully qualified related key name for the relation. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- getQualifiedRelatedPivotKeyName() - Get the fully qualified "related key" for the relation. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- getQuery() - Get the underlying query for the relation. (defined in Illuminate\Database\Eloquent\Relations\Relation)
- getRelated() - Get the related model of the relation. (defined in Illuminate\Database\Eloquent\Relations\Relation)
- getRelatedKeyName() - Get the related key for the relationship. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- getRelatedPivotKeyName() - Get the "related key" for the relation. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- getRelationCountHash() - Get a relationship join table hash. (defined in Illuminate\Database\Eloquent\Relations\Relation)
- getRelationExistenceCountQuery() - Add the constraints for a relationship count query. (defined in Illuminate\Database\Eloquent\Relations\Relation)
- getRelationExistenceQueryForSelfJoin() - Add the constraints for a relationship query on the same table. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- getRelationName() - Get the relationship name for the relationship. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- getResults() - Get the results of the relationship. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- getSimpleValue() - is a helper for getting this relationship simple value, (defined in October\Rain\Database\Relations\BelongsToMany)
- getTable() - Get the intermediate table for the relationship. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- hasMacro() - Checks if macro is registered. (defined in Illuminate\Database\Eloquent\Relations\Relation)
- hasPivotColumn() - Determine whether the given column is defined as a pivot column. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- initRelation() - Initialize the relation on a set of models. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- lazy() - Query lazily, by chunks of the given size. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- lazyById() - Query lazily, by chunking the results of a query by comparing IDs. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- macro() - Register a custom macro. (defined in Illuminate\Database\Eloquent\Relations\Relation)
- macroCall() - Dynamically handle calls to the class. (defined in Illuminate\Database\Eloquent\Relations\Relation)
- match() - Match the eagerly loaded results to their parents. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- mixin() - Mix another object into the class. (defined in Illuminate\Database\Eloquent\Relations\Relation)
- morphMap() - Set or get the morph map for polymorphic relations. (defined in Illuminate\Database\Eloquent\Relations\Relation)
- newExistingPivot() - Create a new existing pivot model instance. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- newPivotStatement() - Get a new plain query builder for the pivot table. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- newPivotStatementForId() - Get a new pivot statement for a given "other" ID. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- noConstraints() - Run a callback with constraints disabled on the relation. (defined in Illuminate\Database\Eloquent\Relations\Relation)
- orWherePivot() - Set an "or where" clause for a pivot table column. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- orWherePivotBetween() - Set a "or where between" clause for a pivot table column. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- orWherePivotIn() - Set an "or where in" clause for a pivot table column. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- orWherePivotNotBetween() - Set a "or where not between" clause for a pivot table column. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- orWherePivotNotIn() - Set an "or where not in" clause for a pivot table column. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- orWherePivotNotNull() - Set a "or where not null" clause for a pivot table column. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- orWherePivotNull() - Set a "or where null" clause for a pivot table column. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- orderByPivot() - Add an "order by" clause for a pivot table column. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- paginate() - gets a paginator for the "select" statement that complies with October Rain. (defined in October\Rain\Database\Relations\BelongsToMany)
- paginateAtPage() - paginates by passing the page number directly. (defined in October\Rain\Database\Relations\BelongsToMany)
- paginateCustom() - paginates using a custom page name. (defined in October\Rain\Database\Relations\BelongsToMany)
- qualifyPivotColumn() - Qualify the given column name by the pivot table. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- rawUpdate() - Run a raw update against the base query. (defined in Illuminate\Database\Eloquent\Relations\Relation)
- relatedUpdatedAt() - Get the name of the related model's "updated at" column. (defined in Illuminate\Database\Eloquent\Relations\Relation)
- remove() - a model from this relationship type. (defined in October\Rain\Database\Relations\BelongsToMany)
- requireMorphMap() - Prevent polymorphic relationships from being used without model mappings. (defined in Illuminate\Database\Eloquent\Relations\Relation)
- requiresMorphMap() - Determine if polymorphic relationships require explicit model mapping. (defined in Illuminate\Database\Eloquent\Relations\Relation)
- save() - the supplied related model with deferred binding support. (defined in October\Rain\Database\Relations\BelongsToMany)
- saveMany() - Save an array of new models and attach them to the parent model. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- saveManyQuietly() - Save an array of new models without raising any events and attach them to the parent model. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- saveQuietly() - Save a new model without raising any events and attach it to the parent model. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- setSimpleValue() - helper for setting this relationship using various expected. (defined in October\Rain\Database\Relations\BelongsToMany)
- simplePaginate() - using a simple paginator. (defined in October\Rain\Database\Relations\BelongsToMany)
- simplePaginateAtPage() - simply paginates by passing the page number directly. (defined in October\Rain\Database\Relations\BelongsToMany)
- simplePaginateCustom() - simply paginates using a custom page name. (defined in October\Rain\Database\Relations\BelongsToMany)
- sole() - Execute the query and get the first result if it's the sole matching record. (defined in Illuminate\Database\Eloquent\Relations\Relation)
- sync() - Sync the intermediate tables with a list of IDs or collection of models. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- syncWithPivotValues() - Sync the intermediate tables with a list of IDs or collection of models with the given pivot values. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- syncWithoutDetaching() - Sync the intermediate tables with a list of IDs without detaching. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- toBase() - Get a base query builder instance. (defined in Illuminate\Database\Eloquent\Relations\Relation)
- toggle() - Toggles a model (or models) from the parent. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- touch() - Touch all of the related models for the relationship. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- touchIfTouching() - If we're touching the parent model, touch. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- updateExistingPivot() - Update an existing pivot record on the table. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- updateOrCreate() - Create or update a related record matching the attributes, and fill it with values. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- updatedAt() - Get the name of the "updated at" column. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- using() - Specify the custom pivot model to use for the relationship. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- wherePivot() - Set a where clause for a pivot table column. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- wherePivotBetween() - Set a "where between" clause for a pivot table column. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- wherePivotIn() - Set a "where in" clause for a pivot table column. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- wherePivotNotBetween() - Set a "where pivot not between" clause for a pivot table column. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- wherePivotNotIn() - Set a "where not in" clause for a pivot table column. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- wherePivotNotNull() - Set a "where not null" clause for a pivot table column. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- wherePivotNull() - Set a "where null" clause for a pivot table column. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- withDeferred() - returns a new model query with deferred bindings added, this. (defined in October\Rain\Database\Relations\BelongsToMany)
- withDeferredQuery() - returns the supplied model query, or current model query, with. (defined in October\Rain\Database\Relations\BelongsToMany)
- withPivot() - Set the columns on the pivot table to retrieve. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- withPivotValue() - Set a where clause for a pivot table column. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- withTimestamps() - Specify that the pivot table has creation and update timestamps. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
Protected Methods
protected addWhereConstraints()
protected addWhereConstraints(): $this
addWhereConstraints set the where clause for the relation query
protected baseAttachRecord()
protected baseAttachRecord(int $id, bool $timed): array
baseAttachRecord creates a new pivot attachment record.
Show inherited protected methods
Inherited Protected Methods
- addTimestampsToAttachment() - Set the creation and update timestamps on an attach record. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- aliasedPivotColumns() - Get the pivot columns for the relation. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- attachNew() - Attach all of the records that aren't in the given current records. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- attachUsingCustomClass() - Attach a model to the parent using a custom class. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- buildDictionary() - Build model dictionary keyed by the relation's foreign key. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- buildMorphMapFromModels() - Builds a table-keyed array from model class names. (defined in Illuminate\Database\Eloquent\Relations\Relation)
- castAttributes() - Cast the given pivot attributes. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- castKey() - Cast the given key to convert to primary key type. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- castKeys() - Cast the given keys to integers if they are numeric and string otherwise. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- detachUsingCustomClass() - Detach models from the relationship using a custom class. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- extractAttachIdAndAttributes() - Get the attach record ID and extra attributes. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- formatAttachRecord() - Create a full attachment record payload. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- formatAttachRecords() - Create an array of records to insert into the pivot table. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- formatRecordsList() - Format the sync / toggle record list so that it is keyed by ID. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- forwardCallTo() - Forward a method call to the given object. (defined in Illuminate\Database\Eloquent\Relations\Relation)
- forwardDecoratedCallTo() - Forward a method call to the given object, returning $this if the forwarded call returned itself. (defined in Illuminate\Database\Eloquent\Relations\Relation)
- getCurrentlyAttachedPivots() - Get the pivot models that are currently attached. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- getDictionaryKey() - Get a dictionary key attribute - casting it to a string if necessary. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- getKeys() - Get all of the primary keys for an array of models. (defined in Illuminate\Database\Eloquent\Relations\Relation)
- getRelationQuery() - Get the query builder that will contain the relationship constraints. (defined in Illuminate\Database\Eloquent\Relations\Relation)
- getTypeSwapValue() - Converts a given value to a given type value. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- getWithDeferredQualifiedKeyName() - returns the related "slave id" key. (defined in October\Rain\Database\Relations\BelongsToMany)
- guessInverseRelation() - Attempt to guess the name of the inverse of the relation. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- hydratePivotRelation() - Hydrate the pivot table relationship on the models. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- migratePivotAttributes() - Get the pivot attributes from a model. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- newSimpleRelationQuery() - for the related instance based on an array of IDs. (defined in October\Rain\Database\Relations\BelongsToMany)
- parseId() - Get the ID from the given mixed value. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- parseIds() - Get all of the IDs from the given mixed value. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- performDeferredLeftJoin() - left joins the deferred bindings table. (defined in October\Rain\Database\Relations\BelongsToMany)
- performJoin() - Set the join clause for the relation query. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- performLeftJoin() - performJoin will join the pivot table opportunistically instead of mandatorily. (defined in October\Rain\Database\Relations\BelongsToMany)
- performSortableColumnJoin() - includes custom logic to replace the sort order column with. (defined in October\Rain\Database\Relations\BelongsToMany)
- prepareQueryBuilder() - Prepare the query builder for query execution. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- resolveTableName() - Attempt to resolve the intermediate table name from the given string. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- shouldSelect() - gets the select columns for the relation query. (defined in October\Rain\Database\Relations\BelongsToMany)
- throwBadMethodCallException() - Throw a bad method call exception for the given method. (defined in Illuminate\Database\Eloquent\Relations\Relation)
- touchingParent() - Determine if we should touch the parent on sync. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- updateExistingPivotUsingCustomClass() - Update an existing pivot record on the table via a custom class. (defined in Illuminate\Database\Eloquent\Relations\BelongsToMany)
- whereInMethod() - Get the name of the "where in" method for eager loading. (defined in Illuminate\Database\Eloquent\Relations\Relation)