PHP Interface Sulu\Component\SmartContent\Configuration\BuilderInterface

Show file Open project: sulu/sulu

Public Methods

Method Description
create ( )
enableCategories ( boolean | true $enable = true ) : Sulu\Component\SmartContent\Configuration\BuilderInterface Enables categories.
enableDatasource ( string $component, array $options = [] ) : Sulu\Component\SmartContent\Configuration\BuilderInterface Enables datasource.
enableLimit ( boolean | true $enable = true ) : Sulu\Component\SmartContent\Configuration\BuilderInterface Enables limit.
enablePagination ( boolean | true $enable = true ) : Sulu\Component\SmartContent\Configuration\BuilderInterface Enables pagination.
enablePresentAs ( boolean | true $enable = true ) : Sulu\Component\SmartContent\Configuration\BuilderInterface Enables present as.
enableSorting ( array $sorting ) : Sulu\Component\SmartContent\Configuration\BuilderInterface Enables categories.
enableTags ( boolean | true $enable = true ) : Sulu\Component\SmartContent\Configuration\BuilderInterface Enables tags.
getConfiguration ( ) : Sulu\Component\SmartContent\Configuration\ProviderConfigurationInterface Returns build configuration.
setDeepLink ( string $deepLink ) : Sulu\Component\SmartContent\Configuration\BuilderInterface Set deep-link.

Method Details

create() public static method

public static create ( )

enableCategories() public method

Enables categories.
public enableCategories ( boolean | true $enable = true ) : Sulu\Component\SmartContent\Configuration\BuilderInterface
$enable boolean | true
return Sulu\Component\SmartContent\Configuration\BuilderInterface

enableDatasource() public method

Enables datasource.
public enableDatasource ( string $component, array $options = [] ) : Sulu\Component\SmartContent\Configuration\BuilderInterface
$component string name of component
$options array options to initialized component
return Sulu\Component\SmartContent\Configuration\BuilderInterface

enableLimit() public method

Enables limit.
public enableLimit ( boolean | true $enable = true ) : Sulu\Component\SmartContent\Configuration\BuilderInterface
$enable boolean | true
return Sulu\Component\SmartContent\Configuration\BuilderInterface

enablePagination() public method

Enables pagination.
public enablePagination ( boolean | true $enable = true ) : Sulu\Component\SmartContent\Configuration\BuilderInterface
$enable boolean | true
return Sulu\Component\SmartContent\Configuration\BuilderInterface

enablePresentAs() public method

Enables present as.
public enablePresentAs ( boolean | true $enable = true ) : Sulu\Component\SmartContent\Configuration\BuilderInterface
$enable boolean | true
return Sulu\Component\SmartContent\Configuration\BuilderInterface

enableSorting() public method

Enables categories.
public enableSorting ( array $sorting ) : Sulu\Component\SmartContent\Configuration\BuilderInterface
$sorting array array of arrays with keys column and title (translation key)
return Sulu\Component\SmartContent\Configuration\BuilderInterface

enableTags() public method

Enables tags.
public enableTags ( boolean | true $enable = true ) : Sulu\Component\SmartContent\Configuration\BuilderInterface
$enable boolean | true
return Sulu\Component\SmartContent\Configuration\BuilderInterface

getConfiguration() public method

Returns build configuration.
public getConfiguration ( ) : Sulu\Component\SmartContent\Configuration\ProviderConfigurationInterface
return Sulu\Component\SmartContent\Configuration\ProviderConfigurationInterface