InGoedeBanen plugin

• Introductie
• Admin
• Ontwikkeling
• Velden

Introductie

Welkom bij de handleiding van de In Goede Banen plugin.

Met InGoedeBanen.nl worden vacatures snel en eenvoudig geplaatst op ruim 500 jobboards. Naast haar CRM software, biedt InGoedeBanen.nl ook koppelingen naar diverse websites. Tussendoor en InGoedeBanen.nl hebben in samenwerking een IGB Vacature WordPress plugin ontwikkeld, waarmee het aanbod vacatures vanuit InGoedeBanen.nl realtime verstuurd en gesynchroniseerd kan worden richting WordPress. Via de IGB Vacature plugin beschik je dus automatisch over al jouw vacatures op je eigen WordPress site. Met het bijgeleverde zoek- en filterformulier is het zoeken naar de ideale baan (in een WordPress site) voor jouw bezoekers een fluitje van een cent.

---

Features

• Koppeling met In Goede Banen (IGB) account.
• Realtime informatie vanuit IGB CRM.
• Bijwerkgeschiedenis in kunnen zien, status van bijwerkproces live volgen en annuleren.
• Zoekvelden eenvoudig maar uitgebreid instellen vanuit de admin.
• Per zoekoptie weergeven hoeveel resultaten er voor zullen zijn.
• Direct bijwerken van resultaten bij wijzigen van zoekoptie.
• Mogelijkheid om resultaten op de gewenste manier te sorteren.
• Zeer uitgebreide controle over weergave van velden.
• Kwaliteit gewaarborgd door circa 400 geautomatiseerde tests.
• Eigen page templates. *
• Basis thema met voorbeeld code. *
• De vormgeving is naar wens aan te passen door het schrijven van eigen HTML, CSS, PHP en JS. *

Dit basis thema kan je als child-theme van je hoofdthema installeren.

---

Installatie

Installeer de plugin door de ontvangen plugin naar /wp-content/plugins/ te uploaden. Activeer de plugin vervolgens vanuit de WordPress admin.

Plugin updates worden beschikbaar gesteld via de WordPress plugin pagina. Ook is op het dashboard van de plugin te zien of de plugin up-to-date is.

Vereisten

• PHP 7.4 of hoger (Wij raden het gebruik van PHP 8+ aan)

Als hier niet aan voldaan wordt zal het activeren van de plugin mislukken of kan het zijn dat de site niet meer wordt geladen. In dat geval moet de plugin map worden hernoemd of verwijderd om het probleem te verhelpen.

Verder zijn de volgende vereisten noodzakelijk voor het soepel laten verlopen van updates:

• Geen max_execution_time limiet
• Geheugenlimiet minstens 128MB, hoger gewenst

Licentie

Bij de aanschaf van de plugin heb je een licentiecode gekregen. Het is van belang dat deze wordt ingevoerd om de plugin zonder restricties te laten werken en om plugin updates te kunnen ontvangen.

Schijfbevoegdheden

Na het activeren van de plugin in WordPress is het van belang om te controleren dat de plugin voldoende schijfbevoegdheden heeft. Als hier niet aan wordt voldaan zullen plugin instellingen niet kunnen worden opgeslagen en zal bijwerken foutmeldingen geven.

Instellingen

Alle instellingen van de plugin worden opgeslagen in de thema-map. Dit heeft als voordeel dat een site gemakkelijk gekopieerd kan worden waarbij alle instellingen ook worden overgenomen.

Bij het wisselen van het actieve WordPress thema worden de instellingen niet automatisch meegenomen. Wissel dus eerst naar het gewenste thema en begin pas daarna met het instellen van de plugin, of verplaats na de thema-wisseling de instellingen map handmatig naar het nieuwe thema. Controleer vervolgens de schijfbevoegdheden opnieuw.

---

Tussendoor B.V.
Sixmastraat 66-B
8932 PA Leeuwarden

e. info@tussendoor.nl
w. http://www.tussendoor.nl

Admin

Deze sectie van de documentatie is bedoeld voor het gebruik van de plugin vanuit de WordPress omgeving.

Dashboard

Het dashboard dient als centrale beginpunt van de plugin. Zo biedt het beknopt inzicht in het bijwerkproces en over de installatie. Na de activatie kan de plugin vanaf het dashboard geactiveerd worden door de meegeleverde licentiecode in te vullen.

Verder kan de schijfbevoegdheden direct vanaf het dashboard worden gecontroleerd. Het is belangrijk dat deze in order zijn voor het juist functioneren van de plugin, wanneer er problemen zijn wordt dit duidelijk gemaakt door rood gearceerde tekst.

---

Instellingen

Instellingen die van toepassing zijn op de gehele plugin kunnen in het tabblad Instellingen worden aangepast. Deze instellingen hebben betrekking tot het doorsturen van de gegevens vanaf IGB.

Allereerst moet een koppeling met IGB worden gerealiseerd. Via het instellingen tabblad is bij Bijwerklink de URL te vinden welke aan IGB (info@ingoedebanen.nl) moet worden doorgegeven. Zij zullen deze vervolgens koppelen aan de juiste account.

Houd er rekening mee dat je exact de juiste URL doorgeeft aan IGB, zonder juiste URL werkt de plugin niet. Bij het verhuizen van een website van ontwikkelomgeving naar een live site kan deze wijzigen, houd hier rekening mee.

Voor alle instellingen geldt dat ze expliciet moeten worden opgeslagen, via de blauwe knop rechtsboven.

Voor iedere object afkomstig vanuit de feed wordt een WordPress post aangemaakt. De titel, inhoud en auteur van deze posts kunnen naar wens worden aangepast.

De titel bepaalt hoe de URL van een vacature eruit ziet, dit is een standaard WordPress functionaliteit. Wanneer je de titel van een vacature anders vorm wil geven zullen daarom de posts opnieuw aangemaakt moeten worden, verwijder daarvoor de vacatures en haal ze opnieuw binnen.

Let er daarbij op dat alleen vacatures die nog in de feed zitten opnieuw worden opgeslagen, het kan voorkomen dat een vacature niet meer in de feed zit en dat deze niet opnieuw opgeslagen kan worden.

De inhoud bepaalt de content van een vacature, hier plaatsen we standaard de aanbiedingstekst van een vacature in.

Als er een typefout in de tekst zit en dit wordt binnen het CRM van IGB aangepast, dan wijzigen we de aanbiedingstekst alleen in de database. Haal daarom altijd de waarde uit de database en niet uit the_content(). De post wordt namelijk niet volledig opnieuw opgeslagen waardoor the_content() de typefout behoudt.

Overig

Vanaf IGB is het mogelijk om bedrijfslogo’s mee te sturen bij de vacature(s). Via de optie “Logo” kan worden aangegeven of deze wel of niet gedownload moeten worden in de WordPress site.

 

---

Zoekvelden

Vanuit de admin kunnen zoekvelden worden toegevoegd, met hun zoekopties en bijbehorende zoekopdracht. Hieronder zie je een voorbeeld van een zoekveld waarmee op locatie gezocht kan worden.

Links zie je een opsomming van de toegevoegde zoekvelden, wanneer je daar op '+ Nieuw' klikt kan er een nieuw zoekveld toegevoegd worden.

De naam van een zoekveld is belangrijk, hiermee koppel je het zoekveld aan een zoekveld binnen je thema. Plaats geen hoofdletters, spaties of streepjes in de naam. Dit kan voor onverwachte problemen zorgen.

---

Opties

In het voorbeeld hierboven willen we het zoekveld 'locatie' in een dropdown op de pagina tonen, om de dropdown te vullen met zoekopties kan je binnen de instellingen van het zoekveld opties toevoegen. Op deze opties moet uiteindelijk gezocht kunnen worden, geef daarom een duidelijk label op zodat bezoekers van de website weten wat voor zoekresultaat ze kunnen verwachten.

Het label van de zoekoptie zie je links in de rij en rechts in de grijze bol zie je de waarde. De plugin zoekt binnen de objecten naar deze waarde. In het voorbeeld zijn beide waardes gelijk, maar het kan zijn dat de waarde 'Leeuwarden' is terwijl je wil dat bezoekers op het label 'LWD' kunnen klikken. Wanneer de bezoeker op het vormgegeven label 'LWD' klikt zoekt de plugin dus naar vacatures met de status waarde 'Leeuwarden'.

De plugin weet natuurlijk niet automatisch op welk veld er gezocht moet worden en de naam 'locatie' van het zoekveld is niet genoeg. Je moet daarom nog een zoekopdracht toevoegen waardoor de plugin weet dat het veld 'locatie' gebruikt moet worden. Lees verder op de pagina om er achter te komen hoe je dit doet.

