[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/libraries/vendor/joomla/event/src/ -> ListenersPriorityQueue.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: 162 lines (3 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 7 functions

  add()
  remove()
  has()
  getPriority()
  getAll()
  getIterator()
  count()

Functions
Functions that are not part of a class:

add(callable $callback, int $priority)   X-Ref
Add a listener with the given priority only if not already present.

param: callable  $callback  A callable function acting as an event listener.
param: integer   $priority  The listener priority.
return: $this

remove(callable $callback)   X-Ref
Remove a listener from the queue.

param: callable  $callback  A callable function acting as an event listener.
return: $this

has(callable $callback)   X-Ref
Tell if the listener exists in the queue.

param: callable  $callback  A callable function acting as an event listener.
return: boolean  True if it exists, false otherwise.

getPriority(callable $callback, $default = null)   X-Ref
Get the priority of the given listener.

param: callable  $callback  A callable function acting as an event listener.
param: mixed     $default   The default value to return if the listener doesn't exist.
return: mixed  The listener priority if it exists or the specified default value

getAll()   X-Ref
Get all listeners contained in this queue, sorted according to their priority.

return: callable[]  An array of listeners.

getIterator()   X-Ref
Get the priority queue.

return: \ArrayIterator

count()   X-Ref
Count the number of listeners in the queue.

return: integer  The number of listeners in the queue.



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