[ALG] Hoe ver gaan met modulariteit?

[Reveller]

Mijn CMS'je is gedeeltelijk modulair van opzet: elke functionaliteit (forum, userbeheer, templating, etc) zit in een aparte module (= php bestand). Ook heeft elke module zijn eigen database tabel of tabellen, geprefixed met de modulenaam.

Nu is het zo, dat modules ook vaak eigen, specifieke javascripts gebruiken. Ook gebruiken een aantal modules plaatjes (icoontjes) die andere modules niet gebruiken. Tot nu toe heb ik alle javascript functies in 1 bestand gedumpt, genaamd 'common.js'. Alle plaatjes zijn in de map /images gezet.

Nu bedacht ik mij vannacht dat het eigenlijk logischer zou zijn om elke module in een eigen map te zetten, met daarin het php bestand en module specieke javascript, language file, css en plaatjes.

Het nadeel daarvan is echter, dat je op 1 pageload meerdere javascript bestandjes moet inladen, meerdere stylesheets en dat de tekststrings niet in 1 bestand staan, maar in meerdere language files verspreid. Het betekent dat de client meer verschillende bestanden moet downloaden, en dat de server realtime meerdere language files moet aanspreken ipv 1. Bovendien staan tot nu toe alle modules in dezelfde map '/modules', waardoor het includen redelijk snel gaat. Maar ook dat zal trager gaan als elke module in een eigen /modules submap staat.

Kortom: hoe ver gaan jullie met het opdelen van je code? Ik heb het idee dat ik het door op te delen beter onderhoudbaar maak, maar er staan zoals gezegd een aantal nadelen tegenover...

[JHS]

Ik zou plaatjes, javascripts en dergelijk wel degelijk bij de module houden, omdat het anders niet echt een modulaire opzet te noemen is. Het is niet alsof je dan simpelweg een module in kan pluggen . De problemen die je schetst met betrekking tot het aanspreken van meerdere bestanden zou ik oplossen met behulp van caching.

[eamelink]

De extra tijd die het je server kost om php files van her en der te includen is verwaarloosbaar.

Het extra downloaden van javascripts door de client kan je voorkomen door een javascript.php en een stylesheet.php te nemen, die alle benodigde javascripts en stylesheets inleest, bij elkaar zet en weer uitspuugt

[Johnny]

gewoon losse javascripts gebruiken, ze worden toch gecached. In plaats van in een keer enkele honderden kilobytes te laden hoeft er dan maar per pagina enkele kilobytes extra te worden geladen en het is nog makkelijker te schalen en te onderhouden ook wanneer je steeds meer modules krijgt.

[Reveller]

Nou, da's dus duidelijk Maar ik loop nu wel tegen een praktisch probleem op. Ik heb een map /modules en in deze map heeft elke module een subdir, bijvoorbeeld /modules/user. In deze map zit onder andere een language file: /module/user/user.nl.lang. Deze language file is op het moment een PHP array:

PHP:

$lang[] = array (
  'USER_FIRSTNAME' => 'Voornaam',
  'USER_LASTNAME'  => 'Achternaam',
  'USER_PASSWORD'  => 'Wachtwoord'
);

Op deze manier heb ik straks een language file voor elke module, bijvoorbeeld ook voor het forum: /modules/forum/forum.nl.lang:

PHP:

$lang[] = array (
  'FORUM_VIEW_POST' => 'Bekijk bericht',
  'FORUM_SEND_POST' => 'Verstuur bericht'
);

Nu wil ik dus op het moment dat er een request naar de server gaat, al deze language files includen, ze doorlezen en er 1 array van maken die ik in een static var of zoiets stop. Pseudo:

PHP:

function language_load($language = 'nl') {
  static $language;

  foreach (module_list() as $module) {
    $filename = "modules/$module/$module.$language.lang";
    if (file_exists($filename)) {
      include_once($filename);
      $language = array_merge($language, $lang) // ??? wat hier te doen ???
    }
  }
  return $language;
}

