Source Code Documentation


Field Summary | Method Summary | Field Detail | Method Detail

Package s2Member\Files

s2member\includes\classes\files-in.inc.php at line #28

Class c_ws_plugin__s2member_files_in

c_ws_plugin__s2member_files_in

public class c_ws_plugin__s2member_files_in

File Download routines for s2Member (inner processing routines).

Since:

3.5


( 18 Methods )
Method Summary
public static array

amazon_cf_auto_configure_distros()

Auto-configures Amazon® S3/CloudFront distros.

public static array

amazon_cf_create_distro(str $distro_type)

Creates an Amazon® S3/CloudFront Distro.

public static array

amazon_cf_create_distros_access_origin_identity()

Creates an Amazon® S3/CloudFront Access Origin Identity for all Distros.

public static array

amazon_cf_del_access_origin_identity(str $access_id, str $access_id_etag, str $access_id_xml)

Deletes an Amazon® S3/CloudFront Access Origin Identity.

public static array

amazon_cf_del_distro(str $distro_id, str $distro_id_etag, str $distro_id_xml)

Deletes an Amazon® S3/CloudFront Distro.

public static array

amazon_cf_disable_distro(str $distro_id, str $distro_id_etag, str $distro_id_xml)

Disables an Amazon® S3/CloudFront Distro.

public static array

amazon_cf_get_access_origin_identity(str $access_id)

Acquires an Amazon® S3/CloudFront Access Origin Identity.

public static array

amazon_cf_get_distro(str $distro_id, str $distro_type)

Acquires an Amazon® S3/CloudFront Distro.

public static str|bool

amazon_cf_rsa_sign(str $string)

Creates an Amazon® CloudFront RSA-SHA1 signature.

public static str

amazon_cf_sign(str $string)

Creates an Amazon® CloudFront HMAC-SHA1 signature.

public static str

amazon_cf_url(str $file, bool $stream, bool $inline, bool $ssl, str $basename, str $mimetype)

Creates an Amazon® CloudFront RSA-SHA1 signature URL.

public static array

amazon_s3_auto_configure_acls()

Auto-configures an Amazon® S3 Bucket's ACLs.

public static str

amazon_s3_sign(str $string)

Creates an Amazon® S3 HMAC-SHA1 signature.

public static str

amazon_s3_url(str $file, bool $stream, bool $inline, bool $ssl, str $basename, str $mimetype)

Creates an Amazon® S3 HMAC-SHA1 signature URL.

public static null|str

check_file_download_access(array $create_file_download_url)

Handles Download Access permissions.

public static bool

check_file_download_key(str $file, str $key)

Checks a File Download Key for validity.

public static obj

check_file_remote_authorization(obj $user)

Checks Header Authorization for Remote File Downloads.

public static str

create_file_download_url(array $config, bool $get_streamer_array)

Generates a File Download URL for access to a file protected by s2Member.

( 18 Methods )
Method Detail

s2member\includes\classes\files-in.inc.php at line #843

amazon_cf_auto_configure_distros()

public static array amazon_cf_auto_configure_distros()

Auto-configures Amazon® S3/CloudFront distros.

Since:

110926

Returns:

array - Array containing a true success element on success, else a failure array. Failure array will contain a failure code, and a failure message.

[ back to top ]

s2member\includes\classes\files-in.inc.php at line #1320

amazon_cf_create_distro()

public static array amazon_cf_create_distro(str $distro_type)

Creates an Amazon® S3/CloudFront Distro.

Since:

110926

Parameters:

str $distro_type - Required: downloads|streaming.

Returns:

array - Array containing a true success and distro_[distro_type]_id, distro_[distro_type]_dname elements on success, else a failure array. Failure array will contain a failure code, and a failure message.

[ back to top ]

s2member\includes\classes\files-in.inc.php at line #1106

amazon_cf_create_distros_access_origin_identity()

public static array amazon_cf_create_distros_access_origin_identity()

Creates an Amazon® S3/CloudFront Access Origin Identity for all Distros.

Since:

110926

Returns:

array - Array containing a true success and distros_access_id, distros_s3_access_id elements on success, else a failure array. Failure array will contain a failure code, and a failure message.

[ back to top ]

s2member\includes\classes\files-in.inc.php at line #1066

