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         // Array elements for CSV data array
  26         const CRAWL_JOB_ARRAY_START_URL      = 'start_url';
  27         const CRAWL_JOB_ARRAY_DEPTH          = 'start_depth';
  28         const CRAWL_JOB_ARRAY_EXTERNAL_DEPTH = 'external_depth';
  29
  30         /**
  31          * Protected constructor
  32          *
  33          * @param       $className      Name of the class
  34          * @return      void
  35          */
  36         protected function __construct ($className) {
  37                 // Call parent constructor
  38                 parent::__construct($className);
  39         }
  40
  41         /**
  42          * Initalizes this source
  43          *
  44          * @param       $prefix                 Prefix for this source
  45          * @param       $sourceName             Name of this source
  46          * @return      void
  47          */
  48         protected function initSource ($prefix, $sourceName) {
  49                 // Use another object factory
  50                 $stackInstance = FileStackFactory::createFileStackInstance($prefix . '_url', $sourceName);
  51
  52                 // Set the stack here
  53                 $this->setStackInstance($stackInstance);
  54         }
  55
  56         /**
  57          * Determines whether the stack 'urls' is empty.
  58          *
  59          * @return      $isEmpty        Whether the stack 'urls' is empty.
  60          */
  61         protected function isUrlStackEmpty () {
  62                 // Determine it
  63                 $isEmpty = $this->getStackInstance()->isStackEmpty('urls');
  64
  65                 // Return result
  66                 return $isEmpty;
  67         }
  68 }
  69
  70 // [EOF]
  71 ?>