Get comments in php file

Question

I am trying to get comments from a specific .php file on my server to parse its variables. I thought Ii found an easy way to do this, however the function I use returns nothing, although I explicitly have comments in the file.

Here are the comments I use:

 /** * @param foo bar * @return baz */ 

Here is my code:

 function GetComments($filename) { $expr = "/((?:\/\*(?:[^*]|(?:\*+[^*\/]))*\*+\/)|(?:\/\/.*))/"; $file = fopen($filename, "r"); $length = filesize($filename); $comments = fread($file, $length); fclose($file); preg_match_all($expr, $comments, $matches); foreach($matches[0] as $id => $variable){ $comments = str_replace($variable,'',$comments); } return $comments; } 

Is there something I'm doing wrong? Because if this is so, I am clearly looking at it.

Any help would be greatly appreciated.

EDIT:

I found the answer:

First of all, I should probably have noted in my question that I am trying to write a system for reading plugins. These plugin files should contain a comment block at the top containing variables such as the author of the plugin, website, email, etc.

so here is what i did:

I took an example of assemblies to modify my function to get comments and variables.
Then I changed the code a bit to fit my needs:

 public function GetComments($filename) { $docComments = array_filter(token_get_all(file_get_contents($filename)), function($entry) { return $entry[0] == T_COMMENT; }); $fileDocComment = array_shift($docComments); $regexp = "/\@.*\:\s.*\r/"; preg_match_all($regexp, $fileDocComment[1], $matches); for($i = 0; $i < sizeof($matches[0]); $i++) { $params[$i] = split(": ", $matches[0][$i]); } return($params); } 

I put the result of the code that I was given through the regular expression, the result is an array containing the parameters and their values. Then I used the split function to give me individual parameters and values, so I could return them to the variable that called the function.

For this to work correctly, I had to change the style of the comment that I used from

 /** * @param foo bar * @return baz */ 

to

 /* @param: foo bar @return: baz */ 

makes it a normal comment block, not a doc comment block.
And it also allowed me to use ':' as a template for the split function.

It may not be so effective in the eyes of some. As Ms. Valle noted, “What will change your style of commentary?” I will be the only one working on this project and writing plugins. Therefore, it’s not too difficult for me to keep the comment style the same in every script plugin.
This method works great for me.

Thanks everyone for the help on this.

Answer 1

You can use token_get_all() , which "parses a given PHP source string in language tokens using the Zend engine lexical scanner."

See: http://php.net/token_get_all

Here's an example function that I used once to get a doc-comment file from the current file:

 /** * Return first doc comment found in this file. * * @return string */ function getFileDocBlock() { $docComments = array_filter( token_get_all( file_get_contents( __FILE__ ) ), function($entry) { return $entry[0] == T_DOC_COMMENT; } ); $fileDocComment = array_shift( $docComments ); return $fileDocComment[1]; } 

Answer 2

Try using http://ca3.php.net/manual/en/class.reflectionclass.php

and http://ca3.php.net/manual/en/class.reflectionfunction.php

This is all you need to get the function parameters.