Implement subnet ordering for sections module

[cmeissner]

Preflight checks

• I agree to follow the Code of Conduct.
• I have searched the issue tracker for a feature requests that matches the one I want to file, without success.
• I only submit one single feature per feature request.

Feature description

As worked out in #124, the list_order parameter does not work as expected and does not reflect in any gui setting. So we decided to implement subnet ordering for the section module to reflect the options available in gui.

Proposed solution

No response

Alternatives solution

No response

Additional context

No response

[cmeissner]

Some observations from sections controller, to help to better understand what is provided by API and shown in GUI.

Default behavior of a newly created section

Creating a section with everything left at default ...

--- will reflect in that entity, gathered via sections controller (via curl command)

curl -sk -XGET -H "phpipam-token: ${PHPIPAM_TOKEN}" "${PHPIPAM_API_URL}/sections/?filter_by=name&filter_value=issue_128_section" | jq

{
  "code": 200,
  "success": true,
  "data": [
    {
      "id": "21",
      "name": "issue_128_section",
      "description": "Test section for getting some insights for #128",
      "masterSection": "0",
      "permissions": "[]",
      "strictMode": "1",
      "subnetOrdering": "default",
      "order": null,
      "editDate": null,
      "showSubnet": "1",
      "showVLAN": "1",
      "showVRF": "1",
      "showSupernetOnly": "1",
      "DNS": null
    }
  ],
  "time": 0.011
}

Ordering options

From the GUI we can concluede there are 5 possible sorting options:

Concrete we have the following options which result in the following values from API:

GUI Option	API value
Default	default
Subnet, ascending	"subnet,asc"
Subnet, descending	"subnet,desc"
Description, ascending	"description,asc"
Description, descending	"description,desc"

Conclusion for Implementation

With this information we could conclude that we should either

1. support the API values as input for a subnet ordering parameter in the sections module, or
2. subnet ordering parameter should expect a dict with oder by (subnet, description) and directione (asc(ending), desc(ending)) as options

[cmeissner]

It could be discussed if the implementation of subnet ordering is needed at all, as it will only apply to ordering in the GUI.

[cmeissner]

Default behavior could be set in PHPIPAM setting under Display settings

[cmeissner]

@StevenH1901 would be great to get some input from you, as you originally brought up the topic of ordering. I would also prefer to get rid of the list_order parameter in the section module, as it is not clear what the API parameter is meant for.