Article::isHomepageHidden() - Code Metrics - Inspection of "Add homepage hiden to article" - rudolfcms/rudolf - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — master ( b4ab83...0f95d0 )

by Mikołaj
created 2017-02-26 14:08 UTC
Article::isHomepageHidden() A

↳ Parent: Project
Complexity

Conditions	1
Paths	1
Size

Total Lines	4
Code Lines	2
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	2
nc	1
nop	0
dl	0
loc	4
rs	10
c	0
b	0
f	0
<?php

namespace Rudolf\Modules\Articles\One;

use Rudolf\Component\Forms\Validator;
use Rudolf\Component\Hooks;
use Rudolf\Component\Html\Text;
use Rudolf\Component\Images\Image;

class Article
{
    /**
     * @var array Article data
     */
    protected $article;

    /**
     * Constructor.
     * 
     * @param array $article
     */
    public function __construct($article = [])
    {
        $this->setData($article);
    }

    /**
     * Set article data.
     * 
     * @param array $article
     */
    public function setData($article)
    {
        $this->article = array_merge(
            [
                'id' => 0,
                'category_ID' => 0,
                'title' => '',
                'keywords' => '',
                'description' => '',
                'content' => '',
                'author' => '',
                'date' => '',
                'added' => '',
                'modified' => '',
                'adder_ID' => 0,
                'adder_first_name' => '',
                'adder_surname' => '',
                'modifier_ID' => 0,
                'modifier_first_name' => '',
                'modifier_surname' => '',
                'views' => 0,
                'slug' => '',
                'url' => '',
                'album' => '',
                'thumb' => '',
                'thumbnail' => '',
                'photos' => '',
                'homepage_hidden' => false,
                'published' => false,
                'category' => '',
                'category_title' => '',
                'category_url' => '',
            ],
            (array) $article
        );
    }

    /**
     * Returns article ID.
     * 
     * @return int
     */
    public function id()
    {
        return (int) $this->article['id'];
    }

    /**
     * Returns category ID.
     * 
     * @return int
     */
    public function categoryID()
    {
        return (int) $this->article['category_ID'];
    }

    /**
     * Returns article title.
     * 
     * @param string $type null|raw
     * 
     * @return string
     */
    public function title($type = '')
    {
        $title = $this->article['title'];
        if ('raw' === $type) {
            return $title;
        }

        return Text::escape($title);
    }

    /**
     * Returns the keywords.
     * 
     * @param string $type null|raw
     * 
     * @return string
     */
    public function keywords($type = '')
    {
        $keywords = $this->article['keywords'];
        if ('raw' === $type) {
            return $keywords;
        }

        return Text::escape($keywords);
    }

    /**
     * Returns the description.
     * 
     * @param string $type
     * 
     * @return string
     */
    public function description($type = '')

    {
        $description = $this->article['description'];
        if ('raw' === $type) {
            return $description;
        }

        return Text::escape($description);
    }

    /**
     * Returns article content.
     * 
     * @param bool|int $truncate
     * @param bool     $stripTags
     * @param bool     $escape
     * @param bool     $raw
     * 
     * @return string
     */
    public function content($truncate = false, $stripTags = false, $escape = false, $raw = false)
    {
        $content = $this->article['content'];

        if (true === $stripTags) {
            $content = strip_tags($content);
        }

        if (false !== $truncate) {
            $content = Text::truncate($content, $truncate, '…', '<b><i><u><em><strong><a><span>');

        }

        if (true === $escape) {
            $content = Text::escape($content);
        }

        if (false === $raw) {
            $content = Hooks\Filter::apply('content_filter', $content);

            return $content;
        }

        return $content;
    }
    /**
     * Returns the author.
     * 
     * @param string $type null|raw
     * 
     * @return string
     */
    public function author($type = '', $adder = true)

    {
        $author = $this->article['author'];

        // if fields is empty and $adder is true
        if (empty($author) and true === $adder) {
// Logical operators have lower precedence:
$f = false or true;

// is executed like this:
($f = false) or true;


// Boolean operators have higher precedence:
$f = false || true;

// is executed like this:
$f = (false || true);
            $author = $this->adderFullName(false);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }

        if ('raw' === $type) {
            return $author;
        }

        return Text::escape($author);
    }

