Source of file OutgoingMessage.php

Size: 2,478 Bytes - Last Modified: 2019-11-07T18:53:25+00:00

/data/development/sccp/sources/PAMI/src/PAMI/Message/OutgoingMessage.php

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687
<?php
/**
 * A generic outgoing message.
 *
 * PHP Version 5
 *
 * @category Pami
 * @package  Message
 * @author   Marcelo Gornstein <marcelog@gmail.com>
 * @license  http://marcelog.github.com/PAMI/ Apache License 2.0
 * @version  SVN: $Id$
 * @link     http://marcelog.github.com/PAMI/
 *
 * Copyright 2011 Marcelo Gornstein <marcelog@gmail.com>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */
namespace PAMI\Message;

use PAMI\Exception\PAMIException;

/**
 * A generic outgoing message.
 *
 * PHP Version 5
 *
 * @category Pami
 * @package  Message
 * @author   Marcelo Gornstein <marcelog@gmail.com>
 * @license  http://marcelog.github.com/PAMI/ Apache License 2.0
 * @link     http://marcelog.github.com/PAMI/
 */
abstract class OutgoingMessage extends Message
{
    /**
     * String of the Class name to handle the Response to this Message
     *
     * @var string
     */
    private $responseHandler = null;

    /**
     * Returns the class name of the response handler.
     *
     * @return string|null
     */
    public function getResponseHandler()
    {
        return $this->responseHandler;
    }

    /**
     * Set the response handler.
     *
     * @param string $responseHandler
     *
     * @return void
     * @throws PAMIException
     */
    public function setResponseHandler($newResponseHandler)
    {
        /*if (class_exists($newResponseHandler) && is_a($newResponseHandler, '\PAMI\Message\Response\Response', true)) {
            $this->responseHandler = $newResponseHandler;
            return;
        }*/

        $className = '\\PAMI\\Message\\Response\\' . $newResponseHandler . 'Response';
        if (class_exists($className, true) && is_a($className, '\PAMI\Message\Response\Response', true)) {
            $this->responseHandler = $className;
            return;
        }

        throw new PAMIException('ResponseHandler '.$className.' could not be found. Please provide a fully qualified class name.');
    }
}