Yearly.php in Commerce Core 8.2

Namespace

Drupal\commerce_number_pattern\Plugin\Commerce\NumberPattern

File

modules/number_pattern/src/Plugin/Commerce/NumberPattern/Yearly.php

<?php

namespace Drupal\commerce_number_pattern\Plugin\Commerce\NumberPattern;

use Drupal\commerce_number_pattern\Sequence;
use Drupal\Core\Datetime\DrupalDateTime;

/**
 * Provides a yearly number pattern.
 *
 * @CommerceNumberPattern(
 *   id = "yearly",
 *   label = @Translation("Yearly (Reset every year)"),
 * )
 */
class Yearly extends SequentialNumberPatternBase {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'pattern' => '[pattern:year]-[pattern:number]',
    ] + parent::defaultConfiguration();
  }

  /**
   * {@inheritdoc}
   */
  protected function shouldReset(Sequence $current_sequence) {

    // Reset the sequence if the current one is from a previous year.
    $generated_time = DrupalDateTime::createFromTimestamp($current_sequence
      ->getGeneratedTime());
    $current_time = DrupalDateTime::createFromTimestamp($this->time
      ->getCurrentTime());
    return $generated_time
      ->format('Y') != $current_time
      ->format('Y');
  }

}

Classes

Name	Description
Yearly	Provides a yearly number pattern.