Initial commit

typo3conf/ext/dd_googlesitemap/Classes/Renderers/AbstractSitemapRenderer.php

@@ -0,0 +1,73 @@
+<?php
+/***************************************************************
+*  Copyright notice
+*
+*  (c) 2009-2014 Dmitry Dulepov <dmitry.dulepov@gmail.com>
+*  All rights reserved
+*
+*  This script is part of the TYPO3 project. The TYPO3 project is
+*  free software; you can redistribute it and/or modify
+*  it under the terms of the GNU General Public License as published by
+*  the Free Software Foundation; either version 2 of the License, or
+*  (at your option) any later version.
+*
+*  The GNU General Public License can be found at
+*  http://www.gnu.org/copyleft/gpl.html.
+*
+*  This script is distributed in the hope that it will be useful,
+*  but WITHOUT ANY WARRANTY; without even the implied warranty of
+*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+*  GNU General Public License for more details.
+*
+*  This copyright notice MUST APPEAR in all copies of the script!
+***************************************************************/
+
+namespace DmitryDulepov\DdGooglesitemap\Renderers;
+
+/**
+ * This class contains an abstract renderer for sitemaps.
+ *
+ * NOTE: interface is internal and it is not stable. Any XCLASS is not guarantied
+ * to work!
+ *
+ * @author	Dmitry Dulepov <dmitry.dulepov@gmail.com>
+ * @package	TYPO3
+ * @subpackage	tx_ddgooglesitemap
+ */
+abstract class AbstractSitemapRenderer {
+
+	/**
+	 * Creates start XML tags (including XML prologue) for the sitemap.
+	 *
+	 * @return	string	Start tags
+	 */
+	abstract public function getStartTags();
+
+	/**
+	 * Renders one single entry according to the format of this sitemap.
+	 *
+	 * @param	string	$url	URL of the entry
+	 * @param	string	$title	Title of the entry
+	 * @param	int	$lastModification	News publication time (Unix timestamp)
+	 * @param	string	$changeFrequency	Unused for news
+	 * @param	string	$keywords	Keywords for this entry
+	 * @param	mixed	$priority	Priority (numeric, 1-10, if passed)
+	 * @return	string	Generated entry content
+	 * @see tx_ddgooglesitemap_abstract_renderer::renderEntry()
+	 */
+	abstract public function renderEntry($url, $title, $lastModification = 0, $changeFrequency = '', $keywords = '', $priority = '');
+
+	/**
+	 * Creates end XML tags for this sitemap.
+	 *
+	 * @return	string	End XML tags
+	 */
+	abstract public function getEndTags();
+
+}
+
+/** @noinspection PhpUndefinedVariableInspection */
+if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['ext/dd_googlesitemap/renderers/class.tx_ddgooglesitemap_abstract_renderer.php'])	{
+	/** @noinspection PhpIncludeInspection */
+	include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['ext/dd_googlesitemap/renderers/class.tx_ddgooglesitemap_abstract_renderer.php']);
+}