Версия: 6.x
burger close
Класс Api

Подробное описание

Класс содержит методы для генерации sitemap файлов

Открытые члены

 sitemapToOutput ()
 
 sitemapChunkToOutput ($chunk)
 
 getChunkFilepath ($chunk, $gzip=null)
 
 checkActual ()
 
 generateSitemap ()
 
 getSitemapUrl ($chunk, $base_url)
 
 gzipFile ($source, $level=9)
 
 createSitemapIndexFile ($chunk_filenames)
 
 cleanSitemaps ()
 

Поля данных

const ELEMENT_NAME_KEY = 'element_name'
 
const ELEMENT_MAP_TYPE_KEY = 'element_map_type'
 
 $map_type
 
 $allowed_map_types = ['google']
 
 $folder = '/storage/sitemap'
 
 $full_filename
 

Защищенные члены

 writeItemContent (array $content, $xml)
 

Защищенные данные

 $site_id
 

Методы

checkActual ( )

Возвращает true, если файл sitemap существует и он актуальный

Возвращает
bool
cleanSitemaps ( )

Очищает старые файлы sitemap

Возвращает
void
createSitemapIndexFile (   $chunk_filenames)

Создает SitemapIndex файл с ссылками на Sitemap файлы

Аргументы
$chunk_filenames
Возвращает
void
generateSitemap ( )

Создает файл sitemap.xml

Возвращает
void
getChunkFilepath (   $chunk,
  $gzip = null 
)

Формирует имя файла на диске для составной части sitemap

Аргументы
integer$chunkНомер части
bool | null$gzipДобавлять или нет .gz в конце. null - по умолчанию
Возвращает
string
getSitemapUrl (   $chunk,
  $base_url 
)
gzipFile (   $source,
  $level = 9 
)

Создает .gz архив с файлом $source

Аргументы
string$sourceПуть к исходному файлу
int$levelУровень сжатия
Возвращает
bool|string Возвращает путь к новому .gz файлу
sitemapChunkToOutput (   $chunk)

Отдает составные части sitemap

Возвращает
void
sitemapToOutput ( )

Отдает актуальный файл sitemap.xml на вывод

Возвращает
void
writeItemContent ( array  $content,
  $xml 
)
protected

Рекурсивно записывает переданный массив элементов карты в xml

Аргументы
array$content- содержимое элемента
\XMLWriter$xml- объект XML документа

Поля

$allowed_map_types = ['google']
$folder = '/storage/sitemap'
$full_filename
$map_type
$site_id
protected
const ELEMENT_MAP_TYPE_KEY = 'element_map_type'
const ELEMENT_NAME_KEY = 'element_name'