| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111 |
- <?php
- declare(strict_types=1);
- /**
- * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
- * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
- *
- * Licensed under The MIT License
- * For full copyright and license information, please see the LICENSE.txt
- * Redistributions of files must retain the above copyright notice.
- *
- * @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
- * @link https://cakephp.org CakePHP(tm) Project
- * @since 4.3.0
- * @license https://opensource.org/licenses/mit-license.php MIT License
- */
- namespace Cake\Test\TestCase\Database\Expression;
- use Cake\Chronos\Chronos;
- use Cake\Chronos\ChronosDate;
- use Cake\Database\Expression\CaseStatementExpression;
- use Cake\Database\Expression\ComparisonExpression;
- use Cake\Database\Expression\FunctionExpression;
- use Cake\Database\Expression\IdentifierExpression;
- use Cake\Database\Expression\QueryExpression;
- use Cake\Database\Expression\WhenThenExpression;
- use Cake\Database\TypeFactory;
- use Cake\Database\TypeMap;
- use Cake\Database\ValueBinder;
- use Cake\Datasource\ConnectionManager;
- use Cake\I18n\Date;
- use Cake\I18n\DateTime;
- use Cake\Test\test_app\TestApp\Database\Expression\CustomWhenThenExpression;
- use Cake\Test\test_app\TestApp\Stub\CaseStatementExpressionStub;
- use Cake\Test\test_app\TestApp\Stub\WhenThenExpressionStub;
- use Cake\TestSuite\TestCase;
- use InvalidArgumentException;
- use LogicException;
- use PHPUnit\Framework\Attributes\DataProvider;
- use stdClass;
- use TestApp\Database\Type\CustomExpressionType;
- use TestApp\View\Object\TestObjectWithToString;
- use TypeError;
- class CaseStatementExpressionTest extends TestCase
- {
- // region Type handling
- public function testExpressionTypeCastingSimpleCase(): void
- {
- TypeFactory::map('custom', CustomExpressionType::class);
- $expression = (new CaseStatementExpression(1, 'custom'))
- ->when(1, 'custom')
- ->then(2, 'custom')
- ->else(3, 'custom');
- $valueBinder = new ValueBinder();
- $sql = $expression->sql($valueBinder);
- $this->assertSame(
- 'CASE CUSTOM(:param0) WHEN CUSTOM(:param1) THEN CUSTOM(:param2) ELSE CUSTOM(:param3) END',
- $sql
- );
- }
- public function testExpressionTypeCastingNullValues(): void
- {
- TypeFactory::map('custom', CustomExpressionType::class);
- $expression = (new CaseStatementExpression(null, 'custom'))
- ->when(1, 'custom')
- ->then(null, 'custom')
- ->else(null, 'custom');
- $valueBinder = new ValueBinder();
- $sql = $expression->sql($valueBinder);
- $this->assertSame(
- 'CASE CUSTOM(:param0) WHEN CUSTOM(:param1) THEN CUSTOM(:param2) ELSE CUSTOM(:param3) END',
- $sql
- );
- }
- public function testExpressionTypeCastingSearchedCase(): void
- {
- TypeFactory::map('custom', CustomExpressionType::class);
- $expression = (new CaseStatementExpression())
- ->when(['Table.column' => true], ['Table.column' => 'custom'])
- ->then(1, 'custom')
- ->else(2, 'custom');
- $valueBinder = new ValueBinder();
- $sql = $expression->sql($valueBinder);
- $this->assertSame(
- 'CASE WHEN Table.column = (CUSTOM(:param0)) THEN CUSTOM(:param1) ELSE CUSTOM(:param2) END',
- $sql
- );
- }
- public function testGetReturnType(): void
- {
- // all provided `then` and `else` types are the same, return
- // type can be inferred
- $expression = (new CaseStatementExpression())
- ->when(['Table.column_a' => true])
- ->then(1, 'integer')
- ->when(['Table.column_b' => true])
- ->then(2, 'integer')
- ->else(3, 'integer');
- $this->assertSame('integer', $expression->getReturnType());
- // all provided `then` an `else` types are the same, one `then`
- // type is `null`, return type can be inferred
- $expression = (new CaseStatementExpression())
- ->when(['Table.column_a' => true])
- ->then(1)
- ->when(['Table.column_b' => true])
- ->then(2, 'integer')
- ->else(3, 'integer');
- $this->assertSame('integer', $expression->getReturnType());
- // all `then` types are null, an `else` type was provided,
- // return type can be inferred
- $expression = (new CaseStatementExpression())
- ->when(['Table.column_a' => true])
- ->then(1)
- ->when(['Table.column_b' => true])
- ->then(2)
- ->else(3, 'integer');
- $this->assertSame('integer', $expression->getReturnType());
- // all provided `then` types are the same, the `else` type is
- // `null`, return type can be inferred
- $expression = (new CaseStatementExpression())
- ->when(['Table.column_a' => true])
- ->then(1, 'integer')
- ->when(['Table.column_b' => true])
- ->then(2, 'integer')
- ->else(3);
- $this->assertSame('integer', $expression->getReturnType());
- // no `then` or `else` types were provided, they are all `null`,
- // and will be derived from the passed value, return type can be
- // inferred
- $expression = (new CaseStatementExpression())
- ->when(['Table.column_a' => true])
- ->then(1)
- ->when(['Table.column_b' => true])
- ->then(2)
- ->else(3);
- $this->assertSame('integer', $expression->getReturnType());
- // all `then` and `else` point to columns of the same type,
- // return type can be inferred
- $typeMap = new TypeMap([
- 'Table.column_a' => 'boolean',
- 'Table.column_b' => 'boolean',
- 'Table.column_c' => 'boolean',
- ]);
- $expression = (new CaseStatementExpression())
- ->setTypeMap($typeMap)
- ->when(['Table.column_a' => true])
- ->then(new IdentifierExpression('Table.column_a'))
- ->when(['Table.column_b' => true])
- ->then(new IdentifierExpression('Table.column_b'))
- ->else(new IdentifierExpression('Table.column_c'));
- $this->assertSame('boolean', $expression->getReturnType());
- // all `then` and `else` use the same custom type, return type
- // can be inferred
- $expression = (new CaseStatementExpression())
- ->when(['Table.column_a' => true])
- ->then(1, 'custom')
- ->when(['Table.column_b' => true])
- ->then(2, 'custom')
- ->else(3, 'custom');
- $this->assertSame('custom', $expression->getReturnType());
- // all `then` and `else` types were provided, but an explicit
- // return type was set, return type will be overwritten
- $expression = (new CaseStatementExpression())
- ->when(['Table.column_a' => true])
- ->then(1, 'integer')
- ->when(['Table.column_b' => true])
- ->then(2, 'integer')
- ->else(3, 'integer')
- ->setReturnType('string');
- $this->assertSame('string', $expression->getReturnType());
- // all `then` and `else` types are different, return type
- // cannot be inferred
- $expression = (new CaseStatementExpression())
- ->when(['Table.column_a' => true])
- ->then(true)
- ->when(['Table.column_b' => true])
- ->then(1)
- ->else(null);
- $this->assertSame('string', $expression->getReturnType());
- }
- public function testSetReturnType(): void
- {
- $expression = (new CaseStatementExpression())->else('1');
- $this->assertSame('string', $expression->getReturnType());
- $expression->setReturnType('float');
- $this->assertSame('float', $expression->getReturnType());
- }
- public static function valueTypeInferenceDataProvider(): array
- {
- return [
- // Values that should have their type inferred because
- // they will be bound by the case expression.
- ['1', 'string'],
- [1, 'integer'],
- [1.0, 'float'],
- [true, 'boolean'],
- [ChronosDate::now(), 'date'],
- [Chronos::now(), 'datetime'],
- // Values that should not have a type inferred, either
- // because they are not bound by the case expression,
- // and/or because their type is obtained differently
- // (for example from a type map).
- [new IdentifierExpression('Table.column'), null],
- [new FunctionExpression('SUM', ['Table.column' => 'literal'], [], 'integer'), null],
- [new stdClass(), null],
- [null, null],
- ];
- }
- /**
- * @param mixed $value The value from which to infer the type.
- * @param string|null $type The expected type.
- */
- #[DataProvider('valueTypeInferenceDataProvider')]
- public function testInferValueType($value, ?string $type): void
- {
- $expression = new CaseStatementExpressionStub();
- $this->assertNull($expression->getValueType());
- $expression = (new CaseStatementExpressionStub($value))
- ->setTypeMap(new TypeMap(['Table.column' => 'boolean']))
- ->when(1)
- ->then(2);
- $this->assertSame($type, $expression->getValueType());
- }
- public static function whenTypeInferenceDataProvider(): array
- {
- return [
- // Values that should have their type inferred because
- // they will be bound by the case expression.
- ['1', 'string'],
- [1, 'integer'],
- [1.0, 'float'],
- [true, 'boolean'],
- [ChronosDate::now(), 'date'],
- [Chronos::now(), 'datetime'],
- // Values that should not have a type inferred, either
- // because they are not bound by the case expression,
- // and/or because their type is obtained differently
- // (for example from a type map).
- [new IdentifierExpression('Table.column'), null],
- [new FunctionExpression('SUM', ['Table.column' => 'literal'], [], 'integer'), null],
- [['Table.column' => true], null],
- [new stdClass(), null],
- ];
- }
- /**
- * @param mixed $value The value from which to infer the type.
- * @param string|null $type The expected type.
- */
- #[DataProvider('whenTypeInferenceDataProvider')]
- public function testInferWhenType($value, ?string $type): void
- {
- $expression = (new CaseStatementExpressionStub())
- ->setTypeMap(new TypeMap(['Table.column' => 'boolean']));
- $expression->when(new WhenThenExpressionStub($expression->getTypeMap()));
- $this->assertNull($expression->clause('when')[0]->getWhenType());
- $expression->clause('when')[0]
- ->when($value)
- ->then(1);
- $this->assertSame($type, $expression->clause('when')[0]->getWhenType());
- }
- public static function resultTypeInferenceDataProvider(): array
- {
- return [
- // Unless a result type has been set manually, values
- // should have their type inferred when possible.
- ['1', 'string'],
- [1, 'integer'],
- [1.0, 'float'],
- [true, 'boolean'],
- [ChronosDate::now(), 'date'],
- [Chronos::now(), 'datetime'],
- [new IdentifierExpression('Table.column'), 'boolean'],
- [new FunctionExpression('SUM', ['Table.column' => 'literal'], [], 'integer'), 'integer'],
- [new stdClass(), null],
- [null, null],
- ];
- }
- /**
- * @param mixed $value The value from which to infer the type.
- * @param string|null $type The expected type.
- */
- #[DataProvider('resultTypeInferenceDataProvider')]
- public function testInferResultType($value, ?string $type): void
- {
- $expression = (new CaseStatementExpressionStub())
- ->setTypeMap(new TypeMap(['Table.column' => 'boolean']))
- ->when(function (WhenThenExpression $whenThen) {
- return $whenThen;
- });
- $this->assertNull($expression->clause('when')[0]->getResultType());
- $expression->clause('when')[0]
- ->when(['Table.column' => true])
- ->then($value);
- $this->assertSame($type, $expression->clause('when')[0]->getResultType());
- }
- /**
- * @param mixed $value The value from which to infer the type.
- * @param string|null $type The expected type.
- */
- #[DataProvider('resultTypeInferenceDataProvider')]
- public function testInferElseType($value, ?string $type): void
- {
- $expression = new CaseStatementExpressionStub();
- $this->assertNull($expression->getElseType());
- $expression = (new CaseStatementExpressionStub())
- ->setTypeMap(new TypeMap(['Table.column' => 'boolean']));
- $this->assertNull($expression->getElseType());
- $expression->else($value);
- $this->assertSame($type, $expression->getElseType());
- }
- public function testWhenArrayValueInheritTypeMap(): void
- {
- $typeMap = new TypeMap([
- 'Table.column_a' => 'boolean',
- 'Table.column_b' => 'string',
- ]);
- $expression = (new CaseStatementExpression())
- ->setTypeMap($typeMap)
- ->when(['Table.column_a' => true])
- ->then(1)
- ->when(['Table.column_b' => 'foo'])
- ->then(2)
- ->else(3);
- $valueBinder = new ValueBinder();
- $sql = $expression->sql($valueBinder);
- $this->assertSame(
- 'CASE WHEN Table.column_a = :c0 THEN :c1 WHEN Table.column_b = :c2 THEN :c3 ELSE :c4 END',
- $sql
- );
- $this->assertSame(
- [
- ':c0' => [
- 'value' => true,
- 'type' => 'boolean',
- 'placeholder' => 'c0',
- ],
- ':c1' => [
- 'value' => 1,
- 'type' => 'integer',
- 'placeholder' => 'c1',
- ],
- ':c2' => [
- 'value' => 'foo',
- 'type' => 'string',
- 'placeholder' => 'c2',
- ],
- ':c3' => [
- 'value' => 2,
- 'type' => 'integer',
- 'placeholder' => 'c3',
- ],
- ':c4' => [
- 'value' => 3,
- 'type' => 'integer',
- 'placeholder' => 'c4',
- ],
- ],
- $valueBinder->bindings()
- );
- }
- public function testWhenArrayValueWithExplicitTypes(): void
- {
- $typeMap = new TypeMap([
- 'Table.column_a' => 'boolean',
- 'Table.column_b' => 'string',
- ]);
- $expression = (new CaseStatementExpression())
- ->setTypeMap($typeMap)
- ->when(['Table.column_a' => 123], ['Table.column_a' => 'integer'])
- ->then(1)
- ->when(['Table.column_b' => 'foo'])
- ->then(2)
- ->else(3);
- $valueBinder = new ValueBinder();
- $sql = $expression->sql($valueBinder);
- $this->assertSame(
- 'CASE WHEN Table.column_a = :c0 THEN :c1 WHEN Table.column_b = :c2 THEN :c3 ELSE :c4 END',
- $sql
- );
- $this->assertSame(
- [
- ':c0' => [
- 'value' => 123,
- 'type' => 'integer',
- 'placeholder' => 'c0',
- ],
- ':c1' => [
- 'value' => 1,
- 'type' => 'integer',
- 'placeholder' => 'c1',
- ],
- ':c2' => [
- 'value' => 'foo',
- 'type' => 'string',
- 'placeholder' => 'c2',
- ],
- ':c3' => [
- 'value' => 2,
- 'type' => 'integer',
- 'placeholder' => 'c3',
- ],
- ':c4' => [
- 'value' => 3,
- 'type' => 'integer',
- 'placeholder' => 'c4',
- ],
- ],
- $valueBinder->bindings()
- );
- }
- public function testWhenCallableArrayValueInheritTypeMap(): void
- {
- $typeMap = new TypeMap([
- 'Table.column_a' => 'boolean',
- 'Table.column_b' => 'string',
- ]);
- $expression = (new CaseStatementExpression())
- ->setTypeMap($typeMap)
- ->when(function (WhenThenExpression $whenThen) {
- return $whenThen
- ->when(['Table.column_a' => true])
- ->then(1);
- })
- ->when(function (WhenThenExpression $whenThen) {
- return $whenThen
- ->when(['Table.column_b' => 'foo'])
- ->then(2);
- })
- ->else(3);
- $valueBinder = new ValueBinder();
- $sql = $expression->sql($valueBinder);
- $this->assertSame(
- 'CASE WHEN Table.column_a = :c0 THEN :c1 WHEN Table.column_b = :c2 THEN :c3 ELSE :c4 END',
- $sql
- );
- $this->assertSame(
- [
- ':c0' => [
- 'value' => true,
- 'type' => 'boolean',
- 'placeholder' => 'c0',
- ],
- ':c1' => [
- 'value' => 1,
- 'type' => 'integer',
- 'placeholder' => 'c1',
- ],
- ':c2' => [
- 'value' => 'foo',
- 'type' => 'string',
- 'placeholder' => 'c2',
- ],
- ':c3' => [
- 'value' => 2,
- 'type' => 'integer',
- 'placeholder' => 'c3',
- ],
- ':c4' => [
- 'value' => 3,
- 'type' => 'integer',
- 'placeholder' => 'c4',
- ],
- ],
- $valueBinder->bindings()
- );
- }
- public function testWhenCallableArrayValueWithExplicitTypes(): void
- {
- $typeMap = new TypeMap([
- 'Table.column_a' => 'boolean',
- 'Table.column_b' => 'string',
- ]);
- $expression = (new CaseStatementExpression())
- ->setTypeMap($typeMap)
- ->when(function (WhenThenExpression $whenThen) {
- return $whenThen
- ->when(['Table.column_a' => 123], ['Table.column_a' => 'integer'])
- ->then(1);
- })
- ->when(function (WhenThenExpression $whenThen) {
- return $whenThen
- ->when(['Table.column_b' => 'foo'])
- ->then(2);
- })
- ->else(3);
- $valueBinder = new ValueBinder();
- $sql = $expression->sql($valueBinder);
- $this->assertSame(
- 'CASE WHEN Table.column_a = :c0 THEN :c1 WHEN Table.column_b = :c2 THEN :c3 ELSE :c4 END',
- $sql
- );
- $this->assertSame(
- [
- ':c0' => [
- 'value' => 123,
- 'type' => 'integer',
- 'placeholder' => 'c0',
- ],
- ':c1' => [
- 'value' => 1,
- 'type' => 'integer',
- 'placeholder' => 'c1',
- ],
- ':c2' => [
- 'value' => 'foo',
- 'type' => 'string',
- 'placeholder' => 'c2',
- ],
- ':c3' => [
- 'value' => 2,
- 'type' => 'integer',
- 'placeholder' => 'c3',
- ],
- ':c4' => [
- 'value' => 3,
- 'type' => 'integer',
- 'placeholder' => 'c4',
- ],
- ],
- $valueBinder->bindings()
- );
- }
- public function testWhenArrayValueRequiresArrayTypeValue(): void
- {
- $this->expectException(InvalidArgumentException::class);
- $this->expectExceptionMessage(
- 'When using an array for the `$when` argument, the `$type` ' .
- 'argument must be an array too, `string` given.'
- );
- (new CaseStatementExpression())
- ->when(['Table.column' => 123], 'integer')
- ->then(1);
- }
- public function testWhenNonArrayValueRequiresStringTypeValue(): void
- {
- $this->expectException(InvalidArgumentException::class);
- $this->expectExceptionMessage(
- 'When using a non-array value for the `$when` argument, ' .
- 'the `$type` argument must be a string, `array` given.'
- );
- (new CaseStatementExpression())
- ->when(123, ['Table.column' => 'integer'])
- ->then(1);
- }
- public function testInternalTypeMapChangesAreNonPersistent(): void
- {
- $typeMap = new TypeMap([
- 'Table.column' => 'integer',
- ]);
- $expression = (new CaseStatementExpression())
- ->setTypeMap($typeMap)
- ->when(['Table.column' => 123])
- ->then(1)
- ->when(['Table.column' => 'foo'], ['Table.column' => 'string'])
- ->then('bar')
- ->when(['Table.column' => 456])
- ->then(2);
- $valueBinder = new ValueBinder();
- $expression->sql($valueBinder);
- $this->assertSame(
- [
- ':c0' => [
- 'value' => 123,
- 'type' => 'integer',
- 'placeholder' => 'c0',
- ],
- ':c1' => [
- 'value' => 1,
- 'type' => 'integer',
- 'placeholder' => 'c1',
- ],
- ':c2' => [
- 'value' => 'foo',
- 'type' => 'string',
- 'placeholder' => 'c2',
- ],
- ':c3' => [
- 'value' => 'bar',
- 'type' => 'string',
- 'placeholder' => 'c3',
- ],
- ':c4' => [
- 'value' => 456,
- 'type' => 'integer',
- 'placeholder' => 'c4',
- ],
- ':c5' => [
- 'value' => 2,
- 'type' => 'integer',
- 'placeholder' => 'c5',
- ],
- ],
- $valueBinder->bindings()
- );
- $this->assertSame($typeMap, $expression->getTypeMap());
- }
- // endregion
- // region SQL injections
- public function testSqlInjectionViaTypedCaseValueIsNotPossible(): void
- {
- $expression = (new CaseStatementExpression('1 THEN 1 END; DELETE * FROM foo; --', 'integer'))
- ->when(1)
- ->then(2);
- $valueBinder = new ValueBinder();
- $sql = $expression->sql($valueBinder);
- $this->assertSame(
- 'CASE :c0 WHEN :c1 THEN :c2 ELSE NULL END',
- $sql
- );
- $this->assertSame(
- [
- ':c0' => [
- 'value' => '1 THEN 1 END; DELETE * FROM foo; --',
- 'type' => 'integer',
- 'placeholder' => 'c0',
- ],
- ':c1' => [
- 'value' => 1,
- 'type' => 'integer',
- 'placeholder' => 'c1',
- ],
- ':c2' => [
- 'value' => 2,
- 'type' => 'integer',
- 'placeholder' => 'c2',
- ],
- ],
- $valueBinder->bindings()
- );
- }
- public function testSqlInjectionViaUntypedCaseValueIsNotPossible(): void
- {
- $expression = (new CaseStatementExpression('1 THEN 1 END; DELETE * FROM foo; --'))
- ->when(1)
- ->then(2);
- $valueBinder = new ValueBinder();
- $sql = $expression->sql($valueBinder);
- $this->assertSame(
- 'CASE :c0 WHEN :c1 THEN :c2 ELSE NULL END',
- $sql
- );
- $this->assertSame(
- [
- ':c0' => [
- 'value' => '1 THEN 1 END; DELETE * FROM foo; --',
- 'type' => 'string',
- 'placeholder' => 'c0',
- ],
- ':c1' => [
- 'value' => 1,
- 'type' => 'integer',
- 'placeholder' => 'c1',
- ],
- ':c2' => [
- 'value' => 2,
- 'type' => 'integer',
- 'placeholder' => 'c2',
- ],
- ],
- $valueBinder->bindings()
- );
- }
- public function testSqlInjectionViaTypedWhenValueIsNotPossible(): void
- {
- $expression = (new CaseStatementExpression())
- ->when('1 THEN 1 END; DELETE * FROM foo; --', 'integer')
- ->then(1);
- $valueBinder = new ValueBinder();
- $sql = $expression->sql($valueBinder);
- $this->assertSame(
- 'CASE WHEN :c0 THEN :c1 ELSE NULL END',
- $sql
- );
- $this->assertSame(
- [
- ':c0' => [
- 'value' => '1 THEN 1 END; DELETE * FROM foo; --',
- 'type' => 'integer',
- 'placeholder' => 'c0',
- ],
- ':c1' => [
- 'value' => 1,
- 'type' => 'integer',
- 'placeholder' => 'c1',
- ],
- ],
- $valueBinder->bindings()
- );
- }
- public function testSqlInjectionViaTypedWhenArrayValueIsNotPossible(): void
- {
- $this->expectException(InvalidArgumentException::class);
- $this->expectExceptionMessage(
- 'When using an array for the `$when` argument, the `$type` ' .
- 'argument must be an array too, `string` given.'
- );
- (new CaseStatementExpression())
- ->when(['1 THEN 1 END; DELETE * FROM foo; --' => '123'], 'integer')
- ->then(1);
- }
- public function testSqlInjectionViaUntypedWhenValueIsNotPossible(): void
- {
- $expression = (new CaseStatementExpression())
- ->when('1 THEN 1 END; DELETE * FROM foo; --')
- ->then(1);
- $valueBinder = new ValueBinder();
- $sql = $expression->sql($valueBinder);
- $this->assertSame(
- 'CASE WHEN :c0 THEN :c1 ELSE NULL END',
- $sql
- );
- $this->assertSame(
- [
- ':c0' => [
- 'value' => '1 THEN 1 END; DELETE * FROM foo; --',
- 'type' => 'string',
- 'placeholder' => 'c0',
- ],
- ':c1' => [
- 'value' => 1,
- 'type' => 'integer',
- 'placeholder' => 'c1',
- ],
- ],
- $valueBinder->bindings()
- );
- }
- public function testSqlInjectionViaTypedThenValueIsNotPossible(): void
- {
- $expression = (new CaseStatementExpression(1))
- ->when(2)
- ->then('1 THEN 1 END; DELETE * FROM foo; --', 'integer');
- $valueBinder = new ValueBinder();
- $sql = $expression->sql($valueBinder);
- $this->assertSame(
- 'CASE :c0 WHEN :c1 THEN :c2 ELSE NULL END',
- $sql
- );
- $this->assertSame(
- [
- ':c0' => [
- 'value' => 1,
- 'type' => 'integer',
- 'placeholder' => 'c0',
- ],
- ':c1' => [
- 'value' => 2,
- 'type' => 'integer',
- 'placeholder' => 'c1',
- ],
- ':c2' => [
- 'value' => '1 THEN 1 END; DELETE * FROM foo; --',
- 'type' => 'integer',
- 'placeholder' => 'c2',
- ],
- ],
- $valueBinder->bindings()
- );
- }
- public function testSqlInjectionViaUntypedThenValueIsNotPossible(): void
- {
- $expression = (new CaseStatementExpression(1))
- ->when(2)
- ->then('1 THEN 1 END; DELETE * FROM foo; --');
- $valueBinder = new ValueBinder();
- $sql = $expression->sql($valueBinder);
- $this->assertSame(
- 'CASE :c0 WHEN :c1 THEN :c2 ELSE NULL END',
- $sql
- );
- $this->assertSame(
- [
- ':c0' => [
- 'value' => 1,
- 'type' => 'integer',
- 'placeholder' => 'c0',
- ],
- ':c1' => [
- 'value' => 2,
- 'type' => 'integer',
- 'placeholder' => 'c1',
- ],
- ':c2' => [
- 'value' => '1 THEN 1 END; DELETE * FROM foo; --',
- 'type' => 'string',
- 'placeholder' => 'c2',
- ],
- ],
- $valueBinder->bindings()
- );
- }
- public function testSqlInjectionViaTypedElseValueIsNotPossible(): void
- {
- $expression = (new CaseStatementExpression(1))
- ->when(2)
- ->then(3)
- ->else('1 THEN 1 END; DELETE * FROM foo; --', 'integer');
- $valueBinder = new ValueBinder();
- $sql = $expression->sql($valueBinder);
- $this->assertSame(
- 'CASE :c0 WHEN :c1 THEN :c2 ELSE :c3 END',
- $sql
- );
- $this->assertSame(
- [
- ':c0' => [
- 'value' => 1,
- 'type' => 'integer',
- 'placeholder' => 'c0',
- ],
- ':c1' => [
- 'value' => 2,
- 'type' => 'integer',
- 'placeholder' => 'c1',
- ],
- ':c2' => [
- 'value' => 3,
- 'type' => 'integer',
- 'placeholder' => 'c2',
- ],
- ':c3' => [
- 'value' => '1 THEN 1 END; DELETE * FROM foo; --',
- 'type' => 'integer',
- 'placeholder' => 'c3',
- ],
- ],
- $valueBinder->bindings()
- );
- }
- public function testSqlInjectionViaUntypedElseValueIsNotPossible(): void
- {
- $expression = (new CaseStatementExpression(1))
- ->when(2)
- ->then(3)
- ->else('1 THEN 1 END; DELETE * FROM foo; --');
- $valueBinder = new ValueBinder();
- $sql = $expression->sql($valueBinder);
- $this->assertSame(
- 'CASE :c0 WHEN :c1 THEN :c2 ELSE :c3 END',
- $sql
- );
- $this->assertSame(
- [
- ':c0' => [
- 'value' => 1,
- 'type' => 'integer',
- 'placeholder' => 'c0',
- ],
- ':c1' => [
- 'value' => 2,
- 'type' => 'integer',
- 'placeholder' => 'c1',
- ],
- ':c2' => [
- 'value' => 3,
- 'type' => 'integer',
- 'placeholder' => 'c2',
- ],
- ':c3' => [
- 'value' => '1 THEN 1 END; DELETE * FROM foo; --',
- 'type' => 'string',
- 'placeholder' => 'c3',
- ],
- ],
- $valueBinder->bindings()
- );
- }
- // endregion
- // region Getters
- public function testGetInvalidCaseExpressionClause(): void
- {
- $this->expectException(InvalidArgumentException::class);
- $this->expectExceptionMessage(
- 'The `$clause` argument must be one of `value`, `when`, `else`, the given value `invalid` is invalid.'
- );
- (new CaseStatementExpression())->clause('invalid');
- }
- public function testGetInvalidWhenThenExpressionClause(): void
- {
- $this->expectException(InvalidArgumentException::class);
- $this->expectExceptionMessage(
- 'The `$clause` argument must be one of `when`, `then`, the given value `invalid` is invalid.'
- );
- (new WhenThenExpression())->clause('invalid');
- }
- public function testGetValueClause(): void
- {
- $expression = new CaseStatementExpression();
- $this->assertNull($expression->clause('value'));
- $expression = (new CaseStatementExpression(1))
- ->when(1)
- ->then(2);
- $this->assertSame(1, $expression->clause('value'));
- }
- public function testGetWhenClause(): void
- {
- $when = ['Table.column' => true];
- $expression = new CaseStatementExpression();
- $this->assertSame([], $expression->clause('when'));
- $expression
- ->when($when)
- ->then(1);
- $this->assertCount(1, $expression->clause('when'));
- $this->assertInstanceOf(WhenThenExpression::class, $expression->clause('when')[0]);
- }
- public function testWhenArrayValueGetWhenClause(): void
- {
- $when = ['Table.column' => true];
- $expression = new CaseStatementExpression();
- $this->assertSame([], $expression->clause('when'));
- $expression
- ->when($when)
- ->then(1);
- $this->assertEquals(
- new QueryExpression($when),
- $expression->clause('when')[0]->clause('when')
- );
- }
- public function testWhenNonArrayValueGetWhenClause(): void
- {
- $expression = new CaseStatementExpression();
- $this->assertSame([], $expression->clause('when'));
- $expression
- ->when(1)
- ->then(2);
- $this->assertSame(1, $expression->clause('when')[0]->clause('when'));
- }
- public function testWhenGetThenClause(): void
- {
- $expression = (new CaseStatementExpression())
- ->when(function (WhenThenExpression $whenThen) {
- return $whenThen;
- });
- $this->assertNull($expression->clause('when')[0]->clause('then'));
- $expression->clause('when')[0]->then(1);
- $this->assertSame(1, $expression->clause('when')[0]->clause('then'));
- }
- public function testGetElseClause(): void
- {
- $expression = new CaseStatementExpression();
- $this->assertNull($expression->clause('else'));
- $expression
- ->when(['Table.column' => true])
- ->then(1)
- ->else(2);
- $this->assertSame(2, $expression->clause('else'));
- }
- // endregion
- // region Order based syntax
- public function testWhenThenElse(): void
- {
- $expression = (new CaseStatementExpression())
- ->when(['Table.column_a' => true, 'Table.column_b IS' => null])
- ->then(1)
- ->when(['Table.column_c' => true, 'Table.column_d IS NOT' => null])
- ->then(2)
- ->else(3);
- $valueBinder = new ValueBinder();
- $sql = $expression->sql($valueBinder);
- $this->assertSame(
- 'CASE ' .
- 'WHEN (Table.column_a = :c0 AND (Table.column_b) IS NULL) THEN :c1 ' .
- 'WHEN (Table.column_c = :c2 AND (Table.column_d) IS NOT NULL) THEN :c3 ' .
- 'ELSE :c4 ' .
- 'END',
- $sql
- );
- }
- public function testWhenBeforeClosingThenFails(): void
- {
- $this->expectException(LogicException::class);
- $this->expectExceptionMessage('Cannot call `when()` between `when()` and `then()`.');
- (new CaseStatementExpression())
- ->when(['Table.column_a' => true])
- ->when(['Table.column_b' => true]);
- }
- public function testElseBeforeClosingThenFails(): void
- {
- $this->expectException(LogicException::class);
- $this->expectExceptionMessage('Cannot call `else()` between `when()` and `then()`.');
- (new CaseStatementExpression())
- ->when(['Table.column' => true])
- ->else(1);
- }
- public function testThenBeforeOpeningWhenFails(): void
- {
- $this->expectException(LogicException::class);
- $this->expectExceptionMessage('Cannot call `then()` before `when()`.');
- (new CaseStatementExpression())
- ->then(1);
- }
- // endregion
- // region Callable syntax
- public function testWhenCallables(): void
- {
- $expression = (new CaseStatementExpression())
- ->when(function (WhenThenExpression $whenThen) {
- return $whenThen
- ->when([
- 'Table.column_a' => true,
- 'Table.column_b IS' => null,
- ])
- ->then(1);
- })
- ->when(function (WhenThenExpression $whenThen) {
- return $whenThen
- ->when([
- 'Table.column_c' => true,
- 'Table.column_d IS NOT' => null,
- ])
- ->then(2);
- })
- ->else(3);
- $valueBinder = new ValueBinder();
- $sql = $expression->sql($valueBinder);
- $this->assertSame(
- 'CASE ' .
- 'WHEN (Table.column_a = :c0 AND (Table.column_b) IS NULL) THEN :c1 ' .
- 'WHEN (Table.column_c = :c2 AND (Table.column_d) IS NOT NULL) THEN :c3 ' .
- 'ELSE :c4 ' .
- 'END',
- $sql
- );
- }
- public function testWhenCallablesWithCustomWhenThenExpressions(): void
- {
- $expression = (new CaseStatementExpression())
- ->when(function () {
- return (new CustomWhenThenExpression())
- ->when([
- 'Table.column_a' => true,
- 'Table.column_b IS' => null,
- ])
- ->then(1);
- })
- ->when(function () {
- return (new CustomWhenThenExpression())
- ->when([
- 'Table.column_c' => true,
- 'Table.column_d IS NOT' => null,
- ])
- ->then(2);
- })
- ->else(3);
- $valueBinder = new ValueBinder();
- $sql = $expression->sql($valueBinder);
- $this->assertSame(
- 'CASE ' .
- 'WHEN (Table.column_a = :c0 AND (Table.column_b) IS NULL) THEN :c1 ' .
- 'WHEN (Table.column_c = :c2 AND (Table.column_d) IS NOT NULL) THEN :c3 ' .
- 'ELSE :c4 ' .
- 'END',
- $sql
- );
- }
- public function testWhenCallablesWithInvalidReturnTypeFails(): void
- {
- $this->expectException(LogicException::class);
- $this->expectExceptionMessage(
- '`when()` callables must return an instance of ' .
- '`\Cake\Database\Expression\WhenThenExpression`, `null` given.'
- );
- $this->deprecated(function (): void {
- (new CaseStatementExpression())
- ->when(function () {
- return null;
- });
- });
- }
- // endregion
- // region Self-contained values
- public function testSelfContainedWhenThenExpressions(): void
- {
- $expression = (new CaseStatementExpression())
- ->when(
- (new WhenThenExpression())
- ->when([
- 'Table.column_a' => true,
- 'Table.column_b IS' => null,
- ])
- ->then(1)
- )
- ->when(
- (new WhenThenExpression())
- ->when([
- 'Table.column_c' => true,
- 'Table.column_d IS NOT' => null,
- ])
- ->then(2)
- )
- ->else(3);
- $valueBinder = new ValueBinder();
- $sql = $expression->sql($valueBinder);
- $this->assertSame(
- 'CASE ' .
- 'WHEN (Table.column_a = :c0 AND (Table.column_b) IS NULL) THEN :c1 ' .
- 'WHEN (Table.column_c = :c2 AND (Table.column_d) IS NOT NULL) THEN :c3 ' .
- 'ELSE :c4 ' .
- 'END',
- $sql
- );
- }
- public function testSelfContainedCustomWhenThenExpressions(): void
- {
- $expression = (new CaseStatementExpression())
- ->when(
- (new CustomWhenThenExpression())
- ->when([
- 'Table.column_a' => true,
- 'Table.column_b IS' => null,
- ])
- ->then(1)
- )
- ->when(
- (new CustomWhenThenExpression())
- ->when([
- 'Table.column_c' => true,
- 'Table.column_d IS NOT' => null,
- ])
- ->then(2)
- )
- ->else(3);
- $valueBinder = new ValueBinder();
- $sql = $expression->sql($valueBinder);
- $this->assertSame(
- 'CASE ' .
- 'WHEN (Table.column_a = :c0 AND (Table.column_b) IS NULL) THEN :c1 ' .
- 'WHEN (Table.column_c = :c2 AND (Table.column_d) IS NOT NULL) THEN :c3 ' .
- 'ELSE :c4 ' .
- 'END',
- $sql
- );
- }
- // endregion
- // region Incomplete states
- public function testCompilingEmptyCaseExpressionFails(): void
- {
- $this->expectException(LogicException::class);
- $this->expectExceptionMessage('Case expression must have at least one when statement.');
- $this->deprecated(function (): void {
- (new CaseStatementExpression())->sql(new ValueBinder());
- });
- }
- public function testCompilingNonClosedWhenFails(): void
- {
- $this->expectException(LogicException::class);
- $this->expectExceptionMessage('Case expression has incomplete when clause. Missing `then()` after `when()`.');
- $this->deprecated(function (): void {
- (new CaseStatementExpression())
- ->when(['Table.column' => true])
- ->sql(new ValueBinder());
- });
- }
- public function testCompilingWhenThenExpressionWithMissingWhenFails(): void
- {
- $this->expectException(LogicException::class);
- $this->expectExceptionMessage('Case expression has incomplete when clause. Missing `when()`.');
- $this->deprecated(function (): void {
- (new CaseStatementExpression())
- ->when(function (WhenThenExpression $whenThen) {
- return $whenThen->then(1);
- })
- ->sql(new ValueBinder());
- });
- }
- public function testCompilingWhenThenExpressionWithMissingThenFails(): void
- {
- $this->expectException(LogicException::class);
- $this->expectExceptionMessage('Case expression has incomplete when clause. Missing `then()` after `when()`.');
- $this->deprecated(function (): void {
- (new CaseStatementExpression())
- ->when(function (WhenThenExpression $whenThen) {
- return $whenThen->when(1);
- })
- ->sql(new ValueBinder());
- });
- }
- // endregion
- // region Valid values
- public static function validCaseValuesDataProvider(): array
- {
- return [
- [null, 'NULL', null],
- ['0', null, 'string'],
- [0, null, 'integer'],
- [0.0, null, 'float'],
- ['foo', null, 'string'],
- [true, null, 'boolean'],
- [Date::now(), null, 'date'],
- [ChronosDate::now(), null, 'date'],
- [DateTime::now(), null, 'datetime'],
- [Chronos::now(), null, 'datetime'],
- [new IdentifierExpression('Table.column'), 'Table.column', null],
- [new QueryExpression('Table.column'), 'Table.column', null],
- [ConnectionManager::get('test')->selectQuery('a'), '(SELECT a)', null],
- [new TestObjectWithToString(), null, 'string'],
- [new stdClass(), null, null],
- ];
- }
- /**
- * @param mixed $value The case value.
- * @param string|null $sqlValue The expected SQL string value.
- * @param string|null $type The expected bound type.
- */
- #[DataProvider('validCaseValuesDataProvider')]
- public function testValidCaseValue($value, ?string $sqlValue, ?string $type): void
- {
- $expression = (new CaseStatementExpression($value))
- ->when(1)
- ->then(2);
- $valueBinder = new ValueBinder();
- $sql = $expression->sql($valueBinder);
- if ($sqlValue) {
- $this->assertEqualsSql(
- "CASE {$sqlValue} WHEN :c0 THEN :c1 ELSE NULL END",
- $sql
- );
- $this->assertSame(
- [
- ':c0' => [
- 'value' => 1,
- 'type' => 'integer',
- 'placeholder' => 'c0',
- ],
- ':c1' => [
- 'value' => 2,
- 'type' => 'integer',
- 'placeholder' => 'c1',
- ],
- ],
- $valueBinder->bindings()
- );
- } else {
- $this->assertEqualsSql(
- 'CASE :c0 WHEN :c1 THEN :c2 ELSE NULL END',
- $sql
- );
- $this->assertSame(
- [
- ':c0' => [
- 'value' => $value,
- 'type' => $type,
- 'placeholder' => 'c0',
- ],
- ':c1' => [
- 'value' => 1,
- 'type' => 'integer',
- 'placeholder' => 'c1',
- ],
- ':c2' => [
- 'value' => 2,
- 'type' => 'integer',
- 'placeholder' => 'c2',
- ],
- ],
- $valueBinder->bindings()
- );
- }
- }
- public static function validWhenValuesSimpleCaseDataProvider(): array
- {
- return [
- ['0', null, 'string'],
- [0, null, 'integer'],
- [0.0, null, 'float'],
- ['foo', null, 'string'],
- [true, null, 'boolean'],
- [new stdClass(), null, null],
- [new TestObjectWithToString(), null, 'string'],
- [Date::now(), null, 'date'],
- [ChronosDate::now(), null, 'date'],
- [DateTime::now(), null, 'datetime'],
- [Chronos::now(), null, 'datetime'],
- [
- new IdentifierExpression('Table.column'),
- 'CASE :c0 WHEN Table.column THEN :c1 ELSE NULL END',
- [
- ':c0' => [
- 'value' => true,
- 'type' => 'boolean',
- 'placeholder' => 'c0',
- ],
- ':c1' => [
- 'value' => 2,
- 'type' => 'integer',
- 'placeholder' => 'c1',
- ],
- ],
- ],
- [
- new QueryExpression('Table.column'),
- 'CASE :c0 WHEN Table.column THEN :c1 ELSE NULL END',
- [
- ':c0' => [
- 'value' => true,
- 'type' => 'boolean',
- 'placeholder' => 'c0',
- ],
- ':c1' => [
- 'value' => 2,
- 'type' => 'integer',
- 'placeholder' => 'c1',
- ],
- ],
- ],
- [
- ConnectionManager::get('test')->selectQuery('a'),
- 'CASE :c0 WHEN (SELECT a) THEN :c1 ELSE NULL END',
- [
- ':c0' => [
- 'value' => true,
- 'type' => 'boolean',
- 'placeholder' => 'c0',
- ],
- ':c1' => [
- 'value' => 2,
- 'type' => 'integer',
- 'placeholder' => 'c1',
- ],
- ],
- ],
- [
- [
- 'Table.column_a' => 1,
- 'Table.column_b' => 'foo',
- ],
- 'CASE :c0 WHEN (Table.column_a = :c1 AND Table.column_b = :c2) THEN :c3 ELSE NULL END',
- [
- ':c0' => [
- 'value' => true,
- 'type' => 'boolean',
- 'placeholder' => 'c0',
- ],
- ':c1' => [
- 'value' => 1,
- 'type' => 'integer',
- 'placeholder' => 'c1',
- ],
- ':c2' => [
- 'value' => 'foo',
- 'type' => 'string',
- 'placeholder' => 'c2',
- ],
- ':c3' => [
- 'value' => 2,
- 'type' => 'integer',
- 'placeholder' => 'c3',
- ],
- ],
- ],
- ];
- }
- /**
- * @param mixed $value The when value.
- * @param string|null $expectedSql The expected SQL string.
- * @param array|string|null $typeOrBindings The expected bound type(s).
- */
- #[DataProvider('validWhenValuesSimpleCaseDataProvider')]
- public function testValidWhenValueSimpleCase($value, ?string $expectedSql, $typeOrBindings = null): void
- {
- $typeMap = new TypeMap([
- 'Table.column_a' => 'integer',
- 'Table.column_b' => 'string',
- ]);
- $expression = (new CaseStatementExpression(true))
- ->setTypeMap($typeMap)
- ->when($value)
- ->then(2);
- $valueBinder = new ValueBinder();
- $sql = $expression->sql($valueBinder);
- if ($expectedSql) {
- $this->assertEqualsSql($expectedSql, $sql);
- $this->assertSame($typeOrBindings, $valueBinder->bindings());
- } else {
- $this->assertEqualsSql('CASE :c0 WHEN :c1 THEN :c2 ELSE NULL END', $sql);
- $this->assertSame(
- [
- ':c0' => [
- 'value' => true,
- 'type' => 'boolean',
- 'placeholder' => 'c0',
- ],
- ':c1' => [
- 'value' => $value,
- 'type' => $typeOrBindings,
- 'placeholder' => 'c1',
- ],
- ':c2' => [
- 'value' => 2,
- 'type' => 'integer',
- 'placeholder' => 'c2',
- ],
- ],
- $valueBinder->bindings()
- );
- }
- }
- public static function validWhenValuesSearchedCaseDataProvider(): array
- {
- return [
- ['0', null, 'string'],
- [0, null, 'integer'],
- [0.0, null, 'float'],
- ['foo', null, 'string'],
- [true, null, 'boolean'],
- [new stdClass(), null, null],
- [new TestObjectWithToString(), null, 'string'],
- [Date::now(), null, 'date'],
- [ChronosDate::now(), null, 'date'],
- [DateTime::now(), null, 'datetime'],
- [Chronos::now(), null, 'datetime'],
- [
- new IdentifierExpression('Table.column'),
- 'CASE WHEN Table.column THEN :c0 ELSE NULL END',
- [
- ':c0' => [
- 'value' => 2,
- 'type' => 'integer',
- 'placeholder' => 'c0',
- ],
- ],
- ],
- [
- new QueryExpression('Table.column'),
- 'CASE WHEN Table.column THEN :c0 ELSE NULL END',
- [
- ':c0' => [
- 'value' => 2,
- 'type' => 'integer',
- 'placeholder' => 'c0',
- ],
- ],
- ],
- [
- ConnectionManager::get('test')->selectQuery('a'),
- 'CASE WHEN (SELECT a) THEN :c0 ELSE NULL END',
- [
- ':c0' => [
- 'value' => 2,
- 'type' => 'integer',
- 'placeholder' => 'c0',
- ],
- ],
- ],
- [
- [
- 'Table.column_a' => 1,
- 'Table.column_b' => 'foo',
- ],
- 'CASE WHEN (Table.column_a = :c0 AND Table.column_b = :c1) THEN :c2 ELSE NULL END',
- [
- ':c0' => [
- 'value' => 1,
- 'type' => 'integer',
- 'placeholder' => 'c0',
- ],
- ':c1' => [
- 'value' => 'foo',
- 'type' => 'string',
- 'placeholder' => 'c1',
- ],
- ':c2' => [
- 'value' => 2,
- 'type' => 'integer',
- 'placeholder' => 'c2',
- ],
- ],
- ],
- ];
- }
- /**
- * @param mixed $value The when value.
- * @param string|null $expectedSql The expected SQL string.
- * @param array|string|null $typeOrBindings The expected bound type(s).
- */
- #[DataProvider('validWhenValuesSearchedCaseDataProvider')]
- public function testValidWhenValueSearchedCase($value, ?string $expectedSql, $typeOrBindings = null): void
- {
- $typeMap = new TypeMap([
- 'Table.column_a' => 'integer',
- 'Table.column_b' => 'string',
- ]);
- $expression = (new CaseStatementExpression())
- ->setTypeMap($typeMap)
- ->when($value)
- ->then(2);
- $valueBinder = new ValueBinder();
- $sql = $expression->sql($valueBinder);
- if ($expectedSql) {
- $this->assertEqualsSql($expectedSql, $sql);
- $this->assertSame($typeOrBindings, $valueBinder->bindings());
- } else {
- $this->assertEqualsSql('CASE WHEN :c0 THEN :c1 ELSE NULL END', $sql);
- $this->assertSame(
- [
- ':c0' => [
- 'value' => $value,
- 'type' => $typeOrBindings,
- 'placeholder' => 'c0',
- ],
- ':c1' => [
- 'value' => 2,
- 'type' => 'integer',
- 'placeholder' => 'c1',
- ],
- ],
- $valueBinder->bindings()
- );
- }
- }
- public static function validThenValuesDataProvider(): array
- {
- return [
- [null, 'NULL', null],
- ['0', null, 'string'],
- [0, null, 'integer'],
- [0.0, null, 'float'],
- ['foo', null, 'string'],
- [true, null, 'boolean'],
- [Date::now(), null, 'date'],
- [ChronosDate::now(), null, 'date'],
- [DateTime::now(), null, 'datetime'],
- [Chronos::now(), null, 'datetime'],
- [new IdentifierExpression('Table.column'), 'Table.column', null],
- [new QueryExpression('Table.column'), 'Table.column', null],
- [ConnectionManager::get('test')->selectQuery('a'), '(SELECT a)', null],
- [new TestObjectWithToString(), null, 'string'],
- [new stdClass(), null, null],
- ];
- }
- /**
- * @param mixed $value The then value.
- * @param string|null $sqlValue The expected SQL string value.
- * @param string|null $type The expected bound type.
- */
- #[DataProvider('validThenValuesDataProvider')]
- public function testValidThenValue($value, ?string $sqlValue, ?string $type): void
- {
- $expression = (new CaseStatementExpression())
- ->when(1)
- ->then($value);
- $valueBinder = new ValueBinder();
- $sql = $expression->sql($valueBinder);
- if ($sqlValue) {
- $this->assertEqualsSql(
- "CASE WHEN :c0 THEN {$sqlValue} ELSE NULL END",
- $sql
- );
- $this->assertSame(
- [
- ':c0' => [
- 'value' => 1,
- 'type' => 'integer',
- 'placeholder' => 'c0',
- ],
- ],
- $valueBinder->bindings()
- );
- } else {
- $this->assertEqualsSql(
- 'CASE WHEN :c0 THEN :c1 ELSE NULL END',
- $sql
- );
- $this->assertSame(
- [
- ':c0' => [
- 'value' => 1,
- 'type' => 'integer',
- 'placeholder' => 'c0',
- ],
- ':c1' => [
- 'value' => $value,
- 'type' => $type,
- 'placeholder' => 'c1',
- ],
- ],
- $valueBinder->bindings()
- );
- }
- }
- public static function validElseValuesDataProvider(): array
- {
- return [
- [null, 'NULL', null],
- ['0', null, 'string'],
- [0, null, 'integer'],
- [0.0, null, 'float'],
- ['foo', null, 'string'],
- [true, null, 'boolean'],
- [Date::now(), null, 'date'],
- [ChronosDate::now(), null, 'date'],
- [DateTime::now(), null, 'datetime'],
- [Chronos::now(), null, 'datetime'],
- [new IdentifierExpression('Table.column'), 'Table.column', null],
- [new QueryExpression('Table.column'), 'Table.column', null],
- [ConnectionManager::get('test')->selectQuery('a'), '(SELECT a)', null],
- [new TestObjectWithToString(), null, 'string'],
- [new stdClass(), null, null],
- ];
- }
- /**
- * @param mixed $value The else value.
- * @param string|null $sqlValue The expected SQL string value.
- * @param string|null $type The expected bound type.
- */
- #[DataProvider('validElseValuesDataProvider')]
- public function testValidElseValue($value, ?string $sqlValue, ?string $type): void
- {
- $expression = (new CaseStatementExpression())
- ->when(1)
- ->then(2)
- ->else($value);
- $valueBinder = new ValueBinder();
- $sql = $expression->sql($valueBinder);
- if ($sqlValue) {
- $this->assertEqualsSql(
- "CASE WHEN :c0 THEN :c1 ELSE {$sqlValue} END",
- $sql
- );
- $this->assertSame(
- [
- ':c0' => [
- 'value' => 1,
- 'type' => 'integer',
- 'placeholder' => 'c0',
- ],
- ':c1' => [
- 'value' => 2,
- 'type' => 'integer',
- 'placeholder' => 'c1',
- ],
- ],
- $valueBinder->bindings()
- );
- } else {
- $this->assertEqualsSql(
- 'CASE WHEN :c0 THEN :c1 ELSE :c2 END',
- $sql
- );
- $this->assertSame(
- [
- ':c0' => [
- 'value' => 1,
- 'type' => 'integer',
- 'placeholder' => 'c0',
- ],
- ':c1' => [
- 'value' => 2,
- 'type' => 'integer',
- 'placeholder' => 'c1',
- ],
- ':c2' => [
- 'value' => $value,
- 'type' => $type,
- 'placeholder' => 'c2',
- ],
- ],
- $valueBinder->bindings()
- );
- }
- }
- // endregion
- // region Invalid values
- public static function invalidCaseValuesDataProvider(): array
- {
- $res = fopen('data:text/plain,123', 'rb');
- fclose($res);
- return [
- [[], 'array'],
- [
- function (): void {
- },
- 'Closure',
- ],
- [$res, 'resource (closed)'],
- ];
- }
- /**
- * @param mixed $value The case value.
- * @param string $typeName The expected error type name.
- */
- #[DataProvider('invalidCaseValuesDataProvider')]
- public function testInvalidCaseValue($value, string $typeName): void
- {
- $this->expectException(InvalidArgumentException::class);
- $this->expectExceptionMessage(
- 'The `$value` argument must be either `null`, a scalar value, an object, ' .
- "or an instance of `\\Cake\\Database\\ExpressionInterface`, `{$typeName}` given."
- );
- new CaseStatementExpression($value);
- }
- public function testInvalidWhenValue(): void
- {
- $this->expectException(InvalidArgumentException::class);
- $this->expectExceptionMessage(
- 'The `$when` argument must be a non-empty array'
- );
- (new CaseStatementExpression())
- ->when([])
- ->then(1);
- }
- public static function invalidThenValueDataProvider(): array
- {
- $res = fopen('data:text/plain,123', 'rb');
- fclose($res);
- return [
- [[], 'array'],
- [
- function (): void {
- },
- 'Closure',
- ],
- [$res, 'resource (closed)'],
- ];
- }
- /**
- * @param mixed $value The then value.
- * @param string $typeName The expected error type name.
- */
- #[DataProvider('invalidThenValueDataProvider')]
- public function testInvalidThenValue($value, string $typeName): void
- {
- $this->expectException(InvalidArgumentException::class);
- $this->expectExceptionMessage(
- 'The `$result` argument must be either `null`, a scalar value, an object, ' .
- "or an instance of `\\Cake\\Database\\ExpressionInterface`, `{$typeName}` given."
- );
- (new CaseStatementExpression())
- ->when(1)
- ->then($value);
- }
- public static function invalidThenTypeDataProvider(): array
- {
- $res = fopen('data:text/plain,123', 'rb');
- fclose($res);
- return [
- [1],
- [1.0],
- [new stdClass()],
- [
- function (): void {
- },
- ],
- [$res, 'resource (closed)'],
- ];
- }
- /**
- * @param mixed $type The then type.
- */
- #[DataProvider('invalidThenTypeDataProvider')]
- public function testInvalidThenType($type): void
- {
- $this->expectException(TypeError::class);
- (new CaseStatementExpression())
- ->when(1)
- ->then(1, $type);
- }
- public static function invalidElseValueDataProvider(): array
- {
- $res = fopen('data:text/plain,123', 'rb');
- fclose($res);
- return [
- [[], 'array'],
- [
- function (): void {
- },
- 'Closure',
- ],
- [$res, 'resource (closed)'],
- ];
- }
- /**
- * @param mixed $value The else value.
- * @param string $typeName The expected error type name.
- */
- #[DataProvider('invalidElseValueDataProvider')]
- public function testInvalidElseValue($value, string $typeName): void
- {
- $this->expectException(InvalidArgumentException::class);
- $this->expectExceptionMessage(
- 'The `$result` argument must be either `null`, a scalar value, an object, ' .
- "or an instance of `\\Cake\\Database\\ExpressionInterface`, `{$typeName}` given."
- );
- (new CaseStatementExpression())
- ->when(1)
- ->then(1)
- ->else($value);
- }
- public static function invalidElseTypeDataProvider(): array
- {
- $res = fopen('data:text/plain,123', 'rb');
- fclose($res);
- return [
- [1],
- [1.0],
- [new stdClass()],
- [
- function (): void {
- },
- 'Closure',
- ],
- [$res, 'resource (closed)'],
- ];
- }
- /**
- * @param mixed $type The else type.
- */
- #[DataProvider('invalidElseTypeDataProvider')]
- public function testInvalidElseType($type): void
- {
- $this->expectException(TypeError::class);
- (new CaseStatementExpression())
- ->when(1)
- ->then(1)
- ->else(1, $type);
- }
- // endregion
- // region Traversal
- public function testTraverse(): void
- {
- $value = new IdentifierExpression('Table.column');
- $conditionsA = ['Table.column_a' => true, 'Table.column_b IS' => null];
- $resultA = new QueryExpression('1');
- $conditionsB = ['Table.column_c' => true, 'Table.column_d IS NOT' => null];
- $resultB = new QueryExpression('2');
- $else = new QueryExpression('3');
- $expression = (new CaseStatementExpression($value))
- ->when($conditionsA)
- ->then($resultA)
- ->when($conditionsB)
- ->then($resultB)
- ->else($else);
- $expressions = [];
- $expression->traverse(function ($expression) use (&$expressions): void {
- $expressions[] = $expression;
- });
- $this->assertCount(14, $expressions);
- $this->assertInstanceOf(IdentifierExpression::class, $expressions[0]);
- $this->assertSame($value, $expressions[0]);
- $this->assertInstanceOf(WhenThenExpression::class, $expressions[1]);
- $this->assertEquals(new QueryExpression($conditionsA), $expressions[2]);
- $this->assertEquals(new ComparisonExpression('Table.column_a', true), $expressions[3]);
- $this->assertSame($resultA, $expressions[6]);
- $this->assertInstanceOf(WhenThenExpression::class, $expressions[7]);
- $this->assertEquals(new QueryExpression($conditionsB), $expressions[8]);
- $this->assertEquals(new ComparisonExpression('Table.column_c', true), $expressions[9]);
- $this->assertSame($resultB, $expressions[12]);
- $this->assertSame($else, $expressions[13]);
- }
- public function testTraverseBeforeClosingThenFails(): void
- {
- $this->expectException(LogicException::class);
- $this->expectExceptionMessage('Case expression has incomplete when clause. Missing `then()` after `when()`.');
- $this->deprecated(function (): void {
- $expression = (new CaseStatementExpression())
- ->when(['Table.column' => true]);
- $expression->traverse(
- function (): void {
- }
- );
- });
- }
- // endregion
- // region Cloning
- public function testClone(): void
- {
- $value = new IdentifierExpression('Table.column');
- $conditionsA = ['Table.column_a' => true, 'Table.column_b IS' => null];
- $resultA = new QueryExpression('1');
- $conditionsB = ['Table.column_c' => true, 'Table.column_d IS NOT' => null];
- $resultB = new QueryExpression('2');
- $else = new QueryExpression('3');
- $expression = (new CaseStatementExpression($value))
- ->when($conditionsA)
- ->then($resultA)
- ->when($conditionsB)
- ->then($resultB)
- ->else($else);
- $clone = clone $expression;
- $this->assertEquals($clone, $expression);
- $this->assertNotSame($clone, $expression);
- }
- public function testCloneBeforeClosingThenFails(): void
- {
- $this->expectException(LogicException::class);
- $this->expectExceptionMessage('Case expression has incomplete when clause. Missing `then()` after `when()`.');
- $this->deprecated(function (): void {
- $expression = (new CaseStatementExpression())
- ->when(['Table.column' => true]);
- clone $expression;
- });
- }
- // endregion
- }
|