JOOMLA中国
  • Joomla中国首页
  • 社区
  • 教程
  • 应用市场
  • B计划
Joomla! Framework TM
  • Namespace
  • Class
  • Tree
  • Deprecated

Namespaces

  • Composer
    • Autoload
  • Joomla
    • Application
      • Cli
        • Output
          • Processor
      • Web
    • Data
    • DI
      • Exception
    • Event
    • Filter
    • Input
    • Ldap
    • Registry
      • Format
    • Session
      • Storage
    • String
    • Uri
    • Utilities
  • None
  • PasswordCompat
    • binary
  • PHP
  • Psr
    • Log
  • Symfony
    • Component
      • Yaml
        • Exception
    • Polyfill
      • Util

Classes

  • AbstractEvent
  • DelegatingDispatcher
  • Dispatcher
  • Event
  • EventImmutable
  • ListenersPriorityQueue
  • Priority

Interfaces

  • DispatcherAwareInterface
  • DispatcherInterface
  • EventInterface

Traits

  • DispatcherAwareTrait

Class AbstractEvent

Implementation of EventInterface.

Joomla\Event\AbstractEvent implements Joomla\Event\EventInterface, ArrayAccess, Serializable, Countable

Direct known subclasses

Joomla\Event\Event, Joomla\Event\EventImmutable

Abstract
Namespace: Joomla\Event
Since: 1.0
Located at vendor/joomla/event/src/AbstractEvent.php

Methods summary

public
# __construct( string $name, array $arguments = array() )

Constructor.

Constructor.

Parameters

$name
string - $name The event name.
$arguments
array - $arguments The event arguments.

Since

1.0
public string
# getName( )

Get the event name.

Get the event name.

Returns

string - The event name.

Since

1.0

Implementation of

Joomla\Event\EventInterface::getName()
public mixed
# getArgument( string $name, mixed $default = null )

Get an event argument value.

Get an event argument value.

Parameters

$name
string - $name The argument name.
$default
mixed - $default The default value if not found.

Returns

mixed - The argument value or the default value.

Since

1.0
public boolean
# hasArgument( string $name )

Tell if the given event argument exists.

Tell if the given event argument exists.

Parameters

$name
string - $name The argument name.

Returns

boolean - True if it exists, false otherwise.

Since

1.0
public array
# getArguments( )

Get all event arguments.

Get all event arguments.

Returns

array - An associative array of argument names as keys and their values as values.

Since

1.0
public boolean
# isStopped( )

Tell if the event propagation is stopped.

Tell if the event propagation is stopped.

Returns

boolean - True if stopped, false otherwise.

Since

1.0

Implementation of

Joomla\Event\EventInterface::isStopped()
public integer
# count( )

Count the number of arguments.

Count the number of arguments.

Returns

integer - The number of arguments.

Since

1.0

Implementation of

Countable::count()
public string
# serialize( )

Serialize the event.

Serialize the event.

Returns

string - The serialized event.

Since

1.0

Implementation of

Serializable::serialize()
public
# unserialize( string $serialized )

Unserialize the event.

Unserialize the event.

Parameters

$serialized
string - $serialized The serialized event.

Since

1.0

Implementation of

Serializable::unserialize()
public boolean
# offsetExists( string $name )

Tell if the given event argument exists.

Tell if the given event argument exists.

Parameters

$name
string - $name The argument name.

Returns

boolean - True if it exists, false otherwise.

Since

1.0

Implementation of

ArrayAccess::offsetExists()
public mixed
# offsetGet( string $name )

Get an event argument value.

Get an event argument value.

Parameters

$name
string - $name The argument name.

Returns

mixed - The argument value or null if not existing.

Since

1.0

Implementation of

ArrayAccess::offsetGet()

Methods inherited from ArrayAccess

offsetSet(), offsetUnset()

Magic methods summary

Properties summary

protected string $name
#

The event name.

The event name.

Since

1.0
protected array $arguments
#

The event arguments.

The event arguments.

Since

1.0
protected boolean $stopped
#

A flag to see if the event propagation is stopped.

A flag to see if the event propagation is stopped.

Since

1.0
Joomla! Framework TM API documentation generated by ApiGen 2.8.0
Joomla!® and Joomla! Framework™ are trademarks of Open Source Matters, Inc. in the United States and other countries.