123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563 |
- <?php
- namespace Drupal\Tests\Core\Form;
- use Drupal\Core\Form\FormInterface;
- use Drupal\Core\Form\FormStateDecoratorBase;
- use Drupal\Core\Form\FormStateInterface;
- use Drupal\Core\Url;
- use Drupal\Tests\UnitTestCase;
- use Prophecy\Argument;
- use Symfony\Component\HttpFoundation\RedirectResponse;
- use Symfony\Component\HttpFoundation\Response;
- /**
- * @coversDefaultClass \Drupal\Core\Form\FormStateDecoratorBase
- *
- * @group Form
- */
- class FormStateDecoratorBaseTest extends UnitTestCase {
- /**
- * The decorated form state.
- *
- * @var \Drupal\Core\Form\FormStateInterface|\Prophecy\Prophecy\ObjectProphecy
- */
- protected $decoratedFormState;
- /**
- * The form state decorator base under test.
- *
- * @var \Drupal\Core\Form\FormStateDecoratorBase
- */
- protected $formStateDecoratorBase;
- /**
- * {@inheritdoc}
- */
- public function setUp() {
- parent::setUp();
- $this->decoratedFormState = $this->prophesize(FormStateInterface::class);
- $this->formStateDecoratorBase = new NonAbstractFormStateDecoratorBase($this->decoratedFormState->reveal());
- }
- /**
- * Provides data to test methods that take a single boolean argument.
- */
- public function providerSingleBooleanArgument() {
- return [
- [TRUE],
- [FALSE],
- ];
- }
- /**
- * @covers ::setFormState
- */
- public function testSetFormState() {
- $form_state_additions = [
- 'foo' => 'bar',
- ];
- $this->decoratedFormState->setFormState($form_state_additions)
- ->shouldBeCalled();
- $this->assertSame($this->formStateDecoratorBase, $this->formStateDecoratorBase->setFormState($form_state_additions));
- }
- /**
- * @covers ::setAlwaysProcess
- *
- * @dataProvider providerSingleBooleanArgument
- *
- * @param bool $always_process
- */
- public function testSetAlwaysProcess($always_process) {
- $this->decoratedFormState->setAlwaysProcess($always_process)
- ->shouldBeCalled();
- $this->assertSame($this->formStateDecoratorBase, $this->formStateDecoratorBase->setAlwaysProcess($always_process));
- }
- /**
- * @covers ::getAlwaysProcess
- *
- * @dataProvider providerSingleBooleanArgument
- *
- * @param bool $always_process
- */
- public function testGetAlwaysProcess($always_process) {
- $this->decoratedFormState->getAlwaysProcess()
- ->willReturn($always_process)
- ->shouldBeCalled();
- $this->assertSame($always_process, $this->formStateDecoratorBase->getAlwaysProcess());
- }
- /**
- * @covers ::setButtons
- */
- public function testSetButtons() {
- $buttons = [
- 'FOO' => 'BAR',
- ];
- $this->decoratedFormState->setButtons($buttons)
- ->shouldBeCalled();
- $this->assertSame($this->formStateDecoratorBase, $this->formStateDecoratorBase->setButtons($buttons));
- }
- /**
- * @covers ::getButtons
- */
- public function testGetButtons() {
- $buttons = [
- 'FOO' => 'BAR',
- ];
- $this->decoratedFormState->getButtons()
- ->willReturn($buttons)
- ->shouldBeCalled();
- $this->assertSame($buttons, $this->formStateDecoratorBase->getButtons());
- }
- /**
- * @covers ::setCached
- *
- * @dataProvider providerSingleBooleanArgument
- *
- * @param bool $cache
- */
- public function testSetCached($cache) {
- $this->decoratedFormState->setCached($cache)
- ->shouldBeCalled();
- $this->assertSame($this->formStateDecoratorBase, $this->formStateDecoratorBase->setCached($cache));
- }
- /**
- * @covers ::isCached
- *
- * @dataProvider providerSingleBooleanArgument
- *
- * @param bool $cache
- */
- public function testIsCached($cache) {
- $this->decoratedFormState->isCached()
- ->willReturn($cache)
- ->shouldBeCalled();
- $this->assertSame($cache, $this->formStateDecoratorBase->isCached());
- }
- /**
- * @covers ::setCached
- *
- * @dataProvider providerSingleBooleanArgument
- *
- * @param bool $cache
- */
- public function testSetCachedWithLogicException($cache) {
- $this->decoratedFormState->setCached($cache)
- ->willThrow(\LogicException::class);
- $this->expectException(\LogicException::class);
- $this->formStateDecoratorBase->setCached($cache);
- }
- /**
- * @covers ::disableCache
- */
- public function testDisableCache() {
- $this->decoratedFormState->disableCache()
- ->shouldBeCalled();
- $this->assertSame($this->formStateDecoratorBase, $this->formStateDecoratorBase->disableCache());
- }
- /**
- * @covers ::setExecuted
- */
- public function testSetExecuted() {
- $this->decoratedFormState->setExecuted()
- ->shouldBecalled();
- $this->assertSame($this->formStateDecoratorBase, $this->formStateDecoratorBase->setExecuted());
- }
- /**
- * @covers ::isExecuted
- *
- * @dataProvider providerSingleBooleanArgument
- *
- * @param bool $executed
- */
- public function testIsExecuted($executed) {
- $this->decoratedFormState->isExecuted()
- ->willReturn($executed)
- ->shouldBeCalled();
- $this->assertSame($executed, $this->formStateDecoratorBase->isExecuted());
- }
- /**
- * @covers ::setGroups
- */
- public function testSetGroups() {
- $groups = [
- 'FOO' => 'BAR',
- ];
- $this->decoratedFormState->setGroups($groups)
- ->shouldBeCalled();
- $this->assertSame($this->formStateDecoratorBase, $this->formStateDecoratorBase->setGroups($groups));
- }
- /**
- * @covers ::getGroups
- */
- public function testGetGroups() {
- $groups = [
- 'FOO' => 'BAR',
- ];
- // Use PHPUnit for mocking, because Prophecy cannot mock methods that return
- // by reference. See \Prophecy\Doubler\Generator\Node::getCode().
- $decorated_form_state = $this->createMock(FormStateInterface::class);
- $decorated_form_state->expects($this->once())
- ->method('getGroups')
- ->willReturn($groups);
- $this->formStateDecoratorBase = new NonAbstractFormStateDecoratorBase($decorated_form_state);
- $this->assertSame($groups, $this->formStateDecoratorBase->getGroups());
- }
- /**
- * @covers ::setHasFileElement
- *
- * @dataProvider providerSingleBooleanArgument
- *
- * @param bool $has_file_element
- */
- public function testSetHasFileElement($has_file_element) {
- $this->decoratedFormState->setHasFileElement($has_file_element)
- ->shouldBeCalled();
- $this->assertSame($this->formStateDecoratorBase, $this->formStateDecoratorBase->setHasFileElement($has_file_element));
- }
- /**
- * @covers ::hasFileElement
- *
- * @dataProvider providerSingleBooleanArgument
- *
- * @param bool $has_file_element
- */
- public function testHasFileElement($has_file_element) {
- $this->decoratedFormState->hasFileElement()
- ->willReturn($has_file_element)
- ->shouldBeCalled();
- $this->assertSame($has_file_element, $this->formStateDecoratorBase->hasFileElement());
- }
- /**
- * @covers ::setLimitValidationErrors
- *
- * @dataProvider providerLimitValidationErrors
- *
- * @param array[]|null $limit_validation_errors
- * Any valid value for
- * \Drupal\Core\Form\FormStateInterface::setLimitValidationErrors()'s
- * $limit_validation_errors argument;
- */
- public function testSetLimitValidationErrors($limit_validation_errors) {
- $this->decoratedFormState->setLimitValidationErrors($limit_validation_errors)
- ->shouldBecalled();
- $this->assertSame($this->formStateDecoratorBase, $this->formStateDecoratorBase->setLimitValidationErrors($limit_validation_errors));
- }
- /**
- * @covers ::getLimitValidationErrors
- *
- * @dataProvider providerLimitValidationErrors
- *
- * @param array[]|null $limit_validation_errors
- * Any valid value for
- * \Drupal\Core\Form\FormStateInterface::getLimitValidationErrors()'s
- * return value;
- */
- public function testGetLimitValidationErrors($limit_validation_errors) {
- $this->decoratedFormState->getLimitValidationErrors()
- ->willReturn($limit_validation_errors)
- ->shouldBeCalled();
- $this->assertSame($limit_validation_errors, $this->formStateDecoratorBase->getLimitValidationErrors());
- }
- /**
- * Provides data to self::testGetLimitValidationErrors() and self::testGetLimitValidationErrors().
- */
- public function providerLimitValidationErrors() {
- return [
- [NULL],
- [
- [
- ['foo', 'bar', 'baz'],
- ],
- ],
- ];
- }
- /**
- * @covers ::setMethod
- *
- * @dataProvider providerSingleBooleanArgument
- *
- * @param bool $method
- */
- public function testSetMethod($method) {
- $this->decoratedFormState->setMethod($method)
- ->shouldBecalled();
- $this->assertSame($this->formStateDecoratorBase, $this->formStateDecoratorBase->setMethod($method));
- }
- /**
- * @covers ::isMethodType
- *
- * @dataProvider providerIsMethodType
- *
- * @param bool $expected_return_value
- * @param string $method_type
- * Either "GET" or "POST".
- */
- public function testIsMethodType($expected_return_value, $method_type) {
- $this->decoratedFormState->isMethodType($method_type)
- ->willReturn($expected_return_value)
- ->shouldBecalled();
- $this->assertSame($expected_return_value, $this->formStateDecoratorBase->isMethodType($method_type));
- }
- /**
- * Provides data to self::testIsMethodType().
- */
- public function providerIsMethodType() {
- return [
- [TRUE, 'GET'],
- [TRUE, 'POST'],
- [FALSE, 'GET'],
- [FALSE, 'POST'],
- ];
- }
- /**
- * @covers ::setRequestMethod
- *
- * @dataProvider providerSetRequestMethod
- *
- * @param bool $method
- */
- public function testSetRequestMethod($method) {
- $this->decoratedFormState->setRequestMethod($method)
- ->shouldBeCalled();
- $this->assertSame($this->formStateDecoratorBase, $this->formStateDecoratorBase->setRequestMethod($method));
- }
- /**
- * Provides data to self::testSetMethod().
- */
- public function providerSetRequestMethod() {
- return [
- ['GET'],
- ['POST'],
- ];
- }
- /**
- * @covers ::setValidationEnforced
- *
- * @dataProvider providerSingleBooleanArgument
- *
- * @param bool $must_validate
- */
- public function testSetValidationEnforced($must_validate) {
- $this->decoratedFormState->setValidationEnforced($must_validate)
- ->shouldBeCalled();
- $this->assertSame($this->formStateDecoratorBase, $this->formStateDecoratorBase->setValidationEnforced($must_validate));
- }
- /**
- * @covers ::isValidationEnforced
- *
- * @dataProvider providerSingleBooleanArgument
- *
- * @param bool $must_validate
- */
- public function testIsValidationEnforced($must_validate) {
- $this->decoratedFormState->isValidationEnforced()
- ->willReturn($must_validate)
- ->shouldBecalled();
- $this->assertSame($must_validate, $this->formStateDecoratorBase->isValidationEnforced());
- }
- /**
- * @covers ::disableRedirect
- *
- * @dataProvider providerSingleBooleanArgument
- *
- * @param bool $no_redirect
- */
- public function testDisableRedirect($no_redirect) {
- $this->decoratedFormState->disableRedirect($no_redirect)
- ->shouldBeCalled();
- $this->assertSame($this->formStateDecoratorBase, $this->formStateDecoratorBase->disableRedirect($no_redirect));
- }
- /**
- * @covers ::isRedirectDisabled
- *
- * @dataProvider providerSingleBooleanArgument
- *
- * @param bool $no_redirect
- */
- public function testIsRedirectDisabled($no_redirect) {
- $this->decoratedFormState->isRedirectDisabled()
- ->willReturn($no_redirect)
- ->shouldBeCalled();
- $this->assertSame($no_redirect, $this->formStateDecoratorBase->isRedirectDisabled());
- }
- /**
- * @covers ::setProcessInput
- *
- * @dataProvider providerSingleBooleanArgument
- *
- * @param bool $process_input
- */
- public function testSetProcessInput($process_input) {
- $this->decoratedFormState->setProcessInput($process_input)
- ->shouldBeCalled();
- $this->assertSame($this->formStateDecoratorBase, $this->formStateDecoratorBase->setProcessInput($process_input));
- }
- /**
- * @covers ::isProcessingInput
- *
- * @dataProvider providerSingleBooleanArgument
- *
- * @param bool $process_input
- */
- public function testIsProcessingInput($process_input) {
- $this->decoratedFormState->isProcessingInput()
- ->willReturn($process_input)
- ->shouldBecalled();
- $this->assertSame($process_input, $this->formStateDecoratorBase->isProcessingInput());
- }
- /**
- * @covers ::setProgrammed
- *
- * @dataProvider providerSingleBooleanArgument
- *
- * @param bool $programmed
- */
- public function testSetProgrammed($programmed) {
- $this->decoratedFormState->setProgrammed($programmed)
- ->shouldBecalled();
- $this->assertSame($this->formStateDecoratorBase, $this->formStateDecoratorBase->setProgrammed($programmed));
- }
- /**
- * @covers ::isProgrammed
- *
- * @dataProvider providerSingleBooleanArgument
- *
- * @param bool $programmed
- */
- public function testIsProgrammed($programmed) {
- $this->decoratedFormState->isProgrammed()
- ->willReturn($programmed)
- ->shouldBecalled();
- $this->assertSame($programmed, $this->formStateDecoratorBase->isProgrammed());
- }
- /**
- * @covers ::setProgrammedBypassAccessCheck
- *
- * @dataProvider providerSingleBooleanArgument
- *
- * @param bool $programmed_bypass_access_check
- */
- public function testSetProgrammedBypassAccessCheck($programmed_bypass_access_check) {
- $this->decoratedFormState->setProgrammedBypassAccessCheck($programmed_bypass_access_check)
- ->shouldBecalled();
- $this->assertSame($this->formStateDecoratorBase, $this->formStateDecoratorBase->setProgrammedBypassAccessCheck($programmed_bypass_access_check));
- }
- /**
- * @covers ::isBypassingProgrammedAccessChecks
- *
- * @dataProvider providerSingleBooleanArgument
- *
- * @param bool $programmed_bypass_access_check
- */
- public function testIsBypassingProgrammedAccessChecks($programmed_bypass_access_check) {
- $this->decoratedFormState->isBypassingProgrammedAccessChecks()
- ->willReturn($programmed_bypass_access_check)
- ->shouldBeCalled();
- $this->assertSame($programmed_bypass_access_check, $this->formStateDecoratorBase->isBypassingProgrammedAccessChecks());
- }
- /**
- * @covers ::setRebuildInfo
- */
- public function testSetRebuildInfo() {
- $rebuild_info = [
- 'FOO' => 'BAR',
- ];
- $this->decoratedFormState->setRebuildInfo($rebuild_info)
- ->shouldBeCalled();
- $this->assertSame($this->formStateDecoratorBase, $this->formStateDecoratorBase->setRebuildInfo($rebuild_info));
- }
- /**
- * @covers ::getRebuildInfo
- */
- public function testGetRebuildInfo() {
- $rebuild_info = [
- 'FOO' => 'BAR',
- ];
- $this->decoratedFormState->getRebuildInfo()
- ->willReturn($rebuild_info)
- ->shouldBeCalled();
- $this->assertSame($rebuild_info, $this->formStateDecoratorBase->getRebuildInfo());
- }
- /**
- * @covers ::addRebuildInfo
- */
- public function testAddRebuildInfo() {
- $property = 'FOO';
- $value = 'BAR';
- $this->decoratedFormState->addRebuildInfo($property, $value);
- $this->assertSame($this->formStateDecoratorBase, $this->formStateDecoratorBase->addRebuildInfo($property, $value));
- }
- /**
- * @covers ::setStorage
- */
- public function testSetStorage() {
- $storage = [
- 'FOO' => 'BAR',
- ];
- $this->decoratedFormState->setStorage($storage)
- ->shouldBeCalled();
- $this->assertSame($this->formStateDecoratorBase, $this->formStateDecoratorBase->setStorage($storage));
- }
- /**
- * @covers ::getStorage
- */
- public function testGetStorage() {
- $storage = [
- 'FOO' => 'BAR',
- ];
- // Use PHPUnit for mocking, because Prophecy cannot mock methods that return
- // by reference. See \Prophecy\Doubler\Generator\Node::getCode().
- $decorated_form_state = $this->createMock(FormStateInterface::class);
- $decorated_form_state->expects($this->once())
- ->method('getStorage')
- ->willReturn($storage);
- $this->formStateDecoratorBase = new NonAbstractFormStateDecoratorBase($decorated_form_state);
- $this->assertSame($storage, $this->formStateDecoratorBase->getStorage());
- }
- /**
- * @covers ::setSubmitHandlers
- */
- public function testSetSubmitHandlers() {
- $submit_handlers = [
- 'FOO' => 'BAR',
- ];
- $this->decoratedFormState->setSubmitHandlers($submit_handlers)
- ->shouldBeCalled();
- $this->assertSame($this->formStateDecoratorBase, $this->formStateDecoratorBase->setSubmitHandlers($submit_handlers));
- }
- /**
- * @covers ::getSubmitHandlers
- */
- public function testGetSubmitHandlers() {
- $submit_handlers = [
- 'FOO' => 'BAR',
- ];
- $this->decoratedFormState->getSubmitHandlers()
- ->willReturn($submit_handlers)
- ->shouldBeCalled();
- $this->assertSame($submit_handlers, $this->formStateDecoratorBase->getSubmitHandlers());
- }
- /**
- * @covers ::setSubmitted
- */
- public function testSetSubmitted() {
- $this->decoratedFormState->setSubmitted()
- ->shouldBeCalled();
- $this->assertSame($this->formStateDecoratorBase, $this->formStateDecoratorBase->setSubmitted());
- }
- /**
- * @covers ::isSubmitted
- *
- * @dataProvider providerSingleBooleanArgument
- *
- * @param bool $submitted
- */
- public function testIsSubmitted($submitted) {
- $this->decoratedFormState->isSubmitted()
- ->willReturn($submitted);
- $this->assertSame($submitted, $this->formStateDecoratorBase->isSubmitted());
- }
- /**
- * @covers ::setTemporary
- */
- public function testSetTemporary() {
- $temporary = [
- 'FOO' => 'BAR',
- ];
- $this->decoratedFormState->setTemporary($temporary)
- ->shouldBeCalled();
- $this->assertSame($this->formStateDecoratorBase, $this->formStateDecoratorBase->setTemporary($temporary));
- }
- /**
- * @covers ::getTemporary
- */
- public function testGetTemporary() {
- $temporary = [
- 'FOO' => 'BAR',
- ];
- $this->decoratedFormState->getTemporary()
- ->willReturn($temporary)
- ->shouldBeCalled();
- $this->assertSame($temporary, $this->formStateDecoratorBase->getTemporary());
- }
- /**
- * @covers ::setTemporaryValue
- *
- * @dataProvider providerSetTemporaryValue
- *
- * @param string $key
- * @param mixed $value
- */
- public function testSetTemporaryValue($key, $value) {
- $this->decoratedFormState->setTemporaryValue($key, $value)
- ->shouldBeCalled();
- $this->assertSame($this->formStateDecoratorBase, $this->formStateDecoratorBase->setTemporaryValue($key, $value));
- }
- /**
- * Provides data to self::testSetTemporaryValue().
- */
- public function providerSetTemporaryValue() {
- return [
- ['FOO', 'BAR'],
- ['FOO', NULL],
- ];
- }
- /**
- * @covers ::getTemporaryValue
- *
- * @dataProvider providerGetTemporaryValue
- *
- * @param string $key
- * @param mixed $value
- */
- public function testGetTemporaryValue($key, $value = NULL) {
- // Use PHPUnit for mocking, because Prophecy cannot mock methods that return
- // by reference. See \Prophecy\Doubler\Generator\Node::getCode().
- $decorated_form_state = $this->createMock(FormStateInterface::class);
- $decorated_form_state->expects($this->once())
- ->method('getTemporaryValue')
- ->with($key)
- ->willReturn($value);
- $this->formStateDecoratorBase = new NonAbstractFormStateDecoratorBase($decorated_form_state);
- $this->assertSame($value, $this->formStateDecoratorBase->getTemporaryValue($key));
- }
- /**
- * Provides data to self::testGetTemporaryValue().
- */
- public function providerGetTemporaryValue() {
- return [
- [TRUE, 'FOO', 'BAR'],
- [TRUE, 'FOO', NULL],
- ];
- }
- /**
- * @covers ::hasTemporaryValue
- *
- * @dataProvider providerHasTemporaryValue
- *
- * @param bool $exists
- * @param string $key
- */
- public function testHasTemporaryValue($exists, $key) {
- $this->decoratedFormState->hasTemporaryValue($key)
- ->willReturn($exists)
- ->shouldBeCalled();
- $this->assertSame($exists, $this->formStateDecoratorBase->hasTemporaryValue($key));
- }
- /**
- * Provides data to self::testHasTemporaryValue().
- */
- public function providerHasTemporaryValue() {
- return [
- [TRUE, 'FOO'],
- [FALSE, 'FOO'],
- ];
- }
- /**
- * @covers ::setTriggeringElement
- */
- public function testSetTriggeringElement() {
- $triggering_element = [
- 'FOO' => 'BAR',
- ];
- $this->decoratedFormState->setTriggeringElement($triggering_element)
- ->shouldBeCalled();
- $this->assertSame($this->formStateDecoratorBase, $this->formStateDecoratorBase->setTriggeringElement($triggering_element));
- }
- /**
- * @covers ::getTriggeringElement
- */
- public function testGetTriggeringElement() {
- $triggering_element = [
- 'FOO' => 'BAR',
- ];
- // Use PHPUnit for mocking, because Prophecy cannot mock methods that return
- // by reference. See \Prophecy\Doubler\Generator\Node::getCode().
- $decorated_form_state = $this->createMock(FormStateInterface::class);
- $decorated_form_state->expects($this->once())
- ->method('getTriggeringElement')
- ->willReturn($triggering_element);
- $this->formStateDecoratorBase = new NonAbstractFormStateDecoratorBase($decorated_form_state);
- $this->assertSame($triggering_element, $this->formStateDecoratorBase->getTriggeringElement());
- }
- /**
- * @covers ::setValidateHandlers
- */
- public function testSetValidateHandlers() {
- $validate_handlers = [
- 'FOO' => 'BAR',
- ];
- $this->decoratedFormState->setValidateHandlers($validate_handlers)
- ->shouldBeCalled();
- $this->assertSame($this->formStateDecoratorBase, $this->formStateDecoratorBase->setValidateHandlers($validate_handlers));
- }
- /**
- * @covers ::getValidateHandlers
- */
- public function testGetValidateHandlers() {
- $validate_handlers = [
- 'FOO' => 'BAR',
- ];
- $this->decoratedFormState->getValidateHandlers()
- ->willReturn($validate_handlers)
- ->shouldBecalled();
- $this->assertSame($validate_handlers, $this->formStateDecoratorBase->getValidateHandlers());
- }
- /**
- * @covers ::setValidationComplete
- *
- * @dataProvider providerSingleBooleanArgument
- *
- * @param bool $complete
- */
- public function testSetValidationComplete($complete) {
- $this->decoratedFormState->setValidationComplete($complete)
- ->shouldBeCalled();
- $this->assertSame($this->formStateDecoratorBase, $this->formStateDecoratorBase->setValidationComplete($complete));
- }
- /**
- * @covers ::isValidationComplete
- *
- * @dataProvider providerSingleBooleanArgument
- *
- * @param bool $complete
- */
- public function testIsValidationComplete($complete) {
- $this->decoratedFormState->isValidationComplete()
- ->willReturn($complete)
- ->shouldBeCalled();
- $this->assertSame($complete, $this->formStateDecoratorBase->isValidationComplete());
- }
- /**
- * @covers ::loadInclude
- *
- * @dataProvider providerLoadInclude
- *
- * @param string|false $expected
- * @param string $module
- * @param string $type
- * @param string|null $name
- */
- public function testLoadInclude($expected, $module, $type, $name) {
- $this->decoratedFormState->loadInclude($module, $type, $name)
- ->willReturn($expected)
- ->shouldBeCalled();
- $this->assertSame($expected, $this->formStateDecoratorBase->loadInclude($module, $type, $name));
- }
- /**
- * Provides data to self::testLoadInclude().
- */
- public function providerLoadInclude() {
- return [
- // Existing files.
- [__FILE__, 'foo', 'inc', 'foo'],
- [__FILE__, 'foo', 'inc', 'foo.admin'],
- [__FILE__, 'bar', 'inc', 'bar'],
- // Non-existent files.
- [FALSE, 'foo', 'php', 'foo'],
- [FALSE, 'bar', 'php', 'foo'],
- ];
- }
- /**
- * @covers ::getCacheableArray
- */
- public function testGetCacheableArray() {
- $cacheable_array = [
- 'foo' => 'bar',
- ];
- $this->decoratedFormState->getCacheableArray()
- ->willReturn($cacheable_array)
- ->shouldBeCalled();
- $this->assertSame($cacheable_array, $this->formStateDecoratorBase->getCacheableArray());
- }
- /**
- * @covers ::setCompleteForm
- */
- public function testSetCompleteForm() {
- $complete_form = [
- 'FOO' => 'BAR',
- ];
- $this->decoratedFormState->setCompleteForm($complete_form)
- ->shouldBeCalled();
- $this->assertSame($this->formStateDecoratorBase, $this->formStateDecoratorBase->setCompleteForm($complete_form));
- }
- /**
- * @covers ::getCompleteForm
- */
- public function testGetCompleteForm() {
- $complete_form = [
- 'FOO' => 'BAR',
- ];
- // Use PHPUnit for mocking, because Prophecy cannot mock methods that return
- // by reference. See \Prophecy\Doubler\Generator\Node::getCode().
- $decorated_form_state = $this->createMock(FormStateInterface::class);
- $decorated_form_state->expects($this->once())
- ->method('getCompleteForm')
- ->willReturn($complete_form);
- $this->formStateDecoratorBase = new NonAbstractFormStateDecoratorBase($decorated_form_state);
- $this->assertSame($this->formStateDecoratorBase, $this->formStateDecoratorBase->setCompleteForm($complete_form));
- $this->assertSame($complete_form, $this->formStateDecoratorBase->getCompleteForm());
- }
- /**
- * @covers ::set
- *
- * @dataProvider providerSet
- *
- * @param string $key
- * @param mixed $value
- */
- public function testSet($key, $value) {
- $this->decoratedFormState->set($key, $value)
- ->shouldBeCalled();
- $this->assertSame($this->formStateDecoratorBase, $this->formStateDecoratorBase->set($key, $value));
- }
- /**
- * Provides data to self::testSet().
- */
- public function providerSet() {
- return [
- ['FOO', 'BAR'],
- ['FOO', NULL],
- ];
- }
- /**
- * @covers ::get
- *
- * @dataProvider providerGet
- *
- * @param string $key
- * @param mixed $value
- */
- public function testGet($key, $value = NULL) {
- // Use PHPUnit for mocking, because Prophecy cannot mock methods that return
- // by reference. See \Prophecy\Doubler\Generator\Node::getCode().
- $decorated_form_state = $this->createMock(FormStateInterface::class);
- $decorated_form_state->expects($this->once())
- ->method('get')
- ->with($key)
- ->willReturn($value);
- $this->formStateDecoratorBase = new NonAbstractFormStateDecoratorBase($decorated_form_state);
- $this->assertSame($value, $this->formStateDecoratorBase->get($key));
- }
- /**
- * Provides data to self::testGet().
- */
- public function providerGet() {
- return [
- ['FOO', 'BAR'],
- ['FOO', NULL],
- ];
- }
- /**
- * @covers ::has
- *
- * @dataProvider providerHas
- *
- * @param bool $exists
- * @param string $key
- */
- public function testHas($exists, $key) {
- $this->decoratedFormState->has($key)
- ->willReturn($exists)
- ->shouldBeCalled();
- $this->assertSame($exists, $this->formStateDecoratorBase->has($key));
- }
- /**
- * Provides data to self::testHas().
- */
- public function providerHas() {
- return [
- [TRUE, 'FOO'],
- [FALSE, 'FOO'],
- ];
- }
- /**
- * @covers ::setBuildInfo
- */
- public function testSetBuildInfo() {
- $build_info = [
- 'FOO' => 'BAR',
- ];
- $this->decoratedFormState->setBuildInfo($build_info)
- ->shouldBeCalled();
- $this->assertSame($this->formStateDecoratorBase, $this->formStateDecoratorBase->setBuildInfo($build_info));
- }
- /**
- * @covers ::getBuildInfo
- */
- public function testGetBuildInfo() {
- $build_info = [
- 'FOO' => 'BAR',
- ];
- $this->decoratedFormState->getBuildInfo()
- ->willReturn($build_info)
- ->shouldBeCalled();
- $this->assertSame($build_info, $this->formStateDecoratorBase->getBuildInfo());
- }
- /**
- * @covers ::addBuildInfo
- */
- public function testAddBuildInfo() {
- $property = 'FOO';
- $value = 'BAR';
- $this->decoratedFormState->addBuildInfo($property, $value)
- ->shouldBeCalled();
- $this->assertSame($this->formStateDecoratorBase, $this->formStateDecoratorBase->addBuildInfo($property, $value));
- }
- /**
- * @covers ::setUserInput
- */
- public function testSetUserInput() {
- $user_input = [
- 'FOO' => 'BAR',
- ];
- $this->decoratedFormState->setUserInput($user_input)
- ->shouldBeCalled();
- $this->assertSame($this->formStateDecoratorBase, $this->formStateDecoratorBase->setUserInput($user_input));
- }
- /**
- * @covers ::getUserInput
- */
- public function testGetUserInput() {
- $user_input = [
- 'FOO' => 'BAR',
- ];
- // Use PHPUnit for mocking, because Prophecy cannot mock methods that return
- // by reference. See \Prophecy\Doubler\Generator\Node::getCode().
- $decorated_form_state = $this->createMock(FormStateInterface::class);
- $decorated_form_state->expects($this->once())
- ->method('getUserInput')
- ->willReturn($user_input);
- $this->formStateDecoratorBase = new NonAbstractFormStateDecoratorBase($decorated_form_state);
- $this->assertSame($user_input, $this->formStateDecoratorBase->getUserInput());
- }
- /**
- * @covers ::getValues
- */
- public function testGetValues() {
- $values = [
- 'FOO' => 'BAR',
- ];
- // Use PHPUnit for mocking, because Prophecy cannot mock methods that return
- // by reference. See \Prophecy\Doubler\Generator\Node::getCode().
- $decorated_form_state = $this->createMock(FormStateInterface::class);
- $decorated_form_state->expects($this->once())
- ->method('getValues')
- ->willReturn($values);
- $this->formStateDecoratorBase = new NonAbstractFormStateDecoratorBase($decorated_form_state);
- $this->assertSame($values, $this->formStateDecoratorBase->getValues());
- }
- /**
- * @covers ::getValue
- */
- public function testGetValue() {
- $key = 'FOO';
- $value = 'BAR';
- // Use PHPUnit for mocking, because Prophecy cannot mock methods that return
- // by reference. See \Prophecy\Doubler\Generator\Node::getCode().
- $decorated_form_state = $this->createMock(FormStateInterface::class);
- $decorated_form_state->expects($this->once())
- ->method('getValue')
- ->with($key, $value)
- ->willReturn($value);
- $this->formStateDecoratorBase = new NonAbstractFormStateDecoratorBase($decorated_form_state);
- $this->assertSame($value, $this->formStateDecoratorBase->getValue($key, $value));
- }
- /**
- * @covers ::setValues
- */
- public function testSetValues() {
- $values = [
- 'foo' => 'Foo',
- 'bar' => ['Bar'],
- ];
- $this->decoratedFormState->setValues($values)
- ->shouldBeCalled();
- $this->assertSame($this->formStateDecoratorBase, $this->formStateDecoratorBase->setValues($values));
- }
- /**
- * @covers ::setValue
- */
- public function testSetValue() {
- $key = 'FOO';
- $value = 'BAR';
- $this->decoratedFormState->setValue($key, $value)
- ->shouldBeCalled();
- $this->assertSame($this->formStateDecoratorBase, $this->formStateDecoratorBase->setValue($key, $value));
- }
- /**
- * @covers ::unsetValue
- */
- public function testUnsetValue() {
- $key = 'FOO';
- $this->decoratedFormState->unsetValue($key)
- ->shouldBeCalled();
- $this->assertSame($this->formStateDecoratorBase, $this->formStateDecoratorBase->unsetValue($key));
- }
- /**
- * @covers ::hasValue
- */
- public function testHasValue() {
- $key = ['foo', 'bar'];
- $has = TRUE;
- $this->decoratedFormState->hasValue($key)
- ->willReturn($has)
- ->shouldBeCalled();
- $this->assertSame($has, $this->formStateDecoratorBase->hasValue($key));
- }
- /**
- * @covers ::isValueEmpty
- */
- public function testIsValueEmpty() {
- $key = ['foo', 'bar'];
- $is_empty = TRUE;
- $this->decoratedFormState->isValueEmpty($key)
- ->willReturn($is_empty)
- ->shouldBeCalled();
- $this->assertSame($is_empty, $this->formStateDecoratorBase->isValueEmpty($key));
- }
- /**
- * @covers ::setValueForElement
- */
- public function testSetValueForElement() {
- $element = [
- '#type' => 'foo',
- ];
- $value = 'BAR';
- $this->decoratedFormState->setValueForElement($element, $value)
- ->shouldBeCalled();
- $this->assertSame($this->formStateDecoratorBase, $this->formStateDecoratorBase->setValueForElement($element, $value));
- }
- /**
- * @covers ::setResponse
- */
- public function testSetResponse() {
- $response = $this->createMock(Response::class);
- $this->decoratedFormState->setResponse($response)
- ->shouldBeCalled();
- $this->assertSame($this->formStateDecoratorBase, $this->formStateDecoratorBase->setResponse($response));
- }
- /**
- * @covers ::getResponse
- */
- public function testGetResponse() {
- $response = $this->createMock(Response::class);
- $this->decoratedFormState->getResponse()
- ->willReturn($response)
- ->shouldBeCalled();
- $this->assertSame($response, $this->formStateDecoratorBase->getResponse());
- }
- /**
- * @covers ::setRedirect
- */
- public function testSetRedirect() {
- $route_name = 'foo';
- $route_parameters = [
- 'bar' => 'baz',
- ];
- $options = [
- 'qux' => 'foo',
- ];
- $this->decoratedFormState->setRedirect($route_name, $route_parameters, $options)
- ->shouldBeCalled();
- $this->assertSame($this->formStateDecoratorBase, $this->formStateDecoratorBase->setRedirect($route_name, $route_parameters, $options));
- }
- /**
- * @covers ::setRedirectUrl
- */
- public function testSetRedirectUrl() {
- $url = new Url('foo');
- $this->decoratedFormState->setRedirectUrl($url)
- ->shouldBeCalled();
- $this->assertSame($this->formStateDecoratorBase, $this->formStateDecoratorBase->setRedirectUrl($url));
- }
- /**
- * @covers ::getRedirect
- *
- * @dataProvider providerGetRedirect
- *
- * @param bool $expected
- */
- public function testGetRedirect($expected) {
- $this->decoratedFormState->getRedirect()
- ->willReturn($expected)
- ->shouldBeCalled();
- $this->assertSame($expected, $this->formStateDecoratorBase->getRedirect());
- }
- /**
- * Provides data to self::testGetRedirect().
- */
- public function providerGetRedirect() {
- return [
- [NULL],
- [FALSE],
- [new Url('foo')],
- [new RedirectResponse('http://example.com')],
- ];
- }
- /**
- * @covers ::setErrorByName
- */
- public function testSetErrorByName() {
- $name = 'foo';
- $message = 'bar';
- $this->decoratedFormState->setErrorByName($name, $message)
- ->shouldBeCalled();
- $this->assertSame($this->formStateDecoratorBase, $this->formStateDecoratorBase->setErrorByName($name, $message));
- }
- /**
- * @covers ::setError
- */
- public function testSetError() {
- $element = [
- '#foo' => 'bar',
- ];
- $message = 'bar';
- $this->decoratedFormState->setError($element, $message)
- ->shouldBeCalled();
- $this->assertSame($this->formStateDecoratorBase, $this->formStateDecoratorBase->setError($element, $message));
- }
- /**
- * @covers ::clearErrors
- */
- public function testClearErrors() {
- $this->decoratedFormState->clearErrors()
- ->shouldBeCalled();
- $this->formStateDecoratorBase->clearErrors();
- }
- /**
- * @covers ::getError
- */
- public function testGetError() {
- $element = [
- '#foo' => 'bar',
- ];
- $message = 'bar';
- $this->decoratedFormState->getError($element)
- ->willReturn($message)
- ->shouldBeCalled();
- $this->assertSame($message, $this->formStateDecoratorBase->getError($element));
- }
- /**
- * @covers ::getErrors
- */
- public function testGetErrors() {
- $errors = [
- 'foo' => 'bar',
- ];
- $this->decoratedFormState->getErrors()
- ->willReturn($errors)
- ->shouldBeCalled();
- $this->assertSame($errors, $this->formStateDecoratorBase->getErrors());
- }
- /**
- * @covers ::setRebuild
- *
- * @dataProvider providerSingleBooleanArgument
- *
- * @param bool $rebuild
- */
- public function testSetRebuild($rebuild) {
- $this->decoratedFormState->setRebuild($rebuild)
- ->shouldBeCalled();
- $this->assertSame($this->formStateDecoratorBase, $this->formStateDecoratorBase->setRebuild($rebuild));
- }
- /**
- * @covers ::isRebuilding
- *
- * @dataProvider providerSingleBooleanArgument
- *
- * @param bool $rebuild
- */
- public function testIsRebuilding($rebuild) {
- $this->decoratedFormState->isRebuilding()
- ->willReturn($rebuild)
- ->shouldBeCalled();
- $this->assertSame($rebuild, $this->formStateDecoratorBase->isRebuilding());
- }
- /**
- * @covers ::setInvalidToken
- *
- * @dataProvider providerSingleBooleanArgument
- *
- * @param bool $expected
- */
- public function testSetInvalidToken($expected) {
- $this->decoratedFormState->setInvalidToken($expected)
- ->shouldBeCalled();
- $this->assertSame($this->formStateDecoratorBase, $this->formStateDecoratorBase->setInvalidToken($expected));
- }
- /**
- * @covers ::hasInvalidToken
- *
- * @dataProvider providerSingleBooleanArgument
- *
- * @param bool $expected
- */
- public function testHasInvalidToken($expected) {
- $this->decoratedFormState->hasInvalidToken()
- ->willReturn($expected)
- ->shouldBeCalled();
- $this->assertSame($expected, $this->formStateDecoratorBase->hasInvalidToken());
- }
- /**
- * @covers ::prepareCallback
- *
- * @dataProvider providerPrepareCallback
- *
- * @param string|callable $unprepared_callback
- * @param callable $prepared_callback
- */
- public function testPrepareCallback($unprepared_callback, callable $prepared_callback) {
- $this->decoratedFormState->prepareCallback(Argument::is($unprepared_callback))
- ->willReturn($prepared_callback)
- ->shouldBeCalled();
- $this->assertSame($prepared_callback, $this->formStateDecoratorBase->prepareCallback($unprepared_callback));
- }
- /**
- * Provides data to self::testPrepareCallback().
- */
- public function providerPrepareCallback() {
- $function = 'sleep';
- $shorthand_form_method = '::submit()';
- $closure = function () {};
- $static_method_string = __METHOD__;
- $static_method_array = [__CLASS__, __FUNCTION__];
- $object_method_array = [$this, __FUNCTION__];
- return [
- // A shorthand form method is generally expanded to become a method on an
- // object.
- [$shorthand_form_method, $object_method_array],
- // Functions, closures, and static method calls generally remain the same.
- [$function, $function],
- [$closure, $closure],
- [$static_method_string, $static_method_string],
- [$static_method_array, $static_method_array],
- ];
- }
- /**
- * @covers ::setFormObject
- */
- public function testSetFormObject() {
- $form = $this->createMock(FormInterface::class);
- $this->decoratedFormState->setFormObject($form)
- ->shouldBeCalled();
- $this->assertSame($this->formStateDecoratorBase, $this->formStateDecoratorBase->setFormObject($form));
- }
- /**
- * @covers ::getFormObject
- */
- public function testGetFormObject() {
- $form = $this->createMock(FormInterface::class);
- $this->decoratedFormState->getFormObject()
- ->willReturn($form)
- ->shouldBeCalled();
- $this->assertSame($form, $this->formStateDecoratorBase->getFormObject());
- }
- /**
- * @covers ::setCleanValueKeys
- */
- public function testSetCleanValueKeys() {
- $keys = ['BAR'];
- $this->decoratedFormState->setCleanValueKeys($keys)
- ->shouldBeCalled();
- $this->assertSame($this->formStateDecoratorBase, $this->formStateDecoratorBase->setCleanValueKeys($keys));
- }
- /**
- * @covers ::getCleanValueKeys
- */
- public function testGetCleanValueKeys() {
- $keys = ['BAR'];
- $this->decoratedFormState->getCleanValueKeys()
- ->willReturn($keys)
- ->shouldBeCalled();
- $this->assertSame($keys, $this->formStateDecoratorBase->getCleanValueKeys());
- }
- /**
- * @covers ::addCleanValueKey
- */
- public function testAddCleanValueKey() {
- $key = 'BAR';
- $this->decoratedFormState->addCleanValueKey($key)
- ->shouldBeCalled();
- $this->assertSame($this->formStateDecoratorBase, $this->formStateDecoratorBase->addCleanValueKey($key));
- }
- /**
- * @covers ::cleanValues
- */
- public function testCleanValues() {
- $this->decoratedFormState->cleanValues()
- ->shouldBeCalled();
- $this->assertSame($this->formStateDecoratorBase, $this->formStateDecoratorBase->cleanValues());
- }
- }
- /**
- * Provides a non-abstract version of the class under test.
- */
- class NonAbstractFormStateDecoratorBase extends FormStateDecoratorBase {
- /**
- * Creates a new instance.
- *
- * @param \Drupal\Core\Form\FormStateInterface $decorated_form_state
- * The decorated form state.
- */
- public function __construct(FormStateInterface $decorated_form_state) {
- $this->decoratedFormState = $decorated_form_state;
- }
- }
|