Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
Public Member Functions | Data Fields
Sequence Class Reference
Inheritance diagram for Sequence:
SequenceInterface

Public Member Functions

 __construct (Meta $meta, AppResource $resource, $pattern=self::DEFAULT_PATTERN)
 
 getCurrentValue ()
 
 getNextValue ()
 

Data Fields

const DEFAULT_PATTERN = "%s%'.09d%s"
 

Detailed Description

Class Sequence represents sequence in logic

@api

Since
100.0.2

Definition at line 17 of file Sequence.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( Meta  $meta,
AppResource  $resource,
  $pattern = self::DEFAULT_PATTERN 
)
Parameters
Meta$meta
AppResource$resource
string$pattern

Definition at line 49 of file Sequence.php.

53  {
54  $this->meta = $meta;
55  $this->connection = $resource->getConnection('sales');
56  $this->pattern = $pattern;
57  }
$pattern
Definition: website.php:22
$resource
Definition: bulk.php:12

Member Function Documentation

◆ getCurrentValue()

getCurrentValue ( )

Retrieve current value

Returns
string

Implements SequenceInterface.

Definition at line 64 of file Sequence.php.

65  {
66  if (!isset($this->lastIncrementId)) {
67  return null;
68  }
69 
70  return sprintf(
71  $this->pattern,
72  $this->meta->getActiveProfile()->getPrefix(),
73  $this->calculateCurrentValue(),
74  $this->meta->getActiveProfile()->getSuffix()
75  );
76  }

◆ getNextValue()

getNextValue ( )

Retrieve next value

Returns
string

Implements SequenceInterface.

Definition at line 83 of file Sequence.php.

84  {
85  $this->connection->insert($this->meta->getSequenceTable(), []);
86  $this->lastIncrementId = $this->connection->lastInsertId($this->meta->getSequenceTable());
87  return $this->getCurrentValue();
88  }

Field Documentation

◆ DEFAULT_PATTERN

const DEFAULT_PATTERN = "%s%'.09d%s"

Default pattern for Sequence

Definition at line 22 of file Sequence.php.


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