1. Documentation
  2. API
  3. Backend
  4. Classes
  5. ListColumn

Backend\Classes\ListColumn

Overview

ListColumn definition is a translation of the list column configuration

Extends
Implements
  • Illuminate\Contracts\Support\Arrayable
  • ArrayAccess
  • Illuminate\Contracts\Support\Jsonable
  • JsonSerializable

Public Properties

There are no public properties in the class.

Show inherited public properties

Inherited Public Properties

Protected Properties

There are no protected properties in the class.

Show inherited protected properties

Inherited Protected Properties

Public Methods

public __construct()

public __construct($config = [], $label = null): void

__construct using old and new interface

public evalConfig()

public evalConfig($config): void

public getAlignClass()

public getAlignClass(): string

getAlignClass returns the column specific alignment css class.

public getDisplayValue()

public getDisplayValue($value): void

getDisplayValue checks to see if display values (model attributes) should be translated, and also escapes the value

public getId()

public getId(string $suffix = null): string

getId returns a value suitable for the column id property.

public getName()

public getName(): string

getName returns a HTML valid name for the column name.

public getValueFromData()

public getValueFromData(mixed $data, mixed $default = null): mixed

getValueFromData returns this columns value from a supplied data set, which can be an array or a model or another generic collection.

public useRelationCount()

public useRelationCount(): bool

Show inherited public methods

Inherited Public Methods

Protected Methods

protected getColumnNameFromData()

protected getColumnNameFromData(
    string $columnName,
    mixed $data,
    mixed $default = null
): mixed

Internal method to extract the value of a column name from a data set.

protected initDefaultValues()

protected initDefaultValues(): void

initDefaultValues for this field

Show inherited protected methods

Inherited Protected Methods