Difference between revisions of "QueryBuilder"
| Line 47: | Line 47: | ||
=== <code>geef</code> === | === <code>geef</code> === | ||
Net zoals de methode <code>geef</code> voor objecten heeft de QueryBuilder een soortgelijke methode. De methode geeft een object terug die wordt opgevraagd dmv de query. Net als bij <code>verzamel</code> heeft de methode een argument voor het soort object wat je op wilt halen. | Net zoals de methode <code>geef</code> voor objecten heeft de QueryBuilder een soortgelijke methode. De methode geeft een object terug die wordt opgevraagd dmv de query. Net als bij <code>verzamel</code> heeft de methode een argument voor het soort object wat je op wilt halen. | ||
| − | Geef het lid met ID 5794 | + | Geef het lid-object met ID 5794 |
<syntaxhighlight lang="php" line='line'> | <syntaxhighlight lang="php" line='line'> | ||
$persoon = PersoonQuery::table() | $persoon = PersoonQuery::table() | ||
| − | ->whereInt(' | + | ->whereInt('contactID', 5794) |
->geef(); | ->geef(); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
== Joins == | == Joins == | ||
| − | De QueryBuilder heeft uiteraard ook de mogelijkheid om joins uit te voeren op tables. Nieuwe tabellen worden automatisch op de juiste velden gejoind, dus dit hoef je niet meer zelf te doen. Mocht de QueryBuilder het toch niet zelf kunnen, dan hebben de join-methoden extra argumenten nodig voor het joinen. De standaard <code>join</code> is een left join. Je hoeft als enige argument de table mee te geven om op te joinen. Zo kan je bv de table Persoon joinen met Bug | + | De QueryBuilder heeft uiteraard ook de mogelijkheid om joins uit te voeren op tables. Nieuwe tabellen worden automatisch op de juiste velden gejoind, dus dit hoef je niet meer zelf te doen. Mocht de QueryBuilder het toch niet zelf kunnen, dan hebben de join-methoden extra argumenten nodig voor het joinen. |
| + | |||
| + | === (left) <code>join</code> === | ||
| + | De standaard <code>join</code> is een left join. Je hoeft als enige argument de table mee te geven om op te joinen. Zo kan je bv de table Persoon joinen met Bug | ||
<syntaxhighlight lang="php" line='line'> | <syntaxhighlight lang="php" line='line'> | ||
$query = BugQuery::table()->join('Persoon'); | $query = BugQuery::table()->join('Persoon'); | ||
| + | </syntaxhighlight> | ||
| + | Als het echt nodig is kan je zelf de twee namen van de kolommen meegeven waarop gejoined moet worden | ||
| + | <syntaxhighlight lang="php" line='line'> | ||
| + | $query = BugQuery::table()->join('Persoon', 'Bug.melder_contactID', 'Persoon.contactID'); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
[[Category:WebCie]] | [[Category:WebCie]] | ||
Revision as of 18:47, 28 February 2017
Om SQL-queries makkelijker te maken heeft de WebCie haar eigen sql-library geschreven, de QueryBuilder. De QueryBuilder maakt queries op dmv van een QueryBuilder-object waaraan properties veranderd worden. Op die manier wordt de query pas gebouwd als de query uitgevoerd moet worden. Hierdoor is er meer mogelijkheid voor controle en sanity checks.
De QueryBuilder bestaat uit de Query-klasse, de QueryBuilder-klasse en alle uitbreidingen. De Query-klasse is een extensie van de QueryBuilder-klasse. Het verschil tussen de twee klasses is dat de QueryBuilder-klasse wordt gebruikt om de query op te bouwen en de Query-klasse wordt gebruikt om van het geheel een werkende query te maken, alsmede verschillende functies zoals het verzamelen van objecten te implementeren.
Contents
QueryBuilder starten
Omdat je een query altijd wilt gebruiken voor WhosWho4-objecten heeft elk WhosWho4-object zijn eigen query-classe die een uitbreiding is van de Query-klasse. Zo heb je bv de PersoonQuery-klasse en de LidQuery-klasse. Deze extensies hebben niet hun eigen speciale constructor. in plaats daarvan heeft elk van deze klassen de methode table waarmee een Query-klasse wordt aangemaakt, het object als table bij de query wordt gezet en het ObjectQuery-object wordt gereturnd zodat er meteen methoden op kunnen worden toegepast. Een voorbeeld:
$query = PersoonQuery::table();
Query uitvoeren
Een query kan je uitvoeren met de methode get. get heeft geen argumenten nodig. Als je verder niets aan je Query-object hebt toegevoegd selecteert de query automatisch alle objecten in de table. Met het volgende voorbeeld worden alle entries uit de Persoon-table opgevraagd:
$personen = PersoonQuery::table()->get();
first
De methode first voert de query uit zoals get dat doet en geeft vervolgens alleen het eerste resultaat terug. Met het volgende voorbeeld wordt de eerste entry uit de Persoon-table opgehaald:
$personen = PersoonQuery::table()->first();
aggregate (TODO: in de php-code moet deze functie nog worden aangepast)
De methode aggregate voert een aggregator uit op de query. De toegestane aggregators zijn: COUNT, SUM, MAX, MIN en YEAR. De aggregator pakt op dit moment nog alles ipv een specifieke kolom. aggregate haalt ook de huidige selectie weg. Een voorbeeld om alle entries in de Persoon-table te tellen:
$aantal_personen = PersoonQuery::table()->aggregate('COUNT');
count
Om makkelijker entries te tellen is de speciale methode count. Deze methode telt het aantal entries en haalt ook de orderBys, limits en offset van de query weg.
$aantal_personen = PersoonQuery::table()->count();
verzamel
De methode die het vaakst gebruikt wordt is verzamel. Net zoals verzamel van elke Verzameling van een WhosWho4-object verzamelt deze query-methode alle WhosWho4-objecten die met de query opgehaald worden. Hierbij verdwijnen alle huidige selects van de query. De methode kan twee argumenten krijgen: de naam van de klasse om de objecten van te verzamelen as string en of de objecten distinct moeten zijn als bool. Zonder argumenten is distinct true en worden de objecten opgehaald van de klasse waarvan je het query-object gemaakt hebt. Als voorbeeld, haal alle Persoon-objecten op:
$persoon_objecten = PersoonQuery::table()->verzamel();
Haal alle distinct bugmelders op (dit voorbeeld gebruikt ook join):
$persoon_objecten = BugQuery::table()
->join('Persoon')
->verzamel('Persoon', true);
geef
Net zoals de methode geef voor objecten heeft de QueryBuilder een soortgelijke methode. De methode geeft een object terug die wordt opgevraagd dmv de query. Net als bij verzamel heeft de methode een argument voor het soort object wat je op wilt halen.
Geef het lid-object met ID 5794
$persoon = PersoonQuery::table()
->whereInt('contactID', 5794)
->geef();
Joins
De QueryBuilder heeft uiteraard ook de mogelijkheid om joins uit te voeren op tables. Nieuwe tabellen worden automatisch op de juiste velden gejoind, dus dit hoef je niet meer zelf te doen. Mocht de QueryBuilder het toch niet zelf kunnen, dan hebben de join-methoden extra argumenten nodig voor het joinen.
(left) join
De standaard join is een left join. Je hoeft als enige argument de table mee te geven om op te joinen. Zo kan je bv de table Persoon joinen met Bug
$query = BugQuery::table()->join('Persoon');
Als het echt nodig is kan je zelf de twee namen van de kolommen meegeven waarop gejoined moet worden
$query = BugQuery::table()->join('Persoon', 'Bug.melder_contactID', 'Persoon.contactID');
