AppserverIo\RemoteMethodInvocation\RemoteMethodCall

Complexity

Total Complexity

13

Size/Duplication

Total Lines	204
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

27.27%

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	addParameter()	0	4	1
A	getParameter()	0	4	1
A	getParameters()	0	4	1
A	getClassName()	0	4	1
A	getMethodName()	0	4	1
A	getSessionId()	0	4	1
A	setAddress()	0	4	1
A	getAddress()	0	4	1
A	setAppName()	0	4	1
A	getAppName()	0	4	1
A	setPort()	0	4	1
A	getPort()	0	4	1

<?php

/**
 * AppserverIo\RemoteMethodInvocation\RemoteMethodCall
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 *
 * PHP version 5
 *
 * @author    Tim Wagner <tw@appserver.io>
 * @copyright 2015 TechDivision GmbH <info@appserver.io>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/appserver-io/rmi
 * @link      http://www.appserver.io
 */

namespace AppserverIo\RemoteMethodInvocation;

/**
 * The remote method call implementation.
 *
 * @author    Tim Wagner <tw@appserver.io>
 * @copyright 2015 TechDivision GmbH <info@appserver.io>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/appserver-io/rmi
 * @link      http://www.appserver.io
 */
class RemoteMethodCall implements RemoteMethodInterface
{

    /**
     * The name of the webapp this call originates from
     *
     * @var string
     */
    protected $appName;

    /**
     * The class name to invoke the method on.
     *
     * @var string
     */
    protected $className = null;

    /**
     * The method name to invoke on the class.
     *
     * @var string
     */
    protected $methodName = null;

    /**
     * Parameters for the method.
     *
     * @var array
     */
    protected $parameters = array();

    /**
     * The session ID to use for the method call.
     *
     * @var string
     */
    protected $sessionId = null;

    /**
     * The client's socket server IP address to send the response to.
     *
     * @var string
     */
    protected $address = '127.0.0.1';

    /**
     * The client's socket server port to send the response to.
     *
     * @var integer
     */
    protected $port = 0;

    /**
     * Initialize the instance with the necessary params.
     *
     * @param string $className  The class name to invoke the method on
     * @param string $methodName The method name to invoke
     * @param string $sessionId  The session ID to use for the method call
     */
    public function __construct($className, $methodName, $sessionId = null)
    {
        $this->className = $className;
        $this->methodName = $methodName;
        $this->sessionId = $sessionId;
    }

    /**
     * Adds passed parameter to the array with the parameters.
     *
     * @param integer $key   The parameter name
     * @param mixed   $value The parameter value
     *
     * @return void
     */
    public function addParameter($key, $value)
    {
        $this->parameters[$key] = $value;
    }

    /**
     * Returns the parameter with the passed key.
     *
     * @param string $key The name of the parameter to return
     *
     * @return mixed The parameter's value
     * @see \AppserverIo\RemoteMethodInvocation\RemoteMethodInterface::getParameter()
     */
    public function getParameter($key)
    {
        return $this->parameters[$key];
    }

    /**
     * Returns the parameters for the method.
     *
     * @return array The method's parameters
     * @see \AppserverIo\RemoteMethodInvocation\RemoteMethodInterface::getParameters()
     */
    public function getParameters()
    {
        return $this->parameters;
    }

    /**
     * Returns the class name to invoke the method on.
     *
     * @return string The class name
     * @see \AppserverIo\RemoteMethodInvocation\RemoteMethodInterface::getClassName()
     */
    public function getClassName()
    {
        return $this->className;
    }

    /**
     * Returns the method name to invoke on the class.
     *
     * @return string The method name
     * @see \AppserverIo\RemoteMethodInvocation\RemoteMethodInterface::getMethodName()
     */
    public function getMethodName()
    {
        return $this->methodName;
    }

    /**
     * Returns the session ID to use for the method call.
     *
     * @return string The session ID
     * @see \AppserverIo\RemoteMethodInvocation\RemoteMethodInterface::getSessionId()
     */
    public function getSessionId()
    {
        return $this->sessionId;
    }

    /**
     * Sets the client's socket server IP address.
     *
     * @param string $address The client's socket server IP address
     *
     * @return void
     */
    public function setAddress($address)
    {
        $this->address = $address;
    }

    /**
     * Returns the client's server socket IP address.
     *
     * @return string The client's server socket IP address
     * @see \AppserverIo\RemoteMethodInvocation\RemoteMethodInterface::getAddress()
     */
    public function getAddress()
    {
        return $this->address;
    }

    /**
     * Sets the webapp name the call comes from
     *
     * @param string $appName Name of the webapp using this client connection
     *
     * @return void
     */
    public function setAppName($appName)
    {
        $this->appName = $appName;
    }

    /**
     * Returns the name of the webapp this call comes from
     *
     * @return string The webapp name
     */
    public function getAppName()
    {
        return $this->appName;
    }

    /**
     * Sets the client's socket server port.
     *
     * @param integer $port The client's socket server port
     *
     * @return void
     */
    public function setPort($port)
    {
        $this->port = $port;
    }

    /**
     * Returns the client's server socket port.
     *
     * @return string The client's server socket port
     * @see \AppserverIo\RemoteMethodInvocation\RemoteMethodInterface::getPort()
     */
    public function getPort()
    {
        return $this->port;
    }
}