PEAR2/Net/RouterOS/Message.php

Go to the documentation of this file.

<?php

namespace PEAR2\Net\RouterOS;

use PEAR2\Net\Transmitter as T;

abstract class Message
{

    protected $arguments = array();

    private $_tag = null;

    public static function sanitizeArgumentName($name)
    {
        $name = (string) $name;
        if ((empty($name) && $name !== '0')
            || !preg_match('/[^=\s]/s', $name)
        ) {
            throw new InvalidArgumentException(
                'Invalid name of argument supplied.', 200
            );
        }
        return $name;
    }

    public static function sanitizeArgumentValue($value)
    {
        if (T\StreamTransmitter::isStream($value)) {
            $meta = stream_get_meta_data($value);
            if ($meta['seekable']) {
                return $value;
            }
            throw new InvalidArgumentException(
                'The stream must be seekable.', 201
            );
        } else {
            return (string) $value;
        }
    }

    public function getTag()
    {
        return $this->_tag;
    }

    protected function setTag($tag)
    {
        $this->_tag = (null === $tag) ? null : (string) $tag;
        return $this;
    }

    public function getArgument($name)
    {
        $name = self::sanitizeArgumentName($name);
        if (array_key_exists($name, $this->arguments)) {
            return $this->arguments[$name];
        }
        return null;
    }

    public function getAllArguments()
    {
        return $this->arguments;
    }

    protected function setArgument($name, $value = null)
    {
        if (null === $value) {
            unset($this->arguments[self::sanitizeArgumentName($name)]);
        } else {
            $this->arguments[self::sanitizeArgumentName($name)]
                = self::sanitizeArgumentValue($value);
        }
        return $this;
    }

    protected function removeAllArguments()
    {
        $this->arguments = array();
        return $this;
    }

}