Server : ApacheSystem : Linux host.digitalbabaji.in 4.18.0-513.11.1.el8_9.x86_64 #1 SMP Wed Jan 17 02:00:40 EST 2024 x86_64 User : addictionfreeind ( 1003) PHP Version : 7.2.34 Disable Function : exec,passthru,shell_exec,system Directory : /home/addictionfreeind/www/vendor/cakephp/cakephp/src/Event/ |
Upload File : |
<?php
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 2.1.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Event;
class Event implements EventInterface
{
/**
* Name of the event
*
* @var string
*/
protected $_name;
/**
* The object this event applies to (usually the same object that generates the event)
*
* @var object|null
*/
protected $_subject;
/**
* Custom data for the method that receives the event
*
* @var array
*/
protected $_data;
/**
* Property used to retain the result value of the event listeners
*
* Note: Public access is deprecated, use setResult() and getResult() instead.
*
* @var mixed
*/
public $result;
/**
* Flags an event as stopped or not, default is false
*
* @var bool
*/
protected $_stopped = false;
/**
* Constructor
*
* ### Examples of usage:
*
* ```
* $event = new Event('Order.afterBuy', $this, ['buyer' => $userData]);
* $event = new Event('User.afterRegister', $UserModel);
* ```
*
* @param string $name Name of the event
* @param object|null $subject the object that this event applies to (usually the object that is generating the event)
* @param array|\ArrayAccess|null $data any value you wish to be transported with this event to it can be read by listeners
*/
public function __construct($name, $subject = null, $data = null)
{
$this->_name = $name;
$this->_subject = $subject;
$this->_data = (array)$data;
}
/**
* Provides read-only access for the name and subject properties.
*
* @param string $attribute Attribute name.
* @return mixed
* @deprecated 3.4.0 Public properties will be removed.
*/
public function __get($attribute)
{
if (!in_array($attribute, ['name', 'subject', 'data', 'result'])) {
return $this->{$attribute};
}
$method = 'get' . ucfirst($attribute);
deprecationWarning(
"Event::\${$attribute} is deprecated. " .
"Use Event::{$method}() instead."
);
if ($attribute === 'name' || $attribute === 'subject') {
return $this->{$attribute}();
}
if ($attribute === 'data') {
return $this->_data;
}
if ($attribute === 'result') {
return $this->result;
}
}
/**
* Provides backward compatibility for write access to data and result properties.
*
* @param string $attribute Attribute name.
* @param mixed $value The value to set.
* @return void
* @deprecated 3.4.0 Public properties will be removed.
*/
public function __set($attribute, $value)
{
$method = 'set' . ucfirst($attribute);
deprecationWarning(
"Event::\${$attribute} is deprecated. " .
"Use Event::{$method}() instead."
);
if ($attribute === 'data') {
$this->_data = (array)$value;
}
if ($attribute === 'result') {
$this->result = $value;
}
}
/**
* Returns the name of this event. This is usually used as the event identifier
*
* @return string
* @deprecated 3.4.0 use getName() instead.
*/
public function name()
{
deprecationWarning('Event::name() is deprecated. Use Event::getName() instead.');
return $this->_name;
}
/**
* Returns the name of this event. This is usually used as the event identifier
*
* @return string
*/
public function getName()
{
return $this->_name;
}
/**
* Returns the subject of this event
*
* @return object
* @deprecated 3.4.0 use getSubject() instead.
*/
public function subject()
{
deprecationWarning('Event::subject() is deprecated. Use Event::getSubject() instead.');
return $this->_subject;
}
/**
* Returns the subject of this event
*
* @return object
*/
public function getSubject()
{
return $this->_subject;
}
/**
* Stops the event from being used anymore
*
* @return void
*/
public function stopPropagation()
{
$this->_stopped = true;
}
/**
* Check if the event is stopped
*
* @return bool True if the event is stopped
*/
public function isStopped()
{
return $this->_stopped;
}
/**
* The result value of the event listeners
*
* @return mixed
* @deprecated 3.4.0 use getResult() instead.
*/
public function result()
{
deprecationWarning('Event::result() is deprecated. Use Event::getResult() instead.');
return $this->result;
}
/**
* The result value of the event listeners
*
* @return mixed
*/
public function getResult()
{
return $this->result;
}
/**
* Listeners can attach a result value to the event.
*
* @param mixed $value The value to set.
* @return $this
*/
public function setResult($value = null)
{
$this->result = $value;
return $this;
}
/**
* Access the event data/payload.
*
* @param string|null $key The data payload element to return, or null to return all data.
* @return array|mixed|null The data payload if $key is null, or the data value for the given $key. If the $key does not
* exist a null value is returned.
* @deprecated 3.4.0 use getData() instead.
*/
public function data($key = null)
{
return $this->getData($key);
}
/**
* Access the event data/payload.
*
* @param string|null $key The data payload element to return, or null to return all data.
* @return array|mixed|null The data payload if $key is null, or the data value for the given $key. If the $key does not
* exist a null value is returned.
*/
public function getData($key = null)
{
if ($key !== null) {
return isset($this->_data[$key]) ? $this->_data[$key] : null;
}
return (array)$this->_data;
}
/**
* Assigns a value to the data/payload of this event.
*
* @param array|string $key An array will replace all payload data, and a key will set just that array item.
* @param mixed $value The value to set.
* @return $this
*/
public function setData($key, $value = null)
{
if (is_array($key)) {
$this->_data = $key;
} else {
$this->_data[$key] = $value;
}
return $this;
}
}