ColumnConfigurationServiceInterface.php

<?php
declare(strict_types=1);

/**
 * Pimcore
 *
 * This source file is available under two different licenses:
 * - GNU General Public License version 3 (GPLv3)
 * - Pimcore Commercial License (PCL)
 * Full copyright and license information is available in
 * LICENSE.md which is distributed with this source code.
 *
 *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
 *  @license    http://www.pimcore.org/license     GPLv3 and PCL
 */

namespace Pimcore\Bundle\StudioBackendBundle\Grid\Service;

use Pimcore\Bundle\StudioBackendBundle\Grid\Schema\ColumnConfiguration;
use Pimcore\Bundle\StudioBackendBundle\Grid\Util\ColumnFieldDefinition;

/**
 * @internal
 */
interface ColumnConfigurationServiceInterface
{
    /**
     * @return ColumnConfiguration[]
     */
    public function getAvailableAssetColumnConfiguration(): array;

    /**
     * @return ColumnConfiguration[]
     */
    public function getAvailableDataObjectColumnConfiguration(string $classId, int $folderId): array;

    /**
     * @return ColumnConfiguration[]
     */
    public function getSystemDataObjectColumnConfiguration(): array;

    /**
     * Builds a column configuration for a data object adapter column.
     * key type and is optional and can be used to build a column configuration for a specific key type.
     */
    public function buildDataObjectAdapterColumnConfiguration(
        ColumnFieldDefinition $definition,
        ?string $type = null,
        ?string $key = null,
        ?array $additionalConfig = null
    ): ColumnConfiguration;
}