application/hub/main/handler/protocol/class_BaseProtocolHandler.php

   1 <?php
   2 /**
   3  * A general handler for protocols such as TCP, UDP and others.
   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 BaseProtocolHandler extends BaseHandler {
  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          * Validates given UNL very basicly by given regular expression. You
  38          * normally don't need/want to overwrite this method as this is a very basic
  39          * validation only based on a regex.
  40          *
  41          * @param       $unl            Universal Node Locator to validate
  42          * @param       $regex          Regular expression to use for validation without slashes
  43          * @return      $isValid        Whether the UNL is valid
  44          */
  45         protected final function isValidUniversalNodeLocator ($unl, $regex) {
  46                 // Debug message
  47                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']: unl=' . $unl . ',regex=' . $regex . ' - CALLED!');
  48
  49                 // Very basic regex check
  50                 $isValid = (preg_match('/^' . $regex . '$/', $unl) === 1);
  51
  52                 // Return result
  53                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']: isValid=' . intval($isValid) . ' - EXIT!');
  54                 return $isValid;
  55         }
  56 }
  57
  58 // [EOF]
  59 ?>