[PHP] Regexp aanpassen

[Reveller]

Mijn CMS'je bestaat, afhankelijk van de wensen van de klant, uit een aantal modules. Elke module begint als volgt:

PHP:

/**
 * Module Name: Story
 * Description: Gets a story from the database
 * Version    : 1.2
 */

Ik ben nu bezig met een script wat automatisch door de modules/ directory browsed, en een overzicht maakt van alle geinstalleerde modules:

PHP:

foreach ($list as $key => $module)
{
  $data = implode('', file(BASE_PATH.'/modules/'.$module.'.module'));

  preg_match("|Module Name:(.*)|i", $data, $module_name);
  preg_match("|Description:(.*)|i", $data, $description);
  preg_match("|Version    :(.*)|i", $data, $version);
    
  if (isset($module_name[1]) && isset($description[1]) && isset($version[1]))
    echo $module_name[1] // etc...
  }

Het nadeel hierbij is dat de Description altijd op 1 regel moet staan, anders pikt de regexp alleen het deel wat direct achter Description staat op. Ik probeer nu een manier te verzinnen waarop ik een beschrijving die over meerdere regels loopt, in zijn geheel kan afvangen:

PHP:

/**
 * Module Name: Story
 * Description: This module grabs a story from
 *              the database, then parses it to
 *              some function, which outputs
 *              the formatted text to the client
 * Version    : 1.2
 */

Mijn huidige functie retourneert in dit geval $description[1] = 'This module grabs a story from'. Wie heeft een idee om hier verder me te komen?

[JayVee]

Je moet zorgen dat meerdere line breaks meegenomen worden. Die kan je dan met str_replace omzetten in <br> als je dat wil.

PHP:

preg_match("|Description:([.\n\r]*)|i", $data, $description);

?
Om ervoor te zorgen dat hij Version niet meepakt moet je die char group misschien anders schrijven.

PHP:

[\w\d\s\n\r]*

misschien? Ik ben redelijk n00b met RegExps

[MarkvE]

Gebruik naast de i modifier ook de m modifier.

[ Voor 4% gewijzigd door MarkvE op 05-01-2005 16:01 ]

[RedRose]

PHP:

preg_match('|Description: (.*?)\* Version|im',blaaa);

ofzo?

[ Voor 15% gewijzigd door RedRose op 05-01-2005 16:04 . Reden: zo dan he :P ]

[Reveller]

@JayVee, @RedRose - bedankt voor jullie suggesties, maar ze werken niet. Ik had al eerder eenzelfde oplossing geprobeerd als RedRose, maar ook die was niet succesvol. Wellicht heeft iemand nog een ander idee?

[RedRose]

Ook de s-modifier gebruiken.

[NMe]

Reveller schreef op woensdag 05 januari 2005 @ 16:39:
@JayVee, @RedRose - bedankt voor jullie suggesties, maar ze werken niet. Ik had al eerder eenzelfde oplossing geprobeerd als RedRose, maar ook die was niet succesvol. Wellicht heeft iemand nog een ander idee?

Definiëer "ze werken niet" eens.

[Reveller]

Bedankt, RedRose (en iedereen die ook gereageerd heeft). Ik heb nu het volgende maar zit met een onverwacht probleem - heel dom eigenlijk:

PHP:

/**
 * Module Name: Story
 * Description: This module grabs a story from
 *              the database, then parses it to
 *              some function, which outputs
 *              the formatted text to the client
 * Version    : 1.2
 */

preg_match("|Description: (.*?)\* Version|ims", $data, $description);

De output hiervan is: This module grabs a story from* the database, then parses it to* some function, which outputs* the formatted text to the client. Met andere woorden - de asteriksen (*) worden ook meegenomen.

Logisch natuurlijk, maar ik vraag me nu af wat een elegante manier is om die asteriksen er tussenuit te halen. Ik heb nu dit

PHP:

str_replace('*', ' ', $description[1])