Helemaal links in de rij kan je aan zoekoptie de- of activeren, met het kruisje helemaal rechts kan een optie worden verwijderd en de checkbox er links naast bepaalt of de optie standaard geselecteerd is.

Automatisch bijwerken

In het voorbeeld hierboven willen we zoeken op 'locatie' en je ziet dat onder de naam van het zoekveld 'automatisch bijwerken' op het veld locatie is ingesteld. Voor sommige zoekvelden is het makkelijk om alle mogelijke waardes automatisch beschikbaar te stellen. Door bij ‘Automatisch bijwerken’ het zoekveld te koppelen aan één van de velden, zoekt de plugin door de database naar alle waarden van dit veld binnen de aanwezige vacatures.

Bij het opslaan van de instellingen worden direct alle opties toegevoegd die momenteel beschikbaar zijn, dus handmatig invoeren is dan niet nodig. Labels en waarden worden automatisch toegevoegd.

Primaire opties

Het kan gewenst zijn om bepaalde opties bovenaan de lijst te tonen, zodat ze bijvoorbeeld bovenaan in een dropdown staan. Door deze opties bovenaan in de lijst te schuiven zullen nieuw toegevoegde opties worden ingevoegd vanaf het punt waar deze primaire opties stoppen, dit is waar de alfabetische volgorde onderbroken wordt. De gekozen opties blijven dus altijd bovenaan staan en nieuwe opties worden alsnog alfabetisch toegevoegd. Slepen doe je door op het grid-icoon helemaal links in een zoekoptie rij te klikken en vervolgens te slepen.

Afhankelijke zoekvelden

Opties kunnen worden gekoppeld aan de waarde van een ander veld. Als voorbeeld hieronder zie je het wederom het zoekveld ‘locatie’, deze is afhankelijk van het zoekveld ‘provincie’. Voor elke locatie kan dan worden opgegeven bij welk provincie deze locatie zichtbaar moet zijn. Dus stel een bezoeker filtert op in het zoekveld voor 'provincie' naar 'Friesland' dan wordt in dit geval in het zoekveld voor 'locatie' alleen nog 'Leeuwarden' getoond.

Wanneer er nog geen provincie is gekozen door de bezoeker zal het zoekveld voor locatie leeg zijn.

 

---

Zoekopdracht

Zoals eerder aangegeven is het niet voldoende om alleen opties toe te voegen, de plugin weet dan namelijk nog niet op welke waarde er gezocht moet worden. Om dit aan de plugin door te geven moet er een zoekopdracht toegevoegd worden.

In veel gevallen is voor iedere optie dezelfde zoekopdracht van toepassing, dan kan een algemene zoekopdracht worden ingesteld. Ook kan voor een optie specifiek een aangepaste zoekopdracht worden opgegeven.

Algemeen

Een algemene zoekopdracht kan onderaan de pagina worden ingevuld bij 'zoekopdracht'. Een ingestelde zoekoptie kan argumenten aan deze zoekopdracht meegeven zodat elke zoekoptie toch een ander resultaat kan geven. Zoals in het voorbeeld van het zoekveld voor locatie stellen we algemeen in dat de plugin op het veld 'locatie' moet zoeken. Per zoekoptie vullen we een andere waarde in en na het klikken (door een bezoeker) op een zoekoptie zal de plugin zoeken naar vacatures met de locatie van de zoekoptie die is aangeklikt.

Rechts naast het label van een optie zie je, zoals eerder aangegeven, de waarde van de zoekoptie in een grijs bolletje. In een algemene zoekopdracht refereer je naar deze waarde met #{0}.

Als een optie geen argumenten heeft wordt de algemene zoekopdracht niet toegepast!

Het is ook mogelijk om nog een argument toe te voegen, na het aanpassen van je eerste waarde druk je op tab waardoor er nog een grijs bolletje ontstaat. Hier kan je je extra waarde invullen. Vanuit de algemene zoekopdracht wordt aan het eerste argument gerefereerd door #{0}, meer argumenten zijn #{1}, #{2} enz.

Zo kan je bijvoorbeeld de opleiding HBO, MBO en VMBO als volgt onder 'Overig' plaatsen. Een bezoeker ziet dus alleen het label 'Overig' maar de plugin zoekt direct ook naar vacatures waar minimaal de opleidingen HBO, MBO en VMBO nodig zijn.

Bij de zoekopdracht stel je nu 'minstens een' in zodat de plugin zoekt naar vacatures die OF de opleiding 'HBO' OF de opleiding 'MBO' OF de opleiding 'MBO' nodig hebben.

Complexe zoekopdrachten zoals hierboven kunnen worden bereikt door meerdere regels toe te voegen, of zelfs meerdere groepen met regels. Voeg regels toe via het kleine omcirkelde plusje rechts naast een regel, en groepen via de grote plus aan het begin van de groep.  Een groep bevat vaak zelf ook meerdere regels, je kan instellen of een object aan alle regels binnen een groep moet voldoen of minstens een. Boven een groep heb je namelijk opnieuw deze keuze zoals je nu ook in het screenshot naar 'zoekopdracht' ziet staan.

Specifiek

Het komt ook voor dat je een zoekveld wil aanmaken waarvoor geen algemene zoekopdracht mogelijk is, bijvoorbeeld wanneer elke optie op een ander veld moet zoeken. In zo'n geval kan je per optie een zoekopdracht meegeven, belangrijk hiervoor is dat je de waarde (in het grijze bolletje) verwijdert. Daarna klik je op de asterisk om een specifieke zoekopdracht in te stellen, dit gaat op gelijke wijze als de algemene zoekopdracht, maar hier stel je vaste waardes in en maak je dus geen gebruik van #{0} of #{1}. 

In het voorbeeld met de opleiding waar het label 'Overig' op 'HBO' 'MBO' en 'VMBO' moet zoeken ziet dat er als volgt uit:

Als je goed kijkt zie je in het bovenstaande voorbeeld dat de andere opleidingen nog wel van de algemene zoekopdracht gebruik maken. Dit is dus ook mogelijk.

---

 

Geavanceerde instellingen

De admin interface biedt toegang tot een klein aantal instellingen, meer geavanceerde instellingen kunnen worden toegepast via het admin tabblad ‘Geavanceerd’. Dit geeft de mogelijkheid om het ruwe bestand met instellingen direct te wijzigen, waaronder ook instellingen die niet gewijzigd zouden moeten worden. Hieronder geven we enkele instellingen die wél zonder risico’s kunnen worden aangepast.

Bij verkeerde aanpassingen van de instellingen kunnen fouten in de plugin worden veroorzaakt die niet op te lossen zijn vanuit het dashboard. Wees daarom altijd voorzichtig.

Sorteren

Om resultaten te sorteren moeten de sorteerrichtingen via de geavanceerde instellingen handmatig worden toegevoegd. In search.orderings kan een array van objecten worden opgegeven waarbij de key orderby verplicht is en aangeeft op welke velden er gesorteerd moet worden. Door voor een object "default": true op te geven wordt deze sorteervolgorde als standaard toegepast. Eventueel andere keys zijn beschikbaar vanuit de template.

Meerdere velden worden gescheiden door een komma, de volgorde zelf volgt op de naam van het veld met een dubbele punt en vervolgens asc voor oplopend, desc voor aflopend.

"search": {
    "orderings": [
        {
            "orderby": "datum:asc",
            "label": "Datum",
            "meta": "oplopend",
          	"default": true
        },
        {
            "orderby": "datum:desc",
            "label": "Datum",
            "meta": "aflopend"
        }
    ]
},

Om de bezoeker van de website vervolgens de mogelijkheid te geven om te switchen tussen sorteeropties kan je bijvoorbeeld een dropdown vullen met door jou ingestelde opties. Hoe je dat doet lees je binnen Ontwikkeling.

Vacatures overzicht pagina

De titel van de pagina met vacatures kan worden aangepast via post.archive.title. Het aantal weer te geven resultaten per pagina is eenvoudig aan te passen door post.archive.query.posts_per_page aan te passen. Overige parameters voor de WP_Query kunnen overigens ook via post.archive worden opgegeven.

Andere WordPress plugins kunnen op hun eigen manier de titel aanpassen, waardoor het wijzigen van post.archive.title niet altijd invloed heeft.

Er zijn WordPress thema's en WordPress plugins die de werking van het aantal berichten per pagina overschrijven waardoor het wijzigen van post.archive.query.posts_per_page niet altijd invloed heeft.

URL's aanpassen

Standaard is de pagina met een overzicht van vacatures bereikbaar op /vacatures/ en een enkele vacature op /vacature/{title}. Dit wordt bepaald door de registratie van WordPress’ custom post type, en kan dus worden aangepast door post.register.has_archive en post.register.rewrite.slug aan te passen.

URL opdelen in componenten

