10 |
This reference provides details on all PHP SDK asset management namespaces and classes.
11 |
For details on the PHP SDK transformation namespaces and classes,
12 | see the PHP SDK Transformation Reference.
13 |
19 | {% set last_name = '' %}
20 | {% for namespace in namespaces %}
21 | {% set top_level = namespace|split('\\')|first %}
22 | {% if top_level != last_name %}
23 | {% if last_name %}
{% endif %}
24 |
47 |
51 | ' . getColoredPhp($this->text, $this->keepSpaces) . '
52 |
53 | ';
54 | }
55 | }
56 |
--------------------------------------------------------------------------------
/samples/SamplePage/Sample/Tabs/TagTab.php:
--------------------------------------------------------------------------------
1 | html = $html;
37 | }
38 |
39 | public function getTabContent()
40 | {
41 | // TODO: add getFormattedHtml() function to SamplePageUtils
42 |
43 | return '
44 |
' .
49 | getFormattedHtml($this->html) .
50 | '
51 |
' .
77 | $tag->addClass('z - depth - 1')->setAttribute('style', 'margin:auto; max-width: 900px;') . '
78 |
79 |
80 | ';
81 | }
82 | }
83 |
--------------------------------------------------------------------------------
/src/Api/Admin/AdminApi.php:
--------------------------------------------------------------------------------
1 |
21 | * Admin API Reference
22 | *
23 | * @api
24 | */
25 | class AdminApi
26 | {
27 | use AssetsTrait;
28 | use FoldersTrait;
29 | use TransformationsTrait;
30 | use StreamingProfilesTrait;
31 | use UploadPresetsTrait;
32 | use UploadMappingsTrait;
33 | use MiscTrait;
34 | use MetadataFieldsTrait;
35 | use AnalysisTrait;
36 |
37 | /**
38 | * @var ApiClient $apiClient The API client instance.
39 | */
40 | protected $apiClient;
41 |
42 | /**
43 | * @var ApiClient $apiV2Client The API v2 client instance.
44 | */
45 | protected $apiV2Client;
46 |
47 | /**
48 | * AdminApi constructor.
49 | *
50 | * @param mixed|null $configuration
51 | *
52 | * @noinspection UnusedConstructorDependenciesInspection*/
53 | public function __construct(mixed $configuration = null)
54 | {
55 | $this->apiClient = new ApiClient($configuration);
56 |
57 | $apiV2Configuration = new Configuration($configuration);
58 | $apiV2Configuration->api->apiVersion = '2';
59 |
60 | $this->apiV2Client = new ApiClient($apiV2Configuration);
61 | }
62 | }
63 |
--------------------------------------------------------------------------------
/src/Api/Admin/AnalysisTrait.php:
--------------------------------------------------------------------------------
1 | analyzeAsync($inputType, $analysisType, $uri, $parameters)->wait();
47 | }
48 |
49 | /**
50 | * Analyzes an asset with the requested analysis type asynchronously.
51 | *
52 | * @param string $inputType The type of input for the asset to analyze ('uri').
53 | * @param string $analysisType The type of analysis to run ('google_tagging', 'captioning', 'fashion').
54 | * @param string|null $uri The URI of the asset to analyze.
55 | * @param array|null $parameters Additional parameters.
56 | *
57 | * @see https://cloudinary.com/documentation/media_analyzer_api_reference
58 | */
59 | public function analyzeAsync(
60 | string $inputType,
61 | string $analysisType,
62 | ?string $uri = null,
63 | ?array $parameters = null
64 | ): PromiseInterface {
65 | $endPoint = [ApiEndPoint::ANALYSIS, 'analyze', $inputType];
66 |
67 | $params = ['analysis_type' => $analysisType, 'uri' => $uri, 'parameters' => $parameters];
68 |
69 | return $this->apiV2Client->postJsonAsync($endPoint, $params);
70 | }
71 | }
72 |
--------------------------------------------------------------------------------
/src/Api/Admin/ApiEndPoint.php:
--------------------------------------------------------------------------------
1 | headers = $headers;
58 | // According to RFC 2616, header names are case-insensitive.
59 | $lcHeaders = array_change_key_case($headers);
60 |
61 | $this->rateLimitResetAt = strtotime(ArrayUtils::get($lcHeaders, ['x-featureratelimit-reset', 0], 0));
62 | $this->rateLimitAllowed = (int)ArrayUtils::get($lcHeaders, ['x-featureratelimit-limit', 0], 0);
63 | $this->rateLimitRemaining = (int)ArrayUtils::get($lcHeaders, ['x-featureratelimit-remaining', 0], 0);
64 |
65 | parent::__construct($responseJson);
66 | }
67 | }
68 |
--------------------------------------------------------------------------------
/src/Api/Exception/AlreadyExists.php:
--------------------------------------------------------------------------------
1 | type = MetadataFieldType::DATE;
32 | }
33 |
34 | /**
35 | * Sets the default date for this field.
36 | *
37 | * @param mixed $defaultValue The date to set.
38 | */
39 | public function setDefaultValue(mixed $defaultValue): void
40 | {
41 | $this->defaultValue = Utils::toISO8601DateOnly($defaultValue);
42 | }
43 |
44 | /**
45 | * Gets the default date of this field.
46 | *
47 | * @throws Exception When the underlying value is malformed.
48 | */
49 | public function getDefaultValue(): ?DateTime
50 | {
51 | return $this->defaultValue ? new DateTime($this->defaultValue) : null;
52 | }
53 | }
54 |
--------------------------------------------------------------------------------
/src/Api/Metadata/EnumMetadataField.php:
--------------------------------------------------------------------------------
1 | type = MetadataFieldType::ENUM;
27 | }
28 | }
29 |
--------------------------------------------------------------------------------
/src/Api/Metadata/IntMetadataField.php:
--------------------------------------------------------------------------------
1 | type = MetadataFieldType::INTEGER;
28 | }
29 |
30 | /**
31 | * Sets the default value for this field.
32 | *
33 | */
34 | public function setDefaultValue(mixed $defaultValue): void
35 | {
36 | $this->defaultValue = (int)$defaultValue;
37 | }
38 | }
39 |
--------------------------------------------------------------------------------
/src/Api/Metadata/Metadata.php:
--------------------------------------------------------------------------------
1 | getPropertyKeys();
39 |
40 | $snakeCaseProperties = [];
41 | foreach ($propertyKeys as $key) {
42 | $value = $this->{$key} ?? null;
43 | if ($value === null) {
44 | continue;
45 | }
46 | if (is_object($value)) {
47 | if (method_exists($value, 'jsonSerialize')) {
48 | $snakeCaseProperties[StringUtils::camelCaseToSnakeCase($key)] = $value->jsonSerialize();
49 | }
50 | } elseif (is_array($value) && !ArrayUtils::isAssoc($value)) {
51 | $subArray = [];
52 | foreach ($value as $subArrayValue) {
53 | if (method_exists($subArrayValue, 'jsonSerialize')) {
54 | $subArray[] = $subArrayValue->jsonSerialize();
55 | } else {
56 | $subArray[] = $subArrayValue;
57 | }
58 | }
59 | $snakeCaseProperties[StringUtils::camelCaseToSnakeCase($key)] = $subArray;
60 | } else {
61 | $snakeCaseProperties[StringUtils::camelCaseToSnakeCase($key)] = $value;
62 | }
63 | }
64 |
65 | return $snakeCaseProperties;
66 | }
67 | }
68 |
--------------------------------------------------------------------------------
/src/Api/Metadata/MetadataDataEntry.php:
--------------------------------------------------------------------------------
1 | setValue($value);
33 | $this->setExternalId($externalId);
34 | }
35 |
36 | /**
37 | * Gets the keys for all the properties of this object.
38 | *
39 | */
40 | public function getPropertyKeys(): array
41 | {
42 | return ['externalId', 'value'];
43 | }
44 |
45 | /**
46 | * Gets the value of the entry.
47 | *
48 | */
49 | public function getValue(): string
50 | {
51 | return $this->value;
52 | }
53 |
54 | /**
55 | * Sets the value of the entry.
56 | *
57 | */
58 | public function setValue(string $value): void
59 | {
60 | if (is_null($value)) {
61 | throw new InvalidArgumentException('Metadata data entry value is not valid');
62 | }
63 | $this->value = $value;
64 | }
65 |
66 | /**
67 | * Gets the ID of the entry.
68 | *
69 | */
70 | public function getExternalId(): string
71 | {
72 | return $this->externalId;
73 | }
74 |
75 | /**
76 | * Sets the ID of the entry. Will be auto-generated if left blank.
77 | *
78 | * @param ?string $externalId The external ID.
79 | */
80 | public function setExternalId(?string $externalId): void
81 | {
82 | $this->externalId = $externalId;
83 | }
84 | }
85 |
--------------------------------------------------------------------------------
/src/Api/Metadata/MetadataDataSource.php:
--------------------------------------------------------------------------------
1 | setValues($values);
37 | }
38 |
39 | /**
40 | * Gets the keys for all the properties of this object.
41 | *
42 | */
43 | public function getPropertyKeys(): array
44 | {
45 | return ['values'];
46 | }
47 |
48 | /**
49 | * Sets entities for this data source.
50 | *
51 | * @param MetadataDataEntry[]|array[] $values
52 | *
53 | * @throws InvalidArgumentException
54 | */
55 | public function setValues(array $values): void
56 | {
57 | $this->values = [];
58 | foreach ($values as $value) {
59 | if ($value instanceof MetadataDataEntry) {
60 | $this->values[] = $value;
61 | } elseif (is_array($value) && isset($value['value'])) {
62 | $this->values[] = new MetadataDataEntry(
63 | $value['value'],
64 | $value['external_id'] ?? null
65 | );
66 | } else {
67 | throw new InvalidArgumentException('The specified metadata datasource values are not valid.');
68 | }
69 | }
70 | }
71 |
72 | /**
73 | * Gets entities of this data source.
74 | *
75 | * @return MetadataDataEntry[]
76 | */
77 | public function getValues(): array
78 | {
79 | return $this->values;
80 | }
81 | }
82 |
--------------------------------------------------------------------------------
/src/Api/Metadata/MetadataFieldType.php:
--------------------------------------------------------------------------------
1 | type = MetadataFieldType::SET;
27 | }
28 | }
29 |
--------------------------------------------------------------------------------
/src/Api/Metadata/StringMetadataField.php:
--------------------------------------------------------------------------------
1 | type = MetadataFieldType::STRING;
27 | }
28 |
29 | /**
30 | * Sets the default value.
31 | *
32 | */
33 | public function setDefaultValue(mixed $defaultValue): void
34 | {
35 | $this->defaultValue = (string)$defaultValue;
36 | }
37 | }
38 |
--------------------------------------------------------------------------------
/src/Api/Metadata/Validators/AndValidator.php:
--------------------------------------------------------------------------------
1 | type = self::RULE_AND;
35 | $this->rules = $rules;
36 | }
37 |
38 | /**
39 | * Gets the keys for all the properties of this object.
40 | *
41 | * @return string[]
42 | */
43 | public function getPropertyKeys(): array
44 | {
45 | return array_merge(parent::getPropertyKeys(), ['rules']);
46 | }
47 | }
48 |
--------------------------------------------------------------------------------
/src/Api/Metadata/Validators/ComparisonRule.php:
--------------------------------------------------------------------------------
1 | type = $type;
30 | $this->setValue($value);
31 | $this->equals = $equals;
32 | }
33 |
34 | protected function setValue(mixed $value): void
35 | {
36 | $this->value = $value;
37 | }
38 | }
39 |
--------------------------------------------------------------------------------
/src/Api/Metadata/Validators/DateGreaterThan.php:
--------------------------------------------------------------------------------
1 | value = Utils::toISO8601DateOnly($value);
37 | }
38 | }
39 |
--------------------------------------------------------------------------------
/src/Api/Metadata/Validators/DateLessThan.php:
--------------------------------------------------------------------------------
1 | value = Utils::toISO8601DateOnly($value);
37 | }
38 | }
39 |
--------------------------------------------------------------------------------
/src/Api/Metadata/Validators/IntGreaterThan.php:
--------------------------------------------------------------------------------
1 | type = self::STRLEN;
31 | $this->min = $min;
32 | $this->max = $max;
33 | }
34 | }
35 |
--------------------------------------------------------------------------------
/src/Api/Provisioning/AccountEndPoint.php:
--------------------------------------------------------------------------------
1 | endpoint(self::FOLDERS);
38 | }
39 | }
40 |
--------------------------------------------------------------------------------
/src/Api/Search/SearchQueryInterface.php:
--------------------------------------------------------------------------------
1 | accessType = $accessType;
60 | $this->start = $start;
61 | $this->end = $end;
62 | }
63 |
64 |
65 | /**
66 | * Serializes to JSON
67 | */
68 | public function jsonSerialize(): array
69 | {
70 | return ArrayUtils::safeFilter(
71 | [
72 | 'access_type' => $this->accessType,
73 | 'start' => Utils::formatDate($this->start),
74 | 'end' => Utils::formatDate($this->end),
75 | ]
76 | );
77 | }
78 | }
79 |
--------------------------------------------------------------------------------
/src/Asset/AccessControl/AccessType.php:
--------------------------------------------------------------------------------
1 | [DeliveryType::UPLOAD => 'files'],
30 | ];
31 | }
32 |
--------------------------------------------------------------------------------
/src/Asset/Image.php:
--------------------------------------------------------------------------------
1 | [
34 | DeliveryType::UPLOAD => 'images',
35 | DeliveryType::PRIVATE_DELIVERY => 'private_images',
36 | DeliveryType::AUTHENTICATED => 'authenticated_images',
37 | ],
38 | ];
39 |
40 | /**
41 | * Gets the transformation.
42 | *
43 | */
44 | public function getTransformation(): CommonTransformation
45 | {
46 | if (! isset($this->transformation)) {
47 | $this->transformation = new ImageTransformation();
48 | }
49 |
50 | return $this->transformation;
51 | }
52 |
53 | /**
54 | * Finalizes the asset type.
55 | *
56 | */
57 | protected function finalizeAssetType(): ?string
58 | {
59 | return $this->finalizeShorten(parent::finalizeAssetType());
60 | }
61 | }
62 |
--------------------------------------------------------------------------------
/src/Asset/Media.php:
--------------------------------------------------------------------------------
1 | transformation)) {
52 | $this->transformation = new Transformation();
53 | }
54 |
55 | return $this->transformation;
56 | }
57 |
58 | /**
59 | * Internal getter for a list of the delivery types that support SEO suffix.
60 | *
61 | *
62 | * @internal
63 | */
64 | public static function getSuffixSupportedDeliveryTypes(): array
65 | {
66 | if (empty(self::$suffixSupportedDeliveryTypes)) {
67 | self::$suffixSupportedDeliveryTypes = ArrayUtils::mergeNonEmpty(
68 | Image::getSuffixSupportedDeliveryTypes(),
69 | Video::getSuffixSupportedDeliveryTypes(),
70 | File::getSuffixSupportedDeliveryTypes()
71 | );
72 | }
73 |
74 | return self::$suffixSupportedDeliveryTypes;
75 | }
76 |
77 | /**
78 | * Finalizes the asset type.
79 | *
80 | */
81 | protected function finalizeAssetType(): ?string
82 | {
83 | return $this->finalizeShorten(parent::finalizeAssetType());
84 | }
85 | }
86 |
--------------------------------------------------------------------------------
/src/Asset/Moderation/ModerationStatus.php:
--------------------------------------------------------------------------------
1 | ttl = $ttl;
24 |
25 | return $this;
26 | }
27 | }
28 |
--------------------------------------------------------------------------------
/src/Asset/Video.php:
--------------------------------------------------------------------------------
1 | [DeliveryType::UPLOAD => 'videos'],
32 | ];
33 |
34 | /**
35 | * Gets the transformation.
36 | *
37 | */
38 | public function getTransformation(): CommonTransformation|VideoTransformation
39 | {
40 | if (! isset($this->transformation)) {
41 | $this->transformation = new VideoTransformation();
42 | }
43 |
44 | return $this->transformation;
45 | }
46 | }
47 |
--------------------------------------------------------------------------------
/src/Configuration/AssetConfigTrait.php:
--------------------------------------------------------------------------------
1 | Delivering token based authenticated media assets
16 | *
17 | * @api
18 | */
19 | class AuthTokenConfig extends BaseConfigSection
20 | {
21 | public const CONFIG_NAME = 'auth_token';
22 |
23 | // Supported parameters
24 | public const KEY = 'key';
25 | public const IP = 'ip';
26 | public const ACL = 'acl';
27 | public const START_TIME = 'start_time';
28 | public const EXPIRATION = 'expiration';
29 | public const DURATION = 'duration';
30 |
31 | /**
32 | * (Required) – the token must be signed with the encryption key received from Cloudinary.
33 | *
34 | * @var ?string
35 | */
36 | public ?string $key = null;
37 |
38 | /**
39 | * (Optional) – only this IP address can access the resource.
40 | *
41 | * @var ?string
42 | */
43 | public ?string $ip = null;
44 |
45 | /**
46 | * (Optional) – an Access Control List for limiting the allowed URL path to a specified pattern (e.g.,
47 | * /video/authenticated/*).
48 | *
49 | * The pattern can include any of Cloudinary's transformations to also apply to the
50 | * delivered assets. Note that if you add an overlay (e.g., for a watermark), you should also include the
51 | * fl_layer_apply flag to ensure the layer cannot be modified. This parameter is useful for generating a token
52 | * that can be added to a number of different URLs that share a common transformation. Without this parameter,
53 | * the pattern defaults to the full URL path of the requested asset.
54 | *
55 | * @var string|array|null
56 | */
57 | public string|array|null $acl = null;
58 |
59 | /**
60 | * (Optional) – timestamp of the UNIX time when the URL becomes valid. Default value: the current time.
61 | *
62 | * @var ?int
63 | */
64 | public ?int $startTime = null;
65 |
66 | /**
67 | * (Optional) – timestamp of the UNIX time when the URL expires.
68 | *
69 | * @var ?int
70 | */
71 | public ?int $expiration = null;
72 |
73 | /**
74 | * (Optional) – the duration that the URL is valid in seconds (counted from start_time).
75 | *
76 | * @var ?int
77 | */
78 | public ?int $duration = null;
79 | }
80 |
--------------------------------------------------------------------------------
/src/Configuration/CloudConfigTrait.php:
--------------------------------------------------------------------------------
1 | setCloudConfig(CloudConfig::CLOUD_NAME, $cloudName);
32 | }
33 |
34 | /**
35 | * Sets the OAuth2.0 token.
36 | *
37 | * @param ?string $oauthToken Used instead of API key and API secret
38 | *
39 | * @return $this
40 | *
41 | * @api
42 | */
43 | public function oauthToken(?string $oauthToken): static
44 | {
45 | return $this->setCloudConfig(CloudConfig::OAUTH_TOKEN, $oauthToken);
46 | }
47 |
48 | /**
49 | * Sets the signature algorithm.
50 | *
51 | * @param string $signatureAlgorithm The algorithm to use. (Can be SHA1 or SHA256).
52 | *
53 | * @return $this
54 | *
55 | * @api
56 | */
57 | public function signatureAlgorithm(string $signatureAlgorithm): static
58 | {
59 | return $this->setCloudConfig(CloudConfig::SIGNATURE_ALGORITHM, $signatureAlgorithm);
60 | }
61 |
62 | /**
63 | * Sets the Cloud configuration key with the specified value.
64 | *
65 | * @param string $configKey The configuration key.
66 | * @param mixed $configValue THe configuration value.
67 | *
68 | * @return $this
69 | *
70 | * @internal
71 | */
72 | abstract public function setCloudConfig(string $configKey, mixed $configValue): static;
73 | }
74 |
--------------------------------------------------------------------------------
/src/Configuration/ConfigurableInterface.php:
--------------------------------------------------------------------------------
1 | :$tag
32 | );
33 | }
34 |
35 | public function testVideoThumbnailTagWithTransformation()
36 | {
37 | $video = (new Video(self::VIDEO_NAME))->trim(VideoEdit::trim(10, 20));
38 | $tag = (new VideoThumbnailTag($video))->effect(Effect::sepia(20));
39 |
40 | self::assertEquals(
41 | '<img src=)
args = $args;
28 | }
29 |
30 | /**
31 | * @return string
32 | */
33 | public function __toString()
34 | {
35 | return substr(strrchr(static::class, '\\'), 1) . '(' . implode(', ', $this->args) . ')';
36 | }
37 | }
38 |
--------------------------------------------------------------------------------
/tests/Unit/TestHelpers/TestClassB.php:
--------------------------------------------------------------------------------
1 | logging);
32 | }
33 |
34 | /**
35 | * Generates log entries
36 | */
37 | public function generateLog()
38 | {
39 | $this->info('This is an info level message');
40 | $this->debug('This is a debug level message');
41 | }
42 | }
43 |
--------------------------------------------------------------------------------
/tests/Unit/UnitTestCase.php:
--------------------------------------------------------------------------------
1 | ['test' => ['level' => 'debug']]];
31 |
32 | const API_TEST_ASSET_ID = '4af5a0d1d4047808528b5425d166c101';
33 | const API_TEST_ASSET_ID2 = '4af5a0d1d4047808528b5425d166c102';
34 | const API_TEST_ASSET_ID3 = '4af5a0d1d4047808528b5425d166c103';
35 |
36 | const NEXT_CURSOR = '8c452e112d4c88ac7c9ffb3a2a41c41bef24';
37 |
38 | protected $cloudinaryUrl;
39 |
40 | private $cldUrlEnvBackup;
41 |
42 | public function setUp()
43 | {
44 | parent::setUp();
45 |
46 | $this->cldUrlEnvBackup = getenv(Configuration::CLOUDINARY_URL_ENV_VAR);
47 |
48 | self::assertNotEmpty($this->cldUrlEnvBackup, 'Please set up CLOUDINARY_URL before running tests!');
49 |
50 | $this->cloudinaryUrl = 'cloudinary://' . $this::API_KEY . ':' . $this::API_SECRET . '@' . $this::CLOUD_NAME;
51 |
52 | putenv(Configuration::CLOUDINARY_URL_ENV_VAR . '=' . $this->cloudinaryUrl);
53 |
54 | $config = ConfigUtils::parseCloudinaryUrl(getenv(Configuration::CLOUDINARY_URL_ENV_VAR));
55 | $config = array_merge($config, self::TEST_LOGGING);
56 | Configuration::instance()->init($config);
57 |
58 | Configuration::instance()->url->analytics(false); // disable analytics for all unit tests
59 | }
60 |
61 | public function tearDown()
62 | {
63 | parent::tearDown();
64 |
65 | putenv(Configuration::CLOUDINARY_URL_ENV_VAR . '=' . $this->cldUrlEnvBackup);
66 | }
67 |
68 | protected static function clearEnvironment()
69 | {
70 | putenv(Configuration::CLOUDINARY_URL_ENV_VAR); // unset CLOUDINARY_URL
71 |
72 | Configuration::instance()->init();
73 | }
74 | }
75 |
--------------------------------------------------------------------------------
/tests/Unit/Utils/FileUtilsTest.php:
--------------------------------------------------------------------------------
1 | payload; printf("cloudinary://%s:%s@%s", $c->cloudApiKey, $c->cloudApiSecret, $c->cloudName);'
10 |
--------------------------------------------------------------------------------
/tools/get_test_cloud.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 |
3 | DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
4 |
5 | PHP_VER=$(php -v | head -n 1 | cut -d ' ' -f 2);
6 | SDK_VER=$(php -r "echo json_decode(file_get_contents('composer.json'))->version;")
7 |
8 |
9 | bash ${DIR}/allocate_test_cloud.sh "PHP ${PHP_VER} SDK ${SDK_VER}"
10 |
--------------------------------------------------------------------------------