luya\web\jsonld\ArticleTrait

Complexity

Total Complexity

14

Size/Duplication

Total Lines	176
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Importance

Changes

0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	getArticleBody()	0	4	1
A	setArticleBody()	0	5	1
A	getArticleSection()	0	4	1
A	setArticleSection()	0	5	1
A	getPageEnd()	0	4	1
A	setPageEnd()	0	5	1
A	getPageStart()	0	4	1
A	setPageStart()	0	5	1
A	getPagination()	0	4	1
A	setPagination()	0	5	1
A	getSpeakable()	0	4	1
A	setSpeakable()	0	5	1
A	getWordCount()	0	4	1
A	setWordCount()	0	5	1

<?php

namespace luya\web\jsonld;

/**
 * JsonLd - Article Trait
 *
 * @see http://schema.org/Article
 *
 * @author Alex Schmid <alex.schmid@stud.unibas.ch>
 * @since 1.0.1
 */
trait ArticleTrait
{
    use CreativeWorkTrait;

    private $_articleBody;

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

    /**
     * The actual body of the article.
     *
     * @param string $articleBody
     * @return Article|ArticleTrait
     */
    public function setArticleBody($articleBody)
    {
        $this->_articleBody = $articleBody;
        return $this;
    }

    private $_articleSection;

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

    /**
     * Articles may belong to one or more 'sections' in a magazine or newspaper, such as Sports, Lifestyle, etc.
     *
     * @param string $articleSection
     * @return Article|ArticleTrait
     */
    public function setArticleSection($articleSection)
    {
        $this->_articleSection = $articleSection;
        return $this;
    }

    private $_pageEnd;

    /**
     * @return int|string
     */
    public function getPageEnd()
    {
        return $this->_pageEnd;
    }

    /**
     * The page on which the work ends; for example "138" or "xvi".
     *
     * @param int|string $pageEnd
     * @return Article|ArticleTrait
     */
    public function setPageEnd($pageEnd)
    {
        $this->_pageEnd = $pageEnd;
        return $this;
    }

    private $_pageStart;

    /**
     * @return int|string
     */
    public function getPageStart()
    {
        return $this->_pageStart;
    }

    /**
     * The page on which the work starts; for example "135" or "xiii".
     *
     * @param int|string $pageStart
     * @return Article|ArticleTrait
     */
    public function setPageStart($pageStart)
    {
        $this->_pageStart = $pageStart;
        return $this;
    }

    private $_pagination;

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

    /**
     * Any description of pages that is not separated into pageStart and pageEnd;
     * for example, "1-6, 9, 55" or "10-12, 46-49".
     *
     * @param string $pagination
     * @return Article|ArticleTrait
     */
    public function setPagination($pagination)
    {
        $this->_pagination = $pagination;
        return $this;
    }

    private $_speakable;

    /**
     * @return SpeakableSpecification|URL
     */
    public function getSpeakable()
    {
        return $this->_speakable;
    }

    /**
     * Indicates sections of a Web page that are particularly 'speakable' in the sense of being highlighted as being
     * especially appropriate for text-to-speech conversion. Other sections of a page may also be usefully spoken in
     * particular circumstances; the 'speakable' property serves to indicate the parts most likely
     * to be generally useful for speech.
     *
     * The speakable property can be repeated an arbitrary number of times,
     * with three kinds of possible 'content-locator' values:
     *
     * 1.) id-value URL references - uses id-value of an element in the page being annotated. The simplest use
     * of speakable has (potentially relative) URL values, referencing identified sections of the document concerned.
     *
     * 2.) CSS Selectors - addresses content in the annotated page, eg. via class attribute. Use the cssSelector property.
     *
     * 3.) XPaths - addresses content via XPaths (assuming an XML view of the content). Use the xpath property.
     *
     * For more sophisticated markup of speakable sections beyond simple ID references, either CSS selectors
     * or XPath expressions to pick out document section(s) as speakable. For this we define a supporting type,
     * SpeakableSpecification which is defined to be a possible value of the speakable property.
     *
     * @param SpeakableSpecification|URL $speakable
     * @return Article|ArticleTrait
     */
    public function setSpeakable($speakable)
    {
        $this->_speakable = $speakable;
        return $this;
    }

    private $_wordCount;

    /**
     * @return int
     */
    public function getWordCount()
    {
        return $this->_wordCount;
    }

    /**
     * The number of words in the text of the Article.
     *
     * @param int $wordCount
     * @return Article|ArticleTrait
     */
    public function setWordCount($wordCount)
    {
        $this->_wordCount = $wordCount;
        return $this;
    }
}