Checkin in Joomla

1. De basis

1.1 Wat is de Check-in-component?

De Check-in-component (com_checkin) is Joomla's ingebouwde beheertool voor het vrijgeven van bewerkingslocks op databaserijen. Deze zit standaard in Joomla core sinds versie 1.6.

Kort samengevat doet het volgende:

• Het scant elke databasetabel waarvan de naam begint met jouw ingestelde prefix.
• Het toont de tabellen die de kolommen checked_out en checked_out_time bevatten én minstens één gelockte rij hebben.
• Het verwijdert de lock door beide kolommen terug te zetten naar hun standaardwaarde of NULL.

Zie het als de force-eject-knop voor vastgelopen records. Het is niet de normale manier waarop records worden ontgrendeld, dat gebeurt bij het opslaan van een record. Check-in ruimt alleen op wat het opslaan heeft gemist.

1.2 De bibliotheekboek-analogie

Het helpt om elk bewerkbaar record te zien als een bibliotheekboek:

• Het openen van het bewerkformulier = het lenen van het boek. Jouw naam komt op het kaartje.
• Klikken op Opslaan of Annuleren = het terugbrengen van het boek. Het kaartje wordt leeggemaakt.
• De browser sluiten tijdens het bewerken = weglopen met het boek. Het kaartje blijft op jouw naam staan, niemand anders kan het lenen.
• Global Check-in = de bibliothecaris loopt langs de schappen en wist elk kaartje waarvan de lener duidelijk vergeten is terug te komen.

1.3 Wat is een check-out eigenlijk?

Wanneer je een artikel opent voor bewerking (of een categorie, module of menu-item), schrijft Joomla een lock op rijniveau weg:

UPDATE #__content
   SET checked_out      = 42,                   -- jouw user id
       checked_out_time = '2026-05-27 14:23:00' -- nu
 WHERE id = 1234;

Zolang deze kolommen gevuld zijn, ziet iedere andere gebruiker die de rij opent een waarschuwing en kan deze niet opslaan. Wanneer je op Opslaan & Sluiten of Annuleren klikt, voert Joomla de bijbehorende check-in uit:

UPDATE #__content
   SET checked_out      = NULL,
       checked_out_time = NULL
 WHERE id = 1234;

De lock is verdwenen en de volgende editor kan de rij openen. Dit is het normale scenario. com_checkin is alleen nodig wanneer deze cyclus wordt onderbroken.

1.4 Waar vind ik het?

In de Joomla 6-backend is het pad:

System → Maintenance → Global Check-in

De component bevindt zich in administrator/components/com_checkin/. Er is bewust geen frontendmap. Er bestaat ook geen menu-itemtype of API-endpoint. Het is een tool voor Super Users.

3. Wanneer een lock blijft hangen

De check-in-stap wordt overgeslagen wanneer iets de editor onderbreekt:

• Het browsertabblad wordt gesloten zonder op Opslaan of Annuleren te klikken.
• De gebruikerssessie verloopt terwijl het bewerkformulier nog open staat.
• De browser crasht, de laptop gaat slapen, of de wifi valt weg tijdens het opslaan.
• Een PHP fatal error treedt op voordat de controller checkin() bereikt.
• Een tweede tabblad opent hetzelfde artikel, de check-in van het eerste tabblad wordt uitgevoerd, waarna het sluiten van het tweede tabblad de rij opnieuw gelockt achterlaat door de tweede check-out.

Het resultaat is in elk geval hetzelfde: een rij die als checked out gemarkeerd staat door een gebruiker die het item niet meer aan het bewerken is. Dat is het moment waarop Global Check-in zijn plaats in de toolbar verdient.

5. De editor-ervaring

5.1 Het lock-icoon in lijstweergaven

Open Content → Articles. Elke rij toont een klein lock-icoon naast de titel wanneer checked_out is ingesteld:

• Hover over het icoon, tooltip met de naam van de gebruiker en het tijdstip van check-out.
• Klik op het icoon, als je de juiste ACL-rechten op de rij hebt, wordt de rij direct ingecheckt.
• Zonder toestemming, de klik doet niets en de rij blijft gelockt.

Deze check-in per rij is de snelle route. Editors hoeven zelden Global Check-in te openen. Ze klikken gewoon op het lock-icoon in de artikellijst.

5.2 De lock-waarschuwing in het bewerkformulier

Als Editor B een artikel opent dat door Editor A wordt bewerkt, ziet B een gele melding bovenaan het formulier. B kan de gegevens nog steeds bekijken, maar de knop Opslaan is uitgeschakeld. B heeft dan drie opties:

1. Het tabblad sluiten en later terugkomen.
2. A vragen om op te slaan en te sluiten.
3. Een Super User vragen, of zelf op het lock-icoon klikken indien toegestaan, om de lock vrij te geven.

