Event.php

Go to the documentation of this file.

<?php
namespace Elgg\Notifications;

use ElggData;
use ElggEntity;
use InvalidArgumentException;
use stdClass;

class Event implements NotificationEvent {

    use EventSerialization;
    
    /* @var string The name of the action/event */
    protected $action;

    /* @var string Action's object */
    protected $object;

    /* @var ElggEntity User who triggered the event */
    protected $actor;

    public function __construct(ElggData $object, $action, ElggEntity $actor = null) {
        if (get_class($this) == Event::class || get_class($this) == Elgg_Notifications_Event::class) {
            _elgg_services()->deprecation->sendNotice(__CLASS__ . ' is deprecated. '
                    . 'Use ' . SubscriptionNotificationEvent::class . ' instead', '2.3');
        }
        if (!$object instanceof ElggData) {
            throw new InvalidArgumentException(__METHOD__ . ' expects an object as an instance of ' . ElggData::class);
        }
        if (!$action) {
            throw new InvalidArgumentException(__METHOD__ . ' expects a valid action name');
        }
        
        $this->object = $object;

        $this->actor = $actor;
        if (!isset($actor)) {
            $this->actor = _elgg_services()->session->getLoggedInUser();
        }

        $this->action = $action;
    }

    public function getActor() {
        return $this->actor;
    }

    public function getActorGUID() {
        return $this->actor ? $this->actor->guid : 0;
    }

    public function getObject() {
        return $this->object;
    }

    public function getAction() {
        return $this->action;
    }

    public function getDescription() {
        return implode(':', [
            $this->action,
            $this->object->getType(),
            $this->object->getSubtype(),
        ]);
    }

    public function toObject() {
        $obj = new stdClass();
        $vars = get_object_vars($this);
        foreach ($vars as $key => $value) {
            if (is_object($value) && is_callable([$value, 'toObject'])) {
                $obj->$key = $value->toObject();
            } else {
                $obj->$key = $value;
            }
        }
        return $obj;
    }
}

class Elgg_Notifications_Event extends Event {}