first commit
This commit is contained in:
340
libraries/vendor/joomla/event/LICENSE
vendored
Normal file
340
libraries/vendor/joomla/event/LICENSE
vendored
Normal file
@ -0,0 +1,340 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 2, June 1991
|
||||
|
||||
Copyright (C) 1989, 1991 Free Software Foundation, Inc.
|
||||
59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The licenses for most software are designed to take away your
|
||||
freedom to share and change it. By contrast, the GNU General Public
|
||||
License is intended to guarantee your freedom to share and change free
|
||||
software--to make sure the software is free for all its users. This
|
||||
General Public License applies to most of the Free Software
|
||||
Foundation's software and to any other program whose authors commit to
|
||||
using it. (Some other Free Software Foundation software is covered by
|
||||
the GNU Library General Public License instead.) You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
this service if you wish), that you receive source code or can get it
|
||||
if you want it, that you can change the software or use pieces of it
|
||||
in new free programs; and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to make restrictions that forbid
|
||||
anyone to deny you these rights or to ask you to surrender the rights.
|
||||
These restrictions translate to certain responsibilities for you if you
|
||||
distribute copies of the software, or if you modify it.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must give the recipients all the rights that
|
||||
you have. You must make sure that they, too, receive or can get the
|
||||
source code. And you must show them these terms so they know their
|
||||
rights.
|
||||
|
||||
We protect your rights with two steps: (1) copyright the software, and
|
||||
(2) offer you this license which gives you legal permission to copy,
|
||||
distribute and/or modify the software.
|
||||
|
||||
Also, for each author's protection and ours, we want to make certain
|
||||
that everyone understands that there is no warranty for this free
|
||||
software. If the software is modified by someone else and passed on, we
|
||||
want its recipients to know that what they have is not the original, so
|
||||
that any problems introduced by others will not reflect on the original
|
||||
authors' reputations.
|
||||
|
||||
Finally, any free program is threatened constantly by software
|
||||
patents. We wish to avoid the danger that redistributors of a free
|
||||
program will individually obtain patent licenses, in effect making the
|
||||
program proprietary. To prevent this, we have made it clear that any
|
||||
patent must be licensed for everyone's free use or not licensed at all.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
||||
|
||||
0. This License applies to any program or other work which contains
|
||||
a notice placed by the copyright holder saying it may be distributed
|
||||
under the terms of this General Public License. The "Program", below,
|
||||
refers to any such program or work, and a "work based on the Program"
|
||||
means either the Program or any derivative work under copyright law:
|
||||
that is to say, a work containing the Program or a portion of it,
|
||||
either verbatim or with modifications and/or translated into another
|
||||
language. (Hereinafter, translation is included without limitation in
|
||||
the term "modification".) Each licensee is addressed as "you".
|
||||
|
||||
Activities other than copying, distribution and modification are not
|
||||
covered by this License; they are outside its scope. The act of
|
||||
running the Program is not restricted, and the output from the Program
|
||||
is covered only if its contents constitute a work based on the
|
||||
Program (independent of having been made by running the Program).
|
||||
Whether that is true depends on what the Program does.
|
||||
|
||||
1. You may copy and distribute verbatim copies of the Program's
|
||||
source code as you receive it, in any medium, provided that you
|
||||
conspicuously and appropriately publish on each copy an appropriate
|
||||
copyright notice and disclaimer of warranty; keep intact all the
|
||||
notices that refer to this License and to the absence of any warranty;
|
||||
and give any other recipients of the Program a copy of this License
|
||||
along with the Program.
|
||||
|
||||
You may charge a fee for the physical act of transferring a copy, and
|
||||
you may at your option offer warranty protection in exchange for a fee.
|
||||
|
||||
2. You may modify your copy or copies of the Program or any portion
|
||||
of it, thus forming a work based on the Program, and copy and
|
||||
distribute such modifications or work under the terms of Section 1
|
||||
above, provided that you also meet all of these conditions:
|
||||
|
||||
a) You must cause the modified files to carry prominent notices
|
||||
stating that you changed the files and the date of any change.
|
||||
|
||||
b) You must cause any work that you distribute or publish, that in
|
||||
whole or in part contains or is derived from the Program or any
|
||||
part thereof, to be licensed as a whole at no charge to all third
|
||||
parties under the terms of this License.
|
||||
|
||||
c) If the modified program normally reads commands interactively
|
||||
when run, you must cause it, when started running for such
|
||||
interactive use in the most ordinary way, to print or display an
|
||||
announcement including an appropriate copyright notice and a
|
||||
notice that there is no warranty (or else, saying that you provide
|
||||
a warranty) and that users may redistribute the program under
|
||||
these conditions, and telling the user how to view a copy of this
|
||||
License. (Exception: if the Program itself is interactive but
|
||||
does not normally print such an announcement, your work based on
|
||||
the Program is not required to print an announcement.)
|
||||
|
||||
These requirements apply to the modified work as a whole. If
|
||||
identifiable sections of that work are not derived from the Program,
|
||||
and can be reasonably considered independent and separate works in
|
||||
themselves, then this License, and its terms, do not apply to those
|
||||
sections when you distribute them as separate works. But when you
|
||||
distribute the same sections as part of a whole which is a work based
|
||||
on the Program, the distribution of the whole must be on the terms of
|
||||
this License, whose permissions for other licensees extend to the
|
||||
entire whole, and thus to each and every part regardless of who wrote it.
|
||||
|
||||
Thus, it is not the intent of this section to claim rights or contest
|
||||
your rights to work written entirely by you; rather, the intent is to
|
||||
exercise the right to control the distribution of derivative or
|
||||
collective works based on the Program.
|
||||
|
||||
In addition, mere aggregation of another work not based on the Program
|
||||
with the Program (or with a work based on the Program) on a volume of
|
||||
a storage or distribution medium does not bring the other work under
|
||||
the scope of this License.
|
||||
|
||||
3. You may copy and distribute the Program (or a work based on it,
|
||||
under Section 2) in object code or executable form under the terms of
|
||||
Sections 1 and 2 above provided that you also do one of the following:
|
||||
|
||||
a) Accompany it with the complete corresponding machine-readable
|
||||
source code, which must be distributed under the terms of Sections
|
||||
1 and 2 above on a medium customarily used for software interchange; or,
|
||||
|
||||
b) Accompany it with a written offer, valid for at least three
|
||||
years, to give any third party, for a charge no more than your
|
||||
cost of physically performing source distribution, a complete
|
||||
machine-readable copy of the corresponding source code, to be
|
||||
distributed under the terms of Sections 1 and 2 above on a medium
|
||||
customarily used for software interchange; or,
|
||||
|
||||
c) Accompany it with the information you received as to the offer
|
||||
to distribute corresponding source code. (This alternative is
|
||||
allowed only for noncommercial distribution and only if you
|
||||
received the program in object code or executable form with such
|
||||
an offer, in accord with Subsection b above.)
|
||||
|
||||
The source code for a work means the preferred form of the work for
|
||||
making modifications to it. For an executable work, complete source
|
||||
code means all the source code for all modules it contains, plus any
|
||||
associated interface definition files, plus the scripts used to
|
||||
control compilation and installation of the executable. However, as a
|
||||
special exception, the source code distributed need not include
|
||||
anything that is normally distributed (in either source or binary
|
||||
form) with the major components (compiler, kernel, and so on) of the
|
||||
operating system on which the executable runs, unless that component
|
||||
itself accompanies the executable.
|
||||
|
||||
If distribution of executable or object code is made by offering
|
||||
access to copy from a designated place, then offering equivalent
|
||||
access to copy the source code from the same place counts as
|
||||
distribution of the source code, even though third parties are not
|
||||
compelled to copy the source along with the object code.
|
||||
|
||||
4. You may not copy, modify, sublicense, or distribute the Program
|
||||
except as expressly provided under this License. Any attempt
|
||||
otherwise to copy, modify, sublicense or distribute the Program is
|
||||
void, and will automatically terminate your rights under this License.
|
||||
However, parties who have received copies, or rights, from you under
|
||||
this License will not have their licenses terminated so long as such
|
||||
parties remain in full compliance.
|
||||
|
||||
5. You are not required to accept this License, since you have not
|
||||
signed it. However, nothing else grants you permission to modify or
|
||||
distribute the Program or its derivative works. These actions are
|
||||
prohibited by law if you do not accept this License. Therefore, by
|
||||
modifying or distributing the Program (or any work based on the
|
||||
Program), you indicate your acceptance of this License to do so, and
|
||||
all its terms and conditions for copying, distributing or modifying
|
||||
the Program or works based on it.
|
||||
|
||||
6. Each time you redistribute the Program (or any work based on the
|
||||
Program), the recipient automatically receives a license from the
|
||||
original licensor to copy, distribute or modify the Program subject to
|
||||
these terms and conditions. You may not impose any further
|
||||
restrictions on the recipients' exercise of the rights granted herein.
|
||||
You are not responsible for enforcing compliance by third parties to
|
||||
this License.
|
||||
|
||||
7. If, as a consequence of a court judgment or allegation of patent
|
||||
infringement or for any other reason (not limited to patent issues),
|
||||
conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot
|
||||
distribute so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you
|
||||
may not distribute the Program at all. For example, if a patent
|
||||
license would not permit royalty-free redistribution of the Program by
|
||||
all those who receive copies directly or indirectly through you, then
|
||||
the only way you could satisfy both it and this License would be to
|
||||
refrain entirely from distribution of the Program.
|
||||
|
||||
If any portion of this section is held invalid or unenforceable under
|
||||
any particular circumstance, the balance of the section is intended to
|
||||
apply and the section as a whole is intended to apply in other
|
||||
circumstances.
|
||||
|
||||
It is not the purpose of this section to induce you to infringe any
|
||||
patents or other property right claims or to contest validity of any
|
||||
such claims; this section has the sole purpose of protecting the
|
||||
integrity of the free software distribution system, which is
|
||||
implemented by public license practices. Many people have made
|
||||
generous contributions to the wide range of software distributed
|
||||
through that system in reliance on consistent application of that
|
||||
system; it is up to the author/donor to decide if he or she is willing
|
||||
to distribute software through any other system and a licensee cannot
|
||||
impose that choice.
|
||||
|
||||
This section is intended to make thoroughly clear what is believed to
|
||||
be a consequence of the rest of this License.
|
||||
|
||||
8. If the distribution and/or use of the Program is restricted in
|
||||
certain countries either by patents or by copyrighted interfaces, the
|
||||
original copyright holder who places the Program under this License
|
||||
may add an explicit geographical distribution limitation excluding
|
||||
those countries, so that distribution is permitted only in or among
|
||||
countries not thus excluded. In such case, this License incorporates
|
||||
the limitation as if written in the body of this License.
|
||||
|
||||
9. The Free Software Foundation may publish revised and/or new versions
|
||||
of the General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the Program
|
||||
specifies a version number of this License which applies to it and "any
|
||||
later version", you have the option of following the terms and conditions
|
||||
either of that version or of any later version published by the Free
|
||||
Software Foundation. If the Program does not specify a version number of
|
||||
this License, you may choose any version ever published by the Free Software
|
||||
Foundation.
|
||||
|
||||
10. If you wish to incorporate parts of the Program into other free
|
||||
programs whose distribution conditions are different, write to the author
|
||||
to ask for permission. For software which is copyrighted by the Free
|
||||
Software Foundation, write to the Free Software Foundation; we sometimes
|
||||
make exceptions for this. Our decision will be guided by the two goals
|
||||
of preserving the free status of all derivatives of our free software and
|
||||
of promoting the sharing and reuse of software generally.
|
||||
|
||||
NO WARRANTY
|
||||
|
||||
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
|
||||
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
|
||||
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
|
||||
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
|
||||
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
||||
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
|
||||
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
|
||||
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
|
||||
REPAIR OR CORRECTION.
|
||||
|
||||
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
|
||||
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
|
||||
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
|
||||
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
|
||||
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
|
||||
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
|
||||
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
|
||||
POSSIBILITY OF SUCH DAMAGES.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
convey the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software; you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation; either version 2 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program; if not, write to the Free Software
|
||||
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
||||
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program is interactive, make it output a short notice like this
|
||||
when it starts in an interactive mode:
|
||||
|
||||
Gnomovision version 69, Copyright (C) year name of author
|
||||
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, the commands you use may
|
||||
be called something other than `show w' and `show c'; they could even be
|
||||
mouse-clicks or menu items--whatever suits your program.
|
||||
|
||||
You should also get your employer (if you work as a programmer) or your
|
||||
school, if any, to sign a "copyright disclaimer" for the program, if
|
||||
necessary. Here is a sample; alter the names:
|
||||
|
||||
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
|
||||
`Gnomovision' (which makes passes at compilers) written by James Hacker.
|
||||
|
||||
<signature of Ty Coon>, 1 April 1989
|
||||
Ty Coon, President of Vice
|
||||
|
||||
This General Public License does not permit incorporating your program into
|
||||
proprietary programs. If your program is a subroutine library, you may
|
||||
consider it more useful to permit linking proprietary applications with the
|
||||
library. If this is what you want to do, use the GNU Library General
|
||||
Public License instead of this License.
|
||||
242
libraries/vendor/joomla/event/src/AbstractEvent.php
vendored
Normal file
242
libraries/vendor/joomla/event/src/AbstractEvent.php
vendored
Normal file
@ -0,0 +1,242 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
|
||||
namespace Joomla\Event;
|
||||
|
||||
use ArrayAccess;
|
||||
use Countable;
|
||||
use Serializable;
|
||||
|
||||
/**
|
||||
* Implementation of EventInterface.
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
abstract class AbstractEvent implements EventInterface, ArrayAccess, Serializable, Countable
|
||||
{
|
||||
/**
|
||||
* The event name.
|
||||
*
|
||||
* @var string
|
||||
* @since 1.0
|
||||
*/
|
||||
protected $name;
|
||||
|
||||
/**
|
||||
* The event arguments.
|
||||
*
|
||||
* @var array
|
||||
* @since 1.0
|
||||
*/
|
||||
protected $arguments;
|
||||
|
||||
/**
|
||||
* A flag to see if the event propagation is stopped.
|
||||
*
|
||||
* @var boolean
|
||||
* @since 1.0
|
||||
*/
|
||||
protected $stopped = false;
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param string $name The event name.
|
||||
* @param array $arguments The event arguments.
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
public function __construct($name, array $arguments = [])
|
||||
{
|
||||
$this->name = $name;
|
||||
$this->arguments = $arguments;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the event name.
|
||||
*
|
||||
* @return string The event name.
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
public function getName()
|
||||
{
|
||||
return $this->name;
|
||||
}
|
||||
|
||||
/**
|
||||
* 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.
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
public function getArgument($name, $default = null)
|
||||
{
|
||||
if (isset($this->arguments[$name])) {
|
||||
return $this->arguments[$name];
|
||||
}
|
||||
|
||||
return $default;
|
||||
}
|
||||
|
||||
/**
|
||||
* Tell if the given event argument exists.
|
||||
*
|
||||
* @param string $name The argument name.
|
||||
*
|
||||
* @return boolean True if it exists, false otherwise.
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
public function hasArgument($name)
|
||||
{
|
||||
return isset($this->arguments[$name]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get all event arguments.
|
||||
*
|
||||
* @return array An associative array of argument names as keys and their values as values.
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
public function getArguments()
|
||||
{
|
||||
return $this->arguments;
|
||||
}
|
||||
|
||||
/**
|
||||
* Tell if the event propagation is stopped.
|
||||
*
|
||||
* @return boolean True if stopped, false otherwise.
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
public function isStopped()
|
||||
{
|
||||
return $this->stopped === true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Stops the propagation of the event to further event listeners.
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function stopPropagation(): void
|
||||
{
|
||||
$this->stopped = true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Count the number of arguments.
|
||||
*
|
||||
* @return integer The number of arguments.
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
#[\ReturnTypeWillChange]
|
||||
public function count()
|
||||
{
|
||||
return \count($this->arguments);
|
||||
}
|
||||
|
||||
/**
|
||||
* Serialize the event.
|
||||
*
|
||||
* @return string The serialized event.
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
public function serialize()
|
||||
{
|
||||
return serialize($this->__serialize());
|
||||
}
|
||||
|
||||
/**
|
||||
* Serialize the event.
|
||||
*
|
||||
* @return array The data to be serialized
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function __serialize()
|
||||
{
|
||||
return [
|
||||
'name' => $this->name,
|
||||
'arguments' => $this->arguments,
|
||||
'stopped' => $this->stopped,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Unserialize the event.
|
||||
*
|
||||
* @param string $serialized The serialized event.
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
public function unserialize($serialized)
|
||||
{
|
||||
$this->__unserialize(unserialize($serialized));
|
||||
}
|
||||
|
||||
/**
|
||||
* Unserialize the event.
|
||||
*
|
||||
* @param array $data The serialized event.
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function __unserialize(array $data)
|
||||
{
|
||||
$this->name = $data['name'];
|
||||
$this->arguments = $data['arguments'];
|
||||
$this->stopped = $data['stopped'];
|
||||
}
|
||||
|
||||
/**
|
||||
* Tell if the given event argument exists.
|
||||
*
|
||||
* @param string $name The argument name.
|
||||
*
|
||||
* @return boolean True if it exists, false otherwise.
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
#[\ReturnTypeWillChange]
|
||||
public function offsetExists($name)
|
||||
{
|
||||
return $this->hasArgument($name);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an event argument value.
|
||||
*
|
||||
* @param string $name The argument name.
|
||||
*
|
||||
* @return mixed The argument value or null if not existing.
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
#[\ReturnTypeWillChange]
|
||||
public function offsetGet($name)
|
||||
{
|
||||
return $this->getArgument($name);
|
||||
}
|
||||
}
|
||||
196
libraries/vendor/joomla/event/src/Command/DebugEventDispatcherCommand.php
vendored
Normal file
196
libraries/vendor/joomla/event/src/Command/DebugEventDispatcherCommand.php
vendored
Normal file
@ -0,0 +1,196 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
|
||||
namespace Joomla\Event\Command;
|
||||
|
||||
use Joomla\Console\Command\AbstractCommand;
|
||||
use Joomla\Event\DispatcherAwareInterface;
|
||||
use Joomla\Event\DispatcherAwareTrait;
|
||||
use Joomla\Event\DispatcherInterface;
|
||||
use Symfony\Component\Console\Input\InputArgument;
|
||||
use Symfony\Component\Console\Input\InputInterface;
|
||||
use Symfony\Component\Console\Output\OutputInterface;
|
||||
use Symfony\Component\Console\Style\SymfonyStyle;
|
||||
|
||||
/**
|
||||
* Command listing information about the application's event dispatcher.
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
class DebugEventDispatcherCommand extends AbstractCommand implements DispatcherAwareInterface
|
||||
{
|
||||
use DispatcherAwareTrait;
|
||||
|
||||
/**
|
||||
* The default command name
|
||||
*
|
||||
* @var string
|
||||
* @since 2.0.0
|
||||
*/
|
||||
protected static $defaultName = 'debug:event-dispatcher';
|
||||
|
||||
/**
|
||||
* Instantiate the command.
|
||||
*
|
||||
* @param DispatcherInterface $dispatcher The application event dispatcher.
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function __construct(DispatcherInterface $dispatcher)
|
||||
{
|
||||
$this->setDispatcher($dispatcher);
|
||||
|
||||
parent::__construct();
|
||||
}
|
||||
|
||||
/**
|
||||
* Configure the command.
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
protected function configure(): void
|
||||
{
|
||||
$this->setDescription("Displays information about the application's event dispatcher");
|
||||
$this->addArgument('event', InputArgument::OPTIONAL, 'Show the listeners for a specific event');
|
||||
$this->setHelp(<<<'EOF'
|
||||
The <info>%command.name%</info> command lists all of the registered event handlers in an application's event dispatcher:
|
||||
|
||||
<info>php %command.full_name%</info>
|
||||
|
||||
To get specific listeners for an event, specify its name:
|
||||
|
||||
<info>php %command.full_name% application.before_execute</info>
|
||||
EOF
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Internal function to execute the command.
|
||||
*
|
||||
* @param InputInterface $input The input to inject into the command.
|
||||
* @param OutputInterface $output The output to inject into the command.
|
||||
*
|
||||
* @return integer The command exit code
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
protected function doExecute(InputInterface $input, OutputInterface $output): int
|
||||
{
|
||||
$io = new SymfonyStyle($input, $output);
|
||||
|
||||
if ($event = $input->getArgument('event')) {
|
||||
$listeners = $this->dispatcher->getListeners($event);
|
||||
|
||||
if (empty($listeners)) {
|
||||
$io->warning(sprintf('The event "%s" does not have any registered listeners.', $event));
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
$io->title(sprintf('%s Registered Listeners for "%s" Event', $this->getApplication()->getName(), $event));
|
||||
|
||||
$this->renderEventListenerTable($listeners, $io);
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
$listeners = $this->dispatcher->getListeners();
|
||||
|
||||
if (empty($listeners)) {
|
||||
$io->comment('There are no listeners registered to the event dispatcher.');
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
$io->title(sprintf('%s Registered Listeners Grouped By Event', $this->getApplication()->getName()));
|
||||
|
||||
ksort($listeners);
|
||||
|
||||
foreach ($listeners as $subscribedEvent => $eventListeners) {
|
||||
$io->section(sprintf('"%s" event', $subscribedEvent));
|
||||
|
||||
$this->renderEventListenerTable($eventListeners, $io);
|
||||
}
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Formats a callable resource to be displayed in the console output
|
||||
*
|
||||
* @param callable $callable A callable resource to format
|
||||
*
|
||||
* @return string
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @throws \ReflectionException
|
||||
* @note This method is based on \Symfony\Bundle\FrameworkBundle\Console\Descriptor\TextDescriptor::formatCallable()
|
||||
*/
|
||||
private function formatCallable($callable): string
|
||||
{
|
||||
if (\is_array($callable)) {
|
||||
if (\is_object($callable[0])) {
|
||||
return sprintf('%s::%s()', \get_class($callable[0]), $callable[1]);
|
||||
}
|
||||
|
||||
return sprintf('%s::%s()', $callable[0], $callable[1]);
|
||||
}
|
||||
|
||||
if (\is_string($callable)) {
|
||||
return sprintf('%s()', $callable);
|
||||
}
|
||||
|
||||
if ($callable instanceof \Closure) {
|
||||
$r = new \ReflectionFunction($callable);
|
||||
|
||||
if (strpos($r->name, '{closure}') !== false) {
|
||||
return 'Closure()';
|
||||
}
|
||||
|
||||
if (null !== $class = $r->getClosureScopeClass()) {
|
||||
return sprintf('%s::%s()', $class->name, $r->name);
|
||||
}
|
||||
|
||||
return $r->name . '()';
|
||||
}
|
||||
|
||||
if (method_exists($callable, '__invoke')) {
|
||||
return sprintf('%s::__invoke()', \get_class($callable));
|
||||
}
|
||||
|
||||
throw new \InvalidArgumentException('Callable is not describable.');
|
||||
}
|
||||
|
||||
/**
|
||||
* Renders the table of listeners for an event
|
||||
*
|
||||
* @param array $eventListeners The listeners for an event
|
||||
* @param SymfonyStyle $io The I/O helper
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
private function renderEventListenerTable(array $eventListeners, SymfonyStyle $io): void
|
||||
{
|
||||
$tableHeaders = ['Order', 'Callable'];
|
||||
$tableRows = [];
|
||||
|
||||
foreach ($eventListeners as $order => $listener) {
|
||||
$tableRows[] = [
|
||||
sprintf('#%d', $order + 1),
|
||||
$this->formatCallable($listener),
|
||||
];
|
||||
}
|
||||
|
||||
$io->table($tableHeaders, $tableRows);
|
||||
}
|
||||
}
|
||||
506
libraries/vendor/joomla/event/src/Dispatcher.php
vendored
Normal file
506
libraries/vendor/joomla/event/src/Dispatcher.php
vendored
Normal file
@ -0,0 +1,506 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
|
||||
namespace Joomla\Event;
|
||||
|
||||
/**
|
||||
* Implementation of a DispatcherInterface supporting prioritized listeners.
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
class Dispatcher implements DispatcherInterface
|
||||
{
|
||||
/**
|
||||
* An array of registered events indexed by the event names.
|
||||
*
|
||||
* @var EventInterface[]
|
||||
* @since 1.0
|
||||
* @deprecated 3.0 Default event objects will no longer be supported
|
||||
*/
|
||||
protected $events = [];
|
||||
|
||||
/**
|
||||
* An array of ListenersPriorityQueue indexed by the event names.
|
||||
*
|
||||
* @var ListenersPriorityQueue[]
|
||||
* @since 1.0
|
||||
*/
|
||||
protected $listeners = [];
|
||||
|
||||
/**
|
||||
* Set an event to the dispatcher. It will replace any event with the same name.
|
||||
*
|
||||
* @param EventInterface $event The event.
|
||||
*
|
||||
* @return $this
|
||||
*
|
||||
* @since 1.0
|
||||
* @deprecated 3.0 Default event objects will no longer be supported
|
||||
*/
|
||||
public function setEvent(EventInterface $event)
|
||||
{
|
||||
trigger_deprecation(
|
||||
'joomla/event',
|
||||
'2.0.0',
|
||||
'%s() is deprecated and will be removed in 3.0.',
|
||||
__METHOD__
|
||||
);
|
||||
|
||||
$this->events[$event->getName()] = $event;
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Add an event to this dispatcher, only if it is not existing.
|
||||
*
|
||||
* @param EventInterface $event The event.
|
||||
*
|
||||
* @return $this
|
||||
*
|
||||
* @since 1.0
|
||||
* @deprecated 3.0 Default event objects will no longer be supported
|
||||
*/
|
||||
public function addEvent(EventInterface $event)
|
||||
{
|
||||
trigger_deprecation(
|
||||
'joomla/event',
|
||||
'2.0.0',
|
||||
'%s() is deprecated and will be removed in 3.0.',
|
||||
__METHOD__
|
||||
);
|
||||
|
||||
if (!isset($this->events[$event->getName()])) {
|
||||
$this->events[$event->getName()] = $event;
|
||||
}
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Tell if the given event has been added to this dispatcher.
|
||||
*
|
||||
* @param EventInterface|string $event The event object or name.
|
||||
*
|
||||
* @return boolean True if the listener has the given event, false otherwise.
|
||||
*
|
||||
* @since 1.0
|
||||
* @deprecated 3.0 Default event objects will no longer be supported
|
||||
*/
|
||||
public function hasEvent($event)
|
||||
{
|
||||
trigger_deprecation(
|
||||
'joomla/event',
|
||||
'2.0.0',
|
||||
'%s() is deprecated and will be removed in 3.0.',
|
||||
__METHOD__
|
||||
);
|
||||
|
||||
if ($event instanceof EventInterface) {
|
||||
$event = $event->getName();
|
||||
}
|
||||
|
||||
return isset($this->events[$event]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the event object identified by the given name.
|
||||
*
|
||||
* @param string $name The event name.
|
||||
* @param mixed $default The default value if the event was not registered.
|
||||
*
|
||||
* @return EventInterface|mixed The event of the default value.
|
||||
*
|
||||
* @since 1.0
|
||||
* @deprecated 3.0 Default event objects will no longer be supported
|
||||
*/
|
||||
public function getEvent($name, $default = null)
|
||||
{
|
||||
trigger_deprecation(
|
||||
'joomla/event',
|
||||
'2.0.0',
|
||||
'%s() is deprecated and will be removed in 3.0.',
|
||||
__METHOD__
|
||||
);
|
||||
|
||||
if (isset($this->events[$name])) {
|
||||
return $this->events[$name];
|
||||
}
|
||||
|
||||
return $default;
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove an event from this dispatcher. The registered listeners will remain.
|
||||
*
|
||||
* @param EventInterface|string $event The event object or name.
|
||||
*
|
||||
* @return $this
|
||||
*
|
||||
* @since 1.0
|
||||
* @deprecated 3.0 Default event objects will no longer be supported
|
||||
*/
|
||||
public function removeEvent($event)
|
||||
{
|
||||
trigger_deprecation(
|
||||
'joomla/event',
|
||||
'2.0.0',
|
||||
'%s() is deprecated and will be removed in 3.0.',
|
||||
__METHOD__
|
||||
);
|
||||
|
||||
if ($event instanceof EventInterface) {
|
||||
$event = $event->getName();
|
||||
}
|
||||
|
||||
if (isset($this->events[$event])) {
|
||||
unset($this->events[$event]);
|
||||
}
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the registered events.
|
||||
*
|
||||
* @return EventInterface[] The registered event.
|
||||
*
|
||||
* @since 1.0
|
||||
* @deprecated 3.0 Default event objects will no longer be supported
|
||||
*/
|
||||
public function getEvents()
|
||||
{
|
||||
trigger_deprecation(
|
||||
'joomla/event',
|
||||
'2.0.0',
|
||||
'%s() is deprecated and will be removed in 3.0.',
|
||||
__METHOD__
|
||||
);
|
||||
|
||||
return $this->events;
|
||||
}
|
||||
|
||||
/**
|
||||
* Clear all events.
|
||||
*
|
||||
* @return EventInterface[] The old events.
|
||||
*
|
||||
* @since 1.0
|
||||
* @deprecated 3.0 Default event objects will no longer be supported
|
||||
*/
|
||||
public function clearEvents()
|
||||
{
|
||||
trigger_deprecation(
|
||||
'joomla/event',
|
||||
'2.0.0',
|
||||
'%s() is deprecated and will be removed in 3.0.',
|
||||
__METHOD__
|
||||
);
|
||||
|
||||
$events = $this->events;
|
||||
$this->events = [];
|
||||
|
||||
return $events;
|
||||
}
|
||||
|
||||
/**
|
||||
* Count the number of registered event.
|
||||
*
|
||||
* @return integer The number of registered events.
|
||||
*
|
||||
* @since 1.0
|
||||
* @deprecated 3.0 Default event objects will no longer be supported
|
||||
*/
|
||||
public function countEvents()
|
||||
{
|
||||
trigger_deprecation(
|
||||
'joomla/event',
|
||||
'2.0.0',
|
||||
'%s() is deprecated and will be removed in 3.0.',
|
||||
__METHOD__
|
||||
);
|
||||
|
||||
return \count($this->events);
|
||||
}
|
||||
|
||||
/**
|
||||
* Attaches a listener to an event
|
||||
*
|
||||
* @param string $eventName The event to listen to.
|
||||
* @param callable $callback A callable function
|
||||
* @param integer $priority The priority at which the $callback executed
|
||||
*
|
||||
* @return boolean
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
public function addListener(string $eventName, callable $callback, int $priority = 0): bool
|
||||
{
|
||||
if (!isset($this->listeners[$eventName])) {
|
||||
$this->listeners[$eventName] = new ListenersPriorityQueue();
|
||||
}
|
||||
|
||||
$this->listeners[$eventName]->add($callback, $priority);
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the priority of the given listener for the given event.
|
||||
*
|
||||
* @param string $eventName The event to listen to.
|
||||
* @param callable $callback A callable function
|
||||
*
|
||||
* @return mixed The listener priority or null if the listener doesn't exist.
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
public function getListenerPriority($eventName, callable $callback)
|
||||
{
|
||||
if (isset($this->listeners[$eventName])) {
|
||||
return $this->listeners[$eventName]->getPriority($callback);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the listeners registered to the given event.
|
||||
*
|
||||
* @param string|null $event The event to fetch listeners for or null to fetch all listeners
|
||||
*
|
||||
* @return callable[] An array of registered listeners sorted according to their priorities.
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
public function getListeners(?string $event = null)
|
||||
{
|
||||
if ($event !== null) {
|
||||
if (isset($this->listeners[$event])) {
|
||||
return $this->listeners[$event]->getAll();
|
||||
}
|
||||
|
||||
return [];
|
||||
}
|
||||
|
||||
$dispatcherListeners = [];
|
||||
|
||||
foreach ($this->listeners as $registeredEvent => $listeners) {
|
||||
$dispatcherListeners[$registeredEvent] = $listeners->getAll();
|
||||
}
|
||||
|
||||
return $dispatcherListeners;
|
||||
}
|
||||
|
||||
/**
|
||||
* Tell if the given listener has been added.
|
||||
*
|
||||
* If an event is specified, it will tell if the listener is registered for that event.
|
||||
*
|
||||
* @param callable $callback The callable to check is listening to the event.
|
||||
* @param ?string $eventName An optional event name to check a listener is subscribed to.
|
||||
*
|
||||
* @return boolean True if the listener is registered, false otherwise.
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
public function hasListener(callable $callback, ?string $eventName = null)
|
||||
{
|
||||
if ($eventName) {
|
||||
if (isset($this->listeners[$eventName])) {
|
||||
return $this->listeners[$eventName]->has($callback);
|
||||
}
|
||||
} else {
|
||||
foreach ($this->listeners as $queue) {
|
||||
if ($queue->has($callback)) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes an event listener from the specified event.
|
||||
*
|
||||
* @param string $eventName The event to remove a listener from.
|
||||
* @param callable $listener The listener to remove.
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function removeListener(string $eventName, callable $listener): void
|
||||
{
|
||||
if (isset($this->listeners[$eventName])) {
|
||||
$this->listeners[$eventName]->remove($listener);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Clear the listeners in this dispatcher.
|
||||
*
|
||||
* If an event is specified, the listeners will be cleared only for that event.
|
||||
*
|
||||
* @param string $event The event name.
|
||||
*
|
||||
* @return $this
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
public function clearListeners($event = null)
|
||||
{
|
||||
if ($event) {
|
||||
if (isset($this->listeners[$event])) {
|
||||
unset($this->listeners[$event]);
|
||||
}
|
||||
} else {
|
||||
$this->listeners = [];
|
||||
}
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Count the number of registered listeners for the given event.
|
||||
*
|
||||
* @param string $event The event name.
|
||||
*
|
||||
* @return integer
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
public function countListeners($event)
|
||||
{
|
||||
return isset($this->listeners[$event]) ? \count($this->listeners[$event]) : 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds an event subscriber.
|
||||
*
|
||||
* @param SubscriberInterface $subscriber The subscriber.
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function addSubscriber(SubscriberInterface $subscriber): void
|
||||
{
|
||||
foreach ($subscriber->getSubscribedEvents() as $eventName => $params) {
|
||||
if (\is_array($params)) {
|
||||
$this->addListener($eventName, [$subscriber, $params[0]], $params[1] ?? Priority::NORMAL);
|
||||
} else {
|
||||
$this->addListener($eventName, [$subscriber, $params]);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes an event subscriber.
|
||||
*
|
||||
* @param SubscriberInterface $subscriber The subscriber.
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function removeSubscriber(SubscriberInterface $subscriber): void
|
||||
{
|
||||
foreach ($subscriber->getSubscribedEvents() as $eventName => $params) {
|
||||
if (\is_array($params)) {
|
||||
$this->removeListener($eventName, [$subscriber, $params[0]]);
|
||||
} else {
|
||||
$this->removeListener($eventName, [$subscriber, $params]);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Dispatches an event to all registered listeners.
|
||||
*
|
||||
* @param string $name The name of the event to dispatch.
|
||||
* @param ?EventInterface $event The event to pass to the event handlers/listeners.
|
||||
* If not supplied, an empty EventInterface instance is created.
|
||||
* Note, not passing an event is deprecated and will be required as of 3.0.
|
||||
*
|
||||
* @return EventInterface
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function dispatch(string $name, ?EventInterface $event = null): EventInterface
|
||||
{
|
||||
if (!($event instanceof EventInterface)) {
|
||||
trigger_deprecation(
|
||||
'joomla/event',
|
||||
'2.0.0',
|
||||
'Not passing an event object to %s() is deprecated, as of 3.0 the $event argument will be required.',
|
||||
__METHOD__
|
||||
);
|
||||
|
||||
$event = $this->getDefaultEvent($name);
|
||||
}
|
||||
|
||||
if (isset($this->listeners[$event->getName()])) {
|
||||
foreach ($this->listeners[$event->getName()] as $listener) {
|
||||
if ($event->isStopped()) {
|
||||
return $event;
|
||||
}
|
||||
|
||||
$listener($event);
|
||||
}
|
||||
}
|
||||
|
||||
return $event;
|
||||
}
|
||||
|
||||
/**
|
||||
* Trigger an event.
|
||||
*
|
||||
* @param EventInterface|string $event The event object or name.
|
||||
*
|
||||
* @return EventInterface The event after being passed through all listeners.
|
||||
*
|
||||
* @since 1.0
|
||||
* @deprecated 3.0 Use dispatch() instead.
|
||||
*/
|
||||
public function triggerEvent($event)
|
||||
{
|
||||
trigger_deprecation(
|
||||
'joomla/event',
|
||||
'2.0.0',
|
||||
'%s() is deprecated and will be removed in 3.0, use %s::dispatch() instead.',
|
||||
__METHOD__,
|
||||
DispatcherInterface::class
|
||||
);
|
||||
|
||||
if (!($event instanceof EventInterface)) {
|
||||
$event = $this->getDefaultEvent($event);
|
||||
}
|
||||
|
||||
return $this->dispatch($event->getName(), $event);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an event object for the specified event name
|
||||
*
|
||||
* @param string $name The event name to get an EventInterface object for
|
||||
*
|
||||
* @return EventInterface
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @deprecated 3.0 Default event objects will no longer be supported
|
||||
*/
|
||||
private function getDefaultEvent(string $name): EventInterface
|
||||
{
|
||||
if (isset($this->events[$name])) {
|
||||
return $this->events[$name];
|
||||
}
|
||||
|
||||
return new Event($name);
|
||||
}
|
||||
}
|
||||
29
libraries/vendor/joomla/event/src/DispatcherAwareInterface.php
vendored
Normal file
29
libraries/vendor/joomla/event/src/DispatcherAwareInterface.php
vendored
Normal file
@ -0,0 +1,29 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
|
||||
namespace Joomla\Event;
|
||||
|
||||
/**
|
||||
* Interface to be implemented by classes depending on a dispatcher.
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
interface DispatcherAwareInterface
|
||||
{
|
||||
/**
|
||||
* Set the dispatcher to use.
|
||||
*
|
||||
* @param DispatcherInterface $dispatcher The dispatcher to use.
|
||||
*
|
||||
* @return DispatcherAwareInterface This method is chainable.
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
public function setDispatcher(DispatcherInterface $dispatcher);
|
||||
}
|
||||
59
libraries/vendor/joomla/event/src/DispatcherAwareTrait.php
vendored
Normal file
59
libraries/vendor/joomla/event/src/DispatcherAwareTrait.php
vendored
Normal file
@ -0,0 +1,59 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
|
||||
namespace Joomla\Event;
|
||||
|
||||
/**
|
||||
* Defines the trait for a Dispatcher Aware Class.
|
||||
*
|
||||
* @since 1.2.0
|
||||
*/
|
||||
trait DispatcherAwareTrait
|
||||
{
|
||||
/**
|
||||
* Event Dispatcher
|
||||
*
|
||||
* @var DispatcherInterface|null
|
||||
* @since 1.2.0
|
||||
*/
|
||||
private $dispatcher;
|
||||
|
||||
/**
|
||||
* Get the event dispatcher.
|
||||
*
|
||||
* @return DispatcherInterface
|
||||
*
|
||||
* @since 1.2.0
|
||||
* @throws \UnexpectedValueException May be thrown if the dispatcher has not been set.
|
||||
*/
|
||||
public function getDispatcher()
|
||||
{
|
||||
if ($this->dispatcher) {
|
||||
return $this->dispatcher;
|
||||
}
|
||||
|
||||
throw new \UnexpectedValueException('Dispatcher not set in ' . __CLASS__);
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the dispatcher to use.
|
||||
*
|
||||
* @param DispatcherInterface $dispatcher The dispatcher to use.
|
||||
*
|
||||
* @return $this
|
||||
*
|
||||
* @since 1.2.0
|
||||
*/
|
||||
public function setDispatcher(DispatcherInterface $dispatcher)
|
||||
{
|
||||
$this->dispatcher = $dispatcher;
|
||||
|
||||
return $this;
|
||||
}
|
||||
}
|
||||
128
libraries/vendor/joomla/event/src/DispatcherInterface.php
vendored
Normal file
128
libraries/vendor/joomla/event/src/DispatcherInterface.php
vendored
Normal file
@ -0,0 +1,128 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
|
||||
namespace Joomla\Event;
|
||||
|
||||
/**
|
||||
* Interface for event dispatchers.
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
interface DispatcherInterface
|
||||
{
|
||||
/**
|
||||
* Dispatches an event to all registered listeners.
|
||||
*
|
||||
* @param string $name The name of the event to dispatch.
|
||||
* @param ?EventInterface $event The event to pass to the event handlers/listeners.
|
||||
* If not supplied, an empty EventInterface instance is created.
|
||||
* Note, not passing an event is deprecated and will be required as of 3.0.
|
||||
*
|
||||
* @return EventInterface
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function dispatch(string $name, ?EventInterface $event = null): EventInterface;
|
||||
|
||||
/**
|
||||
* Attaches a listener to an event
|
||||
*
|
||||
* @param string $eventName The event to listen to.
|
||||
* @param callable $callback A callable function.
|
||||
* @param integer $priority The priority at which the $callback executed.
|
||||
*
|
||||
* @return boolean
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function addListener(string $eventName, callable $callback, int $priority = 0): bool;
|
||||
|
||||
/**
|
||||
* Clear the listeners in this dispatcher.
|
||||
*
|
||||
* If an event is specified, the listeners will be cleared only for that event.
|
||||
*
|
||||
* @param string $event The event name.
|
||||
*
|
||||
* @return $this
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function clearListeners($event = null);
|
||||
|
||||
/**
|
||||
* Count the number of registered listeners for the given event.
|
||||
*
|
||||
* @param string $event The event name.
|
||||
*
|
||||
* @return integer
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function countListeners($event);
|
||||
|
||||
/**
|
||||
* Get the listeners registered to the given event.
|
||||
*
|
||||
* @param string|null $event The event to fetch listeners for or null to fetch all listeners
|
||||
*
|
||||
* @return callable[] An array of registered listeners sorted according to their priorities.
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function getListeners(?string $event = null);
|
||||
|
||||
/**
|
||||
* Tell if the given listener has been added.
|
||||
*
|
||||
* If an event is specified, it will tell if the listener is registered for that event.
|
||||
*
|
||||
* @param callable $callback The callable to check is listening to the event.
|
||||
* @param string|null $eventName An optional event name to check a listener is subscribed to.
|
||||
*
|
||||
* @return boolean True if the listener is registered, false otherwise.
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function hasListener(callable $callback, ?string $eventName = null);
|
||||
|
||||
/**
|
||||
* Removes an event listener from the specified event.
|
||||
*
|
||||
* @param string $eventName The event to remove a listener from.
|
||||
* @param callable $listener The listener to remove.
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function removeListener(string $eventName, callable $listener): void;
|
||||
|
||||
/**
|
||||
* Adds an event subscriber.
|
||||
*
|
||||
* @param SubscriberInterface $subscriber The subscriber.
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function addSubscriber(SubscriberInterface $subscriber): void;
|
||||
|
||||
/**
|
||||
* Removes an event subscriber.
|
||||
*
|
||||
* @param SubscriberInterface $subscriber The subscriber.
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function removeSubscriber(SubscriberInterface $subscriber): void;
|
||||
}
|
||||
149
libraries/vendor/joomla/event/src/Event.php
vendored
Normal file
149
libraries/vendor/joomla/event/src/Event.php
vendored
Normal file
@ -0,0 +1,149 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
|
||||
namespace Joomla\Event;
|
||||
|
||||
use InvalidArgumentException;
|
||||
|
||||
/**
|
||||
* Default Event class.
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
class Event extends AbstractEvent
|
||||
{
|
||||
/**
|
||||
* Add an event argument, only if it is not existing.
|
||||
*
|
||||
* @param string $name The argument name.
|
||||
* @param mixed $value The argument value.
|
||||
*
|
||||
* @return $this
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
public function addArgument($name, $value)
|
||||
{
|
||||
if (!isset($this->arguments[$name])) {
|
||||
$this->arguments[$name] = $value;
|
||||
}
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Add argument to event.
|
||||
*
|
||||
* @param string $name Argument name.
|
||||
* @param mixed $value Value.
|
||||
*
|
||||
* @return $this
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
public function setArgument($name, $value)
|
||||
{
|
||||
$this->arguments[$name] = $value;
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove an event argument.
|
||||
*
|
||||
* @param string $name The argument name.
|
||||
*
|
||||
* @return mixed The old argument value or null if it is not existing.
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
public function removeArgument($name)
|
||||
{
|
||||
$return = null;
|
||||
|
||||
if (isset($this->arguments[$name])) {
|
||||
$return = $this->arguments[$name];
|
||||
unset($this->arguments[$name]);
|
||||
}
|
||||
|
||||
return $return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Clear all event arguments.
|
||||
*
|
||||
* @return array The old arguments.
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
public function clearArguments()
|
||||
{
|
||||
$arguments = $this->arguments;
|
||||
$this->arguments = [];
|
||||
|
||||
return $arguments;
|
||||
}
|
||||
|
||||
/**
|
||||
* Stop the event propagation.
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 1.0
|
||||
* @deprecated 3.0 Use stopPropagation instead
|
||||
*/
|
||||
public function stop()
|
||||
{
|
||||
trigger_deprecation(
|
||||
'joomla/event',
|
||||
'2.0.0',
|
||||
'%s() is deprecated and will be removed in 3.0, use %s::stopPropagation() instead.',
|
||||
__METHOD__,
|
||||
EventInterface::class
|
||||
);
|
||||
|
||||
$this->stopPropagation();
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the value of an event argument.
|
||||
*
|
||||
* @param string $name The argument name.
|
||||
* @param mixed $value The argument value.
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 1.0
|
||||
* @throws InvalidArgumentException If the argument name is null.
|
||||
*/
|
||||
#[\ReturnTypeWillChange]
|
||||
public function offsetSet($name, $value)
|
||||
{
|
||||
if ($name === null) {
|
||||
throw new InvalidArgumentException('The argument name cannot be null.');
|
||||
}
|
||||
|
||||
$this->setArgument($name, $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove an event argument.
|
||||
*
|
||||
* @param string $name The argument name.
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
#[\ReturnTypeWillChange]
|
||||
public function offsetUnset($name)
|
||||
{
|
||||
$this->removeArgument($name);
|
||||
}
|
||||
}
|
||||
102
libraries/vendor/joomla/event/src/EventImmutable.php
vendored
Normal file
102
libraries/vendor/joomla/event/src/EventImmutable.php
vendored
Normal file
@ -0,0 +1,102 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
|
||||
namespace Joomla\Event;
|
||||
|
||||
use BadMethodCallException;
|
||||
|
||||
/**
|
||||
* Implementation of an immutable Event.
|
||||
* An immutable event cannot be modified after instantiation :
|
||||
*
|
||||
* - its propagation cannot be stopped
|
||||
* - its arguments cannot be modified
|
||||
*
|
||||
* You may want to use this event when you want to ensure that
|
||||
* the listeners won't manipulate it.
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
final class EventImmutable extends AbstractEvent
|
||||
{
|
||||
/**
|
||||
* A flag to see if the constructor has been
|
||||
* already called.
|
||||
*
|
||||
* @var boolean
|
||||
*/
|
||||
private $constructed = false;
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param string $name The event name.
|
||||
* @param array $arguments The event arguments.
|
||||
*
|
||||
* @throws BadMethodCallException
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
public function __construct($name, array $arguments = [])
|
||||
{
|
||||
if ($this->constructed) {
|
||||
throw new BadMethodCallException(
|
||||
sprintf('Cannot reconstruct the EventImmutable %s.', $this->name)
|
||||
);
|
||||
}
|
||||
|
||||
$this->constructed = true;
|
||||
|
||||
parent::__construct($name, $arguments);
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the value of an event argument.
|
||||
*
|
||||
* @param string $name The argument name.
|
||||
* @param mixed $value The argument value.
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 1.0
|
||||
* @throws BadMethodCallException
|
||||
*/
|
||||
public function offsetSet($name, $value)
|
||||
{
|
||||
throw new BadMethodCallException(
|
||||
sprintf(
|
||||
'Cannot set the argument %s of the immutable event %s.',
|
||||
$name,
|
||||
$this->name
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove an event argument.
|
||||
*
|
||||
* @param string $name The argument name.
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @throws BadMethodCallException
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
public function offsetUnset($name)
|
||||
{
|
||||
throw new BadMethodCallException(
|
||||
sprintf(
|
||||
'Cannot remove the argument %s of the immutable event %s.',
|
||||
$name,
|
||||
$this->name
|
||||
)
|
||||
);
|
||||
}
|
||||
}
|
||||
58
libraries/vendor/joomla/event/src/EventInterface.php
vendored
Normal file
58
libraries/vendor/joomla/event/src/EventInterface.php
vendored
Normal file
@ -0,0 +1,58 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
|
||||
namespace Joomla\Event;
|
||||
|
||||
/**
|
||||
* Interface for events.
|
||||
* An event has a name and its propagation can be stopped.
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
interface EventInterface
|
||||
{
|
||||
/**
|
||||
* 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.
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function getArgument($name, $default = null);
|
||||
|
||||
/**
|
||||
* Get the event name.
|
||||
*
|
||||
* @return string The event name.
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
public function getName();
|
||||
|
||||
/**
|
||||
* Tell if the event propagation is stopped.
|
||||
*
|
||||
* @return boolean True if stopped, false otherwise.
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
public function isStopped();
|
||||
|
||||
/**
|
||||
* Stops the propagation of the event to further event listeners.
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public function stopPropagation(): void;
|
||||
}
|
||||
126
libraries/vendor/joomla/event/src/LazyServiceEventListener.php
vendored
Normal file
126
libraries/vendor/joomla/event/src/LazyServiceEventListener.php
vendored
Normal file
@ -0,0 +1,126 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
|
||||
namespace Joomla\Event;
|
||||
|
||||
use Psr\Container\ContainerInterface;
|
||||
|
||||
/**
|
||||
* Decorator for an event listener to be pulled from the service container.
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
final class LazyServiceEventListener
|
||||
{
|
||||
/**
|
||||
* The service container to load the service from
|
||||
*
|
||||
* @var ContainerInterface
|
||||
* @since 2.0.0
|
||||
*/
|
||||
private $container;
|
||||
|
||||
/**
|
||||
* The ID of the service from the container to be used
|
||||
*
|
||||
* @var string
|
||||
* @since 2.0.0
|
||||
*/
|
||||
private $serviceId;
|
||||
|
||||
/**
|
||||
* The method from the service to be called
|
||||
*
|
||||
* @var string
|
||||
* @since 2.0.0
|
||||
*/
|
||||
private $method;
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param ContainerInterface $container The service container to load the service from when it shall be executed
|
||||
* @param string $serviceId The ID of the service from the container to be used
|
||||
* @param string $method The method from the service to be called if necessary. If left empty, the service must be a callable;
|
||||
* (i.e. have an `__invoke()` method on a class)
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @throws \InvalidArgumentException if the service ID is empty
|
||||
*/
|
||||
public function __construct(ContainerInterface $container, string $serviceId, string $method = '')
|
||||
{
|
||||
if (empty($serviceId)) {
|
||||
throw new \InvalidArgumentException(
|
||||
sprintf(
|
||||
'The $serviceId parameter cannot be empty in %s',
|
||||
self::class
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
$this->container = $container;
|
||||
$this->serviceId = $serviceId;
|
||||
$this->method = $method;
|
||||
}
|
||||
|
||||
/**
|
||||
* Load a service from the container to listen to an event.
|
||||
*
|
||||
* @param EventInterface $event The event to process
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @throws \InvalidArgumentException if the constructor's $method parameter is empty when not executing a callable service
|
||||
* @throws \RuntimeException if the service cannot be executed
|
||||
*/
|
||||
public function __invoke(EventInterface $event): void
|
||||
{
|
||||
if (!$this->container->has($this->serviceId)) {
|
||||
throw new \RuntimeException(
|
||||
sprintf(
|
||||
'The "%s" service has not been registered to the service container',
|
||||
$this->serviceId
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
$service = $this->container->get($this->serviceId);
|
||||
|
||||
// If the service is callable on its own, just execute it
|
||||
if (\is_callable($service)) {
|
||||
\call_user_func($service, $event);
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
if (empty($this->method)) {
|
||||
throw new \InvalidArgumentException(
|
||||
sprintf(
|
||||
'The $method argument is required when creating a "%s" to call a method from the "%s" service.',
|
||||
self::class,
|
||||
$this->serviceId
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
if (!method_exists($service, $this->method)) {
|
||||
throw new \RuntimeException(
|
||||
sprintf(
|
||||
'The "%s" method does not exist on "%s" (from service "%s")',
|
||||
$this->method,
|
||||
\get_class($service),
|
||||
$this->serviceId
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
\call_user_func([$service, $this->method], $event);
|
||||
}
|
||||
}
|
||||
155
libraries/vendor/joomla/event/src/ListenersPriorityQueue.php
vendored
Normal file
155
libraries/vendor/joomla/event/src/ListenersPriorityQueue.php
vendored
Normal file
@ -0,0 +1,155 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
|
||||
namespace Joomla\Event;
|
||||
|
||||
/**
|
||||
* A class containing an inner listeners priority queue that can be iterated multiple times.
|
||||
*
|
||||
* @since 1.0
|
||||
* @internal
|
||||
*/
|
||||
final class ListenersPriorityQueue implements \IteratorAggregate, \Countable
|
||||
{
|
||||
/**
|
||||
* The listeners for an event.
|
||||
*
|
||||
* @var array
|
||||
* @since 2.0.0
|
||||
*/
|
||||
private $listeners = [];
|
||||
|
||||
/**
|
||||
* 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
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
public function add(callable $callback, int $priority): self
|
||||
{
|
||||
$this->listeners[$priority][] = $callback;
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove a listener from the queue.
|
||||
*
|
||||
* @param callable $callback A callable function acting as an event listener.
|
||||
*
|
||||
* @return $this
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
public function remove(callable $callback): self
|
||||
{
|
||||
foreach ($this->listeners as $priority => $listeners) {
|
||||
if (($key = array_search($callback, $listeners, true)) !== false) {
|
||||
unset($this->listeners[$priority][$key]);
|
||||
}
|
||||
}
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* 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.
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
public function has(callable $callback): bool
|
||||
{
|
||||
foreach ($this->listeners as $priority => $listeners) {
|
||||
if (($key = array_search($callback, $listeners, true)) !== false) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* 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
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
public function getPriority(callable $callback, $default = null)
|
||||
{
|
||||
foreach ($this->listeners as $priority => $listeners) {
|
||||
if (($key = array_search($callback, $listeners, true)) !== false) {
|
||||
return $priority;
|
||||
}
|
||||
}
|
||||
|
||||
return $default;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get all listeners contained in this queue, sorted according to their priority.
|
||||
*
|
||||
* @return callable[] An array of listeners.
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
public function getAll(): array
|
||||
{
|
||||
if (empty($this->listeners)) {
|
||||
return [];
|
||||
}
|
||||
|
||||
krsort($this->listeners);
|
||||
|
||||
return \call_user_func_array('array_merge', $this->listeners);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the priority queue.
|
||||
*
|
||||
* @return \ArrayIterator
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
#[\ReturnTypeWillChange]
|
||||
public function getIterator()
|
||||
{
|
||||
return new \ArrayIterator($this->getAll());
|
||||
}
|
||||
|
||||
/**
|
||||
* Count the number of listeners in the queue.
|
||||
*
|
||||
* @return integer The number of listeners in the queue.
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
#[\ReturnTypeWillChange]
|
||||
public function count()
|
||||
{
|
||||
$count = 0;
|
||||
|
||||
foreach ($this->listeners as $priority) {
|
||||
$count += \count($priority);
|
||||
}
|
||||
|
||||
return $count;
|
||||
}
|
||||
}
|
||||
83
libraries/vendor/joomla/event/src/Priority.php
vendored
Normal file
83
libraries/vendor/joomla/event/src/Priority.php
vendored
Normal file
@ -0,0 +1,83 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
|
||||
namespace Joomla\Event;
|
||||
|
||||
/**
|
||||
* An enumeration of priorities for event listeners that you are encouraged to use when adding them in the Dispatcher.
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
final class Priority
|
||||
{
|
||||
/**
|
||||
* Indicates the event listener should have a minimum priority.
|
||||
*
|
||||
* @var integer
|
||||
* @since 1.0
|
||||
*/
|
||||
public const MIN = -3;
|
||||
|
||||
/**
|
||||
* Indicates the event listener should have a low priority.
|
||||
*
|
||||
* @var integer
|
||||
* @since 1.0
|
||||
*/
|
||||
public const LOW = -2;
|
||||
|
||||
/**
|
||||
* Indicates the event listener should have a below normal priority.
|
||||
*
|
||||
* @var integer
|
||||
* @since 1.0
|
||||
*/
|
||||
public const BELOW_NORMAL = -1;
|
||||
|
||||
/**
|
||||
* Indicates the event listener should have a normal priority. This is the default priority.
|
||||
*
|
||||
* @var integer
|
||||
* @since 1.0
|
||||
*/
|
||||
public const NORMAL = 0;
|
||||
|
||||
/**
|
||||
* Indicates the event listener should have a above normal priority.
|
||||
*
|
||||
* @var integer
|
||||
* @since 1.0
|
||||
*/
|
||||
public const ABOVE_NORMAL = 1;
|
||||
|
||||
/**
|
||||
* Indicates the event listener should have a high priority.
|
||||
*
|
||||
* @var integer
|
||||
* @since 1.0
|
||||
*/
|
||||
public const HIGH = 2;
|
||||
|
||||
/**
|
||||
* Indicates the event listener should have a maximum priority.
|
||||
*
|
||||
* @var integer
|
||||
* @since 1.0
|
||||
*/
|
||||
public const MAX = 3;
|
||||
|
||||
/**
|
||||
* Disallow instantiation of this class
|
||||
*
|
||||
* @since 1.0
|
||||
*/
|
||||
private function __construct()
|
||||
{
|
||||
}
|
||||
}
|
||||
37
libraries/vendor/joomla/event/src/SubscriberInterface.php
vendored
Normal file
37
libraries/vendor/joomla/event/src/SubscriberInterface.php
vendored
Normal file
@ -0,0 +1,37 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
|
||||
namespace Joomla\Event;
|
||||
|
||||
/**
|
||||
* Interface for event subscribers.
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
interface SubscriberInterface
|
||||
{
|
||||
/**
|
||||
* Returns an array of events this subscriber will listen to.
|
||||
*
|
||||
* The array keys are event names and the value can be:
|
||||
*
|
||||
* - The method name to call (priority defaults to 0)
|
||||
* - An array composed of the method name to call and the priority
|
||||
*
|
||||
* For instance:
|
||||
*
|
||||
* * array('eventName' => 'methodName')
|
||||
* * array('eventName' => array('methodName', $priority))
|
||||
*
|
||||
* @return array
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public static function getSubscribedEvents(): array;
|
||||
}
|
||||
Reference in New Issue
Block a user