Epo 7766

[ericdrosas87]

No description provided.

[ericdrosas87]

I did not refactor much of the Asset and Element service classes, as they likely will be going away, nor did I refactor out much of the logic from the controller as it will likely change quite a bit.

[ericdrosas87]

I also didn't both to change the name of the custom table from "universal*" to "canto*" since this table will be going away.

[khalwat]

Usually I add this to my project or system-wide .gitignore:

.idea

...unless you really want the PhpStorm meta attributes checked into your project.

[ericdrosas87]

That makes sense

[khalwat]

For inherited methods, typically the block comment should just be:

/**
 * @inheritdoc
 */

Which tells the IDE/documentation parser to use the docs from the parent method

[ericdrosas87]

Is there a way to automatically tell PhpStorm to do this?

[khalwat]

In general, you may find your code is more easily digestible if you use the "happy path" methodology:

https://lamp-dev.com/a-quick-guide-to-psr-coding-style-recommendations/1887#happy-path

Also sometimes called "early return", the idea is to reduce cognitive load by having your methods return early for exceptional conditions.

Similar to the section below this at the same URL in terms of avoiding if/else

Probably not worth a refactor for working code, just noting it.

[ericdrosas87]

This is an interesting comment to me - when working primarily with Java in a large enterprise environment we were always told to never "short circuit" a method/function and to only ever have a single return statement. Perhaps that's because of the monolithic methods/functions that exist in enterprise codebases?

[khalwat]

Overall looks good, as you said, mostly PhpStorm doing it's thing. I probably should have mentioned this ahead of time, but PhpStorm does help you automate moving namespaces:

https://www.jetbrains.com/help/phpstorm/move-refactorings.html#moving-php-namespace

Probably I can show you a few other tips to make using PhpStorm more efficient for you, but it looks like it's helping to clean things up already!