@@ -26,7 +26,6 @@ |
||
26 | 26 | * ) |
27 | 27 | * ) |
28 | 28 | * @link http://codex.wordpress.org/Function_Reference/register_post_status for more info |
29 | - * @param boolean $store_in_db_as_int By default, enums are stored as STRINGS in the DB. However, if this var is set to true, it will be stored as an INT |
|
30 | 29 | */ |
31 | 30 | function __construct($table_column, $nicename, $nullable, $default_value, $new_stati = array()){ |
32 | 31 | $this->_register_new_stati( $new_stati ); |
@@ -1,6 +1,6 @@ discard block |
||
1 | 1 | <?php |
2 | -require_once( EE_MODELS . 'fields/EE_Enum_Text_Field.php' ); |
|
3 | -class EE_WP_Post_Status_Field extends EE_Enum_Text_Field{ |
|
2 | +require_once(EE_MODELS.'fields/EE_Enum_Text_Field.php'); |
|
3 | +class EE_WP_Post_Status_Field extends EE_Enum_Text_Field { |
|
4 | 4 | |
5 | 5 | protected $_wp_post_stati; |
6 | 6 | |
@@ -28,8 +28,8 @@ discard block |
||
28 | 28 | * @link http://codex.wordpress.org/Function_Reference/register_post_status for more info |
29 | 29 | * @param boolean $store_in_db_as_int By default, enums are stored as STRINGS in the DB. However, if this var is set to true, it will be stored as an INT |
30 | 30 | */ |
31 | - function __construct($table_column, $nicename, $nullable, $default_value, $new_stati = array()){ |
|
32 | - $this->_register_new_stati( $new_stati ); |
|
31 | + function __construct($table_column, $nicename, $nullable, $default_value, $new_stati = array()) { |
|
32 | + $this->_register_new_stati($new_stati); |
|
33 | 33 | $this->_set_allowed_enum_values(); |
34 | 34 | parent::__construct($table_column, $nicename, $nullable, $default_value, $this->_allowed_enum_values); |
35 | 35 | } |
@@ -46,18 +46,18 @@ discard block |
||
46 | 46 | * @param array $new_stati statuses |
47 | 47 | * @return void |
48 | 48 | */ |
49 | - protected function _register_new_stati( $new_stati ) { |
|
49 | + protected function _register_new_stati($new_stati) { |
|
50 | 50 | |
51 | - foreach ( (array) $new_stati as $status_key => $status_args ) { |
|
51 | + foreach ((array) $new_stati as $status_key => $status_args) { |
|
52 | 52 | $args = array( |
53 | - 'label' => isset( $status_args['label'] ) ? $status_args['label'] : $status_key, |
|
54 | - 'public' => isset( $status_args['public'] ) && is_bool( $status_args['public'] ) ? $status_args['public'] : TRUE, |
|
55 | - 'exclude_from_search' => isset( $status_args['exclude_from_search'] ) && is_bool($status_args['exclude_from_search'] ) ? $status_args['exclude_from_search'] : FALSE, |
|
56 | - 'show_in_admin_all_list' => isset( $status_args['show_in_admin_all_list'] ) && is_bool( $status_args['show_in_admin_all_list'] ) ? $status_args['show_in_admin_all_list'] : FALSE, |
|
57 | - 'show_in_admin_status_list' => isset( $status_args['show_in_admin_status_list'] ) && is_bool( $status_args['show_in_admin_status_list'] ) ? $status_args['show_in_admin_status_list'] : TRUE, |
|
58 | - 'label_count' => isset( $status_args['label_count'] ) ? $status_args['label_count'] : '' |
|
53 | + 'label' => isset($status_args['label']) ? $status_args['label'] : $status_key, |
|
54 | + 'public' => isset($status_args['public']) && is_bool($status_args['public']) ? $status_args['public'] : TRUE, |
|
55 | + 'exclude_from_search' => isset($status_args['exclude_from_search']) && is_bool($status_args['exclude_from_search']) ? $status_args['exclude_from_search'] : FALSE, |
|
56 | + 'show_in_admin_all_list' => isset($status_args['show_in_admin_all_list']) && is_bool($status_args['show_in_admin_all_list']) ? $status_args['show_in_admin_all_list'] : FALSE, |
|
57 | + 'show_in_admin_status_list' => isset($status_args['show_in_admin_status_list']) && is_bool($status_args['show_in_admin_status_list']) ? $status_args['show_in_admin_status_list'] : TRUE, |
|
58 | + 'label_count' => isset($status_args['label_count']) ? $status_args['label_count'] : '' |
|
59 | 59 | ); |
60 | - register_post_status( $status_key, $status_args ); |
|
60 | + register_post_status($status_key, $status_args); |
|
61 | 61 | } |
62 | 62 | |
63 | 63 | } |
@@ -78,7 +78,7 @@ discard block |
||
78 | 78 | global $wp_post_statuses; |
79 | 79 | $this->_wp_post_stati = $wp_post_statuses; |
80 | 80 | |
81 | - foreach( $this->_wp_post_stati as $post_status => $args_object ) { |
|
81 | + foreach ($this->_wp_post_stati as $post_status => $args_object) { |
|
82 | 82 | $this->_allowed_enum_values[$post_status] = $args_object->label; |
83 | 83 | } |
84 | 84 | |
@@ -108,7 +108,7 @@ discard block |
||
108 | 108 | * @param string $status What status object you want |
109 | 109 | * @return std_object the status object or FALSE if it doesn't exist. |
110 | 110 | */ |
111 | - public function get_status_object( $status ) { |
|
112 | - return isset( $this->_wp_post_stati[$status] ) ? $this->_wp_post_stati[$status] : FALSE; |
|
111 | + public function get_status_object($status) { |
|
112 | + return isset($this->_wp_post_stati[$status]) ? $this->_wp_post_stati[$status] : FALSE; |
|
113 | 113 | } |
114 | 114 | } |
115 | 115 | \ No newline at end of file |
@@ -43,16 +43,30 @@ discard block |
||
43 | 43 | |
44 | 44 | private $_group_by_sql; |
45 | 45 | |
46 | + /** |
|
47 | + * @param string $limit_sql |
|
48 | + */ |
|
46 | 49 | function set_limit_sql($limit_sql){ |
47 | 50 | $this->_limit_sql = $limit_sql; |
48 | 51 | } |
49 | 52 | |
53 | + /** |
|
54 | + * @param string $order_by_sql |
|
55 | + */ |
|
50 | 56 | function set_order_by_sql($order_by_sql){ |
51 | 57 | $this->_order_by_sql = $order_by_sql; |
52 | 58 | } |
59 | + |
|
60 | + /** |
|
61 | + * @param string $group_by_sql |
|
62 | + */ |
|
53 | 63 | function set_group_by_sql($group_by_sql){ |
54 | 64 | $this->_group_by_sql = $group_by_sql; |
55 | 65 | } |
66 | + |
|
67 | + /** |
|
68 | + * @param string $having_sql |
|
69 | + */ |
|
56 | 70 | function set_having_sql($having_sql){ |
57 | 71 | $this->_having_sql = $having_sql; |
58 | 72 | } |
@@ -72,7 +86,6 @@ discard block |
||
72 | 86 | * |
73 | 87 | * @param type $model_included_name |
74 | 88 | * @param type $join_sql |
75 | - * @param type $data_types |
|
76 | 89 | */ |
77 | 90 | public function __construct($model_included_name= array(), $join_sql = ''){ |
78 | 91 | $this->_models_included = $model_included_name; |
@@ -11,8 +11,8 @@ discard block |
||
11 | 11 | */ |
12 | 12 | class EE_Model_Query_Info_Carrier extends EE_Base{ |
13 | 13 | /** |
14 | - * @var string SQL for performing joins (Eg, "INNER JOIN blah ON blah=blah INNER JOIN FOO ON foo=foo...") |
|
15 | - */ |
|
14 | + * @var string SQL for performing joins (Eg, "INNER JOIN blah ON blah=blah INNER JOIN FOO ON foo=foo...") |
|
15 | + */ |
|
16 | 16 | private $_join_sql; |
17 | 17 | /** |
18 | 18 | * |
@@ -132,7 +132,7 @@ discard block |
||
132 | 132 | * @return string |
133 | 133 | */ |
134 | 134 | public function get_main_model_join_sql() { |
135 | - return $this->_main_join_sql; |
|
135 | + return $this->_main_join_sql; |
|
136 | 136 | } |
137 | 137 | |
138 | 138 |
@@ -9,7 +9,7 @@ discard block |
||
9 | 9 | * We could have returned an array |
10 | 10 | * with two keys 'join_sql' and 'data_types', but this better-defines the data being passed around |
11 | 11 | */ |
12 | -class EE_Model_Query_Info_Carrier extends EE_Base{ |
|
12 | +class EE_Model_Query_Info_Carrier extends EE_Base { |
|
13 | 13 | /** |
14 | 14 | * @var string SQL for performing joins (Eg, "INNER JOIN blah ON blah=blah INNER JOIN FOO ON foo=foo...") |
15 | 15 | */ |
@@ -43,29 +43,29 @@ discard block |
||
43 | 43 | |
44 | 44 | private $_group_by_sql; |
45 | 45 | |
46 | - function set_limit_sql($limit_sql){ |
|
46 | + function set_limit_sql($limit_sql) { |
|
47 | 47 | $this->_limit_sql = $limit_sql; |
48 | 48 | } |
49 | 49 | |
50 | - function set_order_by_sql($order_by_sql){ |
|
50 | + function set_order_by_sql($order_by_sql) { |
|
51 | 51 | $this->_order_by_sql = $order_by_sql; |
52 | 52 | } |
53 | - function set_group_by_sql($group_by_sql){ |
|
53 | + function set_group_by_sql($group_by_sql) { |
|
54 | 54 | $this->_group_by_sql = $group_by_sql; |
55 | 55 | } |
56 | - function set_having_sql($having_sql){ |
|
56 | + function set_having_sql($having_sql) { |
|
57 | 57 | $this->_having_sql = $having_sql; |
58 | 58 | } |
59 | - function get_limit_sql(){ |
|
59 | + function get_limit_sql() { |
|
60 | 60 | return $this->_limit_sql; |
61 | 61 | } |
62 | - function get_order_by_sql(){ |
|
62 | + function get_order_by_sql() { |
|
63 | 63 | return $this->_order_by_sql; |
64 | 64 | } |
65 | - function get_group_by_sql(){ |
|
65 | + function get_group_by_sql() { |
|
66 | 66 | return $this->_group_by_sql; |
67 | 67 | } |
68 | - function get_having_sql(){ |
|
68 | + function get_having_sql() { |
|
69 | 69 | return $this->_having_sql; |
70 | 70 | } |
71 | 71 | /** |
@@ -74,7 +74,7 @@ discard block |
||
74 | 74 | * @param type $join_sql |
75 | 75 | * @param type $data_types |
76 | 76 | */ |
77 | - public function __construct($model_included_name= array(), $join_sql = ''){ |
|
77 | + public function __construct($model_included_name = array(), $join_sql = '') { |
|
78 | 78 | $this->_models_included = $model_included_name; |
79 | 79 | $this->_join_sql = $join_sql; |
80 | 80 | } |
@@ -83,10 +83,10 @@ discard block |
||
83 | 83 | * Merges info from the other EEM_Related_Model_Info_Carrier into this one. |
84 | 84 | * @param EE_Model_Query_Info_Carrier $other_model_query_info_carrier |
85 | 85 | */ |
86 | - public function merge( $other_model_query_info_carrier ){ |
|
87 | - if( $other_model_query_info_carrier && ! $this->_have_already_included_one_of_these_models($other_model_query_info_carrier->get_model_names_included())){ |
|
88 | - $model_included_on_other_join_sql_and_data_types_carrier = $other_model_query_info_carrier->get_model_names_included(); |
|
89 | - $this->_models_included = array_merge( $this->_models_included, $model_included_on_other_join_sql_and_data_types_carrier ); |
|
86 | + public function merge($other_model_query_info_carrier) { |
|
87 | + if ($other_model_query_info_carrier && ! $this->_have_already_included_one_of_these_models($other_model_query_info_carrier->get_model_names_included())) { |
|
88 | + $model_included_on_other_join_sql_and_data_types_carrier = $other_model_query_info_carrier->get_model_names_included(); |
|
89 | + $this->_models_included = array_merge($this->_models_included, $model_included_on_other_join_sql_and_data_types_carrier); |
|
90 | 90 | $this->_join_sql .= $other_model_query_info_carrier->_join_sql; |
91 | 91 | } |
92 | 92 | //otherwise don't merge our data. |
@@ -100,9 +100,9 @@ discard block |
||
100 | 100 | * @param array $model_names just like EE_MOdel_QUery_Info_Carrier::_models_included: keys are model chain paths, values are the model names only |
101 | 101 | * @return boolean |
102 | 102 | */ |
103 | - protected function _have_already_included_one_of_these_models($model_names){ |
|
104 | - foreach($this->_models_included as $model_relation_path=>$model_included){ |
|
105 | - if(array_key_exists($model_relation_path, $model_names)){ |
|
103 | + protected function _have_already_included_one_of_these_models($model_names) { |
|
104 | + foreach ($this->_models_included as $model_relation_path=>$model_included) { |
|
105 | + if (array_key_exists($model_relation_path, $model_names)) { |
|
106 | 106 | return true; |
107 | 107 | } |
108 | 108 | } |
@@ -112,17 +112,17 @@ discard block |
||
112 | 112 | * Array keys are model names, values are "model relation paths". See EE_Model_Query_Info_Carrier::_models_included for details |
113 | 113 | * @return array like EE_Model_Query_Info_Carrier::_models_included |
114 | 114 | */ |
115 | - public function get_model_names_included(){ |
|
115 | + public function get_model_names_included() { |
|
116 | 116 | return $this->_models_included; |
117 | 117 | } |
118 | 118 | /** |
119 | 119 | * sets the $where_sql for later use from client code |
120 | 120 | * @param string $where_sql |
121 | 121 | */ |
122 | - public function set_where_sql($where_sql){ |
|
122 | + public function set_where_sql($where_sql) { |
|
123 | 123 | $this->_where_sql = $where_sql; |
124 | 124 | } |
125 | - public function get_where_sql(){ |
|
125 | + public function get_where_sql() { |
|
126 | 126 | return $this->_where_sql; |
127 | 127 | } |
128 | 128 | |
@@ -143,10 +143,10 @@ discard block |
||
143 | 143 | * after the FROM and before the WHERE.) |
144 | 144 | * @param string $join_sql |
145 | 145 | */ |
146 | - public function set_main_model_join_sql($join_sql){ |
|
146 | + public function set_main_model_join_sql($join_sql) { |
|
147 | 147 | $this->_main_join_sql = $join_sql; |
148 | 148 | } |
149 | - public function get_full_join_sql(){ |
|
150 | - return $this->_main_join_sql . $this->_join_sql; |
|
149 | + public function get_full_join_sql() { |
|
150 | + return $this->_main_join_sql.$this->_join_sql; |
|
151 | 151 | } |
152 | 152 | } |
153 | 153 | \ No newline at end of file |
@@ -49,7 +49,7 @@ discard block |
||
49 | 49 | * creates join statement FROM primary table |
50 | 50 | * gets SQL like "LEFT JOIN table_name AS table_alias ON other_table_alias.pk = table_alias.fk |
51 | 51 | * |
52 | - * @param string $table allows us to set special conditions on the $table_name portion of the join query (i.e. doing a subquery) |
|
52 | + * @param string $primary_table_alias_with_model_chain_prefix |
|
53 | 53 | * @return string of SQL |
54 | 54 | */ |
55 | 55 | function get_join_sql( $primary_table_alias_with_model_chain_prefix ){ |
@@ -72,6 +72,7 @@ discard block |
||
72 | 72 | * " LEFT JOIN secondary_table_table AS Secondary ON ..." like get_join_sql, this function returns |
73 | 73 | * " LEFT JOIN primary_table AS Primary ON ...". |
74 | 74 | * This is useful if the secondary table is already included in the SQL, but the primary table is not yet. |
75 | + * @param string $secondary_table_alias_with_model_chain_prefix |
|
75 | 76 | * @return string |
76 | 77 | */ |
77 | 78 | function get_inverse_join_sql($secondary_table_alias_with_model_chain_prefix){ |
@@ -5,8 +5,8 @@ discard block |
||
5 | 5 | * table's rows. Ie, it can't have many rows in the secondary table that point to |
6 | 6 | * a single row in the primary table |
7 | 7 | */ |
8 | -require_once( EE_MODELS . 'helpers/EE_Table_Base.php'); |
|
9 | -class EE_Secondary_Table extends EE_Table_Base{ |
|
8 | +require_once(EE_MODELS.'helpers/EE_Table_Base.php'); |
|
9 | +class EE_Secondary_Table extends EE_Table_Base { |
|
10 | 10 | protected $_extra_join_conditions; |
11 | 11 | |
12 | 12 | /** |
@@ -19,15 +19,15 @@ discard block |
||
19 | 19 | * @param boolean $global whether the table is "global" as in there is only 1 table on an entire multisite install, |
20 | 20 | * or whether each site on a multisite install has a copy of this table |
21 | 21 | */ |
22 | - function __construct($table_name, $pk_column, $fk_column = null, $extra_join_conditions = null, $global = false ){ |
|
22 | + function __construct($table_name, $pk_column, $fk_column = null, $extra_join_conditions = null, $global = false) { |
|
23 | 23 | $this->_fk_on_table = $fk_column; |
24 | 24 | $this->_extra_join_conditions = $extra_join_conditions; |
25 | - parent::__construct( $table_name, $pk_column, $global ); |
|
25 | + parent::__construct($table_name, $pk_column, $global); |
|
26 | 26 | } |
27 | - function get_fk_on_table(){ |
|
27 | + function get_fk_on_table() { |
|
28 | 28 | return $this->_fk_on_table; |
29 | 29 | } |
30 | - function _construct_finalize_set_table_to_join_with(EE_Table_Base $table){ |
|
30 | + function _construct_finalize_set_table_to_join_with(EE_Table_Base $table) { |
|
31 | 31 | $this->_table_to_join_with = $table; |
32 | 32 | } |
33 | 33 | /** |
@@ -35,14 +35,14 @@ discard block |
||
35 | 35 | * @return string of sql like "Event.post_type = 'event'", which gets added to |
36 | 36 | * the end of the join statement with the primary table |
37 | 37 | */ |
38 | - function get_extra_join_conditions(){ |
|
38 | + function get_extra_join_conditions() { |
|
39 | 39 | return $this->_extra_join_conditions; |
40 | 40 | } |
41 | 41 | /** |
42 | 42 | * |
43 | 43 | * @return EE_Primary_Table |
44 | 44 | */ |
45 | - function get_table_to_join_with(){ |
|
45 | + function get_table_to_join_with() { |
|
46 | 46 | return $this->_table_to_join_with; |
47 | 47 | } |
48 | 48 | /** |
@@ -52,15 +52,15 @@ discard block |
||
52 | 52 | * @param string $table allows us to set special conditions on the $table_name portion of the join query (i.e. doing a subquery) |
53 | 53 | * @return string of SQL |
54 | 54 | */ |
55 | - function get_join_sql( $primary_table_alias_with_model_chain_prefix ){ |
|
55 | + function get_join_sql($primary_table_alias_with_model_chain_prefix) { |
|
56 | 56 | |
57 | 57 | $table_name = $this->get_table_name(); |
58 | - $secondary_table_alias = EE_Model_Parser::get_prefix_from_table_alias_with_model_relation_chain_prefix($primary_table_alias_with_model_chain_prefix) . $this->get_table_alias(); |
|
58 | + $secondary_table_alias = EE_Model_Parser::get_prefix_from_table_alias_with_model_relation_chain_prefix($primary_table_alias_with_model_chain_prefix).$this->get_table_alias(); |
|
59 | 59 | $other_table_pk = $this->get_table_to_join_with()->get_pk_column(); |
60 | 60 | $fk = $this->get_fk_on_table(); |
61 | 61 | $join_sql = " LEFT JOIN $table_name AS $secondary_table_alias ON $primary_table_alias_with_model_chain_prefix.$other_table_pk = $secondary_table_alias.$fk "; |
62 | - if($this->get_extra_join_conditions()){ |
|
63 | - $join_sql.="AND ".$this->get_extra_join_conditions(); |
|
62 | + if ($this->get_extra_join_conditions()) { |
|
63 | + $join_sql .= "AND ".$this->get_extra_join_conditions(); |
|
64 | 64 | } |
65 | 65 | return $join_sql; |
66 | 66 | } |
@@ -74,14 +74,14 @@ discard block |
||
74 | 74 | * This is useful if the secondary table is already included in the SQL, but the primary table is not yet. |
75 | 75 | * @return string |
76 | 76 | */ |
77 | - function get_inverse_join_sql($secondary_table_alias_with_model_chain_prefix){ |
|
78 | - $primary_table_name =$this->get_table_to_join_with()->get_table_name(); |
|
79 | - $primary_table_alias = EE_Model_Parser::get_prefix_from_table_alias_with_model_relation_chain_prefix($secondary_table_alias_with_model_chain_prefix) . $this->get_table_to_join_with()->get_table_alias(); |
|
80 | - $primary_table_pk = $this->get_table_to_join_with()->get_pk_column();//$this->get_pk_column(); |
|
77 | + function get_inverse_join_sql($secondary_table_alias_with_model_chain_prefix) { |
|
78 | + $primary_table_name = $this->get_table_to_join_with()->get_table_name(); |
|
79 | + $primary_table_alias = EE_Model_Parser::get_prefix_from_table_alias_with_model_relation_chain_prefix($secondary_table_alias_with_model_chain_prefix).$this->get_table_to_join_with()->get_table_alias(); |
|
80 | + $primary_table_pk = $this->get_table_to_join_with()->get_pk_column(); //$this->get_pk_column(); |
|
81 | 81 | $fk = $this->get_fk_on_table(); |
82 | 82 | $join_sql = " LEFT JOIN $primary_table_name AS $primary_table_alias ON $primary_table_alias.$primary_table_pk = $secondary_table_alias_with_model_chain_prefix.$fk "; |
83 | - if($this->get_extra_join_conditions()){ |
|
84 | - $join_sql.="AND ".$this->get_extra_join_conditions(); |
|
83 | + if ($this->get_extra_join_conditions()) { |
|
84 | + $join_sql .= "AND ".$this->get_extra_join_conditions(); |
|
85 | 85 | } |
86 | 86 | return $join_sql; |
87 | 87 | } |
@@ -94,7 +94,7 @@ discard block |
||
94 | 94 | public function get_select_join_limit_join($limit) { |
95 | 95 | //first get the select |
96 | 96 | $select = $this->get_select_join_limit($limit); |
97 | - $join_sql = $this->get_join_sql( $select ); |
|
97 | + $join_sql = $this->get_join_sql($select); |
|
98 | 98 | return $join_sql; |
99 | 99 | } |
100 | 100 | |
@@ -103,12 +103,12 @@ discard block |
||
103 | 103 | function get_fully_qualified_fk_column() { |
104 | 104 | $table_alias = $this->get_table_alias(); |
105 | 105 | $fk = $this->get_fk_on_table(); |
106 | - return $table_alias . '.' . $fk; |
|
106 | + return $table_alias.'.'.$fk; |
|
107 | 107 | } |
108 | 108 | |
109 | 109 | function get_fully_qualified_pk_on_fk_table() { |
110 | 110 | $table_alias = $this->get_table_to_join_with()->get_table_alias(); |
111 | 111 | $pk = $this->get_table_to_join_with()->get_pk_column(); |
112 | - return $table_alias . '.' . $pk; |
|
112 | + return $table_alias.'.'.$pk; |
|
113 | 113 | } |
114 | 114 | } |
115 | 115 | \ No newline at end of file |
@@ -17,6 +17,7 @@ discard block |
||
17 | 17 | * get related models across the relation, and add-and-remove the relationships. |
18 | 18 | * @param boolean $block_deletes for this type of relation, we block by default for now. if there are related models across this relation, block (prevent and add an error) the deletion of this model |
19 | 19 | * @param type $blocking_delete_error_message a customized error message on blocking deletes instead of the default |
20 | + * @param string $joining_model_name |
|
20 | 21 | */ |
21 | 22 | function __construct($joining_model_name,$block_deletes = true, $blocking_delete_error_message =''){ |
22 | 23 | $this->_joining_model_name = $joining_model_name; |
@@ -24,7 +25,7 @@ discard block |
||
24 | 25 | } |
25 | 26 | /** |
26 | 27 | * Gets the joining model's object |
27 | - * @return EEM_Base |
|
28 | + * @return boolean |
|
28 | 29 | */ |
29 | 30 | function get_join_model(){ |
30 | 31 | return $this->_get_model($this->_joining_model_name); |
@@ -1,7 +1,7 @@ discard block |
||
1 | 1 | <?php |
2 | 2 | |
3 | -require_once( EE_MODELS . 'relations/EE_Model_Relation_Base.php'); |
|
4 | -class EE_HABTM_Relation extends EE_Model_Relation_Base{ |
|
3 | +require_once(EE_MODELS.'relations/EE_Model_Relation_Base.php'); |
|
4 | +class EE_HABTM_Relation extends EE_Model_Relation_Base { |
|
5 | 5 | /** |
6 | 6 | * Model whicih defines the relation between two other models. Eg, the EE_Event_Question_Group model, |
7 | 7 | * which joins EE_Event and EE_Question_Group |
@@ -18,7 +18,7 @@ discard block |
||
18 | 18 | * @param boolean $block_deletes for this type of relation, we block by default for now. if there are related models across this relation, block (prevent and add an error) the deletion of this model |
19 | 19 | * @param type $blocking_delete_error_message a customized error message on blocking deletes instead of the default |
20 | 20 | */ |
21 | - function __construct($joining_model_name,$block_deletes = true, $blocking_delete_error_message =''){ |
|
21 | + function __construct($joining_model_name, $block_deletes = true, $blocking_delete_error_message = '') { |
|
22 | 22 | $this->_joining_model_name = $joining_model_name; |
23 | 23 | parent::__construct($block_deletes, $blocking_delete_error_message); |
24 | 24 | } |
@@ -26,7 +26,7 @@ discard block |
||
26 | 26 | * Gets the joining model's object |
27 | 27 | * @return EEM_Base |
28 | 28 | */ |
29 | - function get_join_model(){ |
|
29 | + function get_join_model() { |
|
30 | 30 | return $this->_get_model($this->_joining_model_name); |
31 | 31 | } |
32 | 32 | /** |
@@ -34,21 +34,21 @@ discard block |
||
34 | 34 | * @param string $model_relation_chain like 'Event.Event_Venue.Venue' |
35 | 35 | * @return string of SQL |
36 | 36 | */ |
37 | - function get_join_to_intermediate_model_statement($model_relation_chain){ |
|
37 | + function get_join_to_intermediate_model_statement($model_relation_chain) { |
|
38 | 38 | //create sql like |
39 | 39 | //LEFT JOIN join_table AS join_table_alias ON this_table_alias.this_table_pk = join_table_alias.join_table_fk_to_this |
40 | 40 | //LEFT JOIN other_table AS other_table_alias ON join_table_alias.join_table_fk_to_other = other_table_alias.other_table_pk |
41 | 41 | //remember the model relation chain to the JOIN model, because we'll |
42 | 42 | //need it for get_join_statement() |
43 | 43 | $this->_model_relation_chain_to_join_model = $model_relation_chain; |
44 | - $this_table_pk_field = $this->get_this_model()->get_primary_key_field();//get_foreign_key_to($this->get_other_model()->get_this_model_name()); |
|
44 | + $this_table_pk_field = $this->get_this_model()->get_primary_key_field(); //get_foreign_key_to($this->get_other_model()->get_this_model_name()); |
|
45 | 45 | $join_table_fk_field_to_this_table = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name()); |
46 | - $this_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain, $this->get_this_model()->get_this_model_name()) . $this_table_pk_field->get_table_alias(); |
|
46 | + $this_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain, $this->get_this_model()->get_this_model_name()).$this_table_pk_field->get_table_alias(); |
|
47 | 47 | |
48 | - $join_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain, $this->get_join_model()->get_this_model_name()) . $join_table_fk_field_to_this_table->get_table_alias(); |
|
48 | + $join_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain, $this->get_join_model()->get_this_model_name()).$join_table_fk_field_to_this_table->get_table_alias(); |
|
49 | 49 | $join_table = $this->get_join_model()->get_table_for_alias($join_table_alias); |
50 | 50 | //phew! ok, we have all the info we need, now we can create the SQL join string |
51 | - $SQL = $this->_left_join($join_table, $join_table_alias, $join_table_fk_field_to_this_table->get_table_column(), $this_table_alias, $this_table_pk_field->get_table_column()) . $this->get_join_model()->_construct_internal_join_to_table_with_alias($join_table_alias); |
|
51 | + $SQL = $this->_left_join($join_table, $join_table_alias, $join_table_fk_field_to_this_table->get_table_column(), $this_table_alias, $this_table_pk_field->get_table_column()).$this->get_join_model()->_construct_internal_join_to_table_with_alias($join_table_alias); |
|
52 | 52 | |
53 | 53 | return $SQL; |
54 | 54 | } |
@@ -60,18 +60,18 @@ discard block |
||
60 | 60 | * @param string $model_relation_chain like 'Event.Event_Venue.Venue' |
61 | 61 | * @return string of SQL |
62 | 62 | */ |
63 | - function get_join_statement($model_relation_chain){ |
|
64 | - if( $this->_model_relation_chain_to_join_model === NULL ){ |
|
65 | - throw new EE_Error( sprintf( __( 'When using EE_HABTM_Relation to create a join, you must call get_join_to_intermediate_model_statement BEFORE get_join_statement', 'event_espresso' ))); |
|
63 | + function get_join_statement($model_relation_chain) { |
|
64 | + if ($this->_model_relation_chain_to_join_model === NULL) { |
|
65 | + throw new EE_Error(sprintf(__('When using EE_HABTM_Relation to create a join, you must call get_join_to_intermediate_model_statement BEFORE get_join_statement', 'event_espresso'))); |
|
66 | 66 | } |
67 | 67 | $join_table_fk_field_to_this_table = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name()); |
68 | - $join_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($this->_model_relation_chain_to_join_model, $this->get_join_model()->get_this_model_name()) . $join_table_fk_field_to_this_table->get_table_alias(); |
|
68 | + $join_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($this->_model_relation_chain_to_join_model, $this->get_join_model()->get_this_model_name()).$join_table_fk_field_to_this_table->get_table_alias(); |
|
69 | 69 | $other_table_pk_field = $this->get_other_model()->get_primary_key_field(); |
70 | 70 | $join_table_fk_field_to_other_table = $this->get_join_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name()); |
71 | - $other_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain, $this->get_other_model()->get_this_model_name()) . $other_table_pk_field->get_table_alias(); |
|
71 | + $other_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix($model_relation_chain, $this->get_other_model()->get_this_model_name()).$other_table_pk_field->get_table_alias(); |
|
72 | 72 | $other_table = $this->get_other_model()->get_table_for_alias($other_table_alias); |
73 | 73 | |
74 | - $SQL = $this->_left_join($other_table, $other_table_alias, $other_table_pk_field->get_table_column(), $join_table_alias, $join_table_fk_field_to_other_table->get_table_column()) . $this->get_other_model()->_construct_internal_join_to_table_with_alias($other_table_alias); |
|
74 | + $SQL = $this->_left_join($other_table, $other_table_alias, $other_table_pk_field->get_table_column(), $join_table_alias, $join_table_fk_field_to_other_table->get_table_column()).$this->get_other_model()->_construct_internal_join_to_table_with_alias($other_table_alias); |
|
75 | 75 | return $SQL; |
76 | 76 | } |
77 | 77 | |
@@ -84,36 +84,36 @@ discard block |
||
84 | 84 | * @param array $where_query col=>val pairs that are used as extra conditions for checking existing values and for setting new rows if no exact matches. |
85 | 85 | * @return EE_Base_Class |
86 | 86 | */ |
87 | - function add_relation_to($this_obj_or_id, $other_obj_or_id, $where_query = array() ){ |
|
87 | + function add_relation_to($this_obj_or_id, $other_obj_or_id, $where_query = array()) { |
|
88 | 88 | $this_model_obj = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true); |
89 | 89 | $other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true); |
90 | 90 | //check if such a relationship already exists |
91 | 91 | $join_model_fk_to_this_model = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name()); |
92 | 92 | $join_model_fk_to_other_model = $this->get_join_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name()); |
93 | 93 | |
94 | - $cols_n_values = array( |
|
94 | + $cols_n_values = array( |
|
95 | 95 | $join_model_fk_to_this_model->get_name() => $this_model_obj->ID(), |
96 | 96 | $join_model_fk_to_other_model->get_name() => $other_model_obj->ID()); |
97 | 97 | |
98 | 98 | //if $where_query exists lets add them to the query_params. |
99 | - if ( !empty( $where_query ) ) { |
|
99 | + if ( ! empty($where_query)) { |
|
100 | 100 | //make sure we strip any of the join model names from the $where_query cause we don't need that in here (why? because client code may have used the same conditionals for get_all_related which DOES need the join model name) |
101 | 101 | //make sure we strip THIS models name from the query param |
102 | - foreach ( $where_query as $query_param => $val ) { |
|
103 | - $query_param = str_replace($this->get_join_model()->get_this_model_name().".","", $query_param); |
|
102 | + foreach ($where_query as $query_param => $val) { |
|
103 | + $query_param = str_replace($this->get_join_model()->get_this_model_name().".", "", $query_param); |
|
104 | 104 | $parsed_query[$query_param] = $val; |
105 | 105 | } |
106 | - $cols_n_values = array_merge( $cols_n_values, $parsed_query ); |
|
106 | + $cols_n_values = array_merge($cols_n_values, $parsed_query); |
|
107 | 107 | } |
108 | 108 | |
109 | - $query_params = array( $cols_n_values ); |
|
109 | + $query_params = array($cols_n_values); |
|
110 | 110 | |
111 | 111 | |
112 | 112 | $existing_entry_in_join_table = $this->get_join_model()->get_one($query_params); |
113 | 113 | //if there is already an entry in the join table, indicating a relationship, we're done |
114 | 114 | //again, if you want more sophisticated logic or insertions (handling more columns than just 2 foreign keys to |
115 | 115 | //the other tables, use the joining model directly! |
116 | - if( ! $existing_entry_in_join_table ){ |
|
116 | + if ( ! $existing_entry_in_join_table) { |
|
117 | 117 | $this->get_join_model()->insert($cols_n_values); |
118 | 118 | } |
119 | 119 | return $other_model_obj; |
@@ -125,29 +125,29 @@ discard block |
||
125 | 125 | * * @param array $where_query col=>val pairs that are used as extra conditions for checking existing values and for removing existing rows if exact matches exist. |
126 | 126 | * @return EE_Base_Class |
127 | 127 | */ |
128 | - function remove_relation_to($this_obj_or_id, $other_obj_or_id, $where_query = array() ){ |
|
128 | + function remove_relation_to($this_obj_or_id, $other_obj_or_id, $where_query = array()) { |
|
129 | 129 | $this_model_obj = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true); |
130 | 130 | $other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true); |
131 | 131 | //check if such a relationship already exists |
132 | 132 | $join_model_fk_to_this_model = $this->get_join_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name()); |
133 | 133 | $join_model_fk_to_other_model = $this->get_join_model()->get_foreign_key_to($this->get_other_model()->get_this_model_name()); |
134 | 134 | |
135 | - $cols_n_values = array( |
|
135 | + $cols_n_values = array( |
|
136 | 136 | $join_model_fk_to_this_model->get_name() => $this_model_obj->ID(), |
137 | 137 | $join_model_fk_to_other_model->get_name() => $other_model_obj->ID()); |
138 | 138 | |
139 | 139 | //if $where_query exists lets add them to the query_params. |
140 | - if ( !empty( $where_query ) ) { |
|
140 | + if ( ! empty($where_query)) { |
|
141 | 141 | //make sure we strip any of the join model names from the $where_query cause we don't need that in here (why? because client code may have used the same conditionals for get_all_related which DOES need the join model name) |
142 | 142 | //make sure we strip THIS models name from the query param |
143 | - foreach ( $where_query as $query_param => $val ) { |
|
144 | - $query_param = str_replace($this->get_join_model()->get_this_model_name().".","", $query_param); |
|
143 | + foreach ($where_query as $query_param => $val) { |
|
144 | + $query_param = str_replace($this->get_join_model()->get_this_model_name().".", "", $query_param); |
|
145 | 145 | $parsed_query[$query_param] = $val; |
146 | 146 | } |
147 | - $cols_n_values = array_merge( $cols_n_values, $parsed_query ); |
|
147 | + $cols_n_values = array_merge($cols_n_values, $parsed_query); |
|
148 | 148 | } |
149 | 149 | |
150 | - $existing_entry_in_join_table = $this->get_join_model()->delete( array($cols_n_values) ); |
|
150 | + $existing_entry_in_join_table = $this->get_join_model()->delete(array($cols_n_values)); |
|
151 | 151 | return $other_model_obj; |
152 | 152 | } |
153 | 153 | } |
@@ -50,7 +50,7 @@ discard block |
||
50 | 50 | |
51 | 51 | |
52 | 52 | /** |
53 | - * @param $this_model_name |
|
53 | + * @param string $this_model_name |
|
54 | 54 | * @param $other_model_name |
55 | 55 | * @throws EE_Error |
56 | 56 | */ |
@@ -67,7 +67,7 @@ discard block |
||
67 | 67 | |
68 | 68 | /** |
69 | 69 | * Gets the model where this relation is defined. |
70 | - * @return EEM_Base |
|
70 | + * @return boolean |
|
71 | 71 | */ |
72 | 72 | function get_this_model(){ |
73 | 73 | return $this->_get_model($this->_this_model_name); |
@@ -78,7 +78,7 @@ discard block |
||
78 | 78 | /** |
79 | 79 | * Gets the model which this relation establishes the relation TO (ie, |
80 | 80 | * this relation object was defined on get_this_model(), get_other_model() is the other one) |
81 | - * @return EEM_Base |
|
81 | + * @return boolean |
|
82 | 82 | */ |
83 | 83 | function get_other_model(){ |
84 | 84 | return $this->_get_model($this->_other_model_name); |
@@ -89,7 +89,7 @@ discard block |
||
89 | 89 | /** |
90 | 90 | * Internally used by get_this_model() and get_other_model() |
91 | 91 | * @param string $model_name like Event, Question_Group, etc. omit the EEM_ |
92 | - * @return EEM_Base |
|
92 | + * @return boolean |
|
93 | 93 | */ |
94 | 94 | protected function _get_model($model_name){ |
95 | 95 | $modelInstance = EE_Registry::instance()->load_model( $model_name ); |
@@ -112,9 +112,9 @@ discard block |
||
112 | 112 | |
113 | 113 | /** |
114 | 114 | * @param $other_table |
115 | - * @param $other_table_alias |
|
115 | + * @param string $other_table_alias |
|
116 | 116 | * @param $other_table_column |
117 | - * @param $this_table_alias |
|
117 | + * @param string $this_table_alias |
|
118 | 118 | * @param $this_table_join_column |
119 | 119 | * @param string $extra_join_sql |
120 | 120 | * @return string |
@@ -168,7 +168,7 @@ discard block |
||
168 | 168 | * parameters are specified, then all related model objects will be deleted. |
169 | 169 | * Note: If the related model is extends EEM_Soft_Delete_Base, then the related |
170 | 170 | * model objects will only be soft-deleted. |
171 | - * @param EE_Base_Class|int|string $model_object_or_id |
|
171 | + * @param EE_Base_Class $model_object_or_id |
|
172 | 172 | * @param array $query_params |
173 | 173 | * @return int of how many related models got deleted |
174 | 174 | */ |
@@ -196,7 +196,7 @@ discard block |
||
196 | 196 | * parameters are specified, then all related model objects will be deleted. |
197 | 197 | * Note: If the related model is extends EEM_Soft_Delete_Base, then the related |
198 | 198 | * model objects will only be soft-deleted. |
199 | - * @param EE_Base_Class|int|string $model_object_or_id |
|
199 | + * @param EE_Base_Class $model_object_or_id |
|
200 | 200 | * @param array $query_params |
201 | 201 | * @return int of how many related models got deleted |
202 | 202 | */ |
@@ -104,8 +104,9 @@ discard block |
||
104 | 104 | * @param string $timezone timezone to set. |
105 | 105 | */ |
106 | 106 | public function set_timezone( $timezone ) { |
107 | - if($timezone !== NULL) |
|
108 | - $this->_timezone = $timezone; |
|
107 | + if($timezone !== NULL) { |
|
108 | + $this->_timezone = $timezone; |
|
109 | + } |
|
109 | 110 | } |
110 | 111 | |
111 | 112 | |
@@ -213,12 +214,12 @@ discard block |
||
213 | 214 | $deleted_count++; |
214 | 215 | if( ! $delete_is_blocked ){ |
215 | 216 | $related_model_object->delete_permanently(); |
216 | - }else{ |
|
217 | + } else{ |
|
217 | 218 | //delete is blocked |
218 | 219 | //brent and darren, in this case, wanted to just soft delete it then |
219 | 220 | $related_model_object->delete(); |
220 | 221 | } |
221 | - }else{ |
|
222 | + } else{ |
|
222 | 223 | //its not a soft-deletable thing anyways. do the normal logic. |
223 | 224 | if( ! $delete_is_blocked ){ |
224 | 225 | $this->remove_relation_to($model_object_or_id, $related_model_object); |
@@ -241,7 +242,7 @@ discard block |
||
241 | 242 | protected function _get_model_object_id($model_object_or_id) { |
242 | 243 | if($model_object_or_id instanceof EE_Base_Class){ |
243 | 244 | $model_object_id = $model_object_or_id->ID(); |
244 | - }else{ |
|
245 | + } else{ |
|
245 | 246 | $model_object_id = $model_object_or_id; |
246 | 247 | } |
247 | 248 | if( ! $model_object_id){ |
@@ -316,7 +317,7 @@ discard block |
||
316 | 317 | public function get_deletion_error_message(){ |
317 | 318 | if($this->_blocking_delete_error_message){ |
318 | 319 | return $this->_blocking_delete_error_message; |
319 | - }else{ |
|
320 | + } else{ |
|
320 | 321 | // return sprintf(__('Cannot delete %1$s when there are related %2$s', "event_espresso"),$this->get_this_model()->item_name(2),$this->get_other_model()->item_name(2)); |
321 | 322 | return sprintf( |
322 | 323 | __( 'This %1$s is currently linked to one or more %2$s records. If this %1$s is incorrect, then please remove it from all %3$s before attempting to delete it.', "event_espresso"), |
@@ -7,7 +7,7 @@ discard block |
||
7 | 7 | * Once those two models are setup correctly, and the relation object has the names of each, it can |
8 | 8 | * magically figure out what tables must be joined on what fields during querying. |
9 | 9 | */ |
10 | -abstract class EE_Model_Relation_Base{ |
|
10 | +abstract class EE_Model_Relation_Base { |
|
11 | 11 | /** |
12 | 12 | * The model name of which this relation is a component (ie, the model that called new EE_Model_Relation_Base) |
13 | 13 | * @var string eg Event, Question_Group, Registration |
@@ -42,9 +42,9 @@ discard block |
||
42 | 42 | * @param boolean $block_deletes if there are related models across this relation, block (prevent and add an error) the deletion of this model |
43 | 43 | * @param string $blocking_delete_error_message a customized error message on blocking deletes instead of the default |
44 | 44 | */ |
45 | - function __construct($block_deletes, $blocking_delete_error_message){ |
|
45 | + function __construct($block_deletes, $blocking_delete_error_message) { |
|
46 | 46 | $this->_blocking_delete = $block_deletes; |
47 | - $this->_blocking_delete_error_message=$blocking_delete_error_message; |
|
47 | + $this->_blocking_delete_error_message = $blocking_delete_error_message; |
|
48 | 48 | } |
49 | 49 | |
50 | 50 | |
@@ -54,12 +54,12 @@ discard block |
||
54 | 54 | * @param $other_model_name |
55 | 55 | * @throws EE_Error |
56 | 56 | */ |
57 | - function _construct_finalize_set_models($this_model_name, $other_model_name){ |
|
57 | + function _construct_finalize_set_models($this_model_name, $other_model_name) { |
|
58 | 58 | $this->_this_model_name = $this_model_name; |
59 | 59 | $this->_other_model_name = $other_model_name; |
60 | - if(is_string($this->_blocking_delete)){ |
|
60 | + if (is_string($this->_blocking_delete)) { |
|
61 | 61 | throw new EE_Error(sprintf(__("When instantiating the relation of type %s from %s to %s, the \$block_deletes argument should be a boolean, not a string (%s)", "event_espresso"), |
62 | - get_class($this),$this_model_name,$other_model_name,$this->_blocking_delete)); |
|
62 | + get_class($this), $this_model_name, $other_model_name, $this->_blocking_delete)); |
|
63 | 63 | } |
64 | 64 | } |
65 | 65 | |
@@ -69,7 +69,7 @@ discard block |
||
69 | 69 | * Gets the model where this relation is defined. |
70 | 70 | * @return EEM_Base |
71 | 71 | */ |
72 | - function get_this_model(){ |
|
72 | + function get_this_model() { |
|
73 | 73 | return $this->_get_model($this->_this_model_name); |
74 | 74 | } |
75 | 75 | |
@@ -80,7 +80,7 @@ discard block |
||
80 | 80 | * this relation object was defined on get_this_model(), get_other_model() is the other one) |
81 | 81 | * @return EEM_Base |
82 | 82 | */ |
83 | - function get_other_model(){ |
|
83 | + function get_other_model() { |
|
84 | 84 | return $this->_get_model($this->_other_model_name); |
85 | 85 | } |
86 | 86 | |
@@ -91,9 +91,9 @@ discard block |
||
91 | 91 | * @param string $model_name like Event, Question_Group, etc. omit the EEM_ |
92 | 92 | * @return EEM_Base |
93 | 93 | */ |
94 | - protected function _get_model($model_name){ |
|
95 | - $modelInstance = EE_Registry::instance()->load_model( $model_name ); |
|
96 | - $modelInstance->set_timezone( $this->_timezone ); |
|
94 | + protected function _get_model($model_name) { |
|
95 | + $modelInstance = EE_Registry::instance()->load_model($model_name); |
|
96 | + $modelInstance->set_timezone($this->_timezone); |
|
97 | 97 | return $modelInstance; |
98 | 98 | } |
99 | 99 | |
@@ -103,8 +103,8 @@ discard block |
||
103 | 103 | * entirely possible that relations may be called from a model and we need to make sure those relations have their timezone set correctly. |
104 | 104 | * @param string $timezone timezone to set. |
105 | 105 | */ |
106 | - public function set_timezone( $timezone ) { |
|
107 | - if($timezone !== NULL) |
|
106 | + public function set_timezone($timezone) { |
|
107 | + if ($timezone !== NULL) |
|
108 | 108 | $this->_timezone = $timezone; |
109 | 109 | } |
110 | 110 | |
@@ -119,8 +119,8 @@ discard block |
||
119 | 119 | * @param string $extra_join_sql |
120 | 120 | * @return string |
121 | 121 | */ |
122 | - protected function _left_join($other_table,$other_table_alias,$other_table_column,$this_table_alias,$this_table_join_column, $extra_join_sql = ''){ |
|
123 | - return " LEFT JOIN ".$other_table." AS ".$other_table_alias. " ON ".$other_table_alias.".".$other_table_column."=".$this_table_alias.".".$this_table_join_column. ($extra_join_sql ? " AND $extra_join_sql" : ''); |
|
122 | + protected function _left_join($other_table, $other_table_alias, $other_table_column, $this_table_alias, $this_table_join_column, $extra_join_sql = '') { |
|
123 | + return " LEFT JOIN ".$other_table." AS ".$other_table_alias." ON ".$other_table_alias.".".$other_table_column."=".$this_table_alias.".".$this_table_join_column.($extra_join_sql ? " AND $extra_join_sql" : ''); |
|
124 | 124 | } |
125 | 125 | |
126 | 126 | |
@@ -136,10 +136,10 @@ discard block |
||
136 | 136 | * @param boolean $values_already_prepared_by_model_object |
137 | 137 | * @return EE_Base_Class[] |
138 | 138 | */ |
139 | - public function get_all_related($model_object_or_id, $query_params = array(), $values_already_prepared_by_model_object = false){ |
|
139 | + public function get_all_related($model_object_or_id, $query_params = array(), $values_already_prepared_by_model_object = false) { |
|
140 | 140 | $query_params = $this->_disable_default_where_conditions_on_query_param($query_params); |
141 | 141 | $query_param_where_this_model_pk = $this->get_this_model()->get_this_model_name().".".$this->get_this_model()->get_primary_key_field()->get_name(); |
142 | - $model_object_id = $this->_get_model_object_id( $model_object_or_id ); |
|
142 | + $model_object_id = $this->_get_model_object_id($model_object_or_id); |
|
143 | 143 | $query_params[0][$query_param_where_this_model_pk] = $model_object_id; |
144 | 144 | return $this->get_other_model()->get_all($query_params); |
145 | 145 | } |
@@ -151,9 +151,9 @@ discard block |
||
151 | 151 | * @param string $query_params |
152 | 152 | * @return string |
153 | 153 | */ |
154 | - protected function _disable_default_where_conditions_on_query_param($query_params){ |
|
155 | - if( ! isset($query_params['default_where_conditions'])){ |
|
156 | - $query_params['default_where_conditions']='none'; |
|
154 | + protected function _disable_default_where_conditions_on_query_param($query_params) { |
|
155 | + if ( ! isset($query_params['default_where_conditions'])) { |
|
156 | + $query_params['default_where_conditions'] = 'none'; |
|
157 | 157 | } |
158 | 158 | return $query_params; |
159 | 159 | } |
@@ -169,15 +169,15 @@ discard block |
||
169 | 169 | * @param array $query_params |
170 | 170 | * @return int of how many related models got deleted |
171 | 171 | */ |
172 | - public function delete_all_related($model_object_or_id,$query_params = array()){ |
|
172 | + public function delete_all_related($model_object_or_id, $query_params = array()) { |
|
173 | 173 | //for each thing we would delete, |
174 | - $related_model_objects = $this->get_all_related($model_object_or_id,$query_params); |
|
174 | + $related_model_objects = $this->get_all_related($model_object_or_id, $query_params); |
|
175 | 175 | //determine if it's blocked by anything else before it can be deletedx |
176 | 176 | $deleted_count = 0; |
177 | - foreach($related_model_objects as $related_model_object){ |
|
177 | + foreach ($related_model_objects as $related_model_object) { |
|
178 | 178 | $delete_is_blocked = $this->get_other_model()->delete_is_blocked_by_related_models($related_model_object, $model_object_or_id); |
179 | 179 | /* @var $model_object_or_id EE_Base_Class */ |
180 | - if( ! $delete_is_blocked ){ |
|
180 | + if ( ! $delete_is_blocked) { |
|
181 | 181 | $this->remove_relation_to($model_object_or_id, $related_model_object); |
182 | 182 | $related_model_object->delete(); |
183 | 183 | $deleted_count++; |
@@ -197,27 +197,27 @@ discard block |
||
197 | 197 | * @param array $query_params |
198 | 198 | * @return int of how many related models got deleted |
199 | 199 | */ |
200 | - public function delete_related_permanently($model_object_or_id,$query_params = array()){ |
|
200 | + public function delete_related_permanently($model_object_or_id, $query_params = array()) { |
|
201 | 201 | //for each thing we would delete, |
202 | - $related_model_objects = $this->get_all_related($model_object_or_id,$query_params); |
|
202 | + $related_model_objects = $this->get_all_related($model_object_or_id, $query_params); |
|
203 | 203 | //determine if it's blocked by anything else before it can be deletedx |
204 | 204 | $deleted_count = 0; |
205 | - foreach($related_model_objects as $related_model_object){ |
|
205 | + foreach ($related_model_objects as $related_model_object) { |
|
206 | 206 | $delete_is_blocked = $this->get_other_model()->delete_is_blocked_by_related_models($related_model_object, $model_object_or_id); |
207 | 207 | /* @var $model_object_or_id EE_Base_Class */ |
208 | - if( $related_model_object instanceof EE_Soft_Delete_Base_Class ){ |
|
208 | + if ($related_model_object instanceof EE_Soft_Delete_Base_Class) { |
|
209 | 209 | $this->remove_relation_to($model_object_or_id, $related_model_object); |
210 | 210 | $deleted_count++; |
211 | - if( ! $delete_is_blocked ){ |
|
211 | + if ( ! $delete_is_blocked) { |
|
212 | 212 | $related_model_object->delete_permanently(); |
213 | - }else{ |
|
213 | + } else { |
|
214 | 214 | //delete is blocked |
215 | 215 | //brent and darren, in this case, wanted to just soft delete it then |
216 | 216 | $related_model_object->delete(); |
217 | 217 | } |
218 | - }else{ |
|
218 | + } else { |
|
219 | 219 | //its not a soft-deletable thing anyways. do the normal logic. |
220 | - if( ! $delete_is_blocked ){ |
|
220 | + if ( ! $delete_is_blocked) { |
|
221 | 221 | $this->remove_relation_to($model_object_or_id, $related_model_object); |
222 | 222 | $related_model_object->delete(); |
223 | 223 | $deleted_count++; |
@@ -236,13 +236,13 @@ discard block |
||
236 | 236 | * @return int |
237 | 237 | */ |
238 | 238 | protected function _get_model_object_id($model_object_or_id) { |
239 | - if($model_object_or_id instanceof EE_Base_Class){ |
|
239 | + if ($model_object_or_id instanceof EE_Base_Class) { |
|
240 | 240 | $model_object_id = $model_object_or_id->ID(); |
241 | - }else{ |
|
241 | + } else { |
|
242 | 242 | $model_object_id = $model_object_or_id; |
243 | 243 | } |
244 | - if( ! $model_object_id){ |
|
245 | - throw new EE_Error(sprintf(__("Sorry, we cant get the related %s model objects to %s model object before it has an ID. You can solve that by just saving it before trying to get its related model objects", "event_espresso"),$this->get_other_model()->get_this_model_name(),$this->get_this_model()->get_this_model_name())); |
|
244 | + if ( ! $model_object_id) { |
|
245 | + throw new EE_Error(sprintf(__("Sorry, we cant get the related %s model objects to %s model object before it has an ID. You can solve that by just saving it before trying to get its related model objects", "event_espresso"), $this->get_other_model()->get_this_model_name(), $this->get_this_model()->get_this_model_name())); |
|
246 | 246 | } |
247 | 247 | return $model_object_id; |
248 | 248 | } |
@@ -285,10 +285,10 @@ discard block |
||
285 | 285 | * @param array $where_query_param like EEM_Base::get_all's $query_params[0] (where conditions) |
286 | 286 | * @return EE_Base_Class[] |
287 | 287 | */ |
288 | - public function remove_relations($this_obj_or_id,$where_query_param = array()){ |
|
289 | - $related_things = $this->get_all_related($this_obj_or_id,array($where_query_param)); |
|
288 | + public function remove_relations($this_obj_or_id, $where_query_param = array()) { |
|
289 | + $related_things = $this->get_all_related($this_obj_or_id, array($where_query_param)); |
|
290 | 290 | $objs_removed = array(); |
291 | - foreach($related_things as $related_thing){ |
|
291 | + foreach ($related_things as $related_thing) { |
|
292 | 292 | $objs_removed[] = $this->remove_relation_to($this_obj_or_id, $related_thing); |
293 | 293 | } |
294 | 294 | return $objs_removed; |
@@ -301,7 +301,7 @@ discard block |
||
301 | 301 | * related objects exist, returns false. |
302 | 302 | * @return boolean |
303 | 303 | */ |
304 | - public function block_delete_if_related_models_exist(){ |
|
304 | + public function block_delete_if_related_models_exist() { |
|
305 | 305 | return $this->_blocking_delete; |
306 | 306 | } |
307 | 307 | |
@@ -310,13 +310,13 @@ discard block |
||
310 | 310 | * Gets the error message to show |
311 | 311 | * @return string |
312 | 312 | */ |
313 | - public function get_deletion_error_message(){ |
|
314 | - if($this->_blocking_delete_error_message){ |
|
313 | + public function get_deletion_error_message() { |
|
314 | + if ($this->_blocking_delete_error_message) { |
|
315 | 315 | return $this->_blocking_delete_error_message; |
316 | - }else{ |
|
316 | + } else { |
|
317 | 317 | // return sprintf(__('Cannot delete %1$s when there are related %2$s', "event_espresso"),$this->get_this_model()->item_name(2),$this->get_other_model()->item_name(2)); |
318 | 318 | return sprintf( |
319 | - __( 'This %1$s is currently linked to one or more %2$s records. If this %1$s is incorrect, then please remove it from all %3$s before attempting to delete it.', "event_espresso"), |
|
319 | + __('This %1$s is currently linked to one or more %2$s records. If this %1$s is incorrect, then please remove it from all %3$s before attempting to delete it.', "event_espresso"), |
|
320 | 320 | $this->get_this_model()->item_name(1), |
321 | 321 | $this->get_other_model()->item_name(1), |
322 | 322 | $this->get_other_model()->item_name(2) |
@@ -7,6 +7,11 @@ discard block |
||
7 | 7 | |
8 | 8 | protected $_post_type; |
9 | 9 | protected $_meta_field; |
10 | + |
|
11 | + /** |
|
12 | + * @param string $post_type |
|
13 | + * @param string $meta_field_to_chk |
|
14 | + */ |
|
10 | 15 | function __construct($post_type, $meta_field_to_chk){ |
11 | 16 | $this->_post_type = $post_type; |
12 | 17 | $this->_meta_field = $meta_field_to_chk; |
@@ -27,7 +32,6 @@ discard block |
||
27 | 32 | } |
28 | 33 | /** |
29 | 34 | * Gets the where default where conditions for a custom post type model |
30 | - * @param string $model_relation_path. Eg, from Event to Payment, this should be "Registration.Transaction.Payment" |
|
31 | 35 | * @return array like EEM_Base::get_all's $query_params's index [0] (where conditions) |
32 | 36 | */ |
33 | 37 | protected function _get_default_where_conditions() { |
@@ -3,11 +3,11 @@ discard block |
||
3 | 3 | /* |
4 | 4 | * Strategy specifically for adding where conditions specific to CPT models. |
5 | 5 | */ |
6 | -class EE_CPT_Where_Conditions extends EE_Default_Where_Conditions{ |
|
6 | +class EE_CPT_Where_Conditions extends EE_Default_Where_Conditions { |
|
7 | 7 | |
8 | 8 | protected $_post_type; |
9 | 9 | protected $_meta_field; |
10 | - function __construct($post_type, $meta_field_to_chk){ |
|
10 | + function __construct($post_type, $meta_field_to_chk) { |
|
11 | 11 | $this->_post_type = $post_type; |
12 | 12 | $this->_meta_field = $meta_field_to_chk; |
13 | 13 | } |
@@ -17,10 +17,10 @@ discard block |
||
17 | 17 | * @param string $column column name |
18 | 18 | * @return EE_Model_Field_Base |
19 | 19 | */ |
20 | - protected function _get_field_on_column($column){ |
|
20 | + protected function _get_field_on_column($column) { |
|
21 | 21 | $all_fields = $this->_model->field_settings(true); |
22 | - foreach($all_fields as $field_name => $field_obj){ |
|
23 | - if($column == $field_obj->get_table_column()){ |
|
22 | + foreach ($all_fields as $field_name => $field_obj) { |
|
23 | + if ($column == $field_obj->get_table_column()) { |
|
24 | 24 | return $field_obj; |
25 | 25 | } |
26 | 26 | } |
@@ -34,8 +34,8 @@ discard block |
||
34 | 34 | //find post_type field |
35 | 35 | $post_type_field = $this->_get_field_on_column('post_type'); |
36 | 36 | $status_field = $this->_get_field_on_column('post_status'); |
37 | - return array( $post_type_field->get_name() => $this->_post_type, |
|
38 | - $status_field->get_name() => array('NOT IN',array('auto-draft','trash')) |
|
37 | + return array($post_type_field->get_name() => $this->_post_type, |
|
38 | + $status_field->get_name() => array('NOT IN', array('auto-draft', 'trash')) |
|
39 | 39 | ); |
40 | 40 | } |
41 | 41 | } |
@@ -110,7 +110,7 @@ |
||
110 | 110 | /** |
111 | 111 | * Sets addon_name |
112 | 112 | * @param string $addon_name |
113 | - * @return boolean |
|
113 | + * @return string |
|
114 | 114 | */ |
115 | 115 | function set_name( $addon_name ) { |
116 | 116 | return $this->_addon_name = $addon_name; |
@@ -1,5 +1,5 @@ discard block |
||
1 | -<?php if ( !defined( 'EVENT_ESPRESSO_VERSION' ) ) { |
|
2 | - exit( 'No direct script access allowed' ); |
|
1 | +<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) { |
|
2 | + exit('No direct script access allowed'); |
|
3 | 3 | } |
4 | 4 | /** |
5 | 5 | * |
@@ -73,7 +73,7 @@ discard block |
||
73 | 73 | /** |
74 | 74 | * @param mixed $version |
75 | 75 | */ |
76 | - public function set_version( $version = NULL ) { |
|
76 | + public function set_version($version = NULL) { |
|
77 | 77 | $this->_version = $version; |
78 | 78 | } |
79 | 79 | |
@@ -91,7 +91,7 @@ discard block |
||
91 | 91 | /** |
92 | 92 | * @param mixed $min_core_version |
93 | 93 | */ |
94 | - public function set_min_core_version( $min_core_version = NULL ) { |
|
94 | + public function set_min_core_version($min_core_version = NULL) { |
|
95 | 95 | $this->_min_core_version = $min_core_version; |
96 | 96 | } |
97 | 97 | |
@@ -112,7 +112,7 @@ discard block |
||
112 | 112 | * @param string $addon_name |
113 | 113 | * @return boolean |
114 | 114 | */ |
115 | - function set_name( $addon_name ) { |
|
115 | + function set_name($addon_name) { |
|
116 | 116 | return $this->_addon_name = $addon_name; |
117 | 117 | } |
118 | 118 | |
@@ -138,7 +138,7 @@ discard block |
||
138 | 138 | do_action("AHEE__{$classname}__new_install"); |
139 | 139 | do_action("AHEE__EE_Addon__new_install", $this); |
140 | 140 | EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old(); |
141 | - add_action( 'AHEE__EE_System__perform_activations_upgrades_and_migrations', array( $this, 'initialize_db_if_no_migrations_required' ) ); |
|
141 | + add_action('AHEE__EE_System__perform_activations_upgrades_and_migrations', array($this, 'initialize_db_if_no_migrations_required')); |
|
142 | 142 | } |
143 | 143 | |
144 | 144 | |
@@ -153,16 +153,16 @@ discard block |
||
153 | 153 | do_action("AHEE__{$classname}__reactivation"); |
154 | 154 | do_action("AHEE__EE_Addon__reactivation", $this); |
155 | 155 | EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old(); |
156 | - add_action( 'AHEE__EE_System__perform_activations_upgrades_and_migrations', array( $this, 'initialize_db_if_no_migrations_required' ) ); |
|
156 | + add_action('AHEE__EE_System__perform_activations_upgrades_and_migrations', array($this, 'initialize_db_if_no_migrations_required')); |
|
157 | 157 | } |
158 | 158 | |
159 | - public function deactivation(){ |
|
159 | + public function deactivation() { |
|
160 | 160 | $classname = get_class($this); |
161 | 161 | // echo "Deactivating $classname";die; |
162 | 162 | do_action("AHEE__{$classname}__deactivation"); |
163 | 163 | do_action("AHEE__EE_Addon__deactivation", $this); |
164 | 164 | //check if the site no longer needs to be in maintenance mode |
165 | - EE_Register_Addon::deregister( $this->name() ); |
|
165 | + EE_Register_Addon::deregister($this->name()); |
|
166 | 166 | EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old(); |
167 | 167 | } |
168 | 168 | |
@@ -175,7 +175,7 @@ discard block |
||
175 | 175 | * @return void |
176 | 176 | */ |
177 | 177 | public function initialize_db_if_no_migrations_required() { |
178 | - if ( EE_Maintenance_Mode::instance()->level() != EE_Maintenance_Mode::level_2_complete_maintenance ) { |
|
178 | + if (EE_Maintenance_Mode::instance()->level() != EE_Maintenance_Mode::level_2_complete_maintenance) { |
|
179 | 179 | $this->initialize_db(); |
180 | 180 | $this->initialize_default_data(); |
181 | 181 | //@todo: this will probably need to be adjusted in 4.4 as the array changed formats I believe |
@@ -188,11 +188,11 @@ discard block |
||
188 | 188 | */ |
189 | 189 | EE_Registry::instance()->load_helper('Activation'); |
190 | 190 | EEH_Activation::initialize_db_content(); |
191 | - update_option( 'ee_flush_rewrite_rules', TRUE ); |
|
192 | - }else{ |
|
191 | + update_option('ee_flush_rewrite_rules', TRUE); |
|
192 | + } else { |
|
193 | 193 | //ask the data migration manager to init this addon's data |
194 | 194 | //when migrations are finished because we can't do it now |
195 | - EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for( $this->name() ); |
|
195 | + EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for($this->name()); |
|
196 | 196 | } |
197 | 197 | } |
198 | 198 | |
@@ -206,20 +206,20 @@ discard block |
||
206 | 206 | */ |
207 | 207 | public function initialize_db() { |
208 | 208 | //find the migration script that sets the database to be compatible with the code |
209 | - $current_dms_name = EE_Data_Migration_Manager::instance()->get_most_up_to_date_dms( $this->name() ); |
|
210 | - if( $current_dms_name ){ |
|
211 | - $current_data_migration_script = EE_Registry::instance()->load_dms( $current_dms_name ); |
|
212 | - $current_data_migration_script->set_migrating( FALSE ); |
|
209 | + $current_dms_name = EE_Data_Migration_Manager::instance()->get_most_up_to_date_dms($this->name()); |
|
210 | + if ($current_dms_name) { |
|
211 | + $current_data_migration_script = EE_Registry::instance()->load_dms($current_dms_name); |
|
212 | + $current_data_migration_script->set_migrating(FALSE); |
|
213 | 213 | $current_data_migration_script->schema_changes_before_migration(); |
214 | 214 | $current_data_migration_script->schema_changes_after_migration(); |
215 | - if ( $current_data_migration_script->get_errors() ) { |
|
216 | - foreach( $current_data_migration_script->get_errors() as $error ) { |
|
217 | - EE_Error::add_error( $error, __FILE__, __FUNCTION__, __LINE__ ); |
|
215 | + if ($current_data_migration_script->get_errors()) { |
|
216 | + foreach ($current_data_migration_script->get_errors() as $error) { |
|
217 | + EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__); |
|
218 | 218 | } |
219 | 219 | } |
220 | 220 | } |
221 | 221 | //if not DMS was found that should be ok. This addon just doesn't require any database changes |
222 | - EE_Data_Migration_Manager::instance()->update_current_database_state_to( array( 'slug' => $this->name(), 'version' => $this->version() ) ); |
|
222 | + EE_Data_Migration_Manager::instance()->update_current_database_state_to(array('slug' => $this->name(), 'version' => $this->version())); |
|
223 | 223 | } |
224 | 224 | |
225 | 225 | |
@@ -241,7 +241,7 @@ discard block |
||
241 | 241 | * default data) |
242 | 242 | * @param EE_Addon $addon the addon that called this |
243 | 243 | */ |
244 | - do_action( 'AHEE__EE_Addon__initialize_default_data__begin', $this ); |
|
244 | + do_action('AHEE__EE_Addon__initialize_default_data__begin', $this); |
|
245 | 245 | //override to insert default data. It is safe to use the models here |
246 | 246 | //because the site should not be in maintenance mode |
247 | 247 | } |
@@ -260,7 +260,7 @@ discard block |
||
260 | 260 | do_action("AHEE__EE_Addon__upgrade", $this); |
261 | 261 | EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old(); |
262 | 262 | //also it's possible there is new default data that needs to be added |
263 | - add_action( 'AHEE__EE_System__perform_activations_upgrades_and_migrations', array( $this, 'initialize_db_if_no_migrations_required' ) ); |
|
263 | + add_action('AHEE__EE_System__perform_activations_upgrades_and_migrations', array($this, 'initialize_db_if_no_migrations_required')); |
|
264 | 264 | } |
265 | 265 | |
266 | 266 | |
@@ -273,7 +273,7 @@ discard block |
||
273 | 273 | do_action("AHEE__{$classname}__downgrade"); |
274 | 274 | do_action("AHEE__EE_Addon__downgrade", $this); |
275 | 275 | //it's possible there's old default data that needs to be double-checked |
276 | - add_action( 'AHEE__EE_System__perform_activations_upgrades_and_migrations', array( $this, 'initialize_db_if_no_migrations_required' ) ); |
|
276 | + add_action('AHEE__EE_System__perform_activations_upgrades_and_migrations', array($this, 'initialize_db_if_no_migrations_required')); |
|
277 | 277 | } |
278 | 278 | |
279 | 279 | |
@@ -284,7 +284,7 @@ discard block |
||
284 | 284 | * plugin activation only. In the future, we'll want to do it on plugin updates too |
285 | 285 | * @return bool |
286 | 286 | */ |
287 | - public function set_db_update_option_name(){ |
|
287 | + public function set_db_update_option_name() { |
|
288 | 288 | EE_Error::doing_it_wrong(__FUNCTION__, __('EE_Addon::set_db_update_option_name was renamed to EE_Addon::set_activation_indicator_option', 'event_espresso'), '4.3.0.alpha.016'); |
289 | 289 | //let's just handle this on the next request, ok? right now we're just not really ready |
290 | 290 | return $this->set_activation_indicator_option(); |
@@ -312,7 +312,7 @@ discard block |
||
312 | 312 | */ |
313 | 313 | public function set_activation_indicator_option() { |
314 | 314 | // let's just handle this on the next request, ok? right now we're just not really ready |
315 | - return update_option( $this->get_activation_indicator_option_name(), TRUE ); |
|
315 | + return update_option($this->get_activation_indicator_option_name(), TRUE); |
|
316 | 316 | } |
317 | 317 | |
318 | 318 | |
@@ -320,8 +320,8 @@ discard block |
||
320 | 320 | * Gets the name of the wp option which is used to temporarily indicate that this addon was activated |
321 | 321 | * @return string |
322 | 322 | */ |
323 | - public function get_activation_indicator_option_name(){ |
|
324 | - return 'ee_activation_' . $this->name(); |
|
323 | + public function get_activation_indicator_option_name() { |
|
324 | + return 'ee_activation_'.$this->name(); |
|
325 | 325 | } |
326 | 326 | |
327 | 327 | |
@@ -331,7 +331,7 @@ discard block |
||
331 | 331 | * Used by EE_System to set the request type of this addon. Should not be used by addon developers |
332 | 332 | * @param int $req_type |
333 | 333 | */ |
334 | - function set_req_type( $req_type ) { |
|
334 | + function set_req_type($req_type) { |
|
335 | 335 | $this->_req_type = $req_type; |
336 | 336 | } |
337 | 337 | |
@@ -342,7 +342,7 @@ discard block |
||
342 | 342 | * of addons |
343 | 343 | */ |
344 | 344 | function detect_req_type() { |
345 | - if( ! $this->_req_type ){ |
|
345 | + if ( ! $this->_req_type) { |
|
346 | 346 | $this->detect_activation_or_upgrade(); |
347 | 347 | } |
348 | 348 | return $this->_req_type; |
@@ -355,36 +355,36 @@ discard block |
||
355 | 355 | * Should only be called once per request |
356 | 356 | * @return void |
357 | 357 | */ |
358 | - function detect_activation_or_upgrade(){ |
|
358 | + function detect_activation_or_upgrade() { |
|
359 | 359 | $activation_history_for_addon = $this->get_activation_history(); |
360 | 360 | // d($activation_history_for_addon); |
361 | 361 | $request_type = EE_System::detect_req_type_given_activation_history($activation_history_for_addon, $this->get_activation_indicator_option_name(), $this->version()); |
362 | 362 | $this->set_req_type($request_type); |
363 | 363 | $classname = get_class($this); |
364 | - switch($request_type){ |
|
364 | + switch ($request_type) { |
|
365 | 365 | case EE_System::req_type_new_activation: |
366 | - do_action( "AHEE__{$classname}__detect_activations_or_upgrades__new_activation" ); |
|
367 | - do_action( "AHEE__EE_Addon__detect_activations_or_upgrades__new_activation", $this ); |
|
366 | + do_action("AHEE__{$classname}__detect_activations_or_upgrades__new_activation"); |
|
367 | + do_action("AHEE__EE_Addon__detect_activations_or_upgrades__new_activation", $this); |
|
368 | 368 | $this->new_install(); |
369 | - $this->update_list_of_installed_versions( $activation_history_for_addon ); |
|
369 | + $this->update_list_of_installed_versions($activation_history_for_addon); |
|
370 | 370 | break; |
371 | 371 | case EE_System::req_type_reactivation: |
372 | - do_action( "AHEE__{$classname}__detect_activations_or_upgrades__reactivation" ); |
|
373 | - do_action( "AHEE__EE_Addon__detect_activations_or_upgrades__reactivation", $this ); |
|
372 | + do_action("AHEE__{$classname}__detect_activations_or_upgrades__reactivation"); |
|
373 | + do_action("AHEE__EE_Addon__detect_activations_or_upgrades__reactivation", $this); |
|
374 | 374 | $this->reactivation(); |
375 | - $this->update_list_of_installed_versions( $activation_history_for_addon ); |
|
375 | + $this->update_list_of_installed_versions($activation_history_for_addon); |
|
376 | 376 | break; |
377 | 377 | case EE_System::req_type_upgrade: |
378 | - do_action( "AHEE__{$classname}__detect_activations_or_upgrades__upgrade" ); |
|
379 | - do_action( "AHEE__EE_Addon__detect_activations_or_upgrades__upgrade", $this ); |
|
378 | + do_action("AHEE__{$classname}__detect_activations_or_upgrades__upgrade"); |
|
379 | + do_action("AHEE__EE_Addon__detect_activations_or_upgrades__upgrade", $this); |
|
380 | 380 | $this->upgrade(); |
381 | - $this->update_list_of_installed_versions($activation_history_for_addon ); |
|
381 | + $this->update_list_of_installed_versions($activation_history_for_addon); |
|
382 | 382 | break; |
383 | 383 | case EE_System::req_type_downgrade: |
384 | - do_action( "AHEE__{$classname}__detect_activations_or_upgrades__downgrade" ); |
|
385 | - do_action( "AHEE__EE_Addon__detect_activations_or_upgrades__downgrade", $this ); |
|
384 | + do_action("AHEE__{$classname}__detect_activations_or_upgrades__downgrade"); |
|
385 | + do_action("AHEE__EE_Addon__detect_activations_or_upgrades__downgrade", $this); |
|
386 | 386 | $this->downgrade(); |
387 | - $this->update_list_of_installed_versions($activation_history_for_addon ); |
|
387 | + $this->update_list_of_installed_versions($activation_history_for_addon); |
|
388 | 388 | break; |
389 | 389 | case EE_System::req_type_normal: |
390 | 390 | default: |
@@ -392,7 +392,7 @@ discard block |
||
392 | 392 | break; |
393 | 393 | } |
394 | 394 | |
395 | - do_action( "AHEE__{$classname}__detect_if_activation_or_upgrade__complete" ); |
|
395 | + do_action("AHEE__{$classname}__detect_if_activation_or_upgrade__complete"); |
|
396 | 396 | } |
397 | 397 | |
398 | 398 | /** |
@@ -401,17 +401,17 @@ discard block |
||
401 | 401 | * @param string $current_version_to_add |
402 | 402 | * @return boolean success |
403 | 403 | */ |
404 | - public function update_list_of_installed_versions($version_history = NULL,$current_version_to_add = NULL) { |
|
405 | - if( ! $version_history ) { |
|
404 | + public function update_list_of_installed_versions($version_history = NULL, $current_version_to_add = NULL) { |
|
405 | + if ( ! $version_history) { |
|
406 | 406 | $version_history = $this->get_activation_history(); |
407 | 407 | } |
408 | - if( $current_version_to_add == NULL){ |
|
408 | + if ($current_version_to_add == NULL) { |
|
409 | 409 | $current_version_to_add = $this->version(); |
410 | 410 | } |
411 | - $version_history[ $current_version_to_add ][] = date( 'Y-m-d H:i:s',time() ); |
|
411 | + $version_history[$current_version_to_add][] = date('Y-m-d H:i:s', time()); |
|
412 | 412 | // resave |
413 | 413 | // echo "updating list of installed versions:".$this->get_activation_history_option_name();d($version_history); |
414 | - return update_option( $this->get_activation_history_option_name(), $version_history ); |
|
414 | + return update_option($this->get_activation_history_option_name(), $version_history); |
|
415 | 415 | } |
416 | 416 | |
417 | 417 | /** |
@@ -419,8 +419,8 @@ discard block |
||
419 | 419 | * of this addon |
420 | 420 | * @return string |
421 | 421 | */ |
422 | - function get_activation_history_option_name(){ |
|
423 | - return self::ee_addon_version_history_option_prefix . $this->name(); |
|
422 | + function get_activation_history_option_name() { |
|
423 | + return self::ee_addon_version_history_option_prefix.$this->name(); |
|
424 | 424 | } |
425 | 425 | |
426 | 426 | |
@@ -429,7 +429,7 @@ discard block |
||
429 | 429 | * Gets the wp option which stores the activation history for this addon |
430 | 430 | * @return array |
431 | 431 | */ |
432 | - function get_activation_history(){ |
|
432 | + function get_activation_history() { |
|
433 | 433 | return get_option($this->get_activation_history_option_name(), NULL); |
434 | 434 | } |
435 | 435 | |
@@ -438,8 +438,8 @@ discard block |
||
438 | 438 | /** |
439 | 439 | * @param string $config_section |
440 | 440 | */ |
441 | - public function set_config_section( $config_section = '' ) { |
|
442 | - $this->_config_section = ! empty( $config_section ) ? $config_section : 'addons'; |
|
441 | + public function set_config_section($config_section = '') { |
|
442 | + $this->_config_section = ! empty($config_section) ? $config_section : 'addons'; |
|
443 | 443 | } |
444 | 444 | /** |
445 | 445 | * filepath to the main file, which can be used for register_activation_hook, register_deactivation_hook, etc. |
@@ -452,14 +452,14 @@ discard block |
||
452 | 452 | * Sets the filepath to the main plugin file |
453 | 453 | * @param string $filepath |
454 | 454 | */ |
455 | - public function set_main_plugin_file( $filepath ) { |
|
455 | + public function set_main_plugin_file($filepath) { |
|
456 | 456 | $this->_main_plugin_file = $filepath; |
457 | 457 | } |
458 | 458 | /** |
459 | 459 | * gets the filepath to teh main file |
460 | 460 | * @return string |
461 | 461 | */ |
462 | - public function get_main_plugin_file(){ |
|
462 | + public function get_main_plugin_file() { |
|
463 | 463 | return $this->_main_plugin_file; |
464 | 464 | } |
465 | 465 | |
@@ -469,15 +469,15 @@ discard block |
||
469 | 469 | * @return string |
470 | 470 | */ |
471 | 471 | public function get_main_plugin_file_basename() { |
472 | - return plugin_basename( $this->get_main_plugin_file() ); |
|
472 | + return plugin_basename($this->get_main_plugin_file()); |
|
473 | 473 | } |
474 | 474 | |
475 | 475 | /** |
476 | 476 | * Gets the folder name which contains the main plugin file |
477 | 477 | * @return string |
478 | 478 | */ |
479 | - public function get_main_plugin_file_dirname(){ |
|
480 | - return dirname( $this->get_main_plugin_file() ); |
|
479 | + public function get_main_plugin_file_dirname() { |
|
480 | + return dirname($this->get_main_plugin_file()); |
|
481 | 481 | } |
482 | 482 | |
483 | 483 | } |
@@ -189,7 +189,7 @@ |
||
189 | 189 | EE_Registry::instance()->load_helper('Activation'); |
190 | 190 | EEH_Activation::initialize_db_content(); |
191 | 191 | update_option( 'ee_flush_rewrite_rules', TRUE ); |
192 | - }else{ |
|
192 | + } else{ |
|
193 | 193 | //ask the data migration manager to init this addon's data |
194 | 194 | //when migrations are finished because we can't do it now |
195 | 195 | EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for( $this->name() ); |
@@ -88,7 +88,7 @@ discard block |
||
88 | 88 | /** |
89 | 89 | * error_handler |
90 | 90 | * @access public |
91 | - * @param $code |
|
91 | + * @param integer $code |
|
92 | 92 | * @param $message |
93 | 93 | * @param $file |
94 | 94 | * @param $line |
@@ -189,7 +189,7 @@ discard block |
||
189 | 189 | /** |
190 | 190 | * _format_error |
191 | 191 | * @access private |
192 | - * @param $code |
|
192 | + * @param string $code |
|
193 | 193 | * @param $message |
194 | 194 | * @param $file |
195 | 195 | * @param $line |
@@ -936,7 +936,7 @@ discard block |
||
936 | 936 | * |
937 | 937 | * @access public |
938 | 938 | * @param string $return_url |
939 | - * @return array |
|
939 | + * @return string |
|
940 | 940 | */ |
941 | 941 | public static function get_persistent_admin_notices( $return_url = '' ) { |
942 | 942 | $notices = ''; |
@@ -961,7 +961,7 @@ discard block |
||
961 | 961 | * |
962 | 962 | * @access public |
963 | 963 | * @param bool $force_print |
964 | - * @return void |
|
964 | + * @return null|string |
|
965 | 965 | */ |
966 | 966 | private static function _print_scripts( $force_print = FALSE ) { |
967 | 967 | if (( did_action( 'admin_enqueue_scripts' ) || did_action( 'wp_enqueue_scripts' )) && ! $force_print ) { |
@@ -1,4 +1,6 @@ |
||
1 | -<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) exit('No direct script access allowed'); |
|
1 | +<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) { |
|
2 | + exit('No direct script access allowed'); |
|
3 | +} |
|
2 | 4 | // if you're a dev and want to receive all errors via email add this to your wp-config.php: define( 'EE_ERROR_EMAILS', TRUE ); |
3 | 5 | if ( defined( 'WP_DEBUG' ) && WP_DEBUG === TRUE && defined( 'EE_ERROR_EMAILS' ) && EE_ERROR_EMAILS === TRUE ) { |
4 | 6 | set_error_handler( array( 'EE_Error', 'error_handler' )); |
@@ -1,8 +1,8 @@ discard block |
||
1 | 1 | <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) exit('No direct script access allowed'); |
2 | 2 | // if you're a dev and want to receive all errors via email add this to your wp-config.php: define( 'EE_ERROR_EMAILS', TRUE ); |
3 | -if ( defined( 'WP_DEBUG' ) && WP_DEBUG === TRUE && defined( 'EE_ERROR_EMAILS' ) && EE_ERROR_EMAILS === TRUE ) { |
|
4 | - set_error_handler( array( 'EE_Error', 'error_handler' )); |
|
5 | - register_shutdown_function( array( 'EE_Error', 'fatal_error_handler' )); |
|
3 | +if (defined('WP_DEBUG') && WP_DEBUG === TRUE && defined('EE_ERROR_EMAILS') && EE_ERROR_EMAILS === TRUE) { |
|
4 | + set_error_handler(array('EE_Error', 'error_handler')); |
|
5 | + register_shutdown_function(array('EE_Error', 'fatal_error_handler')); |
|
6 | 6 | } |
7 | 7 | /** |
8 | 8 | * |
@@ -64,7 +64,7 @@ discard block |
||
64 | 64 | * @access private |
65 | 65 | * @var boolean |
66 | 66 | */ |
67 | - private static $_espresso_notices = array( 'success' => FALSE, 'errors' => FALSE, 'attention' => FALSE ); |
|
67 | + private static $_espresso_notices = array('success' => FALSE, 'errors' => FALSE, 'attention' => FALSE); |
|
68 | 68 | |
69 | 69 | |
70 | 70 | |
@@ -75,11 +75,11 @@ discard block |
||
75 | 75 | * @access public |
76 | 76 | * @echo string |
77 | 77 | */ |
78 | - function __construct( $message, $code = 0, Exception $previous = NULL ) { |
|
79 | - if ( version_compare( phpversion(), '5.3.0', '<' )) { |
|
80 | - parent::__construct( $message, $code ); |
|
78 | + function __construct($message, $code = 0, Exception $previous = NULL) { |
|
79 | + if (version_compare(phpversion(), '5.3.0', '<')) { |
|
80 | + parent::__construct($message, $code); |
|
81 | 81 | } else { |
82 | - parent::__construct( $message, $code, $previous ); |
|
82 | + parent::__construct($message, $code, $previous); |
|
83 | 83 | } |
84 | 84 | } |
85 | 85 | |
@@ -94,10 +94,10 @@ discard block |
||
94 | 94 | * @param $line |
95 | 95 | * @return void |
96 | 96 | */ |
97 | - public static function error_handler( $code, $message, $file, $line ) { |
|
98 | - $type = EE_Error::error_type( $code ); |
|
97 | + public static function error_handler($code, $message, $file, $line) { |
|
98 | + $type = EE_Error::error_type($code); |
|
99 | 99 | $site = site_url(); |
100 | - switch ( $site ) { |
|
100 | + switch ($site) { |
|
101 | 101 | case 'http://ee4.eventespresso.com/' : |
102 | 102 | case 'http://ee4decaf.eventespresso.com/' : |
103 | 103 | case 'http://ee4hf.eventespresso.com/' : |
@@ -110,16 +110,16 @@ discard block |
||
110 | 110 | $to = '[email protected]'; |
111 | 111 | break; |
112 | 112 | default : |
113 | - $to = get_option( 'admin_email' ); |
|
113 | + $to = get_option('admin_email'); |
|
114 | 114 | } |
115 | - $subject = $type . ' ' . $message . ' in ' . EVENT_ESPRESSO_VERSION . ' on ' . site_url(); |
|
116 | - $msg = EE_Error::_format_error( $type, $message, $file, $line ); |
|
117 | - if ( function_exists( 'wp_mail' )) { |
|
118 | - add_filter( 'wp_mail_content_type', array( 'EE_Error', 'set_content_type' )); |
|
119 | - wp_mail( $to, $subject, $msg ); |
|
115 | + $subject = $type.' '.$message.' in '.EVENT_ESPRESSO_VERSION.' on '.site_url(); |
|
116 | + $msg = EE_Error::_format_error($type, $message, $file, $line); |
|
117 | + if (function_exists('wp_mail')) { |
|
118 | + add_filter('wp_mail_content_type', array('EE_Error', 'set_content_type')); |
|
119 | + wp_mail($to, $subject, $msg); |
|
120 | 120 | } |
121 | 121 | echo '<div id="message" class="espresso-notices error"><p>'; |
122 | - echo $type . ': ' . $message . '<br />' . $file . ' line ' . $line; |
|
122 | + echo $type.': '.$message.'<br />'.$file.' line '.$line; |
|
123 | 123 | echo '<br /></p></div>'; |
124 | 124 | } |
125 | 125 | |
@@ -132,8 +132,8 @@ discard block |
||
132 | 132 | * @param $code |
133 | 133 | * @return string |
134 | 134 | */ |
135 | - public static function error_type( $code ) { |
|
136 | - switch( $code ) { |
|
135 | + public static function error_type($code) { |
|
136 | + switch ($code) { |
|
137 | 137 | case E_ERROR: // 1 // |
138 | 138 | return 'E_ERROR'; |
139 | 139 | case E_WARNING: // 2 // |
@@ -179,8 +179,8 @@ discard block |
||
179 | 179 | */ |
180 | 180 | public static function fatal_error_handler() { |
181 | 181 | $last_error = error_get_last(); |
182 | - if ( $last_error['type'] === E_ERROR ) { |
|
183 | - EE_Error::error_handler( E_ERROR, $last_error['message'], $last_error['file'], $last_error['line'] ); |
|
182 | + if ($last_error['type'] === E_ERROR) { |
|
183 | + EE_Error::error_handler(E_ERROR, $last_error['message'], $last_error['file'], $last_error['line']); |
|
184 | 184 | } |
185 | 185 | } |
186 | 186 | |
@@ -195,7 +195,7 @@ discard block |
||
195 | 195 | * @param $line |
196 | 196 | * @return string |
197 | 197 | */ |
198 | - private static function _format_error( $code, $message, $file, $line ) { |
|
198 | + private static function _format_error($code, $message, $file, $line) { |
|
199 | 199 | $html = "<table cellpadding='5'><thead bgcolor='#f8f8f8'><th>Item</th><th align='left'>Details</th></thead><tbody>"; |
200 | 200 | $html .= "<tr valign='top'><td><b>Code</b></td><td>$code</td></tr>"; |
201 | 201 | $html .= "<tr valign='top'><td><b>Error</b></td><td>$message</td></tr>"; |
@@ -213,7 +213,7 @@ discard block |
||
213 | 213 | * @param $content_type |
214 | 214 | * @return string |
215 | 215 | */ |
216 | - public static function set_content_type( $content_type ) { |
|
216 | + public static function set_content_type($content_type) { |
|
217 | 217 | return 'text/html'; |
218 | 218 | } |
219 | 219 | |
@@ -227,24 +227,24 @@ discard block |
||
227 | 227 | */ |
228 | 228 | public function get_error() { |
229 | 229 | |
230 | - if( apply_filters( 'FHEE__EE_Error__get_error__show_normal_exceptions', FALSE ) ){ |
|
230 | + if (apply_filters('FHEE__EE_Error__get_error__show_normal_exceptions', FALSE)) { |
|
231 | 231 | throw $this; |
232 | 232 | } |
233 | 233 | // get separate user and developer messages if they exist |
234 | - $msg = explode( '||', $this->getMessage() ); |
|
234 | + $msg = explode('||', $this->getMessage()); |
|
235 | 235 | $user_msg = $msg[0]; |
236 | - $dev_msg = isset( $msg[1] ) ? $msg[1] : $msg[0]; |
|
236 | + $dev_msg = isset($msg[1]) ? $msg[1] : $msg[0]; |
|
237 | 237 | $msg = WP_DEBUG ? $dev_msg : $user_msg; |
238 | 238 | |
239 | 239 | // add details to _all_exceptions array |
240 | 240 | $x_time = time(); |
241 | - self::$_all_exceptions[ $x_time ]['name'] = get_class( $this ); |
|
242 | - self::$_all_exceptions[ $x_time ]['file'] = $this->getFile(); |
|
243 | - self::$_all_exceptions[ $x_time ]['line'] = $this->getLine(); |
|
244 | - self::$_all_exceptions[ $x_time ]['msg'] = $msg; |
|
245 | - self::$_all_exceptions[ $x_time ]['code'] = $this->getCode(); |
|
246 | - self::$_all_exceptions[ $x_time ]['trace'] = $this->getTrace(); |
|
247 | - self::$_all_exceptions[ $x_time ]['string'] = $this->getTraceAsString(); |
|
241 | + self::$_all_exceptions[$x_time]['name'] = get_class($this); |
|
242 | + self::$_all_exceptions[$x_time]['file'] = $this->getFile(); |
|
243 | + self::$_all_exceptions[$x_time]['line'] = $this->getLine(); |
|
244 | + self::$_all_exceptions[$x_time]['msg'] = $msg; |
|
245 | + self::$_all_exceptions[$x_time]['code'] = $this->getCode(); |
|
246 | + self::$_all_exceptions[$x_time]['trace'] = $this->getTrace(); |
|
247 | + self::$_all_exceptions[$x_time]['string'] = $this->getTraceAsString(); |
|
248 | 248 | self::$_error_count++; |
249 | 249 | |
250 | 250 | //add_action( 'shutdown', array( $this, 'display_errors' )); |
@@ -259,7 +259,7 @@ discard block |
||
259 | 259 | * @access public |
260 | 260 | * @return boolean |
261 | 261 | */ |
262 | - public static function has_error(){ |
|
262 | + public static function has_error() { |
|
263 | 263 | return self::$_error_count ? TRUE : FALSE; |
264 | 264 | } |
265 | 265 | |
@@ -270,7 +270,7 @@ discard block |
||
270 | 270 | * @access public |
271 | 271 | * @echo string |
272 | 272 | */ |
273 | - public function display_errors(){ |
|
273 | + public function display_errors() { |
|
274 | 274 | |
275 | 275 | $trace_details = ''; |
276 | 276 | |
@@ -331,18 +331,18 @@ discard block |
||
331 | 331 | </style> |
332 | 332 | <div id="ee-error-message" class="error">'; |
333 | 333 | |
334 | - if ( ! WP_DEBUG ) { |
|
334 | + if ( ! WP_DEBUG) { |
|
335 | 335 | $output .= ' |
336 | 336 | <p>'; |
337 | 337 | } |
338 | 338 | |
339 | 339 | // cycle thru errors |
340 | - foreach ( self::$_all_exceptions as $time => $ex ) { |
|
340 | + foreach (self::$_all_exceptions as $time => $ex) { |
|
341 | 341 | |
342 | 342 | // process trace info |
343 | - if ( empty( $ex['trace'] )) { |
|
343 | + if (empty($ex['trace'])) { |
|
344 | 344 | |
345 | - $trace_details .= __( 'Sorry, but no trace information was available for this exception.', 'event_espresso' ); |
|
345 | + $trace_details .= __('Sorry, but no trace information was available for this exception.', 'event_espresso'); |
|
346 | 346 | |
347 | 347 | } else { |
348 | 348 | |
@@ -357,50 +357,50 @@ discard block |
||
357 | 357 | <th scope="col" align="left">Method( arguments )</th> |
358 | 358 | </tr>'; |
359 | 359 | |
360 | - $last_on_stack = count( $ex['trace'] ) - 1; |
|
360 | + $last_on_stack = count($ex['trace']) - 1; |
|
361 | 361 | // reverse array so that stack is in proper chronological order |
362 | - $sorted_trace = array_reverse( $ex['trace'] ); |
|
362 | + $sorted_trace = array_reverse($ex['trace']); |
|
363 | 363 | |
364 | - foreach ( $sorted_trace as $nmbr => $trace ) { |
|
364 | + foreach ($sorted_trace as $nmbr => $trace) { |
|
365 | 365 | |
366 | - $file = isset( $trace['file'] ) ? $trace['file'] : '' ; |
|
367 | - $class = isset( $trace['class'] ) ? $trace['class'] : ''; |
|
368 | - $type = isset( $trace['type'] ) ? $trace['type'] : ''; |
|
369 | - $function = isset( $trace['function'] ) ? $trace['function'] : ''; |
|
370 | - $args = isset( $trace['args'] ) ? $this->_convert_args_to_string( $trace['args'] ) : ''; |
|
371 | - $line = isset( $trace['line'] ) ? $trace['line'] : ''; |
|
366 | + $file = isset($trace['file']) ? $trace['file'] : ''; |
|
367 | + $class = isset($trace['class']) ? $trace['class'] : ''; |
|
368 | + $type = isset($trace['type']) ? $trace['type'] : ''; |
|
369 | + $function = isset($trace['function']) ? $trace['function'] : ''; |
|
370 | + $args = isset($trace['args']) ? $this->_convert_args_to_string($trace['args']) : ''; |
|
371 | + $line = isset($trace['line']) ? $trace['line'] : ''; |
|
372 | 372 | $zebra = $nmbr % 2 ? ' odd' : ''; |
373 | 373 | |
374 | - if ( empty( $file ) && ! empty( $class )) { |
|
375 | - $a = new ReflectionClass( $class ); |
|
374 | + if (empty($file) && ! empty($class)) { |
|
375 | + $a = new ReflectionClass($class); |
|
376 | 376 | $file = $a->getFileName(); |
377 | - if ( empty( $line ) && ! empty( $function )) { |
|
378 | - $b = new ReflectionMethod( $class, $function ); |
|
377 | + if (empty($line) && ! empty($function)) { |
|
378 | + $b = new ReflectionMethod($class, $function); |
|
379 | 379 | $line = $b->getStartLine(); |
380 | 380 | } |
381 | 381 | } |
382 | 382 | |
383 | - if ( $nmbr == $last_on_stack ) { |
|
383 | + if ($nmbr == $last_on_stack) { |
|
384 | 384 | $file = $ex['file'] != '' ? $ex['file'] : $file; |
385 | 385 | $line = $ex['line'] != '' ? $ex['line'] : $line; |
386 | - $error_code = self::generate_error_code ( $file, $trace['function'], $line ); |
|
386 | + $error_code = self::generate_error_code($file, $trace['function'], $line); |
|
387 | 387 | } |
388 | 388 | |
389 | - $nmbr_dsply = ! empty( $nmbr ) ? $nmbr : ' '; |
|
390 | - $line_dsply = ! empty( $line ) ? $line : ' '; |
|
391 | - $file_dsply = ! empty( $file ) ? $file : ' '; |
|
392 | - $class_dsply = ! empty( $class ) ? $class : ' '; |
|
393 | - $type_dsply = ! empty( $type ) ? $type : ' '; |
|
394 | - $function_dsply = ! empty( $function ) ? $function : ' '; |
|
395 | - $args_dsply = ! empty( $args ) ? '( ' . $args . ' )' : ''; |
|
389 | + $nmbr_dsply = ! empty($nmbr) ? $nmbr : ' '; |
|
390 | + $line_dsply = ! empty($line) ? $line : ' '; |
|
391 | + $file_dsply = ! empty($file) ? $file : ' '; |
|
392 | + $class_dsply = ! empty($class) ? $class : ' '; |
|
393 | + $type_dsply = ! empty($type) ? $type : ' '; |
|
394 | + $function_dsply = ! empty($function) ? $function : ' '; |
|
395 | + $args_dsply = ! empty($args) ? '( '.$args.' )' : ''; |
|
396 | 396 | |
397 | 397 | $trace_details .= ' |
398 | 398 | <tr> |
399 | - <td align="right" class="' . $zebra . '">' . $nmbr_dsply . '</td> |
|
400 | - <td align="right" class="' . $zebra . '">' . $line_dsply . '</td> |
|
401 | - <td align="left" class="' . $zebra . '">' . $file_dsply . '</td> |
|
402 | - <td align="left" class="' . $zebra . '">' . $class_dsply . '</td> |
|
403 | - <td align="left" class="' . $zebra . '">' . $type_dsply . $function_dsply . $args_dsply . '</td> |
|
399 | + <td align="right" class="' . $zebra.'">'.$nmbr_dsply.'</td> |
|
400 | + <td align="right" class="' . $zebra.'">'.$line_dsply.'</td> |
|
401 | + <td align="left" class="' . $zebra.'">'.$file_dsply.'</td> |
|
402 | + <td align="left" class="' . $zebra.'">'.$class_dsply.'</td> |
|
403 | + <td align="left" class="' . $zebra.'">'.$type_dsply.$function_dsply.$args_dsply.'</td> |
|
404 | 404 | </tr>'; |
405 | 405 | |
406 | 406 | |
@@ -415,9 +415,9 @@ discard block |
||
415 | 415 | $ex['code'] = $ex['code'] ? $ex['code'] : $error_code; |
416 | 416 | |
417 | 417 | // add generic non-identifying messages for non-privileged uesrs |
418 | - if ( ! WP_DEBUG ) { |
|
418 | + if ( ! WP_DEBUG) { |
|
419 | 419 | |
420 | - $output .= '<span class="ee-error-user-msg-spn">' . trim( $ex['msg'] ) . '</span> <sup>' . $ex['code'] . '</sup><br />'; |
|
420 | + $output .= '<span class="ee-error-user-msg-spn">'.trim($ex['msg']).'</span> <sup>'.$ex['code'].'</sup><br />'; |
|
421 | 421 | |
422 | 422 | } else { |
423 | 423 | |
@@ -425,24 +425,24 @@ discard block |
||
425 | 425 | $output .= ' |
426 | 426 | <div class="ee-error-dev-msg-dv"> |
427 | 427 | <p class="ee-error-dev-msg-pg"> |
428 | - <strong class="ee-error-dev-msg-str">An ' . $ex['name'] . ' exception was thrown!</strong> <span>code: ' . $ex['code'] . '</span><br /> |
|
429 | - <span class="big-text">"' . trim( $ex['msg'] ) . '"</span><br/> |
|
430 | - <a id="display-ee-error-trace-' . self::$_error_count . $time . '" class="display-ee-error-trace-lnk small-text" rel="ee-error-trace-' . self::$_error_count . $time . '"> |
|
431 | - ' . __( 'click to view backtrace and class/method details', 'event_espresso' ) . ' |
|
428 | + <strong class="ee-error-dev-msg-str">An ' . $ex['name'].' exception was thrown!</strong> <span>code: '.$ex['code'].'</span><br /> |
|
429 | + <span class="big-text">"' . trim($ex['msg']).'"</span><br/> |
|
430 | + <a id="display-ee-error-trace-' . self::$_error_count.$time.'" class="display-ee-error-trace-lnk small-text" rel="ee-error-trace-'.self::$_error_count.$time.'"> |
|
431 | + ' . __('click to view backtrace and class/method details', 'event_espresso').' |
|
432 | 432 | </a><br /> |
433 | 433 | <span class="small-text lt-grey-text">'.$ex['file'].' ( line no: '.$ex['line'].' )</span> |
434 | 434 | </p> |
435 | - <div id="ee-error-trace-' . self::$_error_count . $time . '-dv" class="ee-error-trace-dv" style="display: none;"> |
|
435 | + <div id="ee-error-trace-' . self::$_error_count.$time.'-dv" class="ee-error-trace-dv" style="display: none;"> |
|
436 | 436 | ' . $trace_details; |
437 | 437 | |
438 | - if ( ! empty( $class )) { |
|
438 | + if ( ! empty($class)) { |
|
439 | 439 | $output .= ' |
440 | 440 | <div style="padding:3px; margin:0 0 1em; border:1px solid #666; background:#fff; border-radius:3px;"> |
441 | 441 | <div style="padding:1em 2em; border:1px solid #666; background:#f9f9f9;"> |
442 | 442 | <h3>Class Details</h3>'; |
443 | - $a = new ReflectionClass( $class ); |
|
443 | + $a = new ReflectionClass($class); |
|
444 | 444 | $output .= ' |
445 | - <pre>' . $a . '</pre> |
|
445 | + <pre>' . $a.'</pre> |
|
446 | 446 | </div> |
447 | 447 | </div>'; |
448 | 448 | } |
@@ -454,14 +454,14 @@ discard block |
||
454 | 454 | |
455 | 455 | } |
456 | 456 | |
457 | - $this->write_to_error_log( $time, $ex ); |
|
457 | + $this->write_to_error_log($time, $ex); |
|
458 | 458 | |
459 | 459 | } |
460 | 460 | |
461 | 461 | // remove last linebreak |
462 | - $output = substr( $output, 0, ( count( $output ) - 7 )); |
|
462 | + $output = substr($output, 0, (count($output) - 7)); |
|
463 | 463 | |
464 | - if ( ! WP_DEBUG ) { |
|
464 | + if ( ! WP_DEBUG) { |
|
465 | 465 | $output .= ' |
466 | 466 | </p>'; |
467 | 467 | } |
@@ -469,10 +469,10 @@ discard block |
||
469 | 469 | $output .= ' |
470 | 470 | </div>'; |
471 | 471 | |
472 | - $output .= self::_print_scripts( TRUE ); |
|
472 | + $output .= self::_print_scripts(TRUE); |
|
473 | 473 | |
474 | - if ( defined( 'DOING_AJAX' )) { |
|
475 | - echo json_encode( array( 'error' => $output )); |
|
474 | + if (defined('DOING_AJAX')) { |
|
475 | + echo json_encode(array('error' => $output)); |
|
476 | 476 | exit(); |
477 | 477 | } |
478 | 478 | |
@@ -492,29 +492,29 @@ discard block |
||
492 | 492 | * @ param array $arguments |
493 | 493 | * @ return string |
494 | 494 | */ |
495 | - private function _convert_args_to_string ( $arguments = array(), $array = FALSE ) { |
|
495 | + private function _convert_args_to_string($arguments = array(), $array = FALSE) { |
|
496 | 496 | |
497 | 497 | $arg_string = ''; |
498 | - if ( ! empty( $arguments )) { |
|
498 | + if ( ! empty($arguments)) { |
|
499 | 499 | |
500 | 500 | $args = array(); |
501 | 501 | |
502 | - foreach ( $arguments as $arg ) { |
|
502 | + foreach ($arguments as $arg) { |
|
503 | 503 | |
504 | - if ( ! empty( $arg )) { |
|
504 | + if ( ! empty($arg)) { |
|
505 | 505 | |
506 | - if ( is_string( $arg )) { |
|
507 | - $args[] = " '" . $arg . "'"; |
|
508 | - } elseif ( is_array( $arg )) { |
|
509 | - $args[] = 'ARRAY(' . $this->_convert_args_to_string( $arg, TRUE ); |
|
510 | - } elseif ( is_null( $arg )) { |
|
506 | + if (is_string($arg)) { |
|
507 | + $args[] = " '".$arg."'"; |
|
508 | + } elseif (is_array($arg)) { |
|
509 | + $args[] = 'ARRAY('.$this->_convert_args_to_string($arg, TRUE); |
|
510 | + } elseif (is_null($arg)) { |
|
511 | 511 | $args[] = ' NULL'; |
512 | - } elseif ( is_bool( $arg )) { |
|
513 | - $args[] = ( $arg ) ? ' TRUE' : ' FALSE'; |
|
514 | - } elseif ( is_object( $arg )) { |
|
515 | - $args[] = ' OBJECT ' . get_class( $arg ); |
|
516 | - } elseif ( is_resource( $arg )) { |
|
517 | - $args[] = get_resource_type( $arg ); |
|
512 | + } elseif (is_bool($arg)) { |
|
513 | + $args[] = ($arg) ? ' TRUE' : ' FALSE'; |
|
514 | + } elseif (is_object($arg)) { |
|
515 | + $args[] = ' OBJECT '.get_class($arg); |
|
516 | + } elseif (is_resource($arg)) { |
|
517 | + $args[] = get_resource_type($arg); |
|
518 | 518 | } else { |
519 | 519 | $args[] = $arg; |
520 | 520 | } |
@@ -522,9 +522,9 @@ discard block |
||
522 | 522 | } |
523 | 523 | |
524 | 524 | } |
525 | - $arg_string = implode( ', ', $args ); |
|
525 | + $arg_string = implode(', ', $args); |
|
526 | 526 | } |
527 | - if ( $array ) { |
|
527 | + if ($array) { |
|
528 | 528 | $arg_string .= ' )'; |
529 | 529 | } |
530 | 530 | return $arg_string; |
@@ -544,8 +544,8 @@ discard block |
||
544 | 544 | * @param string $line the line number where the error occurred - just use __LINE__ |
545 | 545 | * @return void |
546 | 546 | */ |
547 | - public static function add_error( $msg = NULL, $file = NULL, $func = NULL, $line = NULL ) { |
|
548 | - self::_add_notice ( 'errors', $msg, $file, $func, $line ); |
|
547 | + public static function add_error($msg = NULL, $file = NULL, $func = NULL, $line = NULL) { |
|
548 | + self::_add_notice('errors', $msg, $file, $func, $line); |
|
549 | 549 | } |
550 | 550 | |
551 | 551 | |
@@ -562,8 +562,8 @@ discard block |
||
562 | 562 | * @param string $line the line number where the error occurred - just use __LINE__ |
563 | 563 | * @return void |
564 | 564 | */ |
565 | - public static function add_success( $msg = NULL, $file = NULL, $func = NULL, $line = NULL ) { |
|
566 | - self::_add_notice ( 'success', $msg, $file, $func, $line ); |
|
565 | + public static function add_success($msg = NULL, $file = NULL, $func = NULL, $line = NULL) { |
|
566 | + self::_add_notice('success', $msg, $file, $func, $line); |
|
567 | 567 | } |
568 | 568 | |
569 | 569 | |
@@ -580,8 +580,8 @@ discard block |
||
580 | 580 | * @param string $line the line number where the error occurred - just use __LINE__ |
581 | 581 | * @return void |
582 | 582 | */ |
583 | - public static function add_attention( $msg = NULL, $file = NULL, $func = NULL, $line = NULL ) { |
|
584 | - self::_add_notice ( 'attention', $msg, $file, $func, $line ); |
|
583 | + public static function add_attention($msg = NULL, $file = NULL, $func = NULL, $line = NULL) { |
|
584 | + self::_add_notice('attention', $msg, $file, $func, $line); |
|
585 | 585 | } |
586 | 586 | |
587 | 587 | |
@@ -599,12 +599,12 @@ discard block |
||
599 | 599 | * @param string $line the line number where the error occurred - just use __LINE__ |
600 | 600 | * @return void |
601 | 601 | */ |
602 | - private static function _add_notice( $type = 'success', $msg = NULL, $file = NULL, $func = NULL, $line = NULL ) { |
|
603 | - if ( empty( $msg )) { |
|
602 | + private static function _add_notice($type = 'success', $msg = NULL, $file = NULL, $func = NULL, $line = NULL) { |
|
603 | + if (empty($msg)) { |
|
604 | 604 | EE_Error::doing_it_wrong( |
605 | - 'EE_Error::add_' . $type . '()', |
|
605 | + 'EE_Error::add_'.$type.'()', |
|
606 | 606 | sprintf( |
607 | - __( 'Notifications are not much use without a message! Please add a message to the EE_Error::add_%s() call made in %s on line %d', 'event_espresso' ), |
|
607 | + __('Notifications are not much use without a message! Please add a message to the EE_Error::add_%s() call made in %s on line %d', 'event_espresso'), |
|
608 | 608 | $type, |
609 | 609 | $file, |
610 | 610 | $line |
@@ -612,26 +612,26 @@ discard block |
||
612 | 612 | EVENT_ESPRESSO_VERSION |
613 | 613 | ); |
614 | 614 | } |
615 | - if ( $type == 'errors' && ( empty( $file ) || empty( $func ) || empty( $line ))) { |
|
615 | + if ($type == 'errors' && (empty($file) || empty($func) || empty($line))) { |
|
616 | 616 | EE_Error::doing_it_wrong( |
617 | 617 | 'EE_Error::add_error()', |
618 | - __('You need to provide the file name, function name, and line number that the error occurred on in order to better assist with debugging.', 'event_espresso' ), |
|
618 | + __('You need to provide the file name, function name, and line number that the error occurred on in order to better assist with debugging.', 'event_espresso'), |
|
619 | 619 | EVENT_ESPRESSO_VERSION |
620 | 620 | ); |
621 | 621 | } |
622 | 622 | // get separate user and developer messages if they exist |
623 | - $msg = explode( '||', $msg ); |
|
623 | + $msg = explode('||', $msg); |
|
624 | 624 | $user_msg = $msg[0]; |
625 | - $dev_msg = isset( $msg[1] ) ? $msg[1] : $msg[0]; |
|
625 | + $dev_msg = isset($msg[1]) ? $msg[1] : $msg[0]; |
|
626 | 626 | $msg = WP_DEBUG ? $dev_msg : $user_msg; |
627 | 627 | // add notice if message exists |
628 | - if ( ! empty( $msg )) { |
|
628 | + if ( ! empty($msg)) { |
|
629 | 629 | // get error code only on error |
630 | - $error_code = $type == 'errors' ? EE_Error::generate_error_code ( $file, $func, $line ) : ''; |
|
631 | - $error_code = ! empty( $error_code ) ? '<br/><span class="tiny-text">' . $error_code . '</span>' : ''; |
|
630 | + $error_code = $type == 'errors' ? EE_Error::generate_error_code($file, $func, $line) : ''; |
|
631 | + $error_code = ! empty($error_code) ? '<br/><span class="tiny-text">'.$error_code.'</span>' : ''; |
|
632 | 632 | // add notice |
633 | - self::$_espresso_notices[ $type ][] = $msg . $error_code; |
|
634 | - add_action( 'wp_footer', array( 'EE_Error', 'enqueue_error_scripts' ), 1 ); |
|
633 | + self::$_espresso_notices[$type][] = $msg.$error_code; |
|
634 | + add_action('wp_footer', array('EE_Error', 'enqueue_error_scripts'), 1); |
|
635 | 635 | } |
636 | 636 | |
637 | 637 | } |
@@ -685,7 +685,7 @@ discard block |
||
685 | 685 | * @access private |
686 | 686 | * @return void |
687 | 687 | */ |
688 | - public static function reset_notices(){ |
|
688 | + public static function reset_notices() { |
|
689 | 689 | self::$_espresso_notices['success'] = FALSE; |
690 | 690 | self::$_espresso_notices['attention'] = FALSE; |
691 | 691 | self::$_espresso_notices['errors'] = FALSE; |
@@ -698,14 +698,14 @@ discard block |
||
698 | 698 | * @access public |
699 | 699 | * @return int |
700 | 700 | */ |
701 | - public static function has_notices(){ |
|
701 | + public static function has_notices() { |
|
702 | 702 | $has_notices = 0; |
703 | 703 | // check for success messages |
704 | - $has_notices = self::$_espresso_notices['success'] && ! empty( self::$_espresso_notices['success'] ) ? 3 : $has_notices; |
|
704 | + $has_notices = self::$_espresso_notices['success'] && ! empty(self::$_espresso_notices['success']) ? 3 : $has_notices; |
|
705 | 705 | // check for attention messages |
706 | - $has_notices = self::$_espresso_notices['attention'] && ! empty( self::$_espresso_notices['attention'] ) ? 2 : $has_notices; |
|
706 | + $has_notices = self::$_espresso_notices['attention'] && ! empty(self::$_espresso_notices['attention']) ? 2 : $has_notices; |
|
707 | 707 | // check for error messages |
708 | - $has_notices = self::$_espresso_notices['errors'] && ! empty( self::$_espresso_notices['errors'] ) ? 1 : $has_notices; |
|
708 | + $has_notices = self::$_espresso_notices['errors'] && ! empty(self::$_espresso_notices['errors']) ? 1 : $has_notices; |
|
709 | 709 | return $has_notices; |
710 | 710 | } |
711 | 711 | |
@@ -720,8 +720,8 @@ discard block |
||
720 | 720 | * @param boolean $remove_empty whether or not to unset empty messages |
721 | 721 | * @return array |
722 | 722 | */ |
723 | - public static function get_notices( $format_output = TRUE, $save_to_transient = FALSE, $remove_empty = TRUE ) { |
|
724 | - do_action( 'AHEE_log', __FILE__, __FUNCTION__, '' ); |
|
723 | + public static function get_notices($format_output = TRUE, $save_to_transient = FALSE, $remove_empty = TRUE) { |
|
724 | + do_action('AHEE_log', __FILE__, __FUNCTION__, ''); |
|
725 | 725 | |
726 | 726 | $success_messages = ''; |
727 | 727 | $attention_messages = ''; |
@@ -731,44 +731,44 @@ discard block |
||
731 | 731 | // EEH_Debug_Tools::printr( self::$_espresso_notices, 'espresso_notices <br /><span style="font-size:10px;font-weight:normal;">' . __FILE__ . '<br />line no: ' . __LINE__ . '</span>', 'auto' ); |
732 | 732 | |
733 | 733 | // either save notices to the db |
734 | - if ( $save_to_transient ) { |
|
735 | - update_option( 'ee_notices', self::$_espresso_notices ); |
|
734 | + if ($save_to_transient) { |
|
735 | + update_option('ee_notices', self::$_espresso_notices); |
|
736 | 736 | return; |
737 | 737 | } |
738 | 738 | // grab any notices that have been previously saved |
739 | - if ( $notices = get_option( 'ee_notices', FALSE )) { |
|
740 | - foreach ( $notices as $type => $notice ) { |
|
741 | - if ( is_array( $notice ) && ! empty( $notice )) { |
|
739 | + if ($notices = get_option('ee_notices', FALSE)) { |
|
740 | + foreach ($notices as $type => $notice) { |
|
741 | + if (is_array($notice) && ! empty($notice)) { |
|
742 | 742 | // make sure that existsing notice type is an array |
743 | - self::$_espresso_notices[ $type ] = is_array( self::$_espresso_notices[ $type ] ) && ! empty( self::$_espresso_notices[ $type ] ) ? self::$_espresso_notices[ $type ] : array(); |
|
743 | + self::$_espresso_notices[$type] = is_array(self::$_espresso_notices[$type]) && ! empty(self::$_espresso_notices[$type]) ? self::$_espresso_notices[$type] : array(); |
|
744 | 744 | // merge stored notices with any newly created ones |
745 | - self::$_espresso_notices[ $type ] = array_merge( self::$_espresso_notices[ $type ], $notice ); |
|
745 | + self::$_espresso_notices[$type] = array_merge(self::$_espresso_notices[$type], $notice); |
|
746 | 746 | $print_scripts = TRUE; |
747 | 747 | } |
748 | 748 | } |
749 | 749 | // now clear any stored notices |
750 | - update_option( 'ee_notices', FALSE ); |
|
750 | + update_option('ee_notices', FALSE); |
|
751 | 751 | } |
752 | 752 | |
753 | 753 | // check for success messages |
754 | - if ( self::$_espresso_notices['success'] && ! empty( self::$_espresso_notices['success'] )) { |
|
754 | + if (self::$_espresso_notices['success'] && ! empty(self::$_espresso_notices['success'])) { |
|
755 | 755 | // combine messages |
756 | - $success_messages .= implode( self::$_espresso_notices['success'], '<br />' ); |
|
756 | + $success_messages .= implode(self::$_espresso_notices['success'], '<br />'); |
|
757 | 757 | $print_scripts = TRUE; |
758 | 758 | } |
759 | 759 | |
760 | 760 | // check for attention messages |
761 | - if ( self::$_espresso_notices['attention'] && ! empty( self::$_espresso_notices['attention'] ) ) { |
|
761 | + if (self::$_espresso_notices['attention'] && ! empty(self::$_espresso_notices['attention'])) { |
|
762 | 762 | // combine messages |
763 | - $attention_messages .= implode( self::$_espresso_notices['attention'], '<br />' ); |
|
763 | + $attention_messages .= implode(self::$_espresso_notices['attention'], '<br />'); |
|
764 | 764 | $print_scripts = TRUE; |
765 | 765 | } |
766 | 766 | |
767 | 767 | // check for error messages |
768 | - if ( self::$_espresso_notices['errors'] && ! empty( self::$_espresso_notices['errors'] ) ) { |
|
769 | - $error_messages .= count( self::$_espresso_notices['errors'] ) > 1 ? __( 'The following errors have occurred:<br />', 'event_espresso' ) : __( 'An error has occurred:<br />', 'event_espresso' ); |
|
768 | + if (self::$_espresso_notices['errors'] && ! empty(self::$_espresso_notices['errors'])) { |
|
769 | + $error_messages .= count(self::$_espresso_notices['errors']) > 1 ? __('The following errors have occurred:<br />', 'event_espresso') : __('An error has occurred:<br />', 'event_espresso'); |
|
770 | 770 | // combine messages |
771 | - $error_messages .= implode( self::$_espresso_notices['errors'], '<br />' ); |
|
771 | + $error_messages .= implode(self::$_espresso_notices['errors'], '<br />'); |
|
772 | 772 | $print_scripts = TRUE; |
773 | 773 | } |
774 | 774 | |
@@ -782,21 +782,21 @@ discard block |
||
782 | 782 | $css_id = is_admin() ? 'message' : 'espresso-notices-success'; |
783 | 783 | $css_class = is_admin() ? 'updated fade' : 'success fade-away'; |
784 | 784 | //showMessage( $success_messages ); |
785 | - $notices .= '<div id="' . $css_id . '" class="espresso-notices ' . $css_class . '" style="display:none;"><p>' . $success_messages . '</p>' . $close . '</div>'; |
|
785 | + $notices .= '<div id="'.$css_id.'" class="espresso-notices '.$css_class.'" style="display:none;"><p>'.$success_messages.'</p>'.$close.'</div>'; |
|
786 | 786 | } |
787 | 787 | |
788 | 788 | if ($attention_messages != '') { |
789 | 789 | $css_id = is_admin() ? 'message' : 'espresso-notices-attention'; |
790 | 790 | $css_class = is_admin() ? 'updated ee-notices-attention' : 'attention fade-away'; |
791 | 791 | //showMessage( $error_messages, TRUE ); |
792 | - $notices .= '<div id="' . $css_id . '" class="espresso-notices ' . $css_class . '" style="display:none;"><p>' . $attention_messages . '</p>' . $close . '</div>'; |
|
792 | + $notices .= '<div id="'.$css_id.'" class="espresso-notices '.$css_class.'" style="display:none;"><p>'.$attention_messages.'</p>'.$close.'</div>'; |
|
793 | 793 | } |
794 | 794 | |
795 | 795 | if ($error_messages != '') { |
796 | 796 | $css_id = is_admin() ? 'message' : 'espresso-notices-error'; |
797 | 797 | $css_class = is_admin() ? 'error' : 'error fade-away'; |
798 | 798 | //showMessage( $error_messages, TRUE ); |
799 | - $notices .= '<div id="' . $css_id . '" class="espresso-notices ' . $css_class . '" style="display:none;"><p>' . $error_messages . '</p>' . $close . '</div>'; |
|
799 | + $notices .= '<div id="'.$css_id.'" class="espresso-notices '.$css_class.'" style="display:none;"><p>'.$error_messages.'</p>'.$close.'</div>'; |
|
800 | 800 | } |
801 | 801 | |
802 | 802 | $notices .= '</div>'; |
@@ -809,7 +809,7 @@ discard block |
||
809 | 809 | 'errors' => $error_messages |
810 | 810 | ); |
811 | 811 | |
812 | - if ( $remove_empty ) { |
|
812 | + if ($remove_empty) { |
|
813 | 813 | // remove empty notices |
814 | 814 | foreach ($notices as $type => $notice) { |
815 | 815 | if (empty($notice)) { |
@@ -819,7 +819,7 @@ discard block |
||
819 | 819 | } |
820 | 820 | } |
821 | 821 | |
822 | - if ( $print_scripts ) { |
|
822 | + if ($print_scripts) { |
|
823 | 823 | self::_print_scripts(); |
824 | 824 | } |
825 | 825 | |
@@ -839,17 +839,17 @@ discard block |
||
839 | 839 | * @param bool $force_update allows one to enforce the reappearance of a persistent message. |
840 | 840 | * @return void |
841 | 841 | */ |
842 | - public static function add_persistent_admin_notice( $pan_name = '', $pan_message, $force_update = FALSE ) { |
|
843 | - if ( ! empty( $pan_name ) && ! empty( $pan_message )) { |
|
844 | - $persistent_admin_notices = get_option( 'ee_pers_admin_notices', array() ); |
|
842 | + public static function add_persistent_admin_notice($pan_name = '', $pan_message, $force_update = FALSE) { |
|
843 | + if ( ! empty($pan_name) && ! empty($pan_message)) { |
|
844 | + $persistent_admin_notices = get_option('ee_pers_admin_notices', array()); |
|
845 | 845 | //maybe initialize persistent_admin_notices |
846 | - if ( empty( $persistent_admin_notices )) { |
|
847 | - add_option( 'ee_pers_admin_notices', array(), '', 'no' ); |
|
846 | + if (empty($persistent_admin_notices)) { |
|
847 | + add_option('ee_pers_admin_notices', array(), '', 'no'); |
|
848 | 848 | } |
849 | - $pan_name = sanitize_key( $pan_name ); |
|
850 | - if ( ! array_key_exists( $pan_name, $persistent_admin_notices ) || $force_update ) { |
|
851 | - $persistent_admin_notices[ $pan_name ] = $pan_message; |
|
852 | - update_option( 'ee_pers_admin_notices', $persistent_admin_notices ); |
|
849 | + $pan_name = sanitize_key($pan_name); |
|
850 | + if ( ! array_key_exists($pan_name, $persistent_admin_notices) || $force_update) { |
|
851 | + $persistent_admin_notices[$pan_name] = $pan_message; |
|
852 | + update_option('ee_pers_admin_notices', $persistent_admin_notices); |
|
853 | 853 | } |
854 | 854 | } |
855 | 855 | } |
@@ -865,34 +865,34 @@ discard block |
||
865 | 865 | * @param bool $return_immediately |
866 | 866 | * @return void |
867 | 867 | */ |
868 | - public static function dismiss_persistent_admin_notice( $pan_name = '', $purge = FALSE, $return_immediately = FALSE ) { |
|
869 | - $pan_name = EE_Registry::instance()->REQ->is_set( 'ee_nag_notice' ) ? EE_Registry::instance()->REQ->get( 'ee_nag_notice' ) : $pan_name; |
|
870 | - if ( ! empty( $pan_name )) { |
|
871 | - $persistent_admin_notices = get_option( 'ee_pers_admin_notices', array() ); |
|
868 | + public static function dismiss_persistent_admin_notice($pan_name = '', $purge = FALSE, $return_immediately = FALSE) { |
|
869 | + $pan_name = EE_Registry::instance()->REQ->is_set('ee_nag_notice') ? EE_Registry::instance()->REQ->get('ee_nag_notice') : $pan_name; |
|
870 | + if ( ! empty($pan_name)) { |
|
871 | + $persistent_admin_notices = get_option('ee_pers_admin_notices', array()); |
|
872 | 872 | // check if notice we wish to dismiss is actually in the $persistent_admin_notices array |
873 | - if ( is_array( $persistent_admin_notices ) && isset( $persistent_admin_notices[ $pan_name ] )) { |
|
873 | + if (is_array($persistent_admin_notices) && isset($persistent_admin_notices[$pan_name])) { |
|
874 | 874 | // completely delete nag notice, or just NULL message so that it can NOT be added again ? |
875 | - if ( $purge ) { |
|
876 | - unset( $persistent_admin_notices[ $pan_name ] ); |
|
875 | + if ($purge) { |
|
876 | + unset($persistent_admin_notices[$pan_name]); |
|
877 | 877 | } else { |
878 | - $persistent_admin_notices[ $pan_name ] = NULL; |
|
878 | + $persistent_admin_notices[$pan_name] = NULL; |
|
879 | 879 | } |
880 | - if ( update_option( 'ee_pers_admin_notices', $persistent_admin_notices ) === FALSE ) { |
|
881 | - EE_Error::add_error( sprintf( __( 'The persistent admin notice for "%s" could not be deleted.', 'event_espresso' ), $pan_name ), __FILE__, __FUNCTION__, __LINE__ ); |
|
880 | + if (update_option('ee_pers_admin_notices', $persistent_admin_notices) === FALSE) { |
|
881 | + EE_Error::add_error(sprintf(__('The persistent admin notice for "%s" could not be deleted.', 'event_espresso'), $pan_name), __FILE__, __FUNCTION__, __LINE__); |
|
882 | 882 | } |
883 | 883 | } |
884 | 884 | } |
885 | - if ( $return_immediately ) { |
|
885 | + if ($return_immediately) { |
|
886 | 886 | return; |
887 | - } else if ( EE_Registry::instance()->REQ->ajax ) { |
|
887 | + } else if (EE_Registry::instance()->REQ->ajax) { |
|
888 | 888 | // grab any notices and concatenate into string |
889 | - echo json_encode( array( 'errors' => implode( '<br />', EE_Error::get_notices( FALSE )))); |
|
889 | + echo json_encode(array('errors' => implode('<br />', EE_Error::get_notices(FALSE)))); |
|
890 | 890 | exit(); |
891 | 891 | } else { |
892 | 892 | // save errors to a transient to be displayed on next request (after redirect) |
893 | - EE_Error::get_notices( FALSE, TRUE ); |
|
894 | - $return_url = EE_Registry::instance()->REQ->is_set( 'return_url' ) ? EE_Registry::instance()->REQ->get( 'return_url' ) : ''; |
|
895 | - wp_safe_redirect( urldecode( $return_url )); |
|
893 | + EE_Error::get_notices(FALSE, TRUE); |
|
894 | + $return_url = EE_Registry::instance()->REQ->is_set('return_url') ? EE_Registry::instance()->REQ->get('return_url') : ''; |
|
895 | + wp_safe_redirect(urldecode($return_url)); |
|
896 | 896 | } |
897 | 897 | } |
898 | 898 | |
@@ -907,20 +907,20 @@ discard block |
||
907 | 907 | * @param string $return_url URL to go back to aftger nag notice is dismissed |
908 | 908 | * @return string |
909 | 909 | */ |
910 | - public static function display_persistent_admin_notices( $pan_name = '', $pan_message = '', $return_url = '' ) { |
|
911 | - if ( ! empty( $pan_name ) && ! empty( $pan_message )) { |
|
910 | + public static function display_persistent_admin_notices($pan_name = '', $pan_message = '', $return_url = '') { |
|
911 | + if ( ! empty($pan_name) && ! empty($pan_message)) { |
|
912 | 912 | $args = array( |
913 | 913 | 'nag_notice' => $pan_name, |
914 | - 'return_url' => urlencode( $return_url ), |
|
914 | + 'return_url' => urlencode($return_url), |
|
915 | 915 | 'ajax_url' => WP_AJAX_URL, |
916 | - 'unknown_error' => __( 'An unknown error has occurred on the server while attempting to dismiss this notice.', 'event_espresso' ) |
|
916 | + 'unknown_error' => __('An unknown error has occurred on the server while attempting to dismiss this notice.', 'event_espresso') |
|
917 | 917 | ); |
918 | - wp_localize_script( 'espresso_core', 'ee_dismiss', $args ); |
|
918 | + wp_localize_script('espresso_core', 'ee_dismiss', $args); |
|
919 | 919 | return ' |
920 | - <div id="' . $pan_name . '" class="espresso-notices updated ee-nag-notice clearfix" style="border-left: 4px solid #fcb93c;"> |
|
921 | - <p>' . $pan_message . '</p> |
|
922 | - <a class="dismiss-ee-nag-notice hide-if-no-js" style="float: right; cursor: pointer; text-decoration:none;" rel="' . $pan_name . '"> |
|
923 | - <span class="dashicons dashicons-dismiss" style="position:relative; top:-1px; margin-right:.25em;"></span>'.__( 'Dismiss', 'event_espresso' ) .' |
|
920 | + <div id="' . $pan_name.'" class="espresso-notices updated ee-nag-notice clearfix" style="border-left: 4px solid #fcb93c;"> |
|
921 | + <p>' . $pan_message.'</p> |
|
922 | + <a class="dismiss-ee-nag-notice hide-if-no-js" style="float: right; cursor: pointer; text-decoration:none;" rel="' . $pan_name.'"> |
|
923 | + <span class="dashicons dashicons-dismiss" style="position:relative; top:-1px; margin-right:.25em;"></span>'.__('Dismiss', 'event_espresso').' |
|
924 | 924 | </a> |
925 | 925 | <div style="clear:both;"></div> |
926 | 926 | </div>'; |
@@ -936,17 +936,17 @@ discard block |
||
936 | 936 | * @param string $return_url |
937 | 937 | * @return array |
938 | 938 | */ |
939 | - public static function get_persistent_admin_notices( $return_url = '' ) { |
|
939 | + public static function get_persistent_admin_notices($return_url = '') { |
|
940 | 940 | $notices = ''; |
941 | 941 | // check for persistent admin notices |
942 | - if ( $persistent_admin_notices = get_option( 'ee_pers_admin_notices', FALSE )) { |
|
942 | + if ($persistent_admin_notices = get_option('ee_pers_admin_notices', FALSE)) { |
|
943 | 943 | // load scripts |
944 | - wp_register_script( 'espresso_core', EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js', array('jquery'), EVENT_ESPRESSO_VERSION, TRUE ); |
|
945 | - wp_register_script( 'ee_error_js', EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js', array('espresso_core'), EVENT_ESPRESSO_VERSION, TRUE ); |
|
946 | - wp_enqueue_script( 'ee_error_js' ); |
|
944 | + wp_register_script('espresso_core', EE_GLOBAL_ASSETS_URL.'scripts/espresso_core.js', array('jquery'), EVENT_ESPRESSO_VERSION, TRUE); |
|
945 | + wp_register_script('ee_error_js', EE_GLOBAL_ASSETS_URL.'scripts/EE_Error.js', array('espresso_core'), EVENT_ESPRESSO_VERSION, TRUE); |
|
946 | + wp_enqueue_script('ee_error_js'); |
|
947 | 947 | // and display notices |
948 | - foreach( $persistent_admin_notices as $pan_name => $pan_message ) { |
|
949 | - $notices .= self::display_persistent_admin_notices( $pan_name, $pan_message, $return_url ); |
|
948 | + foreach ($persistent_admin_notices as $pan_name => $pan_message) { |
|
949 | + $notices .= self::display_persistent_admin_notices($pan_name, $pan_message, $return_url); |
|
950 | 950 | } |
951 | 951 | } |
952 | 952 | return $notices; |
@@ -961,26 +961,26 @@ discard block |
||
961 | 961 | * @param bool $force_print |
962 | 962 | * @return void |
963 | 963 | */ |
964 | - private static function _print_scripts( $force_print = FALSE ) { |
|
965 | - if (( did_action( 'admin_enqueue_scripts' ) || did_action( 'wp_enqueue_scripts' )) && ! $force_print ) { |
|
966 | - if ( wp_script_is( 'ee_error_js', 'enqueued' )) { |
|
964 | + private static function _print_scripts($force_print = FALSE) { |
|
965 | + if ((did_action('admin_enqueue_scripts') || did_action('wp_enqueue_scripts')) && ! $force_print) { |
|
966 | + if (wp_script_is('ee_error_js', 'enqueued')) { |
|
967 | 967 | return; |
968 | - } else if ( wp_script_is( 'ee_error_js', 'registered' )) { |
|
969 | - add_filter( 'FHEE_load_css', '__return_true' ); |
|
970 | - add_filter( 'FHEE_load_js', '__return_true' ); |
|
971 | - wp_enqueue_script( 'ee_error_js' ); |
|
972 | - wp_localize_script( 'ee_error_js','ee_settings', array( 'wp_debug'=>WP_DEBUG )); |
|
968 | + } else if (wp_script_is('ee_error_js', 'registered')) { |
|
969 | + add_filter('FHEE_load_css', '__return_true'); |
|
970 | + add_filter('FHEE_load_js', '__return_true'); |
|
971 | + wp_enqueue_script('ee_error_js'); |
|
972 | + wp_localize_script('ee_error_js', 'ee_settings', array('wp_debug'=>WP_DEBUG)); |
|
973 | 973 | } |
974 | 974 | } else { |
975 | 975 | return ' |
976 | 976 | <script> |
977 | 977 | /* <![CDATA[ */ |
978 | -var ee_settings = {"wp_debug":"' . WP_DEBUG . '"}; |
|
978 | +var ee_settings = {"wp_debug":"' . WP_DEBUG.'"}; |
|
979 | 979 | /* ]]> */ |
980 | 980 | </script> |
981 | -<script src="' . includes_url() . 'js/jquery/jquery.js" type="text/javascript"></script> |
|
982 | -<script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script> |
|
983 | -<script src="' . EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js' . '?ver=' . espresso_version() . '" type="text/javascript"></script> |
|
981 | +<script src="' . includes_url().'js/jquery/jquery.js" type="text/javascript"></script> |
|
982 | +<script src="' . EE_GLOBAL_ASSETS_URL.'scripts/espresso_core.js'.'?ver='.espresso_version().'" type="text/javascript"></script> |
|
983 | +<script src="' . EE_GLOBAL_ASSETS_URL.'scripts/EE_Error.js'.'?ver='.espresso_version().'" type="text/javascript"></script> |
|
984 | 984 | '; |
985 | 985 | |
986 | 986 | } |
@@ -1014,11 +1014,11 @@ discard block |
||
1014 | 1014 | * @ param string $line |
1015 | 1015 | * @ return string |
1016 | 1016 | */ |
1017 | - public static function generate_error_code ( $file = '', $func = '', $line = '' ) { |
|
1018 | - $file = explode( '.', basename( $file )); |
|
1019 | - $error_code = ! empty( $file[0] ) ? $file[0] : ''; |
|
1020 | - $error_code .= ! empty( $func ) ? ' - ' . $func : ''; |
|
1021 | - $error_code .= ! empty( $line ) ? ' - ' . $line : ''; |
|
1017 | + public static function generate_error_code($file = '', $func = '', $line = '') { |
|
1018 | + $file = explode('.', basename($file)); |
|
1019 | + $error_code = ! empty($file[0]) ? $file[0] : ''; |
|
1020 | + $error_code .= ! empty($func) ? ' - '.$func : ''; |
|
1021 | + $error_code .= ! empty($line) ? ' - '.$line : ''; |
|
1022 | 1022 | return $error_code; |
1023 | 1023 | } |
1024 | 1024 | |
@@ -1034,38 +1034,38 @@ discard block |
||
1034 | 1034 | * @ param object $ex |
1035 | 1035 | * @ return void |
1036 | 1036 | */ |
1037 | - public function write_to_error_log ( $time = FALSE, $ex = FALSE, $clear = FALSE ) { |
|
1037 | + public function write_to_error_log($time = FALSE, $ex = FALSE, $clear = FALSE) { |
|
1038 | 1038 | |
1039 | - if ( ! $ex ) { |
|
1039 | + if ( ! $ex) { |
|
1040 | 1040 | return; |
1041 | 1041 | } |
1042 | 1042 | |
1043 | - if ( ! $time ) { |
|
1043 | + if ( ! $time) { |
|
1044 | 1044 | $time = time(); |
1045 | 1045 | } |
1046 | 1046 | |
1047 | - $exception_log = '----------------------------------------------------------------------------------------' . PHP_EOL; |
|
1048 | - $exception_log .= '[' . date( 'Y-m-d H:i:s', $time ) . '] Exception Details' . PHP_EOL; |
|
1049 | - $exception_log .= 'Message: ' . $ex['msg'] . PHP_EOL; |
|
1050 | - $exception_log .= 'Code: '. $ex['code'] . PHP_EOL; |
|
1051 | - $exception_log .= 'File: '. $ex['file'] . PHP_EOL; |
|
1052 | - $exception_log .= 'Line No: ' . $ex['line'] . PHP_EOL; |
|
1053 | - $exception_log .= 'Stack trace: ' . PHP_EOL; |
|
1054 | - $exception_log .= $ex['string'] . PHP_EOL; |
|
1055 | - $exception_log .= '----------------------------------------------------------------------------------------' . PHP_EOL; |
|
1056 | - |
|
1057 | - EE_Registry::instance()->load_helper( 'File' ); |
|
1047 | + $exception_log = '----------------------------------------------------------------------------------------'.PHP_EOL; |
|
1048 | + $exception_log .= '['.date('Y-m-d H:i:s', $time).'] Exception Details'.PHP_EOL; |
|
1049 | + $exception_log .= 'Message: '.$ex['msg'].PHP_EOL; |
|
1050 | + $exception_log .= 'Code: '.$ex['code'].PHP_EOL; |
|
1051 | + $exception_log .= 'File: '.$ex['file'].PHP_EOL; |
|
1052 | + $exception_log .= 'Line No: '.$ex['line'].PHP_EOL; |
|
1053 | + $exception_log .= 'Stack trace: '.PHP_EOL; |
|
1054 | + $exception_log .= $ex['string'].PHP_EOL; |
|
1055 | + $exception_log .= '----------------------------------------------------------------------------------------'.PHP_EOL; |
|
1056 | + |
|
1057 | + EE_Registry::instance()->load_helper('File'); |
|
1058 | 1058 | try { |
1059 | - EEH_File::ensure_folder_exists_and_is_writable( EVENT_ESPRESSO_UPLOAD_DIR . 'logs' ); |
|
1060 | - EEH_File::add_htaccess_deny_from_all( EVENT_ESPRESSO_UPLOAD_DIR . 'logs' ); |
|
1061 | - EEH_File::ensure_file_exists_and_is_writable( EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . self::$_exception_log_file ); |
|
1062 | - if ( ! $clear ) { |
|
1059 | + EEH_File::ensure_folder_exists_and_is_writable(EVENT_ESPRESSO_UPLOAD_DIR.'logs'); |
|
1060 | + EEH_File::add_htaccess_deny_from_all(EVENT_ESPRESSO_UPLOAD_DIR.'logs'); |
|
1061 | + EEH_File::ensure_file_exists_and_is_writable(EVENT_ESPRESSO_UPLOAD_DIR.'logs'.DS.self::$_exception_log_file); |
|
1062 | + if ( ! $clear) { |
|
1063 | 1063 | //get existing log file and append new log info |
1064 | - $exception_log = EEH_File::get_file_contents( EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . self::$_exception_log_file ) . $exception_log; |
|
1064 | + $exception_log = EEH_File::get_file_contents(EVENT_ESPRESSO_UPLOAD_DIR.'logs'.DS.self::$_exception_log_file).$exception_log; |
|
1065 | 1065 | } |
1066 | - EEH_File::write_to_file( EVENT_ESPRESSO_UPLOAD_DIR . 'logs' . DS . self::$_exception_log_file, $exception_log ); |
|
1067 | - } catch( EE_Error $e ){ |
|
1068 | - EE_Error::add_error( sprintf( __( 'Event Espresso error logging could not be setup because: %s', 'event_espresso' ), $e->getMessage() )); |
|
1066 | + EEH_File::write_to_file(EVENT_ESPRESSO_UPLOAD_DIR.'logs'.DS.self::$_exception_log_file, $exception_log); |
|
1067 | + } catch (EE_Error $e) { |
|
1068 | + EE_Error::add_error(sprintf(__('Event Espresso error logging could not be setup because: %s', 'event_espresso'), $e->getMessage())); |
|
1069 | 1069 | return; |
1070 | 1070 | } |
1071 | 1071 | |
@@ -1088,10 +1088,10 @@ discard block |
||
1088 | 1088 | * @param string $version The version of Event Espresso where the error was added |
1089 | 1089 | * @return trigger_error() |
1090 | 1090 | */ |
1091 | - public static function doing_it_wrong( $function, $message, $version ) { |
|
1092 | - if ( defined('WP_DEBUG') && WP_DEBUG ) { |
|
1091 | + public static function doing_it_wrong($function, $message, $version) { |
|
1092 | + if (defined('WP_DEBUG') && WP_DEBUG) { |
|
1093 | 1093 | EE_Registry::instance()->load_helper('Debug_Tools'); |
1094 | - EEH_Debug_Tools::instance()->doing_it_wrong( $function, $message, $version ); |
|
1094 | + EEH_Debug_Tools::instance()->doing_it_wrong($function, $message, $version); |
|
1095 | 1095 | } |
1096 | 1096 | } |
1097 | 1097 | |
@@ -1111,13 +1111,13 @@ discard block |
||
1111 | 1111 | */ |
1112 | 1112 | function espresso_error_enqueue_scripts() { |
1113 | 1113 | // js for error handling |
1114 | - wp_register_script( 'espresso_core', EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js', array('jquery'), EVENT_ESPRESSO_VERSION, FALSE ); |
|
1115 | - wp_register_script( 'ee_error_js', EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js', array('espresso_core'), EVENT_ESPRESSO_VERSION, FALSE ); |
|
1114 | + wp_register_script('espresso_core', EE_GLOBAL_ASSETS_URL.'scripts/espresso_core.js', array('jquery'), EVENT_ESPRESSO_VERSION, FALSE); |
|
1115 | + wp_register_script('ee_error_js', EE_GLOBAL_ASSETS_URL.'scripts/EE_Error.js', array('espresso_core'), EVENT_ESPRESSO_VERSION, FALSE); |
|
1116 | 1116 | } |
1117 | -if ( is_admin() ) { |
|
1118 | - add_action( 'admin_enqueue_scripts', 'espresso_error_enqueue_scripts', 2 ); |
|
1117 | +if (is_admin()) { |
|
1118 | + add_action('admin_enqueue_scripts', 'espresso_error_enqueue_scripts', 2); |
|
1119 | 1119 | } else { |
1120 | - add_action( 'wp_enqueue_scripts', 'espresso_error_enqueue_scripts', 2 ); |
|
1120 | + add_action('wp_enqueue_scripts', 'espresso_error_enqueue_scripts', 2); |
|
1121 | 1121 | } |
1122 | 1122 | |
1123 | 1123 |
@@ -18,52 +18,52 @@ discard block |
||
18 | 18 | |
19 | 19 | |
20 | 20 | /** |
21 | - * name of the file to log exceptions to |
|
22 | - * @access private |
|
23 | - * @var string |
|
24 | - */ |
|
21 | + * name of the file to log exceptions to |
|
22 | + * @access private |
|
23 | + * @var string |
|
24 | + */ |
|
25 | 25 | private static $_exception_log_file = 'espresso_error_log.txt'; |
26 | 26 | |
27 | 27 | /** |
28 | - * the exception |
|
29 | - * @access private |
|
30 | - * @var object |
|
31 | - */ |
|
28 | + * the exception |
|
29 | + * @access private |
|
30 | + * @var object |
|
31 | + */ |
|
32 | 32 | private $_exception; |
33 | 33 | |
34 | 34 | /** |
35 | - * stores details for all exception |
|
36 | - * @access private |
|
37 | - * @var array |
|
38 | - */ |
|
35 | + * stores details for all exception |
|
36 | + * @access private |
|
37 | + * @var array |
|
38 | + */ |
|
39 | 39 | private static $_all_exceptions = array(); |
40 | 40 | |
41 | 41 | /** |
42 | - * tracks number of errors |
|
43 | - * @access private |
|
44 | - * @var int |
|
45 | - */ |
|
42 | + * tracks number of errors |
|
43 | + * @access private |
|
44 | + * @var int |
|
45 | + */ |
|
46 | 46 | private static $_error_count = 0; |
47 | 47 | |
48 | 48 | /** |
49 | - * has JS been loaded ? |
|
50 | - * @access private |
|
51 | - * @var boolean |
|
52 | - */ |
|
49 | + * has JS been loaded ? |
|
50 | + * @access private |
|
51 | + * @var boolean |
|
52 | + */ |
|
53 | 53 | private static $_js_loaded = FALSE; |
54 | 54 | |
55 | 55 | /** |
56 | - * has shutdown action been added ? |
|
57 | - * @access private |
|
58 | - * @var boolean |
|
59 | - */ |
|
56 | + * has shutdown action been added ? |
|
57 | + * @access private |
|
58 | + * @var boolean |
|
59 | + */ |
|
60 | 60 | private static $_action_added = FALSE; |
61 | 61 | |
62 | 62 | /** |
63 | - * has shutdown action been added ? |
|
64 | - * @access private |
|
65 | - * @var boolean |
|
66 | - */ |
|
63 | + * has shutdown action been added ? |
|
64 | + * @access private |
|
65 | + * @var boolean |
|
66 | + */ |
|
67 | 67 | private static $_espresso_notices = array( 'success' => FALSE, 'errors' => FALSE, 'attention' => FALSE ); |
68 | 68 | |
69 | 69 | |
@@ -71,10 +71,10 @@ discard block |
||
71 | 71 | |
72 | 72 | |
73 | 73 | /** |
74 | - * @override default exception handling |
|
75 | - * @access public |
|
76 | - * @echo string |
|
77 | - */ |
|
74 | + * @override default exception handling |
|
75 | + * @access public |
|
76 | + * @echo string |
|
77 | + */ |
|
78 | 78 | function __construct( $message, $code = 0, Exception $previous = NULL ) { |
79 | 79 | if ( version_compare( phpversion(), '5.3.0', '<' )) { |
80 | 80 | parent::__construct( $message, $code ); |
@@ -173,10 +173,10 @@ discard block |
||
173 | 173 | |
174 | 174 | |
175 | 175 | /** |
176 | - * fatal_error_handler |
|
177 | - * @access public |
|
178 | - * @return void |
|
179 | - */ |
|
176 | + * fatal_error_handler |
|
177 | + * @access public |
|
178 | + * @return void |
|
179 | + */ |
|
180 | 180 | public static function fatal_error_handler() { |
181 | 181 | $last_error = error_get_last(); |
182 | 182 | if ( $last_error['type'] === E_ERROR ) { |
@@ -221,11 +221,11 @@ discard block |
||
221 | 221 | |
222 | 222 | |
223 | 223 | /** |
224 | - * _add_actions |
|
225 | - * @access public |
|
226 | - * @return void |
|
227 | - */ |
|
228 | - public function get_error() { |
|
224 | + * _add_actions |
|
225 | + * @access public |
|
226 | + * @return void |
|
227 | + */ |
|
228 | + public function get_error() { |
|
229 | 229 | |
230 | 230 | if( apply_filters( 'FHEE__EE_Error__get_error__show_normal_exceptions', FALSE ) ){ |
231 | 231 | throw $this; |
@@ -255,22 +255,22 @@ discard block |
||
255 | 255 | |
256 | 256 | |
257 | 257 | /** |
258 | - * has_error |
|
259 | - * @access public |
|
260 | - * @return boolean |
|
261 | - */ |
|
262 | - public static function has_error(){ |
|
258 | + * has_error |
|
259 | + * @access public |
|
260 | + * @return boolean |
|
261 | + */ |
|
262 | + public static function has_error(){ |
|
263 | 263 | return self::$_error_count ? TRUE : FALSE; |
264 | 264 | } |
265 | 265 | |
266 | 266 | |
267 | 267 | |
268 | 268 | /** |
269 | - * display_errors |
|
270 | - * @access public |
|
271 | - * @echo string |
|
272 | - */ |
|
273 | - public function display_errors(){ |
|
269 | + * display_errors |
|
270 | + * @access public |
|
271 | + * @echo string |
|
272 | + */ |
|
273 | + public function display_errors(){ |
|
274 | 274 | |
275 | 275 | $trace_details = ''; |
276 | 276 | |
@@ -342,7 +342,7 @@ discard block |
||
342 | 342 | // process trace info |
343 | 343 | if ( empty( $ex['trace'] )) { |
344 | 344 | |
345 | - $trace_details .= __( 'Sorry, but no trace information was available for this exception.', 'event_espresso' ); |
|
345 | + $trace_details .= __( 'Sorry, but no trace information was available for this exception.', 'event_espresso' ); |
|
346 | 346 | |
347 | 347 | } else { |
348 | 348 | |
@@ -394,7 +394,7 @@ discard block |
||
394 | 394 | $function_dsply = ! empty( $function ) ? $function : ' '; |
395 | 395 | $args_dsply = ! empty( $args ) ? '( ' . $args . ' )' : ''; |
396 | 396 | |
397 | - $trace_details .= ' |
|
397 | + $trace_details .= ' |
|
398 | 398 | <tr> |
399 | 399 | <td align="right" class="' . $zebra . '">' . $nmbr_dsply . '</td> |
400 | 400 | <td align="right" class="' . $zebra . '">' . $line_dsply . '</td> |
@@ -406,7 +406,7 @@ discard block |
||
406 | 406 | |
407 | 407 | } |
408 | 408 | |
409 | - $trace_details .= ' |
|
409 | + $trace_details .= ' |
|
410 | 410 | </table> |
411 | 411 | </div>'; |
412 | 412 | |
@@ -486,12 +486,12 @@ discard block |
||
486 | 486 | |
487 | 487 | |
488 | 488 | /** |
489 | - * generate string from exception trace args |
|
490 | - * |
|
491 | - * @access private |
|
492 | - * @ param array $arguments |
|
493 | - * @ return string |
|
494 | - */ |
|
489 | + * generate string from exception trace args |
|
490 | + * |
|
491 | + * @access private |
|
492 | + * @ param array $arguments |
|
493 | + * @ return string |
|
494 | + */ |
|
495 | 495 | private function _convert_args_to_string ( $arguments = array(), $array = FALSE ) { |
496 | 496 | |
497 | 497 | $arg_string = ''; |
@@ -535,15 +535,15 @@ discard block |
||
535 | 535 | |
536 | 536 | |
537 | 537 | /** |
538 | - * add error message |
|
539 | - * |
|
540 | - * @access public |
|
541 | - * @param string $msg the message to display to users or developers - adding a double pipe || (OR) creates separate messages for user || dev |
|
542 | - * @param string $file the file that the error occurred in - just use __FILE__ |
|
543 | - * @param string $func the function/method that the error occurred in - just use __FUNCTION__ |
|
544 | - * @param string $line the line number where the error occurred - just use __LINE__ |
|
545 | - * @return void |
|
546 | - */ |
|
538 | + * add error message |
|
539 | + * |
|
540 | + * @access public |
|
541 | + * @param string $msg the message to display to users or developers - adding a double pipe || (OR) creates separate messages for user || dev |
|
542 | + * @param string $file the file that the error occurred in - just use __FILE__ |
|
543 | + * @param string $func the function/method that the error occurred in - just use __FUNCTION__ |
|
544 | + * @param string $line the line number where the error occurred - just use __LINE__ |
|
545 | + * @return void |
|
546 | + */ |
|
547 | 547 | public static function add_error( $msg = NULL, $file = NULL, $func = NULL, $line = NULL ) { |
548 | 548 | self::_add_notice ( 'errors', $msg, $file, $func, $line ); |
549 | 549 | } |
@@ -553,15 +553,15 @@ discard block |
||
553 | 553 | |
554 | 554 | |
555 | 555 | /** |
556 | - * add success message |
|
557 | - * |
|
558 | - * @access public |
|
559 | - * @param string $msg the message to display to users or developers - adding a double pipe || (OR) creates separate messages for user || dev |
|
560 | - * @param string $file the file that the error occurred in - just use __FILE__ |
|
561 | - * @param string $func the function/method that the error occurred in - just use __FUNCTION__ |
|
562 | - * @param string $line the line number where the error occurred - just use __LINE__ |
|
563 | - * @return void |
|
564 | - */ |
|
556 | + * add success message |
|
557 | + * |
|
558 | + * @access public |
|
559 | + * @param string $msg the message to display to users or developers - adding a double pipe || (OR) creates separate messages for user || dev |
|
560 | + * @param string $file the file that the error occurred in - just use __FILE__ |
|
561 | + * @param string $func the function/method that the error occurred in - just use __FUNCTION__ |
|
562 | + * @param string $line the line number where the error occurred - just use __LINE__ |
|
563 | + * @return void |
|
564 | + */ |
|
565 | 565 | public static function add_success( $msg = NULL, $file = NULL, $func = NULL, $line = NULL ) { |
566 | 566 | self::_add_notice ( 'success', $msg, $file, $func, $line ); |
567 | 567 | } |
@@ -571,15 +571,15 @@ discard block |
||
571 | 571 | |
572 | 572 | |
573 | 573 | /** |
574 | - * add attention message |
|
575 | - * |
|
576 | - * @access public |
|
577 | - * @param string $msg the message to display to users or developers - adding a double pipe || (OR) creates separate messages for user || dev |
|
578 | - * @param string $file the file that the error occurred in - just use __FILE__ |
|
579 | - * @param string $func the function/method that the error occurred in - just use __FUNCTION__ |
|
580 | - * @param string $line the line number where the error occurred - just use __LINE__ |
|
581 | - * @return void |
|
582 | - */ |
|
574 | + * add attention message |
|
575 | + * |
|
576 | + * @access public |
|
577 | + * @param string $msg the message to display to users or developers - adding a double pipe || (OR) creates separate messages for user || dev |
|
578 | + * @param string $file the file that the error occurred in - just use __FILE__ |
|
579 | + * @param string $func the function/method that the error occurred in - just use __FUNCTION__ |
|
580 | + * @param string $line the line number where the error occurred - just use __LINE__ |
|
581 | + * @return void |
|
582 | + */ |
|
583 | 583 | public static function add_attention( $msg = NULL, $file = NULL, $func = NULL, $line = NULL ) { |
584 | 584 | self::_add_notice ( 'attention', $msg, $file, $func, $line ); |
585 | 585 | } |
@@ -589,16 +589,16 @@ discard block |
||
589 | 589 | |
590 | 590 | |
591 | 591 | /** |
592 | - * add success message |
|
593 | - * |
|
594 | - * @access public |
|
595 | - * @param string $type whether the message is for a success or error notification |
|
596 | - * @param string $msg the message to display to users or developers - adding a double pipe || (OR) creates separate messages for user || dev |
|
597 | - * @param string $file the file that the error occurred in - just use __FILE__ |
|
598 | - * @param string $func the function/method that the error occurred in - just use __FUNCTION__ |
|
599 | - * @param string $line the line number where the error occurred - just use __LINE__ |
|
600 | - * @return void |
|
601 | - */ |
|
592 | + * add success message |
|
593 | + * |
|
594 | + * @access public |
|
595 | + * @param string $type whether the message is for a success or error notification |
|
596 | + * @param string $msg the message to display to users or developers - adding a double pipe || (OR) creates separate messages for user || dev |
|
597 | + * @param string $file the file that the error occurred in - just use __FILE__ |
|
598 | + * @param string $func the function/method that the error occurred in - just use __FUNCTION__ |
|
599 | + * @param string $line the line number where the error occurred - just use __LINE__ |
|
600 | + * @return void |
|
601 | + */ |
|
602 | 602 | private static function _add_notice( $type = 'success', $msg = NULL, $file = NULL, $func = NULL, $line = NULL ) { |
603 | 603 | if ( empty( $msg )) { |
604 | 604 | EE_Error::doing_it_wrong( |
@@ -641,11 +641,11 @@ discard block |
||
641 | 641 | |
642 | 642 | |
643 | 643 | /** |
644 | - * in some case it may be necessary to overwrite the existing success messages |
|
645 | - * |
|
646 | - * @access public |
|
647 | - * @return void |
|
648 | - */ |
|
644 | + * in some case it may be necessary to overwrite the existing success messages |
|
645 | + * |
|
646 | + * @access public |
|
647 | + * @return void |
|
648 | + */ |
|
649 | 649 | public static function overwrite_success() { |
650 | 650 | self::$_espresso_notices['success'] = FALSE; |
651 | 651 | } |
@@ -655,11 +655,11 @@ discard block |
||
655 | 655 | |
656 | 656 | |
657 | 657 | /** |
658 | - * in some case it may be necessary to overwrite the existing attention messages |
|
659 | - * |
|
660 | - * @access public |
|
661 | - * @return void |
|
662 | - */ |
|
658 | + * in some case it may be necessary to overwrite the existing attention messages |
|
659 | + * |
|
660 | + * @access public |
|
661 | + * @return void |
|
662 | + */ |
|
663 | 663 | public static function overwrite_attention() { |
664 | 664 | self::$_espresso_notices['attention'] = FALSE; |
665 | 665 | } |
@@ -669,11 +669,11 @@ discard block |
||
669 | 669 | |
670 | 670 | |
671 | 671 | /** |
672 | - * in some case it may be necessary to overwrite the existing error messages |
|
673 | - * |
|
674 | - * @access public |
|
675 | - * @return void |
|
676 | - */ |
|
672 | + * in some case it may be necessary to overwrite the existing error messages |
|
673 | + * |
|
674 | + * @access public |
|
675 | + * @return void |
|
676 | + */ |
|
677 | 677 | public static function overwrite_errors() { |
678 | 678 | self::$_espresso_notices['errors'] = FALSE; |
679 | 679 | } |
@@ -681,24 +681,24 @@ discard block |
||
681 | 681 | |
682 | 682 | |
683 | 683 | /** |
684 | - * reset_notices |
|
685 | - * @access private |
|
686 | - * @return void |
|
687 | - */ |
|
684 | + * reset_notices |
|
685 | + * @access private |
|
686 | + * @return void |
|
687 | + */ |
|
688 | 688 | public static function reset_notices(){ |
689 | - self::$_espresso_notices['success'] = FALSE; |
|
690 | - self::$_espresso_notices['attention'] = FALSE; |
|
691 | - self::$_espresso_notices['errors'] = FALSE; |
|
692 | - } |
|
689 | + self::$_espresso_notices['success'] = FALSE; |
|
690 | + self::$_espresso_notices['attention'] = FALSE; |
|
691 | + self::$_espresso_notices['errors'] = FALSE; |
|
692 | + } |
|
693 | 693 | |
694 | 694 | |
695 | 695 | |
696 | 696 | /** |
697 | - * has_errors |
|
698 | - * @access public |
|
699 | - * @return int |
|
700 | - */ |
|
701 | - public static function has_notices(){ |
|
697 | + * has_errors |
|
698 | + * @access public |
|
699 | + * @return int |
|
700 | + */ |
|
701 | + public static function has_notices(){ |
|
702 | 702 | $has_notices = 0; |
703 | 703 | // check for success messages |
704 | 704 | $has_notices = self::$_espresso_notices['success'] && ! empty( self::$_espresso_notices['success'] ) ? 3 : $has_notices; |
@@ -712,14 +712,14 @@ discard block |
||
712 | 712 | |
713 | 713 | |
714 | 714 | /** |
715 | - * compile all error or success messages into one string |
|
716 | - * |
|
717 | - * @access public |
|
718 | - * @param boolean $format_output whether or not to format the messages for display in the WP admin |
|
719 | - * @param boolean $save_to_transient whether or not to save notices to the db for retrieval on next request - ONLY do this just before redirecting |
|
720 | - * @param boolean $remove_empty whether or not to unset empty messages |
|
721 | - * @return array |
|
722 | - */ |
|
715 | + * compile all error or success messages into one string |
|
716 | + * |
|
717 | + * @access public |
|
718 | + * @param boolean $format_output whether or not to format the messages for display in the WP admin |
|
719 | + * @param boolean $save_to_transient whether or not to save notices to the db for retrieval on next request - ONLY do this just before redirecting |
|
720 | + * @param boolean $remove_empty whether or not to unset empty messages |
|
721 | + * @return array |
|
722 | + */ |
|
723 | 723 | public static function get_notices( $format_output = TRUE, $save_to_transient = FALSE, $remove_empty = TRUE ) { |
724 | 724 | do_action( 'AHEE_log', __FILE__, __FUNCTION__, '' ); |
725 | 725 | |
@@ -831,14 +831,14 @@ discard block |
||
831 | 831 | |
832 | 832 | |
833 | 833 | /** |
834 | - * add_persistent_admin_notice |
|
835 | - * |
|
836 | - * @access public |
|
837 | - * @param string $pan_name the name, or key of the Persistent Admin Notice to be stored |
|
838 | - * @param string $pan_message the message to be stored persistently until dismissed |
|
839 | - * @param bool $force_update allows one to enforce the reappearance of a persistent message. |
|
840 | - * @return void |
|
841 | - */ |
|
834 | + * add_persistent_admin_notice |
|
835 | + * |
|
836 | + * @access public |
|
837 | + * @param string $pan_name the name, or key of the Persistent Admin Notice to be stored |
|
838 | + * @param string $pan_message the message to be stored persistently until dismissed |
|
839 | + * @param bool $force_update allows one to enforce the reappearance of a persistent message. |
|
840 | + * @return void |
|
841 | + */ |
|
842 | 842 | public static function add_persistent_admin_notice( $pan_name = '', $pan_message, $force_update = FALSE ) { |
843 | 843 | if ( ! empty( $pan_name ) && ! empty( $pan_message )) { |
844 | 844 | $persistent_admin_notices = get_option( 'ee_pers_admin_notices', array() ); |
@@ -902,9 +902,9 @@ discard block |
||
902 | 902 | * display_persistent_admin_notices |
903 | 903 | * |
904 | 904 | * @access public |
905 | - * @param string $pan_name the name, or key of the Persistent Admin Notice to be stored |
|
906 | - * @param string $pan_name the message to be stored persistently until dismissed |
|
907 | - * @param string $return_url URL to go back to aftger nag notice is dismissed |
|
905 | + * @param string $pan_name the name, or key of the Persistent Admin Notice to be stored |
|
906 | + * @param string $pan_name the message to be stored persistently until dismissed |
|
907 | + * @param string $return_url URL to go back to aftger nag notice is dismissed |
|
908 | 908 | * @return string |
909 | 909 | */ |
910 | 910 | public static function display_persistent_admin_notices( $pan_name = '', $pan_message = '', $return_url = '' ) { |
@@ -993,11 +993,11 @@ discard block |
||
993 | 993 | |
994 | 994 | |
995 | 995 | /** |
996 | - * enqueue_error_scripts |
|
997 | - * |
|
998 | - * @access public |
|
999 | - * @return void |
|
1000 | - */ |
|
996 | + * enqueue_error_scripts |
|
997 | + * |
|
998 | + * @access public |
|
999 | + * @return void |
|
1000 | + */ |
|
1001 | 1001 | public static function enqueue_error_scripts() { |
1002 | 1002 | self::_print_scripts(); |
1003 | 1003 | } |
@@ -1005,15 +1005,15 @@ discard block |
||
1005 | 1005 | |
1006 | 1006 | |
1007 | 1007 | /** |
1008 | - * create error code from filepath, function name, |
|
1009 | - * and line number where exception or error was thrown |
|
1010 | - * |
|
1011 | - * @access public |
|
1012 | - * @ param string $file |
|
1013 | - * @ param string $func |
|
1014 | - * @ param string $line |
|
1015 | - * @ return string |
|
1016 | - */ |
|
1008 | + * create error code from filepath, function name, |
|
1009 | + * and line number where exception or error was thrown |
|
1010 | + * |
|
1011 | + * @access public |
|
1012 | + * @ param string $file |
|
1013 | + * @ param string $func |
|
1014 | + * @ param string $line |
|
1015 | + * @ return string |
|
1016 | + */ |
|
1017 | 1017 | public static function generate_error_code ( $file = '', $func = '', $line = '' ) { |
1018 | 1018 | $file = explode( '.', basename( $file )); |
1019 | 1019 | $error_code = ! empty( $file[0] ) ? $file[0] : ''; |
@@ -1027,13 +1027,13 @@ discard block |
||
1027 | 1027 | |
1028 | 1028 | |
1029 | 1029 | /** |
1030 | - * write exception details to log file |
|
1031 | - * |
|
1032 | - * @access public |
|
1033 | - * @ param timestamp $time |
|
1034 | - * @ param object $ex |
|
1035 | - * @ return void |
|
1036 | - */ |
|
1030 | + * write exception details to log file |
|
1031 | + * |
|
1032 | + * @access public |
|
1033 | + * @ param timestamp $time |
|
1034 | + * @ param object $ex |
|
1035 | + * @ return void |
|
1036 | + */ |
|
1037 | 1037 | public function write_to_error_log ( $time = FALSE, $ex = FALSE, $clear = FALSE ) { |
1038 | 1038 | |
1039 | 1039 | if ( ! $ex ) { |
@@ -184,7 +184,7 @@ |
||
184 | 184 | * returns TRUE if M-Mode is engaged and the current request is not for the admin |
185 | 185 | * |
186 | 186 | * @access public |
187 | - * @return string |
|
187 | + * @return boolean |
|
188 | 188 | */ |
189 | 189 | public static function disable_frontend_for_maintenance() { |
190 | 190 | return ! is_admin() && EE_Maintenance_Mode::instance()->level() ? TRUE : FALSE; |
@@ -48,10 +48,10 @@ |
||
48 | 48 | */ |
49 | 49 | const option_name_maintenance_mode = 'ee_maintenance_mode'; |
50 | 50 | /** |
51 | - * EE_Maintenance_Mode Object |
|
52 | - * @var EE_Maintenance_Mode $_instance |
|
53 | - * @access private |
|
54 | - */ |
|
51 | + * EE_Maintenance_Mode Object |
|
52 | + * @var EE_Maintenance_Mode $_instance |
|
53 | + * @access private |
|
54 | + */ |
|
55 | 55 | private static $_instance = NULL; |
56 | 56 | |
57 | 57 | /** |
@@ -141,7 +141,7 @@ discard block |
||
141 | 141 | current_user_can('administrator') && //when the user is an admin |
142 | 142 | $real_maintenance_mode_level == EE_Maintenance_Mode::level_1_frontend_only_maintenance){//and we're in level 1 |
143 | 143 | $maintenance_mode_level = EE_Maintenance_Mode::level_0_not_in_maintenance; |
144 | - }else{ |
|
144 | + } else{ |
|
145 | 145 | $maintenance_mode_level = $real_maintenance_mode_level; |
146 | 146 | } |
147 | 147 | return $maintenance_mode_level; |
@@ -156,12 +156,12 @@ discard block |
||
156 | 156 | if( EE_Data_Migration_Manager::instance()->check_for_applicable_data_migration_scripts()){ |
157 | 157 | update_option(self::option_name_maintenance_mode, self::level_2_complete_maintenance); |
158 | 158 | return true; |
159 | - }elseif( $this->level() == self::level_2_complete_maintenance ){ |
|
159 | + } elseif( $this->level() == self::level_2_complete_maintenance ){ |
|
160 | 160 | //we also want to handle the opposite: if the site is mm2, but there aren't any migrations to run |
161 | 161 | //then we shouldn't be in mm2. (Maybe an addon got deactivated?) |
162 | 162 | update_option( self::option_name_maintenance_mode, self::level_0_not_in_maintenance ); |
163 | 163 | return false; |
164 | - }else{ |
|
164 | + } else{ |
|
165 | 165 | return false; |
166 | 166 | } |
167 | 167 | } |
@@ -1,5 +1,5 @@ discard block |
||
1 | 1 | <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) { exit('No direct script access allowed'); } |
2 | -do_action( 'AHEE_log', __FILE__, ' FILE LOADED', '' ); |
|
2 | +do_action('AHEE_log', __FILE__, ' FILE LOADED', ''); |
|
3 | 3 | /** |
4 | 4 | * |
5 | 5 | * Event Espresso |
@@ -74,7 +74,7 @@ discard block |
||
74 | 74 | */ |
75 | 75 | public static function instance() { |
76 | 76 | // check if class object is instantiated |
77 | - if ( self::$_instance === NULL or ! is_object( self::$_instance ) or ! ( self::$_instance instanceof EE_Maintenance_Mode )) { |
|
77 | + if (self::$_instance === NULL or ! is_object(self::$_instance) or ! (self::$_instance instanceof EE_Maintenance_Mode)) { |
|
78 | 78 | self::$_instance = new self(); |
79 | 79 | } |
80 | 80 | return self::$_instance; |
@@ -84,7 +84,7 @@ discard block |
||
84 | 84 | * Resets maintenance mode (mostly just re-checks whether or not we should be in maintenance mode) |
85 | 85 | * @return EE_Maintenance_Mode |
86 | 86 | */ |
87 | - public static function reset(){ |
|
87 | + public static function reset() { |
|
88 | 88 | self::instance()->set_maintenance_mode_if_db_old(); |
89 | 89 | return self::instance(); |
90 | 90 | } |
@@ -98,13 +98,13 @@ discard block |
||
98 | 98 | *@return EE_Maintenance_Mode |
99 | 99 | */ |
100 | 100 | private function __construct() { |
101 | - do_action( 'AHEE_log', __CLASS__, __FUNCTION__ ); |
|
101 | + do_action('AHEE_log', __CLASS__, __FUNCTION__); |
|
102 | 102 | // if M-Mode level 2 is engaged, we still need basic assets loaded |
103 | - add_action( 'wp_enqueue_scripts', array( $this, 'load_assets_required_for_m_mode' )); |
|
103 | + add_action('wp_enqueue_scripts', array($this, 'load_assets_required_for_m_mode')); |
|
104 | 104 | // shut 'er down down for maintenance ? |
105 | - add_filter( 'the_content', array( $this, 'the_content' ), 999 ); |
|
105 | + add_filter('the_content', array($this, 'the_content'), 999); |
|
106 | 106 | // add powered by EE msg |
107 | - add_action( 'shutdown', array( $this, 'display_maintenance_mode_notice' ), 10 ); |
|
107 | + add_action('shutdown', array($this, 'display_maintenance_mode_notice'), 10); |
|
108 | 108 | } |
109 | 109 | |
110 | 110 | |
@@ -114,8 +114,8 @@ discard block |
||
114 | 114 | * retrieves the maintenance mode option value from the db |
115 | 115 | * @return int |
116 | 116 | */ |
117 | - public function real_level(){ |
|
118 | - return get_option( self::option_name_maintenance_mode, EE_Maintenance_Mode::level_0_not_in_maintenance ); |
|
117 | + public function real_level() { |
|
118 | + return get_option(self::option_name_maintenance_mode, EE_Maintenance_Mode::level_0_not_in_maintenance); |
|
119 | 119 | } |
120 | 120 | |
121 | 121 | /** |
@@ -123,7 +123,7 @@ discard block |
||
123 | 123 | * thinks their tables are present and up-to-date). |
124 | 124 | * @return boolean |
125 | 125 | */ |
126 | - public function models_can_query(){ |
|
126 | + public function models_can_query() { |
|
127 | 127 | return $this->real_level() != EE_Maintenance_Mode::level_2_complete_maintenance; |
128 | 128 | } |
129 | 129 | |
@@ -136,14 +136,14 @@ discard block |
||
136 | 136 | * EE_Maintenance_Mode::level_2_complete_maintenance => frontend and backend maintenance mode |
137 | 137 | * @return int |
138 | 138 | */ |
139 | - public function level(){ |
|
139 | + public function level() { |
|
140 | 140 | $real_maintenance_mode_level = $this->real_level(); |
141 | 141 | //if this is an admin request, we'll be honest... except if it's ajax, because that might be from the frontend |
142 | - if( ( ! is_admin() || (defined('DOING_AJAX') && DOING_AJAX)) && //only on frontend or ajax requests |
|
142 | + if (( ! is_admin() || (defined('DOING_AJAX') && DOING_AJAX)) && //only on frontend or ajax requests |
|
143 | 143 | current_user_can('administrator') && //when the user is an admin |
144 | - $real_maintenance_mode_level == EE_Maintenance_Mode::level_1_frontend_only_maintenance){//and we're in level 1 |
|
144 | + $real_maintenance_mode_level == EE_Maintenance_Mode::level_1_frontend_only_maintenance) {//and we're in level 1 |
|
145 | 145 | $maintenance_mode_level = EE_Maintenance_Mode::level_0_not_in_maintenance; |
146 | - }else{ |
|
146 | + } else { |
|
147 | 147 | $maintenance_mode_level = $real_maintenance_mode_level; |
148 | 148 | } |
149 | 149 | return $maintenance_mode_level; |
@@ -153,17 +153,17 @@ discard block |
||
153 | 153 | * Determines if we need to put EE in maintenance mode because the database needs updating |
154 | 154 | * @return boolean true if DB is old and maintenance mode was triggered; false otherwise |
155 | 155 | */ |
156 | - public function set_maintenance_mode_if_db_old(){ |
|
157 | - EE_Registry::instance()->load_core( 'Data_Migration_Manager' ); |
|
158 | - if( EE_Data_Migration_Manager::instance()->check_for_applicable_data_migration_scripts()){ |
|
156 | + public function set_maintenance_mode_if_db_old() { |
|
157 | + EE_Registry::instance()->load_core('Data_Migration_Manager'); |
|
158 | + if (EE_Data_Migration_Manager::instance()->check_for_applicable_data_migration_scripts()) { |
|
159 | 159 | update_option(self::option_name_maintenance_mode, self::level_2_complete_maintenance); |
160 | 160 | return true; |
161 | - }elseif( $this->level() == self::level_2_complete_maintenance ){ |
|
161 | + }elseif ($this->level() == self::level_2_complete_maintenance) { |
|
162 | 162 | //we also want to handle the opposite: if the site is mm2, but there aren't any migrations to run |
163 | 163 | //then we shouldn't be in mm2. (Maybe an addon got deactivated?) |
164 | - update_option( self::option_name_maintenance_mode, self::level_0_not_in_maintenance ); |
|
164 | + update_option(self::option_name_maintenance_mode, self::level_0_not_in_maintenance); |
|
165 | 165 | return false; |
166 | - }else{ |
|
166 | + } else { |
|
167 | 167 | return false; |
168 | 168 | } |
169 | 169 | } |
@@ -173,8 +173,8 @@ discard block |
||
173 | 173 | * @param int $level |
174 | 174 | * @return void |
175 | 175 | */ |
176 | - public function set_maintenance_level($level){ |
|
177 | - do_action( 'AHEE__EE_Maintenance_Mode__set_maintenance_level', $level ); |
|
176 | + public function set_maintenance_level($level) { |
|
177 | + do_action('AHEE__EE_Maintenance_Mode__set_maintenance_level', $level); |
|
178 | 178 | update_option(self::option_name_maintenance_mode, intval($level)); |
179 | 179 | } |
180 | 180 | |
@@ -201,11 +201,11 @@ discard block |
||
201 | 201 | * @return string |
202 | 202 | */ |
203 | 203 | public function load_assets_required_for_m_mode() { |
204 | - if ( $this->real_level() == EE_Maintenance_Mode::level_2_complete_maintenance && ! wp_script_is( 'espresso_core', 'enqueued' )) { |
|
205 | - wp_register_style( 'espresso_default', EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css', array( 'dashicons' ), EVENT_ESPRESSO_VERSION ); |
|
204 | + if ($this->real_level() == EE_Maintenance_Mode::level_2_complete_maintenance && ! wp_script_is('espresso_core', 'enqueued')) { |
|
205 | + wp_register_style('espresso_default', EE_GLOBAL_ASSETS_URL.'css/espresso_default.css', array('dashicons'), EVENT_ESPRESSO_VERSION); |
|
206 | 206 | wp_enqueue_style('espresso_default'); |
207 | - wp_register_script( 'espresso_core', EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js', array('jquery'), EVENT_ESPRESSO_VERSION, TRUE ); |
|
208 | - wp_enqueue_script( 'espresso_core' ); |
|
207 | + wp_register_script('espresso_core', EE_GLOBAL_ASSETS_URL.'scripts/espresso_core.js', array('jquery'), EVENT_ESPRESSO_VERSION, TRUE); |
|
208 | + wp_enqueue_script('espresso_core'); |
|
209 | 209 | } |
210 | 210 | } |
211 | 211 | |
@@ -220,9 +220,9 @@ discard block |
||
220 | 220 | * @param string $template_path |
221 | 221 | * @return string |
222 | 222 | */ |
223 | - public static function template_include( $template_path ) { |
|
224 | - EE_Registry::instance()->load_helper( 'Template' ); |
|
225 | - $template_located = EEH_Template::locate_template( EE_TEMPLATES . 'maintenance_mode.template.php', FALSE, FALSE ); |
|
223 | + public static function template_include($template_path) { |
|
224 | + EE_Registry::instance()->load_helper('Template'); |
|
225 | + $template_located = EEH_Template::locate_template(EE_TEMPLATES.'maintenance_mode.template.php', FALSE, FALSE); |
|
226 | 226 | return $template_located ? $template_located : $template_path; |
227 | 227 | } |
228 | 228 | |
@@ -237,12 +237,12 @@ discard block |
||
237 | 237 | * @param string $the_content |
238 | 238 | * @return string |
239 | 239 | */ |
240 | - public function the_content( $the_content ) { |
|
240 | + public function the_content($the_content) { |
|
241 | 241 | // check if M-mode is engaged and for EE shortcode |
242 | - if ( $this->level() && strpos( $the_content, '[ESPRESSO_' )) { |
|
242 | + if ($this->level() && strpos($the_content, '[ESPRESSO_')) { |
|
243 | 243 | // this can eventually be moved to a template, or edited via admin. But for now... |
244 | 244 | $the_content = sprintf( |
245 | - __( '%sMaintenance Mode%sEvent Registration has been temporarily closed while system maintenance is being performed. We\'re sorry for any inconveniences this may have caused. Please try back again later.%s', 'event_espresso' ), |
|
245 | + __('%sMaintenance Mode%sEvent Registration has been temporarily closed while system maintenance is being performed. We\'re sorry for any inconveniences this may have caused. Please try back again later.%s', 'event_espresso'), |
|
246 | 246 | '<h2>', |
247 | 247 | '</h2><p>', |
248 | 248 | '</p>' |
@@ -264,13 +264,13 @@ discard block |
||
264 | 264 | */ |
265 | 265 | public function display_maintenance_mode_notice() { |
266 | 266 | // check if M-mode is engaged and for EE shortcode |
267 | - if ( $this->real_level() && current_user_can( 'administrator' ) && ! is_admin() && ! ( defined( 'DOING_AJAX' ) && DOING_AJAX )) { |
|
267 | + if ($this->real_level() && current_user_can('administrator') && ! is_admin() && ! (defined('DOING_AJAX') && DOING_AJAX)) { |
|
268 | 268 | $admin_bar_adjustment = is_admin_bar_showing() ? ' style="top:32px;"' : ''; |
269 | 269 | printf( |
270 | - __( '%sclose%sEvent Registration is currently disabled because Event Espresso has been placed into Maintenance Mode. To change Maintenance Mode settings, click here %sEE Maintenance Mode Admin Page%s', 'event_espresso' ), |
|
271 | - '<div id="ee-m-mode-admin-notice-dv" class="ee-really-important-notice-dv"' . $admin_bar_adjustment . '><a class="close-espresso-notice" title="', |
|
270 | + __('%sclose%sEvent Registration is currently disabled because Event Espresso has been placed into Maintenance Mode. To change Maintenance Mode settings, click here %sEE Maintenance Mode Admin Page%s', 'event_espresso'), |
|
271 | + '<div id="ee-m-mode-admin-notice-dv" class="ee-really-important-notice-dv"'.$admin_bar_adjustment.'><a class="close-espresso-notice" title="', |
|
272 | 272 | '">×</a><p>', |
273 | - ' » <a href="' . add_query_arg( array( 'page' => 'espresso_maintenance_settings' ), admin_url( 'admin.php' )) . '">', |
|
273 | + ' » <a href="'.add_query_arg(array('page' => 'espresso_maintenance_settings'), admin_url('admin.php')).'">', |
|
274 | 274 | '</a></p></div>' |
275 | 275 | ); |
276 | 276 | } |
@@ -288,9 +288,9 @@ discard block |
||
288 | 288 | * @ return void |
289 | 289 | */ |
290 | 290 | final function __destruct() {} |
291 | - final function __call($a,$b) {} |
|
291 | + final function __call($a, $b) {} |
|
292 | 292 | final function __get($a) {} |
293 | - final function __set($a,$b) {} |
|
293 | + final function __set($a, $b) {} |
|
294 | 294 | final function __isset($a) {} |
295 | 295 | final function __unset($a) {} |
296 | 296 | final function __sleep() { |
@@ -301,7 +301,7 @@ discard block |
||
301 | 301 | final function __invoke() {} |
302 | 302 | final function __set_state() {} |
303 | 303 | final function __clone() {} |
304 | - final static function __callStatic($a,$b) {} |
|
304 | + final static function __callStatic($a, $b) {} |
|
305 | 305 | |
306 | 306 | } |
307 | 307 | // End of file EE_Maintenance_Mode.core.php |