Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | Public Attributes | List of all members
behat_calendar Class Reference
Inheritance diagram for behat_calendar:
behat_base behat_session_interface

Public Member Functions

 getSession ($name=null)
 Returns the Mink session. More...
 
 i_am_viewing_site_calendar ()
 Navigate to site calendar. More...
 
 i_create_a_calendar_event ($data)
 Create event. More...
 
 i_create_a_calendar_event_with_form_data ($data)
 Create event when starting on the front page. More...
 
 i_hover_over_day_of_this_month_in_calendar ($day)
 Hover over a specific day in the calendar. More...
 
 i_hover_over_today_in_the_calendar ()
 Hover over today in the calendar. More...
 
 i_view_the_calendar_for ($month, $year)
 Navigate to a specific date in the calendar. More...
 

Public Attributes

const EXTENDED_TIMEOUT = 10
 And extended timeout for specific cases. More...
 
const PAGE_READY_JS
 The JS code to check that the page is ready. More...
 
const REDUCED_TIMEOUT = 2
 Small timeout. More...
 
const TIMEOUT = 6
 The timeout for each Behat step (load page, wait for an element to load...). More...
 

Member Function Documentation

◆ getSession()

behat_session_interface::getSession (   $name = null)
inherited

Returns the Mink session.

Parameters
string | null$namename of the session OR active session will be used
Return values
Behat::Mink::Session

Implemented in behat_form_field.

◆ i_am_viewing_site_calendar()

behat_calendar::i_am_viewing_site_calendar ( )

Navigate to site calendar.

@Given /^I am viewing site calendar$/

Exceptions
coding_exception
Return values
void

◆ i_create_a_calendar_event()

behat_calendar::i_create_a_calendar_event (   $data)

Create event.

@Given /^I create a calendar event:$/

Parameters
TableNode$data

◆ i_create_a_calendar_event_with_form_data()

behat_calendar::i_create_a_calendar_event_with_form_data (   $data)

Create event when starting on the front page.

@Given /^I create a calendar event with form data:$/

Parameters
TableNode$data

◆ i_hover_over_day_of_this_month_in_calendar()

behat_calendar::i_hover_over_day_of_this_month_in_calendar (   $day)

Hover over a specific day in the calendar.

@Given /^I hover over day "(?P<dayofmonth>::d+)" of this month in the calendar$/

Parameters
int$dayThe day of the current month

◆ i_hover_over_today_in_the_calendar()

behat_calendar::i_hover_over_today_in_the_calendar ( )

Hover over today in the calendar.

@Given /^I hover over today in the calendar$/

◆ i_view_the_calendar_for()

behat_calendar::i_view_the_calendar_for (   $month,
  $year 
)

Navigate to a specific date in the calendar.

@Given /^I view the calendar for "(?P<month>::d+)" "(?P<year>\d+)"$/

Parameters
int$monththe month selected as a number
int$yearthe four digit year

Member Data Documentation

◆ EXTENDED_TIMEOUT

const behat_session_interface::EXTENDED_TIMEOUT = 10
inherited

And extended timeout for specific cases.

Deprecated:
since Moodle 3.7 MDL-64979 - please use get_extended_timeout() instead
Todo:
MDL-64982 This will be deleted in Moodle 3.11
See also
behat_base::get_extended_timeout()

◆ PAGE_READY_JS

const behat_session_interface::PAGE_READY_JS
inherited
Initial value:
= "document.readyState === 'complete' && " .
"(typeof M !== 'object' || typeof M.util !== 'object' || " .
"typeof M.util.pending_js === 'undefined' || M.util.pending_js.length === 0)"

The JS code to check that the page is ready.

The document must be complete and either M.util.pending_js must be empty, or it must not be defined at all.

◆ REDUCED_TIMEOUT

const behat_session_interface::REDUCED_TIMEOUT = 2
inherited

Small timeout.

A reduced timeout for cases where self::TIMEOUT is too much and a simple $this->getSession()->getPage()->find() could not be enough.

Deprecated:
since Moodle 3.7 MDL-64979 - please use get_reduced_timeout() instead
Todo:
MDL-64982 This will be deleted in Moodle 3.11
See also
behat_base::get_reduced_timeout()

◆ TIMEOUT

const behat_session_interface::TIMEOUT = 6
inherited

The timeout for each Behat step (load page, wait for an element to load...).

Deprecated:
since Moodle 3.7 MDL-64979 - please use get_timeout() instead
Todo:
MDL-64982 This will be deleted in Moodle 3.11
See also
behat_base::get_timeout()

The documentation for this class was generated from the following file: