PHP Class Cloudinary\Api

Show file Open project: cloudinary/cloudinary_php Class Usage Examples

Public Properties

Property Type Description
$CLOUDINARY_API_ERROR_CLASSES

Public Methods

Method Description
call_api ( $method, $uri, $params, &$options )
create_streaming_profile ( $name, array $options = [] ) : Response Create a new streaming profile
create_transformation ( $name, $definition, $options = [] )
create_upload_mapping ( $name, $options = [] )
create_upload_preset ( $options = [] )
delete_all_resources ( $options = [] )
delete_derived_resources ( $derived_resource_ids, $options = [] )
delete_resources ( $public_ids, $options = [] )
delete_resources_by_prefix ( $prefix, $options = [] )
delete_resources_by_tag ( $tag, $options = [] )
delete_streaming_profile ( $name, array $options = [] ) : Response Delete a streaming profile information. Predefined profiles are restored to the default setting.
delete_transformation ( $transformation, $options = [] )
delete_upload_mapping ( $name, $options = [] )
delete_upload_preset ( $name, $options = [] )
get_streaming_profile ( $name, array $options = [] ) : Response Get the information of a single streaming profile
list_streaming_profiles ( array $options = [] ) : Response List all streaming profiles associated with the current customer
parse_json_response ( $response )
ping ( $options = [] )
resource ( $public_id, $options = [] )
resource_types ( $options = [] )
resources ( $options = [] )
resources_by_ids ( $public_ids, $options = [] )
resources_by_moderation ( $kind, $status, $options = [] )
resources_by_tag ( $tag, $options = [] )
restore ( $public_ids, $options = [] )
root_folders ( $options = [] )
subfolders ( $of_folder_path, $options = [] )
tags ( $options = [] )
transformation ( $transformation, $options = [] )
transformations ( $options = [] )
update ( $public_id, $options = [] )
update_streaming_profile ( $name, array $options = [] ) : Response Update an existing streaming profile
update_transformation ( $transformation, $updates = [], $options = [] ) # updates - currently only supported update is the "allowed_for_strict" boolean flag
update_upload_mapping ( $name, $options = [] )
update_upload_preset ( $name, $options = [] )
upload_mapping ( $name, $options = [] )
upload_mappings ( $options = [] )
upload_preset ( $name, $options = [] )
upload_presets ( $options = [] )
usage ( $options = [] )

Protected Methods

Method Description
execute ( $ch ) # Based on http://snipplr.com/view/17242/
only ( &$hash, $keys )
prepare_streaming_profile_params ( $options ) : array Prepare streaming profile parameters for API calls
transformation_string ( $transformation )

Method Details

call_api() public method

public call_api ( $method, $uri, $params, &$options )

create_streaming_profile() public method

Create a new streaming profile
public create_streaming_profile ( $name, array $options = [] ) : Response
$name the name of the new profile. if the name is of a predefined profile, the profile will be modified.
$options array additional options
return Cloudinary\Api\Response

create_transformation() public method

public create_transformation ( $name, $definition, $options = [] )

create_upload_mapping() public method

public create_upload_mapping ( $name, $options = [] )

create_upload_preset() public method

public create_upload_preset ( $options = [] )

delete_all_resources() public method

public delete_all_resources ( $options = [] )

delete_derived_resources() public method

public delete_derived_resources ( $derived_resource_ids, $options = [] )

delete_resources() public method

public delete_resources ( $public_ids, $options = [] )

delete_resources_by_prefix() public method

public delete_resources_by_prefix ( $prefix, $options = [] )

delete_resources_by_tag() public method

public delete_resources_by_tag ( $tag, $options = [] )

delete_streaming_profile() public method

Delete a streaming profile information. Predefined profiles are restored to the default setting.
public delete_streaming_profile ( $name, array $options = [] ) : Response
$name the name of the streaming profile to delete
$options array additional options
return Cloudinary\Api\Response

delete_transformation() public method

public delete_transformation ( $transformation, $options = [] )

delete_upload_mapping() public method

public delete_upload_mapping ( $name, $options = [] )

delete_upload_preset() public method

public delete_upload_preset ( $name, $options = [] )

execute() protected method

# Based on http://snipplr.com/view/17242/
protected execute ( $ch )

get_streaming_profile() public method

Get the information of a single streaming profile
public get_streaming_profile ( $name, array $options = [] ) : Response
$name the name of the profile
$options array other options
return Cloudinary\Api\Response An array with a "data" key for results

list_streaming_profiles() public method

List all streaming profiles associated with the current customer
public list_streaming_profiles ( array $options = [] ) : Response
$options array options
return Cloudinary\Api\Response An array with a "data" key for results

only() protected method

protected only ( &$hash, $keys )

parse_json_response() static public method

static public parse_json_response ( $response )

ping() public method

public ping ( $options = [] )

prepare_streaming_profile_params() protected method

Prepare streaming profile parameters for API calls
protected prepare_streaming_profile_params ( $options ) : array
$options the options passed to the API
return array A single profile parameters

resource() public method

public resource ( $public_id, $options = [] )

resource_types() public method

public resource_types ( $options = [] )

resources() public method

public resources ( $options = [] )

resources_by_ids() public method

public resources_by_ids ( $public_ids, $options = [] )

resources_by_moderation() public method

public resources_by_moderation ( $kind, $status, $options = [] )

resources_by_tag() public method

public resources_by_tag ( $tag, $options = [] )

restore() public method

public restore ( $public_ids, $options = [] )

root_folders() public method

public root_folders ( $options = [] )

subfolders() public method

public subfolders ( $of_folder_path, $options = [] )

tags() public method

public tags ( $options = [] )

transformation() public method

public transformation ( $transformation, $options = [] )

transformation_string() protected method

protected transformation_string ( $transformation )

transformations() public method

public transformations ( $options = [] )

update() public method

public update ( $public_id, $options = [] )

update_streaming_profile() public method

Update an existing streaming profile
public update_streaming_profile ( $name, array $options = [] ) : Response
$name the name of the prodile
$options array additional options
return Cloudinary\Api\Response

update_transformation() public method

# updates - currently only supported update is the "allowed_for_strict" boolean flag
public update_transformation ( $transformation, $updates = [], $options = [] )

update_upload_mapping() public method

public update_upload_mapping ( $name, $options = [] )

update_upload_preset() public method

public update_upload_preset ( $name, $options = [] )

upload_mapping() public method

public upload_mapping ( $name, $options = [] )

upload_mappings() public method

public upload_mappings ( $options = [] )

upload_preset() public method

public upload_preset ( $name, $options = [] )

upload_presets() public method

public upload_presets ( $options = [] )

usage() public method

public usage ( $options = [] )

Property Details

$CLOUDINARY_API_ERROR_CLASSES static public property

static public $CLOUDINARY_API_ERROR_CLASSES