Updated 'core' + renamed 'main' -> 'classes'.
[hub.git] / application / hub / classes / resolver / protocol / class_
1 <?php
2 /**
3  * A !!! protocol resolver class
4  *
5  * @author              Roland Haeder <webmaster@shipsimu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 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 !!!ProtocolResolver extends BaseProtocolResolver implements ProtocolResolver, Registerable {
25         /**
26          * Protected constructor
27          *
28          * @return      void
29          */
30         protected function __construct () {
31                 // Call parent constructor
32                 parent::__construct(__CLASS__);
33         }
34
35         /**
36          * Creates an instance of a !!! protocol resolver
37          *
38          * @return      $resolverInstance       The prepared command resolver instance
39          */
40         public static final function create!!!ProtocolResolver () {
41                 // Create the new instance
42                 $resolverInstance = new !!!ProtocolResolver();
43
44                 // Return the prepared instance
45                 return $resolverInstance;
46         }
47
48         /**
49          * Returns an instance of a LocateableNode class for a given NodeHelper
50          * instance or null if it was not found.
51          *
52          * @param       $nodeInstance   An instance of a NodeHelper class
53          * @return      $unlInstance    An instance of a LocateableNode class
54          * @todo        0% done
55          */
56         public function resolveUniversalNodeLocatorFromNodeHelper (NodeHelper $nodeInstance) {
57                 $this->partialStub('Please implement this method. nodeInstance=' . $nodeInstance->__toString());
58         }
59
60         /**
61          * Returns the UNL as string from given configuration key.
62          *
63          * @param       $configKey      Configuration key for UNL address (valid: internal,external)
64          * @return      $unl            Universal node locator
65          * @todo        90% done
66          */
67         public function resolveUniversalNodeLocatorFromConfigKey ($configKey) {
68                 // Put all together
69                 $unl = sprintf('%s://%s',
70                         $this->getProtocolName(),
71                         $this->getConfigInstance()->getConfigEntry($configKey . '_address')
72                 );
73
74                 /*
75                  * And return it. Please note that e.g. a FaxProtocolResolver will
76                  * return a different UNL and therefore all protocol resolvers must do
77                  * it on their own way.
78                  */
79                 return $unl;
80         }
81 }
82
83 // [EOF]
84 ?>