AdminNotices.php

Go to the documentation of this file.

<?php

namespace Elgg\Database;

class AdminNotices {
    
    public function add(string $id, string $message): ?\ElggAdminNotice {
        if (!$id || !$message) {
            return null;
        }
        
        if (elgg_admin_notice_exists($id)) {
            return null;
        }

        $admin_notice = new \ElggAdminNotice();
        $admin_notice->admin_notice_id = $id;
        $admin_notice->description = $message;

        $result = elgg_call(ELGG_IGNORE_ACCESS, function() use($admin_notice) {
            // need to handle when no one is logged in
            return $admin_notice->save();
        });
        
        return $result ? $admin_notice : null;
    }
    
    public function delete(string $id = ''): bool {
        return elgg_call(ELGG_IGNORE_ACCESS, function() use ($id) {
            $result = true;
            
            $notices = $this->find([
                'metadata_name' => 'admin_notice_id',
                'metadata_value' => $id,
                'limit' => false,
                'batch' => true,
                'batch_inc_offset' => false,
            ]);
            
            // in case a bad plugin adds many, let it remove them all at once.
            foreach ($notices as $notice) {
                $result = ($result && $notice->delete());
            }
            
            return $result;
        });
    }
    
    public function find(array $options = []) {
        $options = array_merge($options, [
            'type' => 'object',
            'subtype' => 'admin_notice',
        ]);

        return Entities::find($options);
    }
    
    public function exists(string $id): bool {
        return elgg_call(ELGG_IGNORE_ACCESS, function() use ($id) {
            return (bool) elgg_count_entities([
                'type' => 'object',
                'subtype' => 'admin_notice',
                'metadata_name_value_pair' => ['name' => 'admin_notice_id', 'value' => $id],
            ]);
        });
    }
}