Normaal zal een vacature met titel Leeuwarden - Backend developer gezocht beschikbaar zijn onder de URL /vacature/leeuwarden-backend-developer-gezocht. Om de titel op te delen in verschillende URL componenten, voor de URL /vacature/leeuwarden/backend-developer-gezocht, kan bij instellingen in de titel #{/} worden ingevoegd om op die positie de dash (-) te vervangen door een slash (/):

Extra zoekresultaten pagina’s

Het is mogelijk om extra pagina’s toe te voegen waarop direct een zoekopdracht wordt uitgevoerd, zodat het aanbod onderverdeeld kan worden in landingspagina's. Denk hierbij aan een aparte URL per provincie in het aanbod van vacatures.

Om een pagina aan te maken begin je met het toevoegen van een zoekveld, we doen dit omdat de zoekvelden de basis zijn van een extra zoekresultaten pagina. Je geeft namelijk een zoekopdracht mee aan de pagina zodat de plugin direct weet welk type aanbod er getoond moet worden op deze pagina.

In het onderstaande voorbeeld zie je hoe je een extra zoekresultaten pagina aanmaakt per provincie.

Het zoekveld is gebaseerd op de vacature informatie die is binnen gekomen via de koppeling, de eigenschappen "Friesland", "Groningen" en "Drenthe" slaan we op in het veld provincie. Voor het gemak hebben we het zoekveld ook de naam "provincie" gegeven, dit kan je naar wens aanpassen.

De volgende stap is om de de pagina daadwerkelijk op te zetten, doe dit voor vacatures door binnen de geavanceerde instellingen in de sidebar onder instellingen naar de module vacature te gaan. Het archive gedeelte in de documentatie ziet er als volgt uit, daarbij gaat het nu dus om archive.pages:

"archive": {
	"title": "Vacatures",
	"query": {
		"posts_per_page": 12
	},
	"pages": [
	    {
            "url": "aanbod/{naamvanzoekveld}",
            "query": {
                "naamvanzoekveld": "#{naamvanzoekveld}"
            },
            "name" : "paginanaam"
        }
	]
},

Heb je geen archive.pages in je geavanceerde instellingen staan? Dan kan je deze zelf toevoegen.

Je ziet de naam van ons zoekveld "provincie" nu nog niet terug komen, bovenstaande zou gekoppeld zijn aan een zoekveld die letterlijk "naamvanzoekveld" heet. Om te koppelen beginnen we aller eerst met de url, daar zetten we de naam van ons zoekveld als volgt in:

{
    "url": "aanbod/{provincie}",
}

De string bepaalt de URL van de pagina en de URL bepaalt ook welke zoekopdracht wordt uitgevoerd. In de afbeelding van het zoekveld zie je drie zoekopties, namelijk "Friesland", "Groningen" en "Drenthe". Zet je één van de opties in de url dan wordt de bijbehorende zoekopdracht uitgevoerd.

URL	Zoekopdracht	Resultaat
/vacatures/friesland	provincie = friesland	Alleen vacatures uit Friesland worden gevonden.
/vacatures/groningen	provincie = groningen	Alleen vacatures uit Groningen worden gevonden.
/vacatures/drenthe	provincie = drenthe	Alleen vacatures uit Drenthe worden gevonden.

In query kunnen variabelen worden opgegeven met een waarde, dit is de plek waar je het ingestelde zoekveld daadwerkelijk koppelt aan de nieuwe pagina. Dat ziet er als volgt uit:

{
    "query": {
        "naamvanzoekveld": "#{naamvanzoekveld}"
    }
}

Naast het koppelen van het juiste zoekveld moet je de pagina ook een naam geven, dit helpt bij de ontwikkeling omdat je daarmee bepaalde code kunt uitvoeren op de pagina voor bijvoorbeeld alleen vacatures uit Friesland. Doet dit door tekst "naam" aan te passen naar de gewenste naam, in ons voorbeeld zou "provincie" het meest voor de hand liggen aangezien dit hetzelfde is als de naam van ons zoekveld. Dus als volgt:

{
    "name" : "provincie"
}

Zet geen spaties, hoofdletters of bijzondere karakters in de naam.

TIP: Geef de pagina dezelfde naam als je zoekveld, dit maakt het makkelijker om mee te werken.

Je kan ook een slechts een aantal zoekopties beschikbaar maken voor de extra zoekresultaten pagina's, dit kun je doen wanneer je maar een paar plaatsen een landingspagina wil geven bijvoorbeeld. Door in de URL deze opties vast te leggen wordt er met door middel van een regex voor gezorgd dat alleen deze optie's mogelijk zijn.

De standaard regex die gebruikt wordt [^/]+, dit betekent dat alles wordt geaccepteerd en dat iedere zoekoptie dus een extra pagina kan aanmaken.

Een aangepaste regex kan worden opgegeven, doe dit na de naam van je zoekveld door de naam en de zoekopties te scheiden met een :.

Voor ons zoekveld met de naam "provincie" en de zoekopties "Friesland", "Groningen" en "Drenthe". Willen we met onderstaande code alleen een landingspagina voor "Friesland" en "Groningen" aanmaken. Daarnaast geven we de extra zoekresultaten pagina de naam "noordelijkeprovincies".

{
    "url": "aanbod/{provincie:friesland|groningen}",
    "query": {
        "provincie": "#{provincie}"
    },
    "name" : "noordelijkeprovincies"
}

De pagina’s maken allemaal gebruik van het archive.php template. Om onderscheid te maken tussen de verschillende pagina’s kunnen we de huidige pagina toetsen aan de ingestelde naam, hierboven was dat "noordelijkeprovincies".

In de archive.php toetsen we de huidige pagina met de functies Vacature::isArchive($name, array $query = []) en Vacature::isArchive(array $query). Het argument $query is om op specifieke waardes van variabelen te testen. Als voorbeeld:

Vacature::isArchive('noordelijkeprovincies');
// Geeft 'true' terug wanneer we op de landingspagina voor Friesland of Groningen zitten
// Geeft 'false' terug wanneer we op de normale zoekresultaten pagina zitten

Vacature::isArchive(array('noordelijkeprovincies' => 'Friesland'));
// Geeft 'true' terug wanneer we op de landingspagina voor Friesland zitten
// Geeft 'false' terug wanneer we op de landingspagina voor Groningen zitten
// Geeft 'false' terug wanneer we op de normale zoekresultaten pagina zitten

Ontwikkeling

Bij de aanschaf van onze IGB plugin ontvang je een standaard thema, deze kan je als child-theme naast je hoofd thema installeren. Hierdoor kan je je hoofdthema up-to-date houden en verlies je geen instellingen van onze plugin.

Binnen dit thema werk je aan de ontwikkeling van de betreffende pagina's, zoals het overzicht en de detailpagina van de objecten. Je schrijft zelf de HTML, CSS, PHP en eventueel extra Javascript om de pagina's vorm te geven.

Je kan deze pagina's niet bewerken vanuit WordPress, ook niet met page builders zoals Elementor.

---

Templates

Het standaard thema is opgedeeld in verschillende templates.

Template	Beschrijving
vacature/archive.php	Wordt door WordPress geladen op de archiefpagina van vacatures.
vacature/search.php	Bevat het zoekformulier op de archiefpagina. Aparte template i.v.m. live zoeken.
vacature/loop.php	Bevat de resultaten op de archiefpagina. Aparte template i.v.m. live zoeken.
vacature/item.php	Compacte weergave van een vacature, gebruikt vanuit loop.php om resultaten te renderen.
vacature/none.php	Wordt ingeladen vanuit archive.php als er geen zoekresultaten zijn.
vacature/single.php	Wordt door WordPress geladen wanneer een enkele vacature wordt bekeken.

Om het template vacature/item.php te renderen vanuit een ander template kan het volgende gebruikt worden:
<?= Vacature::template('item'); ?>

Naast de template bestanden worden er standaard de volgende bestanden automatisch ingeladen: ingoedebanen/functions.php en vacature/functions.php. De eerst genoemde om code van toepassing op alle onderdelen van de plugin te plaatsen en de tweede functions is specifiek voor vacatures.

WordPress laadt de archive, single en de functions in omdat we via de geavanceerde instellingen van de plugin het pad aangeven naar de templates. Als je het thema anders op wil bouwen moet je daarom de paden aanpassen.

The loop

Binnen de loop worden zonder zoekopdracht alle vacatures opgehaald en op het moment dat de bezoeker een zoekopdracht instelt worden hier de vacatures getoond die voldoen aan die zoekopdracht. In deze loop is de huidige vacature in de iteratie beschikbaar in de variabele $vacature. Het is over het algemeen niet nodig om deze variabele expliciet als global te declareren, de plugin zal dit voor zijn rekening nemen. Met deze variabele kan je informatie van de vacature tonen in de item.php.

Caching