De output is nu: This module grabs a story fromthe database, then parses it tosome function, which outputsthe formatted text to the client. Het is gek dat de asteriks niet door een spatie wordt vervangen...&nbsp werkt wel maar is niet zo mooi.

Vragen:
• waarom werkt de str_replace niet goed
• heeft iemand een betere oplossing in gedachten (bv. regexp aanpassen?)

@NMe - "ze werken niet": ze geven geen output Je hebt gelijk...

[ Voor 31% gewijzigd door Reveller op 05-01-2005 21:11 ]

[NMe]

De output bewerken met str_replace lijkt me gunstiger, want de regexp aanpassen kost, als het al mogelijk is, veel meer rekenwerk volgens mij.

Edit: snel je post editen he?
Waarom die replace niet werkt weet ik niet. Ziet het in de HTML source ook zo uit?

[ Voor 30% gewijzigd door NMe op 05-01-2005 21:12 ]

[Reveller]

@NMe - Dat dacht is eigenlijk ook.

Blijft de vraag waarom replacen met ' ' geen spaties geeft. Wellicht heeft het te maken met het resultaat van de regexpen:

PHP:

/**
 * Module Name: Story
 * Description: This module grabs a story from
 *              the database, then parses it.
 * Version    : 1.2
 */ 

preg_match("|Module Name: (.*)|i"             , $data, $module_name);
preg_match("|Description: (.*?)\* Version|ims", $data, $description);
preg_match("|Version    : (.*)|i"             , $data, $version);

echo $module_name[1].str_replace('*', ' ', $description[1]).$version[1];

Geeft als html-output:

HTML:

Story
This module grabs a story fromthe database, then parses it.
 1.2

Met andere woorden:
• een newline achter $module_name[1]
• een newline achter $description[1] en een spatie voor $version[1]

Terwijl je als output 1 lange string zou verwachten? Er is dus ws. iets verkeerd aan de regexpen maar ik zie niet wat. Iemand wel?

[ Voor 128% gewijzigd door Reveller op 05-01-2005 22:25 ]

[crisp]

PHP:

$text = "This module grabs a story from
 *              the database, then parses it.
";

$text = preg_replace('/[\s*]+/', ' ', $text);

echo $text;

(waarschijnlijk hou je nog een spatie aan het einde over, maar die kan je met een simpele rtrim() wel wegwerken)

[ Voor 27% gewijzigd door crisp op 05-01-2005 22:59 ]

[vargo]

crisp schreef op woensdag 05 januari 2005 @ 22:57:

PHP:

$text = "This module grabs a story from
 *              the database, then parses it.
";

$text = preg_replace('/[\s*]+/', ' ', $text);

echo $text;

(waarschijnlijk hou je nog een spatie aan het einde over, maar die kan je met een simpele rtrim() wel wegwerken)

Moet er ook geen ungreedy modifier bij: /u?
Dit ivm eventueel meerdere '*'s?

[ Voor 8% gewijzigd door vargo op 05-01-2005 23:03 ]

[crisp]

vargo schreef op woensdag 05 januari 2005 @ 23:03:
[...]

Moet er ook geen ungreedy modifier bij: /u?
Dit ivm eventueel meerdere '*'s?

Tsja, als er in de description een * staat die bij de tekst hoort dan raak je die nu ook kwijt. Fact is echter dat een ungreedy modifier dat niet gaat oplossen, dan moet je je regels anders specificeren, bijvoorbeeld:

PHP:

$text = preg_replace('/\r?\n\s*\*\s+/', ' ', $text);

[Reveller]

Ik kom er niet uit - hoe schrijf je nu jouw oplossing:

PHP:

preg_replace('/[\s*]+/', ' ', $text);

als je hem inpast bij

PHP:

preg_match("|Description: (.*?)\* Version|ims", $data, $description);

?

[chem]

Iets algemener aanvaard is trouwens de @ hiervoor te gebruiken...

