module.get

Descrição

integer/array module.get(object parameters)

O método permite recuperar módulos de acordo com os parâmetros fornecidos.

Este método está disponível apenas para o tipo de usuário Super admin. As permissões para chamar o método podem ser revogadas nas configurações de função de usuário. Consulte Funções de usuário para mais informações.

Parâmetros

(object) Parâmetros que definem a saída desejada.

O método suporta os seguintes parâmetros.

Parâmetro	Tipo	Descrição
moduleids	ID/array	Retorna apenas módulos com os IDs fornecidos.
sortfield	string/array	Ordena o resultado pelas propriedades fornecidas. Valores possíveis: `moduleid`, `relative_path`.
countOutput	boolean	Esses parâmetros são descritos em Comentário de referência.
excludeSearch	boolean
filter	object
limit	integer
output	query
preservekeys	boolean
search	object
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean

Valores de retorno

(integer/array) Retorna:

um array de objetos;
a contagem de objetos recuperados, se o parâmetro countOutput tiver sido usado.

Exemplos

Recuperando um módulo pelo ID

Recupere todos os dados sobre os módulos "1", "2" e "25".

Requisição:

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

Resposta:

{
           "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
       }

Veja também

Fonte

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

Documentation