From ec670451fafdd675c346232d6580c8f291a23d3e Mon Sep 17 00:00:00 2001 From: Roland Haeder Date: Tue, 23 Dec 2014 23:45:10 +0100 Subject: [PATCH] A much better name is HandleableProtocol. MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Roland Häder --- .../socket/class_NoSocketRegisteredException.php | 2 +- ...rotocolHandler.php => class_HandleableProtocol.php} | 4 ++-- .../registry/socket/class_RegisterableSocket.php | 8 ++++---- inc/classes/main/class_BaseFrameworkSystem.php | 10 +++++----- .../main/container/socket/class_SocketContainer.php | 4 ++-- .../main/factories/client/class_ClientFactory.php | 2 +- 6 files changed, 15 insertions(+), 15 deletions(-) rename inc/classes/interfaces/handler/protocol/{class_ProtocolHandler.php => class_HandleableProtocol.php} (91%) diff --git a/inc/classes/exceptions/socket/class_NoSocketRegisteredException.php b/inc/classes/exceptions/socket/class_NoSocketRegisteredException.php index b919e558..e8d84753 100644 --- a/inc/classes/exceptions/socket/class_NoSocketRegisteredException.php +++ b/inc/classes/exceptions/socket/class_NoSocketRegisteredException.php @@ -25,7 +25,7 @@ class NoSocketRegisteredException extends AbstractSocketException { /** * A Constructor for this exception * - * @param $protocolInstance An instance of a ProtocolHandler class + * @param $protocolInstance An instance of a HandleableProtocol class * @param $code Error code * @return void */ diff --git a/inc/classes/interfaces/handler/protocol/class_ProtocolHandler.php b/inc/classes/interfaces/handler/protocol/class_HandleableProtocol.php similarity index 91% rename from inc/classes/interfaces/handler/protocol/class_ProtocolHandler.php rename to inc/classes/interfaces/handler/protocol/class_HandleableProtocol.php index ed8c11e3..8cfe6d60 100644 --- a/inc/classes/interfaces/handler/protocol/class_ProtocolHandler.php +++ b/inc/classes/interfaces/handler/protocol/class_HandleableProtocol.php @@ -21,9 +21,9 @@ * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ -interface ProtocolHandler extends Handleable { +interface HandleableProtocol extends Handleable { /** - * Getter for port number to satify ProtocolHandler + * Getter for port number to satify HandleableProtocol * * @return $port The port number */ diff --git a/inc/classes/interfaces/registry/socket/class_RegisterableSocket.php b/inc/classes/interfaces/registry/socket/class_RegisterableSocket.php index 62ac1874..1f197295 100644 --- a/inc/classes/interfaces/registry/socket/class_RegisterableSocket.php +++ b/inc/classes/interfaces/registry/socket/class_RegisterableSocket.php @@ -26,7 +26,7 @@ interface RegisterableSocket extends Registerable { * Checks whether given socket resource is registered. If $socketResource is * FALSE only the instance will be checked. * - * @param $protocolInstance An instance of a ProtocolHandler class + * @param $protocolInstance An instance of a HandleableProtocol class * @param $socketResource A valid socket resource * @return $isRegistered Whether the given socket resource is registered */ @@ -35,7 +35,7 @@ interface RegisterableSocket extends Registerable { /** * Registeres given socket for listener or throws an exception if it is already registered * - * @param $protocolInstance An instance of a ProtocolHandler class + * @param $protocolInstance An instance of a HandleableProtocol class * @param $socketResource A valid socket resource * @return void * @throws SocketAlreadyRegisteredException If the given socket is already registered @@ -45,7 +45,7 @@ interface RegisterableSocket extends Registerable { /** * Getter for given listener's socket resource * - * @param $protocolInstance An instance of a ProtocolHandler class + * @param $protocolInstance An instance of a HandleableProtocol class * @return $socketResource A valid socket resource * @throws NoSocketRegisteredException If the requested socket is not registered */ @@ -55,7 +55,7 @@ interface RegisterableSocket extends Registerable { * "Getter" for protocol/connection instance from given package data * * @param $packageData Raw package data - * @return $protocolInstance An instance of a ProtocolHandler class + * @return $protocolInstance An instance of a HandleableProtocol class */ function getHandlerInstanceFromPackageData (array $packageData); } diff --git a/inc/classes/main/class_BaseFrameworkSystem.php b/inc/classes/main/class_BaseFrameworkSystem.php index d5a56141..07e9a2c6 100644 --- a/inc/classes/main/class_BaseFrameworkSystem.php +++ b/inc/classes/main/class_BaseFrameworkSystem.php @@ -129,7 +129,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { private $parserInstance = NULL; /** - * A ProtocolHandler instance + * A HandleableProtocol instance */ private $protocolInstance = NULL; @@ -1018,9 +1018,9 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { } /** - * Setter for ProtocolHandler instance + * Setter for HandleableProtocol instance * - * @param $protocolInstance An instance of an ProtocolHandler + * @param $protocolInstance An instance of an HandleableProtocol * @return void */ public final function setProtocolInstance (ProtocolHandler $protocolInstance = NULL) { @@ -1028,9 +1028,9 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { } /** - * Getter for ProtocolHandler instance + * Getter for HandleableProtocol instance * - * @return $protocolInstance An instance of an ProtocolHandler + * @return $protocolInstance An instance of an HandleableProtocol */ public final function getProtocolInstance () { return $this->protocolInstance; diff --git a/inc/classes/main/container/socket/class_SocketContainer.php b/inc/classes/main/container/socket/class_SocketContainer.php index 0cec3448..bfc3bd2c 100644 --- a/inc/classes/main/container/socket/class_SocketContainer.php +++ b/inc/classes/main/container/socket/class_SocketContainer.php @@ -36,11 +36,11 @@ class SocketContainer extends BaseContainer implements Registerable { * Creates an instance of this Container class and prepares it for usage * * @param $socketResource A valid socket resource - * @param $protocolInstance A ProtocolHandler instance + * @param $protocolInstance A HandleableProtocol instance * @param $packageData Raw package data * @return $containerInstance An instance of this Container class */ - public static final function createSocketContainer ($socketResource, ProtocolHandler $protocolInstance = NULL, array $packageData = array()) { + public static final function createSocketContainer ($socketResource, HandleableProtocol $protocolInstance = NULL, array $packageData = array()) { // Get a new instance $containerInstance = new SocketContainer(); diff --git a/inc/classes/main/factories/client/class_ClientFactory.php b/inc/classes/main/factories/client/class_ClientFactory.php index 544ef8f1..3ef532d1 100644 --- a/inc/classes/main/factories/client/class_ClientFactory.php +++ b/inc/classes/main/factories/client/class_ClientFactory.php @@ -36,7 +36,7 @@ class ClientFactory extends ObjectFactory { * Creates a client object for given protocol. This method uses the * registry pattern to cache those instances. * - * @param $protocolInstance An instance of a ProtocolHandler class to create a client object for (e.g. 'http' for a HTTP/1.1 client) + * @param $protocolInstance An instance of a HandleableProtocol class to create a client object for (e.g. 'http' for a HTTP/1.1 client) * @param $socketResource A valid socket resource (optional) * @return $clientInstance An instance of the requested client */ -- 2.39.5