File src/Guzzle/Service/Command/LocationVisitor/Response/HeaderVisitor.php | Omnipay Viva Payments Gateway Module API Documentation

Namespaces

Guzzle
- Batch
  - Exception
- Cache
- Common
  - Exception
- Http
  - Curl
  - Exception
  - Message
    - Header
  - QueryAggregator
- Inflection
- Iterator
- Log
- Parser
  - Cookie
  - Message
  - UriTemplate
  - Url
- Plugin
  - Async
  - Backoff
  - Cache
  - Cookie
    - CookieJar
    - Exception
  - CurlAuth
  - ErrorResponse
    - Exception
  - History
  - Log
  - Md5
  - Mock
  - Oauth
- Service
  - Builder
  - Command
    - Factory
    - LocationVisitor
      - Request
      - Response
  - Description
  - Exception
  - Resource
- Stream
- Tests
  - Batch
  - Cache
  - Common
    - Cache
    - Exception
  - Http
    - Curl
    - Exception
    - Message
      - Header
  - Inflection
  - Iterator
  - Log
  - Message
  - Mock
  - Parser
    - Cookie
    - Message
  - Parsers
    - UriTemplate
  - Plugin
    - Async
    - Backoff
    - Cache
    - Cookie
      - CookieJar
    - CurlAuth
    - ErrorResponse
    - History
    - Log
    - Md5
    - Mock
    - Oauth
    - Redirect
  - Service
    - Builder
    - Command
      - LocationVisitor
        
        Request
        
        Response
    - Description
    - Exception
    - Mock
      - Command
        
        Sub
      - Model
    - Resource
  - Stream
None
Omnipay
- Common
  - Exception
  - Message
- Dummy
  - Message
- VivaPayments
  - Message
PHP

Classes

Interfaces

Exceptions

 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:

<?php

namespace Guzzle\Service\Command\LocationVisitor\Response;

use Guzzle\Http\Message\Response;
use Guzzle\Service\Description\Parameter;
use Guzzle\Service\Command\CommandInterface;

/**
 * Location visitor used to add a particular header of a response to a key in the result
 */
class HeaderVisitor extends AbstractResponseVisitor
{
    public function visit(
        CommandInterface $command,
        Response $response,
        Parameter $param,
        &$value,
        $context =  null
    ) {
        if ($param->getType() == 'object' && $param->getAdditionalProperties() instanceof Parameter) {
            $this->processPrefixedHeaders($response, $param, $value);
        } else {
            $value[$param->getName()] = $param->filter((string) $response->getHeader($param->getWireName()));
        }
    }

    /**
     * Process a prefixed header array
     *
     * @param Response  $response Response that contains the headers
     * @param Parameter $param    Parameter object
     * @param array     $value    Value response array to modify
     */
    protected function processPrefixedHeaders(Response $response, Parameter $param, &$value)
    {
        // Grab prefixed headers that should be placed into an array with the prefix stripped
        if ($prefix = $param->getSentAs()) {
            $container = $param->getName();
            $len = strlen($prefix);
            // Find all matching headers and place them into the containing element
            foreach ($response->getHeaders()->toArray() as $key => $header) {
                if (stripos($key, $prefix) === 0) {
                    // Account for multi-value headers
                    $value[$container][substr($key, $len)] = count($header) == 1 ? end($header) : $header;
                }
            }
        }
    }
}