We raden aan om een WordPress caching plugin te gebruiken om het laden van de site te versnellen. Voor het ophalen van de data voor alle vacatures zijn veel database query's nodig, wat alles bij elkaar enkele tientallen milliseconden in beslag kan nemen.

Om dit te versnellen, raden we aan om templates waarin gegevens van een vacature worden opgevraagd te cachen. Bijvoorbeeld binnen de loop tijdens het weergeven van de vacatures:
<?= Vacature::template('item')->cache(); ?>

Templates worden gecached op basis van de naam en ID van de huidige vacature.

---

Weergave van velden

Het kan voorkomen dat er specifieke eisen zijn om velden op een bepaalde manier weer te geven, soms afhankelijk van andere velden en soms omdat je een prijs als een prijs wil formatten. Om te voorkomen dat deze logica overal door het thema opnieuw geschreven wordt biedt de plugin een aantal manieren om dit op een prettige manier te laten verlopen, waarbij alles op een centrale plek aangepast kan worden.

Een veld uit onze plugin is een object en kan naast het terug geven van zijn waarde nog veel meer informatie terug geven. Zo kunnen de volgende methods worden gebruikt:

$vacature->organisatie; // Het volledige object voor het veld 'organisatie'
$vacature->organisatie->render(); // De organisatie van de vacature na transformaties
$vacature->organisatie->value(); // De waarde van het veld organisatie
$vacature->organisatie->label(); // Label van het veld organisatie
$vacature->organisatie->is('Tussendoor'); // Is de organisatie Tussendoor?
$vacature->organisatie->is('Tussendoor', 'Verbonden'); // Is de organisatie Tussendoor of Verbonden?
$vacature->organisatie->isnt('Tussendoor'); // Is de organisatie niet Tussendoor?
$vacature->organisatie->isEmpty(); // Heeft de organisatie geen waarde?
$vacature->organisatie->hasValue(); // Heeft de organisatie een waarde?

TIP: Doordat onze plugin gebruik maakt van Magic Methods (__toString()) kunnen we voor het tonen van de plaats ook simpel het volgende schrijven <?= $vacature->organisatie; ?>. Voor een simpele echo is ->render() niet nodig.

Veld types

Elk veld heeft een bepaald type zodat het weergeven ervan automatisch gebeurt. Ieder van de types heeft verder specifieke methodes als hulp. Voor de onderstaande veldtypes worden letterlijke voorbeelden in de objecten gezet, er zijn echter geen velden die letterlijk ‘list’, ‘boolean’, ‘date’, ‘dateTime’, ‘integer’ of ‘double’ heten. Deze velden referen naar velden met dat type waarde. De velden die geschikt zijn voor jouw CRM pakket vind je allemaal terug onder het hoofdstuk 'velden'.

Arrays

$vacature->list->render($separator = ', ');
$vacature->list->count();
$vacature->list->all();
$vacature->list->first();
$vacature->list->last();
$vacature->list->implode($glue);

In plaats van komma gescheiden waardes kan ook gebruik worden gemaakt van een lijst. Verander hiervoor de formatter in list, waarbij als standaard een <ul> wordt gebruikt. Optioneel kunnen twee argumenten worden opgegeven om de list template en item template aan te passen, in het voorbeeld hieronder zijn de standaard templates opgegeven:
$vacature->list->formatter('list')->render('<ul>#{items}</ul>', '<li>#{item}</li>');


Booleans

CustomPost\Formatter\BooleanFormatter::setTrue($true);
CustomPost\Formatter\BooleanFormatter::setFalse($false);
CustomPost\Formatter\BooleanFormatter::setTrueFalse($true, $false);

$vacature->boolean->render($true= null, $false = null);
$vacature->boolean->boolValue();
$vacature->boolean->isTrue();
$vacature->boolean->isFalse();

Datums

Voor datums wordt gebruik gemaakt van de Carbon library. Voor het weergeven wordt de PHP functie strftime gebruikt en niet de Carbon API, vanwege localization ondersteuning in strftime. Naast de volledige Carbon API zijn de volgende methods beschikbaar:

$vacature->date->render($format = '%e %B %Y'); // Velden zonder tijd
$vacature->dateTime->render($format = '%e %B %Y, %R'); // Velden met tijd
$vacature->date->date(); // Alias voor `value`

Integers

$vacature->integer->render($decimals = 0, $decimal = ',', $thousands = '.');
$vacature->integer->n('berging', 'bergingen'); // Kiest de juiste vorm

Doubles

$vacature->double->render($decimals = 2, $decimal = ',', $thousands = '.');

Bedragen

CustomPost\Formatter\MoneyFormatter::setCurrency($currency);
CustomPost\Formatter\MoneyFormatter::setDecimals($decimals);

$vacature->prijs->render($currency = null, $suffix = null, $decimals = null);

Weergave aanpassen

Voor ieder veld kan echter de weergave ervan worden aangepast. Als voorbeeld zetten we het veld plaats om in hoofdletters:

Vacature::formatter('organisatie', function ($value)
{
    return strtoupper($value);
});

Standaard wordt het veld organistie al slim omgezet in de juiste vorm. Bovenstaande geldt als voorbeeld en kan beter worden bereikt met CSS.

Label aanpassen

In sommige gevallen kan het nodig zijn om een label aan te passen voor een listing, daar kun je de volgende constructie voor gebruiken:

Vacature::label('organisatie', 'Bedrijf');

---

Listings

Vaak moet een lijstje van bepaalde eigenschappen worden gegeven. Daarbij moet worden gecontroleerd of iedere eigenschap wel een waarde heeft om zo geen lege rijen te tonen. Dit is waar listings gebuikt kunnen worden:

<?= $vacature->listing(
	'contact.organisatie', 
    'contact.naam', 
    'contact.adres', 
    'contact.postcode', 
    'contact.plaats', 
    'contact.telefoon', 
    'contact.email', 
    'contact.fax', 
    'contact.vacatureUrl', 
    'contact.sollicitatieUrl'
); ?>

Bovenstaande snippet geeft een lijst met de opgegeven velden in een lijst, met hun bijbehorende labels en alleen als de velden een waarde hebben. Optioneel kan er een titel worden weergegeven welke voor de lijst komt te staan:

<?= $vacature->listing(...)
    ->title('<h3>Eigenschappen</h3>'); ?>

Lege listings

Wanneer geen van de velden een waarde heeft wordt de listing in zijn geheel niet weergegeven. Om toch bijvoorbeeld een melding te geven kan het volgende worden gebruikt:

<?= $vacature->listing(...)
    ->ifEmpty('<p>Geen eigenschappen bekend</p>'); ?>

Als op deze manier een melding wordt ingevoegd wordt ook de titel getoond.

Templates

Standaard wordt een definition list <dl><dt>#{label}</dt><dd>#{value}</dd></dl> structuur gebruikt om de velden weer te geven. Dit kan echter naar wens worden aangepast, als volgt:

<?= $vacature->listing(...)
    ->before('<div>')->between('<hr>')->after('</div>')
    ->item('<div>#{label}: #{value}</div>'); ?>

Template globaal aanpassen

Binnen een site zal vaak dezelfde opmaak gebruikt worden. Het is mogelijk om dit globaal te wijzigen:

CustomPost\Formatter\Listing::templates(array(
    'title' => '<h2>#{title}</h2>',
));

De volgende templates zijn aan te passen:

Template	Standaard waarde
title	'#{title}'
before	'<dl>'
item	'<dt>#{label}</dt><dd>#{value}</dd>'
between	''
after	'</dl>'
empty	'#{message}'

Aangepaste labels

We hebben al gezien hoe het label van een veld kan worden gewijzigd. Omdat een aangepast label soms alleen nodig is op bepaalde plekken is het mogelijk om dit per listing aan te passen:

<?= $vacature->listing(array(
    'contact.naam',
    'contact.organisatie' => 'Bedrijfsnaam',
    'contact.adres',
)); ?>

Voor vacature.organisatie zal vervolgens binnen de listing het label Bedrijfsnaam worden gebruikt, de overige velden behouden hun originele label.

Extra data meegeven

Soms is het nodig om per eigenschap een class op te geven, voor bijvoorbeeld een icoontje. Geef hiervoor in plaats van een enkel label een array op met de benodigde data.

<?= $vacature->listing(array(
    'contact.naam' => array('label' => 'Contactpersoon', 'class' => 'expand', 'suffix' => ''),
    'contact.organisatie' => array('label' => 'Bedrijfsnaam', 'class' => 'company-n', 'suffix' => ''),
))
->item(
    '<dt><i class="fa fa-#{data.class}"></i> #{label}</dt>
     <dd>#{value}#{data.suffix}</dd>'
); ?>

Met de key 'label' kan het label als voorheen worden overschreven, de overige keys zijn beschikbaar via #{data.key}.

