Saito\User\LastRefresh\LastRefreshAbstract

Complexity

Total Complexity

4

Size/Duplication

Total Lines	79
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	isNewerThan()	0	10	2
	_get()	0	1	?
A	set()	0	9	1
	_set()	0	1	?

<?php

declare(strict_types = 1);

/**
 * Saito - The Threaded Web Forum
 *
 * @copyright Copyright (c) the Saito Project Developers
 * @link https://github.com/Schlaefer/Saito
 * @license http://opensource.org/licenses/MIT
 */

namespace Saito\User\LastRefresh;

use Saito\User\CurrentUser\CurrentUserInterface;

/**
 * handles last refresh time for the current user
 */
abstract class LastRefreshAbstract
{

    /**
     * @var CurrentUserInterface
     */
    protected $_CurrentUser;

    /**
     * @var \DateTimeInterface timestamp
     */
    protected $_timestamp = null;

    /**
     * @var mixed storage object depending on implementation
     */
    protected $_storage;

    /**
     * Constructor
     *
     * @param CurrentUserInterface $CurrentUser current-user
     * @param mixed $storage storage a storage handler
     */
    public function __construct(CurrentUserInterface $CurrentUser, $storage = null)
    {
        $this->_CurrentUser = $CurrentUser;
        $this->_storage = $storage;
    }

    /**
     * Checks if last refresh newer than $timestamp.
     *
     * Performance sensitive: every posting on /entries/index may be
     * tested if new for user.
     *
     * @param string|\DateTimeInterface $timestamp int unix-timestamp or date as string
     * @return mixed bool or null if not determinable
     */
    public function isNewerThan($timestamp)
    {
        $lastRefresh = $this->_get();
        // timestamp is not set (or readable): everything is considered new
        if ($lastRefresh === false) {
            return null;
        }

        return $lastRefresh > dateToUnix($timestamp);
    }

    /**
     * returns last refresh timestamp
     *
     * @return mixed int if unix timestamp or bool false if uninitialized
     */
    abstract protected function _get();

    /**
     * Mark last refresh as "now"
     *
     * @return void
     */
    public function set(): void
    {
        $this->_timestamp = new \DateTimeImmutable();
        $this->_set();

        // All postings indiviually marked as read are now older than the
        // last-refresh timestamp and can be removed.
        $this->_CurrentUser->ReadEntries->delete();

Accessing ReadEntries on the interface Saito\User\CurrentUser\CurrentUserInterface suggest that you code against a concrete implementation. How about adding an instanceof check?

    }

    /**
     * Set timestamp implementation
     *
     * @return void
     */
    abstract protected function _set();
}