updated Model class

- better encapsulations
- better documentation
- added new options, setters and getters
- other small fixes

src/Roumen/Sitemap/Model.php

@@ -1,16 +1,27 @@
 <?php namespace Roumen\Sitemap;
 
+/**
+ * Model class for laravel-sitemap package.
+ *
+ * @author Roumen Damianoff <[email protected]>
+ * @version 2.5.8
+ * @link http://roumen.it/projects/laravel-sitemap
+ * @license http://opensource.org/licenses/mit-license.php MIT License
+ */
+
+use Illuminate\Support\Facades\Cache;
+
 class Model
 {
     /**
      * @var array
      */
-    public $items = [];
+    private $items = [];
 
     /**
      * @var array
      */
-    public $sitemaps = [];
+    private $sitemaps = [];
 
     /**
      * @var null
@@ -34,7 +45,7 @@ class Model
      *
      * @var string
      */
-    private $cacheKey = "Laravel.Sitemap.";
+    private $cacheKey = "laravel-sitemap.";
 
     /**
      * Cache duration, can be int or timestamp
@@ -50,6 +61,14 @@ class Model
      */
     private $escaping = true;
 
+    /**
+     * Use limitSize() for big sitemaps
+     *
+     * @var boolean
+     */
+    private $useLimitSize = false;
+
+
     /**
      * Populating model variables from configuation file
      *
@@ -61,90 +80,237 @@ public function __construct(array $config)
         $this->cacheKey = isset($config['cache_key']) ? $config['cache_key'] : $this->cacheKey;
         $this->cacheDuration = isset($config['cache_duration']) ? $config['cache_duration'] : $this->cacheDuration;
         $this->escaping = isset($config['escaping']) ? $config['escaping'] : $this->escaping;
+        $this->useLimitSize = isset($config['use_limit_size']) ? $config['use_limit_size'] : $this->useLimitSize;
     }
 
+
+    /**
+     * Returns $items array
+     *
+     * @return array
+     */
     public function getItems()
     {
         return $this->items;
     }
 
+    /**
+     * Returns $sitemaps array
+     *
+     * @return array
+     */
     public function getSitemaps()
     {
         return $this->sitemaps;
     }
 
+
+    /**
+     * Returns $title value
+     *
+     * @return string
+     */
     public function getTitle()
     {
         return $this->title;
     }
 
+
+    /**
+     * Returns $link value
+     *
+     * @return string
+     */
     public function getLink()
     {
         return $this->link;
     }
 
+
+    /**
+     * Returns $useCache value
+     *
+     * @return boolean
+     */
     public function getUseCache()
     {
         return $this->useCache;
     }
 
+
+    /**
+     * Returns $CacheKey value
+     *
+     * @return string
+     */
     public function getCacheKey()
     {
         return $this->cacheKey;
     }
 
+
+    /**
+     * Returns $CacheDuration value
+     *
+     * @return string
+     */
     public function getCacheDuration()
     {
         return $this->cacheDuration;
     }
 
+
+    /**
+     * Returns $escaping value
+     *
+     * @return boolean
+     */
     public function getEscaping()
     {
         return $this->escaping;
     }
 
+
+    /**
+     * Returns $useLimitSize value
+     *
+     * @return boolean
+     */
+    public function getUseLimitSize()
+    {
+        return $this->useLimitSize;
+    }
+
+
+    /**
+     * Sets $escaping value
+     *
+     * @param boolean $escaping
+     */
     public function setEscaping($b)
     {
         $this->escaping = $b;
     }
 
+
+    /**
+     * Adds item to $items array
+     *
+     * @param array $item
+     */
     public function setItems($items)
     {
         $this->items[] = $items;
     }
 
-    public function resetItems()
-    {
-        $this->items[] = array_slice($this->items[], 0, 50000);
-    }
 
-    public function setSitemaps($sitemaps)
+    /**
+     * Adds sitemap to $sitemaps array
+     *
+     * @param array $sitemap
+     */
+    public function setSitemaps($sitemap)
     {
-        $this->sitemaps[] = $sitemaps;
+        $this->sitemaps[] = $sitemap;
     }
 
+
+    /**
+     * Sets $title value
+     *
+     * @param string $title
+     */
     public function setTitle($title)
     {
         $this->title = $title;
     }
 
+
+    /**
+     * Sets $link value
+     *
+     * @param string $link
+     */
     public function setLink($link)
     {
         $this->link = $link;
     }
 
+
+    /**
+     * Sets $useLimitSize value
+     *
+     * @param boolean $useLimitSize
+     */
+    public function setUseLimitSize($useLimitSize)
+    {
+        $this->useLimitSize = $useLimitSize;
+    }
+
+
+    /**
+     * Limit size of $items array to 50000 elements
+     *
+     */
+    public function limitSize()
+    {
+        $this->items = array_slice($this->items, 0, 50000);
+    }
+
+
+    /**
+     * Reset $items array
+     *
+     * @param array $items
+     */
+    public function resetItems($items=[])
+    {
+        $this->items = $items;
+    }
+
+
+    /**
+     * Reset $sitemaps array
+     *
+     * @param array $sitemaps
+     */
+    public function resetSitemaps($sitemaps=[])
+    {
+        $this->sitemaps = $sitemaps;
+    }
+
+
+    /**
+     * Set use cache value
+     *
+     * @param boolean $useCache
+     */
     public function setUseCache($useCache)
     {
         $this->useCache = $useCache;
     }
 
+
+    /**
+     * Set cache key value
+     *
+     * @param string $cacheKey
+     */
     public function setCacheKey($cacheKey)
     {
         $this->cacheKey = $cacheKey;
     }
 
+
+    /**
+     * Set cache duration value
+     *
+     * @param Carbon|Datetime|int $cacheDuration
+     */
     public function setCacheDuration($cacheDuration)
     {
         $this->cacheDuration = $cacheDuration;
     }
-}
+
+
+}