class.tx_em_parser_mirrorxmlabstractparser.php

Go to the documentation of this file.

<?php
/***************************************************************
 *  Copyright notice
 *
 *  (c) 2010 Marcus Krause <marcus#exp2010@t3sec.info>
 *         Steffen Kamper <info@sk-typo3.de>
 *  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!
 ***************************************************************/
/**
 * class.tx_em_parser_mirrorxmlabstractparser.php
 *
 * Module: Extension manager - mirror.xml abstract parser
 *
 * $Id: class.tx_em_parser_mirrorxmlabstractparser.php 1913 2010-02-21 15:47:37Z mkrause $
 *
 * @author  Marcus Krause <marcus#exp2010@t3sec.info>
 * @author  Steffen Kamper <info@sk-typo3.de>
 */


/**
 * Abstract parser for TYPO3's mirror.xml file.
 *
 * @author    Marcus Krause <marcus#exp2010@t3sec.info>
 * @author    Steffen Kamper <info@sk-typo3.de>
 *
 * @since      2010-02-09
 * @package  TYPO3
 * @subpackage  EM
 */
abstract class tx_em_Parser_MirrorXmlAbstractParser extends tx_em_Parser_XmlAbstractParser {


    /**
     * Keeps country of currently processed mirror.
     *
     * @var  string
     */
    protected $country = NULL;

    /**
     * Keeps hostname of currently processed mirror.
     *
     * @var  string
     */
    protected $host = NULL;

    /**
     * Keeps path to mirrored TER of currently processed mirror.
     *
     * @var  string
     */
    protected $path = NULL;

    /**
     * Keeps sponsor link of currently processed mirror.
     *
     * @var  string
     */
    protected $sponsorlink = NULL;

    /**
     * Keeps sponsor logo location of currently processed mirror.
     *
     * @var  string
     */
    protected $sponsorlogo = NULL;

    /**
     * Keeps sponsor name of currently processed mirror.
     *
     * @var  string
     */
    protected $sponsorname = NULL;

    /**
     * Keeps title of currently processed mirror.
     *
     * @var  string
     */
    protected $title = NULL;


    /**
     * Returns an assoziative array of all mirror properties.
     *
     * Valid array keys of returned array are:
     * country, host, path, sponsorlink, sponsorlogo, sponsorname, title
     *
     * @access  public
     * @return  array  assoziative array of a mirror's properties
     * @see  $country, $host, $path, $sponsorlink, $sponsorlogo, $sponsorname, $title
     */
    public function getAll() {
        $mirrorProperties = array();
        $mirrorProperties['title'] = $this->title;
        $mirrorProperties['host'] = $this->host;
        $mirrorProperties['path'] = $this->path;
        $mirrorProperties['country'] = $this->country;
        $mirrorProperties['sponsorname'] = $this->sponsorname;
        $mirrorProperties['sponsorlink'] = $this->sponsorlink;
        $mirrorProperties['sponsorlogo'] = $this->sponsorlogo;
        return $mirrorProperties;
    }

    /**
     * Returns country of currently processed mirror.
     *
     * @access  public
     * @return  string  name of country a mirror is located in
     * @see  $country, getAll()
     */
    public function getCountry() {
        return $this->country;
    }

    /**
     * Returns host of currently processed mirror.
     *
     * @access  public
     * @return  string  host name
     * @see  $host, getAll()
     */
    public function getHost() {
        return $this->host;
    }

    /**
     * Returns path to mirrored TER of currently processed mirror.
     *
     * @access  public
     * @return  string  path name
     * @see  $path, getAll()
     */
    public function getPath() {
        return $this->path;
    }

    /**
     * Returns sponsor link of currently processed mirror.
     *
     * @access  public
     * @return  string  URL of a sponsor's website
     * @see  $sponsorlink, getAll()
     */
    public function getSponsorlink() {
        return $this->sponsorlink;
    }

    /**
     * Returns sponsor logo location of currently processed mirror.
     *
     * @access  public
     * @return  string  a sponsor's logo location
     * @see  $sponsorlogo, getAll()
     */
    public function getSponsorlogo() {
        return $this->sponsorlogo;
    }

    /**
     * Returns sponsor name of currently processed mirror.
     *
     * @access  public
     * @return  string  name of sponsor
     * @see  $sponsorname, getAll()
     */
    public function getSponsorname() {
        return $this->sponsorname;
    }

    /**
     * Returns title of currently processed mirror.
     *
     * @access  public
     * @return  string  title of mirror
     * @see  $title, get All()
     */
    public function getTitle() {
        return $this->title;
    }

    /**
     * Method resets version class properties.
     *
     * @access  protected
     * @return  void
     * @see  $country, $host, $path, $sponsorlink, $sponsorlogo, $sponsorname, $title
     */
    protected function resetProperties() {
        $this->title = $this->host = $this->path =
                $this->country = $this->sponsorname = $this->sponsorlink =
                        $this->sponsorlogo;
    }

    /**
     * Method provides a wrapper for an exception call
     *
     * @access  protected
     * @param   string   $message  the exception message to throw.
     * @param   integer $code  the exception code.
     * @return  void
     */
    protected function throwException($message = "", $code = 0) {
        throw new tx_em_MirrorXmlException(get_class($this) . ': ' . $message, $code);
    }
}

if (defined('TYPO3_MODE') && isset($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['typo3/sysext/em/classes/parser/class.tx_em_parser_mirrorxmlabstractparser.php'])) {
    include_once($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['typo3/sysext/em/classes/parser/class.tx_em_parser_mirrorxmlabstractparser.php']);
}

?>