PHP Class Sulu\Bundle\SearchBundle\Search\Configuration\IndexConfiguration

Show file Open project: sulu/sulu

Public Methods

Method Description
__construct ( string $indexName, string $name = null, string $securityContext = null, array $contexts = [] )
getContexts ( ) : array Returns the contexts for which the index should be returned.
getIndexName ( ) : string Returns the name of the index.
getName ( ) : string Returns the already translated name for the index. Should only be used for non-translatable names. Useful for displaying in the user interface.
getSecurityContext ( ) : string Returns the security context required to access index.

Method Details

__construct() public method

public __construct ( string $indexName, string $name = null, string $securityContext = null, array $contexts = [] )
$indexName string The name of the index
$name string The name of the index for the user interface
$securityContext string The required security context to access the index
$contexts array The contexts for which this index should be returned

getContexts() public method

Returns the contexts for which the index should be returned.
public getContexts ( ) : array
return array

getIndexName() public method

Returns the name of the index.
public getIndexName ( ) : string
return string

getName() public method

Returns the already translated name for the index. Should only be used for non-translatable names. Useful for displaying in the user interface.
public getName ( ) : string
return string

getSecurityContext() public method

Returns the security context required to access index.
public getSecurityContext ( ) : string
return string