| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110 |
- <?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 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],
- ];
- }
- /**
- * @dataProvider valueTypeInferenceDataProvider
- * @param mixed $value The value from which to infer the type.
- * @param string|null $type The expected type.
- */
- 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],
- ];
- }
- /**
- * @dataProvider whenTypeInferenceDataProvider
- * @param mixed $value The value from which to infer the type.
- * @param string|null $type The expected type.
- */
- 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],
- ];
- }
- /**
- * @dataProvider resultTypeInferenceDataProvider
- * @param mixed $value The value from which to infer the type.
- * @param string|null $type The expected type.
- */
- 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());
- }
- /**
- * @dataProvider resultTypeInferenceDataProvider
- * @param mixed $value The value from which to infer the type.
- * @param string|null $type The expected type.
- */
- 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()
- {
- $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()
- {
- $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()
- {
- $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 () {
- (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 () {
- (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 () {
- (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 () {
- (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 () {
- (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],
- ];
- }
- /**
- * @dataProvider validCaseValuesDataProvider
- * @param mixed $value The case value.
- * @param string|null $sqlValue The expected SQL string value.
- * @param string|null $type The expected bound type.
- */
- 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',
- ],
- ],
- ],
- ];
- }
- /**
- * @dataProvider validWhenValuesSimpleCaseDataProvider
- * @param mixed $value The when value.
- * @param string|null $expectedSql The expected SQL string.
- * @param array|string|null $typeOrBindings The expected bound type(s).
- */
- 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',
- ],
- ],
- ],
- ];
- }
- /**
- * @dataProvider validWhenValuesSearchedCaseDataProvider
- * @param mixed $value The when value.
- * @param string|null $expectedSql The expected SQL string.
- * @param array|string|null $typeOrBindings The expected bound type(s).
- */
- 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],
- ];
- }
- /**
- * @dataProvider validThenValuesDataProvider
- * @param mixed $value The then value.
- * @param string|null $sqlValue The expected SQL string value.
- * @param string|null $type The expected bound type.
- */
- 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],
- ];
- }
- /**
- * @dataProvider validElseValuesDataProvider
- * @param mixed $value The else value.
- * @param string|null $sqlValue The expected SQL string value.
- * @param string|null $type The expected bound type.
- */
- 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 () {
- },
- 'Closure',
- ],
- [$res, 'resource (closed)'],
- ];
- }
- /**
- * @dataProvider invalidCaseValuesDataProvider
- * @param mixed $value The case value.
- * @param string $typeName The expected error type name.
- */
- 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 () {
- },
- 'Closure',
- ],
- [$res, 'resource (closed)'],
- ];
- }
- /**
- * @dataProvider invalidThenValueDataProvider
- * @param mixed $value The then value.
- * @param string $typeName The expected error type name.
- */
- 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 () {
- },
- ],
- [$res, 'resource (closed)'],
- ];
- }
- /**
- * @dataProvider invalidThenTypeDataProvider
- * @param mixed $type The then type.
- */
- 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 () {
- },
- 'Closure',
- ],
- [$res, 'resource (closed)'],
- ];
- }
- /**
- * @dataProvider invalidElseValueDataProvider
- * @param mixed $value The else value.
- * @param string $typeName The expected error type name.
- */
- 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 () {
- },
- 'Closure',
- ],
- [$res, 'resource (closed)'],
- ];
- }
- /**
- * @dataProvider invalidElseTypeDataProvider
- * @param mixed $type The else type.
- */
- 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) {
- $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 () {
- $expression = (new CaseStatementExpression())
- ->when(['Table.column' => true]);
- $expression->traverse(
- function () {
- }
- );
- });
- }
- // 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 () {
- $expression = (new CaseStatementExpression())
- ->when(['Table.column' => true]);
- clone $expression;
- });
- }
- // endregion
- }
|