amazon_cf_del_access_origin_identity()

public static array amazon_cf_del_access_origin_identity(str $access_id, str $access_id_etag, str $access_id_xml)

Deletes an Amazon® S3/CloudFront Access Origin Identity.

Since:

110926

Parameters:

str $access_id - Required. An Origin Access ID.

str $access_id_etag - Required. An Origin Access ETag header.

str $access_id_xml - Required. An Origin Access Identity's XML configuration.

Returns:

array - Array containing a true success element on success, else a failure array. Failure array will contain a failure code, and a failure message.

[ back to top ]

s2member\includes\classes\files-in.inc.php at line #1252

amazon_cf_del_distro()

public static array amazon_cf_del_distro(str $distro_id, str $distro_id_etag, str $distro_id_xml)

Deletes an Amazon® S3/CloudFront Distro.

Since:

110926

Parameters:

str $distro_id - Required. A Distro ID.

str $distro_id_etag - Required. A Distro ETag header.

str $distro_id_xml - Required. A Distro's XML configuration.

Returns:

array - Array containing a true success element on success, else a failure array. Failure array will contain a failure code, and a failure message.

[ back to top ]

s2member\includes\classes\files-in.inc.php at line #1198

amazon_cf_disable_distro()

public static array amazon_cf_disable_distro(str $distro_id, str $distro_id_etag, str $distro_id_xml)

Disables an Amazon® S3/CloudFront Distro.

Since:

110926

Parameters:

str $distro_id - Required. A Distro ID.

str $distro_id_etag - Required. A Distro ETag header.

str $distro_id_xml - Required. A Distro's XML configuration.

Returns:

array - Array containing a true success and etag, xml, deployed elements on success, else a failure array. Failure array will contain a failure code, and a failure message.

[ back to top ]

s2member\includes\classes\files-in.inc.php at line #1018

amazon_cf_get_access_origin_identity()

public static array amazon_cf_get_access_origin_identity(str $access_id)

Acquires an Amazon® S3/CloudFront Access Origin Identity.

Since:

110926

Parameters:

str $access_id - Required. An Origin Access ID.

Returns:

array - Array containing a true success and etag, xml elements on success, else a failure array. Failure array will contain a failure code, and a failure message.

[ back to top ]

s2member\includes\classes\files-in.inc.php at line #1150

amazon_cf_get_distro()

public static array amazon_cf_get_distro(str $distro_id, str $distro_type)

Acquires an Amazon® S3/CloudFront Distro.

Since:

110926

Parameters:

str $distro_id - Required. A Distro ID.

str $distro_type - Required: downloads|streaming.

Returns:

array - Array containing a true success and etag, xml, deployed elements on success, else a failure array. Failure array will contain a failure code, and a failure message.

[ back to top ]

s2member\includes\classes\files-in.inc.php at line #789

amazon_cf_rsa_sign()

public static str|bool amazon_cf_rsa_sign(str $string)

Creates an Amazon® CloudFront RSA-SHA1 signature.

Since:

110926

Parameters:

str $string - Input string/data, to be signed by this routine.

Returns:

str|bool - An RSA-SHA1 signature for Amazon® CloudFront, else false on failure.

[ back to top ]

s2member\includes\classes\files-in.inc.php at line #774

amazon_cf_sign()

public static str amazon_cf_sign(str $string)

Creates an Amazon® CloudFront HMAC-SHA1 signature.

Since:

110926

Parameters:

str $string - Input string/data, to be signed by this routine.

Returns:

str - An HMAC-SHA1 signature for Amazon® CloudFront.

[ back to top ]

s2member\includes\classes\files-in.inc.php at line #809

amazon_cf_url()

public static str amazon_cf_url(str $file, bool $stream, bool $inline, bool $ssl, str $basename, str $mimetype)

Creates an Amazon® CloudFront RSA-SHA1 signature URL.

Since:

110926

Parameters:

str $file - Input file path, to be signed by this routine.

bool $stream - Is this resource file to be served as streaming media?

bool $inline - Is this resource file to be served inline, or no?

bool $ssl - Is this resource file to be served via SSL, or no?

str $basename - The absolute basename of the resource file.

str $mimetype - The MIME content-type of the resource file.

Returns:

str - An RSA-SHA1 signature URL for Amazon® CloudFront.

