Overview

Namespaces

  • Scene7
    • Commands
      • Layer
    • Definitions
    • Helpers
      • Html
        • Attributes
    • Requests

Classes

  • AbstractRequest
  • CatalogProps
  • Exists
  • Image
  • ImageProps
  • ImageSet
  • LoadCache
  • Map
  • Mask
  • Message
  • Properties
  • Resolve
  • SaveToFile
  • Thumbnail
  • Validate
  • Overview
  • Namespace
  • Class
  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: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 
<?php

namespace Scene7\Requests;

use Scene7\Factory;
use Scene7\RenderInterface;

abstract class AbstractRequest implements RenderInterface
{
    /** @var string */
    protected $baseUrl = '';
    /** @var string */
    protected $file = '';
    /** @var array */
    protected $commands = [];
    /** @var Factory */
    protected $factory;
    /** @var string */
    protected $protocol = '';
    /** @var string */
    protected $responseType = '';
    /** @var string */
    protected $encoding = '';

    /**
     * @return string
     */
    abstract public function getRequestType();

    protected function setBaseUrl($baseUrl)
    {
        $this->baseUrl = $baseUrl;
        return $this;
    }

    protected function addCommand(array $commands)
    {
        $this->commands = array_merge($this->commands, $commands);
        return $this;
    }

    /**
     * @return array
     */
    public function getCommands()
    {
        return $this->commands;
    }

    /**
     * @param bool $obscure
     * @return string
     */
    public function getQuery($obscure = false)
    {
        if ($obscure) {
            $query = $this->getObscuredQuery();
        } else {
            $query = urldecode(http_build_query($this->commands));
        }

        return $query;
    }

    /**
     * @todo broken
     * @return string
     */
    public function getObscuredQuery()
    {
        $commands = [];
        foreach ($this->commands as $k => $v) {
            $commands[$k] = strtr($v, [
                '=' => '%3D',
                '&' => '%26',
                '%' => '%25',
            ]);
        }

        return base64_encode(urldecode(http_build_query($commands)) . $this->renderLayers(true));
    }

    /**
     * A wrapper for getUri()
     *
     * @param bool $obscure
     * @return string
     */
    public function render($obscure = false)
    {
        return $this->getUri($obscure);
    }

    /**
     * @param bool $obscure
     * @return string
     */
    public function getUri($obscure = false)
    {
        return ($this->protocol ?: '')
            . $this->baseUrl
            . $this->file
            . '?'
            . $this->renderRequestType()
            . $this->getQuery($obscure);
    }

    /**
     * @return string
     */
    protected function renderRequestType()
    {
        $requestType = $this->getRequestType();

        if ($requestType !== 'img' && !empty($requestType)) {
            $requestType = 'req=' . $requestType . '&';

            if (!empty($this->responseType) || !empty($this->encoding)) {
                $requestType .= ',' . $this->responseType;
            }

            if (!empty($this->encoding)) {
                $requestType .= ',' . $this->encoding;
            }
        } else {
            $requestType = '';
        }

        return $requestType;
    }

    /**
     * @param string $protocol
     * @return $this
     */
    public function setProtocol($protocol)
    {
        $this->protocol = $protocol;
        return $this;
    }

    public function __toString()
    {
        return $this->getUri();
    }

    public function setFactory(Factory $factory)
    {
        $this->factory = $factory;
        return $this;
    }

    /**
     * @return string[]
     */
    public function getAllowedResponseTypes()
    {
        return [];
    }

    /**
     * @return string[]
     */
    public function getAllowedEncodings()
    {
        return [];
    }
}
API documentation generated by ApiGen