Code Coverage |
||||||||||
Classes and Traits |
Functions and Methods |
Lines |
||||||||
| Total | |
100.00% |
1 / 1 |
|
100.00% |
3 / 3 |
CRAP | |
100.00% |
15 / 15 |
| SurveyContextFilter | |
100.00% |
1 / 1 |
|
100.00% |
3 / 3 |
12 | |
100.00% |
15 / 15 |
| __construct | |
100.00% |
1 / 1 |
1 | |
100.00% |
2 / 2 |
|||
| isAnySurveyAvailable | |
100.00% |
1 / 1 |
8 | |
100.00% |
8 / 8 |
|||
| isKnownPageId | |
100.00% |
1 / 1 |
3 | |
100.00% |
5 / 5 |
|||
| <?php | |
| namespace QuickSurveys; | |
| use Title; | |
| /** | |
| * Determine whether any surveys will be shown on the current pageview. | |
| */ | |
| class SurveyContextFilter { | |
| /** | |
| * The internal name of the view action (see \ViewAction) as returned by Action::getActionName. | |
| */ | |
| private const VIEW_ACTION_NAME = 'view'; | |
| /** | |
| * @var Survey[] | |
| */ | |
| private $surveys; | |
| public function __construct( array $surveys ) { | |
| $this->surveys = $surveys; | |
| } | |
| public function isAnySurveyAvailable( ?Title $title, string $action ): bool { | |
| if ( !$this->surveys ) { | |
| return false; | |
| } | |
| if ( $title === null || $action !== static::VIEW_ACTION_NAME ) { | |
| return false; | |
| } | |
| // Typically disabled outside of the main namespace, as well as on the main page | |
| if ( !$title->inNamespace( NS_MAIN ) || $title->isMainPage() ) { | |
| // Allow surveys to target specific pages regardless of namespace. | |
| if ( !$this->isKnownPageId( $title->getArticleID() ) ) { | |
| return false; | |
| } | |
| } | |
| return $title->exists(); | |
| } | |
| private function isKnownPageId( int $pageId ): bool { | |
| foreach ( $this->surveys as $survey ) { | |
| $audience = $survey->getAudience()->toArray(); | |
| if ( in_array( $pageId, $audience['pageIds'] ?? [] ) ) { | |
| return true; | |
| } | |
| } | |
| return false; | |
| } | |
| } |