EventEspresso\Codeception\helpers\BaseCoreAdmin

Complexity

Total Complexity

5

Size/Duplication

Total Lines	72
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	amOnEventEspressoAdminPage()	0	4	1
A	actor()	0	5	1
A	setPerPageOptionForScreen()	0	7	1
A	appendToWPEditorField()	0	5	1
A	submitBulkActionOnListTable()	0	8	1

<?php
namespace EventEspresso\Codeception\helpers;

use Page\CoreAdmin;

/**
 * Trait BaseCoreAdmin
 * Contains actions for more generic EE Admin page navigation.  Generally speaking it is preferable to create a helper
 * specific to an EE admin page you want actions for, but this is provided for quicker setup as necessary.
 *
 * @package EventEspresso\Codeception\helpers
 */
trait BaseCoreAdmin
{

    /**
     * Core method for going to an Event Espresso Admin page.
     * @param string $page
     * @param string $action
     * @param string $additional_params
     */
    public function amOnEventEspressoAdminPage($page = '', $action = '', $additional_params = '')
    {
        $this->actor()->amOnAdminPage(CoreAdmin::adminUrl($page, $action, $additional_params));
    }


    /**
     * Helper method for returning an instance of the Actor.  Intended to help with IDE fill out of methods.
     * @return \EventEspressoAcceptanceTester;
     */
    protected function actor()
    {
        /** @var \EventEspressoAcceptanceTester $this */
        return $this;
    }


    /**
     * Use this to set the per page option for a list table page.
     * Assumes you are on a page that has this field exposed.
     *
     * @param int|string $per_page_value
     * @throws \Codeception\Exception\TestRuntimeException
     */
    public function setPerPageOptionForScreen($per_page_value)
    {
        $this->actor()->click(CoreAdmin::WP_SCREEN_SETTINGS_LINK_SELECTOR);
        $this->actor()->fillField(CoreAdmin::WP_SCREEN_SETTINGS_PER_PAGE_FIELD_SELECTOR, $per_page_value);
        $this->actor()->click(CoreAdmin::WP_SCREEN_OPTIONS_APPLY_SETTINGS_BUTTON_SELECTOR);
        $this->actor()->wait(8);
    }



    /**
     * Use this to append a given value to a wpEditor instance.
     * How it works is it first switched the instance to the text (or html) view so that the textarea is exposed and
     * the value is added to the text area.
     *
     * @param $field_reference
     * @param $value
     * @throws \Codeception\Exception\ElementNotFound
     */
    public function appendToWPEditorField($field_reference, $value)
    {
        $this->actor()->click(CoreAdmin::wpEditorTextTabSelector($field_reference));
        $this->actor()->appendField(CoreAdmin::wpEditorTextAreaSelector($field_reference), $value);
    }


    /**
     * Use to select and submit the given bulk action.
     * @param string $bulk_action_option
     */
    public function submitBulkActionOnListTable($bulk_action_option)
    {
        $this->actor()->selectOption(
            CoreAdmin::SELECTOR_LIST_TABLE_BULK_ACTION_FIELD,
            $bulk_action_option
        );
        $this->actor()->click(CoreAdmin::SELECTOR_LIST_TABLE_BULK_ACTTION_APPLY);
    }
}