Vraag: hoe kan ik nu die language files uitlezen en mergen tot 1 array? Moet ik trouwens wel elke language file in de vorm van een PHP array stoppen hiervoor? Tips, graag!

[mulder]

Waarom zou je een andere aanpak kiezen dan als met de javascripts en images, je zorgt dat je module de juiste language files include met daar in constants met de juiste taal. Ik zie geen toegevoegde waarde van een array.

[Grijze Vos]

eamelink schreef op maandag 26 februari 2007 @ 16:32:
Het extra downloaden van javascripts door de client kan je voorkomen door een javascript.php en een stylesheet.php te nemen, die alle benodigde javascripts en stylesheets inleest, bij elkaar zet en weer uitspuugt

Moet je wel zorgen dat je het zo aanpakt dat ze wel gecached kunnen worden. Maar goed, als er niet echt veel veranderd per module kun je net zo goed een gewone file neerzetten per js/css file, hoef je het niet te parsen, scheelt ook weer.

[NMe]

Reveller schreef op maandag 26 februari 2007 @ 17:26:
Vraag: hoe kan ik nu die language files uitlezen en mergen tot 1 array? Moet ik trouwens wel elke language file in de vorm van een PHP array stoppen hiervoor? Tips, graag!

Alle language files in één map zetten, waar je met de filesystem functies doorheen loopt, om vervolgens elk bestand dat je daar tegenkomt te includen? Daarna array_merge gebruiken voor het samenvoegen van arrays. Lijkt me niet zo'n probleem eigenlijk?

[frickY]

Kijk ook eens naar gettext() voor je vertalingen.

[Annie]

Ik snap niet waarom je alles in 1 array zou willen zetten. Als de language file module specifiek is, dan gebruik je 'm dus ook alleen binnen die module, toch?
Waarom dan alle files in 1 array stoppen?

[MisterData]

Zet javascripts per module in een map, maak een PHP script (javascripts.php) die al die *.js bestanden samenvoegt en uitspuugt (eventueel newlines enzo eruit slopen voor kleiner bestand). Dat script cached dan naar een bestand en roep je aan als je een script veranderd hebt Eventueel laat je het script ook nog zelf de bestands-tijden checken van de javascripts

[Reveller]

Annie schreef op maandag 26 februari 2007 @ 21:21:
Ik snap niet waarom je alles in 1 array zou willen zetten. Als de language file module specifiek is, dan gebruik je 'm dus ook alleen binnen die module, toch?
Waarom dan alle files in 1 array stoppen?

Modules kunnen aangeroepen worden op pagina's buiten die modules. Het simpelste voorbeeld hierbij is een [laatste 10 reakties uit het forum] - box op de homepage. In die box gebruik ik dus strings uit de forum module, terwijl ik in werkelijkheid in de page (want: op een door de user aangemaakte webpagina) module zit.

MisterData schreef op maandag 26 februari 2007 @ 21:55:
Zet javascripts per module in een map, maak een PHP script (javascripts.php) die al die *.js bestanden samenvoegt en uitspuugt (eventueel newlines enzo eruit slopen voor kleiner bestand). Dat script cached dan naar een bestand en roep je aan als je een script veranderd hebt Eventueel laat je het script ook nog zelf de bestands-tijden checken van de javascripts

Een dergelijk idee is al eerder geopperd en het klinkt reuze handig Daar ga ik eens werk van maken...

frickY schreef op maandag 26 februari 2007 @ 19:42:
Kijk ook eens naar gettext() voor je vertalingen.

gettext is geen optie omdat niet alle (Windows-) servers dit ondersteunen en ik zoek een platform onafhankelijke oplossing. Ik weet dat er op SourceForge een win32 port van gettext staat, maar ik heb niet altijd iets te zeggen over de configuratie van de server, lijkt me

[ Voor 47% gewijzigd door Reveller op 26-02-2007 22:04 ]

[mulder]

Reveller schreef op maandag 26 februari 2007 @ 22:01:
[...]

