1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 

<?php

/* --------------------------------------------------------------
   StaticSeoUrl.inc.php 2016-08-12
   Gambio GmbH
   http://www.gambio.de
   Copyright (c) 2016 Gambio GmbH
   Released under the GNU General Public License (Version 2)
   [http://www.gnu.org/licenses/gpl-2.0.html]
   -------------------------------------------------------------- 
*/

/**
 * Class StaticSeoUrl
 *
 * Represents the default settings of a static seo url. Has got the static seo url contents as collection.
 *
 * @category   System
 * @package    StaticSeoUrl
 * @subpackage Entities
 */
class StaticSeoUrl implements StaticSeoUrlInterface
{
    /**
     * StaticSeoUrl ID
     *
     * @var int
     */
    protected $id = 0;
    
    /**
     * StaticSeoUrl Name
     *
     * @var string
     */
    protected $name = '';
    
    /**
     * Is it shown in sitemap?
     *
     * @var bool
     */
    protected $sitemapEntry = false;
    
    /**
     * Change frequency for sitemap
     *
     * @var double
     */
    protected $changeFrequency = '';
    
    /**
     * Priority for sitemap
     *
     * @var double
     */
    protected $priority = '';
    
    /**
     * Is it shown in robots file?
     *
     * @var bool
     */
    protected $robotsEntry = false;
    
    /**
     * Collection of staticSeoUrlContents
     *
     * @var StaticSeoUrlContentCollection
     */
    protected $staticSeoUrlContentCollection;
    
    
    public function __construct()
    {
        // Set StaticSeoUrlContent items.
        $this->setStaticSeoUrlContentCollection(MainFactory::create('StaticSeoUrlContentCollection', []));
    }
    
    
    /**
     * Set the ID for the staticSeoUrl.
     *
     * @param IdType $id StaticSeoUrl ID.
     *
     * @return StaticSeoUrlInterface Same instance for chained method calls.
     */
    public function setId(IdType $id)
    {
        $this->id = $id->asInt();
        
        return $this;
    }
    
    
    /**
     * Return the ID of the staticSeoUrl.
     *
     * @return int StaticSeoUrl ID.
     */
    public function getId()
    {
        return $this->id;
    }
    
    
    /**
     * Set the name for the staticSeoUrl.
     *
     * @param StringType $name Name for the staticSeoUrl.
     *
     * @return StaticSeoUrlInterface Same instance for chained method calls.
     */
    public function setName(StringType $name)
    {
        $this->name = $name->asString();
        
        return $this;
    }
    
    
    /**
     * Return the Name of the staticSeoUrl.
     *
     * @return string Name.
     */
    public function getName()
    {
        return $this->name;
    }
    
    
    /**
     * Return true when the staticSeoUrl should be considered in the sitemap, false otherwise.
     *
     * @return bool
     */
    public function isInSitemapEntry()
    {
        return $this->sitemapEntry;
    }
    
    
    /**
     * Consider the staticSeoUrl in the sitemap or not.
     *
     * @param BoolType $status True when it should be displayed, false otherwise.
     *
     * @return StaticSeoUrlInterface Same instance for chained method calls.
     */
    public function setIsInSitemapEntry(BoolType $status)
    {
        $this->sitemapEntry = $status->asBool();
        
        return $this;
    }
    
    
    /**
     * Return the change frequency of the staticSeoUrl.
     *
     * @return string Change frequency.
     */
    public function getChangeFrequency()
    {
        return $this->changeFrequency;
    }
    
    
    /**
     * Value of change frequency of staticSeoUrl in sitemap
     *
     * @param StringType $changeFrequency
     *
     * @return StaticSeoUrlInterface Same instance for chained method calls.
     */
    public function setChangeFrequency(StringType $changeFrequency)
    {
        $this->changeFrequency = $changeFrequency->asString();
        
        return $this;
    }
    
    
    /**
     * Return the Priority of the staticSeoUrl.
     *
     * @return string Priority.
     */
    public function getPriority()
    {
        return $this->priority;
    }
    
    
    /**
     * Value of Priority of staticSeoUrl in sitemap
     *
     * @param StringType $priority
     *
     * @return StaticSeoUrlInterface Same instance for chained method calls.
     */
    public function setPriority(StringType $priority)
    {
        $this->priority = $priority->asString();
        
        return $this;
    }
    
    
    /**
     * Return true when the staticSeoUrl should be considered in the robots file, false otherwise.
     *
     * @return bool
     */
    public function isInRobotsFile()
    {
        return $this->robotsEntry;
    }
    
    
    /**
     * Consider the staticSeoUrl in the robots file or not.
     *
     * @param BoolType $status True when it should be displayed, false otherwise.
     *
     * @return StaticSeoUrlInterface Same instance for chained method calls.
     */
    public function setIsInRobotsFile(BoolType $status)
    {
        $this->robotsEntry = $status->asBool();
        
        return $this;
    }
    
    
    /**
     * Set the static seo url content collection for the static seo url.
     *
     * @param StaticSeoUrlContentCollection $staticSeoUrlContentCollection
     *
     * @return StaticSeoUrlInterface Same instance for chained method calls.
     */
    public function setStaticSeoUrlContentCollection(StaticSeoUrlContentCollection $staticSeoUrlContentCollection)
    {
        $this->staticSeoUrlContentCollection = $staticSeoUrlContentCollection;
        
        return $this;
    }
    
    
    /**
     * Return the staticSeoUrlContent collection of the staticSeoUrl.
     *
     * @return StaticSeoUrlContentCollection StaticSeoUrlContent collection.
     */
    public function getStaticSeoUrlContentCollection()
    {
        return $this->staticSeoUrlContentCollection;
    }
    
    
    /**
     * Adds a staticSeoUrlContent to the staticSeoUrlContent collection
     *
     * @param StaticSeoUrlContentInterface $staticSeoUrlContent
     *
     * @throws InvalidArgumentException
     *
     * @return StaticSeoUrlInterface Same instance for chained method calls.
     */
    public function addStaticSeoUrlContent(StaticSeoUrlContentInterface $staticSeoUrlContent)
    {
        $this->staticSeoUrlContentCollection->addItem($staticSeoUrlContent);
        
        return $this;
    }
}