Overview

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

  • AbstractConfigLoader
  • CachingConfigLoader
  • Client

Interfaces

  • ClientInterface
  • ConfigLoaderInterface
  • Overview
  • Namespace
  • Class
  • Tree

Class AbstractConfigLoader

Abstract config loader

Guzzle\Service\AbstractConfigLoader implements Guzzle\Service\ConfigLoaderInterface

Direct known subclasses

Guzzle\Service\Builder\ServiceBuilderLoader, Guzzle\Service\Description\ServiceDescriptionLoader
Abstract
Namespace: Guzzle\Service
Located at src/Guzzle/Service/AbstractConfigLoader.php
Methods summary
public mixed
# load( mixed $config, array $options = array() )

Loads configuration data and returns an array of the loaded result

Loads configuration data and returns an array of the loaded result

Parameters

$config
Data to load (filename or array of data)
$options
Array of options to use when loading

Returns

mixed

Implementation of

Guzzle\Service\ConfigLoaderInterface::load()
public Guzzle\Service\AbstractConfigLoader
# addAlias( string $filename, string $alias )

Add an include alias to the loader

Add an include alias to the loader

Parameters

$filename
Filename to alias (e.g. _foo)
$alias
Actual file to use (e.g. /path/to/foo.json)

Returns

Guzzle\Service\AbstractConfigLoader
public Guzzle\Service\AbstractConfigLoader
# removeAlias( string $alias )

Remove an alias from the loader

Remove an alias from the loader

Parameters

$alias
Alias to remove

Returns

Guzzle\Service\AbstractConfigLoader
abstract protected mixed
# build( array $config, array $options )

Perform the parsing of a config file and create the end result

Perform the parsing of a config file and create the end result

Parameters

$config
Configuration data
$options
Options to use when building

Returns

mixed
protected array
# loadFile( string $filename )

Load a configuration file (can load JSON or PHP files that return an array when included)

Load a configuration file (can load JSON or PHP files that return an array when included)

Parameters

$filename
File to load

Returns

array

Throws

InvalidArgumentException
RuntimeException
when the JSON cannot be parsed
protected array
# mergeIncludes( array & $config, string $basePath = null )

Merges in all include files

Merges in all include files

Parameters

$config
Config data that contains includes
$basePath
Base path to use when a relative path is encountered

Returns

array
Returns the merged and included data
protected array
# mergeData( array $a, array $b )

Default implementation for merging two arrays of data (uses array_merge_recursive)

Default implementation for merging two arrays of data (uses array_merge_recursive)

Parameters

$a
Original data
$b
Data to merge into the original and overwrite existing values

Returns

array
Properties summary
protected array $aliases

Array of aliases for actual filenames

Array of aliases for actual filenames

# array()
protected array $loadedFiles

Hash of previously loaded filenames

Hash of previously loaded filenames

# array()
protected static array $jsonErrors

JSON error code mappings

JSON error code mappings

# array( JSON_ERROR_NONE => 'JSON_ERROR_NONE - No errors', JSON_ERROR_DEPTH => 'JSON_ERROR_DEPTH - Maximum stack depth exceeded', JSON_ERROR_STATE_MISMATCH => 'JSON_ERROR_STATE_MISMATCH - Underflow or the modes mismatch', JSON_ERROR_CTRL_CHAR => 'JSON_ERROR_CTRL_CHAR - Unexpected control character found', JSON_ERROR_SYNTAX => 'JSON_ERROR_SYNTAX - Syntax error, malformed JSON', JSON_ERROR_UTF8 => 'JSON_ERROR_UTF8 - Malformed UTF-8 characters, possibly incorrectly encoded' )
Omnipay Viva Payments Gateway Module API Documentation API documentation generated by ApiGen