Modules kunnen aangeroepen worden op pagina's buiten die modules. Het simpelste voorbeeld hierbij is een [laatste 10 reakties uit het forum] - box op de homepage. In die box gebruik ik dus strings uit de forum module, terwijl ik in werkelijkheid in de page (want: op een door de user aangemaakte webpagina) module zit.

[...]

En als het in een array zit dan heb je toch hetzelfde probleem? Je zult toch de taalwaarden van die module er bij moeten pakken, of je nou de waarden uit een bestand inleest in een array of simpelweg de file include.

[Reveller]

Don Facundo schreef op dinsdag 27 februari 2007 @ 08:42:
[...]
En als het in een array zit dan heb je toch hetzelfde probleem? Je zult toch de taalwaarden van die module er bij moeten pakken, of je nou de waarden uit een bestand inleest in een array of simpelweg de file include.

Het idee is om op elke pagerequest alle language files te includen, door te nemen en onder elkaar te plakken in 1 array die voor elke functie beschikbaar is. Dit bestand, met daarin alle strings van alle modules, kan ik dan cachen. Van tijd tot tijd controleer ik of de language files van de modules veranderd / geupdate zijn. Als dat zo is, stel het systeem een nieuwe language-array samen die weer gecached wordt. Volgens mij werkt zo'n systeem het beste.

[soulrider]

je kan ook spieken bij een voorbeeld zoals php-nuke
(ook in verre mate modulair)
en hoe daar het probleem van language fiels worden opgelost (daar ik me herinner vind je per module een verdere map 'language' die in de module-php-script ge-include wordt)

oke moet je per module vertalingen gaan voorzien, maar dat kan je ook oplossen met een algemene:
if not found include 'default-language-file'
en dat dan in 't engels voorzien.

[mithras]

Reveller schreef op maandag 26 februari 2007 @ 22:01:
[...]

Modules kunnen aangeroepen worden op pagina's buiten die modules. Het simpelste voorbeeld hierbij is een [laatste 10 reakties uit het forum] - box op de homepage. In die box gebruik ik dus strings uit de forum module, terwijl ik in werkelijkheid in de page (want: op een door de user aangemaakte webpagina) module zit.

Dat is natuurlijk niet modulair meer

Wat je beter kan doen is bijvoorbeeld je frontpage zo maken dat de onderdelen die je wil tonen ophaalt van de andere modules. In php kan je dan een functie van de module aanroepen. De module regelt alles zelf, en retourneert bijvoorbeeld een html string. Dan heeft je frontpage niets te zeggen over de zaken die spelen in je forum module.
Bij een wijziging van je forum module wijzigt dan je frontpage automatisch mee, als je het op jouw manier doet kan je problemen krijgen

Maar ik snap het nut ook niet van een grote array voor alle vertalingen: als je modulair wil zijn moet je juist _ook_ dat modulair maken. Gewoon een language file per module. De module regelt gewoon haar eigen vertaling.

In mijn cms is het nu als volgt geregeld:

code:

./
./index.php
./init.php   //initialiseert objecten uit /includes
./config.php  //config file
./includes/plugin.php  //php object met daarin de plugins
./includes/functions/php   //php object met veel gebruikte functies
./plugins/main/main.class.php   //plugin "main"
./plugins/user/user.class.php   //plugin voor user managment
./plugins/user/admin.class.php   //admin gedeelte voor plugin
./plugins/user/language   //language file

De language file werkt nu nog niet, die wordt binnenkort toegevoegd. Maar zo behoud je de hoogste mate van modulariteit

Als ik bijvoorbeeld in mijn blog de user wil ophalen die het artikel heeft geschreven, moet dat via de user plugin. In het blog gedeelte staat namelijk alleen een user-id. Ik roep een functie aan binnen $user die een array met gebruikersinfo retourneert. Daar kan je dan weer je username uit halen. Als ik dus de usertabel wijzig, verandert er niets voor mijn blog: dit handel ik toch allemaal af binnen het user gedeelte

[Reveller]

Voor elke module van mijn cms heb ik een submap in /modules. In elke submap zit een language file die hoort bij die module. Hieronder staan 2 voorbeelden. In de code daaronder probeer ik deze twee language files te mergen tot 1 array:

