Benamite - Revision history

Timb: /* Variabele entry */

2018-02-13T21:29:52Z

‎Variabele entry

Timb at 17:37, 13 February 2018

2018-02-13T17:37:40Z

Timb: /* Waarschuwing voor het aanpassen */

2017-12-08T08:59:51Z

‎Waarschuwing voor het aanpassen

Timb: /* PHP Haak */

2017-10-23T19:09:54Z

‎PHP Haak

Daanr: /* Benamite */ Typo'tje.

2017-10-04T23:00:55Z

‎Benamite: Typo'tje.

Daanr: Fix een verkeerd vervoegde persoonsvorm. Foei!

2017-10-04T22:53:02Z

Fix een verkeerd vervoegde persoonsvorm. Foei!

Daanr: /* Soorten entries */ Verwijder de kolom met icoontjes - het is te veel gedoe om Font Awesome erin te krijgen

2017-06-01T20:12:53Z

‎Soorten entries: Verwijder de kolom met icoontjes - het is te veel gedoe om Font Awesome erin te krijgen

Daanr: /* Documentatie */ Importeer de documentatie van de publisherpagina

2017-05-18T23:03:38Z

‎Documentatie: Importeer de documentatie van de publisherpagina

Show changes

Daanr: Fix de link naar de benamite docs

2017-03-16T17:23:39Z

Fix de link naar de benamite docs

Timb: We gebruiken tegenwoordig git :D

2017-01-18T10:49:19Z

We gebruiken tegenwoordig git :D