[ back to top ]

s2member\includes\classes\files-in.inc.php at line #688

amazon_s3_auto_configure_acls()

public static array amazon_s3_auto_configure_acls()

Auto-configures an Amazon® S3 Bucket's ACLs.

Since:

110926

Returns:

array - Array containing a true success element on success, else a failure array. Failure array will contain a failure code, and a failure message.

[ back to top ]

s2member\includes\classes\files-in.inc.php at line #639

amazon_s3_sign()

public static str amazon_s3_sign(str $string)

Creates an Amazon® S3 HMAC-SHA1 signature.

Since:

110524RC

Parameters:

str $string - Input string/data, to be signed by this routine.

Returns:

str - An HMAC-SHA1 signature for Amazon® S3.

[ back to top ]

s2member\includes\classes\files-in.inc.php at line #659

amazon_s3_url()

public static str amazon_s3_url(str $file, bool $stream, bool $inline, bool $ssl, str $basename, str $mimetype)

Creates an Amazon® S3 HMAC-SHA1 signature URL.

Since:

110926

Parameters:

str $file - Input file path, to be signed by this routine.

bool $stream - Is this resource file to be served as streaming media?

bool $inline - Is this resource file to be served inline, or no?

bool $ssl - Is this resource file to be served via SSL, or no?

str $basename - The absolute basename of the resource file.

str $mimetype - The MIME content-type of the resource file.

Returns:

str - An HMAC-SHA1 signature URL for Amazon® S3.

[ back to top ]

s2member\includes\classes\files-in.inc.php at line #44

check_file_download_access()

public static null|str check_file_download_access(array $create_file_download_url)

Handles Download Access permissions.

Since:

3.5

Attaches-to:

add_action("init");

Also-called-by:

API Function s2Member\API_Functionss2member_file_download_url(), w/ $create_file_download_url param.

Parameters:

array $create_file_download_url - Optional. If this function is called directly, we can pass arguments through this array. Possible array elements: file_download (required), file_download_key, file_stream, file_inline, file_storage, file_remote, file_ssl, file_rewrite, file_rewrite_base, skip_confirmation, url_to_storage_source, count_against_user, check_user.

Returns:

null|str - If called directly with $create_file_download_url, returns a string with the URL, based on configuration. Else, this function may exit script execution after serving a File Download.

[ back to top ]

s2member\includes\classes\files-in.inc.php at line #613

check_file_download_key()

public static bool check_file_download_key(str $file, str $key)

Checks a File Download Key for validity.

Since:

110926

Parameters:

str $file - Input File Download to validate.

str $key - Input File Download Key to validate.

Returns:

bool - True if valid, else false.

[ back to top ]

s2member\includes\classes\files-in.inc.php at line #574

check_file_remote_authorization()

public static obj check_file_remote_authorization(obj $user)

Checks Header Authorization for Remote File Downloads.

Since:

110926

Attaches-to:

add_filter("ws_plugin__s2member_check_file_download_access_user");

Parameters:

obj $user - Expects a WP_User object passed in by the Filter.

Returns:

obj - A WP_User object, possibly obtained through Header Authorization.

[ back to top ]

s2member\includes\classes\files-in.inc.php at line #524

create_file_download_url()

public static str create_file_download_url(array $config, bool $get_streamer_array)

Generates a File Download URL for access to a file protected by s2Member.

Since:

110926

Parameters:

array $config - Required. This is an array of configuration options associated with permissions being checked against the current User/Member; and also the actual URL generated by this routine. Possible $config array elements: file_download (required), file_download_key, file_stream, file_inline, file_storage, file_remote, file_ssl, file_rewrite, file_rewrite_base, skip_confirmation, url_to_storage_source, count_against_user, check_user.

bool $get_streamer_array - Optional. Defaults to false. If true, this function will return an array with the following elements: streamer, file, url. For further details, please review this section in your Dashboard: s2Member -› Download Options -› JW Player® & RTMP Protocol Examples.

Returns:

str - A File Download URL string on success; or an array on success, with elements streamer, file, url when/if $get_streamer_array is true; else false on any type of failure.

See Also:

s2Member\API_Functionss2member_file_download_url()

[ back to top ]

Source Code Documentation


Field Summary | Method Summary | Field Detail | Method Detail