Charcoal\Search\SearchLog

Complexity

Total Complexity

35

Size/Duplication

Total Lines	297
Duplicated Lines	5.72 %

Coupling/Cohesion

Components	2
Dependencies	1

Importance

Changes

0

19 Methods

Rating	Name	Duplication	Size	Complexity
A	setSearchIdent()	0	10	2
A	searchIdent()	0	4	1
A	setKeyword()	0	10	2
A	keyword()	0	4	1
A	setNumResults()	0	5	1
A	numResults()	0	4	1
B	setResults()	0	20	5
A	results()	0	4	1
A	ts()	0	4	1
A	setIp()	0	5	1
A	ip()	0	4	1
A	setTs()	17	17	4
A	setSessionId()	0	14	3
A	sessionId()	0	4	1
A	setLang()	0	5	1
A	lang()	0	4	1
A	setOrigin()	0	12	3
A	origin()	0	4	1
A	preSave()	0	16	4

<?php

namespace Charcoal\Search;

use \DateTime;
use \DateTimeInterface;
use \InvalidArgumentException;

// Module `charcoal-core` dependencies
use \Charcoal\Model\AbstractModel;

/**
 * Search logs should be saved every time a client initiates a search request.
 */
class SearchLog extends AbstractModel
{
    /**
     * The search identifier this specific search log belongs to.
     * @var string $searchIdent
     */
    private $searchIdent;

    /**
     * The searched keyword.
     * @var string $keyword
     */
    private $keyword;

    /**
     * Number of search results.
     * @var array $numResults
     */
    private $numResults;

    /**
     * Detailed results, if available.
     * @var array $results
     */
    private $results;

    /**
     * Timestamp of the search (date-time when the search was performed).
     * @var DateTimeInterface
     */
    private $ts;

    /**
     * Client IP.
     * @var string $ip
     */
    private $ip;

    /**
     * Client session ID, if any.
     * @var string $sessionId
     */
    private $sessionId;

    /**
     * The language code.
     * @var string $lang
     */
    private $lang;

    /**
     * The search origin; an identifier representing where the search was executed from.
     * @var string $origin
     */
    private $origin;

    /**
     * @param string $ident The search identifier.
     * @throws InvalidArgumentException If the search ident is not a string.
     * @return SearchLog Chainable
     */
    public function setSearchIdent($ident)
    {
        if (!is_string($ident)) {
            throw new InvalidArgumentException(
                'Search ident must be a string.'
            );
        }
        $this->searchIdent = $ident;
        return $this;
    }

    /**
     * @return string
     */
    public function searchIdent()
    {
        return $this->searchIdent;
    }

    /**
     * @param string $kw The searched term / keyword.
     * @throws InvalidArgumentException If the keyword is not a string.
     * @return SearchLog Chainable
     */
    public function setKeyword($kw)
    {
        if (!is_string($kw)) {
            throw new InvalidArgumentException(
                'Keyword must be a string'
            );
        }
        $this->keyword = $kw;
        return $this;
    }

    /**
     * @return string
     */
    public function keyword()
    {
        return $this->keyword;
    }

    /**
     * @param integer $num The number of results from search.
     * @return SearchLog Chainable
     */
    public function setNumResults($num)
    {
        $this->numResults = (int)$num;

It seems like (int) $num of type integer is incompatible with the declared type array of property $numResults.

        return $this;
    }

    /**
     * @return integer
     */
    public function numResults()
    {
        return $this->numResults;
    }

    /**
     * @param mixed $results The search results data, if available.
     * @throws InvalidArgumentException If the results is not an array or invalid JSON.
     * @return SearchLog Chainable
     */
    public function setResults($results)
    {
        if ($results === null) {
            $this->results = null;

It seems like null of type null is incompatible with the declared type array of property $results.

        } elseif (is_string($results)) {
            $this->results = json_decode($results, true);

It seems like json_decode($results, true) of type * is incompatible with the declared type array of property $results.

            if (json_last_error() !== JSON_ERROR_NONE) {
                throw new InvalidArgumentException(
                    sprintf('Invalid JSON for search results: "%s"', $results)
                );
            }
        } elseif (is_array($results)) {
            $this->results = $results;
        } else {
            throw new InvalidArgumentException(
                'Invalid search results type. Must be a JSON string, an array or null.'
            );
        }
        return $this;
    }

    /**
     * @return array
     */
    public function results()
    {
        return $this->results;
    }

    /**
     * @param DateTimeInterface|string|null $ts The timestamp (date-time the search occured).
     * @throws InvalidArgumentException If ts is not a valid date-time.
     * @return SearchLog Chainable
     */
    public function setTs($ts)

This method seems to be duplicated in your project.

    {
        if ($ts === null) {
            $this->ts = null;
            return $this;
        }
        if (is_string($ts)) {
            $ts = new DateTime($ts);
        }
        if (!($ts instanceof DateTimeInterface)) {
            throw new InvalidArgumentException(
                'Invalid "ts" value. Must be a date/time string or a DateTime object.'
            );
        }
        $this->ts = $ts;
        return $this;
    }

    /**
     * @return DateTime
     */
    public function ts()
    {
        return $this->ts;
    }

    /**
     * @param string $ip The IP address of the client that searched.
     * @return SearchLog Chainable
     */
    public function setIp($ip)
    {
        $this->ip = $ip;
        return $this;
    }

    /**
     * @return string
     */
    public function ip()
    {
        return $this->ip;
    }

    /**
     * @param string $sessionId The session identifier. Typically, `session_id()`.
     * @throws InvalidArgumentException If the session id is not a string.
     * @return SearchLog Chainable
     */
    public function setSessionId($sessionId)
    {
        if ($sessionId === null) {
            $this->sessionId = null;
            return $this;
        }
        if (!is_string($sessionId)) {
            throw new InvalidArgumentException(
                'Can not set search log\'s session Id:  must be a string.'
            );
        }
        $this->sessionId = $sessionId;
        return $this;
    }

    /**
     * @return string
     */
    public function sessionId()
    {
        return $this->sessionId;
    }

    /**
     * @param string $lang The language code.
     * @return SearchLog Chainable
     */
    public function setLang($lang)
    {
        $this->lang = $lang;
        return $this;
    }

    /**
     * @return string
     */
    public function lang()
    {
        return $this->lang;
    }

    /**
     * @param string $origin The origin is an identifier representing where the search was executed.
     * @throws InvalidArgumentException If the origin is not a string.
     * @return SearchLog Chainable
     */
    public function setOrigin($origin)
    {
        if (!is_string($origin) && $origin !== null) {
            throw new InvalidArgumentException(
                'Origin must be a string'
            );
        }

        $this->origin = $origin;

        return $this;
    }

    /**
     * @return string
     */
    public function origin()
    {
        return $this->origin;
    }

    /**
     * @return boolean
     */
    public function preSave()
    {
        parent::preSave();

        $this->setIp(getenv('REMOTE_ADDR') ? getenv('REMOTE_ADDR') : '');
        $this->setTs('now');
        if (session_id()) {
            $this->setSessionId(session_id());
        }

        if (!isset($this->lang)) {
            $this->setLang('');
        }

        return true;
    }
}