Magento 2: campo de cuadrícula de administrador personalizado: error al ordenar o filtrar

9

Agregué una columna personalizada a la cuadrícula de administración, como esta

<column name="customer_name" class="Vendor\Module\Ui\Component\Listing\Columns\CustomerName">
        <argument name="data" xsi:type="array">
            <item name="config" xsi:type="array">
                <item name="filter" xsi:type="string">text</item>
                <item name="editor" xsi:type="string">text</item>
                <item name="sortable" xsi:type="string">true</item>
                <item name="label" xsi:type="string" translate="true">Customer Name</item>
                <item name="sortOrder" xsi:type="number">30</item>
            </item>
        </argument>
    </column>

En mi clase CustomerName creo valores para esta columna:

public function prepareDataSource(array $dataSource)
{
    $fieldName = $this->getData('name');
    foreach ($dataSource['data']['items'] as & $item) {
        $customer = $this->customerRepository->getById($item['customer_id']);
        $name = $customer ? $customer->getFirstName().' <'.$customer->getEmail().'>' : '';
        $item[$fieldName] = $name;
    }
    return $dataSource;
}

Se muestra en la cuadrícula como se esperaba. Pero cuando trato de ordenar por esta columna o filtro, se produce un error

SQLSTATE[42S22]: Column not found: 1054 Unknown column 'customer_name' in 'order clause'

¿Cómo puedo arreglar esto?

ACTUALIZAR

Ahora trato de resolver este problema eliminando la clase CustomerName (y elimino la referencia a la misma en la etiqueta de columna en xml) y en su lugar agregué la función _renderFiltersBefore () en mi clase de colección

 protected function _renderFiltersBefore() {
     $joinTable = $this->getTable('customer_entity');
     $this->getSelect()->join($joinTable.' as customer_entity','main_table.customer_id = customer_entity.entity_id', array('*'));
     $this->getSelect()->columns('CONCAT(firstname," <",email,">") as customer_name');
     parent::_renderFiltersBefore();
}

Ahora la ordenación funciona, pero el filtrado no (obtiene el mismo error)

Anna
fuente

Respuestas:

13

Hay un método de fábrica que puede usar, y este es el addFilterToMap(). Donde el filtro de representación de Magento 2 simplemente reemplaza los sujetos de las condiciones en función de los campos asignados

puede llamarlo en el método _initSelect o _renderFiltersBefore .

para una columna simple que ya existe en la selección (buena para resolver errores ambiguos)

$this
     ->addFilterToMap('customer_id', 'ce.entity_id');

pero en su caso necesita mapear una expresión como

$this
    ->addFilterToMap(
       'customer_name ', 
       new \Zend_Db_Expr('CONCAT(ce.firstname," <",ce.email,">")')
    ); 

entonces la parte de condición de la consulta será en ... WHERE (CONCAT(ce.firstname," <",ce.email,">") LIKE '%@yippie.com%') ... lugar de ... WHERE (customer_name LIKE '%@yippie.com%') ...

también puede usar otro método de fábrica relacionado con la colección para usar expresiones en SELECTparte de la consulta

$this
    ->addExpressionFieldToSelect(
        'firstname',
        new \Zend_Db_Expr('CONCAT(ce.firstname," <",ce.email,">")'),
        []
    )

en vez de

$this->getSelect()->columns('CONCAT(ce.firstname," <",ce.email,">") as firstname');
Mammouth
fuente
¡Muchas gracias! Estuve luchando con esto durante medio día. ¿Dónde encontraste / aprendiste esto? Seguramente, no en los documentos?
Jānis Elmeris
como mencionaba la publicación original: tenía que agregar una columna personalizada a la cuadrícula de administración, con opciones de filtro y clasificación. Cuesta aproximadamente 1,5 días resolverlo (ofc con la menor huella)
Mammouth
Estoy tratando de mostrar tanto la factura como el pedido de venta increment_ids en mi cuadrícula de administración del módulo personalizado con el ID de incremento de pedido de venta se etiqueta como 'ordincrementid'. Aún así, incluso había usado addFilterToMap (); No puedo filtrar el pedido de venta increment_id. Devuelve este error => Columna 'increment_id' en donde la cláusula es ambigua
Pregunte Bytes
6

Me tomó algo de tiempo, pero descubrí esto

En mi listado xml:

<column name="firstname">
        <argument name="data" xsi:type="array">
            <item name="config" xsi:type="array">
                <item name="filter" xsi:type="string">text</item>
                <item name="editor" xsi:type="string">text</item>
                <item name="sortable" xsi:type="string">true</item>
                <item name="label" xsi:type="string" translate="true">Customer Name</item>
                <item name="sortOrder" xsi:type="number">30</item>
            </item>
        </argument>
    </column>

En Vendor \ Module \ Model \ ResourceModel \ SomeCustomModel \ Grid:

/**
 * adding email to customer name column
 */
protected function _initSelect()
{
    parent::_initSelect();
    $this->getSelect()->joinLeft(
        ['ce' => $this->getTable('customer_entity')],
        'main_table.customer_id = ce.entity_id',
        ['*']
    );

    $this->getSelect()->columns('CONCAT(ce.firstname," <",ce.email,">") as firstname');
    return $this;
}

En Vendor \ Module \ Model \ ResourceModel \ SomeCustomModel

/**
 * addding ability to filter by column with customer name and email
 */
protected function _renderFiltersBefore()
{
    $wherePart = $this->getSelect()->getPart(\Magento\Framework\DB\Select::WHERE);
    foreach ($wherePart as $key => $cond) {
        $wherePart[$key] = str_replace('`firstname`', 'CONCAT(firstname," <",email,">")', $cond);
    }
    $this->getSelect()->setPart(\Magento\Framework\DB\Select::WHERE, $wherePart);
    parent::_renderFiltersBefore();
}
Anna
fuente