[PHP] Wat is nou netjes?

[Kaastosti]

Ik heb een complete site in elkaar gezet met echt alles er op en er aan. Het is voor een project van school en ik krijg dan ook (met het hele team) een beoordeling van de code. Nou heb ik wat tijd over en perfectionist die ik ben wil ik de code netjes hebben. Volgens mij ben ik niet de enige die dat wel eens heeft...

Als ik als voorbeeld de stylesheet neem.. daar hebben we een php file van gemaakt, die we overal includen. Dat werkt in principe heel makkelijk, maar wordt deze dan niet teveel keren geladen?

Hetzelfde geldt voor verschillende acties. Die staan nu gewoon compleet getikt in het php-bestand, terwijl deze in principe ook als functie in een apart bestand ge-include zouden kunnen worden.

Nou vraag ik me dus af... wanneer loont het om dingen als een forum uitlezen in een aparte functie te bakken en die aanroepen met een aantal argumenten? Is het altijd netter om het zo te doen of is het is veel gevallen 'geoorloofd' om gewoon code neer te zetten?

Ik weet dat over smaak niet te twisten valt, maar er zullen vast mensen zijn hier die er een uitgesproken, en duidelijke, mening over hebben bring it on!

[djazete]

ik zou toch voor functies gaan.. iets (*kuch*) makkelijker te onderhouden.. wel minder 'leesbaar' voor een leek maar zeker overzichtelijker denk ik...

[dominic]

agree@djazete voor een groot gedeelte.

Splits je functionaliteiten op vanuit de basis en maak daar script libraries van die je op de juiste momenten gaat include. Bijvoorbeeld een script library die alles te maken heeft met forms, input fields en submitten etc. Misschien een andere script library voor alle visuele aspecten.

Op deze manier include je pas dingen wanneer je ze nodig hebt..

[Helmet]

templates zouden ook een goede optie zijn
ik gebruik yapter (www.yapter.com) voor mijn templates
het voordeel is dat je html en code gescheiden kunt houden waardoorhet geheel overzichtelijk is en je precies kunt bepalen wanneer code gebruikt moet worden en wanneer niet

[Kaastosti]

Okee maar ik begrijp hieruit dat ik dus een heleboel nieuwe bestanden krijg die een aantal functies bevatten. Dat maakt het geheel vanuit bestand-technisch perspectief niet echt overzichtelijker

Ik heb bijvoorbeeld voor de news-admin functies dezelfde nodig als die voor news, alleen zitten er een paar nieuwe bij. Naar hetzelfde bestand verwijzen zou minder bestanden opleveren, maar die admin-functies wil je eigenlijk bij je normale news hebben

[Helmet]

bij templates dus niet,
je krijgt bijvoorbeeld 1 bestand met de layout van je site (ingedeeld in blokken/sets) en 1 php bestand dat je uitvoer regelt

voorbeeld template
en php

[Kaastosti]

Templates zijn dus een nieuwe begrip voor mij binnen PHP
Ik ben er al een tijd mee bezig, maar heb tot nu toe alleen maar stylesheets gebruikt en een aantal externe functie bestanden. Ik begrijp ook uit bovenstaande posts dat er veel verschillende soorten templates zijn. De implementatie ervan ontgaat me echter. Is er een site waar dit heel duidelijk staat uitgelegd?

[Helmet]

Gaat over yapter
Yapter again (nederlands)
Templates (hoe en waarom?)

[Kaastosti]

Aha dat had ik nodig... ik heb nog een boel documentatie door te spitten, maar ik heb eindelijk iets wat ik leuk vind java en c++ vind ik maar nix, dit is een stapje makkelijker en misschien een goede opstap naar de manier van denken ...of niet, maar dat boeit niet.

Bedankt voor de hulp

[whoami]

Hmmm....
* whoami vindt het raar dat je je daar nu nog moet mee bezig houden.

Normaal gezien denk je na over hoe je uw programma gaat implementeren voordat je het werkelijk implementeert.

