AdminNotices.php

Go to the documentation of this file.

<?php

namespace Elgg\Database;

class AdminNotices {
    
    public function add($id, $message) {
        if (!$id || !$message) {
            return false;
        }
        
        if (elgg_admin_notice_exists($id)) {
            return false;
        }

        // need to handle when no one is logged in
        $old_ia = _elgg_services()->session->setIgnoreAccess(true);

        $admin_notice = new \ElggObject();
        $admin_notice->subtype = 'admin_notice';
        // admins can see ACCESS_PRIVATE but no one else can.
        $admin_notice->access_id = ACCESS_PRIVATE;
        $admin_notice->admin_notice_id = $id;
        $admin_notice->description = $message;

        $result = $admin_notice->save();

        _elgg_services()->session->setIgnoreAccess($old_ia);

        if (!$result) {
            return false;
        }

        return $admin_notice;
    }
    
    public function delete($id = '') {
        $result = true;
        
        $notices = $this->find([
            'metadata_name' => 'admin_notice_id',
            'metadata_value' => $id,
            'limit' => false,
            'batch' => true,
            'batch_inc_offset' => false,
        ]);

        $ia = _elgg_services()->session->setIgnoreAccess(true);

        // in case a bad plugin adds many, let it remove them all at once.
        foreach ($notices as $notice) {
            $result = ($result && $notice->delete());
        }

        _elgg_services()->session->setIgnoreAccess($ia);

        return $result;
    }
    
    public function find(array $options = []) {
        $options = array_merge($options, [
            'type' => 'object',
            'subtype' => 'admin_notice',
        ]);

        return Entities::find($options);
    }
    
    public function exists($id) {
        $old_ia = _elgg_services()->session->setIgnoreAccess(true);
        $notice = elgg_get_entities([
            'type' => 'object',
            'subtype' => 'admin_notice',
            'metadata_name_value_pair' => ['name' => 'admin_notice_id', 'value' => $id],
            'count' => true,
        ]);
        _elgg_services()->session->setIgnoreAccess($old_ia);
    
        return ($notice) ? true : false;
    }
}