<?php

namespace T3o\Karma\Domain\Model;

/***************************************************************
 *  Copyright notice
 *
 *  (c) 2018
 *  All rights reserved
 *
 *  This script is part of the TYPO3 project. The TYPO3 project is
 *  free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  The GNU General Public License can be found at
 *  http://www.gnu.org/copyleft/gpl.html.
 *
 *  This script 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 General Public License for more details.
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
class LedgerEntry extends \TYPO3\CMS\Extbase\DomainObject\AbstractEntity
{
    /**
     * @var \DateTime
     */
    protected $crdate;

    /**
     * @var \DateTime
     */
    protected $tstamp;

    /**
     * The date when the entry expired, if set.
     *
     * Set when the entry expires.
     *
     * @var int
     */
    protected $expired;

    /**
     * The unchangeable ledgerentry entry value
     *
     * @var int
     */
    protected $immutableValue;

    /**
     * The changeable ledgerentry entry value.
     *
     * Can be depreciated over time or set to zero.
     *
     * @var int
     */
    protected $mutableValue;

    /**
     * The entry karma source code
     *
     * @var string
     */
    protected $karmaSource;

    /**
     * @var string
     */
    protected $issuer;

    /**
     * @var string
     */
    protected $issuerAction;

    /**
     * Set to the related campaign if the entry is generated through a campaign
     *
     * @var \T3o\Karma\Domain\Model\Campaign
     */
    protected $campaign;

    /**
     * The user the entry is valid for
     *
     * @var \T3o\Karma\Domain\Model\FrontendUser
     */
    protected $user;

    /**
     * Get the creation date
     *
     * @return \DateTime
     */
    public function getCrdate(): \DateTime
    {
        return $this->crdate;
    }

    /**
     * Set the creation date
     *
     * @param \DateTime $crdate
     */
    public function setCrdate(\DateTime $crdate)
    {
        $this->crdate = $crdate;
    }

    /**
     * Get the last modified timestamp
     *
     * @return \DateTime
     */
    public function getTstamp(): \DateTime
    {
        return $this->tstamp;
    }

    /**
     * Set the last modified timestamp
     *
     * @param \DateTime $tstamp
     */
    public function setTstamp(\DateTime $tstamp)
    {
        $this->tstamp = $tstamp;
    }

    /**
     * Return the expired timestamp or zero if not yet expired
     *
     * @return int
     */
    public function getExpired()
    {
        return $this->expired;
    }

    /**
     * Returns true if the entry has expired
     *
     * @return bool
     */
    public function isExpired()
    {
        return (bool)$this->getExpired();
    }

    /**
     * Set the timestamp for the entry's expiry, or zero if the entry has not expired
     *
     * @param int $expired
     */
    public function setExpired(int $expired)
    {
        $this->expired = $expired;
    }

    /**
     * Returns the unchangeable entry value
     *
     * @return int
     */
    public function getImmutableValue()
    {
        return $this->immutableValue;
    }

    /**
     * Set the unchangeable entry value.
     *
     * Should only be done once.
     *
     * @param int $immutableValue
     */
    public function setImmutableValue(int $immutableValue)
    {
        $this->immutableValue = $immutableValue;
    }

    /**
     * Returns the changeable entry value
     *
     * @return int
     */
    public function getMutableValue()
    {
        return $this->mutableValue;
    }

    /**
     * Set the changeable entry value
     *
     * @param int $mutableValue
     */
    public function setMutableValue(int $mutableValue)
    {
        $this->mutableValue = $mutableValue;
    }

    /**
     * Get the entry karma source
     *
     * @return string
     */
    public function getKarmaSource()
    {
        return $this->karmaSource;
    }

    /**
     * Set the entry karma source
     *
     * @param string $karmaSource
     */
    public function setKarmaSource(string $karmaSource)
    {
        $this->karmaSource = $karmaSource;
    }

    /**
     * Get the issuer code
     *
     * @return string
     */
    public function getIssuer()
    {
        return $this->issuer;
    }

    /**
     * Set the issuer code
     *
     * @param string $issuer
     */
    public function setIssuer(string $issuer)
    {
        $this->issuer = $issuer;
    }

    /**
     * Get the issuer action code
     *
     * @return string
     */
    public function getIssuerAction()
    {
        return $this->issuerAction;
    }

    /**
     * Set the issuer action code
     *
     * @param string $issuerAction
     */
    public function setIssuerAction(string $issuerAction)
    {
        $this->issuerAction = $issuerAction;
    }

    /**
     * Get the entry campaign that generated this entry, or null if no campaign
     *
     * @return \T3o\Karma\Domain\Model\Campaign
     */
    public function getCampaign()
    {
        return $this->campaign;
    }

    /**
     * Set the campaign that generated this entry
     *
     * @param \T3o\Karma\Domain\Model\Campaign $campaign
     */
    public function setCampaign(Campaign $campaign)
    {
        $this->campaign = $campaign;
    }

    /**
     * Get the user this entry is for
     *
     * @return \T3o\Karma\Domain\Model\FrontendUser
     */
    public function getUser()
    {
        return $this->user;
    }

    /**
     * Set the user the entry is for
     *
     * @param \T3o\Karma\Domain\Model\FrontendUser $user
     */
    public function setUser(FrontendUser $user)
    {
        $this->user = $user;
    }
}