@@ Line 150: / Line 150: @@
 Op het moment dat in een map een variabele entry staat, dan gaat Benamite (<code>hrefToReference</code>) die entry proberen aan te roepen indien er geen child is met de gegeven naam. Dit gebeurt via de functie [https://doxygen-www.a-eskwadraat.nl/classvfsEntryVariable.html#aa4d977e8c8924f44f67c202201af1cd8 vfsEntryVariable::checkUrl], met argument de naam van de child (dus de volgende filenaam in het hele pad). Deze functie returnt een boolean, of de variabele entry de gegeven naam accepteert. (Bijvoorbeeld: is dit een geldig lidnummer?) Dit gebeurt door de speciale functie aan te roepen.
-Aanroep van de speciale functie gebeurt als volgt: argument is een array van het pad van de childnaam, tot de root (bijvoorbeeld '/Service/Intern/Publisher/Vereniging/Commissies' heeft variabele entry '/Service/Intern/Publisher/*', dus dat wordt <code>['Vereniging', 'Publisher', 'Intern', 'Service']</code>). De returnwaarde van de speciale functie kan <code>false</code> zijn (voor "bestaat niet"), of een array met keys 'name' (verplicht, geeft de "juiste" childname die op het variabele stukje komt), 'displayName' (optioneel, defaulttitel van de HTMLPage) en 'access' (optioneel, of de gebruiker de entry mag bekijken). Deze worden door het entry-object overgenomen (wat goedgaat omdat deze entries gecached zijn) zodat bij de recursieve aanroep in <code>hrefToReference</code> netjes verder geresolved wordt.
+Aanroep van de speciale functie gebeurt als volgt: argument is een array van het pad van de childnaam, tot de root (bijvoorbeeld '/Service/Intern/Publisher/Vereniging/Commissies' heeft variabele entry '/Service/Intern/Publisher/*', dus dat wordt <code>['Vereniging', 'Publisher', 'Intern', 'Service']</code>). De returnwaarde van de speciale functie kan <code>false</code> zijn (voor "bestaat niet"), of een array met keys 'name' (verplicht, geeft de "juiste" childname die op het variabele stukje komt), 'displayName' (optioneel, defaulttitel van de HTMLPage) en 'access' (verplicht, of de gebruiker de entry mag bekijken). Sinds [https://git.a-eskwadraat.nl/webcie/website/pulls/19 deze pullrequest] kan je ook ipv 'name' een parameter 'rewrite' teruggeven, dat '*/Random/Tsjak' vervangt met '$rewrite'. Deze worden door het entry-object overgenomen (wat goedgaat omdat deze entries gecached zijn) zodat bij de recursieve aanroep in <code>hrefToReference</code> netjes verder geresolved wordt.
 == Aanpassingen in Benamite ==

@@ Line 16: / Line 16: @@
 * php haak verder toelichten
 === Soorten entries ===
@@ Line 146: / Line 145: @@
 [3] Sorry voor de brakke/ambigue notatie van mij... komt omdat een HOOK !isa MAP maar wel MAP isA HOOK
 == Aanpassingen in Benamite ==

@@ Line 7: / Line 7: @@
 * <code>/Vereniging/Commissies/*</code>, <code>/Activiteiten/*</code>, <code>/Onderwijs/Medezeggenschap</code>: [[Publisher]] gebruikt deze als hardcoded url's om rechten te checken.
 * <code>/*</code>: Update ook constanten van de vorm <code>BLA_HOME</code>.
 * <code>/*</code>: Zo'n beetje alle zoekmachines vinden het niet leuk als je pagina ineens 404 gaat geven.

@@ Line 124: / Line 124: @@
 Het is dus erg fijn als die addities niet gebruikt worden bij functie die niet bedoeld zijn voor gebruik in een PHP Haak.
-Zowel het menu
+'''Let op''' dat hooks niet meer in het menu terecht komen, behalve bookweb! Zoals de code in HtmlPage::Knopmenu zegt: "Boeken is nog de enig hook die we willen behouden".
-−
-een menu functie
 Het is dus mogelijk dat de diepste entry die we vinden een PHP Haak is en als dat zo is, is het mogelijk dat we nog een stukje URL over hebben welke verwerkt moet worden. Dat is dus precies wat de haak gaat doen. In de benamite UI interface kun je zien dat het speciale veld iets in de vorm van '/path/bestand:functie' moet zijn. '/path/bestand' is het bestand wat we gaan include, 'functie' is de ''prefix'' van de hook functies.

@@ Line 107: / Line 107: @@
 * page-&gt;start() ; content ; page-&gt;end()
-Denkend in ChopChop (WsW4) termen is de Controller logica die tenslote een View aanroept.
+Denkend in ChopChop (WsW4) termen is de Controller logica die tenslotte een View aanroept.
 Het bijzondere geval is de Variabel entry van nummer 5. De methode waar het speciale veld naar verwijst bepaald ofdat wat er in de URL is ingevuld valide en toegankelijk is. In het voorbeeld zou de functie alleen lidnr's toestaan van mensen die deelnemer zijn.

@@ Line 130: / Line 130: @@
 Het is dus mogelijk dat de diepste entry die we vinden een PHP Haak is en als dat zo is, is het mogelijk dat we nog een stukje URL over hebben welke verwerkt moet worden. Dat is dus precies wat de haak gaat doen. In de benamite UI interface kun je zien dat het speciale veld iets in de vorm van '/path/bestand:functie' moet zijn. '/path/bestand' is het bestand wat we gaan include, 'functie' is de ''prefix'' van de hook functies.
-Het verder verwerken van de URL en terug geven van content is namelijk een 'content hook' en daarom is de functie die in aangeroepen wordt 'functie_content'. Vb: de entry voor Leden heeft in het speciale veld staan: '/space/benamite/hooks/leden.php:leden', betekend dat de functie die aangeroepen gaat worden 'leden_content' is.
+Het verder verwerken van de URL en terug geven van content is namelijk een 'content hook' en daarom is de functie die in aangeroepen wordt 'functie_content'. Vb: de entry voor Leden heeft in het speciale veld staan: '/space/benamite/hooks/leden.php:leden', betekent dat de functie die aangeroepen gaat worden 'leden_content' is.
 De content functie krijgt als (enige/eerste) parameter een array met daarin de stukjes URL (welke gesplists was op '/') die nog verwerkt MOETEN worden. Let op de extra nadruk op moeten! Dit zal dus een van de eerste dingen zijn die de content functie gaat doen[2]. Denk bv aan heeft $rest geen/te veel/te weinig elementen, als je lidnr verwacht check ofdat ie ook echt geldig is, ...

@@ Line 22: / Line 22: @@
 {| class="wikitable"
 |-
-! Icoon !! Naam !! Klasse !! Toelichting
+! Naam !! Klasse !! Toelichting
 |-
-| [[Image:vfsdir.png]] || Map || <code>vfsEntryDir</code>
+| Map || <code>vfsEntryDir</code>
 | Deze entry kan andere entries bevatten.
 Verder kan een Map ook functioneren als zijnde een PHP Haak (zie hieronder). Als de Map zelf iets moet weergeven, maar geen Haak functionaliteit heeft, dan probeert hij dat te delegeren naar een sub-entry met de naam $INDEX ('<code>index.html</code>'). Als die sub-entry niet bestaat krijg je een 403.
 |-
-| [[Image:generic.png]] || Bestand (publisher) || <code>vfsEntryFile</code>
+| Bestand (publisher) || <code>vfsEntryFile</code>
 | Dit is een bestandje waarvan de inhoud in de DB zit.
 De inhoud kan alleen bewerkt worden via publisher. Dit is dus altijd een HTML pagina die binnen de website layout weergegeven wordt.
 |-
-| [[Image:binary.png]] || Bestand (geupload) || <code>vfsEntryUploaded</code>
+| Bestand (geupload) || <code>vfsEntryUploaded</code>
 | Dit is een bestand dat via publisher geupload is.
 De inhoud is opgeslagen onder <code>/srv/http/www/benamite_files</code>, voor het vinden wordt de hash van de content gebruikt. Als het bestand weer opgevraagd wordt dan wordt de content-mimetype gebruikt die de data had tijdens het uploaded.
 Uploaden kan alleen in de publisher interface.
 |-
-| [[Image:link.png]] || Link || <code>vfsEntryLink</code>
+| Link || <code>vfsEntryLink</code>
 | Doet een redirect naar een andere plek op onze website.
 In het speciale veld geef je aan waarnaar geredirect moet worden. Dit kan zowel een absoluut pad zijn (begint met <code>/</code>) of relatief ten opzichte van van de huidige locatie zijn.
 Voorbeeld van een relatieve link: stel link zelf is te vinden op <code>/foo/bar</code> en hij verwijst naar <code>aap/noot</code>, dan wordt je bij bezoeken van <code>http://a-eskwadraat.nl/foo/bar</code> geredirect naar <code>http://a-eskwadraat.nl/foo/aap/noot</code>.
 |-
-| [[Image:html.png]] || Bestand (op FS) || <code>vfsEntryInclude</code>
+| Bestand (op FS) || <code>vfsEntryInclude</code>
 | Dit levert een bestand van het filesystem (onder /srv/http/www/www/, dan $HOME/wwwdebug/www/) op.
 Er worden heuristieken toegepast om de content-type te bepalen. De belangrijkste heuristiek regel om te weten is dat als een bestand op .php eindigt, dan wordt deze ge<code>require_once</code>d.
@@ Line 48: / Line 48: @@
 De code in het bestand handelt het weergeven volledig af (inclusief de <code>-&gt;start()</code> en <code>-&gt;end()</code> aanroepen van de pagelayout).
 |-
-| [[Image:variabel.png]] || Variabel || <code>vfsEntryVar</code>
+| Variabel || <code>vfsEntryVar</code>
 | Deze entry heeft in de benamite UI altijd <code><nowiki>*</nowiki></code> als naam en staat ook altijd bovenaan gesorteerd. Deze entry krijgt pas een naam bij het verwerken van een URL (zie 'Werking' hieronder). In het speciale veld staat de functie die gebruikt wordt voor het valideren van de naam.
 Deze entry kan, net als een Map, sub-entries hebben.
 |-
-| [[Image:hook.png]] || PHP Haak || <code>vfsEntryHook</code>
+| PHP Haak || <code>vfsEntryHook</code>
 | Gedetaileerde uitleg over de hoe &amp; wat van deze entry soort staat aan het einde van dit document. Kort gezegd is het een combinatie van ''Map'' en ''Bestand (op FS)'', maar dan met nog wat extra functionaliteiten en eisen.
 |}

@@ Line 11: / Line 11: @@
 == Documentatie ==
-Kijk [https://www.a-eskwadraat.nl/Vereniging/Commissies/www/benamite.html/ hier] voor de documentatie van Benamite.
+Kijk [https://www.a-eskwadraat.nl/Vereniging/Commissies/webcie/benamite.html/ hier] voor de documentatie van Benamite.
 == Aanpassingen in Benamite ==

@@ Line 24: / Line 24: @@
 #./dump_website_struct.sh
 #cd ../
-#Check databasecontent.benamite.sql. Als dit klopt commit het dan. (Denk eraan om toe te voegen dat jij het hebt gecommit via "Committer: naam")
+#Check databasecontent.benamite.sql (gewoon met <code>git diff</code>). Als dit klopt commit het dan. (Denk eraan om toe te voegen dat jij het hebt gecommit via "Committer: naam")