PHP:

    /**
    *   returns the error type
    *
    *   @author Schnappi <[e-mail]>
    *   @version 1.3.9
    */
    function get_error()
    {
        return $this->errortype;
    }

[Reveller]

chem schreef op donderdag 06 januari 2005 @ 12:29:
Iets algemener aanvaard is trouwens de @ hiervoor te gebruiken...

Dat heb ik ook al vaker gezien ja. Volgens mij komt dit voornamelijk omdat PHPDoc standaard die syntax ondersteunt bij het aanleggen van documentatie - of zit ik er nu naast? Is er nog een andere reden om die notatie aan te houden? Als ik er nu dan toch mee bezig ben, dan het lieft ineens zo standaard mogelijk natuurlijk

[Wacky]

code:

preg_match_all('|Description: (.+?)* Version|',$bron,$doel);
$description = $doel[1][0];

Misschien dat dit wel werkt?

[Skaah]

Reveller schreef op donderdag 06 januari 2005 @ 13:15:
[...]

Dat heb ik ook al vaker gezien ja. Volgens mij komt dit voornamelijk omdat PHPDoc standaard die syntax ondersteunt bij het aanleggen van documentatie - of zit ik er nu naast? Is er nog een andere reden om die notatie aan te houden? Als ik er nu dan toch mee bezig ben, dan het lieft ineens zo standaard mogelijk natuurlijk

phpDoc, idd. En ook voor Java, geloof ik. Automatisch documentatie genereren bij je code, wie wil dat niet?

[Reveller]

Dat verandert de zaak wel enigszins. Ik ben zojuist in de documentatie van phpDoc gedoken, en zie dat zij een goede functie beschrijving als volgt zien:

PHP:

/**
 * De functie doet leuke dingen binnen een nog
 * leukere class
 *
 * @author Reveller
 * @name Story
 * @version 1.0.2
 */

Als ik mijn modules op deze manier beschrijf, zijn ze ook meteen 'phpDoc-ready' wanneer ik dat later ga gebruiken (heb er net even mee gespeeld en het werkt ontzettend goed; moet alleen mijn commentaar aanpassen), wordt ineens alles goed geparsed.

De vraag die ik nu wel heb is hoe de regexp eruit moet zien die de beschrijving "De functie doet leuke dingen...") uitleest. Ik heb namelijk geen referentiepunt, zoals ik dat wel bij @author, @name en @version wel heb. Het is wel het eerste commentaar op de pagina, dus misschien kan ik alle zinnen nemen vanaf de eerste /** op de pagina tot aan @author, maar dan moet de volgorde van die documentatie wel altijd gelijk zijn. Ideeen hierover iemand?

[Reveller]

edit:
Een bescheiden * kick * omdat ik er zelf niet uit kom Wie heeft een idee voor de regexp die de beschrijving uitleest (zie post hierboven)?

[ Voor 39% gewijzigd door Reveller op 07-01-2005 18:51 ]

[seamus21]

Even een workaround hoor maar als je nou voor alle description regels @desc zet aangezien je weet hoe je per 1 regel moet filteren. Dan filter je daarna alle @desc eruit met str_replace. Of zit ik helemaal verkeerd te denken?

[ Voor 4% gewijzigd door seamus21 op 08-01-2005 00:06 ]

[MarkvE]

Ik krijg het niet met één RegExp gedaan, wel met twee. So this should do the job well...

PHP:

<?php

$str = '/**
         * Deze functie doet leuke dingen binnen een nog
         * leukere class.
         *
         * @author Reveller
         * @name Story
         * @version 1.0.2
         */';

preg_match ( '/\/\*\*(.+)@author/is', $str, $match );

$description = trim ( preg_replace ( '/(\r|\n|\*| {1,})+/', ' ', $match [ 1 ] ) );

echo $description;

?>

Een werkend voorbeeld.

[ Voor 46% gewijzigd door MarkvE op 08-01-2005 00:09 ]

[crisp]

Jouw voorbeeld stripped ook asterisks binnen het commentaar en houd geen rekening met unix-newlines. Ik zou het zo doen:

