Property reflections include descriptions #7
Conversation
(annotation texts)
| @@ -37,12 +40,13 @@ | |||
| * @param bool $readonly | |||
| * @param string $type | |||
|
I added some comments (mainly typos & coding standards), however, tests would be a nice thing to have... |
|
|
||
| // parse column name | ||
| $column = $name; | ||
| if (isset($split[2], $split[3]) && $split[2] === self::PROP_COLUMN_DELIMITER) { | ||
| $column = $split[3]; | ||
| if (isset($split[4])) { | ||
| $description = implode(' ', array_slice($split, 4)); |
There was a problem hiding this comment.
As punctilious as I am, I'd like to preserve the original whitespace (not simply glue it with one space). That would possibly mean a few more refactoring...
There was a problem hiding this comment.
Yup, we would have to forget about Strings::split()... Unless we ran it twice, first to check if there's a "->" and then with an appropriate limit (which would mean using preg_split directly).
There was a problem hiding this comment.
Or maybe use a slightly more difficult (but yet single) regexp...
|
Okay, I'll fix it according to your coding standard and update my pull request. BTW, there's a method called getReflectioin() (typo) somewhere in your reflection classes. I believe that doesn't deserve a pull request :) |
| @@ -90,6 +90,7 @@ private function loadMethodProperties() | |||
|
|
|||
| $name = lcfirst(substr($method->name, 3)); | |||
| $type = $method->getAnnotation('return'); | |||
| $description = $method->getAnnotation('description'); | |||
There was a problem hiding this comment.
I think that - instead of @description annotation - taking the phpDoc comment (text until first annotation) should be considered as a description...
There was a problem hiding this comment.
And of course the description would be considered at the getter method only.
|
Implemented. Thanks for feature request. |
Sometimes it's useful to access the description of a property (e.g. automatic admin form generation). Since YetORM's EntityProperty reflection already aggregates information about all the properties, it seems to be a good candidate for this.