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 Event

Default Event class.

Joomla\Event\AbstractEvent implements Joomla\Event\EventInterface, ArrayAccess, Serializable, Countable
Extended by Joomla\Event\Event
Namespace: Joomla\Event
Since: 1.0
Located at vendor/joomla/event/src/Event.php

Methods summary

public Joomla\Event\Event
# addArgument( string $name, mixed $value )

Add an event argument, only if it is not existing.

Add an event argument, only if it is not existing.

Parameters

$name
string - $name The argument name.
$value
mixed - $value The argument value.

Returns

Joomla\Event\Event - This method is chainable.

Since

1.0
public Joomla\Event\Event
# setArgument( string $name, mixed $value )

Set the value of an event argument. If the argument already exists, it will be overridden.

Set the value of an event argument. If the argument already exists, it will be overridden.

Parameters

$name
string - $name The argument name.
$value
mixed - $value The argument value.

Returns

Joomla\Event\Event - This method is chainable.

Since

1.0
public mixed
# removeArgument( string $name )

Remove an event argument.

Remove an event argument.

Parameters

$name
string - $name The argument name.

Returns

mixed - The old argument value or null if it is not existing.

Since

1.0
public array
# clearArguments( )

Clear all event arguments.

Clear all event arguments.

Returns

array - The old arguments.

Since

1.0
public
# stop( )

Stop the event propagation.

Stop the event propagation.

Since

1.0
public
# offsetSet( string $name, mixed $value )

Set the value of an event argument.

Set the value of an event argument.

Parameters

$name
string - $name The argument name.
$value
mixed - $value The argument value.

Throws

InvalidArgumentException - If the argument name is null.

Since

1.0
public
# offsetUnset( string $name )

Remove an event argument.

Remove an event argument.

Parameters

$name
string - $name The argument name.

Since

1.0

Methods inherited from Joomla\Event\AbstractEvent

__construct(), count(), getArgument(), getArguments(), getName(), hasArgument(), isStopped(), offsetExists(), offsetGet(), serialize(), unserialize()

Magic methods summary

Properties summary

Properties inherited from Joomla\Event\AbstractEvent

$arguments, $name, $stopped

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.