De array notatie voor 'suffix' geeft de twee waardes op voor enkelvoud en meervoud.

Render argumenten opgeven

Geef aangepaste argumenten op om een veld te renderen door in de lijst met data de key 'render' op te geven als array van de argumenten.

<?= $vacature->listing(array(
    'datum' => array('render' => '%B %Y'),
)); ?>

Formatter type aanpassen

Het type formatter kan worden aangepast door in de lijst met data de key 'formatter' op te geven met de naam van de gewenste formatter.

<?= $vacature->listing(array(
    'arbeidsvoorwaarden' => array('formatter' => 'list'),
)); ?>

Item template aanpassen

We hebben al gezien hoe $listing->field($name, $template) kan worden gebruikt om de template specifiek voor een item aan te passen. Voor gemak kan het ook via de data key 'template' worden bereikt. In het volgende voorbeeld gebruiken we al het bovenstaande om een lijst weer te geven waarbij alle waardes van het veld contact geintegreerd zijn in de lijst zelf:

<?= $vacature->listing(array(
    'contact.organisatie',
    'contact.naam',
    'contact' => array('template' => '#{value}', 'formatter' => 'list', 'render' => '#{items}')
))
->before('<ul>')->after('</ul>')
->item('<li>#{value}</li>')
?>

---

Macros

Vaak worden stukken code vaker gebruikt en is het gewenst om logica uit de templates te houden. Hiervoor kunnen zogenaamde macros worden toegevoegd, welke dan als method op iedere vacature kunnen worden aangeroepen.

/* vacature/functions.php */
Vacature::macro('similar', function ($vacature, $amount = 3)
{
	return Vacature::search(array($vacature->organisatie), array('posts_per_page' => $amount));
});

/* vacature/single.php */
// Resultaat wordt gecached, herhaaldelijk opvragen geeft identiek resultaat
$similar = $vacature->similar;

// Voert macro iedere keer uit<
$similar = $vacature->similar();

// Geef aangepaste argumenten op
$similar = $vacature->similar(10);

Customs

Macros kunnen ook een veld als resultaat geven. In dat geval kan de macro net als ieder ander veld worden gebruikt, het is dus een soort alias naar een ander veld. Zo is het prijs veld wat standaard beschikbaar is ook een alias naar koopprijs of huurprijs, afhankelijk van welke beschikbaar is. Het voordeel hiervan is dat hierdoor $vacature->prijs->label() automatisch aangeeft of het om een koop- of huurprijs gaat.

Bij het gebruik van een macro is het echter van belang dat er altijd een veld als resultaat wordt gegeven, null of alleen een waarde als resultaat zal fouten opleveren. Om dit te voorkomen kunnen er custom velden worden gedefinieerd:

Vacature::custom('soort', function ($vacature)
{
if($vacature->vacature->woonhuis->soort->hasValue())
{
    // Een veld als resultaat werkt gelijk als bij macros
    return $vacature->vacature->woonhuis->soort;
}
else if ($vacature->bouwgrond->huidigeBestemming->hasValue())
{
    // Met custom velden kunnen we echter ook direct een waarde voor<
    // het veld opgeven. Het label wordt afgeleid van de naam van het
    // veld, in dit geval wordt het Soort.
    return 'Bouwgrond';
}

// Zonder een waarde als resultaat geven is gelijk aan `return null`,
// waarbij wordt aangenomen dat het veld leeg is.
}, 'string');

Het laatste argument, in bovenstaande voorbeeld 'string', bepaalt het type van het veld. Omdat 'string' standaard is kan het in dit geval worden weggelaten.

---

Querying

Het opvragen van vacatures is ondersteund via Vacature::query(), waarbij via het eerste optionele argument de WP_Query argumenten kunnen worden opgegeven.
$vacatures = Vacature::query(array('posts_per_page' => 5));

Het resultaat is een Collection van posts.

Sorteren

Sorteer de resultaten door gebruik te maken van de orderby optie van WP_Query. De beschikbare sorteervolgordes zijn asc voor oplopend (A-Z) en desc voor aflopend (Z-A) en kunnen worden opgegeven door het veld en de ordering te scheiden met een dubbele punt. Meerdere velden kunnen worden opgegeven door ze te scheiden met een komma.
$vacatures = Vacature::query(array('orderby' => 'datum:desc,vereisten:asc'));

Zoeken

Om op vacatures met specifieke eisen te zoeken, kan Vacature::search() worden gebruikt. Vervolgens kan de zoekquery worden opgebouwd via chained method calls. Het is mogelijk om de aanroep tot search() weg te laten, alle ondersteunde calls zijn ook direct onder Vacatures beschikbaar.

// Alle vacatures met plaats Leeuwarden
$vacatures = Vacature::search()->where('organisatie', 'Tussendoor');
$vacatures = Vacature::search()->where('organisatie', '=', 'Tussendoor');
$vacatures = Vacature::where('organisatie', 'Tussendoor');

// Uitgebreid zoeken met meer eisen
$vacatures = Vacature::whereNotNull('organisatie')->where('arbeidsvoorwaarden', 'HBO')->whereSql('datum', '> DATE_SUB(NOW(), INTERVAL 1 WEEK)');

De volgende methodes zijn beschikbaar om zoektermen op te geven:

Methode	Beschrijving
where('veld', '=', $value)	Geef op dat veld een bepaalde waarde heeft. Operator = is standaard en kan worden weggelaten.
whereBetween('veld', $min, $max)	Geef op dat veld tussen $min en $max moet zijn.
whereNull('veld')	Geef op dat veld geen waarde mag hebben.
whereNonNull('veld')	Geef op dat veld een waarde moet hebben.
whereSql('veld', 'sql')	Gebruik een ruwe SQL clause als zoekopdracht.
matching($vacature->field, $operator = '=')	Zoek op vacatures met dezelfde waarde als $vacature->field, optioneel kan een operator worden opgegeven.
without($vacature, ...)	Neemt $vacature niet mee in de resultaten.

Daarnaast zijn de volgende methodes beschikbaar voor het opgeven van WordPress query argumenten, om bijvoorbeeld het aantal resultaten en de sorteervolgorde aan te passen:

Methode	Beschrijving
amount($n)	Beperkt het resultaat tot $n vacatures.
all()	Geef op dat alle vacatures opgehaald moeten worden.
order($field, $direction = 'asc')	Geef sorteervolgorde op.
ascending($field)	Geef oplopende sorteervolgorde op.
descending($field)	Geef aflopende sorteervolgorde op.
arg($key, $value)	Geef direct een WordPress query argument op.
args($args)	Geef direct WordPress query argumenten op.

Nesting

Zoektermen kunnen worden genest om te schakelen tussen and en or. Standaard moet aan alle zoektermen worden voldaan, maar door eerst push('or') en vervolgens pop() aan te roepen hoeft alleen aan minimaal één van de zoektermen ertussenin voldaan te worden.