Om de lay-out van uw code consistent en goed leesbaar te houden, pas je best een 'coding style/guideline' toe. Hier vind je een aantal richtlijnen die je daarvoor kunt volgen.

[Johnny]

Als ik als voorbeeld de stylesheet neem.. daar hebben we een php file van gemaakt, die we overal includen. Dat werkt in principe heel makkelijk, maar wordt deze dan niet teveel keren geladen?

Waarom een stylesheet includen via PHP? Je kan toch ook gewoon dit gebruiken:

code:

<link rel="stylesheet" href="bestand.css" type="text/css">

Op die manier wordt het stylesheet gewoon door de browser gecached.

[Verwijderd]

ALS je voor een template engine kiest raad ik je smarty aan... erg veel functionaliteiten en is makkelijk uit te breiden. Aan de andere kant kan er bij smarty toch ook nog wel wat logica in de templates sluipen.

[MisterData]

Helmet schreef op 13 December 2002 @ 22:16:
templates zouden ook een goede optie zijn
ik gebruik yapter (www.yapter.com) voor mijn templates
het voordeel is dat je html en code gescheiden kunt houden waardoorhet geheel overzichtelijk is en je precies kunt bepalen wanneer code gebruikt moet worden en wanneer niet

*spam*

Ik heb mijn eigen template engine geschreven (stackbased), en die wordt al gebruikt op deze site. Onderaan staat de parsetime ervan. Het is even doorbijten (700 regels code) maar dan heb je ook wat en kun je alle HTML voorgoed van PHP scheiden Link naar een test-paginaatje: http://quatro.ath.cx/cms/include/tpltest.php

[ Voor 6% gewijzigd door MisterData op 14-12-2002 18:11 ]

[MisterData]

Johnny64 schreef op 14 December 2002 @ 13:25:
[...]

Waarom een stylesheet includen via PHP? Je kan toch ook gewoon dit gebruiken:

code:

<link rel="stylesheet" href="bestand.css" type="text/css">

Op die manier wordt het stylesheet gewoon door de browser gecached.

Ik denk dattie dit bedoelt:

HTML:

<link rel="stylesheet" href="stylesheets.php?name=default" type="text/css"/>

Zo wordt de stylesheet wel gecached (als je tenminste de goede headers meegeeft), en hou je de mogelijkheid voor skinning e.d. nog open

[ Voor 19% gewijzigd door MisterData op 15-12-2002 12:22 ]

[Helmet]

MisterData schreef op 14 December 2002 @ 18:10:
[...]


*spam*

Ik heb mijn eigen template engine geschreven (stackbased), en die wordt al gebruikt op deze site. Onderaan staat de parsetime ervan. Het is even doorbijten (700 regels code) maar dan heb je ook wat en kun je alle HTML voorgoed van PHP scheiden Link naar een test-paginaatje: http://quatro.ath.cx/cms/include/tpltest.php

ziet er goed uit, kun je ook je template eens laten zien ?

[MisterData]

Helmet schreef op 14 December 2002 @ 19:20:
[...]


ziet er goed uit, kun je ook je template eens laten zien ?

http://www.qprcostcontrol.nl/themes/ en dan alle .tpl files

[Helmet]

ziet er netjes uit

[MrC4u]

MisterData schreef op 14 December 2002 @ 19:16:
[...]

Ik denk dattie dit bedoelt:

PHP:

<link rel="stylesheet" href="stylesheets.php?name=default" type="text/css"/>

Zo wordt de stylesheet wel gecached (als je tenminste de goede headers meegeeft), en hou je de mogelijkheid voor skinning e.d. nog open

Dat moet gewoon in de Head sectie van de html code, en niet in de php-code:

code:

<head>
...
<link rel="stylesheet" href="bestand.css" type="text/css">
</head>

[Kaastosti]

