Class RssWrite

[Строка 27]

Размещен: /Kernel/RssWrite.class.php




Описание


Ядро, класс для генерации RSS.


Со спецификацией можно ознакомиться на сайте http://www.rssboard.org/rss-specification






Свойства класса



    
	






Константы класса



    
	






Унаследованные константы класса







Унаследованные свойства класса








Методы
 


    
		
		
  • string CreateRSS()
		
    Метод формирования XML-файла в стандарте RSS
		
		
  • str str_for_rss()
		
    Преобразует строку для публикации в RSS, использует str_for_xml() и kernel::numeric_character_references()
	





Унаследованные методы
 







Описания методов



    



    RssWrite::CreateRSS
    


    
CreateRSS(
array
$rss_mas_header, array
$rss_mas_items, [array
$property = array()] );

    




    Описание
    

    Метод формирования XML-файла в стандарте RSS
    
		
    Принимаемые параметры
    
			
    $rss_mas_header
    
		
    массив, содержащий данные заголовка канала 
    • $rss_mas_items - массив, содержащий данные новостных заголовков
    • $rss_mas_header['title'] - Заголовок канала
    • $rss_mas_header['link'] - Ссылка на сайт
    • $rss_mas_header['description'] - Краткое описание RSS-канала
    • $rss_mas_header['image'] - Картинка для представления канала (необязательный элемент)
    • $rss_mas_header['image']['url'] - Ссылка на файл изображения
    • $rss_mas_header['image']['title'] - Заменяющий текст для изображения
    • $rss_mas_header['image']['link'] - Ссылка для перехода при щелчке по изображению
    
			
    $rss_mas_items
    
		
    массив, соддержащий данные о элементах канала 
    • $rss_mas_items[]['title'] - Название новости
    • $rss_mas_items[]['link'] - Ссылка на страничку, содержащую соответствующую новость
    • $rss_mas_items[]['description'] - Краткое описание новости
    • $rss_mas_items[]['pubDate'] - Дата публикации новости, ПРИНИМАЕТСЯ В ФОРМАТЕ SQL
    • $rss_mas_items[]['author'] - Автор
    • $rss_mas_items[]['category'] - Наименование категории, к которой относится элемент
    • $rss_mas_items[]['guid'] - Уникальный илентификатор элемента, наиболее часто знаение эквивалентно $rss_mas_items[]['link']
    • $rss_mas_items[]['enclosure'][0]['url'] - URL вложения
    • $rss_mas_items[]['enclosure'][0]['type'] - type вложения, если явно не указан - определяется автоматически
    • $rss_mas_items[]['enclosure'][0]['length'] - размер вложения в байтах, целое число
    
			
    $property
    
		
    массив дополнительных параметров 
    • $property['yandex:full-text'] вывод полного текста для Яндекс, по умолчанию false
    
			
    Возвращает
    
		
    сгенерированный XML в формате RSS 2.0
    
	
    [ Наверх ]
    

    



    RssWrite::str_for_rss
    


    
str_for_rss(
string
$str );

    




    Описание
    

    Преобразует строку для публикации в RSS, использует str_for_xml() и kernel::numeric_character_references()
    
		
    Принимаемые параметры
    
			
    $str
    
		
    строка
    
			
    Возвращает
    
		
    обработанная строка
    
	
    [ Наверх ]
    

    









Описания переменных



    









Описание констант класса