QuickLogTrait.php in farmOS 2.x

Namespace

Drupal\farm_quick\Traits

File

modules/core/quick/src/Traits/QuickLogTrait.php

<?php

namespace Drupal\farm_quick\Traits;

use Drupal\Core\Messenger\MessengerTrait;
use Drupal\Core\StringTranslation\StringTranslationTrait;
use Drupal\log\Entity\Log;

/**
 * Provides methods for working with logs.
 */
trait QuickLogTrait {
  use MessengerTrait;
  use StringTranslationTrait;
  use QuickQuantityTrait;

  /**
   * Get the plugin ID.
   *
   * This must be implemented by the quick form class that uses this trait.
   *
   * @return string
   *   The quick form ID.
   */
  protected abstract function getId();

  /**
   * Create a log.
   *
   * @param array $values
   *   An array of values to initialize the log with.
   *
   * @return \Drupal\log\Entity\LogInterface
   *   The log entity that was created.
   */
  public function createLog(array $values = []) {

    // Start a new log entity with the provided values.

    /** @var \Drupal\log\Entity\LogInterface $log */
    $log = Log::create($values);

    // If quantity measurements are provided, create quantity entities and
    // reference them from the log.
    if (!empty($values['quantity'])) {
      foreach ($values['quantity'] as $qty) {
        $log->quantity[] = $this
          ->createQuantity($qty);
      }
    }

    // If not specified, set the log's status to "done".
    if (!isset($values['status'])) {
      $log->status = 'done';
    }

    // Track which quick form created the entity.
    $log->quick[] = $this
      ->getId();

    // Save the log.
    $log
      ->save();

    // Display a message with a link to the log.
    $message = $this
      ->t('Log created: <a href=":url">@name</a>', [
      ':url' => $log
        ->toUrl()
        ->toString(),
      '@name' => $log
        ->label(),
    ]);
    $this->messenger
      ->addStatus($message);

    // Return the log entity.
    return $log;
  }

}

Traits

Name	Description
QuickLogTrait	Provides methods for working with logs.