Maslosoft Signals API
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 <?php
/**
* This software package is licensed under `AGPL, Commercial` license[s].
*
* @package maslosoft/signals
* @license AGPL, Commercial
*
* @copyright Copyright (c) Peter Maselkowski <pmaselkowski@gmail.com>
* @link https://maslosoft.com/signals/
*/
namespace Maslosoft\Signals\Interfaces;
/**
* This interface is meant to be used when defining signals.
* Implement this to automatically pass calling object to your signal.
* @author Piotr Maselkowski <pmaselkowski at gmail.com>
*/
interface SlotAwareInterface
{
/**
* Set slot to be available in signal.
*
* Example implementation:
* ```php
*
* ...
* // Owner of this signal
* public $owner = null;
*
* public function setSlot($slot)
* {
* if($slot instance of MyCompatibleInterface)
* {
* $this->owner = $slot;
* // So something with owner
* }
* }
* ```
* @param object $slot
*/
public function setSlot($slot);
}
API documentation generated by ApiGen