AdminNotices.php

Go to the documentation of this file.

<?php
namespace Elgg\Database;

class AdminNotices {
    function add($id, $message) {
        if ($id && $message) {
            if (elgg_admin_notice_exists($id)) {
                return false;
            }
    
            // need to handle when no one is logged in
            $old_ia = elgg_set_ignore_access(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_set_ignore_access($old_ia);
    
            return (bool)$result;
        }
    
        return false;
    }
    
    function delete($id) {
        if (!$id) {
            return false;
        }
        $result = true;
        $notices = elgg_get_entities_from_metadata(array(
            'metadata_name' => 'admin_notice_id',
            'metadata_value' => $id,
            'distinct' => false,
        ));
    
        if ($notices) {
            // in case a bad plugin adds many, let it remove them all at once.
            foreach ($notices as $notice) {
                $result = ($result && $notice->delete());
            }
            return $result;
        }
        return false;
    }
    
    function find($limit = 10) {
        return elgg_get_entities_from_metadata(array(
            'type' => 'object',
            'subtype' => 'admin_notice',
            'limit' => $limit,
            'distinct' => false,
        ));
    }
    
    function exists($id) {
        $old_ia = elgg_set_ignore_access(true);
        $notice = elgg_get_entities_from_metadata(array(
            'type' => 'object',
            'subtype' => 'admin_notice',
            'metadata_name_value_pair' => array('name' => 'admin_notice_id', 'value' => $id),
            'distinct' => false,
        ));
        elgg_set_ignore_access($old_ia);
    
        return ($notice) ? true : false;
    }
}