PHP:

$str = '/**
         * Deze functie doet *leuke* dingen binnen een nog
         * leukere class.
         *
         * @author Reveller
         * @name Story
         * @version 1.0.2
         */';

preg_match ( '/\/\*\*(.+)(?=@author)/is', $str, $match );

$description = trim ( preg_replace ( '/\r?\n *\* */', ' ', $match [1] ) );

echo $description;

[Reveller]

Bedankt iedereen (en voornamelijk crisp)! In principe werkt het nu, maar ik blijf zitten met de linebreaks bij mijn eigen regexpen:

PHP:

$str = '/**
         * Deze functie doet *leuke* dingen binnen een nog
         * leukere class.
         *
         * @author Reveller
         * @name Story
         * @version 1.0.2
         */';

preg_match('/\/\*\*(.+)(?=@author)/is', $str, $match);
preg_match('/@author(.*)/i', $str, $author);
preg_match('/@name(.*)/i', $str, $name);
preg_match('/@version(.*)/i', $str, $version);

$description = trim(preg_replace('/\r?\n *\* */', ' ', $match [1]));

echo '<p>'.$description.'</p>';
echo '<p>'.$author[1].'</p>'; 
echo '<p>'.$name[1].'</p>'; 
echo '<p>'.$version[1].'</p>';

levert de volgende

HTML:

<p>Deze functie doet *leuke* dingen binnen een nog leukere class.</p><p> Reveller
</p><p> Story
</p><p> 1.0.2
</p>

Met andere woorden: een break na Reveller, Story en 1.0.2. Weet iemand hoe dit komt?

[MarkvE]

Reveller schreef op zaterdag 08 januari 2005 @ 15:01:
Bedankt iedereen (en voornamelijk crisp)! In principe werkt het nu, maar ik blijf zitten met de linebreaks bij mijn eigen regexpen:

PHP:

$str = '/**
         * Deze functie doet *leuke* dingen binnen een nog
         * leukere class.
         *
         * @author Reveller
         * @name Story
         * @version 1.0.2
         */';

preg_match('/\/\*\*(.+)(?=@author)/is', $str, $match);
preg_match('/@author(.*)/i', $str, $author);
preg_match('/@name(.*)/i', $str, $name);
preg_match('/@version(.*)/i', $str, $version);

$description = trim(preg_replace('/\r?\n *\* */', ' ', $match [1]));

echo '<p>'.$description.'</p>';
echo '<p>'.$author[1].'</p>'; 
echo '<p>'.$name[1].'</p>'; 
echo '<p>'.$version[1].'</p>';

levert de volgende

HTML:

<p>Deze functie doet *leuke* dingen binnen een nog leukere class.</p><p> Reveller
</p><p> Story
</p><p> 1.0.2
</p>

Met andere woorden: een break na Reveller, Story en 1.0.2. Weet iemand hoe dit komt?

trim...

[Reveller]

Dank je! Wat stom ... het stond gewoon voor m'n neus. En ik maar prutsen aan die regexp om het goed te krijgen. Voor iedereen die er nog eens wat aan heeft:

PHP:

$str = '/**
         * Deze functie doet *leuke* dingen binnen een nog
         * leukere class.
         *
         * @author Reveller
         * @name Story
         * @version 1.0.2
         */';

preg_match('/\/\*\*(.+)(?=@author)/is', $str, $description);
preg_match('/@author(.*)/i', $str, $author);
preg_match('/@name(.*)/i', $str, $name);
preg_match('/@version(.*)/i', $str, $version);

$description = trim(preg_replace('/\r?\n *\* */', ' ', $description[1]));
$author      = trim($author[1]);
$name        = trim($name[1]);
$version     = trim($version[1]);

echo '<p>'.$description.'</p>';
echo '<p>'.$author.'</p>'; 
echo '<p>'.$name.'</p>'; 
echo '<p>'.$version.'</p>';