GridStructure Class Reference

Inheritance diagram for GridStructure:

Public Member Functions
	__construct (ResourceConnection $resource, FlatScopeResolver $flatScopeResolver, array $columnTypesMap=[])
	delete ($index, array $dimensions=[])
	create ($index, array $fields, array $dimensions=[])

Protected Member Functions
	createFlatTable ($tableName, array $fields)

Protected Attributes
	$columnTypesMap

Detailed Description

Definition at line 14 of file GridStructure.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ResourceConnection	$resource,
		FlatScopeResolver	$flatScopeResolver,
		array	$columnTypesMap = []
	)

Parameters

ResourceConnection	$resource
FlatScopeResolver	$flatScopeResolver
array	$columnTypesMap

Definition at line 44 of file GridStructure.php.

      {
        $this->resource = $resource;
        $this->flatScopeResolver = $flatScopeResolver;
        $this->columnTypesMap = array_merge($this->columnTypesMap, $columnTypesMap);
    }

Member Function Documentation

create()

create	(		$index,
		array	$fields,
		array	$dimensions = []
	)

Parameters

string	$index
array	$fields
	Dimension[]	$dimensions

Returns

void

Implements IndexStructureInterface.

Definition at line 74 of file GridStructure.php.

    {
        $this->createFlatTable($this->flatScopeResolver->resolve($index, $dimensions), $fields);
    }

createFlatTable()

createFlatTable (   $tableName, array  $fields  )

protected

Parameters

string	$tableName
array	$fields

Exceptions

Definition at line 85 of file GridStructure.php.

    {
        $adapter = $this->getAdapter();
        $table = $adapter->newTable($tableName);
        $table->addColumn(
            'entity_id',
            Table::TYPE_INTEGER,
            10,
            ['unsigned' => true, 'nullable' => false, 'primary' => true],
            'Entity ID'
        );
        $searchableFields = [];
        foreach ($fields as $field) {
            if ($field['type'] === 'searchable') {
                $searchableFields[] = $field['name'];
            }
            $columnMap = isset($field['dataType']) && isset($this->columnTypesMap[$field['dataType']])
                ? $this->columnTypesMap[$field['dataType']]
                : ['type' => $field['dataType'], 'size' => isset($field['size']) ? $field['size'] : null];
            $name = $field['name'];
            $type = $columnMap['type'];
            $size = $columnMap['size'];
            if ($field['type'] === 'filterable') {
                $table->addIndex(
                    $this->resource->getIdxName($tableName, $name, AdapterInterface::INDEX_TYPE_INDEX),
                    $name,
                    ['type' => AdapterInterface::INDEX_TYPE_INDEX]
                );
            }
            $table->addColumn($name, $type, $size);
        }
        $table->addIndex(
            $this->resource->getIdxName(
                $tableName,
                $searchableFields,
                AdapterInterface::INDEX_TYPE_FULLTEXT
            ),
            $searchableFields,
            ['type' => AdapterInterface::INDEX_TYPE_FULLTEXT]
        );
        $adapter->createTable($table);
    }

delete()

delete	(		$index,
		array	$dimensions = []
	)

Parameters

string	$index
	Dimension[]	$dimensions

Returns

void

Implements IndexStructureInterface.

Definition at line 59 of file GridStructure.php.

    {
        $adapter = $this->getAdapter();
        $tableName = $this->flatScopeResolver->resolve($index, $dimensions);
        if ($adapter->isTableExists($tableName)) {
            $adapter->dropTable($tableName);
        }
    }

Field Documentation

$columnTypesMap

$columnTypesMap

protected

Initial value:

= [
        'varchar'    => ['type' => Table::TYPE_TEXT, 'size' => 255],
        'mediumtext' => ['type' => Table::TYPE_TEXT, 'size' => 16777216],
        'text'       => ['type' => Table::TYPE_TEXT, 'size' => 65536],
        'int'        => ['type' => Table::TYPE_INTEGER, 'size' => null],
        'date'       => ['type' => Table::TYPE_DATE, 'size' => null],
        'datetime'   => ['type' => Table::TYPE_DATETIME, 'size' => null],
        'timestamp'  => ['type' => Table::TYPE_TIMESTAMP, 'size' => null],
    ]

Definition at line 29 of file GridStructure.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/framework/Indexer/GridStructure.php