api/laravel/Support/Facades/Event.yaml
2024-09-26 02:03:21 -07:00

233 lines
6.4 KiB
YAML

name: Event
class_comment: '# * @method static void listen(\Closure|string|array $events, \Closure|string|array|null
$listener = null)
# * @method static bool hasListeners(string $eventName)
# * @method static bool hasWildcardListeners(string $eventName)
# * @method static void push(string $event, object|array $payload = [])
# * @method static void flush(string $event)
# * @method static void subscribe(object|string $subscriber)
# * @method static mixed until(string|object $event, mixed $payload = [])
# * @method static array|null dispatch(string|object $event, mixed $payload = [],
bool $halt = false)
# * @method static array getListeners(string $eventName)
# * @method static \Closure makeListener(\Closure|string|array $listener, bool $wildcard
= false)
# * @method static \Closure createClassListener(string $listener, bool $wildcard
= false)
# * @method static void forget(string $event)
# * @method static void forgetPushed()
# * @method static \Illuminate\Events\Dispatcher setQueueResolver(callable $resolver)
# * @method static \Illuminate\Events\Dispatcher setTransactionManagerResolver(callable
$resolver)
# * @method static array getRawListeners()
# * @method static void macro(string $name, object|callable $macro, object|callable
$macro = null)
# * @method static void mixin(object $mixin, bool $replace = true)
# * @method static bool hasMacro(string $name)
# * @method static void flushMacros()
# * @method static \Illuminate\Support\Testing\Fakes\EventFake except(array|string
$eventsToDispatch)
# * @method static void assertListening(string $expectedEvent, string|array $expectedListener)
# * @method static void assertDispatched(string|\Closure $event, callable|int|null
$callback = null)
# * @method static void assertDispatchedTimes(string $event, int $times = 1)
# * @method static void assertNotDispatched(string|\Closure $event, callable|null
$callback = null)
# * @method static void assertNothingDispatched()
# * @method static \Illuminate\Support\Collection dispatched(string $event, callable|null
$callback = null)
# * @method static bool hasDispatched(string $event)
# * @method static array dispatchedEvents()
# *
# * @see \Illuminate\Events\Dispatcher
# * @see \Illuminate\Support\Testing\Fakes\EventFake'
dependencies:
- name: Model
type: class
source: Illuminate\Database\Eloquent\Model
- name: EventFake
type: class
source: Illuminate\Support\Testing\Fakes\EventFake
properties: []
methods:
- name: fake
visibility: public
parameters:
- name: eventsToFake
default: '[]'
comment: '# * @method static void listen(\Closure|string|array $events, \Closure|string|array|null
$listener = null)
# * @method static bool hasListeners(string $eventName)
# * @method static bool hasWildcardListeners(string $eventName)
# * @method static void push(string $event, object|array $payload = [])
# * @method static void flush(string $event)
# * @method static void subscribe(object|string $subscriber)
# * @method static mixed until(string|object $event, mixed $payload = [])
# * @method static array|null dispatch(string|object $event, mixed $payload =
[], bool $halt = false)
# * @method static array getListeners(string $eventName)
# * @method static \Closure makeListener(\Closure|string|array $listener, bool
$wildcard = false)
# * @method static \Closure createClassListener(string $listener, bool $wildcard
= false)
# * @method static void forget(string $event)
# * @method static void forgetPushed()
# * @method static \Illuminate\Events\Dispatcher setQueueResolver(callable $resolver)
# * @method static \Illuminate\Events\Dispatcher setTransactionManagerResolver(callable
$resolver)
# * @method static array getRawListeners()
# * @method static void macro(string $name, object|callable $macro, object|callable
$macro = null)
# * @method static void mixin(object $mixin, bool $replace = true)
# * @method static bool hasMacro(string $name)
# * @method static void flushMacros()
# * @method static \Illuminate\Support\Testing\Fakes\EventFake except(array|string
$eventsToDispatch)
# * @method static void assertListening(string $expectedEvent, string|array $expectedListener)
# * @method static void assertDispatched(string|\Closure $event, callable|int|null
$callback = null)
# * @method static void assertDispatchedTimes(string $event, int $times = 1)
# * @method static void assertNotDispatched(string|\Closure $event, callable|null
$callback = null)
# * @method static void assertNothingDispatched()
# * @method static \Illuminate\Support\Collection dispatched(string $event, callable|null
$callback = null)
# * @method static bool hasDispatched(string $event)
# * @method static array dispatchedEvents()
# *
# * @see \Illuminate\Events\Dispatcher
# * @see \Illuminate\Support\Testing\Fakes\EventFake
# */
# class Event extends Facade
# {
# /**
# * Replace the bound instance with a fake.
# *
# * @param array|string $eventsToFake
# * @return \Illuminate\Support\Testing\Fakes\EventFake'
- name: fakeExcept
visibility: public
parameters:
- name: eventsToAllow
comment: '# * Replace the bound instance with a fake that fakes all events except
the given events.
# *
# * @param string[]|string $eventsToAllow
# * @return \Illuminate\Support\Testing\Fakes\EventFake'
- name: fakeFor
visibility: public
parameters:
- name: callable
- name: eventsToFake
default: '[]'
comment: '# * Replace the bound instance with a fake during the given callable''s
execution.
# *
# * @param callable $callable
# * @param array $eventsToFake
# * @return mixed'
- name: fakeExceptFor
visibility: public
parameters:
- name: callable
- name: eventsToAllow
default: '[]'
comment: '# * Replace the bound instance with a fake during the given callable''s
execution.
# *
# * @param callable $callable
# * @param array $eventsToAllow
# * @return mixed'
- name: getFacadeAccessor
visibility: protected
parameters: []
comment: '# * Get the registered name of the component.
# *
# * @return string'
traits:
- Illuminate\Database\Eloquent\Model
- Illuminate\Support\Testing\Fakes\EventFake
interfaces: []