<?php

// {{{ License
// This file is part of GNU social - https://www.gnu.org/software/soci
//
// GNU social is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// GNU social is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with GNU social.  If not, see <http://www.gnu.org/licenses/>.
// }}}

namespace App\Entity;

use DateTimeInterface;

/**
 * Entity for a Queue Item
 *
 * @category  DB
 * @package   GNUsocial
 *
 * @author    Zach Copley <zach@status.net>
 * @copyright 2010 StatusNet Inc.
 * @author    Mikael Nordfeldth <mmn@hethane.se>
 * @copyright 2009-2014 Free Software Foundation, Inc http://www.fsf.org
 * @author    Hugo Sales <hugo@fc.up.pt>
 * @copyright 2020 Free Software Foundation, Inc http://www.fsf.org
 * @license   https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
 */
class QueueItem
{
    // {{{ Autocode

    private int $id;
    private $frame;
    private string $transport;
    private DateTimeInterface $created;
    private ?DateTimeInterface $claimed;

    public function setId(int $id): self
    {
        $this->id = $id;
        return $this;
    }
    public function getId(): int
    {
        return $this->id;
    }

    public function setFrame($frame): self
    {
        $this->frame = $frame;
        return $this;
    }
    public function getFrame()
    {
        return $this->frame;
    }

    public function setTransport(string $transport): self
    {
        $this->transport = $transport;
        return $this;
    }
    public function getTransport(): string
    {
        return $this->transport;
    }

    public function setCreated(DateTimeInterface $created): self
    {
        $this->created = $created;
        return $this;
    }
    public function getCreated(): DateTimeInterface
    {
        return $this->created;
    }

    public function setClaimed(?DateTimeInterface $claimed): self
    {
        $this->claimed = $claimed;
        return $this;
    }
    public function getClaimed(): ?DateTimeInterface
    {
        return $this->claimed;
    }

    // }}} Autocode

    public static function schemaDef(): array
    {
        return [
            'name'   => 'queue_item',
            'fields' => [
                'id'        => ['type' => 'serial', 'not null' => true, 'description' => 'unique identifier'],
                'frame'     => ['type' => 'blob', 'not null' => true, 'description' => 'data: object reference or opaque string'],
                'transport' => ['type' => 'varchar', 'length' => 32, 'not null' => true, 'description' => 'queue for what? "email", "xmpp", "sms", "irc", ...'],
                'created'   => ['type' => 'datetime', 'not null' => true, 'default' => '0000-00-00 00:00:00', 'description' => 'date this record was created'],
                'claimed'   => ['type' => 'datetime', 'description' => 'date this item was claimed'],
            ],
            'primary key' => ['id'],
            'indexes'     => [
                'queue_item_created_idx' => ['created'],
            ],
        ];
    }
}