    /**
     * Returns article date.
     * 
     * @param bool|string $format
     * @param string      $style  normal|locale
     * 
     * @return string If date field empty, return current date
     */
    public function date($format = false, $style = 'normal', $inflected = true)

    {
        $date = $this->article['date'];

        $validator = new Validator();
        $validator->checkDatetime('date', $date, 'Y-m-d H:i:s');
        if ($validator->isErrors() or empty($date)) {
// Logical operators have lower precedence:
$f = false or true;

// is executed like this:
($f = false) or true;


// Boolean operators have higher precedence:
$f = false || true;

// is executed like this:
$f = (false || true);
            return $date;
        }

        switch ($style) {
            case 'locale': // http://php.net/manual/en/function.strftime.php
                $format = ($format) ? $format : '%D';
                $date = strftime($format, strtotime($date));
                break;

            default: // http://php.net/manual/en/datetime.formats.date.php
                $format = ($format) ? $format : 'Y-m-d H:i:s';
                $date = date_format(date_create($date), $format);
                break;
        }

        $date = Hooks\Filter::apply('date_format_filter', $date);

        if (true === $inflected) {
            $month = [
                'styczeń' => 'stycznia', // 01
                'luty' => 'lutego', // 02
                'marzec' => 'marca', // 03
                'kwiecień' => 'kwietnia', // 04
                'maj' => 'maja', // 05
                'czerwiec' => 'czerwca', // 06
                'lipiec' => 'lipca', // 07
                'sierpień' => 'sierpnia', // 08
                'wrzesień' => 'września', // 09
                'październik' => 'października', // 10
                'listopad' => 'listopada', // 11
                'grudzień' => 'grudnia', // 12
            ];

            foreach ($month as $key => $value) {
                $date = str_replace($key, $value, $date);
            }
        }

        return $date;
    }

    /**
     * Returns date of article added.
     * 
     * @return string
     */
    public function added()
    {
        return $this->article['added'];
    }

    /**
     * Returns date of last article modified.
     * 
     * @return string
     */
    public function modified()
    {
        return $this->article['modified'];
    }

    /**
     * Returns adder ID.
     * 
     * @return int
     */
    public function adderID()
    {
        return (int) $this->article['adder_ID'];
    }

    /**
     * Returns first name and surname of adder.
     * 
     * @param string $type
     * 
     * @return string
     */
    public function adderFullName($type = '')

    {
        $name = trim($this->article['adder_first_name'].' '.$this->article['adder_surname']);
        if ('raw' === $type) {
            return $name;
        }

        return Text::escape($name);
    }

    /**
     * Returns modifier ID.
     * 
     * @return int
     */
    public function modifierID()
    {
        return (int) $this->article['modifier_ID'];
    }

    /**
     * Returns modifier full name.
     * 
     * @return int
     */
    public function modifierFullName($type = '')

    {
        $name = $this->article['modifier_first_name'].' '.$this->article['modifier_surname'];
        if ('raw' === $type) {
            return $name;
        }

        return Text::escape($name);
    }

    /**
     * Checks whether the article has modified.
     * 
     * @return bool
     */
    public function isModified()
    {
        return (bool) $this->article['modified'];
    }

    /**
     * Returns the number of views.
     * 
     * @return int
     */
    public function views()
    {
        return (int) $this->article['views'];
    }

    /**
     * Returns article slug.
     *
     * @param string $type
     *
     * @return string
     */
    public function slug($type = '')

    {
        $slug = $this->article['slug'];
        if ('raw' === $type) {
            return $slug;
        }

        return Text::escape($slug);
    }

    /**
     * Returns article url.
     * 
     * @return string
     */
    public function url()
    {
        return sprintf('%1$s/%2$s/%3$s/%4$s/%5$s',
            DIR,
            'artykuly',
            $this->date('Y'),
            $this->date('m'),
            $this->slug()
        );
    }

