You are here

Home » API reference » Scheduler 8 » SchedulerRequiredTest.php » SchedulerRequiredTest

public function SchedulerRequiredTest::dataRequiredScheduling in Scheduler 8

Same name and namespace in other branches
  1. 2.x tests/src/Functional/SchedulerRequiredTest.php \Drupal\Tests\scheduler\Functional\SchedulerRequiredTest::dataRequiredScheduling()

Provides data for testRequiredScheduling().

Return value

array id - a sequential id to help in identifying test output publish_required - (bool) whether the publish_on field is required unpublish_required - (bool) whether the unpublish_on field is required operation - what is being done to the node, 'add' or 'edit' scheduled - (bool) the node is already scheduled for publishing status - (bool) the current published status of the node publish_expected - (bool) will this scenario produced a 'publish on required' error message unpublish_expected - (bool) will this scenario produced a 'unpublish on required' error message message - Descriptive text used in the body of the node

File

tests/src/Functional/SchedulerRequiredTest.php, line 109

Class

SchedulerRequiredTest
Tests the options for scheduling dates to be required during add/edit.

Namespace

Drupal\Tests\scheduler\Functional

Code

public function dataRequiredScheduling() {
  $data = [
    // The numbering used below matches the test cases described in
    // http://drupal.org/node/1198788#comment-7816119
    // Check the default case when neither date should be required.
    [
      'id' => 0,
      'publish_required' => FALSE,
      'unpublish_required' => FALSE,
      'operation' => 'add',
      'scheduled' => FALSE,
      'status' => TRUE,
      'publish_expected' => FALSE,
      'unpublish_expected' => FALSE,
      'message' => 'By default when a new node is created, the publish on and unpublish on dates are not required.',
    ],
    // A. Test scenarios that require scheduled publishing.
    // When creating a new unpublished node it is required to enter a
    // publication date.
    [
      'id' => 1,
      'publish_required' => TRUE,
      'unpublish_required' => FALSE,
      'operation' => 'add',
      'scheduled' => FALSE,
      'status' => FALSE,
      'publish_expected' => TRUE,
      'unpublish_expected' => FALSE,
      'message' => 'When scheduled publishing is required and a new unpublished node is created, entering a date in the publish on field is required.',
    ],
    // When creating a new published node it is required to enter a
    // publication date. The node will be unpublished on form submit.
    [
      'id' => 2,
      'publish_required' => TRUE,
      'unpublish_required' => FALSE,
      'operation' => 'add',
      'scheduled' => FALSE,
      'status' => TRUE,
      'publish_expected' => TRUE,
      'unpublish_expected' => FALSE,
      'message' => 'When scheduled publishing is required and a new published node is created, entering a date in the publish on field is required.',
    ],
    // When editing a published node it is not needed to enter a publication
    // date since the node is already published.
    [
      'id' => 3,
      'publish_required' => TRUE,
      'unpublish_required' => FALSE,
      'operation' => 'edit',
      'scheduled' => FALSE,
      'status' => TRUE,
      'publish_expected' => FALSE,
      'unpublish_expected' => FALSE,
      'message' => 'When scheduled publishing is required and an existing published, unscheduled node is edited, entering a date in the publish on field is not required.',
    ],
    // When editing an unpublished node that is scheduled for publication it
    // is required to enter a publication date.
    [
      'id' => 4,
      'publish_required' => TRUE,
      'unpublish_required' => FALSE,
      'operation' => 'edit',
      'scheduled' => TRUE,
      'status' => FALSE,
      'publish_expected' => TRUE,
      'unpublish_expected' => FALSE,
      'message' => 'When scheduled publishing is required and an existing unpublished, scheduled node is edited, entering a date in the publish on field is required.',
    ],
    // When editing an unpublished node that is not scheduled for publication
    // it is not required to enter a publication date since this means that
    // the node has already gone through a publication > unpublication cycle.
    [
      'id' => 5,
      'publish_required' => TRUE,
      'unpublish_required' => FALSE,
      'operation' => 'edit',
      'scheduled' => FALSE,
      'status' => FALSE,
      'publish_expected' => FALSE,
      'unpublish_expected' => FALSE,
      'message' => 'When scheduled publishing is required and an existing unpublished, unscheduled node is edited, entering a date in the publish on field is not required.',
    ],
    // B. Test scenarios that require scheduled unpublishing.
    // When creating a new unpublished node it is required to enter an
    // unpublication date since it is to be expected that the node will be
    // published at some point and should subsequently be unpublished.
    [
      'id' => 6,
      'publish_required' => FALSE,
      'unpublish_required' => TRUE,
      'operation' => 'add',
      'scheduled' => FALSE,
      'status' => FALSE,
      'publish_expected' => FALSE,
      'unpublish_expected' => TRUE,
      'message' => 'When scheduled unpublishing is required and a new unpublished node is created, entering a date in the unpublish on field is required.',
    ],
    // When creating a new published node it is required to enter an
    // unpublication date.
    [
      'id' => 7,
      'publish_required' => FALSE,
      'unpublish_required' => TRUE,
      'operation' => 'add',
      'scheduled' => FALSE,
      'status' => TRUE,
      'publish_expected' => FALSE,
      'unpublish_expected' => TRUE,
      'message' => 'When scheduled unpublishing is required and a new published node is created, entering a date in the unpublish on field is required.',
    ],
    // When editing a published node it is required to enter an unpublication
    // date.
    [
      'id' => 8,
      'publish_required' => FALSE,
      'unpublish_required' => TRUE,
      'operation' => 'edit',
      'scheduled' => FALSE,
      'status' => TRUE,
      'publish_expected' => FALSE,
      'unpublish_expected' => TRUE,
      'message' => 'When scheduled unpublishing is required and an existing published, unscheduled node is edited, entering a date in the unpublish on field is required.',
    ],
    // When editing an unpublished node that is scheduled for publication it
    // it is required to enter an unpublication date.
    [
      'id' => 9,
      'publish_required' => FALSE,
      'unpublish_required' => TRUE,
      'operation' => 'edit',
      'scheduled' => TRUE,
      'status' => FALSE,
      'publish_expected' => FALSE,
      'unpublish_expected' => TRUE,
      'message' => 'When scheduled unpublishing is required and an existing unpublished, scheduled node is edited, entering a date in the unpublish on field is required.',
    ],
    // When editing an unpublished node that is not scheduled for publication
    // it is not required to enter an unpublication date since this means that
    // the node has already gone through a publication - unpublication cycle.
    [
      'id' => 10,
      'publish_required' => FALSE,
      'unpublish_required' => TRUE,
      'operation' => 'edit',
      'scheduled' => FALSE,
      'status' => FALSE,
      'publish_expected' => FALSE,
      'unpublish_expected' => FALSE,
      'message' => 'When scheduled unpublishing is required and an existing unpublished, unscheduled node is edited, entering a date in the unpublish on field is not required.',
    ],
    // C. Test scenarios that require both publishing and unpublishing.
    // This section is an amalgamation of the values in the sections A and B
    // to check that the settings do not interfere with each other.
    [
      'id' => 11,
      'publish_required' => TRUE,
      'unpublish_required' => TRUE,
      'operation' => 'add',
      'scheduled' => FALSE,
      'status' => FALSE,
      'publish_expected' => TRUE,
      'unpublish_expected' => TRUE,
      'message' => 'When both scheduled publishing and unpublishing are required and a new unpublished node is created, entering a date in both the publish and unpublish on fields is required.',
    ],
    [
      'id' => 12,
      'publish_required' => TRUE,
      'unpublish_required' => TRUE,
      'operation' => 'add',
      'scheduled' => FALSE,
      'status' => TRUE,
      'publish_expected' => TRUE,
      'unpublish_expected' => TRUE,
      'message' => 'When both scheduled publishing and unpublishing are required and a new published node is created, entering a date in both the publish and unpublish on fields is required.',
    ],
    [
      'id' => 13,
      'publish_required' => TRUE,
      'unpublish_required' => TRUE,
      'operation' => 'edit',
      'scheduled' => FALSE,
      'status' => TRUE,
      'publish_expected' => FALSE,
      'unpublish_expected' => TRUE,
      'message' => 'When both scheduled publishing and unpublishing are required and an existing published, unscheduled node is edited, entering a date in the unpublish on field is required, but a publish date is not required.',
    ],
    [
      'id' => 14,
      'publish_required' => TRUE,
      'unpublish_required' => TRUE,
      'operation' => 'edit',
      'scheduled' => TRUE,
      'status' => FALSE,
      'publish_expected' => TRUE,
      'unpublish_expected' => TRUE,
      'message' => 'When both scheduled publishing and unpublishing are required and an existing unpublished, scheduled node is edited, entering a date in both the publish and unpublish on fields is required.',
    ],
    [
      'id' => 15,
      'publish_required' => TRUE,
      'unpublish_required' => TRUE,
      'operation' => 'edit',
      'scheduled' => FALSE,
      'status' => FALSE,
      'publish_expected' => FALSE,
      'unpublish_expected' => FALSE,
      'message' => 'When both scheduled publishing and unpublishing are required and an existing unpublished, unscheduled node is edited, entering a date in the publish or unpublish on fields is not required.',
    ],
  ];

  // Use unset($data[n]) to remove a temporarily unwanted item, use
  // return [$data[n]] to selectively test just one item, or have the default
  // return $data to test everything.
  return $data;
}