/**
* An Announcement template engine class for XML templates
*
- * @author Roland Haeder <webmaster@ship-simu.org>
+ * @author Roland Haeder <webmaster@shipsimu.org>
* @version 0.0.0
- * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
+ * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 Core Developer Team
* @license GNU GPL 3.0 or any newer version
- * @link http://www.ship-simu.org
+ * @link http://www.shipsimu.org
* @todo This template engine does not make use of setTemplateType()
*
* This program is free software: you can redistribute it and/or modify
/**
* Some XML nodes must be available for later data extraction
*/
- const ANNOUNCEMENT_DATA_SESSION_ID = 'session-id';
- const ANNOUNCEMENT_DATA_NODE_STATUS = 'node-status';
- const ANNOUNCEMENT_DATA_NODE_MODE = 'node-mode';
- const ANNOUNCEMENT_DATA_EXTERNAL_IP = 'external-ip';
- const ANNOUNCEMENT_DATA_INTERNAL_IP = 'internal-ip';
- const ANNOUNCEMENT_DATA_TCP_PORT = 'tcp-port';
- const ANNOUNCEMENT_DATA_UDP_PORT = 'udp-port';
+ const ANNOUNCEMENT_DATA_SESSION_ID = 'session-id';
+ const ANNOUNCEMENT_DATA_NODE_STATUS = 'node-status';
+ const ANNOUNCEMENT_DATA_NODE_MODE = 'node-mode';
+ const ANNOUNCEMENT_DATA_EXTERNAL_ADDRESS = 'external-address';
+ const ANNOUNCEMENT_DATA_INTERNAL_ADDRESS = 'internal-address';
+ const ANNOUNCEMENT_DATA_LISTEN_PORT = 'listen-port';
/**
* Protected constructor
'listener',
self::ANNOUNCEMENT_DATA_NODE_STATUS,
self::ANNOUNCEMENT_DATA_NODE_MODE,
- self::ANNOUNCEMENT_DATA_TCP_PORT,
- self::ANNOUNCEMENT_DATA_UDP_PORT,
+ self::ANNOUNCEMENT_DATA_LISTEN_PORT,
self::ANNOUNCEMENT_DATA_SESSION_ID,
- self::ANNOUNCEMENT_DATA_EXTERNAL_IP,
- self::ANNOUNCEMENT_DATA_INTERNAL_IP,
+ self::ANNOUNCEMENT_DATA_EXTERNAL_ADDRESS,
+ self::ANNOUNCEMENT_DATA_INTERNAL_ADDRESS,
'object-type-list',
);
}
// Is this string empty?
if (empty($characters)) {
// Then skip it silently
- return false;
+ return;
} // END - if
/*
* Assign the found characters to variable and use the last entry from
* stack as the name.
*/
- parent::assignVariable($this->getStackerInstance()->getNamed('node_announcement'), $characters);
+ parent::assignVariable($this->getStackInstance()->getNamed('node_announcement'), $characters);
}
/**
*/
protected function startAnnouncement () {
// Push the node name on the stacker
- $this->getStackerInstance()->pushNamed('node_announcement', 'node_announcement');
+ $this->getStackInstance()->pushNamed('node_announcement', 'announcement');
}
/**
*/
protected function startAnnouncementData () {
// Push the node name on the stacker
- $this->getStackerInstance()->pushNamed('node_announcement', 'announcement-data');
+ $this->getStackInstance()->pushNamed('node_announcement', 'announcement-data');
}
/**
*/
protected function startNodeStatus () {
// Push the node name on the stacker
- $this->getStackerInstance()->pushNamed('node_announcement', self::ANNOUNCEMENT_DATA_NODE_STATUS);
+ $this->getStackInstance()->pushNamed('node_announcement', self::ANNOUNCEMENT_DATA_NODE_STATUS);
}
/**
*/
protected function startNodeMode () {
// Push the node name on the stacker
- $this->getStackerInstance()->pushNamed('node_announcement', self::ANNOUNCEMENT_DATA_NODE_MODE);
+ $this->getStackInstance()->pushNamed('node_announcement', self::ANNOUNCEMENT_DATA_NODE_MODE);
}
/**
*/
protected function startListener () {
// Push the node name on the stacker
- $this->getStackerInstance()->pushNamed('node_announcement', 'listener');
+ $this->getStackInstance()->pushNamed('node_announcement', 'listener');
}
/**
- * Starts the TCP port
+ * Starts the TCP/UDP listen port
*
* @return void
*/
- protected function startTcpPort () {
+ protected function startListenPort () {
// Push the node name on the stacker
- $this->getStackerInstance()->pushNamed('node_announcement', self::ANNOUNCEMENT_DATA_TCP_PORT);
- }
-
- /**
- * Starts the UDP port
- *
- * @return void
- */
- protected function startUdpPort () {
- // Push the node name on the stacker
- $this->getStackerInstance()->pushNamed('node_announcement', self::ANNOUNCEMENT_DATA_UDP_PORT);
+ $this->getStackInstance()->pushNamed('node_announcement', self::ANNOUNCEMENT_DATA_LISTEN_PORT);
}
/**
*/
protected function startSessionId () {
// Push the node name on the stacker
- $this->getStackerInstance()->pushNamed('node_announcement', self::ANNOUNCEMENT_DATA_SESSION_ID);
+ $this->getStackInstance()->pushNamed('node_announcement', self::ANNOUNCEMENT_DATA_SESSION_ID);
}
/**
*
* @return void
*/
- protected function startExternalIp () {
+ protected function startExternalAddress () {
// Push the node name on the stacker
- $this->getStackerInstance()->pushNamed('node_announcement', self::ANNOUNCEMENT_DATA_EXTERNAL_IP);
+ $this->getStackInstance()->pushNamed('node_announcement', self::ANNOUNCEMENT_DATA_EXTERNAL_ADDRESS);
}
/**
*
* @return void
*/
- protected function startInternalIp () {
+ protected function startInternalAddress () {
// Push the node name on the stacker
- $this->getStackerInstance()->pushNamed('node_announcement', self::ANNOUNCEMENT_DATA_INTERNAL_IP);
+ $this->getStackInstance()->pushNamed('node_announcement', self::ANNOUNCEMENT_DATA_INTERNAL_ADDRESS);
}
/**
*/
protected function startObjectTypeList () {
// Push the node name on the stacker
- $this->getStackerInstance()->pushNamed('node_announcement', 'object-type-list');
+ $this->getStackInstance()->pushNamed('node_announcement', 'object-type-list');
}
/**
*/
protected function startObjectType () {
// Push the node name on the stacker
- $this->getStackerInstance()->pushNamed('node_announcement', 'object-type');
+ $this->getStackInstance()->pushNamed('node_announcement', 'object-type');
}
/**
*/
protected function finishObjectType () {
// Pop the last entry
- $this->getStackerInstance()->popNamed('node_announcement');
+ $this->getStackInstance()->popNamed('node_announcement');
}
/**
*/
protected function finishObjectTypeList () {
// Pop the last entry
- $this->getStackerInstance()->popNamed('node_announcement');
+ $this->getStackInstance()->popNamed('node_announcement');
}
/**
*/
protected function finishSessionId () {
// Pop the last entry
- $this->getStackerInstance()->popNamed('node_announcement');
+ $this->getStackInstance()->popNamed('node_announcement');
}
/**
*
* @return void
*/
- protected function finishInternalIp () {
+ protected function finishInternalAddress () {
// Pop the last entry
- $this->getStackerInstance()->popNamed('node_announcement');
+ $this->getStackInstance()->popNamed('node_announcement');
}
/**
*
* @return void
*/
- protected function finishExternalIp () {
- // Pop the last entry
- $this->getStackerInstance()->popNamed('node_announcement');
- }
-
- /**
- * Finishes the UDP port
- *
- * @return void
- */
- protected function finishUdpPort () {
+ protected function finishExternalAddress () {
// Pop the last entry
- $this->getStackerInstance()->popNamed('node_announcement');
+ $this->getStackInstance()->popNamed('node_announcement');
}
/**
- * Finishes the TCP port
+ * Finishes the TCP/UDP listen port
*
* @return void
*/
- protected function finishTcpPort () {
+ protected function finishListenPort () {
// Pop the last entry
- $this->getStackerInstance()->popNamed('node_announcement');
+ $this->getStackInstance()->popNamed('node_announcement');
}
/**
*/
protected function finishListener () {
// Pop the last entry
- $this->getStackerInstance()->popNamed('node_announcement');
+ $this->getStackInstance()->popNamed('node_announcement');
}
/**
*/
protected function finishNodeMode () {
// Pop the last entry
- $this->getStackerInstance()->popNamed('node_announcement');
+ $this->getStackInstance()->popNamed('node_announcement');
}
/**
*/
protected function finishNodeStatus () {
// Pop the last entry
- $this->getStackerInstance()->popNamed('node_announcement');
+ $this->getStackInstance()->popNamed('node_announcement');
}
/**
*/
protected function finishAnnouncementData () {
// Pop the last entry
- $this->getStackerInstance()->popNamed('node_announcement');
+ $this->getStackInstance()->popNamed('node_announcement');
}
/**
*/
protected function finishAnnouncement () {
// Pop the last entry
- $this->getStackerInstance()->popNamed('node_announcement');
+ $this->getStackInstance()->popNamed('node_announcement');
}
}