module.get

Opis

integer/array module.get(object parameters)

Ta metoda umożliwia pobieranie modułów zgodnie z podanymi parametrami.

Ta metoda jest dostępna wyłącznie dla użytkownika typu Super admin. Uprawnienia do wywoływania tej metody mogą zostać cofnięte w ustawieniach roli użytkownika. Więcej informacji można znaleźć w Rolach użytkowników.

Parametry

(object) Parametry definiujące żądane dane wyjściowe.

Metoda obsługuje następujące parametry.

Parametr Typ Opis
moduleids ID/array Zwraca tylko moduły o podanych identyfikatorach.
sortfield string/array Sortuje wynik według podanych właściwości.

Możliwe wartości: moduleid, relative_path.
countOutput boolean Te parametry są opisane w komentarzu referencyjnym.
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Zwracane wartości

(integer/array) Zwraca:

  • tablicę obiektów;
  • liczbę pobranych obiektów, jeśli użyto parametru countOutput.

Przykłady

Pobieranie modułu według ID

Pobierz wszystkie dane o modułach „1”, „2” i „25”.

Żądanie:

{
    "jsonrpc": "2.0",
    "method": "module.get",
    "params": {
        "output": "extend",
        "moduleids": [
            "1",
            "2",
            "25"
        ]
    },
    "id": 1
}

Odpowiedź:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "moduleid": "1",
            "id": "actionlog",
            "relative_path": "widgets/actionlog",
            "status": "1",
            "config": []
        },
        {
            "moduleid": "2",
            "id": "clock",
            "relative_path": "widgets/clock",
            "status": "1",
            "config": []
        },
        {
            "moduleid": "25",
            "id": "example",
            "relative_path": "modules/example_module",
            "status": "1",
            "config": []
        }
    ],
    "id": 1
}

Zobacz także

Źródło

CModule::get() w ui/include/classes/api/services/CModule.php.