5.3 Per rij versus Global, kies het kleinste hulpmiddel

7. De onderliggende API

7.1 Waarom geen echte database-locks?

Joomla gebruikt bewust geen SELECT ... FOR UPDATE of tabel-locks voor editor-concurrency. Daar zijn meerdere redenen voor:

• Bewerkingssessies duren langer dan databaseverbindingen. Databases zijn geoptimaliseerd voor korte transacties, niet voor menselijke editsessies van twintig minuten. Een echte row lock die zolang actief blijft zou de connection pool uitputten. Joomla slaat de lock daarom op als metadata in de rij zelf.
• Cross-engine-portabiliteit. Joomla ondersteunt MySQL, MariaDB, PostgreSQL en SQL Server. Lock-mechanismen verschillen tussen deze systemen. Advisory columns werken overal hetzelfde, waardoor Joomla voorspelbaar en portable blijft.
• Geen deadlocks. Twee kolommen kunnen geen deadlock veroorzaken. Twee echte database-locks op dezelfde rij wel.
• Cluster-safe. De lockstatus staat in de database zelf, waardoor elke webnode dezelfde status ziet. Bestands- of geheugenlocks zouden falen in een load-balanced omgeving.
• Menselijk leesbaar. SELECT * FROM #__content WHERE checked_out IS NOT NULL is iets wat een developer gewoon kan uitvoeren. Het is leesbaar en eenvoudig te debuggen, administrators kunnen locks direct inspecteren.

7.2 Table::checkOut()

Elke Joomla-tabel die locking ondersteunt erft van Joomla\CMS\Table\Table, dat het volgende levert:

public function checkOut($userId, $pk = null): bool

De methode triggert een "before"-event, werkt de kolommen checked_out en checked_out_time bij en triggert daarna een "after"-event. Het integerveld checked_out bevat de user id, geen sessie-id. Daardoor kan Joomla tonen wie de lock bezit, inclusief naam, in de waarschuwing.

7.3 Table::checkIn()

De spiegelmethode wist de kolommen opnieuw:

public function checkIn($pk = null): bool

checkIn() wordt aangeroepen door:

• AdminModel::checkin(), de backendknoppen Opslaan en Annuleren.
• Table::store(), het normale opslagpad. Een record opslaan voert altijd een check-in uit.
• Table::delete(), vóór verwijdering, zodat een eventuele lock eerst wordt vrijgegeven.

Een succesvolle save is dus de normale manier waarop locks worden opgeheven. De Check-in-component ruimt alleen de achterblijvers op.

7.4 Table::isCheckedOut() en sessiemetadata

De controle die bepaalt of een waarschuwing wordt getoond is subtieler dan veel mensen denken. De methode isCheckedOut() raadpleegt de tabel #__session wanneer session tracking actief is:

if (Factory::getApplication()->get('session_metadata', true)) {
    // SELECT COUNT(userid) FROM #__session WHERE userid = $against
    // If 0 → the row is treated as not-checked-out,
    //         even though the columns are still filled in
}

In de praktijk betekent dit:

• Met session_metadata = true (de standaardinstelling), zodra de sessie van de lockende gebruiker eindigt, gedraagt de rij zich als ontgrendeld. De volgende editor kan het item openen en opslaan, ook al lijken de kolommen nog "gelockt".
• Met session_metadata = false vertrouwt de controle blind op de kolommen. Verouderde locks blokkeren dan daadwerkelijk andere editors totdat Global Check-in ze opruimt.

Veelgehoorde mythe: "Joomla geeft oude locks nooit automatisch vrij". De realiteit: met de standaardinstellingen past het gedrag zich al aan zodra sessies verlopen. Global Check-in en de scheduled task ruimen daarna alleen de kolommen op.

De instelling bevindt zich op System → Global Configuration → System → Session Settings → Track Session Metadata.

7.5 De vier table-events

Developers kunnen inhaken op de lock-lifecycle via vier events per rij:

7.6 Het component-event onAfterCheckin

Global Check-in triggert ook een eigen event nadat elke tabel is verwerkt. De eventklasse is Joomla\CMS\Event\Checkin\AfterCheckinEvent (Joomla 5.0 en later). Een typische subscriber:

public function onAfterCheckin(AfterCheckinEvent $event): void
{
    $table = $event->getTableName();
    Log::add("Global check-in cleared locks in {$table}", Log::INFO, 'audit');
}

Dit is handig voor compliance-logs, je wilt weten wie locks in bulk heeft vrijgegeven en wanneer. Let erop dat het event één keer per tabel wordt getriggerd, niet één keer per rij.

9. Rechten en ACL

9.1 De twee acties

De ACL van Check-in wordt ingesteld via System → Global Configuration → Permissions → Check-in:

Standaard erven alleen Super Users beide rechten. Je kunt een Site Manager-groep toegang geven door Manage toe te staan op com_checkin.

