1. class
  2. Cloudinary
  3. \
  4. Configuration
  5. \
  6. Configuration

Configuration

class Configuration implements ConfigurableInterface

Defines the available global configurations.

Properties

CloudConfig $cloud The configuration of the cloud.
ApiConfig $api The configuration of the API.
UrlConfig $url The configuration of the URL.
TagConfig $tag The configuration of tags.
ResponsiveBreakpointsConfig $responsiveBreakpoints The configuration of the responsive breakpoints cache.
AuthTokenConfig $authToken The authentication token.
LoggingConfig $logging The configuration of the logging.

Methods

__construct(Configuration|string|array|null $config = null, bool $includeSensitive = true)

Configuration constructor.

init(Configuration|string|array|null $config = null, bool $includeSensitive = true)

Configuration initializer.

import(Configuration|string|array|null $config = null)

Imports configuration.

instance(Configuration|string|array|null $config = null)

Singleton instance for effective access to global configuration.

fromJson(string|array $json)

Creates Configuration using json string or array as a source.

fromParams(array $params)

Creates Configuration using an array of parameters as a source.

fromCloudinaryUrl(string $cloudinaryUrl)

Creates Configuration using Cloudinary url as a source.

importJson($json)

This is the actual constructor.

importCloudinaryUrl(string|UriInterface $cloudinaryUrl)

Imports configuration from a cloudinary URL.

importConfig(Configuration $otherConfig)

Imports configuration from another instance of the Configuration.

validate()

No description

toString()

Serialises Configuration to Cloudinary url

__toString()

Serialises Configuration to Cloudinary url

jsonSerialize($includeSensitive = true, $includeEmptyKeys = false, $includeEmptySections = false)

No description

Details

__construct(Configuration|string|array|null $config = null, bool $includeSensitive = true)

Configuration constructor.

Parameters

Name Type Description
$config Configuration|string|array|null Configuration source. Can be Cloudinary url, json, array, another instance of the configuration.
$includeSensitive bool Indicates whether to include sensitive keys during serialisation to string/json.

init(Configuration|string|array|null $config = null, bool $includeSensitive = true)

Configuration initializer.

Used for initialising and resetting config

Parameters

Name Type Description
$config Configuration|string|array|null Configuration source. Can be Cloudinary url, json, array, another instance of the configuration.
$includeSensitive bool Indicates whether to include sensitive keys during serialisation to string/json.

import(Configuration|string|array|null $config = null)

Imports configuration.

Parameters

Name Type Description
$config Configuration|string|array|null Configuration source. Can be Cloudinary url, json, array, another instance of the configuration.

static Configuration instance(Configuration|string|array|null $config = null)

Singleton instance for effective access to global configuration.

Instance can be optionally initialised with the provided $config (used only on the first call).

Parameters

Name Type Description
$config Configuration|string|array|null Configuration source. Can be Cloudinary url, json, array, another instance of the configuration.

Return Value

Configuration

static Configuration fromJson(string|array $json)

Creates Configuration using json string or array as a source.

Parameters

Name Type Description
$json string|array Configuration json.

Return Value

Configuration

static Configuration fromParams(array $params)

Creates Configuration using an array of parameters as a source.

Parameters

Name Type Description
$params array Configuration parameters.

Return Value

Configuration

static Configuration fromCloudinaryUrl(string $cloudinaryUrl)

Creates Configuration using Cloudinary url as a source.

Parameters

Name Type Description
$cloudinaryUrl string The Cloudinary url.

Return Value

Configuration

Configuration importJson($json)

This is the actual constructor.

Parameters

Name Type Description
$json

Return Value

Configuration

Configuration importCloudinaryUrl(string|UriInterface $cloudinaryUrl)

Imports configuration from a cloudinary URL.

Parameters

Name Type Description
$cloudinaryUrl string|UriInterface The cloudinary URL.

Return Value

Configuration

Configuration importConfig(Configuration $otherConfig)

Imports configuration from another instance of the Configuration.

Parameters

Name Type Description
$otherConfig Configuration The source of the configuration.

Return Value

Configuration

validate()

string toString()

Serialises Configuration to Cloudinary url

Return Value

string Resulting Cloudinary url

string __toString()

Serialises Configuration to Cloudinary url

Return Value

string Resulting Cloudinary url

jsonSerialize($includeSensitive = true, $includeEmptyKeys = false, $includeEmptySections = false)

Parameters

Name Type Description
$includeSensitive
$includeEmptyKeys
$includeEmptySections

Constants

CLOUDINARY_URL_ENV_VAR

VERSION

The version of the configuration scheme