Ik bedoel inderdaad dat ik in plaats van een .css file, een php file gebruik. Op die manier kan ik namelijk variabelen uit de database gebruiken in die stylesheet, waardoor ik via het admin-gedeelte de gebruikte kleuren op de site gemakkelijk aan kas passen.

Over het gebruik van stylesheets hoef je me niets uit te leggen die snap ik wel. Het ging me enkel om een mooie gestructureerde opbouw en daar lijken die templates me erg bij te helpen. Ik zal alle gegeven links bekijken... wat de beste is laat ik in het midden, aangezien ik ze zelf niet allemaal ga testen.

Ik kan me ook niet voorstellen dat alle mensen die hier een specifieke template prediken ook alle mogelijke soorten hebben getest en deze het beste vonden. Ik verwacht in dit geval dat mensen een template hebben gebruikt, deze erg prettig en strak vonden, en deze vervolgens als 'beste' bestempelen ...correct me if I'm wrong

[MisterData]

Mrc4U schreef op 14 December 2002 @ 23:32:
[...]


Dat moet gewoon in de Head sectie van de html code, en niet in de php-code:

code:

<head>
...
<link rel="stylesheet" href="bestand.css" type="text/css">
</head>

Klopt, maar de php-tags zetten er automatisch '<?' en '?>' voor, terwijl dat niet de bedoeling was Ik pas het even aan.

[Verwijderd]

ik gooi m'n style sheet nooit in 1 file die ik dan include, maar ik gooi hem in een functie die 't gewoon echo't.. voordeel hierbij is dit:

een include is traag (ga het eens meten met php).. teveel includes maken je page echt sloom (en niet iedereen heeft een scsi-raid configuratie).

als je een css file include vanuit je html code geeft dit ook een nadeel.. mensen met een kloteverbinding zullen het herkennen dat pages met een gelinkte css file er soms kut uit zal zien omdat de css file niet is gedownload. als je je css code direct echo't in je html code zal dit probleem uiteraard opgelost zijn..


wanneer functies gebruiken ? als je functionaliteit hebt die je vaker gebruikt dan 1 keer. wanneer die functie in een include-file zetten ? als de functie vaker vanuit meerdere files kan worden gebruikt, en anders niet ! maar maak dus niet voor ieder functietje een file die je include (want zoals ik al zei: traag !)

