3 * A !!! protocol resolver class
5 * @author Roland Haeder <webmaster@shipsimu.org>
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
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.
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.
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/>.
24 class !!!ProtocolResolver extends BaseProtocolResolver implements ProtocolResolver, Registerable {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
36 * Creates an instance of a !!! protocol resolver
38 * @return $resolverInstance The prepared command resolver instance
40 public static final function create!!!ProtocolResolver () {
41 // Create the new instance
42 $resolverInstance = new !!!ProtocolResolver();
44 // Return the prepared instance
45 return $resolverInstance;
49 * Returns an instance of a LocateableNode class for a given NodeHelper
50 * instance or null if it was not found.
52 * @param $nodeInstance An instance of a NodeHelper class
53 * @return $unlInstance An instance of a LocateableNode class
56 public function resolveUniversalNodeLocatorFromNodeHelper (NodeHelper $nodeInstance) {
57 $this->partialStub('Please implement this method. nodeInstance=' . $nodeInstance->__toString());
61 * Returns the UNL as string from given configuration key.
63 * @param $configKey Configuration key for UNL address (valid: internal,external)
64 * @return $unl Universal node locator
67 public function resolveUniversalNodeLocatorFromConfigKey ($configKey) {
69 $unl = sprintf('%s://%s',
70 $this->getProtocolName(),
71 $this->getConfigInstance()->getConfigEntry($configKey . '_address')
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.