@@ -19,59 +19,59 @@ |
||
19 | 19 | class RequestStack |
20 | 20 | { |
21 | 21 | |
22 | - /** |
|
23 | - * @var RequestDecoratorInterface $request_stack_app |
|
24 | - */ |
|
25 | - protected $request_stack_app; |
|
22 | + /** |
|
23 | + * @var RequestDecoratorInterface $request_stack_app |
|
24 | + */ |
|
25 | + protected $request_stack_app; |
|
26 | 26 | |
27 | - /** |
|
28 | - * @var RequestStackCoreAppInterface $core_app |
|
29 | - */ |
|
30 | - protected $core_app; |
|
27 | + /** |
|
28 | + * @var RequestStackCoreAppInterface $core_app |
|
29 | + */ |
|
30 | + protected $core_app; |
|
31 | 31 | |
32 | - /** |
|
33 | - * @var RequestInterface $request |
|
34 | - */ |
|
35 | - protected $request; |
|
32 | + /** |
|
33 | + * @var RequestInterface $request |
|
34 | + */ |
|
35 | + protected $request; |
|
36 | 36 | |
37 | - /** |
|
38 | - * @var ResponseInterface $response |
|
39 | - */ |
|
40 | - protected $response; |
|
37 | + /** |
|
38 | + * @var ResponseInterface $response |
|
39 | + */ |
|
40 | + protected $response; |
|
41 | 41 | |
42 | 42 | |
43 | - /** |
|
44 | - * @param RequestDecoratorInterface $request_stack_app |
|
45 | - * @param RequestStackCoreAppInterface $core_app |
|
46 | - */ |
|
47 | - public function __construct(RequestDecoratorInterface $request_stack_app, RequestStackCoreAppInterface $core_app) |
|
48 | - { |
|
49 | - $this->request_stack_app = $request_stack_app; |
|
50 | - $this->core_app = $core_app; |
|
51 | - } |
|
43 | + /** |
|
44 | + * @param RequestDecoratorInterface $request_stack_app |
|
45 | + * @param RequestStackCoreAppInterface $core_app |
|
46 | + */ |
|
47 | + public function __construct(RequestDecoratorInterface $request_stack_app, RequestStackCoreAppInterface $core_app) |
|
48 | + { |
|
49 | + $this->request_stack_app = $request_stack_app; |
|
50 | + $this->core_app = $core_app; |
|
51 | + } |
|
52 | 52 | |
53 | 53 | |
54 | - /** |
|
55 | - * @param RequestInterface $request |
|
56 | - * @param ResponseInterface $response |
|
57 | - * @return ResponseInterface |
|
58 | - */ |
|
59 | - public function handleRequest(RequestInterface $request, ResponseInterface $response) |
|
60 | - { |
|
61 | - $this->request = $request; |
|
62 | - $this->response = $response; |
|
63 | - return $this->request_stack_app->handleRequest($request, $response); |
|
64 | - } |
|
54 | + /** |
|
55 | + * @param RequestInterface $request |
|
56 | + * @param ResponseInterface $response |
|
57 | + * @return ResponseInterface |
|
58 | + */ |
|
59 | + public function handleRequest(RequestInterface $request, ResponseInterface $response) |
|
60 | + { |
|
61 | + $this->request = $request; |
|
62 | + $this->response = $response; |
|
63 | + return $this->request_stack_app->handleRequest($request, $response); |
|
64 | + } |
|
65 | 65 | |
66 | 66 | |
67 | - /** |
|
68 | - * handle_response |
|
69 | - * executes the handle_response() method on the RequestStackCoreAppInterface object |
|
70 | - * after the request stack has been fully processed |
|
71 | - */ |
|
72 | - public function handleResponse() |
|
73 | - { |
|
74 | - $this->core_app->handleResponse($this->request, $this->response); |
|
75 | - } |
|
67 | + /** |
|
68 | + * handle_response |
|
69 | + * executes the handle_response() method on the RequestStackCoreAppInterface object |
|
70 | + * after the request stack has been fully processed |
|
71 | + */ |
|
72 | + public function handleResponse() |
|
73 | + { |
|
74 | + $this->core_app->handleResponse($this->request, $this->response); |
|
75 | + } |
|
76 | 76 | } |
77 | 77 | // Location: RequestStack.php |
@@ -47,7 +47,7 @@ |
||
47 | 47 | public function __construct(RequestDecoratorInterface $request_stack_app, RequestStackCoreAppInterface $core_app) |
48 | 48 | { |
49 | 49 | $this->request_stack_app = $request_stack_app; |
50 | - $this->core_app = $core_app; |
|
50 | + $this->core_app = $core_app; |
|
51 | 51 | } |
52 | 52 | |
53 | 53 |
@@ -9,51 +9,51 @@ |
||
9 | 9 | class CollectionFilterCallbackIterator extends FilterIterator |
10 | 10 | { |
11 | 11 | |
12 | - /** |
|
13 | - * Used for determining whether the iterated object in the Collection is "valid" or not. |
|
14 | - * @var Closure |
|
15 | - */ |
|
16 | - private $acceptance_callback; |
|
17 | - |
|
18 | - |
|
19 | - /** |
|
20 | - * CollectionFilterCallbackIterator constructor. |
|
21 | - * |
|
22 | - * @param Collection $collection |
|
23 | - * @param Closure $acceptance_callback The closure will receive an instance of whatever object is stored on the |
|
24 | - * collection when iterating over the collection and should return boolean. |
|
25 | - */ |
|
26 | - public function __construct(Collection $collection, Closure $acceptance_callback) |
|
27 | - { |
|
28 | - $this->acceptance_callback = $acceptance_callback; |
|
29 | - parent::__construct($collection); |
|
30 | - } |
|
31 | - |
|
32 | - /** |
|
33 | - * Check whether the current element of the iterator is acceptable |
|
34 | - * |
|
35 | - * @link http://php.net/manual/en/filteriterator.accept.php |
|
36 | - * @return bool true if the current element is acceptable, otherwise false. |
|
37 | - */ |
|
38 | - public function accept() |
|
39 | - { |
|
40 | - $acceptance_callback = $this->acceptance_callback; |
|
41 | - return $acceptance_callback($this->getInnerIterator()->current()); |
|
42 | - } |
|
43 | - |
|
44 | - |
|
45 | - |
|
46 | - /** |
|
47 | - * Returns a filtered array of objects from the collection using the provided acceptance callback |
|
48 | - * @return array |
|
49 | - */ |
|
50 | - public function getFiltered() |
|
51 | - { |
|
52 | - $filtered_array = array(); |
|
53 | - $this->rewind(); |
|
54 | - foreach ($this as $filtered_object) { |
|
55 | - $filtered_array[] = $filtered_object; |
|
56 | - } |
|
57 | - return $filtered_array; |
|
58 | - } |
|
12 | + /** |
|
13 | + * Used for determining whether the iterated object in the Collection is "valid" or not. |
|
14 | + * @var Closure |
|
15 | + */ |
|
16 | + private $acceptance_callback; |
|
17 | + |
|
18 | + |
|
19 | + /** |
|
20 | + * CollectionFilterCallbackIterator constructor. |
|
21 | + * |
|
22 | + * @param Collection $collection |
|
23 | + * @param Closure $acceptance_callback The closure will receive an instance of whatever object is stored on the |
|
24 | + * collection when iterating over the collection and should return boolean. |
|
25 | + */ |
|
26 | + public function __construct(Collection $collection, Closure $acceptance_callback) |
|
27 | + { |
|
28 | + $this->acceptance_callback = $acceptance_callback; |
|
29 | + parent::__construct($collection); |
|
30 | + } |
|
31 | + |
|
32 | + /** |
|
33 | + * Check whether the current element of the iterator is acceptable |
|
34 | + * |
|
35 | + * @link http://php.net/manual/en/filteriterator.accept.php |
|
36 | + * @return bool true if the current element is acceptable, otherwise false. |
|
37 | + */ |
|
38 | + public function accept() |
|
39 | + { |
|
40 | + $acceptance_callback = $this->acceptance_callback; |
|
41 | + return $acceptance_callback($this->getInnerIterator()->current()); |
|
42 | + } |
|
43 | + |
|
44 | + |
|
45 | + |
|
46 | + /** |
|
47 | + * Returns a filtered array of objects from the collection using the provided acceptance callback |
|
48 | + * @return array |
|
49 | + */ |
|
50 | + public function getFiltered() |
|
51 | + { |
|
52 | + $filtered_array = array(); |
|
53 | + $this->rewind(); |
|
54 | + foreach ($this as $filtered_object) { |
|
55 | + $filtered_array[] = $filtered_object; |
|
56 | + } |
|
57 | + return $filtered_array; |
|
58 | + } |
|
59 | 59 | } |
@@ -16,94 +16,94 @@ |
||
16 | 16 | interface HelperInterface |
17 | 17 | { |
18 | 18 | |
19 | - /** |
|
20 | - * Ensures that a valid timezone string is returned. |
|
21 | - * |
|
22 | - * @param string $timezone_string When not provided then attempt to use the timezone_string set in the WP Time |
|
23 | - * settings (or derive from set UTC offset). |
|
24 | - * @return string |
|
25 | - */ |
|
26 | - public function getValidTimezoneString($timezone_string = ''); |
|
27 | - |
|
28 | - |
|
29 | - /** |
|
30 | - * The only purpose for this static method is to validate that the incoming timezone is a valid php timezone. |
|
31 | - * |
|
32 | - * @param string $timezone_string |
|
33 | - * @param bool $throw_error |
|
34 | - * @return bool |
|
35 | - */ |
|
36 | - public function validateTimezone($timezone_string, $throw_error = true); |
|
37 | - |
|
38 | - |
|
39 | - /** |
|
40 | - * Returns a timezone string for the provided gmt_offset. |
|
41 | - * @param float|string $gmt_offset |
|
42 | - * @return string |
|
43 | - */ |
|
44 | - public function getTimezoneStringFromGmtOffset($gmt_offset = ''); |
|
45 | - |
|
46 | - |
|
47 | - /** |
|
48 | - * Gets the site's GMT offset based on either the timezone string |
|
49 | - * (in which case the gmt offset will vary depending on the location's |
|
50 | - * observance of daylight savings time) or the gmt_offset wp option |
|
51 | - * |
|
52 | - * @return int seconds offset |
|
53 | - */ |
|
54 | - public function getSiteTimezoneGmtOffset(); |
|
55 | - |
|
56 | - |
|
57 | - /** |
|
58 | - * Get timezone transitions |
|
59 | - * @param DateTimeZone $date_time_zone |
|
60 | - * @param int|null $time |
|
61 | - * @param bool $first_only |
|
62 | - * @return array |
|
63 | - */ |
|
64 | - public function getTimezoneTransitions(DateTimeZone $date_time_zone, $time = null, $first_only = true); |
|
65 | - |
|
66 | - |
|
67 | - /** |
|
68 | - * Get Timezone offset for given timezone object |
|
69 | - * @param DateTimeZone $date_time_zone |
|
70 | - * @param null|int $time |
|
71 | - * @return int |
|
72 | - */ |
|
73 | - public function getTimezoneOffset(DateTimeZone $date_time_zone, $time = null); |
|
74 | - |
|
75 | - |
|
76 | - /** |
|
77 | - * Provide a timezone select input |
|
78 | - * @param string $timezone_string |
|
79 | - * @return string |
|
80 | - */ |
|
81 | - public function timezoneSelectInput($timezone_string = ''); |
|
82 | - |
|
83 | - |
|
84 | - /** |
|
85 | - * This method will take an incoming unix timestamp and add the offset to it for the given timezone_string. |
|
86 | - * If no unix timestamp is given then time() is used. If no timezone is given then the set timezone string for |
|
87 | - * the site is used. |
|
88 | - * This is used typically when using a Unix timestamp any core WP functions that expect their specially |
|
89 | - * computed timestamp (i.e. date_i18n() ) |
|
90 | - * |
|
91 | - * @param int $unix_timestamp if 0, then time() will be used. |
|
92 | - * @param string $timezone_string timezone_string. If empty, then the current set timezone for the |
|
93 | - * site will be used. |
|
94 | - * @return int unix_timestamp value with the offset applied for the given timezone. |
|
95 | - */ |
|
96 | - public function getTimestampWithOffset($unix_timestamp = 0, $timezone_string = ''); |
|
97 | - |
|
98 | - |
|
99 | - /** |
|
100 | - * Depending on PHP version, |
|
101 | - * there might not be valid current timezone strings to match these gmt_offsets in its timezone tables. |
|
102 | - * To get around that, for these fringe timezones we bump them to a known valid offset. |
|
103 | - * This method should ONLY be called after first verifying an timezone_string cannot be retrieved for the offset. |
|
104 | - * |
|
105 | - * @param int $gmt_offset |
|
106 | - * @return int |
|
107 | - */ |
|
108 | - public function adjustInvalidGmtOffsets($gmt_offset); |
|
19 | + /** |
|
20 | + * Ensures that a valid timezone string is returned. |
|
21 | + * |
|
22 | + * @param string $timezone_string When not provided then attempt to use the timezone_string set in the WP Time |
|
23 | + * settings (or derive from set UTC offset). |
|
24 | + * @return string |
|
25 | + */ |
|
26 | + public function getValidTimezoneString($timezone_string = ''); |
|
27 | + |
|
28 | + |
|
29 | + /** |
|
30 | + * The only purpose for this static method is to validate that the incoming timezone is a valid php timezone. |
|
31 | + * |
|
32 | + * @param string $timezone_string |
|
33 | + * @param bool $throw_error |
|
34 | + * @return bool |
|
35 | + */ |
|
36 | + public function validateTimezone($timezone_string, $throw_error = true); |
|
37 | + |
|
38 | + |
|
39 | + /** |
|
40 | + * Returns a timezone string for the provided gmt_offset. |
|
41 | + * @param float|string $gmt_offset |
|
42 | + * @return string |
|
43 | + */ |
|
44 | + public function getTimezoneStringFromGmtOffset($gmt_offset = ''); |
|
45 | + |
|
46 | + |
|
47 | + /** |
|
48 | + * Gets the site's GMT offset based on either the timezone string |
|
49 | + * (in which case the gmt offset will vary depending on the location's |
|
50 | + * observance of daylight savings time) or the gmt_offset wp option |
|
51 | + * |
|
52 | + * @return int seconds offset |
|
53 | + */ |
|
54 | + public function getSiteTimezoneGmtOffset(); |
|
55 | + |
|
56 | + |
|
57 | + /** |
|
58 | + * Get timezone transitions |
|
59 | + * @param DateTimeZone $date_time_zone |
|
60 | + * @param int|null $time |
|
61 | + * @param bool $first_only |
|
62 | + * @return array |
|
63 | + */ |
|
64 | + public function getTimezoneTransitions(DateTimeZone $date_time_zone, $time = null, $first_only = true); |
|
65 | + |
|
66 | + |
|
67 | + /** |
|
68 | + * Get Timezone offset for given timezone object |
|
69 | + * @param DateTimeZone $date_time_zone |
|
70 | + * @param null|int $time |
|
71 | + * @return int |
|
72 | + */ |
|
73 | + public function getTimezoneOffset(DateTimeZone $date_time_zone, $time = null); |
|
74 | + |
|
75 | + |
|
76 | + /** |
|
77 | + * Provide a timezone select input |
|
78 | + * @param string $timezone_string |
|
79 | + * @return string |
|
80 | + */ |
|
81 | + public function timezoneSelectInput($timezone_string = ''); |
|
82 | + |
|
83 | + |
|
84 | + /** |
|
85 | + * This method will take an incoming unix timestamp and add the offset to it for the given timezone_string. |
|
86 | + * If no unix timestamp is given then time() is used. If no timezone is given then the set timezone string for |
|
87 | + * the site is used. |
|
88 | + * This is used typically when using a Unix timestamp any core WP functions that expect their specially |
|
89 | + * computed timestamp (i.e. date_i18n() ) |
|
90 | + * |
|
91 | + * @param int $unix_timestamp if 0, then time() will be used. |
|
92 | + * @param string $timezone_string timezone_string. If empty, then the current set timezone for the |
|
93 | + * site will be used. |
|
94 | + * @return int unix_timestamp value with the offset applied for the given timezone. |
|
95 | + */ |
|
96 | + public function getTimestampWithOffset($unix_timestamp = 0, $timezone_string = ''); |
|
97 | + |
|
98 | + |
|
99 | + /** |
|
100 | + * Depending on PHP version, |
|
101 | + * there might not be valid current timezone strings to match these gmt_offsets in its timezone tables. |
|
102 | + * To get around that, for these fringe timezones we bump them to a known valid offset. |
|
103 | + * This method should ONLY be called after first verifying an timezone_string cannot be retrieved for the offset. |
|
104 | + * |
|
105 | + * @param int $gmt_offset |
|
106 | + * @return int |
|
107 | + */ |
|
108 | + public function adjustInvalidGmtOffsets($gmt_offset); |
|
109 | 109 | } |
@@ -87,7 +87,7 @@ |
||
87 | 87 | { |
88 | 88 | $this->evaluation_callback = $evaluation_callback instanceof Closure |
89 | 89 | ? $evaluation_callback |
90 | - : function (ContextInterface $context, $acceptable_values) { |
|
90 | + : function(ContextInterface $context, $acceptable_values) { |
|
91 | 91 | return in_array($context->slug(), $acceptable_values, true); |
92 | 92 | }; |
93 | 93 | } |
@@ -17,145 +17,145 @@ |
||
17 | 17 | class ContextChecker |
18 | 18 | { |
19 | 19 | |
20 | - /** |
|
21 | - * A unique string used to identify where this ContextChecker is being employed |
|
22 | - * Is currently only used within the hook name for the filterable return value of isAllowed(). |
|
23 | - * |
|
24 | - * @var string $identifier |
|
25 | - */ |
|
26 | - private $identifier; |
|
27 | - |
|
28 | - /** |
|
29 | - * A list of values to be compared against the slug of the Context class passed to isAllowed() |
|
30 | - * |
|
31 | - * @var array $acceptable_values |
|
32 | - */ |
|
33 | - private $acceptable_values; |
|
34 | - |
|
35 | - /** |
|
36 | - * Closure that will be called to perform the evaluation within isAllowed(). |
|
37 | - * If none is provided, then a simple type sensitive in_array() check will be used |
|
38 | - * and return true if the incoming Context::slug() is found within the array of $acceptable_values. |
|
39 | - * |
|
40 | - * @var Closure $evaluation_callback |
|
41 | - */ |
|
42 | - private $evaluation_callback; |
|
43 | - |
|
44 | - |
|
45 | - /** |
|
46 | - * ContextChecker constructor. |
|
47 | - * |
|
48 | - * @param string $identifier |
|
49 | - * @param array $acceptable_values |
|
50 | - * @param Closure|null $evaluation_callback [optional] |
|
51 | - */ |
|
52 | - public function __construct($identifier, array $acceptable_values, Closure $evaluation_callback = null) |
|
53 | - { |
|
54 | - $this->setIdentifier($identifier); |
|
55 | - $this->setAcceptableValues($acceptable_values); |
|
56 | - $this->setEvaluationCallback($evaluation_callback); |
|
57 | - } |
|
58 | - |
|
59 | - |
|
60 | - /** |
|
61 | - * @param string $identifier |
|
62 | - */ |
|
63 | - private function setIdentifier($identifier) |
|
64 | - { |
|
65 | - $this->identifier = sanitize_key($identifier); |
|
66 | - } |
|
67 | - |
|
68 | - |
|
69 | - /** |
|
70 | - * @param array $acceptable_values |
|
71 | - */ |
|
72 | - private function setAcceptableValues(array $acceptable_values) |
|
73 | - { |
|
74 | - $this->acceptable_values = $acceptable_values; |
|
75 | - } |
|
76 | - |
|
77 | - |
|
78 | - /** |
|
79 | - * @param Closure $evaluation_callback |
|
80 | - */ |
|
81 | - private function setEvaluationCallback(Closure $evaluation_callback = null) |
|
82 | - { |
|
83 | - $this->evaluation_callback = $evaluation_callback instanceof Closure |
|
84 | - ? $evaluation_callback |
|
85 | - : function (ContextInterface $context, $acceptable_values) { |
|
86 | - return in_array($context->slug(), $acceptable_values, true); |
|
87 | - }; |
|
88 | - } |
|
89 | - |
|
90 | - |
|
91 | - /** |
|
92 | - * @return string |
|
93 | - */ |
|
94 | - protected function identifier() |
|
95 | - { |
|
96 | - return $this->identifier; |
|
97 | - } |
|
98 | - |
|
99 | - |
|
100 | - /** |
|
101 | - * @return array |
|
102 | - */ |
|
103 | - protected function acceptableValues() |
|
104 | - { |
|
105 | - return apply_filters( |
|
106 | - "FHEE__EventEspresso_core_domain_entities_context_ContextChecker__{$this->identifier}__acceptableValues", |
|
107 | - $this->acceptable_values |
|
108 | - ); |
|
109 | - } |
|
110 | - |
|
111 | - |
|
112 | - /** |
|
113 | - * @return Closure |
|
114 | - */ |
|
115 | - protected function evaluationCallback() |
|
116 | - { |
|
117 | - return $this->evaluation_callback; |
|
118 | - } |
|
119 | - |
|
120 | - |
|
121 | - /** |
|
122 | - * Returns true if the incoming Context class slug matches one of the preset acceptable values. |
|
123 | - * The result is filterable using the identifier for this ContextChecker. |
|
124 | - * example: |
|
125 | - * If this ContextChecker's $identifier was set to "registration-checkout-type", |
|
126 | - * then the filter here would be named: |
|
127 | - * "FHEE__EventEspresso_core_domain_entities_context_ContextChecker__registration-checkout-type__isAllowed". |
|
128 | - * Other code could hook into the filter in isAllowed() using the above name |
|
129 | - * and test for additional acceptable values. |
|
130 | - * So if the set of $acceptable_values was: [ "initial-visit", "revisit" ] |
|
131 | - * then adding a filter to |
|
132 | - * "FHEE__EventEspresso_core_domain_entities_context_ContextChecker__registration-checkout-type__isAllowed", |
|
133 | - * would allow you to perform your own conditional and allow "wait-list-checkout" as an acceptable value. |
|
134 | - * example: |
|
135 | - * add_filter( |
|
136 | - * 'FHEE__EventEspresso_core_domain_entities_context_ContextChecker__registration-checkout-type__isAllowed', |
|
137 | - * function ($is_allowed, ContextInterface $context) { return $context->slug() === 'wait-list-checkout' |
|
138 | - * ? true |
|
139 | - * : $is_allowed; |
|
140 | - * }, |
|
141 | - * 10, |
|
142 | - * 2 |
|
143 | - * ); |
|
144 | - * |
|
145 | - * @param ContextInterface $context |
|
146 | - * @return boolean |
|
147 | - */ |
|
148 | - public function isAllowed(ContextInterface $context) |
|
149 | - { |
|
150 | - $evaluation_callback = $this->evaluationCallback(); |
|
151 | - return filter_var( |
|
152 | - apply_filters( |
|
153 | - "FHEE__EventEspresso_core_domain_entities_context_ContextChecker__{$this->identifier}__isAllowed", |
|
154 | - $evaluation_callback($context, $this->acceptableValues()), |
|
155 | - $context, |
|
156 | - $this |
|
157 | - ), |
|
158 | - FILTER_VALIDATE_BOOLEAN |
|
159 | - ); |
|
160 | - } |
|
20 | + /** |
|
21 | + * A unique string used to identify where this ContextChecker is being employed |
|
22 | + * Is currently only used within the hook name for the filterable return value of isAllowed(). |
|
23 | + * |
|
24 | + * @var string $identifier |
|
25 | + */ |
|
26 | + private $identifier; |
|
27 | + |
|
28 | + /** |
|
29 | + * A list of values to be compared against the slug of the Context class passed to isAllowed() |
|
30 | + * |
|
31 | + * @var array $acceptable_values |
|
32 | + */ |
|
33 | + private $acceptable_values; |
|
34 | + |
|
35 | + /** |
|
36 | + * Closure that will be called to perform the evaluation within isAllowed(). |
|
37 | + * If none is provided, then a simple type sensitive in_array() check will be used |
|
38 | + * and return true if the incoming Context::slug() is found within the array of $acceptable_values. |
|
39 | + * |
|
40 | + * @var Closure $evaluation_callback |
|
41 | + */ |
|
42 | + private $evaluation_callback; |
|
43 | + |
|
44 | + |
|
45 | + /** |
|
46 | + * ContextChecker constructor. |
|
47 | + * |
|
48 | + * @param string $identifier |
|
49 | + * @param array $acceptable_values |
|
50 | + * @param Closure|null $evaluation_callback [optional] |
|
51 | + */ |
|
52 | + public function __construct($identifier, array $acceptable_values, Closure $evaluation_callback = null) |
|
53 | + { |
|
54 | + $this->setIdentifier($identifier); |
|
55 | + $this->setAcceptableValues($acceptable_values); |
|
56 | + $this->setEvaluationCallback($evaluation_callback); |
|
57 | + } |
|
58 | + |
|
59 | + |
|
60 | + /** |
|
61 | + * @param string $identifier |
|
62 | + */ |
|
63 | + private function setIdentifier($identifier) |
|
64 | + { |
|
65 | + $this->identifier = sanitize_key($identifier); |
|
66 | + } |
|
67 | + |
|
68 | + |
|
69 | + /** |
|
70 | + * @param array $acceptable_values |
|
71 | + */ |
|
72 | + private function setAcceptableValues(array $acceptable_values) |
|
73 | + { |
|
74 | + $this->acceptable_values = $acceptable_values; |
|
75 | + } |
|
76 | + |
|
77 | + |
|
78 | + /** |
|
79 | + * @param Closure $evaluation_callback |
|
80 | + */ |
|
81 | + private function setEvaluationCallback(Closure $evaluation_callback = null) |
|
82 | + { |
|
83 | + $this->evaluation_callback = $evaluation_callback instanceof Closure |
|
84 | + ? $evaluation_callback |
|
85 | + : function (ContextInterface $context, $acceptable_values) { |
|
86 | + return in_array($context->slug(), $acceptable_values, true); |
|
87 | + }; |
|
88 | + } |
|
89 | + |
|
90 | + |
|
91 | + /** |
|
92 | + * @return string |
|
93 | + */ |
|
94 | + protected function identifier() |
|
95 | + { |
|
96 | + return $this->identifier; |
|
97 | + } |
|
98 | + |
|
99 | + |
|
100 | + /** |
|
101 | + * @return array |
|
102 | + */ |
|
103 | + protected function acceptableValues() |
|
104 | + { |
|
105 | + return apply_filters( |
|
106 | + "FHEE__EventEspresso_core_domain_entities_context_ContextChecker__{$this->identifier}__acceptableValues", |
|
107 | + $this->acceptable_values |
|
108 | + ); |
|
109 | + } |
|
110 | + |
|
111 | + |
|
112 | + /** |
|
113 | + * @return Closure |
|
114 | + */ |
|
115 | + protected function evaluationCallback() |
|
116 | + { |
|
117 | + return $this->evaluation_callback; |
|
118 | + } |
|
119 | + |
|
120 | + |
|
121 | + /** |
|
122 | + * Returns true if the incoming Context class slug matches one of the preset acceptable values. |
|
123 | + * The result is filterable using the identifier for this ContextChecker. |
|
124 | + * example: |
|
125 | + * If this ContextChecker's $identifier was set to "registration-checkout-type", |
|
126 | + * then the filter here would be named: |
|
127 | + * "FHEE__EventEspresso_core_domain_entities_context_ContextChecker__registration-checkout-type__isAllowed". |
|
128 | + * Other code could hook into the filter in isAllowed() using the above name |
|
129 | + * and test for additional acceptable values. |
|
130 | + * So if the set of $acceptable_values was: [ "initial-visit", "revisit" ] |
|
131 | + * then adding a filter to |
|
132 | + * "FHEE__EventEspresso_core_domain_entities_context_ContextChecker__registration-checkout-type__isAllowed", |
|
133 | + * would allow you to perform your own conditional and allow "wait-list-checkout" as an acceptable value. |
|
134 | + * example: |
|
135 | + * add_filter( |
|
136 | + * 'FHEE__EventEspresso_core_domain_entities_context_ContextChecker__registration-checkout-type__isAllowed', |
|
137 | + * function ($is_allowed, ContextInterface $context) { return $context->slug() === 'wait-list-checkout' |
|
138 | + * ? true |
|
139 | + * : $is_allowed; |
|
140 | + * }, |
|
141 | + * 10, |
|
142 | + * 2 |
|
143 | + * ); |
|
144 | + * |
|
145 | + * @param ContextInterface $context |
|
146 | + * @return boolean |
|
147 | + */ |
|
148 | + public function isAllowed(ContextInterface $context) |
|
149 | + { |
|
150 | + $evaluation_callback = $this->evaluationCallback(); |
|
151 | + return filter_var( |
|
152 | + apply_filters( |
|
153 | + "FHEE__EventEspresso_core_domain_entities_context_ContextChecker__{$this->identifier}__isAllowed", |
|
154 | + $evaluation_callback($context, $this->acceptableValues()), |
|
155 | + $context, |
|
156 | + $this |
|
157 | + ), |
|
158 | + FILTER_VALIDATE_BOOLEAN |
|
159 | + ); |
|
160 | + } |
|
161 | 161 | } |
@@ -18,14 +18,14 @@ |
||
18 | 18 | interface ContextInterface |
19 | 19 | { |
20 | 20 | |
21 | - /** |
|
22 | - * @return string |
|
23 | - */ |
|
24 | - public function slug(); |
|
21 | + /** |
|
22 | + * @return string |
|
23 | + */ |
|
24 | + public function slug(); |
|
25 | 25 | |
26 | 26 | |
27 | - /** |
|
28 | - * @return string |
|
29 | - */ |
|
30 | - public function description(); |
|
27 | + /** |
|
28 | + * @return string |
|
29 | + */ |
|
30 | + public function description(); |
|
31 | 31 | } |
@@ -14,8 +14,8 @@ discard block |
||
14 | 14 | |
15 | 15 | //need the MER plugin active for this test (we'll deactivate it after). |
16 | 16 | $I->ensurePluginActive( |
17 | - 'event-espresso-mer-multi-event-registration', |
|
18 | - 'activated' |
|
17 | + 'event-espresso-mer-multi-event-registration', |
|
18 | + 'activated' |
|
19 | 19 | ); |
20 | 20 | |
21 | 21 | //k now we need to make sure the registration multi-status message type is active because it isn't by default |
@@ -73,38 +73,38 @@ discard block |
||
73 | 73 | $I->loginAsAdmin(); |
74 | 74 | $I->amOnMessagesActivityListTablePage(); |
75 | 75 | $I->see( |
76 | - '[email protected]', |
|
77 | - MessagesAdmin::messagesActivityListTableCellSelectorFor( |
|
78 | - 'to', |
|
79 | - 'Registration Multi-status Summary', |
|
80 | - MessagesAdmin::MESSAGE_STATUS_SENT, |
|
81 | - '', |
|
82 | - 'Primary Registrant' |
|
83 | - ) |
|
76 | + '[email protected]', |
|
77 | + MessagesAdmin::messagesActivityListTableCellSelectorFor( |
|
78 | + 'to', |
|
79 | + 'Registration Multi-status Summary', |
|
80 | + MessagesAdmin::MESSAGE_STATUS_SENT, |
|
81 | + '', |
|
82 | + 'Primary Registrant' |
|
83 | + ) |
|
84 | 84 | ); |
85 | 85 | $I->see( |
86 | - '[email protected]', |
|
87 | - MessagesAdmin::messagesActivityListTableCellSelectorFor( |
|
88 | - 'to', |
|
89 | - 'Registration Multi-status Summary', |
|
90 | - MessagesAdmin::MESSAGE_STATUS_SENT |
|
91 | - ) |
|
86 | + '[email protected]', |
|
87 | + MessagesAdmin::messagesActivityListTableCellSelectorFor( |
|
88 | + 'to', |
|
89 | + 'Registration Multi-status Summary', |
|
90 | + MessagesAdmin::MESSAGE_STATUS_SENT |
|
91 | + ) |
|
92 | 92 | ); |
93 | 93 | //verify count |
94 | 94 | $I->verifyMatchingCountofTextInMessageActivityListTableFor( |
95 | - 1, |
|
96 | - '[email protected]', |
|
97 | - 'to', |
|
98 | - 'Registration Multi-status Summary', |
|
99 | - MessagesAdmin::MESSAGE_STATUS_SENT, |
|
100 | - 'Email', |
|
101 | - 'Primary Registrant' |
|
95 | + 1, |
|
96 | + '[email protected]', |
|
97 | + 'to', |
|
98 | + 'Registration Multi-status Summary', |
|
99 | + MessagesAdmin::MESSAGE_STATUS_SENT, |
|
100 | + 'Email', |
|
101 | + 'Primary Registrant' |
|
102 | 102 | ); |
103 | 103 | $I->verifyMatchingCountofTextInMessageActivityListTableFor( |
104 | - 1, |
|
105 | - '[email protected]', |
|
106 | - 'to', |
|
107 | - 'Registration Multi-status Summary' |
|
104 | + 1, |
|
105 | + '[email protected]', |
|
106 | + 'to', |
|
107 | + 'Registration Multi-status Summary' |
|
108 | 108 | ); |
109 | 109 | |
110 | 110 | //okay now let's do some registrations for just the first event and verify that registration multi-status summary is NOT |
@@ -134,25 +134,25 @@ discard block |
||
134 | 134 | $I->loginAsAdmin(); |
135 | 135 | $I->amOnMessagesActivityListTablePage(); |
136 | 136 | $I->dontSee( |
137 | - '[email protected]', |
|
138 | - MessagesAdmin::messagesActivityListTableCellSelectorFor( |
|
139 | - 'to', |
|
140 | - 'Registration Multi-status Summary', |
|
141 | - MessagesAdmin::MESSAGE_STATUS_SENT, |
|
142 | - '', |
|
143 | - 'Primary Registrant' |
|
144 | - ) |
|
137 | + '[email protected]', |
|
138 | + MessagesAdmin::messagesActivityListTableCellSelectorFor( |
|
139 | + 'to', |
|
140 | + 'Registration Multi-status Summary', |
|
141 | + MessagesAdmin::MESSAGE_STATUS_SENT, |
|
142 | + '', |
|
143 | + 'Primary Registrant' |
|
144 | + ) |
|
145 | 145 | ); |
146 | 146 | //there should still only be one admin multi-status summary thing. |
147 | 147 | $I->verifyMatchingCountofTextInMessageActivityListTableFor( |
148 | - 1, |
|
149 | - '[email protected]', |
|
150 | - 'to', |
|
151 | - 'Registration Multi-status Summary' |
|
148 | + 1, |
|
149 | + '[email protected]', |
|
150 | + 'to', |
|
151 | + 'Registration Multi-status Summary' |
|
152 | 152 | ); |
153 | 153 | |
154 | 154 | //deactivate MER plugin so its not active for future tests |
155 | 155 | $I->ensurePluginDeactivated( |
156 | - 'event-espresso-mer-multi-event-registration', |
|
157 | - 'plugins deactivated' |
|
156 | + 'event-espresso-mer-multi-event-registration', |
|
157 | + 'plugins deactivated' |
|
158 | 158 | ); |
159 | 159 | \ No newline at end of file |
@@ -18,14 +18,14 @@ discard block |
||
18 | 18 | $event_one_link = $event_two_link = $event_three_link = ''; |
19 | 19 | |
20 | 20 | $I->wantTo( |
21 | - 'Test that when registrations for multiple events are completed, and those events share the same custom' |
|
22 | - . 'template, that that custom template will be used.' |
|
21 | + 'Test that when registrations for multiple events are completed, and those events share the same custom' |
|
22 | + . 'template, that that custom template will be used.' |
|
23 | 23 | ); |
24 | 24 | |
25 | 25 | //need the MER plugin active for this test (we'll deactivate it after). |
26 | 26 | $I->ensurePluginActive( |
27 | - 'event-espresso-mer-multi-event-registration', |
|
28 | - 'activated' |
|
27 | + 'event-espresso-mer-multi-event-registration', |
|
28 | + 'activated' |
|
29 | 29 | ); |
30 | 30 | |
31 | 31 | $I->loginAsAdmin(); |
@@ -80,9 +80,9 @@ discard block |
||
80 | 80 | |
81 | 81 | |
82 | 82 | $test_registration_details = array( |
83 | - 'fname' => 'CTGuy', |
|
84 | - 'lname' => 'Dude', |
|
85 | - 'email' => '[email protected]' |
|
83 | + 'fname' => 'CTGuy', |
|
84 | + 'lname' => 'Dude', |
|
85 | + 'email' => '[email protected]' |
|
86 | 86 | ); |
87 | 87 | |
88 | 88 | $I->amGoingTo('Register for Event One and Event Two and verify Custom Template A was used.'); |
@@ -108,23 +108,23 @@ discard block |
||
108 | 108 | $I->loginAsAdmin(); |
109 | 109 | $I->amOnMessagesActivityListTablePage(); |
110 | 110 | $I->viewMessageInMessagesListTableFor( |
111 | - 'Registration Approved', |
|
112 | - MessagesAdmin::MESSAGE_STATUS_SENT, |
|
113 | - 'Email', |
|
114 | - 'Registrant' |
|
111 | + 'Registration Approved', |
|
112 | + MessagesAdmin::MESSAGE_STATUS_SENT, |
|
113 | + 'Email', |
|
114 | + 'Registrant' |
|
115 | 115 | ); |
116 | 116 | $I->seeTextInViewMessageModal($custom_template_a_label); |
117 | 117 | $I->dismissMessageModal(); |
118 | 118 | $I->deleteMessageInMessagesListTableFor( |
119 | - 'Registration Approved', |
|
120 | - MessagesAdmin::MESSAGE_STATUS_SENT, |
|
121 | - 'Email', |
|
122 | - 'Registrant' |
|
119 | + 'Registration Approved', |
|
120 | + MessagesAdmin::MESSAGE_STATUS_SENT, |
|
121 | + 'Email', |
|
122 | + 'Registrant' |
|
123 | 123 | ); |
124 | 124 | |
125 | 125 | //verify admin context |
126 | 126 | $I->viewMessageInMessagesListTableFor( |
127 | - 'Registration Approved' |
|
127 | + 'Registration Approved' |
|
128 | 128 | ); |
129 | 129 | $I->seeTextInViewMessageModal($custom_template_a_label); |
130 | 130 | $I->dismissMessageModal(); |
@@ -153,25 +153,25 @@ discard block |
||
153 | 153 | $I->loginAsAdmin(); |
154 | 154 | $I->amOnMessagesActivityListTablePage(); |
155 | 155 | $I->viewMessageInMessagesListTableFor( |
156 | - 'Registration Approved', |
|
157 | - MessagesAdmin::MESSAGE_STATUS_SENT, |
|
158 | - 'Email', |
|
159 | - 'Registrant' |
|
156 | + 'Registration Approved', |
|
157 | + MessagesAdmin::MESSAGE_STATUS_SENT, |
|
158 | + 'Email', |
|
159 | + 'Registrant' |
|
160 | 160 | ); |
161 | 161 | $I->waitForElementVisible(MessagesAdmin::MESSAGES_LIST_TABLE_VIEW_MESSAGE_DIALOG_CONTAINER_SELECTOR); |
162 | 162 | $I->dontSeeTextInViewMessageModal($custom_template_a_label); |
163 | 163 | $I->dontSeeTextInViewMessageModal($custom_template_b_label); |
164 | 164 | $I->dismissMessageModal(); |
165 | 165 | $I->deleteMessageInMessagesListTableFor( |
166 | - 'Registration Approved', |
|
167 | - MessagesAdmin::MESSAGE_STATUS_SENT, |
|
168 | - 'Email', |
|
169 | - 'Registrant' |
|
166 | + 'Registration Approved', |
|
167 | + MessagesAdmin::MESSAGE_STATUS_SENT, |
|
168 | + 'Email', |
|
169 | + 'Registrant' |
|
170 | 170 | ); |
171 | 171 | |
172 | 172 | //verify admin context |
173 | 173 | $I->viewMessageInMessagesListTableFor( |
174 | - 'Registration Approved' |
|
174 | + 'Registration Approved' |
|
175 | 175 | ); |
176 | 176 | $I->waitForElementVisible(MessagesAdmin::MESSAGES_LIST_TABLE_VIEW_MESSAGE_DIALOG_CONTAINER_SELECTOR); |
177 | 177 | $I->dontSee($custom_template_a_label); |
@@ -183,6 +183,6 @@ discard block |
||
183 | 183 | |
184 | 184 | //deactivate MER plugin so its not active for future tests |
185 | 185 | $I->ensurePluginDeactivated( |
186 | - 'event-espresso-mer-multi-event-registration', |
|
187 | - 'plugins deactivated' |
|
186 | + 'event-espresso-mer-multi-event-registration', |
|
187 | + 'plugins deactivated' |
|
188 | 188 | ); |
189 | 189 | \ No newline at end of file |
@@ -6,59 +6,59 @@ |
||
6 | 6 | |
7 | 7 | trait CountrySettingsAdmin |
8 | 8 | { |
9 | - /** |
|
10 | - * Instructs the actor to browse to the country settings page. |
|
11 | - * Assumes the actor is already logged in. |
|
12 | - * @param string $additional_params |
|
13 | - */ |
|
14 | - public function amOnCountrySettingsAdminPage($additional_params = '') |
|
15 | - { |
|
16 | - $this->actor()->amOnAdminPage(CountrySettings::url($additional_params)); |
|
17 | - } |
|
9 | + /** |
|
10 | + * Instructs the actor to browse to the country settings page. |
|
11 | + * Assumes the actor is already logged in. |
|
12 | + * @param string $additional_params |
|
13 | + */ |
|
14 | + public function amOnCountrySettingsAdminPage($additional_params = '') |
|
15 | + { |
|
16 | + $this->actor()->amOnAdminPage(CountrySettings::url($additional_params)); |
|
17 | + } |
|
18 | 18 | |
19 | 19 | |
20 | - /** |
|
21 | - * Instructs the actor to select the given decimal places radio option. |
|
22 | - * Assumes the actor is already on the country settings page. |
|
23 | - * @param string $decimal_places |
|
24 | - * @param string $country_code |
|
25 | - */ |
|
26 | - public function setCurrencyDecimalPlacesTo($decimal_places = '2', $country_code = 'US') |
|
27 | - { |
|
28 | - $this->actor()->click(CountrySettings::currencyDecimalPlacesRadioField($decimal_places, $country_code)); |
|
29 | - } |
|
20 | + /** |
|
21 | + * Instructs the actor to select the given decimal places radio option. |
|
22 | + * Assumes the actor is already on the country settings page. |
|
23 | + * @param string $decimal_places |
|
24 | + * @param string $country_code |
|
25 | + */ |
|
26 | + public function setCurrencyDecimalPlacesTo($decimal_places = '2', $country_code = 'US') |
|
27 | + { |
|
28 | + $this->actor()->click(CountrySettings::currencyDecimalPlacesRadioField($decimal_places, $country_code)); |
|
29 | + } |
|
30 | 30 | |
31 | 31 | |
32 | - /** |
|
33 | - * Instructs the actor to select the given decimal mark radio option. |
|
34 | - * Assumes the actor is already on the country settings page. |
|
35 | - * @param string $decimal_mark |
|
36 | - */ |
|
37 | - public function setCurrencyDecimalMarkTo($decimal_mark = '.') |
|
38 | - { |
|
39 | - $this->actor()->click(CountrySettings::currencyDecimalMarkRadioField($decimal_mark)); |
|
40 | - } |
|
32 | + /** |
|
33 | + * Instructs the actor to select the given decimal mark radio option. |
|
34 | + * Assumes the actor is already on the country settings page. |
|
35 | + * @param string $decimal_mark |
|
36 | + */ |
|
37 | + public function setCurrencyDecimalMarkTo($decimal_mark = '.') |
|
38 | + { |
|
39 | + $this->actor()->click(CountrySettings::currencyDecimalMarkRadioField($decimal_mark)); |
|
40 | + } |
|
41 | 41 | |
42 | 42 | |
43 | - /** |
|
44 | - * Instructs the actor to select the given thousands separator radio option. |
|
45 | - * Assumes the actor is already on the country settings page. |
|
46 | - * @param string $thousands_seperator |
|
47 | - */ |
|
48 | - public function setCurrencyThousandsSeparatorTo($thousands_seperator = ',') |
|
49 | - { |
|
50 | - $this->actor()->click(CountrySettings::currencyThousandsSeparatorField($thousands_seperator)); |
|
51 | - } |
|
43 | + /** |
|
44 | + * Instructs the actor to select the given thousands separator radio option. |
|
45 | + * Assumes the actor is already on the country settings page. |
|
46 | + * @param string $thousands_seperator |
|
47 | + */ |
|
48 | + public function setCurrencyThousandsSeparatorTo($thousands_seperator = ',') |
|
49 | + { |
|
50 | + $this->actor()->click(CountrySettings::currencyThousandsSeparatorField($thousands_seperator)); |
|
51 | + } |
|
52 | 52 | |
53 | 53 | |
54 | - /** |
|
55 | - * Clicks the country settings submit button. |
|
56 | - * Assumes the actor is on the country settings admin page. |
|
57 | - */ |
|
58 | - public function saveCountrySettings() |
|
59 | - { |
|
60 | - $this->actor()->click(CountrySettings::COUNTRY_SETTINGS_SAVE_BUTTON); |
|
61 | - //no indicator on the page when stuff has been updated so just give a bit of time for it to finish. |
|
62 | - $this->actor()->wait(10); |
|
63 | - } |
|
54 | + /** |
|
55 | + * Clicks the country settings submit button. |
|
56 | + * Assumes the actor is on the country settings admin page. |
|
57 | + */ |
|
58 | + public function saveCountrySettings() |
|
59 | + { |
|
60 | + $this->actor()->click(CountrySettings::COUNTRY_SETTINGS_SAVE_BUTTON); |
|
61 | + //no indicator on the page when stuff has been updated so just give a bit of time for it to finish. |
|
62 | + $this->actor()->wait(10); |
|
63 | + } |
|
64 | 64 | } |
65 | 65 | \ No newline at end of file |
@@ -15,139 +15,139 @@ |
||
15 | 15 | trait RegistrationsAdmin |
16 | 16 | { |
17 | 17 | |
18 | - /** |
|
19 | - * This will select all checkboxes on a registration list table for the given array of |
|
20 | - * registration ids. |
|
21 | - * Assumes the actor is on a list table page for registrations. |
|
22 | - * @param $registration_ids |
|
23 | - */ |
|
24 | - public function selectBulkActionCheckboxesForRegistrationIds(array $registration_ids) |
|
25 | - { |
|
26 | - foreach ($registration_ids as $registration_id) { |
|
27 | - $this->actor()->checkOption( |
|
28 | - RegistrationsAdminPage::listTableCheckBoxSelectorForRegistrationId($registration_id) |
|
29 | - ); |
|
30 | - } |
|
31 | - } |
|
32 | - |
|
33 | - |
|
34 | - /** |
|
35 | - * Navigates the actor to the default registration list table page. |
|
36 | - * @param string $additional_params |
|
37 | - */ |
|
38 | - public function amOnDefaultRegistrationsListTableAdminPage($additional_params = '') |
|
39 | - { |
|
40 | - $this->actor()->amOnAdminPage( |
|
41 | - RegistrationsAdminPage::registrationsDefaultAdminListTableUrl($additional_params) |
|
42 | - ); |
|
43 | - //wait for page to fully load |
|
44 | - $this->actor()->wait(5); |
|
45 | - } |
|
46 | - |
|
47 | - |
|
48 | - /** |
|
49 | - * Will enter the provided value in the registration list table search field and execute a search for that value. |
|
50 | - * @param string $search_text |
|
51 | - */ |
|
52 | - public function searchForRegistrationOnRegistrationListTableWithText($search_text) |
|
53 | - { |
|
54 | - $this->amOnDefaultRegistrationsListTableAdminPage(); |
|
55 | - $this->actor()->fillField(RegistrationsAdminPage::SEARCH_INPUT_SELECTOR_LIST_TABLE_REGISTRATION, $search_text); |
|
56 | - $this->actor()->click(CoreAdmin::LIST_TABLE_SEARCH_SUBMIT_SELECTOR); |
|
57 | - $this->actor()->waitForText('Displaying search results for'); |
|
58 | - } |
|
59 | - |
|
60 | - |
|
61 | - |
|
62 | - /** |
|
63 | - * This will filter the registration list table to view registrations for the given event id. |
|
64 | - * Assumption is made that you are logged into the admin but you do not need to be on the registration list table |
|
65 | - * page. |
|
66 | - * |
|
67 | - * @param int $event_id The id of the event viewing registrations for. |
|
68 | - */ |
|
69 | - public function amViewingRegistrationsForEvent($event_id) |
|
70 | - { |
|
71 | - $this->actor()->amOnDefaultEventsListTablePage(); |
|
72 | - $this->actor()->click(EventsAdmin::listTableActionLinkRegistrationsForEvent($event_id)); |
|
73 | - $this->actor()->waitForText('Viewing registrations for the event'); |
|
74 | - } |
|
75 | - |
|
76 | - |
|
77 | - /** |
|
78 | - * This helper will initiate registering for the given event via the backend. |
|
79 | - * @param int $event_id The event to initiate registration for. |
|
80 | - */ |
|
81 | - public function amOnAdminRegistrationPageForEvent($event_id) |
|
82 | - { |
|
83 | - $this->actor()->amViewingRegistrationsForEvent($event_id); |
|
84 | - $this->actor()->click(RegistrationsAdminPage::BUTTON_ADD_NEW_REGISTRATION); |
|
85 | - $this->actor()->waitForText('Adding Registration For'); |
|
86 | - } |
|
87 | - |
|
88 | - |
|
89 | - |
|
90 | - /** |
|
91 | - * This clicks the View Details Link for Registration with the given Id |
|
92 | - * @param $registration_id |
|
93 | - */ |
|
94 | - public function clickViewDetailsLinkForRegistrationWithId($registration_id) |
|
95 | - { |
|
96 | - $this->actor()->click(RegistrationsAdminPage::viewDetailsLinkSelectorForRegistrationId($registration_id)); |
|
97 | - } |
|
98 | - |
|
99 | - |
|
100 | - /** |
|
101 | - * /** |
|
102 | - * This assumes you are on the admin details page for a registration in EE. It selects the given status in the |
|
103 | - * dropdown for changing registration status. |
|
104 | - * |
|
105 | - * @param string $status_label_or_value Either the label for the dropdown option or the value for the option. |
|
106 | - * @param $status_label_or_value |
|
107 | - */ |
|
108 | - public function selectRegistrationStatusOnRegistrationDetailsPageFor($status_label_or_value) |
|
109 | - { |
|
110 | - $this->actor()->selectOption( |
|
111 | - RegistrationsAdminPage::DROPDOWN_REGISTRATION_STATUS, |
|
112 | - $status_label_or_value |
|
113 | - ); |
|
114 | - } |
|
115 | - |
|
116 | - |
|
117 | - /** |
|
118 | - * This selects (or deselects) the "Send Related Messages" checkbox on the Registration Details page. |
|
119 | - * @param bool $send_related_messages |
|
120 | - */ |
|
121 | - public function selectSendRelatedMessagesOptionOnRegistrationDetailsPage($send_related_messages = true) |
|
122 | - { |
|
123 | - $send_related_messages |
|
124 | - ? $this->actor()->selectOption( |
|
125 | - RegistrationsAdminPage::DROPDOWN_SEND_RELATED_MESSAGES, |
|
126 | - 'Yes' |
|
127 | - ) |
|
128 | - : $this->actor()->selecOption( |
|
129 | - RegistrationsAdminPage::DROPDOWN_SEND_RELATED_MESSAGES, |
|
130 | - 'No' |
|
131 | - ); |
|
132 | - } |
|
133 | - |
|
134 | - |
|
135 | - |
|
136 | - /** |
|
137 | - * This assumes you are on the admin details page for a registration in EE. It selects the given status in the |
|
138 | - * dropdown for changing registration status and submits the change. |
|
139 | - * |
|
140 | - * @param string $status_label_or_value Either the label for the dropdown option or the value for the option. |
|
141 | - * @param bool $send_related_messages Whether or not to send related messages after changing the bulk action. |
|
142 | - */ |
|
143 | - public function changeRegistrationStatusOnRegistrationDetailsPageTo( |
|
144 | - $status_label_or_value, |
|
145 | - $send_related_messages = true |
|
146 | - ) { |
|
147 | - $this->actor()->selectRegistrationStatusOnRegistrationDetailsPageFor($status_label_or_value); |
|
148 | - $this->actor()->selectSendRelatedMessagesOptionOnRegistrationDetailsPage($send_related_messages); |
|
149 | - $this->actor()->click(RegistrationsAdminPage::BUTTON_UPDATE_REGISTRATION_STATUS); |
|
150 | - $this->actor()->waitForText('Registration status has been set to'); |
|
151 | - } |
|
18 | + /** |
|
19 | + * This will select all checkboxes on a registration list table for the given array of |
|
20 | + * registration ids. |
|
21 | + * Assumes the actor is on a list table page for registrations. |
|
22 | + * @param $registration_ids |
|
23 | + */ |
|
24 | + public function selectBulkActionCheckboxesForRegistrationIds(array $registration_ids) |
|
25 | + { |
|
26 | + foreach ($registration_ids as $registration_id) { |
|
27 | + $this->actor()->checkOption( |
|
28 | + RegistrationsAdminPage::listTableCheckBoxSelectorForRegistrationId($registration_id) |
|
29 | + ); |
|
30 | + } |
|
31 | + } |
|
32 | + |
|
33 | + |
|
34 | + /** |
|
35 | + * Navigates the actor to the default registration list table page. |
|
36 | + * @param string $additional_params |
|
37 | + */ |
|
38 | + public function amOnDefaultRegistrationsListTableAdminPage($additional_params = '') |
|
39 | + { |
|
40 | + $this->actor()->amOnAdminPage( |
|
41 | + RegistrationsAdminPage::registrationsDefaultAdminListTableUrl($additional_params) |
|
42 | + ); |
|
43 | + //wait for page to fully load |
|
44 | + $this->actor()->wait(5); |
|
45 | + } |
|
46 | + |
|
47 | + |
|
48 | + /** |
|
49 | + * Will enter the provided value in the registration list table search field and execute a search for that value. |
|
50 | + * @param string $search_text |
|
51 | + */ |
|
52 | + public function searchForRegistrationOnRegistrationListTableWithText($search_text) |
|
53 | + { |
|
54 | + $this->amOnDefaultRegistrationsListTableAdminPage(); |
|
55 | + $this->actor()->fillField(RegistrationsAdminPage::SEARCH_INPUT_SELECTOR_LIST_TABLE_REGISTRATION, $search_text); |
|
56 | + $this->actor()->click(CoreAdmin::LIST_TABLE_SEARCH_SUBMIT_SELECTOR); |
|
57 | + $this->actor()->waitForText('Displaying search results for'); |
|
58 | + } |
|
59 | + |
|
60 | + |
|
61 | + |
|
62 | + /** |
|
63 | + * This will filter the registration list table to view registrations for the given event id. |
|
64 | + * Assumption is made that you are logged into the admin but you do not need to be on the registration list table |
|
65 | + * page. |
|
66 | + * |
|
67 | + * @param int $event_id The id of the event viewing registrations for. |
|
68 | + */ |
|
69 | + public function amViewingRegistrationsForEvent($event_id) |
|
70 | + { |
|
71 | + $this->actor()->amOnDefaultEventsListTablePage(); |
|
72 | + $this->actor()->click(EventsAdmin::listTableActionLinkRegistrationsForEvent($event_id)); |
|
73 | + $this->actor()->waitForText('Viewing registrations for the event'); |
|
74 | + } |
|
75 | + |
|
76 | + |
|
77 | + /** |
|
78 | + * This helper will initiate registering for the given event via the backend. |
|
79 | + * @param int $event_id The event to initiate registration for. |
|
80 | + */ |
|
81 | + public function amOnAdminRegistrationPageForEvent($event_id) |
|
82 | + { |
|
83 | + $this->actor()->amViewingRegistrationsForEvent($event_id); |
|
84 | + $this->actor()->click(RegistrationsAdminPage::BUTTON_ADD_NEW_REGISTRATION); |
|
85 | + $this->actor()->waitForText('Adding Registration For'); |
|
86 | + } |
|
87 | + |
|
88 | + |
|
89 | + |
|
90 | + /** |
|
91 | + * This clicks the View Details Link for Registration with the given Id |
|
92 | + * @param $registration_id |
|
93 | + */ |
|
94 | + public function clickViewDetailsLinkForRegistrationWithId($registration_id) |
|
95 | + { |
|
96 | + $this->actor()->click(RegistrationsAdminPage::viewDetailsLinkSelectorForRegistrationId($registration_id)); |
|
97 | + } |
|
98 | + |
|
99 | + |
|
100 | + /** |
|
101 | + * /** |
|
102 | + * This assumes you are on the admin details page for a registration in EE. It selects the given status in the |
|
103 | + * dropdown for changing registration status. |
|
104 | + * |
|
105 | + * @param string $status_label_or_value Either the label for the dropdown option or the value for the option. |
|
106 | + * @param $status_label_or_value |
|
107 | + */ |
|
108 | + public function selectRegistrationStatusOnRegistrationDetailsPageFor($status_label_or_value) |
|
109 | + { |
|
110 | + $this->actor()->selectOption( |
|
111 | + RegistrationsAdminPage::DROPDOWN_REGISTRATION_STATUS, |
|
112 | + $status_label_or_value |
|
113 | + ); |
|
114 | + } |
|
115 | + |
|
116 | + |
|
117 | + /** |
|
118 | + * This selects (or deselects) the "Send Related Messages" checkbox on the Registration Details page. |
|
119 | + * @param bool $send_related_messages |
|
120 | + */ |
|
121 | + public function selectSendRelatedMessagesOptionOnRegistrationDetailsPage($send_related_messages = true) |
|
122 | + { |
|
123 | + $send_related_messages |
|
124 | + ? $this->actor()->selectOption( |
|
125 | + RegistrationsAdminPage::DROPDOWN_SEND_RELATED_MESSAGES, |
|
126 | + 'Yes' |
|
127 | + ) |
|
128 | + : $this->actor()->selecOption( |
|
129 | + RegistrationsAdminPage::DROPDOWN_SEND_RELATED_MESSAGES, |
|
130 | + 'No' |
|
131 | + ); |
|
132 | + } |
|
133 | + |
|
134 | + |
|
135 | + |
|
136 | + /** |
|
137 | + * This assumes you are on the admin details page for a registration in EE. It selects the given status in the |
|
138 | + * dropdown for changing registration status and submits the change. |
|
139 | + * |
|
140 | + * @param string $status_label_or_value Either the label for the dropdown option or the value for the option. |
|
141 | + * @param bool $send_related_messages Whether or not to send related messages after changing the bulk action. |
|
142 | + */ |
|
143 | + public function changeRegistrationStatusOnRegistrationDetailsPageTo( |
|
144 | + $status_label_or_value, |
|
145 | + $send_related_messages = true |
|
146 | + ) { |
|
147 | + $this->actor()->selectRegistrationStatusOnRegistrationDetailsPageFor($status_label_or_value); |
|
148 | + $this->actor()->selectSendRelatedMessagesOptionOnRegistrationDetailsPage($send_related_messages); |
|
149 | + $this->actor()->click(RegistrationsAdminPage::BUTTON_UPDATE_REGISTRATION_STATUS); |
|
150 | + $this->actor()->waitForText('Registration status has been set to'); |
|
151 | + } |
|
152 | 152 | |
153 | 153 | } |
154 | 154 | \ No newline at end of file |