[PHP] PHP Commentaar regels opzoeken en filteren

woensdag 8 juni 2005 22:15 · beginnen

/**
 * @description Retourneert een foo-bericht naar de gebruiker
 * @user Met deze functie kunt u mooi dingen doen.
 *   Hele mooie dingen!
 */
function foo_ding() {
  return 'foo!';
}

/**
 * @user Deze functie doet iets stoms. Iets heel erg stoms!
 * @version Retourneert een bar-bericht naar de gebruiker
 */
function bar_ding() {
  return 'bar!';
}
1
2
3
4
5
6
7
8
9
10
11
12

function get_dingen() {
  $func = get_defined_functions();
  $func = $func['user'];

  foreach ($func as $val) {
    if (substr($val, -5, 5) == '_ding') {
      $dingen[] = $val;
    }
  }

  return $dingen;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

function dingen_info()
{
  foreach (get_dingen() as $ding)
  {
    /* Zoek de functie op en ga dan een x aantal regels omhoog
     * in het bestand totdat je @user tegenkomt. Verzamel de
     * info achter @user totdat je een andere "@" tegenkomt of
     * totdat je een * direct gevolgd door een / tegenkomt */

    preg_match('/@user(.*)/i', $data, $name);
    $user = trim($user[1]);
    $info[$ding] = $user;
  }
  return $ding;
}
1
2
3
4

while(eregi("@user([[:print:]]*)function [A-Z]*_ding()", $file, $regs) {
  echo "Gevonden comment: {$regs[1]}<BR>".
  $file = str_replace($regs[0], "", $file); // voorkomt dat de comment nog een keer gevonden wordt
}
1
2
3
4
5
6
7
8

function foo_ding($comment=false) {
  if ($comment) {
    return 'dit is de beschrijving';
  }
  else {
    return 'functie output!';
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

/**
 * @description Dit moet niet meegenomen worden 
 *   in de output van dingen_info
 * @user Deze functie doet mooie dingen.
 *   Hele mooie dingen!
 */
function foo_ding() {
  return 'foo!';
}

/**
 * @user Deze functie doet iets stoms.
 *   Iets heel erg stoms!
 * @version Versienummer moet niet in de output
 *   van dingen_info()
 */
function bar_ding() {
  return 'bar!';
}

function get_dingen() {
  $func = get_defined_functions();
  $func = $func['user'];

  foreach ($func as $val) {
    if (substr($val, -5, 5) == '_ding') {
      $dingen[] = $val;
    }
  }

  return $dingen;
}

function dingen_info($file) {
  $file = file_get_contents($file);
  while(eregi("@user([[:print:]]*)function [A-Z]*_ding()", $file, $regs)) {
    echo "Gevonden comment: {$regs[1]}<br>";
    $file = str_replace($regs[0], "", $file);
  } 
}

dingen_info('C:\Program Files\Apache2\htdocs\test\macro.php');
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

function dingen_info($file, $commentNames = array())
{
    //Strip newlines
    $file = str_replace(array("\n", "\r"), ' ', $file);

    // Find methods with PHPDoc-style comments:
    // /**
    //  *
    //  */
    $hasMatch = preg_match_all(
        ";
            /\*\*                   #Comment start
                (?P<Comment>.*?)    #Comment contents
            \*/                     #End of the comment
                \s*
            function\s+(?P<Function>[a-z0-9_]*_ding) #Function name, all 'to be matched' end with _ding!!!
        ;xim", 
        $file, 
        $matches, 
        PREG_SET_ORDER
    );

    if($hasMatch)
    {
        //iterate found methods
        foreach($matches as $functionMatch)
        {
            echo 'In de functie ', $functionMatch['Function'], ':<br/>';
            parse_comments($functionMatch['Comment'], $commentNames);
        }
    }
}

function parse_comments($comment, $commentNames = array())
{
    $hasMatch = preg_match_all(
        ';
            @(?P<Name>[^ ]+)    #tag name, format @<text><space>
            (?P<Content>[^@]+)  #tag contents
        ;x', 
        $comment, 
        $commentMatch
    );

    if($hasMatch)
    {
        foreach($commentMatch['Name'] as $Key => $Name)
        {
            if(in_array($Name, $commentNames))
            {
                // convert back to newlines
                echo preg_replace(';\s*\*\s+;', "\n", $commentMatch['Content'][$Key]);
                echo '<br/>';
            }
        }
    }
}

dingen_info(file_get_contents(__FILE__), array('user'));
1

function\s+(?P<Function>[a-z0-9_]*_ding) #Function name, all 'to be matched' end with _ding!!!
1

function\s+(?P<Function>ding_*[a-z0-9_]) #Function name, all 'to be matched' begin with ding_
1

function\s+(?P<Function>ding_[a-z0-9_]*)
1
2
3
4
5
6
7
8
9
10
11
12

$hasMatch = preg_match_all(
    ";
        /\*+                                #Comment start
            (?P<Comment>([^\*][^/])*)       #Comment contents
        \*+/                                #End of the comment
        \s*
        function\s+(?P<Function>[a-z0-9_]*_comments) #Function name, all 'to be matched' end with _ding!!!
    ;xim", 
    $file, 
    $matches, 
    PREG_SET_ORDER
);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

/**
 * @user Deze functie doet iets stoms. Iets heel erg stoms!
 * @version V0.1...moet niet meegenomen worden in output
 */
function ding_bar()
{
  return 'bar!';
}

/**
 * @user Deze functie doet mooie dingen. Hele mooie dingen!
 * @description Blaat...moet niet meegenomen worden in output
 */
function foo_ding()
{
  return 'foo!';
}

/**
 * @description Versienummer moet niet in de output van dingen_info()
 * @user Deze functie doet iets stoms. Iets heel erg stoms!
 */
function bar_ding()
{
  return 'bar!';
}

function dingen_info($file, $commentNames = array())
{
  $file = str_replace(array("\n", "\r"), ' ', $file);

  $hasMatch = preg_match_all(
      ";
          /\*+                                #Comment start
              (?P<Comment>([^\*][^/])*)       #Comment contents
          \*+/                                #End of the comment
          \s*
          function\s+(?P<Function>[a-z0-9_]*_ding) # functions with _ding
      ;xim", 
      $file, 
      $matches, 
      PREG_SET_ORDER
  ); 

  if($hasMatch)
  {
    foreach($matches as $functionMatch)
    {
      echo 'In de functie ', $functionMatch['Function'], ':<br/>';
      parse_comments($functionMatch['Comment'], $commentNames);
    }
  }
}
1
2
3
4
5
6
7
8
9
10
11
12

  $hasMatch = preg_match_all(
      ";
        /\*\*                   #Comment start
            (?P<Comment>.*?)    #Comment contents
        \*/                     #End of the comment
             \s*
        function\s+(?P<Function>ding_[a-z0-9_]+) # functions beginning with ding_
      ;xim", 
      $file, 
      $matches, 
      PREG_SET_ORDER
  );

[PHP] PHP Commentaar regels opzoeken en filteren

Onderwerpen