// Zoek vacatures met een ingevulde organisatie, van de laatste week, met vereisten van HBO of VWO
$vacatures = Vacature::whereNotNull('organisatie')
  ->push('or')
  ->where('vereisten', '=', 'HBO')->where('vereisten', '=', 'VWO)
  ->pop()
  ->whereSql('datum', '> DATE_SUB(NOW(), INTERVAL 1 WEEK)');
    

Soortgelijke vacatures zoeken

Het is eenvoudig gemaakt om voor de huidige vacature, dus bijvoorbeeld binnen de template file single.php, te zoeken naar vacatures in dezelfde plaats. Geef hiertoe alleen het veld in:

// Zoek drie vacatures met dezelfde locatie als de huidige vacature
$vacatures = Vacature::matching($vacature->locatie->locatie)->amount(3);

Vacatures tellen

Soms is het alleen het aantal resultaten nodig.
$aantal = Vacature::whereSql('datum', '> DATE_SUB(NOW(), INTERVAL 1 WEEK)')->total();

---

Zoekvelden

Eerder heb je over het instellen van zoekvelden gelezen in het admin gedeelte van onze plugin, in dit gedeelte van de documentatie leggen we uit hoe je de ingestelde zoekvelden kunt koppelen aan de code in de search.php en daarnaast leggen we uit hoe je de zoekvelden kunt gebruiken.

Zoekvelden koppelen

In het admin gedeelte van de plugin kan je zoekvelden aanmaken, de naam die je het zoekveld daar geeft zorgt voor de koppeling. Een aantal voorbeelden.

Locatie: <?php Vacature::form()->dropdown('locatie'); ?>
Organisatie: <?php Vacature::form()->dropdown('organisatie'); ?>
Vereisten: <?php Vacature::form()->dropdown('vereisten'); ?>

Let er daarom goed op dat je de naam een duidelijke, maar simpele naam geeft.

Een naam met spaties, hoofdletters of bijzondere karakters kan voor onverwachte problemen zorgen.

Type zoekvelden

Zoekvelden aangemaakt vanuit de admin kunnen op verschillende manieren worden weergegeven.

Dropdown

<?php Vacature::form()->dropdown('naam', $options = []); ?>

De volgende mogelijkheden heb je in de options array:

Optie	Type	Standaard	Beschrijving
'emptyLabel'	string	''	Label van optie om zoekveld leeg te laten.
'showCounts'	bool	false	Weergave van aantal resultaten per optie.
'hideWhenNoResults'	bool	false	Verberg een optie als er 0 resultaten zijn.
'hideWhenNotExists'	bool	false	Verberg een optie als de waarde nooit resultaten zal geven.
'select'	array	[]	Extra HTML attributen voor de <select>.
'option'	array	[]	Extra HTML attributen voor <option> elementen.
'emptyOption'	array	[]	Extra HTML attributen voor <option> elementen, specifiek voor lege optie.

---

<?php Vacature::form()->minDropdown('naam', $options = []); ?>
<?php Vacature::form()->maxDropdown('naam', $options = []); ?>
<?php Vacature::form()->minMaxDropdown('naam', $options = []); ?>

Optie	Type	Standaard	Beschrijving
'emptyLabelMin'	string	''	Label van optie om zoekveld leeg te laten voor minimum dropdown.
'emptyLabelMax'	string	''	Label van optie om zoekveld leeg te laten voor maximum dropdown.

---

Checkboxes & Radio buttons

<?php Vacature::form()->checkboxes('naam', $options = []); ?>
<?php Vacature::form()->radios('naam', $options = []); ?>

Optie	Type	Standaard	Beschrijving
'showCounts'	bool	false	Weergave van aantal resultaten per optie.
'hideWhenNoResults'	bool	false	Verberg een optie als er 0 resultaten zijn.
'hideWhenNotExists'	bool	false	Verberg een optie als de waarde nooit resultaten zal geven.
'label'	array	[]	Extra HTML attributen voor <label> elementen.
'input'	array	[]	Extra HTML attributen voor <input> elementen.
'count'	array	[]	Extra HTML attributen voor de <span> om aantal resultaten in te tonen.

---

Verborgen input

<?php Vacature::form()->hidden('naam', $options = []); ?>

Optie	Type	Standaard	Beschrijving
'input'	array	[]	Extra HTML attributen voor de <input>.

Extra HTML attributen kunnen worden opgegeven via de opties, zoals in de tabellen staat beschreven. Voor nodes die specifiek zijn voor een bepaalde optie worden de placeholders {{label}}, {{value}} en {{count}} ingevuld met de label, waarde en aantal resultaten voor de optie. Dit kan bijvoorbeeld worden gebruikt om extra data-attributen op te geven welke door JavaScript plugins worden gebruikt om de weergave van de zoekvelden aan te passen.

---

Vrije input

Zoekvelden hebben een vast aantal opties en accepteren geen aangepaste waardes. Om bijvoorbeeld te kunnen zoeken op de titel van een vacature moet handmatig de query worden aangepast. Als HTML fragment kan het volgende worden gebruikt:

<input type="text" name="titel" value="<?= Vacature::form()->value('titel'); ?>">

Om vervolgens het adres op de query toe te passen moet een event listener worden toegevoegd om de query te wijzigen:

Vacature::listen('search.before', function($form, $query)
{
    if ($title = $form->value('titel'))
    {
        $query->compare('titel', 'like', '%'.str_replace(' ', '%', $title).'%');
    }
});

De query kan in alle mogelijke constructies worden beinvloed:

Operator	Code
IS NULL	$query->isNull('veld')
IS NOT NULL	$query->isNotNull('veld')
BETWEEN	$query->between('veld', $min, $max)
SQL	$query->sql('veld', '> NOW()')
=, <>, <, >, …	$query->compare('veld', $operator, $value)

Een geneste groep kan worden begonnen met $query->push('and|or'), waarna opvolgende declaraties binnen die groep worden toegepast. Een groep moet worden afgesloten met $query->pop().

---

Nieuwe types toevoegen

Voor meer controle over de HTML kunnen nieuwe types worden gemaakt. De standaard types zijn makkelijk aanpasbaar door ze te subclassen en voor de gewenste methods een aangepaste implementatie te schrijven.

class CustomRenderer extends CustomPost\Search\Renderers\Dropdown
{
    // ...
}

Vacature::form()->render('naam', new CustomRenderer($options = []));

Door de subclass te registreren onder een bepaalde identifier kan het nieuwe/aangepaste type eenvoudiger worden gebruikt:

CustomPost\Search\Form::register('identifier', 'CustomRenderer');

Vacature::form()->identifier('naam', $options = []);

Daarnaast is het ook mogelijk om bestaande types aan te passen zodat je meer vrijheid hebt in de vormgeving. In het onderstaande voorbeeld kan je zien hoe je een span toe kan voegen om het label binnen checkboxes en radios, hiermee kan je bijvoorbeeld met een ::before of ::after de input vervangen voor een mooiere vormgeving.

// Checkboxes
use \CustomPost\Search\Option;

class CustomCheckboxes extends \CustomPost\Search\Renderers\Checkboxes {
	protected function renderLabel(Option $option) {
		$option->setLabel('<span>' . $option->getLabel() . '</span>');
		parent::renderLabel($option);
	}
}

// Radios
class CustomRadios extends \CustomPost\Search\Renderers\Radios {
	protected function renderLabel(Option $option) {
		$option->setLabel('<span>' . $option->getLabel() . '</span>');
		parent::renderLabel($option);
	}
}
CustomPost\Search\Form::register('checkboxes', new CustomCheckboxes());
CustomPost\Search\Form::register('radios', new CustomRadios());

Voor meer informatie wordt aangeraden om contact met ons op te nemen. De standaard types bieden ruime mogelijkheden om via CSS aan te passen, alleen in uitzonderlijke gevallen zal een aangepast type noodzakelijk zijn.

---

Zoekopties vanuit Javascript

In enkele gevallen kan het handig zijn om alle opties van een zoekveld in Javascript beschikbaar te hebben, bijvoorbeeld om afhankelijke velden handmatig bij te kunnen werken als er geen gebruik wordt gemaakt van live bijwerken. Een geneste structuur, vooral geschikt voor een zoekveld met afhankelijkheden, kan in JSON formaat worden verkregen via:

Vacature::form()->options('organisatie')->json();

Dit geeft een JSON object waarbij alle opties onderverdeeld zijn onder de afhankelijke waarde waar de optie bij hoort. Als voorbeeld een zoekveld organisatie waarvan de waardes afhankelijk zijn van de geselecteerde plaats:

{
    "leeuwarden": [
        {"value": "tussendoor", "label": "Tussendoor"},
        {"value": "verbonden", "label": "Verbonden"}
    ],
    "groningen": [
        {"value": "vroem", "label": "Vroem"}
    ]
}

Het is echter ook mogelijk om alle opties in een vlakke lijst te krijgen:

Vacature::form()->options('organisatie')->flat()->json();

[
    {"value": "tussendoor", "label": "Tussendoor", "parents": {"locatie": "leeuwarden"}},
    {"value": "verbonden", "label": "Verbonden", "parents": {"locatie": "leeuwarden"}},
    {"value": "vroem", "label": "Vroem", "parents": {"locatie": "groningen"}}
]

In plaats van de opties in JSON representatie kan ook een PHP array worden opgevraagd via get() in plaats van json().

Voorbeeld

Als voorbeeld een manier om een dropdown voor het zoekveld organisatie bij te werken met de opties behorende bij een bepaalde locatie, nadat een andere locatie is geselecteerd. We geven hierbij alle opties in bovenstaande geneste structuur op via een HTML data-attribuut, zodat dit vervolgens vanuit Javascript beschikbaar is.

<?php Vacature::form()->dropdown('organisatie', array(
    'emptyLabel' => 'Organisatie',
    'select' => array(
        'data-options' => Vacature::form()->options('locatie')->json(),
    ),
)); ?>

Het onderstaande is de minimaal benodigde Javascript om de dropdown bij te werken:

$('#locatie').change(function() {
    var locatie = $(this), organisatie = $('#organisatie');

    organisatie.empty().append($('<option></option>').attr('value', '').text('Organisatie'));

    $.each(organisatie.data('options')[locatie.val()] || [], function(option) {
        organisatie.append($('<option></option>').attr('value', option.value).text(option.label));
    });
});

---

Resultaten sorteren

Binnen het Admin gedeelte van de documentatie heb je kunnen lezen hoe je sorteer opties kunt toevoegen, dit doe namelijk via de geavanceerde instellingen van de plugin. Om de bezoeker van de website de mogelijkheid te geven om te switchen tussen de door jou ingestelde opties moeten we een orderby veld vullen met opties.

Een lijst van de ingestelde sorteeropties is beschikbaar via Vacature::form()->orderings() en kan bijvoorbeeld worden gebuikt om een dropdown weer te geven:

<select name="orderby">
    <?php foreach (Vacature::form()->orderings() as $ordering): ?>
        <option value="<?= $ordering['orderby'] ?>" <?= selected($ordering['current']); ?>>
            <?= $ordering['label'] ?>
        </option>
    <?php endforeach; ?>
</select>

Als je in plaats van een dropdown buttons wil gebruiken kan bijvoorbeeld een verborgen input worden ingevoegd waarvan de waarde met JavaScript wordt aangepast:

<input type="hidden" name="orderby" id="orderby" value="<?= Vacature::form()->ordering(); ?>">

<?php foreach (Vacature::form()->orderings() as $ordering): ?>
    <a class="orderby" data-orderby="<?= $ordering['orderby'] ?>"><?= $ordering['label'] ?></a>
<?php endforeach; ?>

$(document).on('click', 'a.orderby', function() {
    var orderby = $(this).data('orderby'), current = $('#orderby').val();

    if (current !== orderby) {
        $('#orderby').val(orderby).trigger('change');
    }
}

In de vormgeving ben je vrij, zolang je maar de name orderby mee stuurt met de zoekopdracht. De plugin sorteert vervolgens de resultaten.

---

Hulpmiddelen

De plugin bevat ingebouwde hulpmiddelen die je kunnen helpen bij het ontwikkelen van je thema, hier lees je meer over deze hulpmiddelen.

Vacatures overslaan

ls alleen vacatures met bepaalde eigenschappen op de site moeten worden getoond kan tijdens het bijwerken aangegeven worden of een vacature al dan niet moet worden geïmporteerd. Dit kan worden bereikt door een filter toe te voegen welke bepaalt of de vacature moet worden overgeslagen, in dit voorbeeld moeten alleen vacatures met een salarisindicatie van meer dan €15 worden geïmporteerd:

Vacature::filter('updater.skip', function($skip, $vacature)
{
    return $vacature->arbeidsvoorwaarden->value() < 15;
});

De bovenstaande code kan je toevoegen binnen het onderstaande bestand:
/wp-content/themes/*active-theme*/ingoedebanen/functions.php

Het mechanisme werkt via de WordPress add_filter API, het eerste argument $skip  is standaard false. Want zonder dit filter willen we immers alle vacatures uit de feed importeren. Dit is de reden dat we return true doen op het moment dat een vacature aan onze eisen voldoet.

Post Collections

Ingebouwde query resultaten zijn van het type QueryCollection, een gebruiksvriendelijke interface in plaats van het standaard WordPress WP_Query object. Dit biedt een aantal voordelen, zo zijn alle methods uit Illuminate’s Collection class beschikbaar, en blijven ook alle properties en methods van WP_Query direct beschikbaar.

$vacatures = Vacature::search(...);

$vacatures->count(); // Aantal vacatures in resultaat, rekening houdende met pagination
$vacatures->total(); // Totaal aantal gevonden resultaten, zonder pagination
$vacatures->has(); // Of er resultaten zijn
$vacatures->isEmtpty();
$vacatures->first();
$vacatures->last();
$vacatures->random();
$vacatures->sample(3); // Collection van 3 random vacatures

Het WP_Query object is beschikbaar via $vacatures->getQuery(), al zijn alle properties en methods dus ook beschikbaar op de Collection zelf.

The loop

De Collection biedt een PHP iterator om de WordPress loop constructie niet handmatig uit te hoeven schrijven:

while ($vacatures->next()):
    // ...
endwhile;

Dit is equivalent aan de loop constructie:

while ($vacatures->have_posts()): $vacatures->the_post();
    // ...
endwhile;
wp_reset_postdata();

---

Media

Voor iedere vacature kan de bijbehorende media eenvoudig worden opgevraagd d.m.v. $vacature->media() met eventueel een argument om query opties in te geven:

$media = $vacature->media(array('posts_per_page' => 3));

Ook dit levert een Collection op.

---

Javascript

Vanuit de plugin is standaard ondersteuning om het zoeken interactief te maken. Het meegeleverde thema bevat enkele Javascript bestanden, in dit gedeelte van de plugin willen we duidelijk maken hoe deze kunnen worden gebruikt en wat alle opties zijn.

Template	Beschrijving
js/vacature/archive.js	Geregistreerd als vacature-archive en te enqueuen vanuit vacature/archive.php.
js/vacature/single.js	Geregistreerd als vacature-single en te enqueuen vanuit vacature/single.php.

---

Live bijwerken

Een van de voornaamste features van de plugin is het direct bijwerken van resultaten nadat een zoekveld van waarde is veranderd. Het principe is eenvoudig: vanuit Javascript worden alle wijzigingen opgemerkt en wordt het zoekformulier via AJAX verzonden, waarna het wordt verwerkt op de server. Deze stuurt een JSON response met de templates die vernieuwd moeten worden terug, zodat de nieuwe templates vervolgens in de DOM worden ingevoegd. Ook pagination links worden onderschept en verwerkt op dezelfde manier.

Een bijkomend voordeel van deze methode is dat een lange, lelijke en onduidelijke query string wordt voorkomen, doordat het formuleer wordt geëncodeerd in een hash welke aan de URL wordt toegevoegd. Hierdoor blijft de browsergeschiedenis intact en wordt bij het vernieuwen van de pagina de gewenste zoekopdracht weer uitgevoerd.

De plugin wordt ingeladen door custompost-liveform toe te voegen als script dependency, waarna initialisatie als volgt gebeurt:

var form = new CustomPost.LiveForm(options);

// Event handlers toevoegen

form.init();

Optie	Standaard	Beschrijving
'container'	'#entity-search-form'	DOM element of selector voor <form> container.
'els'	Zie Templates	Bepaalt welke templates moeten worden bijgewerkt in welke containers.
'pageLinkEls'	'.pagination a'	Selector voor pagination links.

Templates

Voor het bijwerken van de pagina worden de benodigde templates op de server gerendered en wordt de parent DOM vervangen met de nieuwe content. Via de optie 'els' kan worden opgegeven welke templates moeten worden bijgewerkt en de selector van de parent element, met een Javacript object met als key de naam van de template en als value de selector:

{
    search: '#entity-search',
    loop: '#entity-results'
}

Vanuit vacature/archive.php moeten deze templates dus als volgt worden gebruikt, waarbij de wrapper <div> alleen de template mag bevatten:

<div id="entity-search">
    <?= Vacature::template('search'); ?>
</div>

Er kunnen indien nodig dus nog meer templates worden ingeladen en vervangen, door ze in 'els' op te geven. De template met zoekvelden wordt bijgewerkt om zo het aantal resultaten per optie bij te werken.

Events

Om bepaalde acties uit te voeren wanneer specifieke events optreden kunnen event listeners worden toegevoegd. Zo moeten bijvoorbeeld Javascript widgets welke van toepassing zijn op elementen in de te vervangen templates iedere keer opnieuw worden geïnitialiseerd, omdat de volledige DOM structuur vervangen wordt.

Event	Argumenten	Beschrijving
'load'	data|null	Uitgevoerd bij initialisatie en nadat bijwerken is voltooid.
'updated'	data	Uitgevoerd nadat bijwerken is voltooid.
'refresh'		Uitgevoerd wanneer een refresh wordt gestart.
'before:replace'	data	Uitgevoerd net voordat de templates worden ingevoegd in hun DOM parents.
'after:replace'	data	Uitgevoerd direct nadat de templates zijn ingevoegd.
'request:data'	data, request	Geeft de mogelijkheid om extra data aan de request toe te voegen door data argument aan te passen.
'change:page'		Uitgevoerd wanneer van pagina wordt gewisseld.

De API voor het gebruik van events is als volgt:

form.on('event', function(e, ...) {
    // ...
});

form.off('event');

DOM Event delegation

We raden aan om DOM event listeners aan document toe te voegen en vervolgens te filteren op het gewenste element. Hierdoor hoeft de listener maar één keer worden toegevoegd en niet bij iedere 'load' op de vernieuwde elementen:

$(document).on('click', 'a', function(e) {
    // ...
});

Pagination

Links om van pagina te wisselen moeten ook worden onderschept om een pagina reload te voorkomen. Met de optie 'pageLinkEls' kan de selector voor pagination links worden opgegeven, waarbij de plugin ook pagina wijzigingen via AJAX in zal laden. Ook wordt het event 'change:page' gegenereerd om een actie te ondernemen bij het wijzigen van de pagina.

Infinite scrollen

In plaats van pagination is het mogelijk om meer resultaten achteraf in te voegen, mogelijk automatisch wanneer de gebruiker het einde van de resultaten bereikt. Voeg hiertoe alleen een link in naar de volgende pagina, met de class infinite-results of een van de parents moet deze class toegekend krijgen. Extra vacatures zullen vervolgens achteraan in options.infinite.appendTo (met standaardwaarde #entity-items) worden ingevoegd, waarbij per vacature de events before:append en after:append worden uitgevoerd met het DOM element van de vacature als extra parameter. Vanuit deze events kunnen bijvoorbeeld animaties worden opgegeven of overige widgets worden geinitialiseerd. Alle overige events zijn als volgt:

Event	Argumenten	Beschrijving
'before:append'	item	Uitgevoerd net voordat een vacature wordt toegevoegd in de DOM.
'after:append'	item	Uitgevoerd direct nadat een vacature is ingevoegd.
'appended'	data	Uitgevoerd direct nadat alle vacatures zijn ingevoegd.
'infinite:end'	data	Uitgevoerd wanneer alle resultaten zijn ingeladen.
'append:page'		Uitgevoerd wanneer meer resultaten worden opgehaald.

De events before:replace, after:replace, change:page en updated komen te vervallen en verder zal het load event alleen bij initialisatie worden uitgevoerd en niet meer voor nieuwe resultaten.

Als voor een vacature ongeldige HTML wordt gegenereert zal er geen DOM element aangemaakt kunnen worden, met als gevolg dat er vanuit liveform.js een fout optreedt. Ga in dat geval na of alle elementen wel worden gesloten en of dit in de correcte volgorde gebeurt.

Voor ieder resultaat zal de template item worden gerendered en worden ingevoegd in de DOM. De template per vacature kan worden aangepast door options.infinite.template te wijzigen in het gewenste template. Om infinite scrollen te bereiken moet een klik-event op de pagination link handmatig worden uitgevoerd, zodat automatisch de juiste pagina aan extra resultaten geladen wordt. De pagination link moet verplicht zijn opgenomen in de DOM maar kan uiteraard verborgen worden indien gewenst. Voorbeeldcode om dit te bereiken is als volgt:

var scrolled = false, $window = $(window);
$window.scroll(function() { scrolled = true; });

setInterval(function() {
    if (scrolled && !form.isLoading() && $window.scrollTop() + $window.height() >= form.$el.offset().top + form.$el.height()) {
        $('.infinite-results a, a.infinite-results').click();
    }
    scrolled = false;
}, 100);

Laad indicatie

Tijdens het wachten op resultaten van de server krijgt de container <form> de class search-loading toegewezen. Vanuit CSS kan dit bijvoorbeeld worden gebruikt om laad indicaties op het juiste moment zichtbaar te maken.

---

Widgets

Er zijn standaard een aantal widgets beschikbaar om de functionaliteit van zoekvelden uit te breiden.

Sliders

Om een slider weer te geven worden de opties van een dropdown gebruikt, er wordt een jQuery slider widget toegevoegd in de DOM welke in sync blijft met de dropdown. Hierdoor is het eenvoudig om de dropdown te blijven tonen voor bijv. mobiele devices en de slider alleen zichtbaar te maken voor desktops, aan de hand van responsive CSS rules. Voor gebruik van deze widget, voeg custompost-slider toe als script dependency en initialiseer de widget als volgt:

new CustomPost.Slider(options);

Optie	Standaard	Beschrijving
'container'	Verplicht	DOM element of selector voor label container.
'type'	'min'	Bepaalt het type slider, 'min' of 'max'.
'select'	'select'	DOM element of selector voor gekoppelde dropdown.
'emptyLabel'	null	Label wanneer geen minimum/maximum is ingesteld, standaard bepaald a.d.h.v. lege optie in gekoppelde dropdown.
'optionLabelAttribute'	null	Biedt de mogelijkheid om HTML label te gebruiken zoals opgegeven in data attribuut van de <option>. Standaard wordt simpelweg de optie’s label gebruikt.
'sliderOptions'	{}	Geef extra opties op voor de jQuery slider widget.

Bij initialisatie wordt een extra wrapper toegevoegd aan de opgegeven container, met de volgende opmaak:

<div class="slider-container">
    <div class="slider-values">
        <div class="value low|high"></div>
    </div>
    <div class="slider"></div>
</div>

De class van div.value is low wanneer 'type' = 'min', voor 'type' = 'max' wordt de class high gebruikt. Hierin wordt de huidige waarde van het veld weergegeven. Tijdens verplaatsen van de handle krijgt de container de class tracking toegewezen, en tracking-low/tracking-high voor respectievelijk min/max types.

Range sliders

Naast sliders met een enkele handle kan ook een dubbele handle worden gebruikt, om zowel een minimum als maximum op te geven. Range sliders moeten los van sliders worden opgegeven met custompost-rangeslider als dependency.

new CustomPost.RangeSlider(options);

Optie	Standaard	Beschrijving
'container'	Verplicht	DOM element of selector voor label container.
'minSelect'	'select[id$="-min"]'	DOM element of selector voor gekoppelde dropdown voor minimum waarde.
'maxSelect'	'select[id$="-max"]'	DOM element of selector voor gekoppelde dropdown voor maximum waarde.
'minLabel'	null	Label wanneer geen minimum is ingesteld, standaard bepaald a.d.h.v. lege optie in gekoppelde dropdown.
'maxLabel'	null	Label wanneer geen maximum is ingesteld, standaard bepaald a.d.h.v. lege optie in gekoppelde dropdown.
'optionLabelAttribute'	null	Biedt de mogelijkheid om HTML label te gebruiken zoals opgegeven in data attribuut van de <option>. Standaard wordt simpelweg de optie’s label gebruikt.
'sliderOptions'	{}	Geef extra opties op voor de jQuery slider widget.

Nu zullen zowel div.value.low als div.value.high beschikbaar zijn, de eerste toont het label van de minimum waarde en de laatste bevat het label van de maximum waarde.

Show more

Deze widget is bedoeld in combinatie met een lijst van checkboxes/radios, om in eerste instantie slechts een beperkt aantal opties te tonen en de resterende opties pas later weer te geven.

De hoeveelheid altijd zichtbare opties kan worden ingesteld op een vast aantal, of afgeleid worden van de alfabetische volgorde van de opties. Zo kunnen primaire opties op alfabet voor secundaire opties worden geplaatst, waardoor automatisch de grens tussen primair en secundair bepaald kan worden.

De widget wordt ingeladen door custompost-showmore op te geven als script dependency, hoeft verder alleen te worden geinitialiseerd:

new CustomPost.ShowMore(options);

Optie	Standaard	Beschrijving
'container'	Verplicht	jQuery element of DOM selector voor label container.
'name'	Verplicht	Unieke naam van de lijst.
'moreText'	'More...'	Tekst welke wordt weergegeven als niet alle opties worden weergegeven.
'lessText'	'Less'	Tekst welke wordt weergegeven als wel alle opties worden weergegeven.
'defaultAmount'	0	Het aantal te tonen opties als primair, of 0 om af te leiden van de opties.

De naam is verplicht in verband met het onthouden van de state, waarop wordt teruggevallen bij herinitialisatie tijdens live bijwerken zodat de widget in de juiste state hersteld wordt.

Wat betreft HTML structuur wordt een lijst van labels verwacht, genest in een container. Bij initialisatie wordt een
<a class="show-more-toggle"> element toegevoegd aan het einde van de container, waarvan de click events de secundaire opties tonen/verbergen. Als alleen de primaire opties worden weergegeven wordt de tekst options.moreText weergegeven en heeft dit element de class less, bij tonen van de secundaire opties verandert de tekst in options.lessText en de class in more.

Velden

Tijdens de ontwikkeling van het thema kunnen de onderstaande velden in de page templates gebruikt worden om informatie van de vacatures te tonen.

Veld	Naam	Type
Id	id	Integer
Actie	actie	String
Datum	datum	DateTime
Titel	titel	String
Organisatie	organisatie	String
Referentie	referentie	String
Bedrijfs beschrijving	bedrijfsBeschrijving	Text
Beschrijving	beschrijving	Text
Vereisten	vereisten	Text
Arbeidsvoorwaarden	arbeidsvoorwaarden	Text
Solicitatieprocedure	solicitatieprocedure	Text
Logo	logo	String
contact	contact	Subtype
Organisatie	contact.organisatie	String
Naam	contact.naam	String
Adres	contact.adres	String
Postcode	contact.postcode	String
Plaats	contact.plaats	String
Telefoon	contact.telefoon	String
Email	contact.email	String
Fax	contact.fax	String
Vacature url	contact.vacatureUrl	String
Sollicitatie url	contact.sollicitatieUrl	String
locatie	locatie	Subtype
Locatie	locatie.locatie	String
Postcode	locatie.postcode	String