Builder Class Reference

Inheritance diagram for Builder:

Public Member Functions
	__construct (ResourceMetadata $resourceMetadata, MetaFactory $metaFactory, ProfileFactory $profileFactory, AppResource $appResource, DdlSequence $ddlSequence, Logger $logger)
	setEntityType ($entityType)
	setStoreId ($storeId)
	setPrefix ($prefix)
	setSuffix ($suffix)
	setStartValue ($startValue)
	setStep ($step)
	setMaxValue ($maxValue)
	setWarningValue ($warningValue)
	create ()

Protected Member Functions
	getSequenceName ()

Protected Attributes
	$resourceMetadata
	$profileFactory
	$metaFactory
	$appResource
	$ddlSequence
	$required
	$pattern
	$data = []
	$logger

Detailed Description

Class Builder

@api @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Since

100.0.2

Definition at line 21 of file Builder.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ResourceMetadata	$resourceMetadata,
		MetaFactory	$metaFactory,
		ProfileFactory	$profileFactory,
		AppResource	$appResource,
		DdlSequence	$ddlSequence,
		Logger	$logger
	)

Parameters

ResourceMetadata	$resourceMetadata
MetaFactory	$metaFactory
ProfileFactory	$profileFactory
AppResource	$appResource
DdlSequence	$ddlSequence
Logger	$logger

Definition at line 94 of file Builder.php.

      {
        $this->resourceMetadata = $resourceMetadata;
        $this->metaFactory = $metaFactory;
        $this->profileFactory = $profileFactory;
        $this->appResource = $appResource;
        $this->ddlSequence = $ddlSequence;
        $this->logger = $logger;
        $this->data = array_flip($this->pattern);
    }

Member Function Documentation

create()

create

(

)

Create sequence with metadata and profile

Exceptions

Definition at line 214 of file Builder.php.

    {
        $metadata = $this->resourceMetadata->loadByEntityTypeAndStore(
            $this->data['entity_type'],
            $this->data['store_id']
        );
        if ($metadata->getSequenceTable() == $this->getSequenceName()) {
            return;
        }
        $this->data['sequence_table'] = $this->getSequenceName();
        $this->data['is_active'] = 1;
        $profile = $this->profileFactory->create(
            [
                'data' => array_intersect_key(
                    $this->data,
                    array_flip(
                        [
                            'prefix', 'suffix', 'start_value', 'step', 'max_value', 'warning_value',
                            'is_active', 'active_profile'
                        ]
                    )
                )
            ]
        );
        $profile->setHasDataChanges(true);
        $this->data['active_profile'] = $profile;
        $metadata = $this->metaFactory->create(
            [
                'data' => array_intersect_key(
                    $this->data,
                    array_flip(['entity_type', 'store_id', 'sequence_table', 'active_profile'])
                )
            ]
        );
        $metadata->setHasDataChanges(true);
        try {
            $this->resourceMetadata->save($metadata);
            $connection = $this->appResource->getConnection('sales');
            if (!$connection->isTableExists($this->data['sequence_table'])) {
                $connection->query(
                    $this->ddlSequence->getCreateSequenceDdl(
                        $this->data['sequence_table'],
                        $this->data['start_value']
                    )
                );
            }
        } catch (Exception $e) {
            $this->resourceMetadata->delete($metadata);
            $this->logger->critical($e);
            throw $e;
        }
        $this->data = array_flip($this->pattern);
    }

getSequenceName()

getSequenceName ( )

protected

Returns sequence table name

Returns

string

Definition at line 196 of file Builder.php.

    {
        return $this->appResource->getTableName(
            sprintf(
                'sequence_%s_%s',
                $this->data['entity_type'],
                $this->data['store_id']
            )
        );
    }

setEntityType()

setEntityType

(

$entityType

)

Parameters

string

$entityType

Returns

$this

Definition at line 115 of file Builder.php.

    {
        $this->data['entity_type'] = $entityType;
        return $this;
    }

setMaxValue()

setMaxValue

(

$maxValue

)

Parameters

int

$maxValue

Returns

$this

Definition at line 175 of file Builder.php.

    {
        $this->data['max_value'] = $maxValue;
        return $this;
    }

setPrefix()

setPrefix

(

$prefix

)

Parameters

string

$prefix

Returns

$this

Definition at line 135 of file Builder.php.

    {
        $this->data['prefix'] = $prefix;
        return $this;
    }

setStartValue()

setStartValue

(

$startValue

)

Parameters

int

$startValue

Returns

$this

Definition at line 155 of file Builder.php.

    {
        $this->data['start_value'] = $startValue;
        return $this;
    }

setStep()

setStep

(

$step

)

Parameters

int

$step

Returns

$this

Definition at line 165 of file Builder.php.

    {
        $this->data['step'] = $step;
        return $this;
    }

setStoreId()

setStoreId

(

$storeId

)

Parameters

int

$storeId

Returns

$this

Definition at line 125 of file Builder.php.

    {
        $this->data['store_id'] = $storeId;
        return $this;
    }

setSuffix()

setSuffix

(

$suffix

)

Parameters

string

$suffix

Returns

$this

Definition at line 145 of file Builder.php.

    {
        $this->data['suffix'] = $suffix;
        return $this;
    }

setWarningValue()

setWarningValue

(

$warningValue

)

Parameters

int

$warningValue

Returns

$this

Definition at line 185 of file Builder.php.

    {
        $this->data['warning_value'] = $warningValue;
        return $this;
    }

Field Documentation

$appResource

$appResource

protected

Definition at line 41 of file Builder.php.

$data

$data = []

protected

Definition at line 79 of file Builder.php.

$ddlSequence

$ddlSequence

protected

Definition at line 46 of file Builder.php.

$logger

$logger

protected

Definition at line 84 of file Builder.php.

$metaFactory

$metaFactory

protected

Definition at line 36 of file Builder.php.

$pattern

$pattern

protected

Initial value:

= [
        'entity_type',
        'store_id',
        'prefix',
        'suffix',
        'start_value',
        'step',
        'max_value',
        'warning_value',
    ]

Definition at line 63 of file Builder.php.

$profileFactory

$profileFactory

protected

Definition at line 31 of file Builder.php.

$required

$required

protected

Initial value:

= [
        'entityType',
        'storeId'
    ]

Definition at line 53 of file Builder.php.

$resourceMetadata

$resourceMetadata

protected

Definition at line 26 of file Builder.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/module-sales-sequence/Model/Builder.php