1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
|
<?php
namespace Imagify\Context;
defined( 'ABSPATH' ) || die( 'Cheatin’ uh?' );
/**
* Interface to use for contexts.
*
* @since 1.9
* @author Grégory Viguier
*/
interface ContextInterface {
/**
* Get the main Instance.
*
* @since 1.9
* @access protected
* @author Grégory Viguier
*
* @return object Main instance.
*/
public static function get_instance();
/**
* Get the context "short name".
*
* @since 1.9
* @access public
* @author Grégory Viguier
*
* @return string
*/
public function get_name();
/**
* Tell if the context is network-wide.
*
* @since 1.9
* @access public
* @author Grégory Viguier
*
* @return bool
*/
public function is_network_wide();
/**
* Get the type of files this context allows.
*
* @since 1.9
* @access protected
* @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
* @access public
* @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
* @access public
* @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
* @access public
* @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
* @access public
* @author Grégory Viguier
*
* @return bool
*/
public function can_backup();
/**
* Tell if the optimization process is allowed to keep exif in this context.
*
* @since 1.9
* @access public
* @author Grégory Viguier
*
* @return bool
*/
public function can_keep_exif();
/**
* Tell if the current user is allowed to operate Imagify in this context.
*
* @since 1.9
* @access public
* @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
* @access public
* @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.
* @access public
* @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 );
}
|