    /**
     * Returns album path.
     *
     * @param string $type
     * 
     * @return string
     */
    public function album($type = '')
    {
        $album = $this->article['album'];
        if ('raw' === $type) {
            return $album;
        }

        return Text::escape($album);
    }

    /**
     * Returns thumb path.
     *
     * @param string $type
     * 
     * @return string
     */
    public function thumb($type = '')
    {
        $thumb = $this->article['thumb'];
        if ('raw' === $type) {
            return $thumb;
        }

        return Text::escape($thumb);
    }

    /**
     * Checks whether the article has a thumbnail.
     * 
     * @return bool
     */
    public function hasThumbnail()
    {
        return (bool) $this->article['thumb'];
    }

    /**
     * Returns thumbnail code or only address.
     * 
     * @param int    $width   Image width
     * @param int    $height  Image height
     * @param bool   $album   Add album address if exists
     * @param string $alt     Set alternative text
     * @param string $default Default thumb path. It use when thumb path is empty
     * 
     * @return string
     */
    public function thumbnail($width = 100, $height = 100, $album = false, $alt = '', $default = '')

    {
        $thumbUrl = $this->thumb();
        $albumUrl = $this->album();
        $alt = ($alt) ? $alt : $this->title();

        if (!$this->hasThumbnail()) {
            if (!empty($default)) {
                $thumbUrl = $default;
            } else {
                return false;
            }
        }

        $thumbUrl = Image::resize($thumbUrl, $width, $height);

        $html = sprintf('<img src="%1$s" alt="%4$s" width="%2$s" height="%3$s">',
            $thumbUrl, $width, $height, $alt
        );

        if (true === $album and !empty($albumUrl)) {
// Logical operators have lower precedence:
$f = false or true;

// is executed like this:
($f = false) or true;


// Boolean operators have higher precedence:
$f = false || true;

// is executed like this:
$f = (false || true);
            $html = sprintf('<a href="%1$s">%2$s</a>', $albumUrl, $html);
        }

        return $html;
    }

    /**
     * Returns the number of photos.
     * 
     * @return int
     */
    public function photos()
    {
        return (int) $this->article['photos'];
    }

    /**
     * Checks whether the article has a photos.
     * 
     * @return bool
     */
    public function hasPhotos()
    {
        return (bool) $this->article['photos'];
    }

    /**
     * Check whether the article is hidden on homepage.
     *
     * @return bool
     */
    public function isHomepageHidden()
    {
        return (bool) $this->article['homepage_hidden'];
    }

    /**
     * Chcecks whether the article is published.
     * 
     * @return bool
     */
    public function isPublished()
    {
        return (bool) $this->article['published'];
    }

    /**
     * Returns article category anchor.
     * 
     * @return string
     */
    public function category()
    {
        return sprintf('<a href="%1$s">%2$s</a>',
            $this->categoryUrl(),
            $this->categoryTitle()
        );
    }

    /**
     * Returns category title.
     * 
     * @param string $type
     * 
     * @return string
     */
    public function categoryTitle($type = '')
    {
        $title = $this->article['category_title'];

        if ('raw' === $type) {
            return $title;
        }

        return Text::escape($title);
    }

    /**
     * Returns category url.
     * 
     * @return string
     */
    public function categoryUrl()
    {
        return sprintf('%1$s/%2$s/%3$s',
            DIR,
            'artykuly/kategorie',
            Text::escape($this->article['category_url'])
        );
    }

    /**
     * Checks whether the article has a category.
     * 
     * @return bool
     */
    public function hasCategory()
    {
        return (bool) $this->article['category_url'];
    }
}

Push — master ( b4ab83...0f95d0 )

Article::isHomepageHidden() A

Complexity

Size

Duplication

Importance

Logical Operators are used for Control-Flow

Logical Operators are used for Control-Flow

Logical Operators are used for Control-Flow

rudolfcms / rudolf

Push — master ( b4ab83...0f95d0 )

Article::isHomepageHidden() A

Complexity

Size

Duplication

Importance

Logical Operators are used for Control-Flow

Logical Operators are used for Control-Flow

Logical Operators are used for Control-Flow

Duplication Side-by-Side

Filter issues like
