- md5
- 3a39bb1f7ff5d8e24ec0c6ab67061749
- sha1
- 7137c686262aaf978c1424602e13496b76c69161
- sha256
- b20943993cbf2a0410cee7c9cb73ac2c85c32d45055bb079640bb452f41f519e
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161
<?php
/**
* Joomla! Content Management System
*
* @copyright (C) 2023 Open Source Matters, Inc. <https://www.joomla.org>
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
namespace Joomla\CMS\Event\Installer;
use Joomla\CMS\Event\AbstractImmutableEvent;
use Joomla\CMS\Event\ReshapeArgumentsAware;
// phpcs:disable PSR1.Files.SideEffects
\defined('_JEXEC') or die;
// phpcs:enable PSR1.Files.SideEffects
/**
* Class for Installer events
*
* @since 5.0.0
*/
class BeforePackageDownloadEvent extends AbstractImmutableEvent
{
use ReshapeArgumentsAware;
/**
* The argument names, in order expected by legacy plugins.
*
* @var array
*
* @since 5.0.0
* @deprecated 5.0 will be removed in 7.0
*/
protected $legacyArgumentsOrder = ['url', 'headers'];
/**
* Constructor.
*
* @param string $name The event name.
* @param array $arguments The event arguments.
*
* @throws \BadMethodCallException
*
* @since 5.0.0
*/
public function __construct($name, array $arguments = [])
{
// Reshape the arguments array to preserve b/c with legacy listeners
// Do not override existing $arguments in place, or it will break references!
if ($this->legacyArgumentsOrder) {
parent::__construct($name, $this->reshapeArguments($arguments, $this->legacyArgumentsOrder));
} else {
parent::__construct($name, $arguments);
}
if (!\array_key_exists('url', $this->arguments)) {
throw new \BadMethodCallException("Argument 'url' of event {$name} is required but has not been provided");
}
if (!\array_key_exists('headers', $this->arguments)) {
throw new \BadMethodCallException("Argument 'headers' of event {$name} is required but has not been provided");
}
// For backward compatibility make sure the value is referenced
// @todo: Remove in Joomla 7
// @deprecated: Passing argument by reference is deprecated, and will not work in Joomla 7
if (key($arguments) === 0) {
$this->arguments['url'] = &$arguments[0];
$this->arguments['headers'] = &$arguments[1];
} elseif (\array_key_exists('url', $arguments)) {
$this->arguments['url'] = &$arguments['url'];
$this->arguments['headers'] = &$arguments['headers'];
}
}
/**
* Setter for the url argument.
*
* @param string $value The value to set
*
* @return string
*
* @since 5.0.0
*/
protected function onSetUrl(string $value): string
{
return $value;
}
/**
* Setter for the headers argument.
*
* @param array $value The value to set
*
* @return array
*
* @since 5.0.0
*/
protected function onSetHeaders(array $value): array
{
return $value;
}
/**
* Getter for the url.
*
* @return string
*
* @since 5.0.0
*/
public function getUrl(): string
{
return $this->arguments['url'];
}
/**
* Getter for the headers.
*
* @return array
*
* @since 5.0.0
*/
public function getHeaders(): array
{
return $this->arguments['headers'];
}
/**
* Update the url.
*
* @param string $value The value to set
*
* @return static
*
* @since 5.0.0
*/
public function updateUrl(string $value): static
{
$this->arguments['url'] = $this->onSetUrl($value);
return $this;
}
/**
* Update the headers.
*
* @param array $value The value to set
*
* @return static
*
* @since 5.0.0
*/
public function updateHeaders(array $value): static
{
$this->arguments['headers'] = $this->onSetHeaders($value);
return $this;
}
}
The same content is in 73 releases, Joomla 5.4.0-beta1 to 6.2.1-rc1. See them all, or every version of this file.