Simone 'Wiz' Tellini - Entries tagged as tips'n'tricks

Sunday, January 13. 2008

Attributes, reflection and PHP

After a long exposure to .NET, when I get back to PHP I sometimes find myself missing some cool functionality (and a good IDE too... none of those I've tried so far can compete with the comfort of VisualStudio + ReSharper).

Among these missing features, attributes are what I needed in order to solve a certain problem in an elegant way.

Looking at what the reflection API was offering, I came up with a simple way to decorate my properties/methods/classes with attributes: through the documentation comments!

Let's see an example:

<pre>
<?

class A
{
/**
   * @attr
   * @attr2
   */
protected $foo;

protected function GetPropAttrs( $property )
{
$class = new ReflectionClass( get_class( $this ));
$prop = $class->getProperty( $property );
$doc = $prop->getDocComment();
$attrs = array();
$matches = array();

preg_match_all( '/@([a-zA-Z_][a-zA-Z_0-9]*)\s/m',
$doc, $matches, PREG_SET_ORDER );

foreach( $matches as $m )
$attrs[] = $m[ 1 ];

return( $attrs );
}

public function test()
{
$attrs = $this->GetPropAttrs( 'foo' );

print_r( $attrs );
}
}

class B
extends A
{
/**
   * @attr3
   */
protected $foo;
}

$obj = new A();

print( 'Test A:<br>' );
$obj->test();

$obj = new B();

print( '<p>Test B:<br>' );
$obj->test();

?>
</pre>

Running the above script you'll see the following output, confirming that everything works as desired:



Test A:

Array

(

    [0] => attr

    [1] => attr2

)



Test B:

Array ( [0] => attr3 )

If you're using the /** */ comments for real documentation, you might want to use another escape character rather than @, to avoid problems.

Happy coding

Posted by Simone in Software Development, Tips'n'Tricks at 12:16 | Comments (0) | Trackbacks (0)

552 hits

Defined tags for this entry: php, reflection, software development, tips'n'tricks

(Page 1 of 1, totaling 1 entries)

About me

Born in Guastalla the 14th of February, 1978; since I was a child I've always enjoyed disassembling (and re-assembling, often succesfully) everything I could put my hands on.

Eventually I ended up disassembling and re-assembling software... it's not exactly the same thing as dismantling toys, but it can be equally funny

Nota per i connazionali: la maggior parte di questo sito è in inglese, in modo da poter essere compreso dalla maggior parte delle persone che passano di qui.