class FilenameGenerator in Entity Print 8.2

A service for generating filenames for printed documents.

Hierarchy

• class \Drupal\entity_print\FilenameGenerator implements FilenameGeneratorInterface

1 string reference to 'FilenameGenerator'

entity_print.services.yml in ./entity_print.services.yml

entity_print.services.yml

1 service uses FilenameGenerator

entity_print.filename_generator in ./entity_print.services.yml

Drupal\entity_print\FilenameGenerator

File

src/FilenameGenerator.php, line 10

Namespace

Drupal\entity_print

class FilenameGenerator implements FilenameGeneratorInterface {

  /**
   * The transliteration service.
   *
   * @var \Drupal\Component\Transliteration\TransliterationInterface
   */
  protected $transliteration;

  /**
   * FilenameGenerator constructor.
   *
   * @param \Drupal\Component\Transliteration\TransliterationInterface $transliteration
   *   Transliteration service.
   */
  public function __construct(TransliterationInterface $transliteration) {
    $this->transliteration = $transliteration;
  }

  /**
   * {@inheritdoc}
   */
  public function generateFilename(array $entities, callable $entity_label_callback = NULL) {
    $filenames = [];

    /** @var \Drupal\Core\Entity\EntityInterface $entity */
    foreach ($entities as $entity) {
      if ($label = trim($this
        ->sanitizeFilename($entity_label_callback ? $entity_label_callback($entity) : $entity
        ->label(), $entity
        ->language()
        ->getId()))) {
        $filenames[] = $label;
      }
    }
    return $filenames ? implode('-', $filenames) : static::DEFAULT_FILENAME;
  }

  /**
   * Gets a safe filename.
   *
   * @param string $filename
   *   The un-processed filename.
   * @param string $langcode
   *   The language of the filename.
   *
   * @return string
   *   The filename stripped to only safe characters.
   */
  protected function sanitizeFilename($filename, $langcode) {
    $transformed = $this->transliteration
      ->transliterate($filename, $langcode);
    return preg_replace("/[^A-Za-z0-9 ]/", '', $transformed);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FilenameGenerator::$transliteration	protected	property	The transliteration service.
FilenameGenerator::generateFilename	public	function	Generates a filename to be used for a printed document. Overrides FilenameGeneratorInterface::generateFilename
FilenameGenerator::sanitizeFilename	protected	function	Gets a safe filename.
FilenameGenerator::__construct	public	function	FilenameGenerator constructor.
FilenameGeneratorInterface::DEFAULT_FILENAME		constant	The filename used when we're unable to calculate a filename.