@@ -26,7 +26,7 @@ |
||
26 | 26 | * just checks the field isn't blank |
27 | 27 | * |
28 | 28 | * @param $normalized_value |
29 | - * @return bool |
|
29 | + * @return boolean|null |
|
30 | 30 | * @throws \EE_Validation_Error |
31 | 31 | */ |
32 | 32 | function validate($normalized_value) { |
@@ -11,8 +11,8 @@ discard block |
||
11 | 11 | class EE_Email_Validation_Strategy extends EE_Text_Validation_Strategy{ |
12 | 12 | |
13 | 13 | /** |
14 | - * @param null $validation_error_message |
|
15 | - */ |
|
14 | + * @param null $validation_error_message |
|
15 | + */ |
|
16 | 16 | public function __construct( $validation_error_message = NULL ) { |
17 | 17 | if( ! $validation_error_message ){ |
18 | 18 | $validation_error_message = __("Please enter a valid email address.", "event_espresso"); |
@@ -38,8 +38,8 @@ discard block |
||
38 | 38 | |
39 | 39 | |
40 | 40 | /** |
41 | - * @return array |
|
42 | - */ |
|
41 | + * @return array |
|
42 | + */ |
|
43 | 43 | function get_jquery_validation_rule_array(){ |
44 | 44 | return array( 'email'=>true, 'messages' => array( 'email' => $this->get_validation_error_message() ) ); |
45 | 45 | } |
@@ -59,56 +59,56 @@ discard block |
||
59 | 59 | $atIndex = strrpos($email, "@"); |
60 | 60 | if (is_bool($atIndex) && !$atIndex) |
61 | 61 | { |
62 | - $isValid = false; |
|
62 | + $isValid = false; |
|
63 | 63 | } |
64 | 64 | else |
65 | 65 | { |
66 | - $domain = substr($email, $atIndex+1); |
|
67 | - $local = substr($email, 0, $atIndex); |
|
68 | - $localLen = strlen($local); |
|
69 | - $domainLen = strlen($domain); |
|
70 | - if ($localLen < 1 || $localLen > 64) |
|
71 | - { |
|
72 | - // local part length exceeded |
|
73 | - $isValid = false; |
|
74 | - } |
|
75 | - else if ($domainLen < 1 || $domainLen > 255) |
|
76 | - { |
|
77 | - // domain part length exceeded |
|
78 | - $isValid = false; |
|
79 | - } |
|
80 | - else if ($local[0] == '.' || $local[$localLen-1] == '.') |
|
81 | - { |
|
82 | - // local part starts or ends with '.' |
|
83 | - $isValid = false; |
|
84 | - } |
|
85 | - else if (preg_match('/\\.\\./', $local)) |
|
86 | - { |
|
87 | - // local part has two consecutive dots |
|
88 | - $isValid = false; |
|
89 | - } |
|
90 | - else if (!preg_match('/^[A-Za-z0-9\\-\\.]+$/', $domain)) |
|
91 | - { |
|
92 | - // character not valid in domain part |
|
93 | - $isValid = false; |
|
94 | - } |
|
95 | - else if (preg_match('/\\.\\./', $domain)) |
|
96 | - { |
|
97 | - // domain part has two consecutive dots |
|
98 | - $isValid = false; |
|
99 | - } |
|
100 | - else if |
|
66 | + $domain = substr($email, $atIndex+1); |
|
67 | + $local = substr($email, 0, $atIndex); |
|
68 | + $localLen = strlen($local); |
|
69 | + $domainLen = strlen($domain); |
|
70 | + if ($localLen < 1 || $localLen > 64) |
|
71 | + { |
|
72 | + // local part length exceeded |
|
73 | + $isValid = false; |
|
74 | + } |
|
75 | + else if ($domainLen < 1 || $domainLen > 255) |
|
76 | + { |
|
77 | + // domain part length exceeded |
|
78 | + $isValid = false; |
|
79 | + } |
|
80 | + else if ($local[0] == '.' || $local[$localLen-1] == '.') |
|
81 | + { |
|
82 | + // local part starts or ends with '.' |
|
83 | + $isValid = false; |
|
84 | + } |
|
85 | + else if (preg_match('/\\.\\./', $local)) |
|
86 | + { |
|
87 | + // local part has two consecutive dots |
|
88 | + $isValid = false; |
|
89 | + } |
|
90 | + else if (!preg_match('/^[A-Za-z0-9\\-\\.]+$/', $domain)) |
|
91 | + { |
|
92 | + // character not valid in domain part |
|
93 | + $isValid = false; |
|
94 | + } |
|
95 | + else if (preg_match('/\\.\\./', $domain)) |
|
96 | + { |
|
97 | + // domain part has two consecutive dots |
|
98 | + $isValid = false; |
|
99 | + } |
|
100 | + else if |
|
101 | 101 | (!preg_match('/^(\\\\.|[A-Za-z0-9!#%&`_=\\/$\'*+?^{}|~.-])+$/', |
102 | - str_replace("\\\\","",$local))) |
|
103 | - { |
|
104 | - // character not valid in local part unless |
|
105 | - // local part is quoted |
|
106 | - if (!preg_match('/^"(\\\\"|[^"])+"$/', |
|
107 | - str_replace("\\\\","",$local))) |
|
108 | - { |
|
109 | - $isValid = false; |
|
110 | - } |
|
111 | - } |
|
102 | + str_replace("\\\\","",$local))) |
|
103 | + { |
|
104 | + // character not valid in local part unless |
|
105 | + // local part is quoted |
|
106 | + if (!preg_match('/^"(\\\\"|[^"])+"$/', |
|
107 | + str_replace("\\\\","",$local))) |
|
108 | + { |
|
109 | + $isValid = false; |
|
110 | + } |
|
111 | + } |
|
112 | 112 | //don't check the DNS records... just personal preference |
113 | 113 | // if ($isValid && !(checkdnsrr($domain,"MX") || checkdnsrr($domain,"A"))) |
114 | 114 | // { |
@@ -8,16 +8,16 @@ discard block |
||
8 | 8 | * @since 4.6 |
9 | 9 | * |
10 | 10 | */ |
11 | -class EE_Email_Validation_Strategy extends EE_Text_Validation_Strategy{ |
|
11 | +class EE_Email_Validation_Strategy extends EE_Text_Validation_Strategy { |
|
12 | 12 | |
13 | 13 | /** |
14 | 14 | * @param null $validation_error_message |
15 | 15 | */ |
16 | - public function __construct( $validation_error_message = NULL ) { |
|
17 | - if( ! $validation_error_message ){ |
|
16 | + public function __construct($validation_error_message = NULL) { |
|
17 | + if ( ! $validation_error_message) { |
|
18 | 18 | $validation_error_message = __("Please enter a valid email address.", "event_espresso"); |
19 | 19 | } |
20 | - parent::__construct( $validation_error_message ); |
|
20 | + parent::__construct($validation_error_message); |
|
21 | 21 | } |
22 | 22 | |
23 | 23 | |
@@ -30,8 +30,8 @@ discard block |
||
30 | 30 | * @throws \EE_Validation_Error |
31 | 31 | */ |
32 | 32 | function validate($normalized_value) { |
33 | - if( $normalized_value && ! $this->_validate_email($normalized_value) ){ |
|
34 | - throw new EE_Validation_Error( $this->get_validation_error_message(), 'required'); |
|
33 | + if ($normalized_value && ! $this->_validate_email($normalized_value)) { |
|
34 | + throw new EE_Validation_Error($this->get_validation_error_message(), 'required'); |
|
35 | 35 | } |
36 | 36 | } |
37 | 37 | |
@@ -40,8 +40,8 @@ discard block |
||
40 | 40 | /** |
41 | 41 | * @return array |
42 | 42 | */ |
43 | - function get_jquery_validation_rule_array(){ |
|
44 | - return array( 'email'=>true, 'messages' => array( 'email' => $this->get_validation_error_message() ) ); |
|
43 | + function get_jquery_validation_rule_array() { |
|
44 | + return array('email'=>true, 'messages' => array('email' => $this->get_validation_error_message())); |
|
45 | 45 | } |
46 | 46 | |
47 | 47 | |
@@ -57,13 +57,13 @@ discard block |
||
57 | 57 | { |
58 | 58 | $isValid = true; |
59 | 59 | $atIndex = strrpos($email, "@"); |
60 | - if (is_bool($atIndex) && !$atIndex) |
|
60 | + if (is_bool($atIndex) && ! $atIndex) |
|
61 | 61 | { |
62 | 62 | $isValid = false; |
63 | 63 | } |
64 | 64 | else |
65 | 65 | { |
66 | - $domain = substr($email, $atIndex+1); |
|
66 | + $domain = substr($email, $atIndex + 1); |
|
67 | 67 | $local = substr($email, 0, $atIndex); |
68 | 68 | $localLen = strlen($local); |
69 | 69 | $domainLen = strlen($domain); |
@@ -77,7 +77,7 @@ discard block |
||
77 | 77 | // domain part length exceeded |
78 | 78 | $isValid = false; |
79 | 79 | } |
80 | - else if ($local[0] == '.' || $local[$localLen-1] == '.') |
|
80 | + else if ($local[0] == '.' || $local[$localLen - 1] == '.') |
|
81 | 81 | { |
82 | 82 | // local part starts or ends with '.' |
83 | 83 | $isValid = false; |
@@ -87,7 +87,7 @@ discard block |
||
87 | 87 | // local part has two consecutive dots |
88 | 88 | $isValid = false; |
89 | 89 | } |
90 | - else if (!preg_match('/^[A-Za-z0-9\\-\\.]+$/', $domain)) |
|
90 | + else if ( ! preg_match('/^[A-Za-z0-9\\-\\.]+$/', $domain)) |
|
91 | 91 | { |
92 | 92 | // character not valid in domain part |
93 | 93 | $isValid = false; |
@@ -97,14 +97,13 @@ discard block |
||
97 | 97 | // domain part has two consecutive dots |
98 | 98 | $isValid = false; |
99 | 99 | } |
100 | - else if |
|
101 | -(!preg_match('/^(\\\\.|[A-Za-z0-9!#%&`_=\\/$\'*+?^{}|~.-])+$/', |
|
102 | - str_replace("\\\\","",$local))) |
|
100 | + else if ( ! preg_match('/^(\\\\.|[A-Za-z0-9!#%&`_=\\/$\'*+?^{}|~.-])+$/', |
|
101 | + str_replace("\\\\", "", $local))) |
|
103 | 102 | { |
104 | 103 | // character not valid in local part unless |
105 | 104 | // local part is quoted |
106 | - if (!preg_match('/^"(\\\\"|[^"])+"$/', |
|
107 | - str_replace("\\\\","",$local))) |
|
105 | + if ( ! preg_match('/^"(\\\\"|[^"])+"$/', |
|
106 | + str_replace("\\\\", "", $local))) |
|
108 | 107 | { |
109 | 108 | $isValid = false; |
110 | 109 | } |
@@ -60,8 +60,7 @@ discard block |
||
60 | 60 | if (is_bool($atIndex) && !$atIndex) |
61 | 61 | { |
62 | 62 | $isValid = false; |
63 | - } |
|
64 | - else |
|
63 | + } else |
|
65 | 64 | { |
66 | 65 | $domain = substr($email, $atIndex+1); |
67 | 66 | $local = substr($email, 0, $atIndex); |
@@ -71,33 +70,27 @@ discard block |
||
71 | 70 | { |
72 | 71 | // local part length exceeded |
73 | 72 | $isValid = false; |
74 | - } |
|
75 | - else if ($domainLen < 1 || $domainLen > 255) |
|
73 | + } else if ($domainLen < 1 || $domainLen > 255) |
|
76 | 74 | { |
77 | 75 | // domain part length exceeded |
78 | 76 | $isValid = false; |
79 | - } |
|
80 | - else if ($local[0] == '.' || $local[$localLen-1] == '.') |
|
77 | + } else if ($local[0] == '.' || $local[$localLen-1] == '.') |
|
81 | 78 | { |
82 | 79 | // local part starts or ends with '.' |
83 | 80 | $isValid = false; |
84 | - } |
|
85 | - else if (preg_match('/\\.\\./', $local)) |
|
81 | + } else if (preg_match('/\\.\\./', $local)) |
|
86 | 82 | { |
87 | 83 | // local part has two consecutive dots |
88 | 84 | $isValid = false; |
89 | - } |
|
90 | - else if (!preg_match('/^[A-Za-z0-9\\-\\.]+$/', $domain)) |
|
85 | + } else if (!preg_match('/^[A-Za-z0-9\\-\\.]+$/', $domain)) |
|
91 | 86 | { |
92 | 87 | // character not valid in domain part |
93 | 88 | $isValid = false; |
94 | - } |
|
95 | - else if (preg_match('/\\.\\./', $domain)) |
|
89 | + } else if (preg_match('/\\.\\./', $domain)) |
|
96 | 90 | { |
97 | 91 | // domain part has two consecutive dots |
98 | 92 | $isValid = false; |
99 | - } |
|
100 | - else if |
|
93 | + } else if |
|
101 | 94 | (!preg_match('/^(\\\\.|[A-Za-z0-9!#%&`_=\\/$\'*+?^{}|~.-])+$/', |
102 | 95 | str_replace("\\\\","",$local))) |
103 | 96 | { |
@@ -25,7 +25,7 @@ |
||
25 | 25 | /** |
26 | 26 | * |
27 | 27 | * @param $normalized_value |
28 | - * @return bool |
|
28 | + * @return boolean|null |
|
29 | 29 | */ |
30 | 30 | function validate($normalized_value) { |
31 | 31 | //errors should have been detected by the normalization strategy |
@@ -8,16 +8,16 @@ discard block |
||
8 | 8 | * @since 4.6 |
9 | 9 | * |
10 | 10 | */ |
11 | -class EE_Float_Validation_Strategy extends EE_Validation_Strategy_Base{ |
|
11 | +class EE_Float_Validation_Strategy extends EE_Validation_Strategy_Base { |
|
12 | 12 | |
13 | 13 | /** |
14 | 14 | * @param null $validation_error_message |
15 | 15 | */ |
16 | - public function __construct( $validation_error_message = NULL ) { |
|
17 | - if( ! $validation_error_message ){ |
|
16 | + public function __construct($validation_error_message = NULL) { |
|
17 | + if ( ! $validation_error_message) { |
|
18 | 18 | $validation_error_message = sprintf(__("Only numeric characters, commas, periods, and spaces, please!", "event_espresso")); |
19 | 19 | } |
20 | - parent::__construct( $validation_error_message ); |
|
20 | + parent::__construct($validation_error_message); |
|
21 | 21 | } |
22 | 22 | |
23 | 23 | |
@@ -36,8 +36,8 @@ discard block |
||
36 | 36 | /** |
37 | 37 | * @return array |
38 | 38 | */ |
39 | - function get_jquery_validation_rule_array(){ |
|
40 | - return array('number'=>true, 'messages' => array( 'number' => $this->get_validation_error_message() ) ); |
|
39 | + function get_jquery_validation_rule_array() { |
|
40 | + return array('number'=>true, 'messages' => array('number' => $this->get_validation_error_message())); |
|
41 | 41 | } |
42 | 42 | } |
43 | 43 |
@@ -27,7 +27,7 @@ |
||
27 | 27 | /** |
28 | 28 | * Applies all teh individual item validation strategies on each item in the array |
29 | 29 | * @param array $normalized_value |
30 | - * @return boolean |
|
30 | + * @return boolean|null |
|
31 | 31 | */ |
32 | 32 | function validate($normalized_value) { |
33 | 33 | if( is_array($normalized_value)){ |
@@ -11,14 +11,14 @@ discard block |
||
11 | 11 | * @since 4.6 |
12 | 12 | * |
13 | 13 | */ |
14 | -class EE_Many_Valued_Validation_Strategy extends EE_Validation_Strategy_Base{ |
|
14 | +class EE_Many_Valued_Validation_Strategy extends EE_Validation_Strategy_Base { |
|
15 | 15 | protected $_individual_item_validation_strategies = array(); |
16 | 16 | /** |
17 | 17 | * |
18 | 18 | * @param EE_Validation_Strategy_Base[] $individual_item_validation_strategies (or a single EE_Validation_Strategy_Base) |
19 | 19 | */ |
20 | 20 | public function __construct($individual_item_validation_strategies) { |
21 | - if( ! is_array($individual_item_validation_strategies)){ |
|
21 | + if ( ! is_array($individual_item_validation_strategies)) { |
|
22 | 22 | $individual_item_validation_strategies = array($individual_item_validation_strategies); |
23 | 23 | } |
24 | 24 | $this->_individual_item_validation_strategies = $individual_item_validation_strategies; |
@@ -30,14 +30,14 @@ discard block |
||
30 | 30 | * @return boolean |
31 | 31 | */ |
32 | 32 | function validate($normalized_value) { |
33 | - if( is_array($normalized_value)){ |
|
33 | + if (is_array($normalized_value)) { |
|
34 | 34 | $items_to_validate = $normalized_value; |
35 | - }else{ |
|
35 | + } else { |
|
36 | 36 | $items_to_validate = array($normalized_value); |
37 | 37 | } |
38 | - foreach($items_to_validate as $individual_item){ |
|
39 | - foreach($this->_individual_item_validation_strategies as $validation_strategy){ |
|
40 | - if ( $validation_strategy instanceof EE_Validation_Strategy_Base ) { |
|
38 | + foreach ($items_to_validate as $individual_item) { |
|
39 | + foreach ($this->_individual_item_validation_strategies as $validation_strategy) { |
|
40 | + if ($validation_strategy instanceof EE_Validation_Strategy_Base) { |
|
41 | 41 | $validation_strategy->validate($individual_item); |
42 | 42 | } |
43 | 43 | } |
@@ -50,8 +50,8 @@ discard block |
||
50 | 50 | */ |
51 | 51 | function _construct_finalize(\EE_Form_Input_Base $form_input) { |
52 | 52 | parent::_construct_finalize($form_input); |
53 | - foreach($this->_individual_item_validation_strategies as $item_validation_strategy){ |
|
54 | - if ( $item_validation_strategy instanceof EE_Validation_Strategy_Base ) { |
|
53 | + foreach ($this->_individual_item_validation_strategies as $item_validation_strategy) { |
|
54 | + if ($item_validation_strategy instanceof EE_Validation_Strategy_Base) { |
|
55 | 55 | $item_validation_strategy->_construct_finalize($form_input); |
56 | 56 | } |
57 | 57 | } |
@@ -32,7 +32,7 @@ |
||
32 | 32 | function validate($normalized_value) { |
33 | 33 | if( is_array($normalized_value)){ |
34 | 34 | $items_to_validate = $normalized_value; |
35 | - }else{ |
|
35 | + } else{ |
|
36 | 36 | $items_to_validate = array($normalized_value); |
37 | 37 | } |
38 | 38 | foreach($items_to_validate as $individual_item){ |
@@ -10,6 +10,10 @@ |
||
10 | 10 | class EE_Text_Validation_Strategy extends EE_Validation_Strategy_Base{ |
11 | 11 | |
12 | 12 | protected $_regex = null; |
13 | + |
|
14 | + /** |
|
15 | + * @param string $regex |
|
16 | + */ |
|
13 | 17 | public function __construct( $validation_error_message = NULL, $regex = null ) { |
14 | 18 | $this->_regex = $regex; |
15 | 19 | parent::__construct( $validation_error_message ); |
@@ -7,21 +7,21 @@ discard block |
||
7 | 7 | * @subpackage Expression package is undefined on line 19, column 19 in Templates/Scripting/PHPClass.php. |
8 | 8 | * @author Mike Nelson |
9 | 9 | */ |
10 | -class EE_Text_Validation_Strategy extends EE_Validation_Strategy_Base{ |
|
10 | +class EE_Text_Validation_Strategy extends EE_Validation_Strategy_Base { |
|
11 | 11 | |
12 | 12 | protected $_regex = null; |
13 | - public function __construct( $validation_error_message = NULL, $regex = null ) { |
|
13 | + public function __construct($validation_error_message = NULL, $regex = null) { |
|
14 | 14 | $this->_regex = $regex; |
15 | - parent::__construct( $validation_error_message ); |
|
15 | + parent::__construct($validation_error_message); |
|
16 | 16 | } |
17 | 17 | |
18 | 18 | /** |
19 | 19 | * @param $normalized_value |
20 | 20 | */ |
21 | 21 | public function validate($normalized_value) { |
22 | - if( $this->_regex && $normalized_value) { |
|
23 | - if( ! preg_match( $this->_regex, $normalized_value ) ) { |
|
24 | - throw new EE_Validation_Error( $this->get_validation_error_message(), 'regex' ); |
|
22 | + if ($this->_regex && $normalized_value) { |
|
23 | + if ( ! preg_match($this->_regex, $normalized_value)) { |
|
24 | + throw new EE_Validation_Error($this->get_validation_error_message(), 'regex'); |
|
25 | 25 | } |
26 | 26 | } |
27 | 27 | } |
@@ -29,10 +29,10 @@ discard block |
||
29 | 29 | /** |
30 | 30 | * @return array |
31 | 31 | */ |
32 | - function get_jquery_validation_rule_array(){ |
|
33 | - if( $this->_regex !== null ){ |
|
34 | - return array( 'regex'=> $this->regex_js(), 'messages' => array( 'regex' => $this->get_validation_error_message() ) ); |
|
35 | - }else{ |
|
32 | + function get_jquery_validation_rule_array() { |
|
33 | + if ($this->_regex !== null) { |
|
34 | + return array('regex'=> $this->regex_js(), 'messages' => array('regex' => $this->get_validation_error_message())); |
|
35 | + } else { |
|
36 | 36 | return array(); |
37 | 37 | } |
38 | 38 | |
@@ -46,8 +46,8 @@ discard block |
||
46 | 46 | function regex_js() { |
47 | 47 | //first character must be the delimiter |
48 | 48 | $delimeter = $this->_regex[0]; |
49 | - $last_occurence_of_delimieter = strrpos($this->_regex, $delimeter ); |
|
50 | - return substr( $this->_regex, 1, $last_occurence_of_delimieter - 1 ); |
|
49 | + $last_occurence_of_delimieter = strrpos($this->_regex, $delimeter); |
|
50 | + return substr($this->_regex, 1, $last_occurence_of_delimieter - 1); |
|
51 | 51 | } |
52 | 52 | } |
53 | 53 |
@@ -32,7 +32,7 @@ |
||
32 | 32 | function get_jquery_validation_rule_array(){ |
33 | 33 | if( $this->_regex !== null ){ |
34 | 34 | return array( 'regex'=> $this->regex_js(), 'messages' => array( 'regex' => $this->get_validation_error_message() ) ); |
35 | - }else{ |
|
35 | + } else{ |
|
36 | 36 | return array(); |
37 | 37 | } |
38 | 38 |
@@ -26,7 +26,7 @@ |
||
26 | 26 | * just checks the field isn't blank |
27 | 27 | * |
28 | 28 | * @param $normalized_value |
29 | - * @return bool |
|
29 | + * @return boolean|null |
|
30 | 30 | * @throws \EE_Validation_Error |
31 | 31 | */ |
32 | 32 | function validate($normalized_value) { |
@@ -8,16 +8,16 @@ discard block |
||
8 | 8 | * @since 4.6 |
9 | 9 | * |
10 | 10 | */ |
11 | -class EE_URL_Validation_Strategy extends EE_Validation_Strategy_Base{ |
|
11 | +class EE_URL_Validation_Strategy extends EE_Validation_Strategy_Base { |
|
12 | 12 | |
13 | 13 | /** |
14 | 14 | * @param null $validation_error_message |
15 | 15 | */ |
16 | - public function __construct( $validation_error_message = NULL ) { |
|
17 | - if( ! $validation_error_message ){ |
|
16 | + public function __construct($validation_error_message = NULL) { |
|
17 | + if ( ! $validation_error_message) { |
|
18 | 18 | $validation_error_message = __("Please enter a valid URL", "event_espresso"); |
19 | 19 | } |
20 | - parent::__construct( $validation_error_message ); |
|
20 | + parent::__construct($validation_error_message); |
|
21 | 21 | } |
22 | 22 | |
23 | 23 | |
@@ -30,12 +30,12 @@ discard block |
||
30 | 30 | * @throws \EE_Validation_Error |
31 | 31 | */ |
32 | 32 | function validate($normalized_value) { |
33 | - if( $normalized_value ){ |
|
34 | - if (filter_var($normalized_value, FILTER_VALIDATE_URL) === false){ |
|
35 | - throw new EE_Validation_Error( $this->get_validation_error_message(), 'invalid_url'); |
|
36 | - }else{ |
|
33 | + if ($normalized_value) { |
|
34 | + if (filter_var($normalized_value, FILTER_VALIDATE_URL) === false) { |
|
35 | + throw new EE_Validation_Error($this->get_validation_error_message(), 'invalid_url'); |
|
36 | + } else { |
|
37 | 37 | EE_Registry::instance()->load_helper('URL'); |
38 | - if( ! EEH_URL::remote_file_exists($normalized_value)){ |
|
38 | + if ( ! EEH_URL::remote_file_exists($normalized_value)) { |
|
39 | 39 | throw new EE_Validation_Error(sprintf(__("That URL seems to be broken. Please enter a valid URL", "event_espresso"))); |
40 | 40 | } |
41 | 41 | } |
@@ -47,8 +47,8 @@ discard block |
||
47 | 47 | /** |
48 | 48 | * @return array |
49 | 49 | */ |
50 | - function get_jquery_validation_rule_array(){ |
|
51 | - return array( 'validUrl'=>true, 'messages' => array( 'validUrl' => $this->get_validation_error_message() ) ); |
|
50 | + function get_jquery_validation_rule_array() { |
|
51 | + return array('validUrl'=>true, 'messages' => array('validUrl' => $this->get_validation_error_message())); |
|
52 | 52 | } |
53 | 53 | } |
54 | 54 |
@@ -33,7 +33,7 @@ |
||
33 | 33 | if( $normalized_value ){ |
34 | 34 | if (filter_var($normalized_value, FILTER_VALIDATE_URL) === false){ |
35 | 35 | throw new EE_Validation_Error( $this->get_validation_error_message(), 'invalid_url'); |
36 | - }else{ |
|
36 | + } else{ |
|
37 | 37 | EE_Registry::instance()->load_helper('URL'); |
38 | 38 | if( ! EEH_URL::remote_file_exists($normalized_value)){ |
39 | 39 | throw new EE_Validation_Error(sprintf(__("That URL seems to be broken. Please enter a valid URL", "event_espresso"))); |
@@ -16,7 +16,7 @@ discard block |
||
16 | 16 | /** |
17 | 17 | * @param EE_Line_Item $line_item |
18 | 18 | * @param array $options |
19 | - * @return mixed |
|
19 | + * @return string |
|
20 | 20 | */ |
21 | 21 | public function display_line_item( EE_Line_Item $line_item, $options = array() ) { |
22 | 22 | |
@@ -94,7 +94,7 @@ discard block |
||
94 | 94 | * |
95 | 95 | * @param EE_Line_Item $line_item |
96 | 96 | * @param array $options |
97 | - * @return mixed |
|
97 | + * @return string |
|
98 | 98 | */ |
99 | 99 | private function _item_row( EE_Line_Item $line_item, $options = array() ) { |
100 | 100 | // start of row |
@@ -123,7 +123,7 @@ discard block |
||
123 | 123 | * |
124 | 124 | * @param EE_Line_Item $line_item |
125 | 125 | * @param array $options |
126 | - * @return mixed |
|
126 | + * @return string |
|
127 | 127 | */ |
128 | 128 | private function _sub_item_row( EE_Line_Item $line_item, $options = array() ) { |
129 | 129 | // start of row |
@@ -153,7 +153,7 @@ discard block |
||
153 | 153 | * |
154 | 154 | * @param EE_Line_Item $line_item |
155 | 155 | * @param array $options |
156 | - * @return mixed |
|
156 | + * @return string |
|
157 | 157 | */ |
158 | 158 | private function _tax_row( EE_Line_Item $line_item, $options = array() ) { |
159 | 159 | // start of row |
@@ -179,7 +179,7 @@ discard block |
||
179 | 179 | * @param EE_Line_Item $line_item |
180 | 180 | * @param string $text |
181 | 181 | * @param array $options |
182 | - * @return mixed |
|
182 | + * @return string |
|
183 | 183 | */ |
184 | 184 | private function _total_row( EE_Line_Item $line_item, $text = '', $options = array() ) { |
185 | 185 | // colspan |
@@ -203,7 +203,7 @@ discard block |
||
203 | 203 | * _separator_row |
204 | 204 | * |
205 | 205 | * @param array $options |
206 | - * @return mixed |
|
206 | + * @return string |
|
207 | 207 | */ |
208 | 208 | private function _separator_row( $options = array() ) { |
209 | 209 | // colspan |
@@ -1,16 +1,16 @@ |
||
1 | 1 | <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) { exit('No direct script access allowed'); } |
2 | 2 | /** |
3 | - * |
|
4 | - * Class EE_Invoice_Line_Item_Display_Strategy |
|
5 | - * |
|
6 | - * Description |
|
7 | - * |
|
8 | - * @package Event Espresso |
|
9 | - * @subpackage core |
|
10 | - * @author Brent Christensen |
|
11 | - * @since $VID:$ |
|
12 | - * |
|
13 | - */ |
|
3 | + * |
|
4 | + * Class EE_Invoice_Line_Item_Display_Strategy |
|
5 | + * |
|
6 | + * Description |
|
7 | + * |
|
8 | + * @package Event Espresso |
|
9 | + * @subpackage core |
|
10 | + * @author Brent Christensen |
|
11 | + * @since $VID:$ |
|
12 | + * |
|
13 | + */ |
|
14 | 14 | class EE_Invoice_Line_Item_Display_Strategy implements EEI_Line_Item_Display { |
15 | 15 | |
16 | 16 | /** |
@@ -18,9 +18,9 @@ discard block |
||
18 | 18 | * @param array $options |
19 | 19 | * @return mixed |
20 | 20 | */ |
21 | - public function display_line_item( EE_Line_Item $line_item, $options = array() ) { |
|
21 | + public function display_line_item(EE_Line_Item $line_item, $options = array()) { |
|
22 | 22 | |
23 | - EE_Registry::instance()->load_helper( 'HTML' ); |
|
23 | + EE_Registry::instance()->load_helper('HTML'); |
|
24 | 24 | |
25 | 25 | $html = ''; |
26 | 26 | // set some default options and merge with incoming |
@@ -28,58 +28,58 @@ discard block |
||
28 | 28 | 'show_desc' => TRUE, |
29 | 29 | 'odd' => FALSE |
30 | 30 | ); |
31 | - $options = array_merge( $default_options, (array)$options ); |
|
31 | + $options = array_merge($default_options, (array) $options); |
|
32 | 32 | |
33 | - switch( $line_item->type() ) { |
|
33 | + switch ($line_item->type()) { |
|
34 | 34 | |
35 | 35 | case EEM_Line_Item::type_total: |
36 | 36 | // loop thru children |
37 | - foreach( $line_item->children() as $child_line_item ) { |
|
37 | + foreach ($line_item->children() as $child_line_item) { |
|
38 | 38 | // recursively feed children back into this method |
39 | - $html .= $this->display_line_item( $child_line_item, $options ); |
|
39 | + $html .= $this->display_line_item($child_line_item, $options); |
|
40 | 40 | } |
41 | - $html .= $this->_separator_row( $options ); |
|
42 | - $html .= $this->_total_row( $line_item, __('Total', 'event_espresso'), $options ); |
|
41 | + $html .= $this->_separator_row($options); |
|
42 | + $html .= $this->_total_row($line_item, __('Total', 'event_espresso'), $options); |
|
43 | 43 | break; |
44 | 44 | |
45 | 45 | |
46 | 46 | case EEM_Line_Item::type_sub_total: |
47 | 47 | // loop thru children |
48 | - foreach( $line_item->children() as $child_line_item ) { |
|
48 | + foreach ($line_item->children() as $child_line_item) { |
|
49 | 49 | // recursively feed children back into this method |
50 | - $html .= $this->display_line_item( $child_line_item, $options ); |
|
50 | + $html .= $this->display_line_item($child_line_item, $options); |
|
51 | 51 | } |
52 | - $html .= $this->_total_row( $line_item, __('Sub-Total', 'event_espresso'), $options ); |
|
52 | + $html .= $this->_total_row($line_item, __('Sub-Total', 'event_espresso'), $options); |
|
53 | 53 | break; |
54 | 54 | |
55 | 55 | |
56 | 56 | case EEM_Line_Item::type_tax_sub_total: |
57 | 57 | // loop thru children |
58 | - foreach( $line_item->children() as $child_line_item ) { |
|
58 | + foreach ($line_item->children() as $child_line_item) { |
|
59 | 59 | // recursively feed children back into this method |
60 | - $html .= $this->display_line_item( $child_line_item, $options ); |
|
60 | + $html .= $this->display_line_item($child_line_item, $options); |
|
61 | 61 | } |
62 | - $html .= $this->_total_row( $line_item, __('Tax Total', 'event_espresso'), $options ); |
|
62 | + $html .= $this->_total_row($line_item, __('Tax Total', 'event_espresso'), $options); |
|
63 | 63 | break; |
64 | 64 | |
65 | 65 | |
66 | 66 | case EEM_Line_Item::type_line_item: |
67 | 67 | // item row |
68 | - $html .= $this->_item_row( $line_item, $options ); |
|
68 | + $html .= $this->_item_row($line_item, $options); |
|
69 | 69 | // got any kids? |
70 | - foreach( $line_item->children() as $child_line_item ) { |
|
71 | - $this->display_line_item( $child_line_item, $options ); |
|
70 | + foreach ($line_item->children() as $child_line_item) { |
|
71 | + $this->display_line_item($child_line_item, $options); |
|
72 | 72 | } |
73 | 73 | break; |
74 | 74 | |
75 | 75 | |
76 | 76 | case EEM_Line_Item::type_sub_line_item: |
77 | - $html .= $this->_sub_item_row( $line_item, $options ); |
|
77 | + $html .= $this->_sub_item_row($line_item, $options); |
|
78 | 78 | break; |
79 | 79 | |
80 | 80 | |
81 | 81 | case EEM_Line_Item::type_tax: |
82 | - $html .= $this->_tax_row( $line_item, $options ); |
|
82 | + $html .= $this->_tax_row($line_item, $options); |
|
83 | 83 | break; |
84 | 84 | |
85 | 85 | } |
@@ -96,21 +96,21 @@ discard block |
||
96 | 96 | * @param array $options |
97 | 97 | * @return mixed |
98 | 98 | */ |
99 | - private function _item_row( EE_Line_Item $line_item, $options = array() ) { |
|
99 | + private function _item_row(EE_Line_Item $line_item, $options = array()) { |
|
100 | 100 | // start of row |
101 | 101 | $row_class = $options['odd'] ? 'item odd' : 'item'; |
102 | - $html = EEH_HTML::tr( '', $row_class ); |
|
102 | + $html = EEH_HTML::tr('', $row_class); |
|
103 | 103 | // name td |
104 | - $html .= EEH_HTML::td( $line_item->name(), '', 'item_l' ); |
|
104 | + $html .= EEH_HTML::td($line_item->name(), '', 'item_l'); |
|
105 | 105 | // desc td |
106 | - $html .= $options['show_desc'] ? EEH_HTML::td( $line_item->desc(), '', 'item_l' ) : ''; |
|
106 | + $html .= $options['show_desc'] ? EEH_HTML::td($line_item->desc(), '', 'item_l') : ''; |
|
107 | 107 | // quantity td |
108 | - $html .= EEH_HTML::td( $line_item->quantity(), '', 'item_l' ); |
|
108 | + $html .= EEH_HTML::td($line_item->quantity(), '', 'item_l'); |
|
109 | 109 | // price td |
110 | - $html .= EEH_HTML::td( $line_item->unit_price_no_code(), '', 'item_c' ); |
|
110 | + $html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'item_c'); |
|
111 | 111 | // total td |
112 | - $total = $line_item->is_taxable() ? $line_item->total_no_code() . '*' : $line_item->total_no_code(); |
|
113 | - $html .= EEH_HTML::td( $total, '', 'item_r' ); |
|
112 | + $total = $line_item->is_taxable() ? $line_item->total_no_code().'*' : $line_item->total_no_code(); |
|
113 | + $html .= EEH_HTML::td($total, '', 'item_r'); |
|
114 | 114 | // end of row |
115 | 115 | $html .= EEH_HTML::trx(); |
116 | 116 | return $html; |
@@ -125,22 +125,22 @@ discard block |
||
125 | 125 | * @param array $options |
126 | 126 | * @return mixed |
127 | 127 | */ |
128 | - private function _sub_item_row( EE_Line_Item $line_item, $options = array() ) { |
|
128 | + private function _sub_item_row(EE_Line_Item $line_item, $options = array()) { |
|
129 | 129 | // start of row |
130 | - $html = EEH_HTML::tr( '', 'item sub-item-row' ); |
|
130 | + $html = EEH_HTML::tr('', 'item sub-item-row'); |
|
131 | 131 | // name td |
132 | - $html .= EEH_HTML::td( $line_item->name(), '', 'item_l sub-item' ); |
|
132 | + $html .= EEH_HTML::td($line_item->name(), '', 'item_l sub-item'); |
|
133 | 133 | // desc td |
134 | - $html .= $options['show_desc'] ? EEH_HTML::td( $line_item->desc(), '', 'item_l' ) : ''; |
|
135 | - $html .= EEH_HTML::td() . EEH_HTML::tdx(); |
|
134 | + $html .= $options['show_desc'] ? EEH_HTML::td($line_item->desc(), '', 'item_l') : ''; |
|
135 | + $html .= EEH_HTML::td().EEH_HTML::tdx(); |
|
136 | 136 | // discount/surcharge td |
137 | - if ( $line_item->is_percent() ) { |
|
138 | - $html .= EEH_HTML::td( $line_item->percent() . '%', '', 'item_c' ); |
|
137 | + if ($line_item->is_percent()) { |
|
138 | + $html .= EEH_HTML::td($line_item->percent().'%', '', 'item_c'); |
|
139 | 139 | } else { |
140 | - $html .= EEH_HTML::td( $line_item->unit_price_no_code(), '', 'item_c' ); |
|
140 | + $html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'item_c'); |
|
141 | 141 | } |
142 | 142 | // total td |
143 | - $html .= EEH_HTML::td( $line_item->total_no_code(), '', 'item_r' ); |
|
143 | + $html .= EEH_HTML::td($line_item->total_no_code(), '', 'item_r'); |
|
144 | 144 | // end of row |
145 | 145 | $html .= EEH_HTML::trx(); |
146 | 146 | return $html; |
@@ -155,17 +155,17 @@ discard block |
||
155 | 155 | * @param array $options |
156 | 156 | * @return mixed |
157 | 157 | */ |
158 | - private function _tax_row( EE_Line_Item $line_item, $options = array() ) { |
|
158 | + private function _tax_row(EE_Line_Item $line_item, $options = array()) { |
|
159 | 159 | // start of row |
160 | - $html = EEH_HTML::tr( '', 'item sub-item tax-total' ); |
|
160 | + $html = EEH_HTML::tr('', 'item sub-item tax-total'); |
|
161 | 161 | // name td |
162 | - $html .= EEH_HTML::td( $line_item->name(), '', 'item_l sub-item' ); |
|
162 | + $html .= EEH_HTML::td($line_item->name(), '', 'item_l sub-item'); |
|
163 | 163 | // desc td |
164 | - $html .= $options['show_desc'] ? EEH_HTML::td( $line_item->desc(), '', 'item_l' ) : ''; |
|
164 | + $html .= $options['show_desc'] ? EEH_HTML::td($line_item->desc(), '', 'item_l') : ''; |
|
165 | 165 | // percent td |
166 | - $html .= EEH_HTML::td( $line_item->percent() . '%', '', 'item_c', '', ' colspan="2"' ); |
|
166 | + $html .= EEH_HTML::td($line_item->percent().'%', '', 'item_c', '', ' colspan="2"'); |
|
167 | 167 | // total td |
168 | - $html .= EEH_HTML::td( $line_item->total_no_code(), '', 'item_r' ); |
|
168 | + $html .= EEH_HTML::td($line_item->total_no_code(), '', 'item_r'); |
|
169 | 169 | // end of row |
170 | 170 | $html .= EEH_HTML::trx(); |
171 | 171 | return $html; |
@@ -181,17 +181,17 @@ discard block |
||
181 | 181 | * @param array $options |
182 | 182 | * @return mixed |
183 | 183 | */ |
184 | - private function _total_row( EE_Line_Item $line_item, $text = '', $options = array() ) { |
|
184 | + private function _total_row(EE_Line_Item $line_item, $text = '', $options = array()) { |
|
185 | 185 | // colspan |
186 | 186 | $colspan = $options['show_desc'] ? ' colspan="2"' : ''; |
187 | 187 | // start of row |
188 | - $html = EEH_HTML::tr( '', '', 'total_tr odd' ); |
|
188 | + $html = EEH_HTML::tr('', '', 'total_tr odd'); |
|
189 | 189 | // empty td |
190 | - $html .= EEH_HTML::td( EEH_HTML::nbsp(), '', '', '', $colspan ); |
|
190 | + $html .= EEH_HTML::td(EEH_HTML::nbsp(), '', '', '', $colspan); |
|
191 | 191 | // total td |
192 | - $html .= EEH_HTML::td( $text, '', 'total_currency total', '', $colspan ); |
|
192 | + $html .= EEH_HTML::td($text, '', 'total_currency total', '', $colspan); |
|
193 | 193 | // total td |
194 | - $html .= EEH_HTML::td( $line_item->total_no_code(), '', 'total' ); |
|
194 | + $html .= EEH_HTML::td($line_item->total_no_code(), '', 'total'); |
|
195 | 195 | // end of row |
196 | 196 | $html .= EEH_HTML::trx(); |
197 | 197 | return $html; |
@@ -205,11 +205,11 @@ discard block |
||
205 | 205 | * @param array $options |
206 | 206 | * @return mixed |
207 | 207 | */ |
208 | - private function _separator_row( $options = array() ) { |
|
208 | + private function _separator_row($options = array()) { |
|
209 | 209 | // colspan |
210 | 210 | $colspan = $options['show_desc'] ? ' colspan="5"' : ' colspan="4"'; |
211 | 211 | // start of row |
212 | - $html = EEH_HTML::tr( EEH_HTML::td( '<hr>', '', '', '', $colspan )); |
|
212 | + $html = EEH_HTML::tr(EEH_HTML::td('<hr>', '', '', '', $colspan)); |
|
213 | 213 | // // separator td |
214 | 214 | // $html .= EEH_HTML::td( '<hr>', '', '', '', $colspan ); |
215 | 215 | // // end of row |
@@ -31,7 +31,7 @@ |
||
31 | 31 | /** |
32 | 32 | * @param EE_Line_Item $line_item |
33 | 33 | * @param array $options |
34 | - * @return mixed |
|
34 | + * @return string |
|
35 | 35 | */ |
36 | 36 | public function display_line_item( EE_Line_Item $line_item, $options = array() ) { |
37 | 37 |
@@ -14,17 +14,17 @@ |
||
14 | 14 | * ------------------------------------------------------------------------ |
15 | 15 | */ |
16 | 16 | /** |
17 | - * |
|
18 | - * Class EE_Receipt_Line_Item_Display_Strategy |
|
19 | - * |
|
20 | - * Description |
|
21 | - * |
|
22 | - * @package Event Espresso |
|
23 | - * @subpackage core |
|
24 | - * @author Brent Christensen |
|
25 | - * @since $VID:$ |
|
26 | - * |
|
27 | - */ |
|
17 | + * |
|
18 | + * Class EE_Receipt_Line_Item_Display_Strategy |
|
19 | + * |
|
20 | + * Description |
|
21 | + * |
|
22 | + * @package Event Espresso |
|
23 | + * @subpackage core |
|
24 | + * @author Brent Christensen |
|
25 | + * @since $VID:$ |
|
26 | + * |
|
27 | + */ |
|
28 | 28 | |
29 | 29 | class EE_Receipt_Line_Item_Display_Strategy implements EEI_Line_Item_Display { |
30 | 30 |
@@ -33,9 +33,9 @@ discard block |
||
33 | 33 | * @param array $options |
34 | 34 | * @return mixed |
35 | 35 | */ |
36 | - public function display_line_item( EE_Line_Item $line_item, $options = array() ) { |
|
36 | + public function display_line_item(EE_Line_Item $line_item, $options = array()) { |
|
37 | 37 | |
38 | - EE_Registry::instance()->load_helper( 'HTML' ); |
|
38 | + EE_Registry::instance()->load_helper('HTML'); |
|
39 | 39 | |
40 | 40 | $html = ''; |
41 | 41 | // set some default options and merge with incoming |
@@ -43,12 +43,12 @@ discard block |
||
43 | 43 | 'show_desc' => TRUE, |
44 | 44 | 'odd' => FALSE |
45 | 45 | ); |
46 | - $options = array_merge( $default_options, (array)$options ); |
|
47 | - switch( $line_item->type() ) { |
|
46 | + $options = array_merge($default_options, (array) $options); |
|
47 | + switch ($line_item->type()) { |
|
48 | 48 | |
49 | 49 | case EEM_Line_Item::type_total: |
50 | 50 | // loop thru children |
51 | - foreach( $line_item->children() as $child_line_item ) { |
|
51 | + foreach ($line_item->children() as $child_line_item) { |
|
52 | 52 | // recursively feed children back into this method |
53 | 53 | // $html .= $this->display_line_item( $child_line_item, $options ); |
54 | 54 | } |
@@ -59,7 +59,7 @@ discard block |
||
59 | 59 | |
60 | 60 | case EEM_Line_Item::type_sub_total: |
61 | 61 | // loop thru children |
62 | - foreach( $line_item->children() as $child_line_item ) { |
|
62 | + foreach ($line_item->children() as $child_line_item) { |
|
63 | 63 | // recursively feed children back into this method |
64 | 64 | // $html .= $this->display_line_item( $child_line_item, $options ); |
65 | 65 | } |
@@ -69,7 +69,7 @@ discard block |
||
69 | 69 | |
70 | 70 | case EEM_Line_Item::type_tax_sub_total: |
71 | 71 | // loop thru children |
72 | - foreach( $line_item->children() as $child_line_item ) { |
|
72 | + foreach ($line_item->children() as $child_line_item) { |
|
73 | 73 | // recursively feed children back into this method |
74 | 74 | // $html .= $this->display_line_item( $child_line_item, $options ); |
75 | 75 | } |
@@ -81,7 +81,7 @@ discard block |
||
81 | 81 | // item row |
82 | 82 | // $html .= $this->_item_row( $line_item, $options ); |
83 | 83 | // got any kids? |
84 | - foreach( $line_item->children() as $child_line_item ) { |
|
84 | + foreach ($line_item->children() as $child_line_item) { |
|
85 | 85 | // $this->display_line_item( $child_line_item, $options ); |
86 | 86 | } |
87 | 87 | break; |
@@ -316,6 +316,7 @@ |
||
316 | 316 | * @param EE_message_type $message_type |
317 | 317 | * @param string $field The field reference for the specific template being looked up. |
318 | 318 | * @param string $context The context reference for the specific template being looked up |
319 | + * @param EE_Messages_Template_Pack_Default|null $default_pack |
|
319 | 320 | * |
320 | 321 | * @return string The template contents. |
321 | 322 | */ |
@@ -167,48 +167,48 @@ discard block |
||
167 | 167 | public function __construct() { |
168 | 168 | $this->_set_props(); |
169 | 169 | //make sure classname is correct |
170 | - $classname = get_class( $this ); |
|
170 | + $classname = get_class($this); |
|
171 | 171 | //make sure required props have been set |
172 | 172 | |
173 | 173 | //if label is empty then throw an error because we should have it defined by now. |
174 | - if ( ! isset( $this->label ) ) { |
|
175 | - throw new EE_Error( sprintf( __('The label property is not set for %s. Please ensure that is set for the class.', 'event_espresso' ), $classname ) ); |
|
174 | + if ( ! isset($this->label)) { |
|
175 | + throw new EE_Error(sprintf(__('The label property is not set for %s. Please ensure that is set for the class.', 'event_espresso'), $classname)); |
|
176 | 176 | } |
177 | 177 | |
178 | 178 | |
179 | 179 | //the reference for this template pack |
180 | - if ( ! isset( $this->dbref ) ) { |
|
181 | - throw new EE_Error( sprintf( __('The dbref property is not set for %s. Please ensure that is set for the class.', 'event_espresso' ), $classname ) ); |
|
180 | + if ( ! isset($this->dbref)) { |
|
181 | + throw new EE_Error(sprintf(__('The dbref property is not set for %s. Please ensure that is set for the class.', 'event_espresso'), $classname)); |
|
182 | 182 | } |
183 | 183 | |
184 | 184 | //make sure dbref is safe |
185 | - $this->dbref = str_replace( '-', '_', sanitize_key( $this->dbref ) ); |
|
185 | + $this->dbref = str_replace('-', '_', sanitize_key($this->dbref)); |
|
186 | 186 | |
187 | - $should_be = 'EE_Messages_Template_Pack_' . str_replace( ' ', '_', ucwords( str_replace( '_', ' ', $this->dbref ) ) ); |
|
187 | + $should_be = 'EE_Messages_Template_Pack_'.str_replace(' ', '_', ucwords(str_replace('_', ' ', $this->dbref))); |
|
188 | 188 | |
189 | - if ( $should_be !== $classname ) { |
|
190 | - throw new EE_Error( sprintf( __('The name of the template pack instantiated class is "%s". It should be "%s". Make sure that the name of the template pack class matches is prepended with "EE_Messages_Template_Pack_" and appended with a sentence case iteration of the value for your template pack\'s dbref property.', 'event_espresso' ), $classname, $should_be ) ); |
|
189 | + if ($should_be !== $classname) { |
|
190 | + throw new EE_Error(sprintf(__('The name of the template pack instantiated class is "%s". It should be "%s". Make sure that the name of the template pack class matches is prepended with "EE_Messages_Template_Pack_" and appended with a sentence case iteration of the value for your template pack\'s dbref property.', 'event_espresso'), $classname, $should_be)); |
|
191 | 191 | } |
192 | 192 | |
193 | 193 | //if _base_path is not set then throw an error because a base path string is needed. |
194 | - if ( empty( $this->_base_path ) ) { |
|
195 | - throw new EE_Error( sprintf( __('The _base_path property is not set for %s. Please ensure that is set for the class.', 'event_espresso' ), $classname ) ); |
|
194 | + if (empty($this->_base_path)) { |
|
195 | + throw new EE_Error(sprintf(__('The _base_path property is not set for %s. Please ensure that is set for the class.', 'event_espresso'), $classname)); |
|
196 | 196 | } |
197 | 197 | |
198 | 198 | |
199 | 199 | //if _base_url is not set then throw an error because a string is needed for variations. |
200 | - if ( empty( $this->_base_url ) ) { |
|
201 | - throw new EE_Error( sprintf( __('The _base_url property is not set for %s. Please ensure that is set for the class.', 'event_espresso' ), $classname ) ); |
|
200 | + if (empty($this->_base_url)) { |
|
201 | + throw new EE_Error(sprintf(__('The _base_url property is not set for %s. Please ensure that is set for the class.', 'event_espresso'), $classname)); |
|
202 | 202 | } |
203 | 203 | |
204 | 204 | |
205 | 205 | //if $supports is not set then throw an error because that effectively means this template_pack does not have any templates! |
206 | - if ( empty( $this->_supports ) ) { |
|
207 | - throw new EE_Error( sprintf( __('The supports property is not set for %s. Please ensure that is set for the class.', 'event_espresso' ), $classname ) ); |
|
206 | + if (empty($this->_supports)) { |
|
207 | + throw new EE_Error(sprintf(__('The supports property is not set for %s. Please ensure that is set for the class.', 'event_espresso'), $classname)); |
|
208 | 208 | } |
209 | 209 | |
210 | 210 | //load template helper |
211 | - EE_Registry::instance()->load_helper( 'Template' ); |
|
211 | + EE_Registry::instance()->load_helper('Template'); |
|
212 | 212 | |
213 | 213 | } |
214 | 214 | |
@@ -243,8 +243,8 @@ discard block |
||
243 | 243 | * |
244 | 244 | * @return array |
245 | 245 | */ |
246 | - public function get_templates( EE_messenger $messenger, EE_message_type $message_type ) { |
|
247 | - return isset( $this->_templates[$messenger->name][$message_type->name] ) ? $this->_templates[$messenger->name][$message_type->name] : $this->_get_templates( $messenger, $message_type ); |
|
246 | + public function get_templates(EE_messenger $messenger, EE_message_type $message_type) { |
|
247 | + return isset($this->_templates[$messenger->name][$message_type->name]) ? $this->_templates[$messenger->name][$message_type->name] : $this->_get_templates($messenger, $message_type); |
|
248 | 248 | } |
249 | 249 | |
250 | 250 | |
@@ -261,7 +261,7 @@ discard block |
||
261 | 261 | * @return array Returns an multi-level associative array indexed by template context and field in the format: |
262 | 262 | * array( 'context' => array( 'field' => 'value', 'another-field', 'value' ) ); |
263 | 263 | */ |
264 | - protected function _get_templates( EE_messenger $messenger, EE_message_type $message_type ) { |
|
264 | + protected function _get_templates(EE_messenger $messenger, EE_message_type $message_type) { |
|
265 | 265 | $templates = array(); |
266 | 266 | |
267 | 267 | /** |
@@ -280,28 +280,28 @@ discard block |
||
280 | 280 | $contexts = $message_type->get_contexts(); |
281 | 281 | |
282 | 282 | |
283 | - foreach ( $contexts as $context => $details ) { |
|
284 | - foreach ( $fields as $field => $field_details ) { |
|
285 | - if ( empty( $field_details ) ) |
|
283 | + foreach ($contexts as $context => $details) { |
|
284 | + foreach ($fields as $field => $field_details) { |
|
285 | + if (empty($field_details)) |
|
286 | 286 | continue; |
287 | 287 | /** |
288 | 288 | * is this a field array (linked to a main field)? |
289 | 289 | */ |
290 | - if ( $field == 'extra' ) { |
|
291 | - foreach ( $field_details as $main_field => $sub_fields ) { |
|
292 | - foreach ( $sub_fields as $sub_field => $sub_field_details ) { |
|
290 | + if ($field == 'extra') { |
|
291 | + foreach ($field_details as $main_field => $sub_fields) { |
|
292 | + foreach ($sub_fields as $sub_field => $sub_field_details) { |
|
293 | 293 | //make sure that the template_field_ref matches what the main template field is for this template group. |
294 | 294 | $template_field_ref = $sub_field == 'main' ? $main_field : $sub_field; |
295 | - $templates[ $context ][ $main_field ][ $sub_field ] = $this->_get_specific_template( $default_pack, $messenger, $message_type, $template_field_ref, $context ); |
|
295 | + $templates[$context][$main_field][$sub_field] = $this->_get_specific_template($default_pack, $messenger, $message_type, $template_field_ref, $context); |
|
296 | 296 | } |
297 | 297 | } |
298 | 298 | } else { |
299 | - $templates[ $context ][ $field ] = $this->_get_specific_template( $default_pack, $messenger, $message_type, $field, $context ); |
|
299 | + $templates[$context][$field] = $this->_get_specific_template($default_pack, $messenger, $message_type, $field, $context); |
|
300 | 300 | } |
301 | 301 | } |
302 | 302 | } |
303 | 303 | |
304 | - $templates = apply_filters( 'FHEE__EE_Template_Pack___get_templates__templates', $templates, $messenger, $message_type, $this ); |
|
304 | + $templates = apply_filters('FHEE__EE_Template_Pack___get_templates__templates', $templates, $messenger, $message_type, $this); |
|
305 | 305 | |
306 | 306 | $this->_templates[$messenger->name][$message_type->name] = $templates; |
307 | 307 | return $templates; |
@@ -319,22 +319,22 @@ discard block |
||
319 | 319 | * |
320 | 320 | * @return string The template contents. |
321 | 321 | */ |
322 | - protected function _get_specific_template( $default_pack, EE_messenger $messenger, EE_message_type $message_type, $field, $context ) { |
|
322 | + protected function _get_specific_template($default_pack, EE_messenger $messenger, EE_message_type $message_type, $field, $context) { |
|
323 | 323 | |
324 | 324 | //default templates |
325 | - $default_templates = $default_pack instanceof EE_Messages_Template_Pack_Default ? $default_pack->get_templates( $messenger, $message_type ) : array(); |
|
325 | + $default_templates = $default_pack instanceof EE_Messages_Template_Pack_Default ? $default_pack->get_templates($messenger, $message_type) : array(); |
|
326 | 326 | |
327 | 327 | //first we allow for the $_base_path to be filtered. However, we assign this to a new variable so that we have the original base_path as a fallback. |
328 | - $filtered_base_path = apply_filters( 'FHEE__EE_Template_Pack___get_specific_template__filtered_base_path', $this->_base_path, $messenger, $message_type, $field, $context, $this ); |
|
328 | + $filtered_base_path = apply_filters('FHEE__EE_Template_Pack___get_specific_template__filtered_base_path', $this->_base_path, $messenger, $message_type, $field, $context, $this); |
|
329 | 329 | |
330 | 330 | $master_templates = $message_type->get_master_templates(); |
331 | - $master_templates_mt = isset( $master_templates[$messenger->name] ) ? $master_templates[$messenger->name] : $message_type->name; |
|
332 | - $full_path = $filtered_base_path . $messenger->name . '_' . $message_type->name . '_' . $field . '_' . $context . '.template.php'; |
|
333 | - $fallback_path = $filtered_base_path . $messenger->name . '_' . $message_type->name . '_' . $field . '.template.php'; |
|
334 | - $mt_defined_full_path = $filtered_base_path . $messenger->name . '_' . $master_templates_mt . '_' . $field . '_' . $context . '.template.php'; |
|
335 | - $mt_defined_fallback_path = $filtered_base_path . $messenger->name . '_' . $master_templates_mt . '_' . $field . '.template.php'; |
|
336 | - $base_defined_full_path = $this->_base_path . $messenger->name . '_' . $master_templates_mt . '_' . $field . '_' . $context . '.template.php'; |
|
337 | - $base_defined_fallback_path = $this->_base_path . $messenger->name . '_' . $master_templates_mt . '_' . $field . '.template.php'; |
|
331 | + $master_templates_mt = isset($master_templates[$messenger->name]) ? $master_templates[$messenger->name] : $message_type->name; |
|
332 | + $full_path = $filtered_base_path.$messenger->name.'_'.$message_type->name.'_'.$field.'_'.$context.'.template.php'; |
|
333 | + $fallback_path = $filtered_base_path.$messenger->name.'_'.$message_type->name.'_'.$field.'.template.php'; |
|
334 | + $mt_defined_full_path = $filtered_base_path.$messenger->name.'_'.$master_templates_mt.'_'.$field.'_'.$context.'.template.php'; |
|
335 | + $mt_defined_fallback_path = $filtered_base_path.$messenger->name.'_'.$master_templates_mt.'_'.$field.'.template.php'; |
|
336 | + $base_defined_full_path = $this->_base_path.$messenger->name.'_'.$master_templates_mt.'_'.$field.'_'.$context.'.template.php'; |
|
337 | + $base_defined_fallback_path = $this->_base_path.$messenger->name.'_'.$master_templates_mt.'_'.$field.'.template.php'; |
|
338 | 338 | |
339 | 339 | /** |
340 | 340 | * Template checks are done hierarchically in the following order: |
@@ -348,28 +348,28 @@ discard block |
||
348 | 348 | */ |
349 | 349 | |
350 | 350 | |
351 | - if ( is_readable( $full_path ) ) { |
|
351 | + if (is_readable($full_path)) { |
|
352 | 352 | $actual_path = $full_path; |
353 | - } elseif ( is_readable( $fallback_path ) ) { |
|
353 | + } elseif (is_readable($fallback_path)) { |
|
354 | 354 | $actual_path = $fallback_path; |
355 | - } elseif ( is_readable( $mt_defined_full_path ) ) { |
|
355 | + } elseif (is_readable($mt_defined_full_path)) { |
|
356 | 356 | $actual_path = $mt_defined_full_path; |
357 | - } elseif ( is_readable( $mt_defined_fallback_path ) ) { |
|
357 | + } elseif (is_readable($mt_defined_fallback_path)) { |
|
358 | 358 | $actual_path = $mt_defined_fallback_path; |
359 | - } elseif ( is_readable( $base_defined_full_path ) ) { |
|
359 | + } elseif (is_readable($base_defined_full_path)) { |
|
360 | 360 | $actual_path = $base_defined_full_path; |
361 | - } elseif ( is_readable( $base_defined_fallback_path ) ) { |
|
361 | + } elseif (is_readable($base_defined_fallback_path)) { |
|
362 | 362 | $actual_path = $base_defined_fallback_path; |
363 | - } else { |
|
363 | + } else { |
|
364 | 364 | $actual_path = ''; |
365 | 365 | } |
366 | - if ( empty( $actual_path ) ) { |
|
367 | - $contents = isset( $default_templates[$context][$field] ) ? $default_templates[$context][$field] : ''; |
|
366 | + if (empty($actual_path)) { |
|
367 | + $contents = isset($default_templates[$context][$field]) ? $default_templates[$context][$field] : ''; |
|
368 | 368 | } else { |
369 | - $contents = EEH_Template::display_template( $actual_path, array(), TRUE ); |
|
369 | + $contents = EEH_Template::display_template($actual_path, array(), TRUE); |
|
370 | 370 | } |
371 | 371 | |
372 | - return apply_filters( 'FHEE__EE_Messages_Template_Pack__get_specific_template__contents', $contents, $actual_path, $messenger, $message_type, $field, $context, $this ); |
|
372 | + return apply_filters('FHEE__EE_Messages_Template_Pack__get_specific_template__contents', $contents, $actual_path, $messenger, $message_type, $field, $context, $this); |
|
373 | 373 | } |
374 | 374 | |
375 | 375 | |
@@ -384,8 +384,8 @@ discard block |
||
384 | 384 | * @return array |
385 | 385 | */ |
386 | 386 | public function get_supports() { |
387 | - $supports = apply_filters( 'FHEE__' . get_class( $this ) . '__get_supports', $this->_supports ); |
|
388 | - return apply_filters( 'FHEE__EE_Messages_Template_Pack__get_supports', $supports, $this ); |
|
387 | + $supports = apply_filters('FHEE__'.get_class($this).'__get_supports', $this->_supports); |
|
388 | + return apply_filters('FHEE__EE_Messages_Template_Pack__get_supports', $supports, $this); |
|
389 | 389 | } |
390 | 390 | |
391 | 391 | |
@@ -400,11 +400,11 @@ discard block |
||
400 | 400 | * |
401 | 401 | * @return array|string |
402 | 402 | */ |
403 | - public function get_default_variation_labels( $messenger = '' ) { |
|
404 | - $label = empty( $messenger ) ? $this->_default_variation_labels : array(); |
|
405 | - $label = empty( $label ) && ! empty( $this->_default_variation_labels[$messenger] ) ? $this->_default_variation_labels[$messenger] : __('Default', 'event_espresso'); |
|
403 | + public function get_default_variation_labels($messenger = '') { |
|
404 | + $label = empty($messenger) ? $this->_default_variation_labels : array(); |
|
405 | + $label = empty($label) && ! empty($this->_default_variation_labels[$messenger]) ? $this->_default_variation_labels[$messenger] : __('Default', 'event_espresso'); |
|
406 | 406 | |
407 | - return apply_filters( 'FHEE__EE_Messages_Template_Pack__get_default_variation_labels', $label, $this->_default_variation_labels, $messenger ); |
|
407 | + return apply_filters('FHEE__EE_Messages_Template_Pack__get_default_variation_labels', $label, $this->_default_variation_labels, $messenger); |
|
408 | 408 | } |
409 | 409 | |
410 | 410 | |
@@ -420,25 +420,25 @@ discard block |
||
420 | 420 | * @param string $message_type if included then css variations matching the message_type are returned (must have $messenger set). Otherwise the array of variations per message type are returned. If message_type is provided but NOT the messenger, then just all variations for all messengers are returned. |
421 | 421 | * @return array |
422 | 422 | */ |
423 | - public function get_variations( $messenger = '', $message_type = '' ) { |
|
424 | - $messenger_variations = ! empty( $messenger ) && isset( $this->_variations[$messenger] ) ? $this->_variations[$messenger] : array(); |
|
423 | + public function get_variations($messenger = '', $message_type = '') { |
|
424 | + $messenger_variations = ! empty($messenger) && isset($this->_variations[$messenger]) ? $this->_variations[$messenger] : array(); |
|
425 | 425 | |
426 | 426 | //message_type provided? IF so, then we've requested a specific set of variations, so we need to make sure we set it as empty if that's not present. |
427 | - $variations = !empty( $messenger ) && !empty( $message_type ) && isset( $messenger_variations[$message_type] ) ? $messenger_variations[$message_type] : array(); |
|
427 | + $variations = ! empty($messenger) && ! empty($message_type) && isset($messenger_variations[$message_type]) ? $messenger_variations[$message_type] : array(); |
|
428 | 428 | |
429 | 429 | //now let's account for the possibility we just want all the variations for a messenger (which is indicated by providing the messenger but not the message type). |
430 | - $variations = empty( $variations ) && !empty( $messenger ) && empty( $message_type ) ? $messenger_variations : $variations; |
|
430 | + $variations = empty($variations) && ! empty($messenger) && empty($message_type) ? $messenger_variations : $variations; |
|
431 | 431 | |
432 | 432 | //filter per template pack and globally. |
433 | - $variations = apply_filters( 'FHEE__' . get_class( $this ) . '__get_variations', $variations, $messenger, $message_type ); |
|
434 | - $variations = apply_filters( 'FHEE__EE_Messages_Template_Pack__get_variations', $variations, $messenger, $message_type, $this ); |
|
433 | + $variations = apply_filters('FHEE__'.get_class($this).'__get_variations', $variations, $messenger, $message_type); |
|
434 | + $variations = apply_filters('FHEE__EE_Messages_Template_Pack__get_variations', $variations, $messenger, $message_type, $this); |
|
435 | 435 | |
436 | 436 | //prepend the _default_variation, but ONLY if we're returning the fully validated array. |
437 | - if ( !empty( $messenger ) && !empty( $message_type ) && ! empty( $variations ) ) { |
|
438 | - $variations = array( 'default' => $this->get_default_variation_labels( $messenger ) ) + $variations; |
|
437 | + if ( ! empty($messenger) && ! empty($message_type) && ! empty($variations)) { |
|
438 | + $variations = array('default' => $this->get_default_variation_labels($messenger)) + $variations; |
|
439 | 439 | } |
440 | 440 | |
441 | - return empty( $variations ) ? array( 'default' => $this->get_default_variation_labels('dft') ): $variations; |
|
441 | + return empty($variations) ? array('default' => $this->get_default_variation_labels('dft')) : $variations; |
|
442 | 442 | } |
443 | 443 | |
444 | 444 | |
@@ -459,39 +459,39 @@ discard block |
||
459 | 459 | * |
460 | 460 | * @return string The variation path or url (typically css reference) |
461 | 461 | */ |
462 | - public function get_variation( $messenger, $message_type, $type, $variation, $url = true, $file_extension = '.css', $skip_filters = FALSE ) { |
|
462 | + public function get_variation($messenger, $message_type, $type, $variation, $url = true, $file_extension = '.css', $skip_filters = FALSE) { |
|
463 | 463 | |
464 | 464 | $base = $url ? $this->_base_url : $this->_base_path; |
465 | 465 | $base_path = $this->_base_path; |
466 | 466 | |
467 | - if ( ! $skip_filters ) { |
|
468 | - $base = apply_filters( 'FHEE__EE_Messages_Template_Pack__get_variation__base_path_or_url', $base, $messenger, $message_type, $type, $variation, $url, $file_extension, $this ); |
|
469 | - $base_path = apply_filters( 'FHEE__EE_Messages_Template_Pack__get_variation__base_path', $base_path, $messenger, $message_type, $type, $variation, FALSE, $file_extension, $this ); |
|
467 | + if ( ! $skip_filters) { |
|
468 | + $base = apply_filters('FHEE__EE_Messages_Template_Pack__get_variation__base_path_or_url', $base, $messenger, $message_type, $type, $variation, $url, $file_extension, $this); |
|
469 | + $base_path = apply_filters('FHEE__EE_Messages_Template_Pack__get_variation__base_path', $base_path, $messenger, $message_type, $type, $variation, FALSE, $file_extension, $this); |
|
470 | 470 | } |
471 | 471 | |
472 | - $default_pack = get_class( $this ) != 'EE_Messages_Template_Pack_Default' ? new EE_Messages_Template_Pack_Default() : $this; |
|
472 | + $default_pack = get_class($this) != 'EE_Messages_Template_Pack_Default' ? new EE_Messages_Template_Pack_Default() : $this; |
|
473 | 473 | |
474 | 474 | //possible variation paths considering whether message type is present or not in the file name. |
475 | - $path_string = 'variations/' . $messenger . '_' . $message_type . '_' . $type . '_' . $variation . $file_extension; |
|
476 | - $default_path_string = 'variations/' . $messenger . '_' . $type . '_' . $variation . $file_extension; |
|
475 | + $path_string = 'variations/'.$messenger.'_'.$message_type.'_'.$type.'_'.$variation.$file_extension; |
|
476 | + $default_path_string = 'variations/'.$messenger.'_'.$type.'_'.$variation.$file_extension; |
|
477 | 477 | |
478 | 478 | //first see if fully validated file exists. |
479 | - if ( is_readable( $base_path . $path_string ) ) { |
|
480 | - $variation_path = $base . $path_string; |
|
479 | + if (is_readable($base_path.$path_string)) { |
|
480 | + $variation_path = $base.$path_string; |
|
481 | 481 | //otherwise see if default exists. |
482 | - } elseif ( is_readable( $base_path . $default_path_string ) ) { |
|
483 | - $variation_path = $base . $default_path_string; |
|
482 | + } elseif (is_readable($base_path.$default_path_string)) { |
|
483 | + $variation_path = $base.$default_path_string; |
|
484 | 484 | } else { |
485 | - $variation_path = $default_pack instanceof EE_Messages_Template_Pack_Default ? $default_pack->get_default_variation( $messenger, $message_type, $type, $url, $file_extension ) : ''; |
|
485 | + $variation_path = $default_pack instanceof EE_Messages_Template_Pack_Default ? $default_pack->get_default_variation($messenger, $message_type, $type, $url, $file_extension) : ''; |
|
486 | 486 | } |
487 | 487 | |
488 | - if ( $skip_filters ) { |
|
488 | + if ($skip_filters) { |
|
489 | 489 | return $variation_path; |
490 | 490 | } |
491 | 491 | |
492 | 492 | //filter result |
493 | - $variation_path = apply_filters( 'FHEE__' . get_class( $this ) . '__get_variation', $variation_path, $messenger, $message_type, $type, $variation, $file_extension, $url ); |
|
494 | - return apply_filters( 'FHEE__EE_Messages_Template_Pack__get_variation', $variation_path, $messenger, $message_type, $type, $variation, $file_extension, $url, $this ); |
|
493 | + $variation_path = apply_filters('FHEE__'.get_class($this).'__get_variation', $variation_path, $messenger, $message_type, $type, $variation, $file_extension, $url); |
|
494 | + return apply_filters('FHEE__EE_Messages_Template_Pack__get_variation', $variation_path, $messenger, $message_type, $type, $variation, $file_extension, $url, $this); |
|
495 | 495 | } |
496 | 496 | |
497 | 497 | |
@@ -506,19 +506,19 @@ discard block |
||
506 | 506 | * |
507 | 507 | * @return string returns the path for the requested wrapper template. |
508 | 508 | */ |
509 | - public function get_wrapper( $messenger, $type = 'main' ) { |
|
510 | - $default_pack = get_class( $this ) !== 'EE_Messages_Template_Pack_Default' ? new EE_Messages_Template_Pack_Default() : NULL; |
|
509 | + public function get_wrapper($messenger, $type = 'main') { |
|
510 | + $default_pack = get_class($this) !== 'EE_Messages_Template_Pack_Default' ? new EE_Messages_Template_Pack_Default() : NULL; |
|
511 | 511 | |
512 | - $path_string = $this->_base_path . $messenger . '_' . $type . '_wrapper.template.php'; |
|
512 | + $path_string = $this->_base_path.$messenger.'_'.$type.'_wrapper.template.php'; |
|
513 | 513 | |
514 | - if ( is_readable( $path_string ) ) { |
|
514 | + if (is_readable($path_string)) { |
|
515 | 515 | $template = $path_string; |
516 | 516 | } else { |
517 | - $template = $default_pack instanceof EE_Messages_Template_Pack_Default ? $default_pack->get_wrapper( $messenger, $type ) : ''; |
|
517 | + $template = $default_pack instanceof EE_Messages_Template_Pack_Default ? $default_pack->get_wrapper($messenger, $type) : ''; |
|
518 | 518 | } |
519 | 519 | |
520 | 520 | //filter |
521 | - $template = apply_filters( 'FHEE__' . get_class( $this ) . '__get_wrapper', $template, $messenger, $type ); |
|
522 | - return apply_filters( 'FHEE__EE_Messages_Template_Pack__get_wrapper', $template, $messenger, $type, $this ); |
|
521 | + $template = apply_filters('FHEE__'.get_class($this).'__get_wrapper', $template, $messenger, $type); |
|
522 | + return apply_filters('FHEE__EE_Messages_Template_Pack__get_wrapper', $template, $messenger, $type, $this); |
|
523 | 523 | } |
524 | 524 | } |
@@ -5,7 +5,9 @@ discard block |
||
5 | 5 | * @subpackage messages |
6 | 6 | * @since 4.5.0 |
7 | 7 | */ |
8 | -if ( ! defined('EVENT_ESPRESSO_VERSION')) exit('No direct script access allowed'); |
|
8 | +if ( ! defined('EVENT_ESPRESSO_VERSION')) { |
|
9 | + exit('No direct script access allowed'); |
|
10 | +} |
|
9 | 11 | |
10 | 12 | /** |
11 | 13 | * EE_Template_Packs are classes that contain all the information related to messages templates for a given "template pack". |
@@ -282,8 +284,9 @@ discard block |
||
282 | 284 | |
283 | 285 | foreach ( $contexts as $context => $details ) { |
284 | 286 | foreach ( $fields as $field => $field_details ) { |
285 | - if ( empty( $field_details ) ) |
|
286 | - continue; |
|
287 | + if ( empty( $field_details ) ) { |
|
288 | + continue; |
|
289 | + } |
|
287 | 290 | /** |
288 | 291 | * is this a field array (linked to a main field)? |
289 | 292 | */ |
@@ -125,9 +125,6 @@ discard block |
||
125 | 125 | /** |
126 | 126 | * Activates the specified messenger |
127 | 127 | * @param string $messenger_name |
128 | - * @param array $message_types (optional) An array of message types to activate with this messenger. If |
|
129 | - * included we do NOT setup the default message types (assuming |
|
130 | - * they are already setup.) |
|
131 | 128 | * @return boolean an array of generated templates or false if nothing generated/activated. |
132 | 129 | */ |
133 | 130 | public function activate_messenger( $messenger_name, $mts = array() ){ |
@@ -275,7 +272,7 @@ discard block |
||
275 | 272 | * Used to verify if a message can be sent for the given messenger and message type and that it is a generating messenger (used for generating message templates). |
276 | 273 | * |
277 | 274 | * @param EE_messenger $messenger messenger used in trigger |
278 | - * @param EE_messagetype $message_type message type used in trigger |
|
275 | + * @param EE_message_type $message_type message type used in trigger |
|
279 | 276 | * |
280 | 277 | * @return bool true is a generating messenger and can be sent OR FALSE meaning cannot send. |
281 | 278 | */ |
@@ -500,7 +497,7 @@ discard block |
||
500 | 497 | * |
501 | 498 | * @param string $messenger a string matching a valid active messenger in the system |
502 | 499 | * @param string $message_type Although it seems contrary to the name of the method, a message type name is still required to send along the message type to the messenger because this is used for determining what specific variations might be loaded for the generated message. |
503 | - * @param stdClass $messages a stdClass object in the format expected by the messenger. |
|
500 | + * @param stdClass $message a stdClass object in the format expected by the messenger. |
|
504 | 501 | * |
505 | 502 | * @return bool success or fail. |
506 | 503 | */ |
@@ -573,6 +570,7 @@ discard block |
||
573 | 570 | /** |
574 | 571 | * This is a wrapper for the protected _create_new_templates function |
575 | 572 | * @param string $message_type message type that the templates are being created for |
573 | + * @param string $messenger |
|
576 | 574 | * @return array|object if creation is succesful then we return an array of info, otherwise an error_object is returned. |
577 | 575 | */ |
578 | 576 | public function create_new_templates( $messenger, $message_type, $GRP_ID = 0, $is_global = false ) { |
@@ -594,6 +592,10 @@ discard block |
||
594 | 592 | return $this->_create_new_templates($GRP_ID, $is_global); |
595 | 593 | } |
596 | 594 | |
595 | + /** |
|
596 | + * @param integer $GRP_ID |
|
597 | + * @param boolean $is_global |
|
598 | + */ |
|
597 | 599 | protected function _create_new_templates($GRP_ID, $is_global) { |
598 | 600 | |
599 | 601 | //if we're creating a custom template then we don't need to use the defaults class |
@@ -713,7 +715,6 @@ discard block |
||
713 | 715 | * |
714 | 716 | * @access public |
715 | 717 | * @param string $type we can indicate just returning installed message types or messengers (or both) via this parameter. |
716 | - * @param bool $set if true then we skip the cache and retrieve via files. |
|
717 | 718 | * @return array multidimensional array of messenger and message_type objects (messengers index, and message_type index); |
718 | 719 | */ |
719 | 720 | public function get_installed( $type = 'all', $skip_cache = false ) { |
@@ -302,7 +302,7 @@ |
||
302 | 302 | * @param string $sending_messenger if included then we ONLY use the specified messenger for delivery. Otherwise we cycle through all active messengers. |
303 | 303 | * @param string $generating_messenger if included then this messenger is used for generating the message templates (but not for sending). |
304 | 304 | * @param string $context If included then only a message type for a specific context will be generated. |
305 | - * @param bool $send Default TRUE. If false, then this will just return the generated EE_Messages objects which might be used by the trigger to setup a batch message (typically html messenger uses it). |
|
305 | + * @param bool $send Default TRUE. If false, then this will just return the generated EE_Messages objects which might be used by the trigger to setup a batch message (typically html messenger uses it). |
|
306 | 306 | * @return bool |
307 | 307 | */ |
308 | 308 | public function send_message( $type, $vars, $sending_messenger = '', $generating_messenger='', $context='', $send = TRUE ) { |
@@ -1,7 +1,8 @@ discard block |
||
1 | 1 | <?php |
2 | 2 | |
3 | -if (!defined('EVENT_ESPRESSO_VERSION') ) |
|
3 | +if (!defined('EVENT_ESPRESSO_VERSION') ) { |
|
4 | 4 | exit('NO direct script access allowed'); |
5 | +} |
|
5 | 6 | |
6 | 7 | /** |
7 | 8 | * Event Espresso |
@@ -90,7 +91,7 @@ discard block |
||
90 | 91 | if( ! isset( $active_messengers[ $messenger_name ] ) ) { |
91 | 92 | $this->activate_messenger( $messenger_name ); |
92 | 93 | return FALSE; |
93 | - }else{ |
|
94 | + } else{ |
|
94 | 95 | return TRUE; |
95 | 96 | } |
96 | 97 | } |
@@ -207,7 +208,9 @@ discard block |
||
207 | 208 | private function _load_files($kind, $actives) { |
208 | 209 | $active_names = array(); |
209 | 210 | $base_path = EE_LIBRARIES . 'messages' . DS . $kind . DS; |
210 | - if ( empty($actives) ) return false; |
|
211 | + if ( empty($actives) ) { |
|
212 | + return false; |
|
213 | + } |
|
211 | 214 | |
212 | 215 | //make sure autoloaders are set (failsafe) |
213 | 216 | EED_Messages::set_autoloaders(); |
@@ -418,8 +421,9 @@ discard block |
||
418 | 421 | if ( isset( $this->_active_messengers[$messenger] ) ) { |
419 | 422 | |
420 | 423 | //we ONLY continue if the given messenger has that message type active with it (note previews only come from primary messengers so no need to check secondarys) |
421 | - if ( !isset( $this->_active_message_types[$messenger][$type] ) ) |
|
422 | - return false; |
|
424 | + if ( !isset( $this->_active_message_types[$messenger][$type] ) ) { |
|
425 | + return false; |
|
426 | + } |
|
423 | 427 | |
424 | 428 | $message = $installed_message_types[$type]; |
425 | 429 | $messenger = $this->_active_messengers[$messenger]; |
@@ -553,8 +557,9 @@ discard block |
||
553 | 557 | |
554 | 558 | |
555 | 559 | //do we have the necessary objects loaded? |
556 | - if ( empty( $this->_messenger) || empty($this->_message_type) ) |
|
557 | - throw new EE_Error( sprintf( __(' The %s messenger or the %s message_type are not active. Are you sure they exist?', 'event_espresso'), $messenger, $message_type ) ); |
|
560 | + if ( empty( $this->_messenger) || empty($this->_message_type) ) { |
|
561 | + throw new EE_Error( sprintf( __(' The %s messenger or the %s message_type are not active. Are you sure they exist?', 'event_espresso'), $messenger, $message_type ) ); |
|
562 | + } |
|
558 | 563 | |
559 | 564 | //is given message_type valid for given messenger (if this is not a global save) |
560 | 565 | $types_to_check = array(); |
@@ -597,8 +602,9 @@ discard block |
||
597 | 602 | protected function _create_new_templates($GRP_ID, $is_global) { |
598 | 603 | |
599 | 604 | //if we're creating a custom template then we don't need to use the defaults class |
600 | - if ( ! $is_global ) |
|
601 | - return $this->_create_custom_template_group( $GRP_ID ); |
|
605 | + if ( ! $is_global ) { |
|
606 | + return $this->_create_custom_template_group( $GRP_ID ); |
|
607 | + } |
|
602 | 608 | |
603 | 609 | $DFLT = new EE_Message_Template_Defaults( $this, $this->_messenger->name, $this->_message_type->name, $GRP_ID ); |
604 | 610 | |
@@ -663,14 +669,16 @@ discard block |
||
663 | 669 | |
664 | 670 | //add new message templates and add relation to. |
665 | 671 | foreach ( $mtts as $mtt ) { |
666 | - if ( ! $mtt instanceof EE_Message_Template ) |
|
667 | - continue; |
|
672 | + if ( ! $mtt instanceof EE_Message_Template ) { |
|
673 | + continue; |
|
674 | + } |
|
668 | 675 | $nmtt = clone $mtt; |
669 | 676 | $nmtt->set('MTP_ID', 0); |
670 | 677 | $nmtt->set( 'GRP_ID', $new_mtg->ID() ); //relation |
671 | 678 | $nmtt->save(); |
672 | - if ( empty( $success['MTP_context'] ) ) |
|
673 | - $success['MTP_context'] = $nmtt->get('MTP_context'); |
|
679 | + if ( empty( $success['MTP_context'] ) ) { |
|
680 | + $success['MTP_context'] = $nmtt->get('MTP_context'); |
|
681 | + } |
|
674 | 682 | } |
675 | 683 | |
676 | 684 | return $success; |
@@ -761,7 +769,9 @@ discard block |
||
761 | 769 | $classname = preg_match("/" . $replace . "/", $filename ) ? str_replace($replace, "", $filename) : false; |
762 | 770 | |
763 | 771 | //no classname? no match? move along, nothing to see here. note, the stripos is checking to make sure the filename (classname) begins with EE. |
764 | - if ( !$classname || 0 !== stripos($classname, 'EE') ) continue; |
|
772 | + if ( !$classname || 0 !== stripos($classname, 'EE') ) { |
|
773 | + continue; |
|
774 | + } |
|
765 | 775 | |
766 | 776 | //note: I'm not sure if this will work without including the file. We do have autoloaders so it "may" work. |
767 | 777 | $a = new ReflectionClass($classname); |
@@ -786,8 +796,9 @@ discard block |
||
786 | 796 | $message_types = array(); |
787 | 797 | foreach ( $this->_active_message_types as $messenger => $mtvalues ) { |
788 | 798 | foreach ( $mtvalues as $mt => $config ) { |
789 | - if ( !in_array( $mt, $message_types ) ) |
|
790 | - $message_types[] = $mt; |
|
799 | + if ( !in_array( $mt, $message_types ) ) { |
|
800 | + $message_types[] = $mt; |
|
801 | + } |
|
791 | 802 | } |
792 | 803 | } |
793 | 804 |
@@ -1,6 +1,6 @@ discard block |
||
1 | 1 | <?php |
2 | 2 | |
3 | -if (!defined('EVENT_ESPRESSO_VERSION') ) |
|
3 | +if ( ! defined('EVENT_ESPRESSO_VERSION')) |
|
4 | 4 | exit('NO direct script access allowed'); |
5 | 5 | |
6 | 6 | /** |
@@ -63,17 +63,17 @@ discard block |
||
63 | 63 | $actives = is_array($_actives) ? array_keys($_actives) : $_actives; |
64 | 64 | $active_names = $this->_load_files('messenger', $actives); |
65 | 65 | |
66 | - if ( is_array($active_names) ) { |
|
67 | - foreach ( $active_names as $name => $class ) { |
|
68 | - $a = new ReflectionClass( $class ); |
|
66 | + if (is_array($active_names)) { |
|
67 | + foreach ($active_names as $name => $class) { |
|
68 | + $a = new ReflectionClass($class); |
|
69 | 69 | $active = $a->newInstance(); |
70 | - if ( is_wp_error($active) ) { |
|
70 | + if (is_wp_error($active)) { |
|
71 | 71 | //we've got an error so let's bubble up the error_object to be caught by caller. |
72 | 72 | //todo: would be better to just catch the errors and then return any aggregated errors later. |
73 | 73 | EE_Error::add_error($active->get_error_message(), __FILE__, __FUNCTION__, __LINE__); |
74 | 74 | } |
75 | 75 | $this->_active_messengers[$name] = $active; |
76 | - $this->_active_message_types[$name] = ! empty( $_actives[$name]['settings'][$name . '-message_types'] ) ? $_actives[$name]['settings'][$name . '-message_types'] : array(); |
|
76 | + $this->_active_message_types[$name] = ! empty($_actives[$name]['settings'][$name.'-message_types']) ? $_actives[$name]['settings'][$name.'-message_types'] : array(); |
|
77 | 77 | } |
78 | 78 | } |
79 | 79 | } |
@@ -84,13 +84,13 @@ discard block |
||
84 | 84 | * @param string $messenger_name |
85 | 85 | * @return boolean TRUE if it was PREVIOUSLY active, and FALSE if it was previously inactive |
86 | 86 | */ |
87 | - public function ensure_messenger_is_active( $messenger_name ){ |
|
87 | + public function ensure_messenger_is_active($messenger_name) { |
|
88 | 88 | //note: active messengers indexed by their names |
89 | 89 | $active_messengers = EEH_MSG_Template::get_active_messengers_in_db(); |
90 | - if( ! isset( $active_messengers[ $messenger_name ] ) ) { |
|
91 | - $this->activate_messenger( $messenger_name ); |
|
90 | + if ( ! isset($active_messengers[$messenger_name])) { |
|
91 | + $this->activate_messenger($messenger_name); |
|
92 | 92 | return FALSE; |
93 | - }else{ |
|
93 | + } else { |
|
94 | 94 | return TRUE; |
95 | 95 | } |
96 | 96 | } |
@@ -105,21 +105,21 @@ discard block |
||
105 | 105 | * |
106 | 106 | * @return boolean true if it got activated (or was active) and false if not. |
107 | 107 | */ |
108 | - public function ensure_message_type_is_active( $message_type, $messenger ) { |
|
108 | + public function ensure_message_type_is_active($message_type, $messenger) { |
|
109 | 109 | //first validate that the incoming messenger allows this message type to be activated. |
110 | 110 | $messengers = $this->get_installed_messengers(); |
111 | - if ( ! isset( $messengers[$messenger] ) ) { |
|
112 | - throw new EE_Error( sprintf( __('The messenger sent to %s is not installed', 'event_espresso'), __METHOD__ ) ); |
|
111 | + if ( ! isset($messengers[$messenger])) { |
|
112 | + throw new EE_Error(sprintf(__('The messenger sent to %s is not installed', 'event_espresso'), __METHOD__)); |
|
113 | 113 | } |
114 | 114 | |
115 | 115 | $msgr = $messengers[$messenger]; |
116 | 116 | $valid_message_types = $msgr->get_valid_message_types(); |
117 | - if ( ! in_array( $message_type, $valid_message_types ) ) { |
|
118 | - throw new EE_Error( sprint_f( __('The message type ($1%s) sent to $2%s is not valid for the $3%s messenger. Doublecheck the spelling and verify that message type has been registered as a valid type with the messenger.', 'event_espresso' ), $message_type, __METHOD__, $messenger ) ); |
|
117 | + if ( ! in_array($message_type, $valid_message_types)) { |
|
118 | + throw new EE_Error(sprint_f(__('The message type ($1%s) sent to $2%s is not valid for the $3%s messenger. Doublecheck the spelling and verify that message type has been registered as a valid type with the messenger.', 'event_espresso'), $message_type, __METHOD__, $messenger)); |
|
119 | 119 | } |
120 | 120 | |
121 | 121 | //all is good so let's just get it active |
122 | - return $this->activate_messenger( $messenger, array( $message_type ) ); |
|
122 | + return $this->activate_messenger($messenger, array($message_type)); |
|
123 | 123 | } |
124 | 124 | |
125 | 125 | /** |
@@ -130,7 +130,7 @@ discard block |
||
130 | 130 | * they are already setup.) |
131 | 131 | * @return boolean an array of generated templates or false if nothing generated/activated. |
132 | 132 | */ |
133 | - public function activate_messenger( $messenger_name, $mts = array() ){ |
|
133 | + public function activate_messenger($messenger_name, $mts = array()) { |
|
134 | 134 | $active_messengers = EEH_MSG_Template::get_active_messengers_in_db(); |
135 | 135 | $message_types = $this->get_installed_message_types(); |
136 | 136 | $installed_messengers = $this->get_installed_messengers(); |
@@ -138,33 +138,33 @@ discard block |
||
138 | 138 | $templates = false; |
139 | 139 | |
140 | 140 | //get has_active so we can be sure its kept up to date. |
141 | - $has_activated = get_option( 'ee_has_activated_messenger' ); |
|
141 | + $has_activated = get_option('ee_has_activated_messenger'); |
|
142 | 142 | |
143 | 143 | //grab the messenger to work with. |
144 | - $messenger = isset( $installed_messengers[$messenger_name] ) ? $installed_messengers[$messenger_name] : null; |
|
144 | + $messenger = isset($installed_messengers[$messenger_name]) ? $installed_messengers[$messenger_name] : null; |
|
145 | 145 | |
146 | 146 | //it's inactive. Activate it. |
147 | 147 | |
148 | - if( $messenger instanceof EE_messenger ) { |
|
149 | - $active_messengers[ $messenger->name ][ 'obj' ] = $messenger; |
|
148 | + if ($messenger instanceof EE_messenger) { |
|
149 | + $active_messengers[$messenger->name]['obj'] = $messenger; |
|
150 | 150 | |
151 | 151 | /** @var EE_messenger[] $installed_messengers */ |
152 | - $mts_to_activate = ! empty( $mts ) ? $mts : $messenger->get_default_message_types(); |
|
153 | - foreach ( $mts_to_activate as $message_type ) { |
|
152 | + $mts_to_activate = ! empty($mts) ? $mts : $messenger->get_default_message_types(); |
|
153 | + foreach ($mts_to_activate as $message_type) { |
|
154 | 154 | //we need to setup any initial settings for message types |
155 | 155 | /** @var EE_message_type[] $installed_mts */ |
156 | - $settings_fields = isset( $message_types[$message_type] ) ? $message_types[ $message_type ]->get_admin_settings_fields() : array(); |
|
157 | - if ( !empty( $settings_fields ) ) { |
|
158 | - foreach ( $settings_fields as $field => $values ) { |
|
159 | - $settings[$field] = $values[ 'default' ]; |
|
156 | + $settings_fields = isset($message_types[$message_type]) ? $message_types[$message_type]->get_admin_settings_fields() : array(); |
|
157 | + if ( ! empty($settings_fields)) { |
|
158 | + foreach ($settings_fields as $field => $values) { |
|
159 | + $settings[$field] = $values['default']; |
|
160 | 160 | } |
161 | 161 | } else { |
162 | 162 | $settings = array(); |
163 | 163 | } |
164 | 164 | |
165 | - $active_messengers[ $messenger->name ][ 'settings' ][ $messenger->name . '-message_types' ][ $message_type ][ 'settings' ] = $settings; |
|
165 | + $active_messengers[$messenger->name]['settings'][$messenger->name.'-message_types'][$message_type]['settings'] = $settings; |
|
166 | 166 | |
167 | - if ( ! empty( $has_activated[$messenger->name] ) && ! in_array( $message_type, $has_activated[$messenger->name] ) ) { |
|
167 | + if ( ! empty($has_activated[$messenger->name]) && ! in_array($message_type, $has_activated[$messenger->name])) { |
|
168 | 168 | $has_activated[$messenger->name][] = $message_type; |
169 | 169 | } |
170 | 170 | } |
@@ -172,22 +172,22 @@ discard block |
||
172 | 172 | //setup any initial settings for the messenger |
173 | 173 | $msgr_settings = $messenger->get_admin_settings_fields(); |
174 | 174 | |
175 | - if ( !empty( $msgr_settings ) ) { |
|
176 | - foreach ( $msgr_settings as $field => $value ) { |
|
177 | - $active_messengers[ $messenger->name ][ 'settings' ][ $field ] = $value; |
|
175 | + if ( ! empty($msgr_settings)) { |
|
176 | + foreach ($msgr_settings as $field => $value) { |
|
177 | + $active_messengers[$messenger->name]['settings'][$field] = $value; |
|
178 | 178 | } |
179 | 179 | } |
180 | 180 | |
181 | - EEH_MSG_Template::update_active_messengers_in_db( $active_messengers ); |
|
182 | - update_option( 'ee_has_activated_messenger', $has_activated ); |
|
181 | + EEH_MSG_Template::update_active_messengers_in_db($active_messengers); |
|
182 | + update_option('ee_has_activated_messenger', $has_activated); |
|
183 | 183 | |
184 | 184 | //make sure that the cached active_messengers is set on this object |
185 | 185 | $this->_active_messengers[$messenger->name] = $messenger; |
186 | 186 | $this->_active_message_types[$messenger->name] = $active_messengers[$messenger->name]; |
187 | 187 | |
188 | 188 | //might need to generate new templates |
189 | - if ( ! empty( $mts_to_activate ) ) { |
|
190 | - $templates = EEH_MSG_Template::generate_new_templates( $messenger->name, $mts_to_activate, 0, TRUE ); |
|
189 | + if ( ! empty($mts_to_activate)) { |
|
190 | + $templates = EEH_MSG_Template::generate_new_templates($messenger->name, $mts_to_activate, 0, TRUE); |
|
191 | 191 | } |
192 | 192 | } |
193 | 193 | |
@@ -206,8 +206,8 @@ discard block |
||
206 | 206 | */ |
207 | 207 | private function _load_files($kind, $actives) { |
208 | 208 | $active_names = array(); |
209 | - $base_path = EE_LIBRARIES . 'messages' . DS . $kind . DS; |
|
210 | - if ( empty($actives) ) return false; |
|
209 | + $base_path = EE_LIBRARIES.'messages'.DS.$kind.DS; |
|
210 | + if (empty($actives)) return false; |
|
211 | 211 | |
212 | 212 | //make sure autoloaders are set (failsafe) |
213 | 213 | EED_Messages::set_autoloaders(); |
@@ -215,18 +215,18 @@ discard block |
||
215 | 215 | //make sure $actives is an array |
216 | 216 | $actives = (array) $actives; |
217 | 217 | |
218 | - EE_Registry::instance()->load_helper( 'File' ); |
|
219 | - foreach ( $actives as $active ) { |
|
220 | - $msg_name = 'EE_' . ucwords( str_replace( ' ', '_', $active) ) . '_' . $kind; |
|
221 | - $filename = $msg_name . '.class.php'; |
|
222 | - $load_file = $base_path . DS . $filename; |
|
223 | - if ( is_readable($load_file) ) { |
|
218 | + EE_Registry::instance()->load_helper('File'); |
|
219 | + foreach ($actives as $active) { |
|
220 | + $msg_name = 'EE_'.ucwords(str_replace(' ', '_', $active)).'_'.$kind; |
|
221 | + $filename = $msg_name.'.class.php'; |
|
222 | + $load_file = $base_path.DS.$filename; |
|
223 | + if (is_readable($load_file)) { |
|
224 | 224 | require_once($load_file); |
225 | 225 | $active_names[$active] = $msg_name; |
226 | 226 | } else { |
227 | 227 | $this->_unset_active($active, $kind); |
228 | 228 | //set WP_Error |
229 | - return EE_Error::add_error( sprintf( __("Missing messages system file set as inactive: (%s) %s has been made inactive.", 'event_espresso'), $load_file, $msg_name), __FILE__, __FUNCTION__, __LINE__ ); |
|
229 | + return EE_Error::add_error(sprintf(__("Missing messages system file set as inactive: (%s) %s has been made inactive.", 'event_espresso'), $load_file, $msg_name), __FILE__, __FUNCTION__, __LINE__); |
|
230 | 230 | } |
231 | 231 | } |
232 | 232 | return $active_names; |
@@ -243,25 +243,25 @@ discard block |
||
243 | 243 | * @param string $kind messenger or message_type? |
244 | 244 | * @return void |
245 | 245 | */ |
246 | - private function _unset_active( $active_name, $kind ) { |
|
246 | + private function _unset_active($active_name, $kind) { |
|
247 | 247 | //pluralize |
248 | 248 | $active_messengers = EEH_MSG_Template::get_active_messengers_in_db(); |
249 | - EE_Registry::instance()->load_helper( 'MSG_Template' ); |
|
250 | - if ( $kind == 'messenger' ) { |
|
251 | - unset( $active_messengers[$active_name] ); |
|
252 | - EEH_MSG_Template::update_to_inactive( $active_name ); |
|
253 | - if ( isset( $this->_active_messengers[$active_name] ) ) { |
|
254 | - unset( $this->_active_messengers[$active_name] ); |
|
249 | + EE_Registry::instance()->load_helper('MSG_Template'); |
|
250 | + if ($kind == 'messenger') { |
|
251 | + unset($active_messengers[$active_name]); |
|
252 | + EEH_MSG_Template::update_to_inactive($active_name); |
|
253 | + if (isset($this->_active_messengers[$active_name])) { |
|
254 | + unset($this->_active_messengers[$active_name]); |
|
255 | 255 | } |
256 | 256 | } else { |
257 | - foreach( $active_messengers as $messenger => $settings ) { |
|
258 | - if ( ! empty( $settings['settings'][$messenger . '-message_types'][$active_name] ) ) { |
|
259 | - unset( $active_messengers[$messenger]['settings'][$messenger . '-message_types'][$active_name] ); |
|
257 | + foreach ($active_messengers as $messenger => $settings) { |
|
258 | + if ( ! empty($settings['settings'][$messenger.'-message_types'][$active_name])) { |
|
259 | + unset($active_messengers[$messenger]['settings'][$messenger.'-message_types'][$active_name]); |
|
260 | 260 | } |
261 | 261 | } |
262 | - EEH_MSG_Template::update_to_inactive( '', $active_name ); |
|
263 | - if ( isset( $this->_active_message_types[$active_name] ) ) { |
|
264 | - unset( $this->_active_message_types[$active_name] ); |
|
262 | + EEH_MSG_Template::update_to_inactive('', $active_name); |
|
263 | + if (isset($this->_active_message_types[$active_name])) { |
|
264 | + unset($this->_active_message_types[$active_name]); |
|
265 | 265 | } |
266 | 266 | } |
267 | 267 | |
@@ -279,13 +279,13 @@ discard block |
||
279 | 279 | * |
280 | 280 | * @return bool true is a generating messenger and can be sent OR FALSE meaning cannot send. |
281 | 281 | */ |
282 | - private function _is_generating_messenger_and_active( EE_messenger $messenger, EE_message_type $message_type ) { |
|
282 | + private function _is_generating_messenger_and_active(EE_messenger $messenger, EE_message_type $message_type) { |
|
283 | 283 | $generating_msgrs = array(); |
284 | 284 | //get the $messengers the message type says it can be used with. |
285 | 285 | $used_with = $message_type->with_messengers(); |
286 | 286 | |
287 | - foreach ( $used_with as $generating_msgr => $secondary_msgrs ) { |
|
288 | - if ( $messenger->name == $generating_msgr && isset( $this->_active_message_types[$generating_msgr][$message_type->name] ) ) { |
|
287 | + foreach ($used_with as $generating_msgr => $secondary_msgrs) { |
|
288 | + if ($messenger->name == $generating_msgr && isset($this->_active_message_types[$generating_msgr][$message_type->name])) { |
|
289 | 289 | return true; |
290 | 290 | } |
291 | 291 | } |
@@ -305,17 +305,17 @@ discard block |
||
305 | 305 | * @param bool $send Default TRUE. If false, then this will just return the generated EE_Messages objects which might be used by the trigger to setup a batch message (typically html messenger uses it). |
306 | 306 | * @return bool |
307 | 307 | */ |
308 | - public function send_message( $type, $vars, $sending_messenger = '', $generating_messenger='', $context='', $send = TRUE ) { |
|
308 | + public function send_message($type, $vars, $sending_messenger = '', $generating_messenger = '', $context = '', $send = TRUE) { |
|
309 | 309 | |
310 | 310 | $error = FALSE; |
311 | 311 | $installed_message_types = $this->get_installed_message_types(); |
312 | - $debug_index = 'Messages: ' . $type; |
|
313 | - foreach ( $vars as $var ) { |
|
314 | - if ( method_exists( $var, 'ID' ) ) { |
|
315 | - $debug_index = get_class( $var ) . ': ' . $var->ID(); |
|
312 | + $debug_index = 'Messages: '.$type; |
|
313 | + foreach ($vars as $var) { |
|
314 | + if (method_exists($var, 'ID')) { |
|
315 | + $debug_index = get_class($var).': '.$var->ID(); |
|
316 | 316 | break; |
317 | - } else if ( is_object( $var )) { |
|
318 | - $debug_index = spl_object_hash( $var ); |
|
317 | + } else if (is_object($var)) { |
|
318 | + $debug_index = spl_object_hash($var); |
|
319 | 319 | } |
320 | 320 | } |
321 | 321 | //EEH_Debug_Tools::log( |
@@ -334,34 +334,34 @@ discard block |
||
334 | 334 | //); |
335 | 335 | |
336 | 336 | // is that a real class ? |
337 | - if ( isset( $installed_message_types[$type] ) ) { |
|
337 | + if (isset($installed_message_types[$type])) { |
|
338 | 338 | //is the messenger specified? If so then let's see if can send. This is the check where its possible secondary messengers might be in use. |
339 | - if ( !empty ( $sending_messenger ) ) { |
|
340 | - $generating_messenger = !empty( $generating_messenger ) && !empty( $this->_active_messengers[$generating_messenger] ) ? $this->_active_messengers[$generating_messenger]: NULL; |
|
341 | - $generating_messenger = empty( $generating_messenger ) && ! empty( $this->_active_messengers[$sending_messenger] ) ? $this->_active_messengers[$sending_messenger] : $generating_messenger; |
|
339 | + if ( ! empty ($sending_messenger)) { |
|
340 | + $generating_messenger = ! empty($generating_messenger) && ! empty($this->_active_messengers[$generating_messenger]) ? $this->_active_messengers[$generating_messenger] : NULL; |
|
341 | + $generating_messenger = empty($generating_messenger) && ! empty($this->_active_messengers[$sending_messenger]) ? $this->_active_messengers[$sending_messenger] : $generating_messenger; |
|
342 | 342 | |
343 | - if ( !$this->_is_generating_messenger_and_active( $generating_messenger, $installed_message_types[$type] ) ) { |
|
343 | + if ( ! $this->_is_generating_messenger_and_active($generating_messenger, $installed_message_types[$type])) { |
|
344 | 344 | return false; |
345 | 345 | } |
346 | - $sending_messenger = ! empty( $this->_active_messengers[$sending_messenger] ) ? $this->_active_messengers[$sending_messenger] : NULL; |
|
346 | + $sending_messenger = ! empty($this->_active_messengers[$sending_messenger]) ? $this->_active_messengers[$sending_messenger] : NULL; |
|
347 | 347 | |
348 | - $context = !empty( $context ) ? $context : FALSE; |
|
349 | - $success = $this->_send_message( $generating_messenger, $installed_message_types[$type], $vars, $sending_messenger, $context, $send ); |
|
350 | - if ( ! $send ) { |
|
348 | + $context = ! empty($context) ? $context : FALSE; |
|
349 | + $success = $this->_send_message($generating_messenger, $installed_message_types[$type], $vars, $sending_messenger, $context, $send); |
|
350 | + if ( ! $send) { |
|
351 | 351 | return $success; //returning generated EE_Messages objects |
352 | 352 | } |
353 | 353 | } else { |
354 | 354 | //no messenger sent so let's just loop through active messengers (this method is only acceptable for primary messengers) |
355 | 355 | $send_messages = array(); |
356 | - foreach ( $this->_active_messengers as $active_messenger ) { |
|
356 | + foreach ($this->_active_messengers as $active_messenger) { |
|
357 | 357 | |
358 | 358 | //we ONLY continue if the given messenger is a primary messenger and is an active messenger for the given message type. Otherwise we skip. |
359 | - if ( ! $this->_is_generating_messenger_and_active( $active_messenger, $installed_message_types[$type] ) ) { |
|
359 | + if ( ! $this->_is_generating_messenger_and_active($active_messenger, $installed_message_types[$type])) { |
|
360 | 360 | continue; |
361 | 361 | } |
362 | 362 | |
363 | - $success = $this->_send_message( $active_messenger, $installed_message_types[$type], $vars, $active_messenger ); |
|
364 | - if ( $success === FALSE ) { |
|
363 | + $success = $this->_send_message($active_messenger, $installed_message_types[$type], $vars, $active_messenger); |
|
364 | + if ($success === FALSE) { |
|
365 | 365 | $error = TRUE; |
366 | 366 | } else { |
367 | 367 | $send_messages[] = $success; |
@@ -381,17 +381,17 @@ discard block |
||
381 | 381 | // ); |
382 | 382 | |
383 | 383 | //return generated EE_Messages objects? |
384 | - if ( ! $send ) { |
|
384 | + if ( ! $send) { |
|
385 | 385 | return $send_messages; |
386 | 386 | } |
387 | 387 | } |
388 | 388 | } else { |
389 | - EE_Error::add_error( sprintf( __('Message type: %s does not exist', 'event_espresso'), $type ), __FILE__, __FUNCTION__, __LINE__ ); |
|
389 | + EE_Error::add_error(sprintf(__('Message type: %s does not exist', 'event_espresso'), $type), __FILE__, __FUNCTION__, __LINE__); |
|
390 | 390 | return false; |
391 | 391 | } |
392 | 392 | // add a success message |
393 | - if ( ! $error ) { |
|
394 | - EE_Error::add_success( sprintf( __( 'The %s message has been successfully sent.', 'event_espresso'), $installed_message_types[$type]->label['singular'] ), __FILE__, __FUNCTION__, __LINE__ ); |
|
393 | + if ( ! $error) { |
|
394 | + EE_Error::add_success(sprintf(__('The %s message has been successfully sent.', 'event_espresso'), $installed_message_types[$type]->label['singular']), __FILE__, __FUNCTION__, __LINE__); |
|
395 | 395 | } |
396 | 396 | |
397 | 397 | return $error ? FALSE : TRUE; //yeah backwards eh? Really what we're returning is if there is a total success for all the messages or not. We'll modify this once we get message recording in place. |
@@ -408,35 +408,35 @@ discard block |
||
408 | 408 | * @param bool $send true we will do a test send using the messenger delivery, false we just do a regular preview |
409 | 409 | * @return string The body of the message. |
410 | 410 | */ |
411 | - public function preview_message( $type, $context, $messenger, $send = FALSE ) { |
|
411 | + public function preview_message($type, $context, $messenger, $send = FALSE) { |
|
412 | 412 | |
413 | 413 | $installed_message_types = $this->get_installed_message_types(); |
414 | 414 | |
415 | 415 | //does the given type match an actual message type class. |
416 | - if ( isset( $installed_message_types[$type] ) ) { |
|
416 | + if (isset($installed_message_types[$type])) { |
|
417 | 417 | // valid messenger? |
418 | - if ( isset( $this->_active_messengers[$messenger] ) ) { |
|
418 | + if (isset($this->_active_messengers[$messenger])) { |
|
419 | 419 | |
420 | 420 | //we ONLY continue if the given messenger has that message type active with it (note previews only come from primary messengers so no need to check secondarys) |
421 | - if ( !isset( $this->_active_message_types[$messenger][$type] ) ) |
|
421 | + if ( ! isset($this->_active_message_types[$messenger][$type])) |
|
422 | 422 | return false; |
423 | 423 | |
424 | 424 | $message = $installed_message_types[$type]; |
425 | 425 | $messenger = $this->_active_messengers[$messenger]; |
426 | 426 | |
427 | 427 | //set data for preview |
428 | - $message->set_messages( array(), $messenger, $context, TRUE ); |
|
428 | + $message->set_messages(array(), $messenger, $context, TRUE); |
|
429 | 429 | |
430 | 430 | //let's GET the message body from the messenger (instead of the normal send_message) |
431 | - return $messenger->get_preview( $message->messages[0], $message, $send ); |
|
431 | + return $messenger->get_preview($message->messages[0], $message, $send); |
|
432 | 432 | |
433 | 433 | } else { |
434 | - EE_Error::add_error( sprintf( __('Messenger: %s does not exist', 'event_espresso'), $messenger ), __FILE__, __FUNCTION__, __LINE__ ); |
|
434 | + EE_Error::add_error(sprintf(__('Messenger: %s does not exist', 'event_espresso'), $messenger), __FILE__, __FUNCTION__, __LINE__); |
|
435 | 435 | return FALSE; |
436 | 436 | } |
437 | 437 | |
438 | 438 | } else { |
439 | - EE_Error::add_error( sprintf( __('Message type: %s does not exist', 'event_espresso'), $type ), __FILE__, __FUNCTION__, __LINE__ ); |
|
439 | + EE_Error::add_error(sprintf(__('Message type: %s does not exist', 'event_espresso'), $type), __FILE__, __FUNCTION__, __LINE__); |
|
440 | 440 | return FALSE; |
441 | 441 | } |
442 | 442 | |
@@ -457,22 +457,22 @@ discard block |
||
457 | 457 | * |
458 | 458 | * @return mixed(bool|std_Class[]) |
459 | 459 | */ |
460 | - private function _send_message( EE_messenger $generating_messenger, EE_message_type $message_type, $data, EE_messenger $sending_messenger, $context = FALSE, $send = TRUE ) { |
|
460 | + private function _send_message(EE_messenger $generating_messenger, EE_message_type $message_type, $data, EE_messenger $sending_messenger, $context = FALSE, $send = TRUE) { |
|
461 | 461 | //can't even get started yo! |
462 | - if ( $message_type === FALSE || is_wp_error( $message_type ) || $message_type->set_messages( $data, $generating_messenger, $context ) === FALSE ) { |
|
462 | + if ($message_type === FALSE || is_wp_error($message_type) || $message_type->set_messages($data, $generating_messenger, $context) === FALSE) { |
|
463 | 463 | return FALSE; |
464 | 464 | } |
465 | 465 | // if the generating messenger and the sending messengers are different... |
466 | 466 | // then are there any hooks that the generating messenger sets for the sending messenger (i.e. css file swap outs etc.) |
467 | - if ( $sending_messenger != $generating_messenger ) { |
|
468 | - $generating_messenger->do_secondary_messenger_hooks( $sending_messenger->name ); |
|
467 | + if ($sending_messenger != $generating_messenger) { |
|
468 | + $generating_messenger->do_secondary_messenger_hooks($sending_messenger->name); |
|
469 | 469 | } |
470 | 470 | //it is possible that the user has the messenger turned off for this type. |
471 | - if ( $message_type->count === 0 ) { |
|
471 | + if ($message_type->count === 0) { |
|
472 | 472 | return FALSE; |
473 | 473 | } |
474 | 474 | //are we just sending the EE_Messages stdClass objects back? |
475 | - if ( ! $send ) { |
|
475 | + if ( ! $send) { |
|
476 | 476 | return $message_type->messages; |
477 | 477 | } |
478 | 478 | //TODO: check count (at some point we'll use this to decide whether we send to queue or not i.e. |
@@ -480,12 +480,12 @@ discard block |
||
480 | 480 | //else... |
481 | 481 | $success = TRUE; |
482 | 482 | // $success is a flag for the loop. If there is NO error then everything is a success (true) otherwise it wasn't a success (false) |
483 | - foreach ( $message_type->messages as $message ) { |
|
483 | + foreach ($message_type->messages as $message) { |
|
484 | 484 | //todo: should we do some reporting on messages gone out at some point? I think we could have the $active_messenger object return bool for whether message was sent or not and we can compile a report based on that. |
485 | 485 | // if messages send successfully then $success retains it's value, but a single fail will toggle it to FALSE |
486 | - $success = $sending_messenger->send_message( $message, $message_type ) === TRUE ? $success : FALSE; |
|
486 | + $success = $sending_messenger->send_message($message, $message_type) === TRUE ? $success : FALSE; |
|
487 | 487 | } |
488 | - unset( $message_type ); |
|
488 | + unset($message_type); |
|
489 | 489 | return $success; |
490 | 490 | } |
491 | 491 | |
@@ -504,24 +504,24 @@ discard block |
||
504 | 504 | * |
505 | 505 | * @return bool success or fail. |
506 | 506 | */ |
507 | - public function send_message_with_messenger_only( $messenger, $message_type, $message ) { |
|
507 | + public function send_message_with_messenger_only($messenger, $message_type, $message) { |
|
508 | 508 | |
509 | 509 | //get EE_messenger object (which also checks if its active) |
510 | - $msgr = !empty( $messenger ) && !empty( $this->_active_messengers[$messenger] ) ? $this->_active_messengers[$messenger]: NULL; |
|
510 | + $msgr = ! empty($messenger) && ! empty($this->_active_messengers[$messenger]) ? $this->_active_messengers[$messenger] : NULL; |
|
511 | 511 | $installed_message_types = $this->get_installed_message_types(); |
512 | 512 | |
513 | - if ( ! $msgr instanceof EE_messenger ) { |
|
513 | + if ( ! $msgr instanceof EE_messenger) { |
|
514 | 514 | return false; //can't do anything without a valid messenger. |
515 | 515 | } |
516 | 516 | |
517 | 517 | //check valid message type |
518 | - $mtype = isset( $installed_message_types[$message_type] ) ? $installed_message_types[$message_type] : NULL; |
|
518 | + $mtype = isset($installed_message_types[$message_type]) ? $installed_message_types[$message_type] : NULL; |
|
519 | 519 | |
520 | - if( ! $mtype instanceof EE_message_type ) { |
|
520 | + if ( ! $mtype instanceof EE_message_type) { |
|
521 | 521 | return false; //can't do anything without a valid message type. |
522 | 522 | } |
523 | 523 | |
524 | - return $msgr->send_message( $message, $mtype ); |
|
524 | + return $msgr->send_message($message, $mtype); |
|
525 | 525 | } |
526 | 526 | |
527 | 527 | |
@@ -537,7 +537,7 @@ discard block |
||
537 | 537 | */ |
538 | 538 | private function _validate_setup($messenger, $message_type, $is_global = FALSE) { |
539 | 539 | |
540 | - $message_type = strtolower(str_replace(' ', '_', $message_type) ); |
|
540 | + $message_type = strtolower(str_replace(' ', '_', $message_type)); |
|
541 | 541 | $messenger = strtolower(str_replace(' ', '_', $messenger)); |
542 | 542 | $installed_message_types = $this->get_installed_message_types(); |
543 | 543 | |
@@ -553,16 +553,16 @@ discard block |
||
553 | 553 | |
554 | 554 | |
555 | 555 | //do we have the necessary objects loaded? |
556 | - if ( empty( $this->_messenger) || empty($this->_message_type) ) |
|
557 | - throw new EE_Error( sprintf( __(' The %s messenger or the %s message_type are not active. Are you sure they exist?', 'event_espresso'), $messenger, $message_type ) ); |
|
556 | + if (empty($this->_messenger) || empty($this->_message_type)) |
|
557 | + throw new EE_Error(sprintf(__(' The %s messenger or the %s message_type are not active. Are you sure they exist?', 'event_espresso'), $messenger, $message_type)); |
|
558 | 558 | |
559 | 559 | //is given message_type valid for given messenger (if this is not a global save) |
560 | 560 | $types_to_check = array(); |
561 | - if ( !$is_global ) { |
|
562 | - $has_active = EEM_Message_Template_Group::instance()->count( array( array( 'MTP_is_active' => TRUE, 'MTP_messenger' => $this->_messenger->name, 'MTP_message_type' => $message_type ) ) ); |
|
561 | + if ( ! $is_global) { |
|
562 | + $has_active = EEM_Message_Template_Group::instance()->count(array(array('MTP_is_active' => TRUE, 'MTP_messenger' => $this->_messenger->name, 'MTP_message_type' => $message_type))); |
|
563 | 563 | |
564 | - if ( $has_active == 0 ) { |
|
565 | - EE_Error::add_error( sprintf(__(' The %s message type is not registered with the %s messenger. Please visit the Messenger activation page to assign this message type first if you want to use it.', 'event_espresso'), $message_type, $messenger), __FILE__, __FUNCTION__, __LINE__ ); |
|
564 | + if ($has_active == 0) { |
|
565 | + EE_Error::add_error(sprintf(__(' The %s message type is not registered with the %s messenger. Please visit the Messenger activation page to assign this message type first if you want to use it.', 'event_espresso'), $message_type, $messenger), __FILE__, __FUNCTION__, __LINE__); |
|
566 | 566 | return false; |
567 | 567 | } |
568 | 568 | |
@@ -575,17 +575,17 @@ discard block |
||
575 | 575 | * @param string $message_type message type that the templates are being created for |
576 | 576 | * @return array|object if creation is succesful then we return an array of info, otherwise an error_object is returned. |
577 | 577 | */ |
578 | - public function create_new_templates( $messenger, $message_type, $GRP_ID = 0, $is_global = false ) { |
|
578 | + public function create_new_templates($messenger, $message_type, $GRP_ID = 0, $is_global = false) { |
|
579 | 579 | $valid_mt = false; |
580 | 580 | |
581 | 581 | $valid_mt = $this->_validate_setup($messenger, $message_type, $is_global); |
582 | 582 | |
583 | - if ( is_wp_error($valid_mt) && $is_global ) { |
|
583 | + if (is_wp_error($valid_mt) && $is_global) { |
|
584 | 584 | //we're setting up a brand new global templates (with messenger activation) so we're assuming that the message types sent in are valid. |
585 | 585 | $valid_mt = true; |
586 | 586 | } |
587 | 587 | |
588 | - if ( is_wp_error($valid_mt) ) { |
|
588 | + if (is_wp_error($valid_mt)) { |
|
589 | 589 | //if we've still got no valid_mt then bubble up error object |
590 | 590 | return $valid_mt; |
591 | 591 | } |
@@ -597,10 +597,10 @@ discard block |
||
597 | 597 | protected function _create_new_templates($GRP_ID, $is_global) { |
598 | 598 | |
599 | 599 | //if we're creating a custom template then we don't need to use the defaults class |
600 | - if ( ! $is_global ) |
|
601 | - return $this->_create_custom_template_group( $GRP_ID ); |
|
600 | + if ( ! $is_global) |
|
601 | + return $this->_create_custom_template_group($GRP_ID); |
|
602 | 602 | |
603 | - $DFLT = new EE_Message_Template_Defaults( $this, $this->_messenger->name, $this->_message_type->name, $GRP_ID ); |
|
603 | + $DFLT = new EE_Message_Template_Defaults($this, $this->_messenger->name, $this->_message_type->name, $GRP_ID); |
|
604 | 604 | |
605 | 605 | //generate templates |
606 | 606 | $success = $DFLT->create_new_templates(); |
@@ -628,16 +628,16 @@ discard block |
||
628 | 628 | * ) |
629 | 629 | * @access private |
630 | 630 | */ |
631 | - private function _create_custom_template_group( $GRP_ID ) { |
|
631 | + private function _create_custom_template_group($GRP_ID) { |
|
632 | 632 | //defaults |
633 | - $success = array( 'GRP_ID' => NULL, 'MTP_context' => '' ); |
|
633 | + $success = array('GRP_ID' => NULL, 'MTP_context' => ''); |
|
634 | 634 | |
635 | 635 | //get the template group to use as a template from the db. If $GRP_ID is empty then we'll assume the base will be the global template matching the messenger and message type. |
636 | - $mtg = empty( $GRP_ID ) ? EEM_Message_Template_Group::instance()->get_one( array( array( 'MTP_messenger' => $this->_messenger->name, 'MTP_message_type' => $this->_message_type->name, 'MTP_is_global' => TRUE ) ) ) : EEM_Message_Template_Group::instance()->get_one_by_ID( $GRP_ID ); |
|
636 | + $mtg = empty($GRP_ID) ? EEM_Message_Template_Group::instance()->get_one(array(array('MTP_messenger' => $this->_messenger->name, 'MTP_message_type' => $this->_message_type->name, 'MTP_is_global' => TRUE))) : EEM_Message_Template_Group::instance()->get_one_by_ID($GRP_ID); |
|
637 | 637 | |
638 | 638 | //if we don't have a mtg at this point then we need to bail. |
639 | - if ( ! $mtg instanceof EE_Message_Template_Group ) { |
|
640 | - EE_Error::add_error( sprintf( __('Something went wrong with generating the custom template from this group id: %s. This usually happens when there is no matching message template group in the db.', 'event_espresso'), $GRP_ID ), __FILE__, __FUNCTION__, __LINE__ ); |
|
639 | + if ( ! $mtg instanceof EE_Message_Template_Group) { |
|
640 | + EE_Error::add_error(sprintf(__('Something went wrong with generating the custom template from this group id: %s. This usually happens when there is no matching message template group in the db.', 'event_espresso'), $GRP_ID), __FILE__, __FUNCTION__, __LINE__); |
|
641 | 641 | return $success; |
642 | 642 | } |
643 | 643 | |
@@ -649,27 +649,27 @@ discard block |
||
649 | 649 | $new_mtg->set('GRP_ID', 0); |
650 | 650 | $new_mtg->set('MTP_is_global', FALSE); |
651 | 651 | |
652 | - $template_name = defined('DOING_AJAX') && !empty( $_POST['templateName'] ) ? $_POST['templateName'] : __('New Custom Template', 'event_espresso'); |
|
653 | - $template_description = defined("DOING_AJAX") && !empty( $_POST['templateDescription'] ) ? $_POST['templateDescription'] : sprintf( __('This is a custom template that was created for the %s messenger and %s message type.', 'event_espresso' ), $new_mtg->messenger_obj()->label['singular'], $new_mtg->message_type_obj()->label['singular'] ); |
|
652 | + $template_name = defined('DOING_AJAX') && ! empty($_POST['templateName']) ? $_POST['templateName'] : __('New Custom Template', 'event_espresso'); |
|
653 | + $template_description = defined("DOING_AJAX") && ! empty($_POST['templateDescription']) ? $_POST['templateDescription'] : sprintf(__('This is a custom template that was created for the %s messenger and %s message type.', 'event_espresso'), $new_mtg->messenger_obj()->label['singular'], $new_mtg->message_type_obj()->label['singular']); |
|
654 | 654 | |
655 | 655 | |
656 | - $new_mtg->set('MTP_name', $template_name ); |
|
657 | - $new_mtg->set('MTP_description', $template_description ); |
|
656 | + $new_mtg->set('MTP_name', $template_name); |
|
657 | + $new_mtg->set('MTP_description', $template_description); |
|
658 | 658 | //remove ALL relations on this template group so they don't get saved! |
659 | - $new_mtg->_remove_relations( 'Message_Template' ); |
|
659 | + $new_mtg->_remove_relations('Message_Template'); |
|
660 | 660 | $new_mtg->save(); |
661 | 661 | $success['GRP_ID'] = $new_mtg->ID(); |
662 | 662 | $success['template_name'] = $template_name; |
663 | 663 | |
664 | 664 | //add new message templates and add relation to. |
665 | - foreach ( $mtts as $mtt ) { |
|
666 | - if ( ! $mtt instanceof EE_Message_Template ) |
|
665 | + foreach ($mtts as $mtt) { |
|
666 | + if ( ! $mtt instanceof EE_Message_Template) |
|
667 | 667 | continue; |
668 | 668 | $nmtt = clone $mtt; |
669 | 669 | $nmtt->set('MTP_ID', 0); |
670 | - $nmtt->set( 'GRP_ID', $new_mtg->ID() ); //relation |
|
670 | + $nmtt->set('GRP_ID', $new_mtg->ID()); //relation |
|
671 | 671 | $nmtt->save(); |
672 | - if ( empty( $success['MTP_context'] ) ) |
|
672 | + if (empty($success['MTP_context'])) |
|
673 | 673 | $success['MTP_context'] = $nmtt->get('MTP_context'); |
674 | 674 | } |
675 | 675 | |
@@ -694,14 +694,14 @@ discard block |
||
694 | 694 | |
695 | 695 | |
696 | 696 | //okay now let's assemble an array with the messenger template fields added to the message_type contexts. |
697 | - foreach ( $this->_message_type->get_contexts() as $context => $details ) { |
|
698 | - foreach ( $this->_messenger->get_template_fields() as $field => $value ) { |
|
697 | + foreach ($this->_message_type->get_contexts() as $context => $details) { |
|
698 | + foreach ($this->_messenger->get_template_fields() as $field => $value) { |
|
699 | 699 | $template_fields[$context][$field] = $value; |
700 | 700 | } |
701 | 701 | } |
702 | 702 | |
703 | - if ( empty($template_fields) ) { |
|
704 | - EE_Error::add_error( __('Something went wrong and we couldn\'t get any templates assembled', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__ ); |
|
703 | + if (empty($template_fields)) { |
|
704 | + EE_Error::add_error(__('Something went wrong and we couldn\'t get any templates assembled', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__); |
|
705 | 705 | return FALSE; |
706 | 706 | } |
707 | 707 | |
@@ -716,30 +716,30 @@ discard block |
||
716 | 716 | * @param bool $set if true then we skip the cache and retrieve via files. |
717 | 717 | * @return array multidimensional array of messenger and message_type objects (messengers index, and message_type index); |
718 | 718 | */ |
719 | - public function get_installed( $type = 'all', $skip_cache = false ) { |
|
719 | + public function get_installed($type = 'all', $skip_cache = false) { |
|
720 | 720 | $installed = array(); |
721 | 721 | |
722 | 722 | //first let's account for caching |
723 | - if ( $skip_cache ) { |
|
724 | - $message_base = EE_LIBRARIES . "messages" . DS; |
|
723 | + if ($skip_cache) { |
|
724 | + $message_base = EE_LIBRARIES."messages".DS; |
|
725 | 725 | |
726 | - $messenger_files = $type == 'all' || $type == 'messengers' ? scandir( $message_base . "messenger", 1) : NULL; |
|
727 | - $messagetype_files = $type == 'all' || $type == 'message_types' ? scandir( $message_base . "message_type", 1) : NULL; |
|
726 | + $messenger_files = $type == 'all' || $type == 'messengers' ? scandir($message_base."messenger", 1) : NULL; |
|
727 | + $messagetype_files = $type == 'all' || $type == 'message_types' ? scandir($message_base."message_type", 1) : NULL; |
|
728 | 728 | |
729 | 729 | |
730 | 730 | //allow plugins to filter in their messenger/message_type files |
731 | - $messenger_files = apply_filters('FHEE__EE_messages__get_installed__messenger_files', $messenger_files, $type ); |
|
732 | - $messagetype_files = apply_filters('FHEE__EE_messages__get_installed__messagetype_files', $messagetype_files, $type ); |
|
731 | + $messenger_files = apply_filters('FHEE__EE_messages__get_installed__messenger_files', $messenger_files, $type); |
|
732 | + $messagetype_files = apply_filters('FHEE__EE_messages__get_installed__messagetype_files', $messagetype_files, $type); |
|
733 | 733 | |
734 | - $installed['messengers'] = !empty($messenger_files ) ? $this->_get_installed($messenger_files) : ''; |
|
735 | - $installed['message_types'] = !empty($messagetype_files) ? $this->_get_installed($messagetype_files) : ''; |
|
734 | + $installed['messengers'] = ! empty($messenger_files) ? $this->_get_installed($messenger_files) : ''; |
|
735 | + $installed['message_types'] = ! empty($messagetype_files) ? $this->_get_installed($messagetype_files) : ''; |
|
736 | 736 | } else { |
737 | 737 | $installed['messengers'] = $this->get_installed_messengers(); |
738 | 738 | $installed['message_types'] = $this->get_installed_message_types(); |
739 | 739 | } |
740 | 740 | |
741 | 741 | |
742 | - if ( $type != 'all' ) { |
|
742 | + if ($type != 'all') { |
|
743 | 743 | $installed = $type == 'messengers' ? $installed['messengers'] : $installed['message_types']; |
744 | 744 | } |
745 | 745 | |
@@ -757,11 +757,11 @@ discard block |
||
757 | 757 | $the_goods = array(); |
758 | 758 | $filenames = (array) $filenames; |
759 | 759 | $replace = ".class.php"; |
760 | - foreach ( $filenames as $filename ) { |
|
761 | - $classname = preg_match("/" . $replace . "/", $filename ) ? str_replace($replace, "", $filename) : false; |
|
760 | + foreach ($filenames as $filename) { |
|
761 | + $classname = preg_match("/".$replace."/", $filename) ? str_replace($replace, "", $filename) : false; |
|
762 | 762 | |
763 | 763 | //no classname? no match? move along, nothing to see here. note, the stripos is checking to make sure the filename (classname) begins with EE. |
764 | - if ( !$classname || 0 !== stripos($classname, 'EE') ) continue; |
|
764 | + if ( ! $classname || 0 !== stripos($classname, 'EE')) continue; |
|
765 | 765 | |
766 | 766 | //note: I'm not sure if this will work without including the file. We do have autoloaders so it "may" work. |
767 | 767 | $a = new ReflectionClass($classname); |
@@ -784,9 +784,9 @@ discard block |
||
784 | 784 | */ |
785 | 785 | public function get_active_message_types() { |
786 | 786 | $message_types = array(); |
787 | - foreach ( $this->_active_message_types as $messenger => $mtvalues ) { |
|
788 | - foreach ( $mtvalues as $mt => $config ) { |
|
789 | - if ( !in_array( $mt, $message_types ) ) |
|
787 | + foreach ($this->_active_message_types as $messenger => $mtvalues) { |
|
788 | + foreach ($mtvalues as $mt => $config) { |
|
789 | + if ( ! in_array($mt, $message_types)) |
|
790 | 790 | $message_types[] = $mt; |
791 | 791 | } |
792 | 792 | } |
@@ -806,17 +806,17 @@ discard block |
||
806 | 806 | * |
807 | 807 | * @return EE_message_type[] (or empty array if none present) |
808 | 808 | */ |
809 | - public function get_active_message_types_per_messenger( $messenger ) { |
|
809 | + public function get_active_message_types_per_messenger($messenger) { |
|
810 | 810 | $messenger = (string) $messenger; |
811 | - if ( empty( $this->_active_message_types[$messenger] ) ) { |
|
811 | + if (empty($this->_active_message_types[$messenger])) { |
|
812 | 812 | return array(); |
813 | 813 | } |
814 | 814 | |
815 | 815 | $mts = array(); |
816 | 816 | $message_types = $this->_active_message_types[$messenger]; |
817 | 817 | $installed_message_types = $this->get_installed_message_types(); |
818 | - foreach ( $message_types as $mt => $settings ) { |
|
819 | - if ( ! empty( $installed_message_types[$mt] ) ) { |
|
818 | + foreach ($message_types as $mt => $settings) { |
|
819 | + if ( ! empty($installed_message_types[$mt])) { |
|
820 | 820 | $mts[] = $installed_message_types[$mt]; |
821 | 821 | } |
822 | 822 | } |
@@ -833,9 +833,9 @@ discard block |
||
833 | 833 | * |
834 | 834 | * @return EE_Message_Type|null |
835 | 835 | */ |
836 | - public function get_active_message_type( $messenger, $message_type ) { |
|
836 | + public function get_active_message_type($messenger, $message_type) { |
|
837 | 837 | $installed_message_types = $this->get_installed_message_types(); |
838 | - if ( !empty( $this->_active_message_types[$messenger][$message_type] ) && !empty( $installed_message_types[$message_type] ) ) { |
|
838 | + if ( ! empty($this->_active_message_types[$messenger][$message_type]) && ! empty($installed_message_types[$message_type])) { |
|
839 | 839 | return $installed_message_types[$message_type]; |
840 | 840 | } |
841 | 841 | return NULL; |
@@ -844,13 +844,13 @@ discard block |
||
844 | 844 | |
845 | 845 | |
846 | 846 | public function get_installed_message_types() { |
847 | - $this->_installed_message_types = empty( $this->_installed_message_types ) ? $this->get_installed( 'message_types', true ) : $this->_installed_message_types; |
|
847 | + $this->_installed_message_types = empty($this->_installed_message_types) ? $this->get_installed('message_types', true) : $this->_installed_message_types; |
|
848 | 848 | return $this->_installed_message_types; |
849 | 849 | } |
850 | 850 | |
851 | 851 | |
852 | 852 | public function get_installed_messengers() { |
853 | - $this->_installed_messengers = empty( $this->_installed_messengers ) ? $this->get_installed( 'messengers', true ) : $this->_installed_messengers; |
|
853 | + $this->_installed_messengers = empty($this->_installed_messengers) ? $this->get_installed('messengers', true) : $this->_installed_messengers; |
|
854 | 854 | return $this->_installed_messengers; |
855 | 855 | } |
856 | 856 | } |