Event.php

Go to the documentation of this file.

<?php
namespace Elgg;

use Elgg\Di\PublicContainer;

class Event {
    
    public function __construct(
        protected PublicContainer $dic,
        protected string $name,
        protected string $type,
        protected $value = null,
        protected $params = []
    ) {
    }
    
    public function getName(): string {
        return $this->name;
    }

    public function getType(): string {
        return $this->type;
    }

    public function getObject() {
        return elgg_extract('object', $this->params);
    }
    
    public function getValue() {
        return $this->value;
    }
    
    public function setValue($value): void {
        $this->value = $value;
    }
    
    public function getParams() {
        return $this->params;
    }
    
    public function getParam(string $key, $default = null) {
        if (!is_array($this->params)) {
            return $default;
        }
        
        return elgg_extract($key, $this->params, $default);
    }
    
    public function getEntityParam(): ?\ElggEntity {
        if (isset($this->params['entity']) && $this->params['entity'] instanceof \ElggEntity) {
            return $this->params['entity'];
        }
        
        return null;
    }
    
    public function getUserParam(): ?\ElggUser {
        if (isset($this->params['user']) && $this->params['user'] instanceof \ElggUser) {
            return $this->params['user'];
        }
        
        return null;
    }

    public function elgg(): PublicContainer {
        return $this->dic;
    }
    
    public function getSequenceID(): ?string {
        return elgg_extract('_elgg_sequence_id', $this->params);
    }
}