3.0.0: Q: what is the logic for the class and namespace sorting ? (template: default)

[jrfnl]

Template issue/request

I'm wondering what the logic is behind the sorting of the classes/namespaces on the index.html, Global namespace and individual namespace pages.
With files all being in the same directory - src - and all following the same naming convention, I'm seeing some, well, interesting sorting.... (screenshot from the demo issue repo)

[mvriel]

I'm probably missing the obvious but can you specify what you find interesting specifically? That helps me to answer the question :)

[jrfnl]

@mvriel Sorry, my bad. I'd expect an alphabetically ordered list (natural sort order). That's currently not the case.

This should hopefully make it clearer:

[ghost]

I am having the same problem, sorting is broken and the results look wrong. For example, in my case names starting with a "c" are at the top and those starting with a "b" are at the bottom.

I took a quick look at the template source and found this example:

            {% if package.children is not empty %}
            <ul class="phpdocumentor-list">
                {% for child in package.children %}
                    <li>{{ child|route('class:short') }}</li>
                {% endfor %}
            </ul>
            {% endif %}

It appears that the for loop is not using "|sort" as is typical in twig templates? I tried to add it but got a php error that nesting is level is too deep.

[ghost]

It would be nice if this was fixed in the up coming 3.1 version.

[jaapio]

Thanks for reminding me of this issue.

Unfortunately, we didn't have time to fix this in the upcoming release.

[ghost]

I understand that you only release a new version twice a year, but this issue makes phpDocumentor quite hard to use properly with my users trying text search because sorting is broken. Could you please consider releasing a minor point version with some issues fixed? Waiting for version 3.2 to be released in 6 months... is not ideal.

Thank you.

[jaapio]

Hi,

Thanks for your response. It is correct that we try to release 2 versions each year. This is already more often than we did before. phpDocumentor is maintained by a small number of people. It is mostly me, who is doing the major part of the work. And I have to make choices. phpDocumentor is quite a complex project. Users expect us to go with the newest php-versions. Each php version upgrade takes me already so much time that I nearly have time to fix minor issues like this bug. Since I have to do this next to my full-time job and day-to-day life.

I'm deeply sorry that phpDocumentor doesn't work for you right now. And if I had the time to fix this issue myself, it could have been fixed already. But this is not the case. I would be happy to review and accept a PR for this bug. If you need any help to provide a fix I'm here to help you and give you some guidance on what needs to be done.

If we have fixed this issue, the nightly builds should provide you a proper working version to work with. There is from my point of view no specific reason to wait for a release.

Thanks in advance for your help.