4.5.10 getLabel

La méthode getLabel permet de définir le libellé de la vue.

Ce libellé est accessible dans la structure retournée par l'api REST de récupération du rendu au moyen de la clé data.view.renderLabel.

/**
 * Get the label of this view
 * @return string the text label
 */
public function getLabel(\Doc $document=null);

4.5.10.1 Exemple

class ExampleRenderConfigView extends \Dcp\Ui\DefaultView
{
    public function getLabel(\Doc $document) {
        return "Example view";
    }
}

Retour du rendu suite à la requête de demande du rendu

http://www.example.net/api/v1/documents/1211/views/!defaultConsultation

data: {
    uri: "http://localhost/tmp32/api/v1/documents/1211/views/!defaultConsultation",
    properties: {
        requestIdentifier: "!defaultConsultation",
        identifier: "!coreConsultation",
        label: "Core View Consultation",
        uri: "http://localhost/tmp32/api/v1/documents/1211/views/!coreConsultation",
        ...
    },
    uri: "http://localhost/tmp32/api/v1/documents/1211/views/!defaultConsultation",
    view: {
        renderLabel: "Example view",
        documentData: {...}
        locale: {...}
        menu: [...]
        ...
    }
    ...
}

La variable data.properties.label contient le label système du rendu. Ce label est celui du contrôle de vue s'il est utilisé.

Source : server/renderConfig/methods/getLabel.md Dynacase Platform 3.2 | Document User Interface Manuel de référence, version 1.0 édition 2, © Labs <labs@anakeen.com>