application/hub/main/source/class_BaseUrlSource.php

   1 <?php
   2 /**
   3  * A general URL source class
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.shipsimu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 class BaseUrlSource extends BaseSource {
  25         /**
  26          * Protected constructor
  27          *
  28          * @param       $className      Name of the class
  29          * @return      void
  30          */
  31         protected function __construct ($className) {
  32                 // Call parent constructor
  33                 parent::__construct($className);
  34         }
  35
  36         /**
  37          * Initalizes this source
  38          *
  39          * @param       $prefix                 Prefix for this source
  40          * @param       $sourceName             Name of this source
  41          * @return      void
  42          */
  43         protected function initSource ($prefix, $sourceName) {
  44                 // Use another object factory
  45                 $stackInstance = FileStackFactory::createFileStackInstance($prefix . '_url', $sourceName);
  46
  47                 // Set the stack here
  48                 $this->setStackInstance($stackInstance);
  49         }
  50
  51         /**
  52          * Determines whether the stack 'urls' is empty.
  53          *
  54          * @return      $isEmpty        Whether the stack 'urls' is empty.
  55          */
  56         protected function isUrlStackEmpty () {
  57                 // Determine it
  58                 $isEmpty = $this->getStackInstance()->isStackEmpty('urls');
  59
  60                 // Return result
  61                 return $isEmpty;
  62         }
  63 }
  64
  65 // [EOF]
  66 ?>