You are here

Home » API reference » Date 8 » DateRRuleCalcTest.php

class DateRRuleCalcTest in Date 8

Hierarchy

Expanded class hierarchy of DateRRuleCalcTest

File

date_repeat/lib/Drupal/date_repeat/Tests/DateRRuleCalcTest.php, line 14
Test Date Repeat calculations.

Namespace

Drupal\date_repeat\Tests
View source 
class DateRRuleCalcTest extends WebTestBase {
  public static function getInfo() {
    return array(
      'name' => t('Date RRule'),
      'description' => t('Test Date RRule functions to create arrays of dates from iCal RRules.'),
      'group' => t('Date'),
    );
  }

  /**
   * Load the date_repeat module.
   */
  public static $modules = array(
    'date_api',
    'date_repeat',
  );
  public function testDateRRuleCalc() {

    // Examples adapted from http://www.faqs.org/rfcs/rfc2445.html and
    // http://www.kanzaki.com/docs/ical/rrule.html.
    //  Invalid value:
    $start = "1997-09-02 09:00:00";
    $end = "1997-09-30 09:00:00";
    $rule = "RRULE:FREQ=NONE;INTERVAL=0;COUNT=10";
    $start = new DrupalDateTime($start);
    $end = new DrupalDateTime($end);
    $dates = new DateRRuleCalc($rule, $start, $end, array());

    //  should be (1997 9:00 AM EDT)September 2-11
    $shouldbe = '';
    $result = implode(', ', $dates
      ->compute());
    $this
      ->assertEqual($result, $shouldbe, $rule . '; results: ' . $result);

    //  Daily for 10 occurrences:
    $start = "1997-09-02 09:00:00";
    $end = "1997-09-30 09:00:00";
    $rule = "RRULE:FREQ=DAILY;COUNT=10";
    $start = new DrupalDateTime($start);
    $end = new DrupalDateTime($end);
    $dates = new DateRRuleCalc($rule, $start, $end, array());

    //  should be (1997 9:00 AM EDT)September 2-11
    $shouldbe = '1997-09-02 09:00:00, 1997-09-03 09:00:00, 1997-09-04 09:00:00, 1997-09-05 09:00:00, 1997-09-06 09:00:00, 1997-09-07 09:00:00, 1997-09-08 09:00:00, 1997-09-09 09:00:00, 1997-09-10 09:00:00, 1997-09-11 09:00:00';
    $result = implode(', ', (array) $dates
      ->compute());
    $this
      ->assertEqual($result, $shouldbe, $rule . '; results: ' . $result);

    //Daily until September 24, 1997:
    $start = "1997-09-02 09:00:00";
    $end = "1997-09-30 09:00:00";
    $start = new DrupalDateTime($start);
    $end = new DrupalDateTime($end);
    $rule = "RRULE:FREQ=DAILY;UNTIL=19970924T000000Z";
    $dates = new DateRRuleCalc($rule, $start, $end, array());

    //  should be (1997 9:00 AM EDT)September 2-23
    $shouldbe = '1997-09-02 09:00:00, 1997-09-03 09:00:00, 1997-09-04 09:00:00, 1997-09-05 09:00:00, 1997-09-06 09:00:00, 1997-09-07 09:00:00, 1997-09-08 09:00:00, 1997-09-09 09:00:00, 1997-09-10 09:00:00, 1997-09-11 09:00:00, 1997-09-12 09:00:00, 1997-09-13 09:00:00, 1997-09-14 09:00:00, 1997-09-15 09:00:00, 1997-09-16 09:00:00, 1997-09-17 09:00:00, 1997-09-18 09:00:00, 1997-09-19 09:00:00, 1997-09-20 09:00:00, 1997-09-21 09:00:00, 1997-09-22 09:00:00, 1997-09-23 09:00:00';
    $result = implode(', ', $dates
      ->compute());
    $this
      ->assertEqual($result, $shouldbe, $rule . '; results: ' . $result);

    //Every other day - until September 30:
    $start = "1997-09-02 09:00:00";
    $end = "1997-09-30 09:00:00";
    $start = new DrupalDateTime($start);
    $end = new DrupalDateTime($end);
    $rule = "RRULE:FREQ=DAILY;INTERVAL=2";
    $dates = new DateRRuleCalc($rule, $start, $end, array());

    // should be (1997 9:00 AM EDT)September2,4,6,8...24,26,28,30;
    $shouldbe = '1997-09-02 09:00:00, 1997-09-04 09:00:00, 1997-09-06 09:00:00, 1997-09-08 09:00:00, 1997-09-10 09:00:00, 1997-09-12 09:00:00, 1997-09-14 09:00:00, 1997-09-16 09:00:00, 1997-09-18 09:00:00, 1997-09-20 09:00:00, 1997-09-22 09:00:00, 1997-09-24 09:00:00, 1997-09-26 09:00:00, 1997-09-28 09:00:00, 1997-09-30 09:00:00';
    $result = implode(', ', $dates
      ->compute());
    $this
      ->assertEqual($result, $shouldbe, $rule . '; results: ' . $result);

    //Every 10 days, 2 occurrences:
    $start = "1997-09-02 09:00:00";
    $end = "1997-09-30 09:00:00";
    $start = new DrupalDateTime($start);
    $end = new DrupalDateTime($end);
    $rule = "RRULE:FREQ=DAILY;INTERVAL=10;COUNT=2";
    $dates = new DateRRuleCalc($rule, $start, $end, array());

    //  should be (1997 9:00 AM EDT)September 2,12
    $shouldbe = '1997-09-02 09:00:00, 1997-09-12 09:00:00';
    $result = implode(', ', $dates
      ->compute());
    $this
      ->assertEqual($result, $shouldbe, $rule . '; results: ' . $result);

    //Weekly for 3 occurrences
    $start = "1997-09-02 09:00:00";
    $end = "1997-09-30 09:00:00";
    $start = new DrupalDateTime($start);
    $end = new DrupalDateTime($end);
    $rule = "RRULE:FREQ=WEEKLY;COUNT=3";
    $dates = new DateRRuleCalc($rule, $start, $end, array());

    //  should be (1997 9:00 AM EDT)September 2,9,16
    $shouldbe = '1997-09-02 09:00:00, 1997-09-09 09:00:00, 1997-09-16 09:00:00';
    $result = implode(', ', $dates
      ->compute());
    $this
      ->assertEqual($result, $shouldbe, $rule . '; results: ' . $result);

    //Weekly until September 24, 1997
    $start = "1997-09-02 09:00:00";
    $end = "1997-09-30 09:00:00";
    $start = new DrupalDateTime($start);
    $end = new DrupalDateTime($end);
    $rule = "RRULE:FREQ=WEEKLY;UNTIL=19970924T000000Z";

    //  ==> (1997 9:00 AM EDT)September 2,9,16,23
    $dates = new DateRRuleCalc($rule, $start, $end, array());
    $shouldbe = '1997-09-02 09:00:00, 1997-09-09 09:00:00, 1997-09-16 09:00:00, 1997-09-23 09:00:00';
    $result = implode(', ', $dates
      ->compute());
    $this
      ->assertEqual($result, $shouldbe, $rule . '; results: ' . $result);

    //Every other week - forever:
    $start = "1997-09-02 09:00:00";
    $end = "1997-09-30 09:00:00";
    $start = new DrupalDateTime($start);
    $end = new DrupalDateTime($end);
    $rule = "RRULE:FREQ=WEEKLY;INTERVAL=2;WKST=SU";

    //  should be (1997 9:00 AM EDT)September 2,16,30
    $dates = new DateRRuleCalc($rule, $start, $end, array());
    $shouldbe = '1997-09-02 09:00:00, 1997-09-16 09:00:00, 1997-09-30 09:00:00';
    $result = implode(', ', $dates
      ->compute());
    $this
      ->assertEqual($result, $shouldbe, $rule . '; results: ' . $result);

    //Weekly on Tuesday and Thursday for 4 weeks:
    $start = "1997-09-02 09:00:00";
    $end = "1997-09-30 09:00:00";
    $start = new DrupalDateTime($start);
    $end = new DrupalDateTime($end);
    $rule = "RRULE:FREQ=WEEKLY;COUNT=8;WKST=SU;BYDAY=TU,TH";

    // should be(1997 9:00 AM EDT)September 2,4,9,11,16,18,23,25
    $dates = new DateRRuleCalc($rule, $start, $end, array());
    $shouldbe = '1997-09-02 09:00:00, 1997-09-04 09:00:00, 1997-09-09 09:00:00, 1997-09-11 09:00:00, 1997-09-16 09:00:00, 1997-09-18 09:00:00, 1997-09-23 09:00:00, 1997-09-25 09:00:00';
    $result = implode(', ', $dates
      ->compute());
    $this
      ->assertEqual($result, $shouldbe, $rule . '; results: ' . $result);

    //Every other week on Tuesday and Thursday, for 5 occurrences:
    $start = "1997-09-02 09:00:00";
    $end = "1997-09-30 09:00:00";
    $start = new DrupalDateTime($start);
    $end = new DrupalDateTime($end);
    $rule = "RRULE:FREQ=WEEKLY;INTERVAL=2;COUNT=5;WKST=SU;BYDAY=TU,TH";

    //  should be  (1997 9:00 AM EDT)September 2,4,16,18,30
    $dates = new DateRRuleCalc($rule, $start, $end, array());
    $shouldbe = '1997-09-02 09:00:00, 1997-09-04 09:00:00, 1997-09-16 09:00:00, 1997-09-18 09:00:00, 1997-09-30 09:00:00';
    $result = implode(', ', $dates
      ->compute());
    $this
      ->assertEqual($result, $shouldbe, $rule . '; results: ' . $result);

    //Every other week on Monday, Wednesday and Friday until September 24, 1997,
    $start = "1997-09-02 09:00:00";
    $end = "1997-09-30 09:00:00";
    $start = new DrupalDateTime($start);
    $end = new DrupalDateTime($end);
    $rule = "RRULE:FREQ=WEEKLY;INTERVAL=2;UNTIL=19970924T000000Z;WKST=SU;BYDAY=MO,WE,FR";

    // should be (1997 9:00 AM EDT)September 2,3,5,15,17,19
    $dates = new DateRRuleCalc($rule, $start, $end, array());
    $shouldbe = '1997-09-02 09:00:00, 1997-09-03 09:00:00, 1997-09-05 09:00:00, 1997-09-15 09:00:00, 1997-09-17 09:00:00, 1997-09-19 09:00:00';
    $result = implode(', ', $dates
      ->compute());
    $this
      ->assertEqual($result, $shouldbe, $rule . '; results: ' . $result);

    //Monthly on the 1st Friday for 2 occurrences:
    $start = "1997-09-05 09:00:00";
    $end = "1997-10-31 09:00:00";
    $start = new DrupalDateTime($start);
    $end = new DrupalDateTime($end);
    $rule = "RRULE:FREQ=MONTHLY;COUNT=2;BYDAY=1FR";

    //  should be (1997 9:00 AM EDT)September 5;October 3
    $dates = new DateRRuleCalc($rule, $start, $end, array());
    $shouldbe = '1997-09-05 09:00:00, 1997-10-03 09:00:00';
    $result = implode(', ', $dates
      ->compute());
    $this
      ->assertEqual($result, $shouldbe, $rule . '; results: ' . $result);

    //Monthly on the 1st Friday until December 24, 1997:
    $start = "1997-09-05 09:00:00";
    $end = "1998-10-01 09:00:00";
    $start = new DrupalDateTime($start);
    $end = new DrupalDateTime($end);
    $rule = "RRULE:FREQ=MONTHLY;UNTIL=19971224T000000Z;BYDAY=1FR";
    $dates = new DateRRuleCalc($rule, $start, $end, array());
    $shouldbe = '1997-09-05 09:00:00, 1997-10-03 09:00:00, 1997-11-07 09:00:00, 1997-12-05 09:00:00';
    $result = implode(', ', $dates
      ->compute());
    $this
      ->assertEqual($result, $shouldbe, $rule . '; results: ' . $result);

    //Every other month on the 1st and last Sunday of the month for 10 occurrences:
    $start = "1997-09-07 09:00:00";
    $end = "1998-10-01 09:00:00";
    $start = new DrupalDateTime($start);
    $end = new DrupalDateTime($end);
    $rule = "RRULE:FREQ=MONTHLY;INTERVAL=2;COUNT=10;BYDAY=1SU,-1SU";

    //  ==> (1997 9:00 AM EDT)September 7,28
    //      (1997 9:00 AM EST)November 2,30
    //      (1998 9:00 AM EST)January 4,25;March 1,29
    //      (1998 9:00 AM EDT)May 3,31
    $dates = new DateRRuleCalc($rule, $start, $end, array());
    $shouldbe = '1997-09-07 09:00:00, 1997-09-28 09:00:00, 1997-11-02 09:00:00, 1997-11-30 09:00:00, 1998-01-04 09:00:00, 1998-01-25 09:00:00, 1998-03-01 09:00:00, 1998-03-29 09:00:00, 1998-05-03 09:00:00, 1998-05-31 09:00:00';
    $result = implode(', ', $dates
      ->compute());
    $this
      ->assertEqual($result, $shouldbe, $rule . '; results: ' . $result);

    //Monthly on the second to last Monday of the month for 6 months:
    $start = "1997-09-22 09:00:00";
    $end = "1998-10-01 09:00:00";
    $start = new DrupalDateTime($start);
    $end = new DrupalDateTime($end);
    $rule = "RRULE:FREQ=MONTHLY;COUNT=6;BYDAY=-2MO";

    //==> (1997 9:00 AM EDT)September 22;October 20

    //  (1997 9:00 AM EST)November 17;December 22
    //  (1998 9:00 AM EST)January 19;February 16
    $dates = new DateRRuleCalc($rule, $start, $end, array());
    $shouldbe = '1997-09-22 09:00:00, 1997-10-20 09:00:00, 1997-11-17 09:00:00, 1997-12-22 09:00:00, 1998-01-19 09:00:00, 1998-02-16 09:00:00';
    $result = implode(', ', $dates
      ->compute());
    $this
      ->assertEqual($result, $shouldbe, $rule . '; results: ' . $result);

    //Every Tuesday, every other month:
    $start = "1997-09-02 09:00:00";
    $end = "1998-02-01 09:00:00";
    $start = new DrupalDateTime($start);
    $end = new DrupalDateTime($end);
    $rule = "RRULE:FREQ=MONTHLY;INTERVAL=2;BYDAY=TU";

    //  ==> (1997 9:00 AM EDT)September 2,9,16,23,30
    //      (1997 9:00 AM EST)November 4,11,18,25
    //      (1998 9:00 AM EST)January 6,13,20,27;March 3,10,17,24,31
    $dates = new DateRRuleCalc($rule, $start, $end, array());
    $shouldbe = '1997-09-02 09:00:00, 1997-09-09 09:00:00, 1997-09-16 09:00:00, 1997-09-23 09:00:00, 1997-09-30 09:00:00, 1997-11-04 09:00:00, 1997-11-11 09:00:00, 1997-11-18 09:00:00, 1997-11-25 09:00:00, 1998-01-06 09:00:00, 1998-01-13 09:00:00, 1998-01-20 09:00:00, 1998-01-27 09:00:00';
    $result = implode(', ', $dates
      ->compute());
    $this
      ->assertEqual($result, $shouldbe, $rule . '; results: ' . $result);

    //Yearly in June and July for 10 occurrences:
    $start = "1997-06-10 09:00:00";
    $end = "2002-01-01 09:00:00";
    $start = new DrupalDateTime($start);
    $end = new DrupalDateTime($end);
    $rule = "RRULE:FREQ=YEARLY;COUNT=10;BYMONTH=6,7";

    //  ==> (1997 9:00 AM EDT)June 10;July 10
    //      (1998 9:00 AM EDT)June 10;July 10
    //      (1999 9:00 AM EDT)June 10;July 10
    //      (2000 9:00 AM EDT)June 10;July 10
    //      (2001 9:00 AM EDT)June 10;July 10
    //  Note: Since none of the BYDAY, BYMONTHDAY or BYYEARDAY components
    //  are specified, the day is gotten from DTSTART
    $dates = new DateRRuleCalc($rule, $start, $end, array());
    $shouldbe = '1997-06-10 09:00:00, 1997-07-10 09:00:00, 1998-06-10 09:00:00, 1998-07-10 09:00:00, 1999-06-10 09:00:00, 1999-07-10 09:00:00, 2000-06-10 09:00:00, 2000-07-10 09:00:00, 2001-06-10 09:00:00, 2001-07-10 09:00:00';
    $result = implode(', ', $dates
      ->compute());
    $this
      ->assertEqual($result, $shouldbe, $rule . '; results: ' . $result);

    //Every other year on January, February, and March for 10 occurrences:
    $start = "1997-03-10 09:00:00";
    $end = "2004-01-01 09:00:00";
    $start = new DrupalDateTime($start);
    $end = new DrupalDateTime($end);
    $rule = "RRULE:FREQ=YEARLY;INTERVAL=2;COUNT=10;BYMONTH=1,2,3";

    //  ==> (1997 9:00 AM EST)March 10
    //      (1999 9:00 AM EST)January 10;February 10;March 10
    //      (2001 9:00 AM EST)January 10;February 10;March 10
    //      (2003 9:00 AM EST)January 10;February 10;March 10
    $dates = new DateRRuleCalc($rule, $start, $end, array());
    $shouldbe = '1997-03-10 09:00:00, 1999-01-10 09:00:00, 1999-02-10 09:00:00, 1999-03-10 09:00:00, 2001-01-10 09:00:00, 2001-02-10 09:00:00, 2001-03-10 09:00:00, 2003-01-10 09:00:00, 2003-02-10 09:00:00, 2003-03-10 09:00:00';
    $result = implode(', ', $dates
      ->compute());
    $this
      ->assertEqual($result, $shouldbe, $rule . '; results: ' . $result);

    //An example where the days generated makes a difference because of WKST:
    $start = "1997-08-05 09:00:00";
    $end = "2004-01-01 09:00:00";
    $start = new DrupalDateTime($start);
    $end = new DrupalDateTime($end);
    $rule = "RRULE:FREQ=WEEKLY;INTERVAL=2;COUNT=4;BYDAY=TU,SU;WKST=MO";

    //  ==> (1997 EDT)Aug 5,10,19,24
    $dates = new DateRRuleCalc($rule, $start, $end, array());
    $shouldbe = '1997-08-05 09:00:00, 1997-08-10 09:00:00, 1997-08-19 09:00:00, 1997-08-24 09:00:00';
    $result = implode(', ', $dates
      ->compute());
    $this
      ->assertEqual($result, $shouldbe, $rule . '; results: ' . $result);

    //changing only WKST from MO to SU, yields different results...
    $start = "1997-08-05 09:00:00";
    $end = "2004-01-01 09:00:00";
    $start = new DrupalDateTime($start);
    $end = new DrupalDateTime($end);
    $rule = "RRULE:FREQ=WEEKLY;INTERVAL=2;COUNT=4;BYDAY=TU,SU;WKST=SU";

    // Result: 1997 EDT August 5,17,19,31;
    $dates = new DateRRuleCalc($rule, $start, $end, array());
    $shouldbe = '1997-08-05 09:00:00, 1997-08-17 09:00:00, 1997-08-19 09:00:00, 1997-08-31 09:00:00';
    $result = implode(', ', $dates
      ->compute());
    $this
      ->assertEqual($result, $shouldbe, $rule . '; results: ' . $result);

    //Every 18 months on the 10th thru 15th of the month for 10 occurrences:
    $start = "1997-09-10 09:00:00";
    $end = "2004-01-01 09:00:00";
    $start = new DrupalDateTime($start);
    $end = new DrupalDateTime($end);
    $rule = "RRULE:FREQ=MONTHLY;INTERVAL=18;COUNT=10;BYMONTHDAY=10,11,12,13,14,15";

    //  ==> (1997 9:00 AM EDT)September 10,11,12,13,14,15
    //      (1999 9:00 AM EST)March 10,11,12,13
    $dates = new DateRRuleCalc($rule, $start, $end, array());
    $shouldbe = '1997-09-10 09:00:00, 1997-09-11 09:00:00, 1997-09-12 09:00:00, 1997-09-13 09:00:00, 1997-09-14 09:00:00, 1997-09-15 09:00:00, 1999-03-10 09:00:00, 1999-03-11 09:00:00, 1999-03-12 09:00:00, 1999-03-13 09:00:00';
    $result = implode(', ', $dates
      ->compute());
    $this
      ->assertEqual($result, $shouldbe, $rule . '; results: ' . $result);

    //Monthly on the third to the last day of the month, forever:
    $start = "1997-09-28 09:00:00";
    $end = "1998-03-01 09:00:00";
    $start = new DrupalDateTime($start);
    $end = new DrupalDateTime($end);
    $rule = "RRULE:FREQ=MONTHLY;BYMONTHDAY=-3";

    //  ==> (1997 9:00 AM EDT)September 28
    //      (1997 9:00 AM EST)October 29;November 28;December 29
    //      (1998 9:00 AM EST)January 29;February 26
    $dates = new DateRRuleCalc($rule, $start, $end, array());
    $shouldbe = '1997-09-28 09:00:00, 1997-10-29 09:00:00, 1997-11-28 09:00:00, 1997-12-29 09:00:00, 1998-01-29 09:00:00, 1998-02-26 09:00:00';
    $result = implode(', ', $dates
      ->compute());
    $this
      ->assertEqual($result, $shouldbe, $rule . '; results: ' . $result);

    //Every Thursday in March, forever:

    //  ==> (1997 9:00 AM EST)March 13,20,27
    //      (1998 9:00 AM EST)March 5,12,19,26
    //      (1999 9:00 AM EST)March 4,11,18,25
    $start = "1997-03-13 09:00:00";
    $end = "1999-03-31 09:00:00";
    $start = new DrupalDateTime($start);
    $end = new DrupalDateTime($end);
    $rule = "RRULE:FREQ=YEARLY;BYMONTH=3;BYDAY=TH";
    $dates = new DateRRuleCalc($rule, $start, $end, array());
    $shouldbe = '1997-03-13 09:00:00, 1997-03-20 09:00:00, 1997-03-27 09:00:00, 1998-03-05 09:00:00, 1998-03-12 09:00:00, 1998-03-19 09:00:00, 1998-03-26 09:00:00, 1999-03-04 09:00:00, 1999-03-11 09:00:00, 1999-03-18 09:00:00, 1999-03-25 09:00:00';
    $result = implode(', ', $dates
      ->compute());
    $this
      ->assertEqual($result, $shouldbe, $rule . '; results: ' . $result);

    //Every Thursday, but only during June, July, and August, forever:

    //  ==> (1997 9:00 AM EDT)June 5,12,19,26;July 3,10,17,24,31;August 7,14,21,28
    //      (1998 9:00 AM EDT)June 4,11,18,25;July 2,9,16,23,30;August 6,13,20,27
    //      (1999 9:00 AM EDT)June 3,10,17,24;July 1,8,15,22,29;August 5,12,19,26
    $start = "1997-06-05 09:00:00";
    $end = "1999-08-31 09:00:00";
    $start = new DrupalDateTime($start);
    $end = new DrupalDateTime($end);
    $rule = "RRULE:FREQ=YEARLY;BYDAY=TH;BYMONTH=6,7,8";
    $dates = new DateRRuleCalc($rule, $start, $end, array());
    $shouldbe = '1997-06-05 09:00:00, 1997-06-12 09:00:00, 1997-06-19 09:00:00, 1997-06-26 09:00:00, 1997-07-03 09:00:00, 1997-07-10 09:00:00, 1997-07-17 09:00:00, 1997-07-24 09:00:00, 1997-07-31 09:00:00, 1997-08-07 09:00:00, 1997-08-14 09:00:00, 1997-08-21 09:00:00, 1997-08-28 09:00:00, 1998-06-04 09:00:00, 1998-06-11 09:00:00, 1998-06-18 09:00:00, 1998-06-25 09:00:00, 1998-07-02 09:00:00, 1998-07-09 09:00:00, 1998-07-16 09:00:00, 1998-07-23 09:00:00, 1998-07-30 09:00:00, 1998-08-06 09:00:00, 1998-08-13 09:00:00, 1998-08-20 09:00:00, 1998-08-27 09:00:00, 1999-06-03 09:00:00, 1999-06-10 09:00:00, 1999-06-17 09:00:00, 1999-06-24 09:00:00, 1999-07-01 09:00:00, 1999-07-08 09:00:00, 1999-07-15 09:00:00, 1999-07-22 09:00:00, 1999-07-29 09:00:00, 1999-08-05 09:00:00, 1999-08-12 09:00:00, 1999-08-19 09:00:00, 1999-08-26 09:00:00';
    $result = implode(', ', $dates
      ->compute());
    $this
      ->assertEqual($result, $shouldbe, $rule . '; results: ' . $result);

    //Monthly on the 2nd and 15th of the month for 10 occurrences:

    //  ==> (1997 9:00 AM EDT)September 2,15;October 2,15
    //      (1997 9:00 AM EST)November 2,15;December 2,15
    //      (1998 9:00 AM EST)January 2,15
    $start = "1997-09-02 09:00:00";
    $end = "1998-01-31 09:00:00";
    $start = new DrupalDateTime($start);
    $end = new DrupalDateTime($end);
    $rule = "RRULE:FREQ=MONTHLY;COUNT=10;BYMONTHDAY=2,15";
    $dates = new DateRRuleCalc($rule, $start, $end, array());
    $shouldbe = '1997-09-02 09:00:00, 1997-09-15 09:00:00, 1997-10-02 09:00:00, 1997-10-15 09:00:00, 1997-11-02 09:00:00, 1997-11-15 09:00:00, 1997-12-02 09:00:00, 1997-12-15 09:00:00, 1998-01-02 09:00:00, 1998-01-15 09:00:00';
    $result = implode(', ', $dates
      ->compute());
    $this
      ->assertEqual($result, $shouldbe, $rule . '; results: ' . $result);

    //Monthly on the first and last day of the month for 10 occurrences:

    //  ==> (1997 9:00 AM EDT)September 30;October 1
    //      (1997 9:00 AM EST)October 31;November 1,30;December 1,31
    //      (1998 9:00 AM EST)January 1,31;February 1
    $start = "1997-09-30 09:00:00";
    $end = "1998-03-31 09:00:00";
    $start = new DrupalDateTime($start);
    $end = new DrupalDateTime($end);
    $rule = "RRULE:FREQ=MONTHLY;COUNT=10;BYMONTHDAY=1,-1";
    $dates = new DateRRuleCalc($rule, $start, $end, array());
    $shouldbe = '1997-09-30 09:00:00, 1997-10-01 09:00:00, 1997-10-31 09:00:00, 1997-11-01 09:00:00, 1997-11-30 09:00:00, 1997-12-01 09:00:00, 1997-12-31 09:00:00, 1998-01-01 09:00:00, 1998-01-31 09:00:00, 1998-02-01 09:00:00';
    $result = implode(', ', $dates
      ->compute());
    $this
      ->assertEqual($result, $shouldbe, $rule . '; results: ' . $result);

    //Every Friday the 13th, forever:
    $rule = "EXDATE;TZID=US-Eastern:19970902T090000";

    //  ==> (1998 9:00 AM EST)February 13;March 13;November 13
    //      (1999 9:00 AM EDT)August 13
    //      (2000 9:00 AM EDT)October 13
    $start = "1997-09-02 09:00:00";
    $end = "2000-12-31 09:00:00";
    $start = new DrupalDateTime($start);
    $end = new DrupalDateTime($end);
    $rule = "RRULE:FREQ=MONTHLY;BYDAY=FR;BYMONTHDAY=13";
    $dates = new DateRRuleCalc($rule, $start, $end, array());
    $shouldbe = '1997-09-02 09:00:00, 1998-02-13 09:00:00, 1998-03-13 09:00:00, 1998-11-13 09:00:00, 1999-08-13 09:00:00, 2000-10-13 09:00:00';
    $result = implode(', ', $dates
      ->compute());
    $this
      ->assertEqual($result, $shouldbe, $rule . '; results: ' . $result);

    //The first Saturday that follows the first Sunday of the month, forever:

    //  ==> (1997 9:00 AM EDT)September 13;October 11
    //      (1997 9:00 AM EST)November 8;December 13
    //      (1998 9:00 AM EST)January 10;February 7;March 7
    //      (1998 9:00 AM EDT)April 11;May 9;June 13...
    $start = "1997-09-13 09:00:00";
    $end = "1998-06-30 09:00:00";
    $start = new DrupalDateTime($start);
    $end = new DrupalDateTime($end);
    $rule = "RRULE:FREQ=MONTHLY;BYDAY=SA;BYMONTHDAY=7,8,9,10,11,12,13";
    $dates = new DateRRuleCalc($rule, $start, $end, array());
    $shouldbe = '1997-09-13 09:00:00, 1997-10-11 09:00:00, 1997-11-08 09:00:00, 1997-12-13 09:00:00, 1998-01-10 09:00:00, 1998-02-07 09:00:00, 1998-03-07 09:00:00, 1998-04-11 09:00:00, 1998-05-09 09:00:00, 1998-06-13 09:00:00';
    $result = implode(', ', $dates
      ->compute());
    $this
      ->assertEqual($result, $shouldbe, $rule . '; results: ' . $result);

    //Every four years, the first Tuesday after a Monday in November,

    //forever (U.S. Presidential Election day):

    //  ==> (1996 9:00 AM EST)November 5
    //      (2000 9:00 AM EST)November 7
    //      (2004 9:00 AM EST)November 2
    $start = "1996-11-05 09:00:00";
    $end = "2004-11-30 09:00:00";
    $start = new DrupalDateTime($start);
    $end = new DrupalDateTime($end);
    $rule = "RRULE:FREQ=YEARLY;INTERVAL=4;BYMONTH=11;BYDAY=TU;BYMONTHDAY=2,3,4,5,6,7,8";
    $shouldbe = '1996-11-05 09:00:00, 2000-11-07 09:00:00, 2004-11-02 09:00:00';
    $dates = new DateRRuleCalc($rule, $start, $end, array());
    $result = implode(', ', $dates
      ->compute());
    $this
      ->assertEqual($result, $shouldbe, $rule . '; results: ' . $result);

    //Every 20th Monday of the year, forever:
    $start = "1997-05-19 09:00:00";
    $end = "2000-01-01 09:00:00";
    $start = new DrupalDateTime($start);
    $end = new DrupalDateTime($end);
    $rule = "RRULE:FREQ=YEARLY;BYDAY=20MO";

    //  ==> (1997 9:00 AM EDT)May 19
    //      (1998 9:00 AM EDT)May 18
    //      (1999 9:00 AM EDT)May 17
    $dates = new DateRRuleCalc($rule, $start, $end, array());
    $shouldbe = '1997-05-19 09:00:00, 1998-05-18 09:00:00, 1999-05-17 09:00:00';
    $result = implode(', ', $dates
      ->compute());
    $this
      ->assertEqual($result, $shouldbe, $rule . '; results: ' . $result);

    //Every Sunday in January, every other year, forever:
    $start = "1997-01-05 09:00:00";
    $end = "2001-02-01 09:00:00";
    $start = new DrupalDateTime($start);
    $end = new DrupalDateTime($end);
    $rule = 'RRULE:FREQ=YEARLY;INTERVAL=2;BYMONTH=1;BYDAY=SU';

    //  ==> (1997 9:00 AM EDT)January 5,12,19,26
    //      (1999 9:00 AM EDT)January 3,10,17,24,31
    //      (2001 9:00 AM EDT)January 7,14,21,28
    $dates = new DateRRuleCalc($rule, $start, $end, array());
    $shouldbe = '1997-01-05 09:00:00, 1997-01-12 09:00:00, 1997-01-19 09:00:00, 1997-01-26 09:00:00, 1999-01-03 09:00:00, 1999-01-10 09:00:00, 1999-01-17 09:00:00, 1999-01-24 09:00:00, 1999-01-31 09:00:00, 2001-01-07 09:00:00, 2001-01-14 09:00:00, 2001-01-21 09:00:00, 2001-01-28 09:00:00';
    $result = implode(', ', $dates
      ->compute());
    $this
      ->assertEqual($result, $shouldbe, $rule . '; results: ' . $result);
    return;

    //Every Thanksgiving, forever:
    $start = "1997-01-01 09:00:00";
    $end = "2001-02-01 09:00:00";
    $start = new DrupalDateTime($start);
    $end = new DrupalDateTime($end);
    $rule = 'RRULE:FREQ=YEARLY;INTERVAL=1;BYMONTH=11;BYDAY=4TH';

    //  ==> (1997 9:00 AM EDT)Nov
    //      (1999 9:00 AM EDT)Nov
    //      (2001 9:00 AM EDT)Nov
    $dates = new DateRRuleCalc($rule, $start, $end, array());
    $shouldbe = '';
    $result = implode(', ', $dates
      ->compute());
    $this
      ->assertEqual($result, $shouldbe, $rule . '; results: ' . $result);

    // TODO:
    // BYYEARDAY, BYSETPOS,
    // BYHOUR, BYMINUTE, HOURLY, MINUTELY, SECONDLY
    // have not yet been implemented in date_repeat.

    //Every 3rd year on the 1st, 100th and 200th day for 10 occurrences:
    $date = "DTSTART;TZID=US-Eastern:19970101T090000";
    $rule = "RRULE:FREQ=YEARLY;INTERVAL=3;COUNT=10;BYYEARDAY=1,100,200";

    //  ==> (1997 9:00 AM EST)January 1
    //      (1997 9:00 AM EDT)April 10;July 19
    //      (2000 9:00 AM EST)January 1
    //      (2000 9:00 AM EDT)April 9;July 18
    //      (2003 9:00 AM EST)January 1
    //      (2003 9:00 AM EDT)April 10;July 19
    //      (2006 9:00 AM EST)January 1

    //Monday of week number 20 (where the default start of the week is Monday), forever:
    $date = "DTSTART;TZID=US-Eastern:19970512T090000";
    $rule = "RRULE:FREQ=YEARLY;BYWEEKNO=20;BYDAY=MO";

    //  ==> (1997 9:00 AM EDT)May 12
    //      (1998 9:00 AM EDT)May 11
    //      (1999 9:00 AM EDT)May 17

    //The 3rd instance into the month of one of Tuesday, Wednesday or

    //Thursday, for the next 3 months:
    $date = "DTSTART;TZID=US-Eastern:19970904T090000";
    $rule = "RRULE:FREQ=MONTHLY;COUNT=3;BYDAY=TU,WE,TH;BYSETPOS=3";

    //  ==> (1997 9:00 AM EDT)September 4;October 7
    //      (1997 9:00 AM EST)November 6

    //The 2nd to last weekday of the month:
    $date = "DTSTART;TZID=US-Eastern:19970929T090000";
    $rule = "RRULE:FREQ=MONTHLY;BYDAY=MO,TU,WE,TH,FR;BYSETPOS=-2";

    //  ==> (1997 9:00 AM EDT)September 29
    //      (1997 9:00 AM EST)October 30;November 27;December 30
    //      (1998 9:00 AM EST)January 29;February 26;March 30

    //Every 3 hours from 9:00 AM to 5:00 PM on a specific day:
    $date = "DTSTART;TZID=US-Eastern:19970902T090000";
    $rule = "RRULE:FREQ=HOURLY;INTERVAL=3;UNTIL=19970902T170000Z";

    //  ==> (September 2, 1997 EDT)09:00,12:00,15:00

    //Every 15 minutes for 6 occurrences:
    $date = "DTSTART;TZID=US-Eastern:19970902T090000";
    $rule = "RRULE:FREQ=MINUTELY;INTERVAL=15;COUNT=6";

    //  ==> (September 2, 1997 EDT)09:00,09:15,09:30,09:45,10:00,10:15

    //Every hour and a half for 4 occurrences:
    $date = "DTSTART;TZID=US-Eastern:19970902T090000";
    $rule = "RRULE:FREQ=MINUTELY;INTERVAL=90;COUNT=4";

    //  ==> (September 2, 1997 EDT)09:00,10:30;12:00;13:30

    //Every 20 minutes from 9:00 AM to 4:40 PM every day:
    $date = "DTSTART;TZID=US-Eastern:19970902T090000";
    $rule = "RRULE:FREQ=DAILY;BYHOUR=9,10,11,12,13,14,15,16;BYMINUTE=0,20,40";

    //  or
    $rule = "RRULE:FREQ=MINUTELY;INTERVAL=20;BYHOUR=9,10,11,12,13,14,15,16";

    //  ==> (September 2, 1997 EDT)9:00,9:20,9:40,10:00,10:20,16:00,16:20,16:40
    //      (September 3, 1997 EDT)9:00,9:20,9:40,10:00,10:20,16:00,16:20,16:40
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl protected function Get the current URL from the cURL handler. 1
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertMailTrait::assertMail protected function Asserts that the most recently sent email message has the given value.
AssertMailTrait::assertMailPattern protected function Asserts that the most recently sent email message has the pattern in it.
AssertMailTrait::assertMailString protected function Asserts that the most recently sent email message has the string in it.
AssertMailTrait::getMails protected function Gets an array containing all emails sent during this test case. Aliased as: drupalGetMails
AssertMailTrait::verboseEmail protected function Outputs to verbose the most recent $count emails sent.
AssertPageCacheContextsAndTagsTrait::assertCacheContext protected function Asserts whether an expected cache context was present in the last response.
AssertPageCacheContextsAndTagsTrait::assertCacheContexts protected function Ensures that some cache contexts are present in the current response.
AssertPageCacheContextsAndTagsTrait::assertCacheMaxAge protected function Asserts the max age header.
AssertPageCacheContextsAndTagsTrait::assertCacheTags protected function Ensures that some cache tags are present in the current response.
AssertPageCacheContextsAndTagsTrait::assertNoCacheContext protected function Asserts that a cache context was not present in the last response.
AssertPageCacheContextsAndTagsTrait::assertPageCacheContextsAndTags protected function Asserts page cache miss, then hit for the given URL; checks cache headers.
AssertPageCacheContextsAndTagsTrait::debugCacheTags protected function Provides debug information for cache tags.
AssertPageCacheContextsAndTagsTrait::enablePageCaching protected function Enables page caching.
AssertPageCacheContextsAndTagsTrait::getCacheHeaderValues protected function Gets a specific header value as array.
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
CronRunTrait::cronRun protected function Runs cron on the test site.
DateRRuleCalcTest::$modules public static property Load the date_repeat module.
DateRRuleCalcTest::getInfo public static function
DateRRuleCalcTest::testDateRRuleCalc public function
EntityViewTrait::buildEntityView protected function Builds the renderable view of an entity. Aliased as: drupalBuildEntityView
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set 'apcu_ensure_unique_prefix' setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$configDirectories Deprecated protected property The config directories used in this test.
FunctionalTestSetupTrait::$rootUser protected property The "#1" admin user.
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 1
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 2
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed.
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 9
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 23
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 2
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site.
GeneratePermutationsTrait::generatePermutations public static function Converts a list of possible parameters into a stack of permutations.
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
RandomGeneratorTrait::$randomGenerator protected property The random generator.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers. 1
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 3
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestBase::$assertions protected property Assertions thrown in that test case.
TestBase::$configImporter protected property The config importer that can used in a test.
TestBase::$databasePrefix protected property The database prefix of this test run.
TestBase::$dieOnFail public property Whether to die in case any test assertion fails.
TestBase::$httpAuthCredentials protected property HTTP authentication credentials (<username>:<password>).
TestBase::$httpAuthMethod protected property HTTP authentication method (specified as a CURLAUTH_* constant).
TestBase::$originalConf protected property The original configuration (variables), if available.
TestBase::$originalConfig protected property The original configuration (variables).
TestBase::$originalConfigDirectories protected property The original configuration directories.
TestBase::$originalContainer protected property The original container.
TestBase::$originalFileDirectory protected property The original file directory, before it was changed for testing purposes.
TestBase::$originalLanguage protected property The original language.
TestBase::$originalPrefix protected property The original database prefix when running inside Simpletest.
TestBase::$originalSessionName protected property The name of the session cookie of the test-runner.
TestBase::$originalSettings protected property The settings array.
TestBase::$results public property Current results of this test case.
TestBase::$skipClasses protected property This class is skipped when looking for the source of an assertion.
TestBase::$timeLimit protected property Time limit for the test.
TestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
TestBase::$verbose public property TRUE if verbose debugging is enabled.
TestBase::$verboseClassName protected property Safe class name for use in verbose output filenames.
TestBase::$verboseDirectory protected property Directory where verbose output files are put.
TestBase::$verboseDirectoryUrl protected property URL to the verbose output file directory.
TestBase::$verboseId protected property Incrementing identifier for verbose output filenames.
TestBase::assert protected function Internal helper: stores the assert.
TestBase::assertEqual protected function Check to see if two values are equal.
TestBase::assertErrorLogged protected function Asserts that a specific error has been logged to the PHP error log.
TestBase::assertFalse protected function Check to see if a value is false.
TestBase::assertIdentical protected function Check to see if two values are identical.
TestBase::assertIdenticalObject protected function Checks to see if two objects are identical.
TestBase::assertNoErrorsLogged protected function Asserts that no errors have been logged to the PHP error.log thus far.
TestBase::assertNotEqual protected function Check to see if two values are not equal.
TestBase::assertNotIdentical protected function Check to see if two values are not identical.
TestBase::assertNotNull protected function Check to see if a value is not NULL.
TestBase::assertNull protected function Check to see if a value is NULL.
TestBase::assertTrue protected function Check to see if a value is not false.
TestBase::beforePrepareEnvironment protected function Act on global state information before the environment is altered for a test. 1
TestBase::checkRequirements protected function Checks the matching requirements for Test. 1
TestBase::checkTestHierarchyMismatch public function Fail the test if it belongs to a PHPUnit-based framework.
TestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
TestBase::deleteAssert public static function Delete an assertion record by message ID.
TestBase::error protected function Fire an error assertion. 1
TestBase::errorHandler public function Handle errors during test runs.
TestBase::exceptionHandler protected function Handle exceptions.
TestBase::fail protected function Fire an assertion that is always negative.
TestBase::filePreDeleteCallback public static function Ensures test files are deletable.
TestBase::getAssertionCall protected function Cycles through backtrace until the first non-assertion method is found.
TestBase::getDatabasePrefix public function Gets the database prefix.
TestBase::getTempFilesDirectory public function Gets the temporary files directory.
TestBase::insertAssert Deprecated public static function Store an assertion from outside the testing context. 1
TestBase::pass protected function Fire an assertion that is always positive.
TestBase::prepareDatabasePrefix private function Generates a database prefix for running tests. Overrides TestSetupTrait::prepareDatabasePrefix
TestBase::restoreEnvironment private function Cleans up the test environment and restores the original environment.
TestBase::run public function Run all tests in this class. 2
TestBase::settingsSet protected function Changes in memory settings.
TestBase::storeAssertion protected function Helper method to store an assertion record in the configured database. 1
TestBase::verbose protected function Logs a verbose message in a text file.
TestFileCreationTrait::$generatedTestFiles protected property Whether the files were copied to the test files directory.
TestFileCreationTrait::compareFiles protected function Compares two files based on size and file name. Aliased as: drupalCompareFiles
TestFileCreationTrait::generateFile public static function Generates a test file.
TestFileCreationTrait::getTestFiles protected function Gets a list of files that can be used in tests. Aliased as: drupalGetTestFiles
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 2
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role. Aliased as: drupalCreateAdminRole
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
WebTestBase::$additionalCurlOptions protected property Additional cURL options.
WebTestBase::$assertAjaxHeader protected property Whether or not to assert the presence of the X-Drupal-Ajax-Token.
WebTestBase::$cookieFile protected property The current cookie file used by cURL.
WebTestBase::$cookies protected property The cookies of the page currently loaded in the internal browser.
WebTestBase::$curlCookies protected property Cookies to set on curl requests.
WebTestBase::$curlHandle protected property The handle of the current cURL connection.
WebTestBase::$customTranslations protected property An array of custom translations suitable for drupal_rewrite_settings().
WebTestBase::$dumpHeaders protected property Indicates that headers should be dumped if verbose output is enabled. 1
WebTestBase::$headers protected property The headers of the page currently loaded in the internal browser.
WebTestBase::$loggedInUser protected property The current user logged in using the internal browser.
WebTestBase::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
WebTestBase::$maximumRedirects protected property The maximum number of redirects to follow when handling responses.
WebTestBase::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
WebTestBase::$originalBatch protected property The original batch, before it was changed for testing purposes.
WebTestBase::$originalShutdownCallbacks protected property The original shutdown handlers array, before it was cleaned for testing. Overrides TestBase::$originalShutdownCallbacks
WebTestBase::$originalUser protected property The original user, before it was changed to a clean uid = 1 for testing. Overrides TestBase::$originalUser
WebTestBase::$profile protected property The profile to install as a basis for testing. 2
WebTestBase::$redirectCount protected property The number of redirects followed during the handling of a request.
WebTestBase::$sessionId protected property The current session ID, if available.
WebTestBase::$url protected property The URL currently loaded in the internal browser.
WebTestBase::addCustomTranslations protected function Queues custom translations to be written to settings.php.
WebTestBase::assertBlockAppears protected function Checks to see whether a block appears on the page.
WebTestBase::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
WebTestBase::assertHeader protected function Check if a HTTP response header exists and has the expected value.
WebTestBase::assertNoBlockAppears protected function Checks to see whether a block does not appears on the page.
WebTestBase::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
WebTestBase::assertNoResponse protected function Asserts the page did not return the specified response code.
WebTestBase::assertResponse protected function Asserts the page responds with the specified response code. 1
WebTestBase::assertUrl protected function Passes if the internal browser's URL matches the given path.
WebTestBase::buildUrl protected function Builds an a absolute URL from a system path or a URL object.
WebTestBase::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
WebTestBase::clickLink protected function Follows a link by complete name.
WebTestBase::clickLinkHelper protected function Provides a helper for ::clickLink() and ::clickLinkPartialName().
WebTestBase::clickLinkPartialName protected function Follows a link by partial name.
WebTestBase::curlClose protected function Close the cURL handler and unset the handler.
WebTestBase::curlExec protected function Initializes and executes a cURL request. 1
WebTestBase::curlHeaderCallback protected function Reads headers and registers errors received from the tested site.
WebTestBase::curlInitialize protected function Initializes the cURL connection.
WebTestBase::drupalGet protected function Retrieves a Drupal path or an absolute path. 1
WebTestBase::drupalGetAjax protected function Requests a path or URL in drupal_ajax format and JSON-decodes the response.
WebTestBase::drupalGetHeader protected function Gets the value of an HTTP response header. 1
WebTestBase::drupalGetHeaders protected function Gets the HTTP response headers of the requested page. 1
WebTestBase::drupalGetJSON protected function Retrieves a Drupal path or an absolute path and JSON decodes the result.
WebTestBase::drupalGetWithFormat protected function Retrieves a Drupal path or an absolute path for a given format.
WebTestBase::drupalGetXHR protected function Requests a Drupal path or an absolute path as if it is a XMLHttpRequest.
WebTestBase::drupalHead protected function Retrieves only the headers for a Drupal path or an absolute path.
WebTestBase::drupalLogin protected function Log in a user with the internal browser.
WebTestBase::drupalLogout protected function Logs a user out of the internal browser and confirms.
WebTestBase::drupalPost protected function Perform a POST HTTP request.
WebTestBase::drupalPostAjaxForm protected function Executes an Ajax form submission.
WebTestBase::drupalPostForm protected function Executes a form submission.
WebTestBase::drupalPostWithFormat protected function Performs a POST HTTP request with a specific format.
WebTestBase::drupalProcessAjaxResponse protected function Processes an AJAX response into current content.
WebTestBase::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
WebTestBase::findBlockInstance protected function Find a block instance on the page.
WebTestBase::getAbsoluteUrl protected function Takes a path and returns an absolute path.
WebTestBase::getAjaxPageStatePostData protected function Get the Ajax page state from drupalSettings and prepare it for POSTing.
WebTestBase::handleForm protected function Handles form input related to drupalPostForm().
WebTestBase::isInChildSite protected function Returns whether the test is being executed from within a test site.
WebTestBase::restoreBatch protected function Restore the original batch.
WebTestBase::serializePostValues protected function Serialize POST HTTP request values.
WebTestBase::setBatch protected function Preserve the original batch, and instantiate the test batch.
WebTestBase::setHttpResponseDebugCacheabilityHeaders protected function Enables/disables the cacheability headers.
WebTestBase::setUp protected function Sets up a Drupal site for running functional and integration tests. Overrides TestBase::setUp 30
WebTestBase::tearDown protected function Cleans up after testing. Overrides TestBase::tearDown 1
WebTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for WebTestBase::drupalPostForm().
WebTestBase::writeCustomTranslations protected function Writes custom translations to the test site's settings.php.
WebTestBase::__construct public function Constructor for \Drupal\simpletest\WebTestBase. Overrides TestBase::__construct 1
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.