How is a custom entity's grid implemented?

dmitrii_fediuk · May 25, 2017, 5:04pm

Generic settings

oroinc/platform/blob/2.1.2/src/Oro/Bundle/EntityBundle/Resources/config/oro/datagrids.yml#L2-L55


custom-entity-grid:
    acl_resource: ~
    options:
        base_datagrid_class: Oro\Bundle\EntityBundle\Grid\CustomEntityDatagrid
        entityHint: entities
        export: true
        entity_pagination: true
    source:
        type: orm
        query:
            select:
                - ce.id
            from:
                - { table: ENTITY_NAME, alias: ce }
    columns: # no static columns
        id: {renderable: false} #required because of OrmSorterExtension
    properties:
        id: ~
        update_link:
            type: callback
            callable: "@oro_entity.event_listener.custom_entity_grid_listener->getLinkProperty"
            route: oro_entity_update
        view_link:
            type: callback
            callable: "@oro_entity.event_listener.custom_entity_grid_listener->getLinkProperty"
            route: oro_entity_view
        delete_link:
            type: callback
            callable: "@oro_entity.event_listener.custom_entity_grid_listener->getLinkProperty"
            route: oro_entity_delete
    actions:
        # TODO: add dynamic acl_resources
        view:
            type: navigate
            label: oro.grid.action.view
            icon: eye
            link: view_link
            rowAction: true
        update:
            type: navigate
            label: oro.grid.action.update
            icon: pencil-square-o
            link: update_link
        delete:
            type: delete
            label: oro.grid.action.delete
            icon: trash-o
            link: delete_link
    sorters:
        columns:
            id:
                data_name: ce.id
    filters:
        columns: []

Individual settings

github.com

oroinc/platform/blob/2.1.2/src/Oro/Bundle/DataGridBundle/Resources/views/macros.html.twig#L39-L55


{% set options  = {
    el: '#' ~ gridId,
    gridName: oro_datagrid_build_fullname(datagrid.name, datagrid.scope),
    builders: metaData.requireJSModules,
    metadata: metaData,
    data: data,
    enableFilters: enableFilters,
    enableToggleFilters: enableToggleFilters,
    filterContainerSelector: renderParams.filterContainerSelector is defined ? renderParams.filterContainerSelector : null,
    filtersStateElement: renderParams.filtersStateElement is defined ? renderParams.filtersStateElement : null,
    enableViews: renderParams.enableViews is defined ? renderParams.enableViews : enableFilters,
    showViewsInNavbar: renderParams.showViewsInNavbar is defined ? renderParams.showViewsInNavbar : false,
    showViewsInCustomElement: renderParams.showViewsInCustomElement is defined ? renderParams.showViewsInCustomElement : false,
    inputName: oro_datagrid_build_inputname(datagrid.name),
    themeOptions: renderParams.themeOptions|default({}),
    toolbarOptions: renderParams.toolbarOptions|default({})
} %}

The primary data (rows)

github.com

oroinc/platform/blob/2.1.2/src/Oro/Bundle/DataGridBundle/Resources/views/macros.html.twig#L29-L29


{% set data     = oro_datagrid_data(datagrid) %}

The `oro_datagrid_data` function

github.com

oroinc/platform/blob/2.1.2/src/Oro/Bundle/DataGridBundle/Twig/DataGridExtension.php#L103-L103


new \Twig_SimpleFunction('oro_datagrid_data', [$this, 'getGridData']),

It is an alias to Oro\Bundle\DataGridBundle\Twig\DataGridExtension::getGridData().

How is a custom entity's grid implemented?

Generic settings

Individual settings

The primary data (rows)

The oro_datagrid_data function

The `oro_datagrid_data` function