trait QuickAssetTrait in farmOS 2.x
Provides methods for working with assets.
Hierarchy
- trait \Drupal\farm_quick\Traits\QuickAssetTrait uses MessengerTrait, StringTranslationTrait
1 file declares its use of QuickAssetTrait
File
- modules/
core/ quick/ src/ Traits/ QuickAssetTrait.php, line 12
Namespace
Drupal\farm_quick\TraitsView source
trait QuickAssetTrait {
use MessengerTrait;
use StringTranslationTrait;
/**
* 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 an asset.
*
* @param array $values
* An array of values to initialize the asset with.
*
* @return \Drupal\asset\Entity\AssetInterface
* The asset entity that was created.
*/
public function createAsset(array $values = []) {
// Start a new asset entity with the provided values.
/** @var \Drupal\asset\Entity\AssetInterface $asset */
$asset = Asset::create($values);
// Track which quick form created the entity.
$asset->quick[] = $this
->getId();
// Save the asset.
$asset
->save();
// Display a message with a link to the asset.
$message = $this
->t('Asset created: <a href=":url">@name</a>', [
':url' => $asset
->toUrl()
->toString(),
'@name' => $asset
->label(),
]);
$this->messenger
->addStatus($message);
// Return the asset entity.
return $asset;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
MessengerTrait:: |
public | function | Sets the messenger. | |
QuickAssetTrait:: |
public | function | Create an asset. | |
QuickAssetTrait:: |
abstract protected | function | Get the plugin ID. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |