77 lines
1.8 KiB
PHP
77 lines
1.8 KiB
PHP
<?php
|
|
|
|
/*
|
|
Base Event class in Swift Mailer.
|
|
|
|
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 3 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, see <http://www.gnu.org/licenses/>.
|
|
|
|
*/
|
|
|
|
|
|
//@require 'Swift/Events/Event.php';
|
|
|
|
/**
|
|
* A base Event which all Event classes inherit from.
|
|
*
|
|
* @package Swift
|
|
* @subpackage Events
|
|
* @author Chris Corbyn
|
|
*/
|
|
class Swift_Events_EventObject implements Swift_Events_Event
|
|
{
|
|
|
|
/** The source of this Event */
|
|
private $_source;
|
|
|
|
/** The state of this Event (should it bubble up the stack?) */
|
|
private $_bubbleCancelled = false;
|
|
|
|
/**
|
|
* Create a new EventObject originating at $source.
|
|
* @param object $source
|
|
*/
|
|
public function __construct($source)
|
|
{
|
|
$this->_source = $source;
|
|
}
|
|
|
|
/**
|
|
* Get the source object of this event.
|
|
* @return object
|
|
*/
|
|
public function getSource()
|
|
{
|
|
return $this->_source;
|
|
}
|
|
|
|
/**
|
|
* Prevent this Event from bubbling any further up the stack.
|
|
* @param boolean $cancel, optional
|
|
*/
|
|
public function cancelBubble($cancel = true)
|
|
{
|
|
$this->_bubbleCancelled = $cancel;
|
|
}
|
|
|
|
/**
|
|
* Returns true if this Event will not bubble any further up the stack.
|
|
* @return boolean
|
|
*/
|
|
public function bubbleCancelled()
|
|
{
|
|
return $this->_bubbleCancelled;
|
|
}
|
|
|
|
}
|