Overview

Namespaces

  • Apptus
    • ESales
      • Connector
        • Report
        • Time
    • Util
      • Cache
  • PHP
  • Overview
  • Namespace
  • Class
  • Tree
  1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 
<?php
namespace Apptus\ESales\Connector;

/**
 * Convenience class for passing arguments to a panel request.
 * Automaticly casts all keys and values to strings.
 *
 */
class ArgMap implements \ArrayAccess, \Countable, \IteratorAggregate {
    private $data = array ();

    /**
     * Put an argument into the ArgMap. Both the key and the value will be casted to strings.
     *
     * Alternative syntax:<br />
     * $argmap[$key] = $value;
     *
     * @param mixed
     * @param mixed
     */
    public function put($key, $value) {
        $valueStr = $value === null? null : (string)$value;
        $this->data[(string)$key] = $valueStr;
    }

    /**
     * Put all arguments from an array or another ArgMap into the ArgMap.
     *
     * @param array|ArgMap|null
     */
    public function putAll($args) {
        if ($args === null) {
            return;
        }
        if ($args instanceof ArgMap) {
            $args = $args->getArgs();
        }
        if (!is_array($args)) {
            $type = gettype($args) === 'object' ? get_class($args) : gettype($args);
            throw new \InvalidArgumentException('Array or ArgMap expected, got: ' . $type);
        }
        foreach ($args as $key => $value) {
            $this->put($key, $value);
        }
    }

    /**
     * Check if a key exists in the ArgMap.
     *
     * Alternative syntax:<br />
     * isset($argmap[$key]);
     *
     * @param mixed
     *            The key to check.
     * @return boolean
     *            True if the key exists in the ArgMap, false otherwise.
     */
    public function hasKey($key) {
        return isset($this->data[(string) $key]);
    }

    /**
     * Get the value for a key.
     *
     * Alternative syntax:<br />
     * $argmap[$key];
     *
     * @param mixed
     *            Key to get the value for.
     * @param mixed
     *            What to return if the key is not in the ArgMap. Defaults to null.
     * @return string|mixed
     *            The value if found, otherwise $default.
     */
    public function get($key, $default = null) {
        $key = (string) $key;
        if (isset($this->data[$key])) {
            return $this->data[$key];
        }
        return $default;
    }

    /**
     * Return an array representing the arguments in the ArgMap.
     *
     * @return array
     *            A regular array representing the arguments in the ArgMap.
     */
    public function getArgs() {
        return $this->data;
    }

    // ArrayAccess
    public function offsetExists($offset) {
        return isset($this->data[(string) $offset]);
    }

    public function offsetGet($offset) {
        return $this->data[(string) $offset];
    }

    public function offsetSet($offset, $value) {
        $valueStr = $value === null? null : (string)$value;
        $this->data[(string)$offset] = $valueStr;
    }

    public function offsetUnset($offset) {
        unset($this->data[(string) $offset]);
    }

    // Countable
    public function count() {
        return count($this->data);
    }

    // IteratorAggregate
    public function getIterator() {
        return new \ArrayIterator($this->data);
    }

    /**
     * @internal
     * @param ArgMap|array|null
     * @throws \InvalidArgumentException
     * @return array
     */
    public static function validate($arguments) {
        if ($arguments === null || is_array($arguments)) {
            return $arguments;
        } elseif ($arguments instanceof ArgMap) {
            return $arguments->getArgs();
        }
        $type = gettype($arguments) === 'object' ? get_class($arguments) : gettype($arguments);
        throw new \InvalidArgumentException('Invalid arguments type, expected null, array or ArgMap, got ' . $type);
    }
}
Apptus ESales Connector PHP API documentation generated by ApiGen