Completed
Branch FET-10486-add-timestamp-checki... (611b15)
by
unknown
136:24 queued 121:17
created

MessagesAdmin::amOnMessageSettingsPage()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 1
Metric Value
cc 1
eloc 2
c 1
b 0
f 1
nc 1
nop 0
dl 0
loc 4
rs 10
1
<?php
2
namespace EventEspresso\Codeception\helpers;
3
4
use Page\MessagesAdmin as MessagesPage;
5
6
/**
7
 * Trait MessagesAdmin
8
 * Helper actions for the Messages Admin Pages
9
 * @package EventEspresso\Codeception\helpers
10
 */
11
trait MessagesAdmin
12
{
13
    /**
14
     * @param string $additional_params Any additional request parameters for the generated url should be included as
15
     *                                  a string.
16
     */
17
    public function amOnMessagesActivityListTablePage($additional_params = '')
18
    {
19
        $this->actor()->amOnAdminPage(MessagesPage::messageActivityListTableUrl($additional_params));
0 ignored issues
show
Bug introduced by
It seems like actor() must be provided by classes using this trait. How about adding it as abstract method to this trait?

This check looks for methods that are used by a trait but not required by it.

To illustrate, let’s look at the following code example

trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

The trait Idable provides a method equalsId that in turn relies on the method getId(). If this method does not exist on a class mixing in this trait, the method will fail.

Adding the getId() as an abstract method to the trait will make sure it is available.

Loading history...
20
    }
21
22
    /**
23
     * @param string $additional_params Any additional request parameters for the generated url should be included as
24
     *                                  a string.
25
     */
26
    public function amOnDefaultMessageTemplateListTablePage($additional_params = '')
27
    {
28
        $this->actor()->amOnAdminPage(MessagesPage::defaultMessageTemplateListTableUrl($additional_params));
0 ignored issues
show
Bug introduced by
It seems like actor() must be provided by classes using this trait. How about adding it as abstract method to this trait?

This check looks for methods that are used by a trait but not required by it.

To illustrate, let’s look at the following code example

trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

The trait Idable provides a method equalsId that in turn relies on the method getId(). If this method does not exist on a class mixing in this trait, the method will fail.

Adding the getId() as an abstract method to the trait will make sure it is available.

Loading history...
29
    }
30
31
32
    /**
33
     * @param string $additional_params Any additional request parameters for the generated url should be included as
34
     *                                  a string.
35
     */
36
    public function amOnCustomMessageTemplateListTablePage($additional_params = '')
37
    {
38
        $this->actor()->amOnAdminPage(MessagesPage::customMessageTemplateListTableUrl($additional_params));
0 ignored issues
show
Bug introduced by
It seems like actor() must be provided by classes using this trait. How about adding it as abstract method to this trait?

This check looks for methods that are used by a trait but not required by it.

To illustrate, let’s look at the following code example

trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

The trait Idable provides a method equalsId that in turn relies on the method getId(). If this method does not exist on a class mixing in this trait, the method will fail.

Adding the getId() as an abstract method to the trait will make sure it is available.

Loading history...
39
    }
40
41
42
    /**
43
     * Directs to message settings page
44
     */
45
    public function amOnMessageSettingsPage()
46
    {
47
        $this->actor()->amOnAdminPage(MessagesPage::messageSettingsUrl());
0 ignored issues
show
Bug introduced by
It seems like actor() must be provided by classes using this trait. How about adding it as abstract method to this trait?

This check looks for methods that are used by a trait but not required by it.

To illustrate, let’s look at the following code example

trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

The trait Idable provides a method equalsId that in turn relies on the method getId(). If this method does not exist on a class mixing in this trait, the method will fail.

Adding the getId() as an abstract method to the trait will make sure it is available.

Loading history...
48
    }
49
50
51
    /**
52
     * Assumes you are already on the list table page that has the ui for editing the template.
53
     * @param string $message_type_slug
54
     * @param string $context [optional] if you want to click directly to the given context in the editor
55
     */
56
    public function clickToEditMessageTemplateByMessageType($message_type_slug, $context = '')
57
    {
58
        $this->actor()->click(MessagesPage::editMessageTemplateClassByMessageType($message_type_slug, $context));
0 ignored issues
show
Bug introduced by
It seems like actor() must be provided by classes using this trait. How about adding it as abstract method to this trait?

This check looks for methods that are used by a trait but not required by it.

To illustrate, let’s look at the following code example

trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

The trait Idable provides a method equalsId that in turn relies on the method getId(). If this method does not exist on a class mixing in this trait, the method will fail.

Adding the getId() as an abstract method to the trait will make sure it is available.

Loading history...
59
    }
60
61
62
    /**
63
     * Use this action to verify that the count for the given text in the specified field is as expected.  For example
64
     * filling the condition of, "There should only be 1 instance of `[email protected]` in all the 'to' column.
65
     *
66
     * @param int    $expected_occurence_count
67
     * @param string $text_to_check_for
68
     * @param string $field
69
     * @param string $message_type_label
70
     * @param string $message_status
71
     * @param string $messenger
72
     * @param string $context
73
     */
74
    public function verifyMatchingCountofTextInMessageActivityListTableFor(
75
        $expected_occurence_count,
76
        $text_to_check_for,
77
        $field,
78
        $message_type_label,
79
        $message_status = MessagesPage::MESSAGE_STATUS_SENT,
80
        $messenger = 'Email',
81
        $context = 'Event Admin'
82
    ) {
83
        $elements = $this->actor()->grabMultiple(MessagesPage::messagesActivityListTableCellSelectorFor(
0 ignored issues
show
Bug introduced by
It seems like actor() must be provided by classes using this trait. How about adding it as abstract method to this trait?

This check looks for methods that are used by a trait but not required by it.

To illustrate, let’s look at the following code example

trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

The trait Idable provides a method equalsId that in turn relies on the method getId(). If this method does not exist on a class mixing in this trait, the method will fail.

Adding the getId() as an abstract method to the trait will make sure it is available.

Loading history...
84
            $field,
85
            $message_type_label,
86
            $message_status,
87
            $messenger,
88
            $context,
89
            $text_to_check_for
90
        ));
91
        $actual_count = count($elements);
92
        $this->actor()->assertEquals(
0 ignored issues
show
Bug introduced by
It seems like actor() must be provided by classes using this trait. How about adding it as abstract method to this trait?

This check looks for methods that are used by a trait but not required by it.

To illustrate, let’s look at the following code example

trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

The trait Idable provides a method equalsId that in turn relies on the method getId(). If this method does not exist on a class mixing in this trait, the method will fail.

Adding the getId() as an abstract method to the trait will make sure it is available.

Loading history...
93
            $expected_occurence_count,
94
            $actual_count,
95
            sprintf(
96
                'Expected %s of the %s text for the %s field but there were actually %s counted.',
97
                $expected_occurence_count,
98
                $text_to_check_for,
99
                $field,
100
                $actual_count
101
            )
102
        );
103
    }
104
105
}