DelayedEmailQueueTable.php

Go to the documentation of this file.

<?php
 
namespace Elgg\Database;
 
use Elgg\Database;
use Elgg\Email\DelayedQueue\DatabaseRecord;
use Elgg\Traits\TimeUsing;
 
class DelayedEmailQueueTable {
    
    use TimeUsing;
    
    public const TABLE_NAME = 'delayed_email_queue';
    
    public function __construct(protected Database $db) {
    }
    
    public function queueEmail(int $recipient_guid, string $delivery_interval, $item): bool {
        $insert = Insert::intoTable(self::TABLE_NAME);
        $insert->values([
            'recipient_guid' => $insert->param($recipient_guid, ELGG_VALUE_GUID),
            'delivery_interval' => $insert->param($delivery_interval, ELGG_VALUE_STRING),
            'data' => $insert->param(serialize($item), ELGG_VALUE_STRING),
            'timestamp' => $insert->param($this->getCurrentTime()->getTimestamp(), ELGG_VALUE_TIMESTAMP),
        ]);
        
        return $this->db->insertData($insert) !== 0;
    }
    
    public function getRow(int $id): ?DatabaseRecord {
        $select = Select::fromTable(self::TABLE_NAME);
        $select->select('*')
            ->where($select->compare('id', '=', $id, ELGG_VALUE_ID));
        
        return $this->db->getDataRow($select, [$this, 'rowToRecord']);
    }
    
    public function getRecipientRows(int $recipient_guid, string $delivery_interval, ?int $timestamp = null, int $max_results = 0): array {
        $select = Select::fromTable(self::TABLE_NAME);
        $select->select('*')
            ->where($select->compare('recipient_guid', '=', $recipient_guid, ELGG_VALUE_GUID))
            ->andWhere($select->compare('delivery_interval', '=', $delivery_interval, ELGG_VALUE_STRING))
            ->andWhere($select->compare('timestamp', '<', $timestamp ?? $this->getCurrentTime()->getTimestamp(), ELGG_VALUE_TIMESTAMP))
            ->orderBy('timestamp', 'ASC')
            ->addOrderBy('id', 'ASC');
        
        if ($max_results > 0) {
            $select->setMaxResults($max_results);
        }
        
        return $this->db->getData($select, [$this, 'rowToRecord']);
    }
    
    public function getNextRecipientGUID(string $delivery_interval, ?int $timestamp = null): ?int {
        $select = Select::fromTable(self::TABLE_NAME);
        $select->select('recipient_guid')
            ->where($select->compare('delivery_interval', '=', $delivery_interval, ELGG_VALUE_STRING))
            ->andWhere($select->compare('timestamp', '<', $timestamp ?? $this->getCurrentTime()->getTimestamp()))
            ->orderBy('timestamp', 'ASC')
            ->addOrderBy('id', 'ASC')
            ->setMaxResults(1);
        
        $row = $this->db->getDataRow($select);
        if (empty($row)) {
            return null;
        }
        
        return (int) $row->recipient_guid;
    }
    
    public function deleteRow(int $id): int {
        $delete = Delete::fromTable(self::TABLE_NAME);
        $delete->where($delete->compare('id', '=', $id, ELGG_VALUE_ID));
        
        return $this->db->deleteData($delete);
    }
    
    public function deleteRecipientRows(int $recipient_guid, string $delivery_interval, ?int $timestamp = null, int $max_id = 0): int {
        $delete = Delete::fromTable(self::TABLE_NAME);
        $delete->where($delete->compare('recipient_guid', '=', $recipient_guid, ELGG_VALUE_GUID))
            ->andWhere($delete->compare('delivery_interval', '=', $delivery_interval, ELGG_VALUE_STRING))
            ->andWhere($delete->compare('timestamp', '<', $timestamp ?? $this->getCurrentTime()->getTimestamp(), ELGG_VALUE_INTEGER))
            ->orderBy('timestamp', 'ASC')
            ->addOrderBy('id', 'ASC');
        
        if ($max_id > 0) {
            $delete->andWhere($delete->compare('id', '<=', $max_id, ELGG_VALUE_ID));
        }
        
        return $this->db->deleteData($delete);
    }
    
    public function deleteAllRecipientRows(int $recipient_guid): int {
        $delete = Delete::fromTable(self::TABLE_NAME);
        $delete->where($delete->compare('recipient_guid', '=', $recipient_guid, ELGG_VALUE_GUID));
        
        return $this->db->deleteData($delete);
    }
    
    public function updateRecipientInterval(int $recipient_guid, string $delivery_interval): bool {
        $update = Update::table(self::TABLE_NAME);
        $update->set('delivery_interval', $update->param($delivery_interval, ELGG_VALUE_STRING))
            ->where($update->compare('recipient_guid', '=', $recipient_guid, ELGG_VALUE_GUID));
        
        return $this->db->updateData($update);
    }
    
    public function rowToRecord(\stdClass $row): DatabaseRecord {
        return new DatabaseRecord($row);
    }
}