[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/libraries/vendor/joomla/event/src/ -> AbstractEvent.php (summary)

Part of the Joomla Framework Event Package

Copyright: Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved.
License: GNU General Public License version 2 or later; see LICENSE
File Size: 242 lines (4 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 14 functions

  __construct()
  getName()
  getArgument()
  hasArgument()
  getArguments()
  isStopped()
  stopPropagation()
  count()
  serialize()
  __serialize()
  unserialize()
  __unserialize()
  offsetExists()
  offsetGet()

Functions
Functions that are not part of a class:

__construct($name, array $arguments = [])   X-Ref
Constructor.

param: string  $name       The event name.
param: array   $arguments  The event arguments.

getName()   X-Ref
Get the event name.

return: string  The event name.

getArgument($name, $default = null)   X-Ref
Get an event argument value.

param: string  $name     The argument name.
param: mixed   $default  The default value if not found.
return: mixed  The argument value or the default value.

hasArgument($name)   X-Ref
Tell if the given event argument exists.

param: string  $name  The argument name.
return: boolean  True if it exists, false otherwise.

getArguments()   X-Ref
Get all event arguments.

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

isStopped()   X-Ref
Tell if the event propagation is stopped.

return: boolean  True if stopped, false otherwise.

stopPropagation()   X-Ref
Stops the propagation of the event to further event listeners.

return: void

count()   X-Ref
Count the number of arguments.

return: integer  The number of arguments.

serialize()   X-Ref
Serialize the event.

return: string  The serialized event.

__serialize()   X-Ref
Serialize the event.

return: array  The data to be serialized

unserialize($serialized)   X-Ref
Unserialize the event.

param: string  $serialized  The serialized event.
return: void

__unserialize(array $data)   X-Ref
Unserialize the event.

param: array  $data  The serialized event.
return: void

offsetExists($name)   X-Ref
Tell if the given event argument exists.

param: string  $name  The argument name.
return: boolean  True if it exists, false otherwise.

offsetGet($name)   X-Ref
Get an event argument value.

param: string  $name  The argument name.
return: mixed  The argument value or null if not existing.



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer