@@ -14,8 +14,8 @@ |
||
14 | 14 | interface ResettableInterface |
15 | 15 | { |
16 | 16 | |
17 | - /** |
|
18 | - * @return mixed |
|
19 | - */ |
|
20 | - public static function reset(); |
|
17 | + /** |
|
18 | + * @return mixed |
|
19 | + */ |
|
20 | + public static function reset(); |
|
21 | 21 | } |
@@ -6,5 +6,5 @@ |
||
6 | 6 | interface EEI_Event |
7 | 7 | { |
8 | 8 | |
9 | - public function name(); |
|
9 | + public function name(); |
|
10 | 10 | } |
@@ -15,24 +15,24 @@ |
||
15 | 15 | interface EEI_Related_Scope |
16 | 16 | { |
17 | 17 | |
18 | - /** |
|
19 | - * Used to return the related scope object. |
|
20 | - * @return object This may not necessarily be a EE_Base_Class object. |
|
21 | - */ |
|
22 | - public function get_related_scope_object(); |
|
18 | + /** |
|
19 | + * Used to return the related scope object. |
|
20 | + * @return object This may not necessarily be a EE_Base_Class object. |
|
21 | + */ |
|
22 | + public function get_related_scope_object(); |
|
23 | 23 | |
24 | 24 | |
25 | 25 | |
26 | - /** |
|
27 | - * Return the name representing the related_scope_object (i.e. Event Title, or Ticket Name). |
|
28 | - * @return string |
|
29 | - */ |
|
30 | - public function get_related_scope_name(); |
|
26 | + /** |
|
27 | + * Return the name representing the related_scope_object (i.e. Event Title, or Ticket Name). |
|
28 | + * @return string |
|
29 | + */ |
|
30 | + public function get_related_scope_name(); |
|
31 | 31 | |
32 | 32 | |
33 | - /** |
|
34 | - * Return the related scope ID. |
|
35 | - * @return mixed int|string |
|
36 | - */ |
|
37 | - public function get_ID(); |
|
33 | + /** |
|
34 | + * Return the related scope ID. |
|
35 | + * @return mixed int|string |
|
36 | + */ |
|
37 | + public function get_ID(); |
|
38 | 38 | } |
@@ -12,23 +12,23 @@ |
||
12 | 12 | { |
13 | 13 | |
14 | 14 | |
15 | - /** |
|
16 | - * Used to return the event object that can be derived from the EE_Base_Class object. |
|
17 | - * @return EE_Event |
|
18 | - */ |
|
19 | - public function get_related_event(); |
|
15 | + /** |
|
16 | + * Used to return the event object that can be derived from the EE_Base_Class object. |
|
17 | + * @return EE_Event |
|
18 | + */ |
|
19 | + public function get_related_event(); |
|
20 | 20 | |
21 | 21 | |
22 | - /** |
|
23 | - * Used to return the name of the event that can be derived from the EE_Base_Class object. |
|
24 | - * @return string |
|
25 | - */ |
|
26 | - public function get_event_name(); |
|
22 | + /** |
|
23 | + * Used to return the name of the event that can be derived from the EE_Base_Class object. |
|
24 | + * @return string |
|
25 | + */ |
|
26 | + public function get_event_name(); |
|
27 | 27 | |
28 | 28 | |
29 | - /** |
|
30 | - * Used to return the EVT_ID for the related event. |
|
31 | - * @return string |
|
32 | - */ |
|
33 | - public function get_event_ID(); |
|
29 | + /** |
|
30 | + * Used to return the EVT_ID for the related event. |
|
31 | + * @return string |
|
32 | + */ |
|
33 | + public function get_event_ID(); |
|
34 | 34 | } |
@@ -13,13 +13,13 @@ |
||
13 | 13 | |
14 | 14 | |
15 | 15 | |
16 | - /** |
|
17 | - * delete |
|
18 | - * |
|
19 | - * used for deleting the current object from the wherever the object is persisted ( ie: from the database, cache, session, etc ) |
|
20 | - * |
|
21 | - * @access public |
|
22 | - * @return bool | int |
|
23 | - */ |
|
24 | - public function delete(); |
|
16 | + /** |
|
17 | + * delete |
|
18 | + * |
|
19 | + * used for deleting the current object from the wherever the object is persisted ( ie: from the database, cache, session, etc ) |
|
20 | + * |
|
21 | + * @access public |
|
22 | + * @return bool | int |
|
23 | + */ |
|
24 | + public function delete(); |
|
25 | 25 | } |
@@ -6,12 +6,12 @@ |
||
6 | 6 | interface EEI_Request_Stack_Core_App |
7 | 7 | { |
8 | 8 | |
9 | - /** |
|
10 | - * gives the core app a chance to handle the response after the request stack has fully processed |
|
11 | - * |
|
12 | - * @deprecated 4.9.53 |
|
13 | - * @param EE_Request $request |
|
14 | - * @param EE_Response $response |
|
15 | - */ |
|
16 | - public function handle_response(EE_Request $request, EE_Response $response); |
|
9 | + /** |
|
10 | + * gives the core app a chance to handle the response after the request stack has fully processed |
|
11 | + * |
|
12 | + * @deprecated 4.9.53 |
|
13 | + * @param EE_Request $request |
|
14 | + * @param EE_Response $response |
|
15 | + */ |
|
16 | + public function handle_response(EE_Request $request, EE_Response $response); |
|
17 | 17 | } |
@@ -13,33 +13,33 @@ |
||
13 | 13 | |
14 | 14 | |
15 | 15 | |
16 | - /** |
|
17 | - * persist |
|
18 | - * |
|
19 | - * used for persisting the current object ( ie: to the database, cache, session, etc ) |
|
20 | - * can be supplied with a "persistence callback" on a per method call basis, |
|
21 | - * or the $persist_method property can be set in the class constructor, |
|
22 | - * for providing how to persist an object such as session caching, etc... |
|
23 | - * an array of arguments can also be supplied that will be passed along to the object's persistence method |
|
24 | - * |
|
25 | - * @access public |
|
26 | - * @param string $persistence_callback name of method found on object that can be used for persisting the object |
|
27 | - * @param array $persistence_arguments arrays of arguments that will be passed to the object's persistence method |
|
28 | - * @return bool | int |
|
29 | - * @throws \EE_Error |
|
30 | - */ |
|
31 | - public function persist($persistence_callback = '', $persistence_arguments = array()); |
|
16 | + /** |
|
17 | + * persist |
|
18 | + * |
|
19 | + * used for persisting the current object ( ie: to the database, cache, session, etc ) |
|
20 | + * can be supplied with a "persistence callback" on a per method call basis, |
|
21 | + * or the $persist_method property can be set in the class constructor, |
|
22 | + * for providing how to persist an object such as session caching, etc... |
|
23 | + * an array of arguments can also be supplied that will be passed along to the object's persistence method |
|
24 | + * |
|
25 | + * @access public |
|
26 | + * @param string $persistence_callback name of method found on object that can be used for persisting the object |
|
27 | + * @param array $persistence_arguments arrays of arguments that will be passed to the object's persistence method |
|
28 | + * @return bool | int |
|
29 | + * @throws \EE_Error |
|
30 | + */ |
|
31 | + public function persist($persistence_callback = '', $persistence_arguments = array()); |
|
32 | 32 | |
33 | 33 | |
34 | 34 | |
35 | - /** |
|
36 | - * persist_all |
|
37 | - * |
|
38 | - * calls \EEI_Repository::persist() on all objects within the repository |
|
39 | - * |
|
40 | - * @access public |
|
41 | - * @param string $persistence_callback name of method found on object that can be used for persisting it |
|
42 | - * @return bool | int |
|
43 | - */ |
|
44 | - public function persist_all($persistence_callback = ''); |
|
35 | + /** |
|
36 | + * persist_all |
|
37 | + * |
|
38 | + * calls \EEI_Repository::persist() on all objects within the repository |
|
39 | + * |
|
40 | + * @access public |
|
41 | + * @param string $persistence_callback name of method found on object that can be used for persisting it |
|
42 | + * @return bool | int |
|
43 | + */ |
|
44 | + public function persist_all($persistence_callback = ''); |
|
45 | 45 | } |
@@ -6,97 +6,97 @@ |
||
6 | 6 | interface EEI_Base |
7 | 7 | { |
8 | 8 | |
9 | - /** |
|
10 | - * gets the unique ID of the model object. If it hasn't been saved yet |
|
11 | - * to the database, this should be 0 or NULL |
|
12 | - */ |
|
13 | - public function ID(); |
|
14 | - |
|
15 | - |
|
16 | - |
|
17 | - /** |
|
18 | - * Returns an array where keys are field names and values are their values |
|
19 | - * |
|
20 | - * @return array |
|
21 | - */ |
|
22 | - public function model_field_array(); |
|
23 | - |
|
24 | - |
|
25 | - |
|
26 | - /** |
|
27 | - * Saves the thing to the database and returns success (or an ID) |
|
28 | - * |
|
29 | - * @return boolean success on insert; or int on update (ID of newly inserted thing) |
|
30 | - */ |
|
31 | - public function save(); |
|
32 | - |
|
33 | - |
|
34 | - |
|
35 | - /** |
|
36 | - * Similar to insert_post_meta, adds a record in the Extra_Meta model's table with the given key and value. |
|
37 | - * A $previous_value can be specified in case there are many meta rows with the same key |
|
38 | - * |
|
39 | - * @param string $meta_key |
|
40 | - * @param string $meta_value |
|
41 | - * @param string $previous_value |
|
42 | - * @return int records updated (or BOOLEAN if we actually ended up inserting the extra meta row) |
|
43 | - * NOTE: if the values haven't changed, returns 0 |
|
44 | - */ |
|
45 | - public function update_extra_meta($meta_key, $meta_value, $previous_value = null); |
|
46 | - |
|
47 | - |
|
48 | - |
|
49 | - /** |
|
50 | - * Adds a new extra meta record. If $unique is set to TRUE, we'll first double-check |
|
51 | - * no other extra meta for this model object have the same key. Returns TRUE if the |
|
52 | - * extra meta row was entered, false if not |
|
53 | - * |
|
54 | - * @param string $meta_key |
|
55 | - * @param string $meta_value |
|
56 | - * @param boolean $unique |
|
57 | - * @return boolean |
|
58 | - */ |
|
59 | - public function add_extra_meta($meta_key, $meta_value, $unique = false); |
|
60 | - |
|
61 | - |
|
62 | - |
|
63 | - /** |
|
64 | - * Deletes all the extra meta rows for this record as specified by key. If $meta_value |
|
65 | - * is specified, only deletes extra meta records with that value. |
|
66 | - * |
|
67 | - * @param string $meta_key |
|
68 | - * @param string $meta_value |
|
69 | - * @return int number of extra meta rows deleted |
|
70 | - */ |
|
71 | - public function delete_extra_meta($meta_key, $meta_value = null); |
|
72 | - |
|
73 | - |
|
74 | - |
|
75 | - /** |
|
76 | - * Gets the extra meta with the given meta key. If you specify "single" we just return 1, otherwise |
|
77 | - * an array of everything found. Requires that this model actually have a relation of type EE_Has_Many_Any_Relation. |
|
78 | - * You can specify $default is case you haven't found the extra meta |
|
79 | - * |
|
80 | - * @param string $meta_key |
|
81 | - * @param boolean $single |
|
82 | - * @param mixed $default if we don't find anything, what should we return? |
|
83 | - * @return mixed single value if $single; array if ! $single |
|
84 | - */ |
|
85 | - public function get_extra_meta($meta_key, $single = false, $default = null); |
|
86 | - |
|
87 | - |
|
88 | - |
|
89 | - /** |
|
90 | - * Gets a pretty view of the field's value. $extra_cache_ref can specify different formats for this. |
|
91 | - * The $extra_cache_ref will be passed to the model field's prepare_for_pretty_echoing, so consult the field's class |
|
92 | - * to see what options are available. |
|
93 | - * |
|
94 | - * @param string $field_name |
|
95 | - * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property |
|
96 | - * (in cases where the same property may be used for different outputs |
|
97 | - * - i.e. datetime, money etc.) |
|
98 | - * @return mixed |
|
99 | - * @throws \EE_Error |
|
100 | - */ |
|
101 | - public function get_pretty($field_name, $extra_cache_ref); |
|
9 | + /** |
|
10 | + * gets the unique ID of the model object. If it hasn't been saved yet |
|
11 | + * to the database, this should be 0 or NULL |
|
12 | + */ |
|
13 | + public function ID(); |
|
14 | + |
|
15 | + |
|
16 | + |
|
17 | + /** |
|
18 | + * Returns an array where keys are field names and values are their values |
|
19 | + * |
|
20 | + * @return array |
|
21 | + */ |
|
22 | + public function model_field_array(); |
|
23 | + |
|
24 | + |
|
25 | + |
|
26 | + /** |
|
27 | + * Saves the thing to the database and returns success (or an ID) |
|
28 | + * |
|
29 | + * @return boolean success on insert; or int on update (ID of newly inserted thing) |
|
30 | + */ |
|
31 | + public function save(); |
|
32 | + |
|
33 | + |
|
34 | + |
|
35 | + /** |
|
36 | + * Similar to insert_post_meta, adds a record in the Extra_Meta model's table with the given key and value. |
|
37 | + * A $previous_value can be specified in case there are many meta rows with the same key |
|
38 | + * |
|
39 | + * @param string $meta_key |
|
40 | + * @param string $meta_value |
|
41 | + * @param string $previous_value |
|
42 | + * @return int records updated (or BOOLEAN if we actually ended up inserting the extra meta row) |
|
43 | + * NOTE: if the values haven't changed, returns 0 |
|
44 | + */ |
|
45 | + public function update_extra_meta($meta_key, $meta_value, $previous_value = null); |
|
46 | + |
|
47 | + |
|
48 | + |
|
49 | + /** |
|
50 | + * Adds a new extra meta record. If $unique is set to TRUE, we'll first double-check |
|
51 | + * no other extra meta for this model object have the same key. Returns TRUE if the |
|
52 | + * extra meta row was entered, false if not |
|
53 | + * |
|
54 | + * @param string $meta_key |
|
55 | + * @param string $meta_value |
|
56 | + * @param boolean $unique |
|
57 | + * @return boolean |
|
58 | + */ |
|
59 | + public function add_extra_meta($meta_key, $meta_value, $unique = false); |
|
60 | + |
|
61 | + |
|
62 | + |
|
63 | + /** |
|
64 | + * Deletes all the extra meta rows for this record as specified by key. If $meta_value |
|
65 | + * is specified, only deletes extra meta records with that value. |
|
66 | + * |
|
67 | + * @param string $meta_key |
|
68 | + * @param string $meta_value |
|
69 | + * @return int number of extra meta rows deleted |
|
70 | + */ |
|
71 | + public function delete_extra_meta($meta_key, $meta_value = null); |
|
72 | + |
|
73 | + |
|
74 | + |
|
75 | + /** |
|
76 | + * Gets the extra meta with the given meta key. If you specify "single" we just return 1, otherwise |
|
77 | + * an array of everything found. Requires that this model actually have a relation of type EE_Has_Many_Any_Relation. |
|
78 | + * You can specify $default is case you haven't found the extra meta |
|
79 | + * |
|
80 | + * @param string $meta_key |
|
81 | + * @param boolean $single |
|
82 | + * @param mixed $default if we don't find anything, what should we return? |
|
83 | + * @return mixed single value if $single; array if ! $single |
|
84 | + */ |
|
85 | + public function get_extra_meta($meta_key, $single = false, $default = null); |
|
86 | + |
|
87 | + |
|
88 | + |
|
89 | + /** |
|
90 | + * Gets a pretty view of the field's value. $extra_cache_ref can specify different formats for this. |
|
91 | + * The $extra_cache_ref will be passed to the model field's prepare_for_pretty_echoing, so consult the field's class |
|
92 | + * to see what options are available. |
|
93 | + * |
|
94 | + * @param string $field_name |
|
95 | + * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property |
|
96 | + * (in cases where the same property may be used for different outputs |
|
97 | + * - i.e. datetime, money etc.) |
|
98 | + * @return mixed |
|
99 | + * @throws \EE_Error |
|
100 | + */ |
|
101 | + public function get_pretty($field_name, $extra_cache_ref); |
|
102 | 102 | } |
@@ -10,7 +10,7 @@ |
||
10 | 10 | interface ProgressStepsConfigInterface |
11 | 11 | { |
12 | 12 | |
13 | - public function get(); |
|
13 | + public function get(); |
|
14 | 14 | |
15 | - public function update(); |
|
15 | + public function update(); |
|
16 | 16 | } |