Current File : /var/www/html/buggydubrovnik.com/wp-content/plugins/imagify/classes/Context/ContextInterface.php
<?php
namespace Imagify\Context;
/**
* Interface to use for contexts.
*
* @since 1.9
* @author Grégory Viguier
*/
interface ContextInterface {
/**
* Get the main Instance.
*
* @since 1.9
* @author Grégory Viguier
*
* @return object Main instance.
*/
public static function get_instance();
/**
* Get the context "short name".
*
* @since 1.9
* @author Grégory Viguier
*
* @return string
*/
public function get_name();
/**
* Tell if the context is network-wide.
*
* @since 1.9
* @author Grégory Viguier
*
* @return bool
*/
public function is_network_wide();
/**
* Get the type of files this context allows.
*
* @since 1.9
* @see imagify_get_mime_types()
* @author Grégory Viguier
*
* @return string Possible values are:
* - 'all' to allow all types.
* - 'image' to allow only images.
* - 'not-image' to allow only pdf files.
*/
public function get_allowed_mime_types();
/**
* Get the thumbnail sizes for this context, except the full size.
*
* @since 1.9
* @author Grégory Viguier
*
* @return array {
* Data for the currently registered thumbnail sizes.
* Size names are used as array keys.
*
* @type int $width The image width.
* @type int $height The image height.
* @type bool $crop True to crop, false to resize.
* @type string $name The size name.
* }
*/
public function get_thumbnail_sizes();
/**
* Get images max width for this context. This is used when resizing.
* 0 means to not resize.
*
* @since 1.9.8
* @author Grégory Viguier
*
* @return int
*/
public function get_resizing_threshold();
/**
* Tell if the optimization process is allowed resize in this context.
*
* @since 1.9
* @author Grégory Viguier
*
* @return bool
*/
public function can_resize();
/**
* Tell if the optimization process is allowed to backup in this context.
*
* @since 1.9
* @author Grégory Viguier
*
* @return bool
*/
public function can_backup();
/**
* Tell if the current user is allowed to operate Imagify in this context.
*
* @since 1.9
* @author Grégory Viguier
*
* @param string $describer Capacity describer. See $this->get_capacity() for possible values. Can also be a "real" user capacity.
* @param int $media_id A media ID.
* @return bool
*/
public function current_user_can( $describer, $media_id = null );
/**
* Tell if a user is allowed to operate Imagify in this context.
*
* @since 1.9
* @author Grégory Viguier
*
* @param int $user_id A user ID.
* @param string $describer Capacity describer. See $this->get_capacity() for possible values. Can also be a "real" user capacity.
* @param int $media_id A media ID.
* @return bool
*/
public function user_can( $user_id, $describer, $media_id = null );
/**
* Get user capacity to operate Imagify in this context.
*
* @since 1.9
* @since 1.9 The describer 'auto-optimize' is not used anymore.
* @author Grégory Viguier
*
* @param string $describer Capacity describer. Possible values are like 'manage', 'bulk-optimize', 'manual-optimize', 'auto-optimize'.
* @return string
*/
public function get_capacity( $describer );
}
Mini Shell