PHP Class Smile\ElasticsuiteThesaurus\Model\Thesaurus

Author: Romain Ruaud ([email protected])

Inheritance: extends Magento\Framework\Model\AbstractModel, implements Smile\ElasticsuiteThesaurus\Api\Data\ThesaurusInterface

Show file Open project: smile-sa/elasticsuite Class Usage Examples

Protected Properties

Property	Type	Description
$_eventObject	string	Parameter name in event In observer method you can use $observer->getEvent()->getThesaurus() in this case
$_eventPrefix	string	Prefix of model events names
$indexerRegistry	Magento\Framework\Indexer\IndexerRegistry

Public Methods

Method	Description
__construct ( Magento\Framework\Model\Context $context, Magento\Framework\Registry $registry, Magento\Framework\Indexer\IndexerRegistry $indexerRegistry, Magento\Framework\Model\ResourceModel\AbstractResource $resource = null, Magento\Framework\Data\Collection\AbstractDb $resourceCollection = null, array $data = [] )	PHP constructor
afterDeleteCommit ( )	Process after delete operations
afterSave ( )	Process after save operations
getName ( ) : string	Retrieve thesaurus name
getStoreIds ( ) : int[]	Get store ids
getTermsData ( ) : array	Get terms data
getThesaurusId ( ) : integer \| null	Get Thesaurus ID
getType ( ) : string	Retrieve thesaurus type
isActive ( ) : boolean	Get Thesaurus status
setIsActive ( boolean $status ) : Smile\ElasticsuiteThesaurus\Api\Data\ThesaurusInterface	Set Thesaurus status
setName ( string $name ) : Thesaurus	Set name
setStoreIds ( int[] $storeIds ) : Smile\ElasticsuiteThesaurus\Api\Data\ThesaurusInterface	Set store ids
setThesaurusId ( integer $identifier ) : Smile\ElasticsuiteThesaurus\Api\Data\ThesaurusInterface	Set Thesaurus ID
setType ( string $type ) : Smile\ElasticsuiteThesaurus\Api\Data\ThesaurusInterface	Set type

Protected Methods

Method	Description
_construct ( )	Internal Constructor

Private Methods

Method	Description
invalidateIndex ( )	Invalidate Thesaurus index

Method Details

__construct() public method

PHP constructor

public __construct ( Magento\Framework\Model\Context $context, Magento\Framework\Registry $registry, Magento\Framework\Indexer\IndexerRegistry $indexerRegistry, Magento\Framework\Model\ResourceModel\AbstractResource $resource = null, Magento\Framework\Data\Collection\AbstractDb $resourceCollection = null, array $data = [] )
$context	Magento\Framework\Model\Context	Magento Context
$registry	Magento\Framework\Registry	Magento Registry
$indexerRegistry	Magento\Framework\Indexer\IndexerRegistry	Indexers registry.
$resource	Magento\Framework\Model\ResourceModel\AbstractResource	Magento Resource
$resourceCollection	Magento\Framework\Data\Collection\AbstractDb	Magento Collection
$data	array	Magento Data

_construct() protected method

Internal Constructor

protected _construct ( )

afterDeleteCommit() public method

Process after delete operations

public afterDeleteCommit ( )

afterSave() public method

Process after save operations

public afterSave ( )

getName() public method

Retrieve thesaurus name

public getName ( ) : string
return	string

getStoreIds() public method

Get store ids

public getStoreIds ( ) : int[]
return	int[]

getTermsData() public method

Get terms data

public getTermsData ( ) : array
return	array

getThesaurusId() public method

Get Thesaurus ID

public getThesaurusId ( ) : integer \| null
return	integer \| null

getType() public method

Retrieve thesaurus type

public getType ( ) : string
return	string

isActive() public method

Get Thesaurus status

public isActive ( ) : boolean
return	boolean

setIsActive() public method

Set Thesaurus status

public setIsActive ( boolean $status ) : Smile\ElasticsuiteThesaurus\Api\Data\ThesaurusInterface
$status	boolean	The thesaurus status
return	Smile\ElasticsuiteThesaurus\Api\Data\ThesaurusInterface

setName() public method

Set name

public setName ( string $name ) : Thesaurus
$name	string	the value to save
return	Thesaurus

setStoreIds() public method

Set store ids

public setStoreIds ( int[] $storeIds ) : Smile\ElasticsuiteThesaurus\Api\Data\ThesaurusInterface
$storeIds	int[]	the store ids
return	Smile\ElasticsuiteThesaurus\Api\Data\ThesaurusInterface

setThesaurusId() public method

Set Thesaurus ID

public setThesaurusId ( integer $identifier ) : Smile\ElasticsuiteThesaurus\Api\Data\ThesaurusInterface
$identifier	integer	the value to save
return	Smile\ElasticsuiteThesaurus\Api\Data\ThesaurusInterface

setType() public method

Set type

public setType ( string $type ) : Smile\ElasticsuiteThesaurus\Api\Data\ThesaurusInterface
$type	string	the type of thesaurus to save
return	Smile\ElasticsuiteThesaurus\Api\Data\ThesaurusInterface

Property Details

$_eventObject protected property

Parameter name in event In observer method you can use $observer->getEvent()->getThesaurus() in this case

protected string $_eventObject
return	string

$_eventPrefix protected property

Prefix of model events names

protected string $_eventPrefix
return	string

$indexerRegistry protected property

protected IndexerRegistry,Magento\Framework\Indexer $indexerRegistry
return	Magento\Framework\Indexer\IndexerRegistry