UrlConfig
class UrlConfig extends BaseConfigSection
Defines the global configuration applied when generating Cloudinary URLs.
Properties
| bool | $cdnSubdomain | Whether to automatically build URLs with multiple CDN sub-domains. | |
| bool | $secureCdnSubdomain | Secure CDN sub-domain. | |
| string | $cname | The custom domain name to use for building HTTP URLs. Relevant only for Advanced plan users that have a private CDN distribution and a custom CNAME | |
| string | $secureCname | The domain name of the CDN distribution to use for building HTTPS URLs. Relevant only for Advanced plan users that have a private CDN distribution. | |
| bool | $privateCdn | Set this parameter to true if you are an Advanced plan user with a private CDN distribution. | |
| bool | $signUrl | Set to true to create a Cloudinary URL signed with the first 8 characters of a SHA-1 hash. | |
| bool | $longUrlSignature | Setting both this and signUrl to true will sign the URL using the first 32 characters of a SHA-256 hash. | |
| bool | $shorten | Set to true to use shorten asset type. | |
| bool | $useRootPath | Set to true to omit type and resource_type in the URL. | |
| bool | $responsiveWidth | Whether to use responsive width. | |
| bool | $secure | Force HTTPS URLs for resources even if they are embedded in non-secure HTTP pages. | |
| bool | $forceVersion | By default set to self::DEFAULT_FORCE_VERSION. | |
| string | $responsiveWidthTransformation | The transformation to use with responsive width. |
Methods
Whether to automatically build URLs with multiple CDN sub-domains.
Whether to use secure CDN sub-domain.
The custom domain name to use for building HTTP URLs.
Force HTTPS URLs for resources even if they are embedded in non-secure HTTP pages.
The domain name of the CDN distribution to use for building HTTPS URLs.
Set this parameter to true if you are an Advanced plan user with a private CDN distribution.
Set to true to create a signed Cloudinary URL.
Setting both this and signUrl to true will sign the URL using the first 32 characters of a SHA-256 hash.
Set to true to use shorten asset type.
Set to true to omit type and resource_type in the URL.
Set to false to omit default version string for assets in folders in the delivery URL.
Set to false to omit analytics.
Serialises configuration section to a string representation.
Details
$this
cdnSubdomain(bool $cdnSubdomain = true)
Whether to automatically build URLs with multiple CDN sub-domains.
$this
secureCdnSubdomain(bool $secureCdnSubdomain = true)
Whether to use secure CDN sub-domain.
$this
cname(string $cname)
The custom domain name to use for building HTTP URLs.
Relevant only for Advanced plan users that have a private CDN distribution and a custom CNAME.
$this
secure(bool $secure = true)
Force HTTPS URLs for resources even if they are embedded in non-secure HTTP pages.
$this
secureCname(string $secureCname)
The domain name of the CDN distribution to use for building HTTPS URLs.
Relevant only for Advanced plan users that have a private CDN distribution.
$this
privateCdn(bool $privateCdn = true)
Set this parameter to true if you are an Advanced plan user with a private CDN distribution.
$this
signUrl(bool $signUrl = true)
Set to true to create a signed Cloudinary URL.
$this
longUrlSignature(bool $longUrlSignature = true)
Setting both this and signUrl to true will sign the URL using the first 32 characters of a SHA-256 hash.
$this
shorten(bool $shorten = true)
Set to true to use shorten asset type.
$this
useRootPath(bool $useRootPath = true)
Set to true to omit type and resource_type in the URL.
$this
forceVersion(bool $forceVersion = true)
Set to false to omit default version string for assets in folders in the delivery URL.
$this
analytics(bool $analytics = true)
Set to false to omit analytics.
string
__toString()
Serialises configuration section to a string representation.
Constants
| CONFIG_NAME |
|
| DEFAULT_DOMAIN |
|
| DEFAULT_SUB_DOMAIN |
|
| DEFAULT_SHARED_HOST |
|
| PROTOCOL_HTTP |
|
| PROTOCOL_HTTPS |
|
| DEFAULT_SECURE |
Default value for secure (distribution). |
| DEFAULT_FORCE_VERSION |
Default value for forcing version. |
| DEFAULT_ANALYTICS |
Default value for analytics. |
| DEFAULT_RESPONSIVE_WIDTH_TRANSFORMATION |
Default responsive width transformation. |
| CDN_SUBDOMAIN |
|
| SECURE_CDN_SUBDOMAIN |
|
| CNAME |
|
| SECURE |
|
| SECURE_CNAME |
|
| PRIVATE_CDN |
|
| SIGN_URL |
|
| LONG_URL_SIGNATURE |
|
| SHORTEN |
|
| USE_ROOT_PATH |
|
| FORCE_VERSION |
|
| ANALYTICS |
|
| RESPONSIVE_WIDTH |
|
| RESPONSIVE_WIDTH_TRANSFORMATION |
|