3 * A AnnouncementAnswerTag filter for Package
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Hub Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.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 PackageAnnouncementAnswerTagFilter extends BaseNodeFilter implements FilterablePackage {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
35 $this->dataXmlNodes = array(
36 XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_EXTERNAL_IP => '',
37 XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_INTERNAL_IP => '',
38 XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_NODE_STATUS => '',
39 XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_SESSION_ID => '',
40 XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_TCP_PORT => 9060,
41 XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_UDP_PORT => 9060,
42 XmlAnnouncementAnswerTemplateEngine::ANNOUNCEMENT_DATA_ANSWER_STATUS => '',
47 * Creates an instance of this filter class
49 * @return $filterInstance An instance of this filter class
51 public final static function createPackageAnnouncementAnswerTagFilter () {
53 $filterInstance = new PackageAnnouncementAnswerTagFilter();
55 // Return the instance
56 return $filterInstance;
60 * Executes the filter with given request and response objects
62 * @param $requestInstance An instance of a class with an Requestable interface
63 * @param $responseInstance An instance of a class with an Responseable interface
65 * @throws UnsupportedOperationException If this method is called, please use processMessage() instead!
67 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
68 // Please don't call this method
69 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
73 * Processes the given raw message content. The method renderXmlContent
74 * may throw (not the method itself) several exceptions:
76 * InvalidXmlNodeException - If an invalid XML node has been found (e.g.
77 * wrong/out-dated template used)
78 * XmlNodeMismatchException - Again might be caused by invalid XML node
80 * XmlParserException - If the XML message is damaged or not
83 * @param $messageContent Raw message content
84 * @param $packageInstance An instance of a Receivable class
86 * @todo Exceptions from renderXmlContent() are currently unhandled
88 public function processMessage ($messageContent, Receivable $packageInstance) {
89 // Process message in generic way
90 $this->genericProcessMessage('announcement_answer', $messageContent, $packageInstance);