Class app\modules\main\sitemap\Sitemap

All Classes | Properties | Methods

Inheritance	app\modules\main\sitemap\Sitemap » yii\base\Component

Class Sitemap Компонет для генерации карты сайта

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$defaultLabelAttr	string	имя атрибута для вывода подписи по умолчанию	app\modules\main\sitemap\Sitemap
$defaultScope	string	Scope применяемый по умолчанию	app\modules\main\sitemap\Sitemap
$definition	array	массив определяющий сущности для карты сайта [ [ "class"=>"app\modules\main\models\Pages", "entityRoute"=>"main/pages/index", "labelAttr"=>"title", "scopes" => ["active"], "urlCreate" => function($model){ .	app\modules\main\sitemap\Sitemap
$sitemapPath	string	путь к файлу, куда сохранять карту сайта	app\modules\main\sitemap\Sitemap

Public Methods

Hide inherited methods

Method	Description	Defined By
getElements()	Возвращает массив скартой сайта	app\modules\main\sitemap\Sitemap
renderXml()	Рендерит карту в xml и сохраняет в файл	app\modules\main\sitemap\Sitemap

Protected Methods

Hide inherited methods

Method	Description	Defined By
addItem()	Добавляет элемент в карту сайта	app\modules\main\sitemap\Sitemap
applyScopes()	Применяет scopes к запросу	app\modules\main\sitemap\Sitemap

Property Details

$defaultLabelAttr public property

string $defaultLabelAttr = "title"

имя атрибута для вывода подписи по умолчанию

$defaultScope public property

string $defaultScope = "published"

Scope применяемый по умолчанию

$definition public property

array $definition = null

массив определяющий сущности для карты сайта [ [

 "class"=>"app\modules\main\models\Pages",
 "entityRoute"=>"main/pages/index",
 "labelAttr"=>"title",
 "scopes" => ["active"],
 "urlCreate" => function($model){ ... }
 "doAdd" => function($model){ ... }

], ... ]

class, urlCreate - обязательные элементы

если scopes не задано, применяется свойство $defaultScope если labelAttr не задано, применяется свойство $defaultLabelAttr

$sitemapPath public property

string $sitemapPath = "@webapp/web/sitemap.xml"

путь к файлу, куда сохранять карту сайта

Method Details

addItem() protected method

Добавляет элемент в карту сайта

void addItem( $doc, $params )
$doc	DOMDocument
$params	array	массив параметров. должен содержать ключи url, date

applyScopes() protected method

Применяет scopes к запросу

void applyScopes( $query, $scopes )
$query	\yii\db\ActiveQueryInterface	запрос
$scopes	array	массив имен scopes

getElements() public method

Возвращает массив скартой сайта

array getElements( )
throws	\yii\base\InvalidConfigException

renderXml() public method

Рендерит карту в xml и сохраняет в файл

int renderXml( )
return	int	количество элемнтов добавленных в карту сайта
throws	\yii\base\InvalidConfigException