9.2 De permissie per rij is anders

Het vrijgeven van één enkele rij via het lock-icoon in een lijstweergave wordt bepaald door de component die eigenaar is van de rij, niet door com_checkin. Om een artikel via het icoon te ontgrendelen heb je de juiste rechten nodig op com_content, niet op com_checkin.

Een gebruiker met Manage-rechten op com_checkin kan dus wel een bulk check-in uitvoeren, maar mogelijk geen lock-icoon aanklikken op een individueel artikel. Beide routes gebruiken verschillende permissies.

9.3 Aanbevolen rollenmatrix

Global Check-in is een onderhoudsrecht, terwijl check-in per rij een contentbeheerrecht is.

11. Multi-server, API en headless

11.1 Load-balanced clusters

Omdat de lockstatus volledig in de database wordt opgeslagen, werkt Joomla check-in probleemloos in clustered hosting zonder extra configuratie:

• Editor A opent een rij op webnode A, checked_out wordt opgeslagen in de gedeelde database.
• De aanvraag van Editor B komt binnen op webnode B, dezelfde rij wordt geladen en de lock is zichtbaar.
• Beide nodes kunnen de check-in uitvoeren. Het resultaat is direct overal zichtbaar.

Sticky sessions zijn voor de lock zelf niet nodig.

11.2 De Web Services API

Joomla 4 en later bevatten een JSON API op /api/index.php/v1/. Dezelfde AdminModel-code stuurt zowel de API-endpoints als de backendformulieren aan, dus:

• Een PATCH op een artikel voert intern check-out, save en check-in uit.
• Een API-client die een artikel alleen leest plaatst geen lock.
• Een API-client die een artikel voor bewerking opent moet expliciet het check-out-endpoint aanroepen, daarna opslaan en vervolgens rekenen op automatische check-in.

De lock is adviserend. Een ruwe PATCH die check-out negeert slaagt gewoon en kan een lopende backendbewerking overschrijven. Als je een headless editor bovenop de API bouwt, ben je zelf verantwoordelijk voor het uitvoeren van check-out voordat het formulier wordt getoond, het tonen van de lockstatus in je UI en het uitvoeren van check-in wanneer de gebruiker weg navigeert.

11.3 CLI-scripts en directe SQL

De lock wordt afgedwongen door Joomla's PHP-code, niet door de database zelf. Dat betekent:

• CLI-scripts die direct Table::store() aanroepen omzeilen de lockcontrole tenzij ze eerst expliciet isCheckedOut() uitvoeren.
• Onderhoudsscripts met ruwe UPDATE-statements omzeilen het systeem volledig.
• Third-party migrators respecteren locks mogelijk niet. Wees voorzichtig wanneer editors actief zijn.

Als jouw CLI-script schrijft naar een tabel die check-in ondersteunt, toon dan wat beleefdheid en voer check-out en check-in uit rondom de write-operatie.

13. Best practices en cheat sheet

Als je maar een paar dingen uit dit artikel onthoudt, laat het dan deze zijn:

• Check-in is niet de primaire manier waarop een lock wordt verwijderd, opslaan is dat. De component bestaat voor situaties waarin opslaan nooit heeft plaatsgevonden.
• Kies altijd het kleinste hulpmiddel dat het probleem oplost: eerst het lock-icoon, daarna Global Check-in, daarna de scheduled task.
• Activeer plg_task_globalcheckin op productiesites met meerdere editors en gebruik een logische delay, 2 uur is een goed begin.
• De conventie bestaat uit twee kolommen: checked_out en checked_out_time. Elke tabel die deze bevat doet automatisch mee.
• De lock is adviserend. Ruwe SQL of onzorgvuldige CLI-scripts kunnen het systeem omzeilen.
• Met session_metadata = true (de standaardinstelling) gedragen verlopen sessies zich in de UI al als ontgrendeld, Global Check-in ruimt alleen de kolommen op.
• Subscribe op onAfterCheckin als je een audittrail nodig hebt.

Cheat sheet

ÉÉN RIJ ONTGRENDELEN    Klik op het lock-icoon in de lijstweergave
MEERDERE RIJEN          System → Maintenance → Global Check-in
AUTOMATISCH VRIJGEVEN   Activeer plg_task_globalcheckin, stel delay = 2 in
ONDERSTEUN HET ZELF     Voeg checked_out + checked_out_time toe
                        Extend Table en AdminModel
AUDIT WIE VRIJGAF       Subscribe op onAfterCheckin
CHECK-IN WEIGEREN       Subscribe op onTableBeforeCheckin
ALLE LOCKTABELLEN       INFORMATION_SCHEMA.COLUMNS WHERE COLUMN_NAME = 'checked_out'
LOCK DIAGNOSTICEREN     SELECT a.*, u.name FROM <table> a JOIN #__users u ON u.id = a.checked_out