PHP:

// user/user.nl.lang
$lang[] = array (
  'USER_FIRSTNAME' => 'Voornaam',
  'USER_LASTNAME'  => 'Achternaam',
  'USER_PASSWORD'  => 'Wachtwoord'
);

// page/page.nl.lang
$lang[] = array (
  'PAGE_DELETE' => 'Verwijder pagina',
  'PAGE_UPDATE' => 'Update pagina',
);

function language_load($language = 'nl') {
  foreach (module_list() as $module) {
    $filename = "modules/$module/$module.$language.lang";
    if (file_exists($filename)) {
      include_once($filename);
      $array = array_merge($array, $lang);
    }
  }

  return $array;
}

PHP loopt keihard vast door regel 20. Als ik die regel weg laat, werkt het bijna. Met een print_r($lang) krijg ik de volgende array terug:

code:

Array
(
  [0] = Array (
    [USER_FIRSTNAME] => 'Voornaam',
    [USER_LASTNAME]  => 'Achternaam',
    [USER_PASSWORD]  => 'Wachtwoord'
  )

  [1] = Array (
    [PAGE_DELETE] => 'Verwijder pagina',
    [PAGE_UPDATE] => 'Update pagina',
  )
)

Maar ik wil als output:

code:

Array
(
  [USER_FIRSTNAME] => 'Voornaam',
  [USER_LASTNAME]  => 'Achternaam',
  [USER_PASSWORD]  => 'Wachtwoord'
  [PAGE_DELETE]    => 'Verwijder pagina',
  [PAGE_UPDATE]    => 'Update pagina',
)

Vraag: hoe kan ik nu die language files uitlezen en mergen tot 1 array?

[Wim Leers]

Wat is de exacte foutmelding?

[Creepy]

Met $lang[] = new array(...) voeg je steeds een nieuwe element aan de $lang array toe waarin weer een nieuwe array staat omdat je met array() weer een nieuwe array aanmaakt. Probeerd $lang = new array(...) eens zodat $lang steeds opnieuw wordt overschreven.

[Reveller]

@Creepy - nu werkt het perfect, dank je!

Nu ik erover nadenkt, kan ik ws. net zo makkelijk de array's appenden ipv mergen, maar dat dan nog blijft de oplossing hetzelfde

[Verwijderd]

Waarom doe je niet iets als

PHP:

// user/user.nl.lang
$lang['USER_FIRSTNAME'] = 'Voornaam';
$lang['USER_LASTNAME']  = 'Achternaam';
$lang['USER_PASSWORD']  = 'Wachtwoord';

// page/page.nl.lang
$lang['PAGE_DELETE'] = 'Verwijder pagina';
$lang['PAGE_UPDATE'] = 'Update pagina';

\Je hoeft nu alleen de juiste files te includen, en niets te mergen.

[Blaise]

Ik zat laatst ook met deze kwestie en heb gekeken hoe anderen het doen. PHPBB3 (beta) doet het zo:

Aan het begin van elk taalbestand:

PHP:

if (empty($lang) || !is_array($lang))
{
    $lang = array();
}

vervolgens:

PHP:

$lang = array_merge($lang, array(
    'YEAR'              => 'Year',
    'YES'               => 'Yes',
    'YOU_LAST_VISIT'    => 'Last visit was: %s',
    'YOU_NEW_PM'        => 'A new private message is waiting for you in your Inbox',
    'YOU_NEW_PMS'       => 'New private messages are waiting for you in your Inbox',
    'YOU_NO_NEW_PM'     => 'No new private messages are waiting for you',

    'datetime'          => array(
        'TODAY'         => 'Today, ',
        'YESTERDAY'     => 'Yesterday, ',
        'Sunday'        => 'Sunday',
        'Monday'        => 'Monday',
        // etc
    )
));

Ik heb de methode gebruikt zoals beschreven in de post hierboven, maar die vind ik minder overzichtelijk door de brackets.

[ Voor 6% gewijzigd door Blaise op 18-03-2007 20:19 ]