give
/
vendor
/
vendor-prefixed
/
stellarwp
/
admin-notices
/
src
/
Actions
/
NoticeShouldRender.php
DisplayNoticesInAdmin.php
1 year ago
EnqueueNoticesScriptsAndStyles.php
1 year ago
NoticeShouldRender.php
1 year ago
RenderAdminNotice.php
1 year ago
NoticeShouldRender.php
175 lines
| 1 | <?php |
| 2 | |
| 3 | declare(strict_types=1); |
| 4 | |
| 5 | |
| 6 | namespace Give\Vendors\StellarWP\AdminNotices\Actions; |
| 7 | |
| 8 | use DateTimeImmutable; |
| 9 | use DateTimeZone; |
| 10 | use Give\Vendors\StellarWP\AdminNotices\AdminNotice; |
| 11 | use Give\Vendors\StellarWP\AdminNotices\Traits\HasNamespace; |
| 12 | |
| 13 | /** |
| 14 | * Checks whether the given notice should be rendered based on the provided conditions. |
| 15 | * |
| 16 | * @since 2.0.0 |
| 17 | */ |
| 18 | class NoticeShouldRender |
| 19 | { |
| 20 | use HasNamespace; |
| 21 | |
| 22 | /** |
| 23 | * @since 2.0.0 |
| 24 | */ |
| 25 | public function __invoke(AdminNotice $notice): bool |
| 26 | { |
| 27 | return $this->passesDismissedConditions($notice) |
| 28 | && $this->passesDateLimits($notice) |
| 29 | && $this->passesWhenCallback($notice) |
| 30 | && $this->passesUserCapabilities($notice) |
| 31 | && $this->passesScreenConditions($notice); |
| 32 | } |
| 33 | |
| 34 | /** |
| 35 | * Checks whether the notice should be displayed based on the provided date limits. |
| 36 | * |
| 37 | * @since 2.0.0 moved to the NoticeShouldRender class |
| 38 | * @since 1.0.0 |
| 39 | */ |
| 40 | private function passesDateLimits(AdminNotice $notice): bool |
| 41 | { |
| 42 | if (!$notice->getAfterDate() && !$notice->getUntilDate()) { |
| 43 | return true; |
| 44 | } |
| 45 | |
| 46 | $now = new DateTimeImmutable('now', new DateTimeZone('UTC')); |
| 47 | |
| 48 | if ($notice->getAfterDate() && $notice->getAfterDate() > $now) { |
| 49 | return false; |
| 50 | } |
| 51 | |
| 52 | if ($notice->getUntilDate() && $notice->getUntilDate() < $now) { |
| 53 | return false; |
| 54 | } |
| 55 | |
| 56 | return true; |
| 57 | } |
| 58 | |
| 59 | /** |
| 60 | * Checks whether the notice should be displayed based on the provided callback. |
| 61 | * |
| 62 | * @since 2.0.0 moved to the NoticeShouldRender class |
| 63 | * @since 1.0.0 |
| 64 | */ |
| 65 | private function passesWhenCallback(AdminNotice $notice): bool |
| 66 | { |
| 67 | $callback = $notice->getWhenCallback(); |
| 68 | |
| 69 | if ($callback === null) { |
| 70 | return true; |
| 71 | } |
| 72 | |
| 73 | return $callback(); |
| 74 | } |
| 75 | |
| 76 | /** |
| 77 | * Checks whether user limits were provided and they pass. Only one capability is required to pass, allowing for |
| 78 | * multiple users have visibility. |
| 79 | * |
| 80 | * @since 2.0.0 moved to the NoticeShouldRender class |
| 81 | * @since 1.0.0 |
| 82 | */ |
| 83 | private function passesUserCapabilities(AdminNotice $notice): bool |
| 84 | { |
| 85 | $capabilities = $notice->getUserCapabilities(); |
| 86 | |
| 87 | if (empty($capabilities)) { |
| 88 | return true; |
| 89 | } |
| 90 | |
| 91 | foreach ($capabilities as $capability) { |
| 92 | if ($capability->currentUserCan()) { |
| 93 | return true; |
| 94 | } |
| 95 | } |
| 96 | |
| 97 | return false; |
| 98 | } |
| 99 | |
| 100 | /** |
| 101 | * Checks whether the notice is limited to specific screens and the current screen matches the conditions. Only one |
| 102 | * screen condition is required to pass, allowing for the notice to appear on multiple screens. |
| 103 | * |
| 104 | * @since 2.0.0 moved to the NoticeShouldRender class |
| 105 | * @since 1.0.0 |
| 106 | */ |
| 107 | private function passesScreenConditions(AdminNotice $notice): bool |
| 108 | { |
| 109 | $screenConditions = $notice->getOnConditions(); |
| 110 | |
| 111 | if (empty($screenConditions)) { |
| 112 | return true; |
| 113 | } |
| 114 | |
| 115 | $screen = get_current_screen(); |
| 116 | $currentUrl = get_admin_url(null, $_SERVER['REQUEST_URI']); |
| 117 | |
| 118 | foreach ($screenConditions as $screenCondition) { |
| 119 | $condition = $screenCondition->getCondition(); |
| 120 | |
| 121 | if ($screenCondition->isRegex()) { |
| 122 | // do a regex comparison on the current url |
| 123 | if (preg_match($condition, $currentUrl) === 1) { |
| 124 | return true; |
| 125 | } |
| 126 | } elseif (is_string($condition)) { |
| 127 | // do a string comparison on the current url |
| 128 | if (strpos($currentUrl, $condition) !== false) { |
| 129 | return true; |
| 130 | } |
| 131 | } else { |
| 132 | // compare the condition array against the WP_Screen object |
| 133 | foreach ($condition as $property => $value) { |
| 134 | if ($screen->$property === $value) { |
| 135 | return true; |
| 136 | } |
| 137 | } |
| 138 | } |
| 139 | } |
| 140 | |
| 141 | return false; |
| 142 | } |
| 143 | |
| 144 | /** |
| 145 | * Checks whether the notice has been dismissed by the user. |
| 146 | * |
| 147 | * @since 2.0.0 moved to the NoticeShouldRender class |
| 148 | * @since 1.1.0 added namespacing to the preferences key |
| 149 | * @since 1.0.0 |
| 150 | */ |
| 151 | private function passesDismissedConditions(AdminNotice $notice): bool |
| 152 | { |
| 153 | global $wpdb; |
| 154 | |
| 155 | $userPreferences = get_user_meta( |
| 156 | get_current_user_id(), |
| 157 | $wpdb->get_blog_prefix() . 'persisted_preferences', |
| 158 | true |
| 159 | ); |
| 160 | |
| 161 | $key = "stellarwp/admin-notices/$this->namespace"; |
| 162 | if (!is_array($userPreferences) || empty($userPreferences[$key])) { |
| 163 | return true; |
| 164 | } |
| 165 | |
| 166 | $dismissedNotices = $userPreferences[$key]; |
| 167 | |
| 168 | if (key_exists($notice->getId(), $dismissedNotices)) { |
| 169 | return false; |
| 170 | } |
| 171 | |
| 172 | return true; |
| 173 | } |
| 174 | } |
| 175 |