3 * A SelfConnectTag filter for packages
5 * @author Roland Haeder <webmaster@shipsimu.org>
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
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 PackageSelfConnectTagFilter extends BaseNodeFilter implements FilterablePackage {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
35 $this->dataXmlNodes = array(
36 XmlSelfConnectTemplateEngine::SELF_CONNECT_DATA_NODE_ID => '',
37 XmlSelfConnectTemplateEngine::SELF_CONNECT_DATA_SESSION_ID => '',
42 * Creates an instance of this filter class
44 * @return $filterInstance An instance of this filter class
46 public final static function createPackageSelfConnectTagFilter () {
48 $filterInstance = new PackageSelfConnectTagFilter();
50 // Return the instance
51 return $filterInstance;
55 * Executes the filter with given request and response objects
57 * @param $requestInstance An instance of a class with an Requestable interface
58 * @param $responseInstance An instance of a class with an Responseable interface
60 * @throws UnsupportedOperationException If this method is called, please use processMessage() instead!
62 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
63 // Please don't call this method
64 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
68 * Processes the given raw message content. The method renderXmlContent
69 * may throw (not the method itself) several exceptions:
71 * InvalidXmlNodeException - If an invalid XML node has been found (e.g.
72 * wrong/out-dated template used)
73 * XmlNodeMismatchException - Again might be caused by invalid XML node
75 * XmlParserException - If the XML message is damaged or not
78 * @param $messageData Raw message data array
79 * @param $packageInstance An instance of a Receivable class
82 public function processMessage (array $messageData, Receivable $packageInstance) {
84 $this->genericProcessMessage('self_connect', $messageData, $packageInstance);
88 * Post-processes the stacked message. Do not call popNamed() as then no
89 * other class can process the message.
91 * @param $packageInstance An instance of a Receivable class
93 * @throws UnsupportedOperationException If this method is called, please use processMessage() instead!
95 public function postProcessMessage (Receivable $packageInstance) {
96 // Please don't call this method
97 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);