class GridFieldLazyLoader extends AbstractGridFieldComponent implements GridField_DataManipulator, GridField_HTMLProvider (View source)

GridFieldLazyLoader alters the {@link GridField} behavior to delay rendering of rows until the tab containing the GridField is selected by the user.

Traits

A class that can be instantiated or replaced via DI

Methods

static Injectable
create(array ...$args)

An implementation of the factory method, allows you to create an instance of a class

static Injectable
singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

getManipulatedData(GridField $gridField, SS_List $dataList)

Empty $datalist if the current request should be lazy loadable.

array
getHTMLFragments(GridField $gridField)

Apply an appropriate CSS class to $gridField based on whatever the current request is lazy loadable or not.

Details

static Injectable create(array ...$args)

An implementation of the factory method, allows you to create an instance of a class

This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.

This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create(SiteTree::class); $list = SiteTree::get();

Parameters

array ...$args

Return Value

Injectable

static Injectable singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).

Parameters

string $class

Optional classname to create, if the called class should not be used

Return Value

Injectable

The singleton instance

SS_List getManipulatedData(GridField $gridField, SS_List $dataList)

Empty $datalist if the current request should be lazy loadable.

Parameters

GridField $gridField
SS_List $dataList

Return Value

SS_List

array getHTMLFragments(GridField $gridField)

Apply an appropriate CSS class to $gridField based on whatever the current request is lazy loadable or not.

Parameters

GridField $gridField

Return Value

array