-
Backend
-
Behaviors
-
Classes
-
Controllers
-
Database
-
Seeds
-
-
Facades
-
FormWidgets
-
Helpers
-
Models
-
ReportWidgets
-
Skins
-
Traits
-
VueComponents
-
Widgets
- ServiceProvider
-
-
Cms
-
Classes
- Asset
- CmsCompoundObject
- CmsController
- CmsException
- CmsObject
- CmsObjectCollection
- CodeBase
- CodeParser
- ComponentBase
- ComponentHelpers
- ComponentManager
- ComponentPartial
- Content
- Controller
- EditorExtension
- Layout
- LayoutCode
- MediaLibrary
- MediaLibraryItem
- MediaViewHelper
- Meta
- ObjectMemoryCache
- Page
- PageCode
- Partial
- PartialCode
- PartialStack
- Router
- Theme
- ThemeManager
-
Components
-
Controllers
-
Facades
-
FormWidgets
-
Helpers
-
Models
-
ReportWidgets
-
Traits
-
Twig
- ComponentNode
- ComponentTokenParser
- ContentNode
- ContentTokenParser
- DebugExtension
- DefaultNode
- DefaultTokenParser
- Extension
- FlashNode
- FlashTokenParser
- FrameworkNode
- FrameworkTokenParser
- Loader
- PageNode
- PageTokenParser
- PartialNode
- PartialTokenParser
- PlaceholderNode
- PlaceholderTokenParser
- PutNode
- PutTokenParser
- ScriptsNode
- ScriptsTokenParser
- StylesNode
- StylesTokenParser
-
VueComponents
-
Widgets
- ServiceProvider
-
-
Editor
-
Behaviors
-
Classes
-
Controllers
-
VueComponents
- ServiceProvider
-
-
Media
-
Classes
-
Controllers
-
FormWidgets
-
Twig
-
Widgets
- ServiceProvider
-
-
System
-
Behaviors
-
Classes
-
Console
-
OctoberUtil
- ComposerScript
- OctoberDown
- OctoberFresh
- OctoberMigrate
- OctoberMirror
- OctoberPasswd
- OctoberUp
- OctoberUpdate
- OctoberUtil
- PluginCheck
- PluginDisable
- PluginEnable
- PluginInstall
- PluginList
- PluginRefresh
- PluginRemove
- ProjectSet
- ProjectSync
- ThemeCheck
- ThemeInstall
- ThemeList
- ThemeRemove
- ThemeSync
- ThemeUse
-
-
Controllers
-
Database
-
Facades
-
Helpers
-
Models
-
ReportWidgets
-
Traits
-
Twig
-
Widgets
- ServiceProvider
-
-
Events
-
backend
-
ajax
-
filter
-
form
-
list
-
menu
-
page
-
user
-
-
cms
-
ajax
-
block
-
combiner
-
component
-
object
-
page
-
resizer
-
router
-
template
-
theme
-
-
exception
-
halcyon
-
datasource
-
-
mailer
-
media
-
model
-
auth
-
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
-
- afterBoot
- afterCreate
- afterDelete
- afterFetch
- afterRestore
- afterSave
- afterUpdate
- afterValidate
- beforeCreate
- beforeDelete
- beforeFetch
- beforeGetAttribute
- beforeRestore
- beforeSave
- beforeSetAttribute
- beforeUpdate
- beforeValidate
- getAttribute
- saveInternal
- setAttribute
-
-
system
-
assets
-
console
-
mirror
-
theme
-
-
reportwidgets
-
resizer
-
settings
- extendConfigFile
-
-
translator
-
-
Library
-
Argon
-
Assetic
-
Asset
-
Cache
-
Exception
-
Factory
-
Filter
- BaseCssFilter
- CallablesFilter
- CssCacheBustingFilter
- CssImportFilter
- CssMinFilter
- CssRewriteFilter
- FilterCollection
- JavascriptImporter
- JSMinFilter
- JSMinPlusFilter
- JSqueezeFilter
- LessCompiler
- LessphpFilter
- MinifyCssCompressorFilter
- PackagerFilter
- PackerFilter
- ScssCompiler
- ScssphpFilter
- StylesheetMinify
-
Util
- README
- AssetManager
- AssetWriter
- FilterManager
-
-
Auth
-
Models
- AuthException
- Manager
-
-
Config
-
Database
-
Attach
-
Behaviors
-
Concerns
-
Connections
-
Connectors
-
Models
-
Relations
-
Schema
-
Traits
-
Updates
- README
- Builder
- Collection
- DatabaseServiceProvider
- DataFeed
- Dongle
- MemoryCache
- MigrationServiceProvider
- Model
- ModelBehavior
- ModelException
- MorphPivot
- NestedTreeScope
- Pivot
- QueryBuilder
- SortableScope
- TreeCollection
- Updater
-
-
Events
-
Exception
-
Extension
-
Filesystem
-
Flash
-
Foundation
-
Bootstrap
-
Console
-
Exception
-
Http
-
Middleware
- Kernel
-
-
Providers
- Application
- Maker
-
-
Halcyon
-
Datasource
-
Exception
-
Processors
-
Traits
- README
- Builder
- Collection
- HalcyonServiceProvider
- MemoryCacheManager
- MemoryRepository
- Model
-
-
Html
-
Mail
-
Network
-
Parse
-
Parsedown
-
Syntax
- Bracket
- Ini
- Markdown
- MarkdownData
- ParseServiceProvider
- Twig
- Yaml
-
-
Process
-
Resize
-
Router
-
Scaffold
-
Support
-
Translation
-
- Documentation
- API
- Library
- Events
- Dispatcher
October\Rain\Events\Dispatcher
Implements:
- Illuminate\Contracts\Events\Dispatcher
Protected properties
protected Illuminate\Contracts\Container\Container $container
The IoC container instance.
protected array $listeners
The registered event listeners.
protected array $wildcards
The wildcard listeners.
protected array $wildcardsCache
The cached wildcard listeners.
protected array $sorted
The sorted event listeners.
protected array $firing
The event firing stack.
protected callable $queueResolver
The queue resolver instance.
Public methods
public void __construct(Illuminate\Contracts\Container\Container|null $container=NULL)
Create a new event dispatcher instance.
Parameters
- Illuminate\Contracts\Container\Container|null $container
public Closure createClassListener(string $listener, bool $wildcard=false)
Create a class based listener using the IoC container.
Parameters
- string $listener
- bool $wildcard
public array|null dispatch(string|object $event, mixed $payload=array(), bool $halt=false)
Fire an event and call the listeners.
Parameters
- string|object $event
- mixed $payload
- bool $halt
public array|null fire(string|object $event, mixed $payload=array(), bool $halt=false)
Fire an event and call the listeners.
Parameters
- string|object $event
- mixed $payload
- bool $halt
public string firing()
Get the event that is currently firing.
public void flush(string $event)
Flush a set of pushed events.
Parameters
- string $event
public void forget(string $event)
Remove a set of listeners from the dispatcher.
Parameters
- string $event
public void forgetPushed()
Forget all of the pushed listeners.
public array getListeners(string $eventName)
Get all of the listeners for a given event name.
Parameters
- string $eventName
public bool hasListeners(string $eventName)
Determine if a given event has listeners.
Parameters
- string $eventName
public bool hasWildcardListeners(string $eventName)
Determine if the given event has any wildcard listeners.
Parameters
- string $eventName
public void listen(string|array $events, mixed $listener, int $priority=0)
Register an event listener with the dispatcher.
Parameters
- string|array $events
- mixed $listener
- int $priority
public Closure makeListener(Closure|string $listener, bool $wildcard=false)
Register an event listener with the dispatcher.
Parameters
- Closure|string $listener
- bool $wildcard
public void push(string $event, array $payload=array())
Register an event and payload to be fired later.
Parameters
- string $event
- array $payload
public $this setQueueResolver(callable $resolver)
Set the queue resolver implementation.
Parameters
- callable $resolver
public void subscribe(object|string $subscriber)
Register an event subscriber with the dispatcher.
Parameters
- object|string $subscriber
public array|null until(string|object $event, mixed $payload=array())
Fire an event until the first non-null response is returned.
Parameters
- string|object $event
- mixed $payload
Protected methods
protected array addInterfaceListeners(string $eventName, array $listeners=array())
Add the listeners for the event's interfaces to the given array.
Parameters
- string $eventName
- array $listeners
protected void broadcastEvent(Illuminate\Contracts\Broadcasting\ShouldBroadcast $event)
Broadcast the given event class.
Parameters
- Illuminate\Contracts\Broadcasting\ShouldBroadcast $event
protected void callQueueMethodOnHandler(string $class, string $method, array $arguments)
Call the queue method on the handler class.
Parameters
- string $class
- string $method
- array $arguments
protected array cloneArgumentsForQueueing(array $arguments)
Clone the given arguments for queueing.
Parameters
- array $arguments
protected callable createClassCallable(string $listener)
Create the class based event callable.
Parameters
- string $listener
protected Closure createQueuedHandlerCallable(string $class, string $method)
Create a callable for putting an event handler on the queue.
Parameters
- string $class
- string $method
protected array getWildcardListeners(string $eventName)
Get the wildcard listeners for the event.
Parameters
- string $eventName
protected bool handlerShouldBeQueued(string $class)
Determine if the event handler class should be queued.
Parameters
- string $class
protected array parseClassCallable(string $listener)
Parse the class listener into class and method.
Parameters
- string $listener
protected array parseEventAndPayload(mixed $event, mixed $payload)
Parse the given event and payload and prepare them for dispatching.
Parameters
- mixed $event
- mixed $payload
protected Illuminate\Contracts\Queue\Queue resolveQueue()
Get the queue implementation from the resolver.
protected mixed resolveSubscriber(object|string $subscriber)
Resolve the subscriber instance.
Parameters
- object|string $subscriber
protected void setupWildcardListen(string $event, mixed $listener)
Setup a wildcard listener callback.
Parameters
- string $event
- mixed $listener
protected array sortListeners(string $eventName)
Sort the listeners for a given event by priority.
Parameters
- string $eventName