Borobudur\Http\HttpStatusTrait

Complexity

Total Complexity

19

Size/Duplication

Total Lines	161
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes	4
Bugs	4	Features	0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	setStatusCode()	0	13	4
A	isValid()	0	4	1
A	isInformational()	0	4	1
A	isSuccessful()	0	4	1
A	isRedirection()	0	4	1
A	isClientError()	0	4	1
A	isServerError()	0	4	1
A	isOk()	0	4	1
A	isForbidden()	0	4	1
A	isNotFound()	0	4	1
A	isEmpty()	0	4	1
A	isNotModified()	0	4	1
A	getStatusCode()	0	8	2
A	getStatusText()	0	8	2

<?php
/*
 * This file is part of the Borobudur-Http package.
 *
 * (c) Hexacodelabs <http://hexacodelabs.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Borobudur\Http;

use Borobudur\Http\Exception\InvalidArgumentException;

/**
 * @author      Iqbal Maulana <iq.bluejack@gmail.com>
 * @created     8/5/15
 */
trait HttpStatusTrait
{
    /**
     * Get status code.
     *
     * @return int
     */
    public function getStatusCode()
    {
        if (property_exists($this, 'statusCode')) {
            return $this->{'statusCode'};
        }

        return null;
    }

    /**
     * Set status code.
     *
     * @param int $statusCode
     *
     * @return $this
     */
    public function setStatusCode($statusCode)
    {
        if (false === HttpStatus::isValid($statusCode)) {
            throw new InvalidArgumentException(sprintf('Invalid status code "%s".', $statusCode));
        }

        if (property_exists($this, 'statusCode') && property_exists($this, 'statusText')) {
            $this->{'statusCode'} = $statusCode = (int) $statusCode;
            $this->{'statusText'} = HttpStatus::getStatusText($statusCode, '');
        }

        return $this;
    }

    /**
     * Get status text.
     *
     * @return string
     */
    public function getStatusText()
    {
        if (property_exists($this, 'statusText')) {
            return $this->{'statusText'};
        }

        return null;
    }

    /**
     * Check if current response is valid status code.
     *
     * @return bool
     */
    public function isValid()
    {
        return HttpStatus::isValid($this->getStatusCode());
    }

    /**
     * Check if current response is informational.
     *
     * @return bool
     */
    public function isInformational()
    {
        return HttpStatus::isInformational($this->getStatusCode());
    }

    /**
     * Check if current response is successful.
     *
     * @return bool
     */
    public function isSuccessful()
    {
        return HttpStatus::isSuccessful($this->getStatusCode());
    }

    /**
     * Check if current response is redirection.
     *
     * @return bool
     */
    public function isRedirection()
    {
        return HttpStatus::isRedirection($this->getStatusCode());
    }

    /**
     * Check if current response is client error.
     *
     * @return bool
     */
    public function isClientError()
    {
        return HttpStatus::isClientError($this->getStatusCode());
    }

    /**
     * Check if current response is server error.
     *
     * @return bool
     */
    public function isServerError()
    {
        return HttpStatus::isServerError($this->getStatusCode());
    }

    /**
     * Check if current response is ok.
     *
     * @return bool
     */
    public function isOk()
    {
        return HttpStatus::isOk($this->getStatusCode());
    }

    /**
     * Check if current response is forbidden.
     *
     * @return bool
     */
    public function isForbidden()
    {
        return HttpStatus::isForbidden($this->getStatusCode());
    }

    /**
     * Check if current response is not found.
     *
     * @return bool
     */
    public function isNotFound()
    {
        return HttpStatus::isNotFound($this->getStatusCode());
    }

    /**
     * Check if current response is empty.
     *
     * @return bool
     */
    public function isEmpty()
    {
        return HttpStatus::isEmpty($this->getStatusCode());
    }

    /**
     * Check if response is not modified.
     *
     * @return bool
     */
    public function isNotModified()
    {
        return HttpStatus::HTTP_NOT_MODIFIED === $this->getStatusCode();
    }
}