functies kunnen ook bij eenmalig gebruik handig zijn ivm de handigheid van "return". (16 keer false returnen bij allerlei error-situaties bijvoorbeeld en op het eind een true returnen... dit kan gigantisch schelen in 't nesten van if-statements en maakt je code er dan dus een stuk duidelijker op)..

succes ermee

[Verwijderd]

extra voordeel trouwens bij het genereren van je CSS code middels een functie is dat je die functie parameters mee kunt geven die je CSS code dan kunnen beinvloeden.. stukje extra functionaliteit dus.

[Kaastosti]

Maar volgens mij denken mensen hier nog steeds dat ik een php file als css gebruik en die dan include... dat is dus niet zo. Ik gebruik de 'normale' manier om een stylesheet te gebruiken, alleen in plaats van style.css noem ik 'm style.php. Ik include 'm dus niet, maar roep 'm standaard aan. Het verschil is echter dat het bestand eerst door de parser heengaat, waardoor alle variabelen uit de database geplukt kunnen worden.

Ik zal in het vervolg meer templates en functies gaan gebruiken, maar ben tot de conclusie gekomen dat ik m'n team niet blij maak als ik dat alles nu nog implementeer, aangezien we volgende week oplevering hebben... kunnen ze overnieuw gaan leren

[Helmet]

het is idd iets wat je vooraf moet beslissen

[Kaastosti]

Jah ik weet 't... maar toen ik er mee startte zo'n maand terug wist ik nog niet eens van het bestaan van templates af ik ben gaandeweg me meer in php gaan verdiepen en kom het dus nu pas tegen. Ook wil ik van die frames af, alleen ben ik (nog) niet vaardig in het werken met links in tabellen... ik heb de komende tijd wat te doen

[pjonk]

Een aantal zaken die ik belangrijk vind bij het netjes in PHP programmeren:
- Werken met templates HTML en PHP code dus gescheiden houden.
- Je PHP code zoveel mogelijk opdelen in functies. Door deze in een include file te zetten kan je alles mooi overzichtelijk houden en worden je PHP scripts niet lang. Hoe meer regels je PHP script bevat des te moeilijker leesbaar wordt het script.
- Werken met error reporting E_ALL en register globals off.
- consistent gebruik van hoofdletters of kleine letters bij variabele en functienamen
- En uiteraard je PHP script voorzien van voldoende commentaar

[Verwijderd]

luistert nou es

templates zijn traag

1 of 2 per page gebruiken okay, maar ga niet alles met includes aan elkaar hangen.. is gewoon niet zo slim..

ik meen me te herinneren dat een meting van mij opleverde dat hij er op die machine 0,15 seconden voor nodig had om een willekeurige file te includen.

doe dit met 6 files en je zit al aan een seconde, zonder dat er ook maar iets is geparsed.. ik weet niet meer op welke machine ik dit gebenched had destijds, maar 't gaat hier een beetje om 't idee.. 't is een vertragende factor die je niet moet vergeten.

[pjonk]

Verwijderd schreef op 15 december 2002 @ 16:54:
luistert nou es

templates zijn traag

1 of 2 per page gebruiken okay, maar ga niet alles met includes aan elkaar hangen.. is gewoon niet zo slim..

ik meen me te herinneren dat een meting van mij opleverde dat hij er op die machine 0,15 seconden voor nodig had om een willekeurige file te includen.

doe dit met 6 files en je zit al aan een seconde, zonder dat er ook maar iets is geparsed.. ik weet niet meer op welke machine ik dit gebenched had destijds, maar 't gaat hier een beetje om 't idee.. 't is een vertragende factor die je niet moet vergeten.

Als je veel functies hebt moet je ook niet alles in 1 include file proppen, want dan wordt het traag ja.
Ik ben met een site bezig waar ik 1 common.php gebruik (450 regels) lang en ik merk weinig qua performance verlies.
Overigens wordt je PHP script eerder traag van te veel of inefficiente database queries.

[Helmet]

Kaastosti schreef op 15 december 2002 @ 16:44:
Jah ik weet 't... maar toen ik er mee startte zo'n maand terug wist ik nog niet eens van het bestaan van templates af ik ben gaandeweg me meer in php gaan verdiepen en kom het dus nu pas tegen. Ook wil ik van die frames af, alleen ben ik (nog) niet vaardig in het werken met links in tabellen... ik heb de komende tijd wat te doen

je kan natuurlijk ook gewoon met <div> tags werken is net zo handig en heeft minder nadelen dan tables

[Verwijderd]

JonkieXL: wie heeft 't hier over queries ? ik draag iets aan wat behoorlijk vertragend werkt, kom dat niet ontkrachten met langzame database queries ... je spreekt jezelf ook behoorlijk tegen "moet je ook niet alles in 1 include file proppen" en "Ik ben met een site bezig waar ik 1 common.php gebruik"..

ik volg zelf ook het principe van het groeperen van veel gebruikte functies in 1 file.. dat vertraagt minimaal. het gebruik van templates echter (waar het hier initieel) om ging kan ik echter niet zo zeer toejuichen...

[Shagura]

Verwijderd schreef op 15 december 2002 @ 21:22:
JonkieXL: wie heeft 't hier over queries ? ik draag iets aan wat behoorlijk vertragend werkt, kom dat niet ontkrachten met langzame database queries ... je spreekt jezelf ook behoorlijk tegen "moet je ook niet alles in 1 include file proppen" en "Ik ben met een site bezig waar ik 1 common.php gebruik"..

ik volg zelf ook het principe van het groeperen van veel gebruikte functies in 1 file.. dat vertraagt minimaal. het gebruik van templates echter (waar het hier initieel) om ging kan ik echter niet zo zeer toejuichen...

Dat vind ik er ook maar aan liggen of je voor snelheid of functionaliteit/leesbaarheid gaat. Jij zit hier te prediken dat snelheid o zo belangrijk is en dat alles daarvoor moet wijken, maar daar ben ik het niet mee eens.

Zo is de leesbaarheid van je code (voor mij iig) ook belangrijk, omdat je dan alles makkelijk kan overzien en aanpassen. Zo snap je na een tijdje aan een site gewerkt te hebben je eigen code ook nog (ik had er altijd een handje van om mijn code zo vaag te maken dat ik het na een tijdje zelf niet meer snapte ).

[Verwijderd]

shagura: waar predik ik dat ? wat een onzin.. zo code ik zelf ook helemaal niet

als je templates nodig hebt om je code leesbaar te maken moet je eens richting object georienteerd programmeren gaan neigen denk ik.. functionaliteit abstraheren, dan hou je ruimte over voor content zodat je geen friggin content-"templates" nodig hebt..

ik heb er geen moeite mee m'n eigen code te snappen na een half jaar of zo, jij blijkbaar wel.. wie doet 't hier goed en wie doet 't fout ?

[Kaastosti]

Niemand doet hier iets goed of fout denk ik. Het gaat hier om een mening, en iedereen mag uiteraard een eigen mening hebben. Ik zie in templates zowel voor- als nadelen, die hier ook al eerder genoemd zijn. De discussie die hier nu gehouden wordt over het al-dan-niet stom zijn van gebruikers is niet de bedoeling natuurlijk... als jij na een half jaar nog steeds je complete code kunt onthouden en uitleggen.. bravo.. werkelijk geweldig..

Ikzelf zie het nut van het structureren van de code echter wel en daarom zit ik dus nu ook met die templates te klooien.

Laten we deze discussie bij deze maar sluiten, aangezien het nu meer gaat over GoT-ers zelf dan over de eigenlijke vraag, die al lang beantwoord is. Ik ben blij met alle reacties (zijn er nog best veel ook), dank daarvoor ik ben weer een stuk verder, maar het raakt een beetje off-topic

[Genoil]

Dank abraxas voor het linked CSS verhaal! ik ben nu bezig met een OO-based "sitebakmachine", waarmee ik pagina's generereer adhv een objecthierarchie met daaraan hangende (PHP) templates en stylesheets. Per template-node gebruik ik nu aparte CSS files, waardoor ik dus relatief veel CSS files moet linken per pagina. Beter dus om deze CSS files te "fopenen" en in de HTML-HEAD te dumpen? Worden dat dan wel behoorlijk gecached? Ik bedoel, als de URL van de pagina ook maar met 1 parameter verandert, denkt ie alles weer te moeten downloaden. Ik ging er vanuit dat 1maal gelinkte CSS files netjes gecached werden?

[Verwijderd]

dat is ook zo, die paar regels css worden niet gecached op mijn manier.. mij persoonlijk zal dat eigenlijk worst wezen.. gzencode() je pages en tis toch allemaal 6 keer kleiner

[Kaastosti]

gzencode() ?

[Verwijderd]

ik zou echt zoveel mogelijk in functies zetten, die je dan overal include. Als je dan eens een keer wat moet veranderen dan hoef je niet alle files na te pluizen.

[Verwijderd]

Het is inderdaad erg handig om verschillende functies die bij elkaar horen in een bestand te zetten.
Het gebruik van templates is aan te raden als je samenwerkt met grafisch ontwerpers of mensen die niks snappen van php maar wel van html. Dan hoeven ze alleen rekening te houden met je tags.
Ik heb ook een eigen template parser in php gemaakt. Het is inderdaad stuk performance dat je verliest. Maar doordat je een caching mechanisme gebruikt is dit weer op te lossen.
Er zit ook nog een simpele UBB code parser in die ervoor zorgt dat product omschrijvingen met een kleurtje en opmaak op het scherm gezet kunnen worden.
Nog leuker wordt het als je een IFrame gebruikt om een richt text editor te maken in je backoffice. Maar dat is OT hier.

Het laden van gecachte paginas gaat in ieder geval stuk sneller. Je leest direct html bestand uit. De eerste bezoeker heeft een wat tragere site omdat de paginas geparsed en gecached moeten worden maar de volgende heeft een rete snelle site.
Met een browse tooltje kun je dit ook weer voorkomen.

[ Voor 35% gewijzigd door Verwijderd op 17-12-2002 14:40 ]

[MisterData]

Verwijderd schreef op 15 December 2002 @ 16:54:
luistert nou es

templates zijn traag

Ow ja? Ik heb een stackbased-template-parser, en die doet het toch redelijk snel hoor Kijk maar es onderaan bij tpl: op www.qprcostcontrol.nl De templates van die site staan hier: www.qprcostcontrol.nl/themes/

1 of 2 per page gebruiken okay, maar ga niet alles met includes aan elkaar hangen.. is gewoon niet zo slim..

Misschien juist wel, als je het slim gebruikt hoef je niet te includen wat je niet gebruikt en dat scheelt zeer zeker wel snelheid.

ik meen me te herinneren dat een meting van mij opleverde dat hij er op die machine 0,15 seconden voor nodig had om een willekeurige file te includen.

doe dit met 6 files en je zit al aan een seconde, zonder dat er ook maar iets is geparsed.. ik weet niet meer op welke machine ik dit gebenched had destijds, maar 't gaat hier een beetje om 't idee.. 't is een vertragende factor die je niet moet vergeten.

Kan bijna niet, ik include net zoveel files en ik haal de tiende seconde niet eens

[Genoil]

ik gebruik gewoon PHP als template parser. kwestie van een beetje streng tegen jezelf zijn qua scheiding logica en dynamische pagina content. verder include ik me ziek en doe ik niet aan caching. ik geef meer om snelle ontwikkeltijd dan om snelle parsetijd

[Kaastosti]

Misschien een idee om hier deze vraag ook te stellen, aangezien veel mensen hier bekend zijn met templates...

Ik gebruik nu FastTemplate en ben een eindje op weg. Alleen kan ik geen loop gebruiken. Wat is er aan de hand:

In pagina.tpl wordt een pagina geschetst met daarin een table voor in de index van het forum.
In forum_index.tpl wordt een rij gemaakt waarin waarden uit een database moeten komen.
In index.php worden aan de variabelen waarden gegeven, forum_index geparsed en ge-FastPrint (dus elke rij opnieuw).

Ik krijg alle gegevens achter elkaar, op de laatste na. Die wordt netjes in de tabel gezet. Kan dit komen doordat {FORUM_INDEX} maar 1x geFastPrint kan worden? Zonder loops kan je namelijk vrij weinig

[Verwijderd]

Smarty is een template-renderer met caching. Die kan dus ook (optioneel) meteen de pagina's cachen.

Smarty templates zijn sneeeeeel

Ik ken een bedrijf die smarty gebruikt, waar het verschil tussen smarty en caching en geen caching een factor 10 is.

[xces]

maaruh "MisterData", kennen we je template code gebruiken?

[djluc]

Kaastosti: je gebruikt nu fasttemplate, waarom heb je die keuze gemaakt? Alleen om de naam oid? Ik ben er zelf ook mee begonnen en er toen heel snel mee gestopt omdat er blijkbaar geen mogelijkheid in zat om blocks te gebruiken zoals je die in yapter wel hebt, dat wil zeggen: In yapter heb je voor een tabel 1 bestand, in fasttemplete heb je er 2. Namelijk een rij en een tabel bestand.

[ Voor 8% gewijzigd door djluc op 01-12-2003 17:52 ]