class DevelGenerateBase
Same name in other branches
- 4.x devel_generate/src/DevelGenerateBase.php \Drupal\devel_generate\DevelGenerateBase
- 5.x devel_generate/src/DevelGenerateBase.php \Drupal\devel_generate\DevelGenerateBase
Provides a base DevelGenerate plugin implementation.
Hierarchy
- class \Drupal\devel_generate\DevelGenerateBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\devel_generate\DevelGenerateBaseInterface
Expanded class hierarchy of DevelGenerateBase
7 files declare their use of DevelGenerateBase
- ContentDevelGenerate.php in devel_generate/
src/ Plugin/ DevelGenerate/ ContentDevelGenerate.php - devel_generate.module in devel_generate/
devel_generate.module - ExampleDevelGenerate.php in devel_generate/
tests/ modules/ devel_generate_example/ src/ Plugin/ DevelGenerate/ ExampleDevelGenerate.php - MenuDevelGenerate.php in devel_generate/
src/ Plugin/ DevelGenerate/ MenuDevelGenerate.php - TermDevelGenerate.php in devel_generate/
src/ Plugin/ DevelGenerate/ TermDevelGenerate.php
File
-
devel_generate/
src/ DevelGenerateBase.php, line 14
Namespace
Drupal\devel_generateView source
abstract class DevelGenerateBase extends PluginBase implements DevelGenerateBaseInterface {
/**
* The plugin settings.
*
* @var array
*/
protected $settings = array();
/**
* The random data generator.
*
* @var \Drupal\Component\Utility\Random
*/
protected $random;
/**
* {@inheritdoc}
*/
public function getSetting($key) {
// Merge defaults if we have no value for the key.
if (!array_key_exists($key, $this->settings)) {
$this->settings = $this->getDefaultSettings();
}
return isset($this->settings[$key]) ? $this->settings[$key] : NULL;
}
/**
* {@inheritdoc}
*/
public function getDefaultSettings() {
$definition = $this->getPluginDefinition();
return $definition['settings'];
}
/**
* {@inheritdoc}
*/
public function getSettings() {
return $this->settings;
}
/**
* {@inheritdoc}
*/
public function settingsForm(array $form, FormStateInterface $form_state) {
return array();
}
/**
* {@inheritdoc}
*/
function settingsFormValidate(array $form, FormStateInterface $form_state) {
// Validation is optional.
}
/**
* {@inheritdoc}
*/
public function generate(array $values) {
$this->generateElements($values);
$this->setMessage('Generate process complete.');
}
/**
* Business logic relating with each DevelGenerate plugin
*
* @param array $values
* The input values from the settings form.
*/
protected function generateElements(array $values) {
}
/**
* Populate the fields on a given entity with sample values.
*
* @param \Drupal\Core\Entity\EntityInterface $entity
* The entity to be enriched with sample field values.
*/
public static function populateFields(EntityInterface $entity) {
/** @var \Drupal\field\FieldConfigInterface[] $instances */
$instances = entity_load_multiple_by_properties('field_config', array(
'entity_type' => $entity->getEntityType()
->id(),
'bundle' => $entity->bundle(),
));
if ($skips = function_exists('drush_get_option') ? drush_get_option('skip-fields', '') : @$_REQUEST['skip-fields']) {
foreach (explode(',', $skips) as $skip) {
unset($instances[$skip]);
}
}
foreach ($instances as $instance) {
$field_storage = $instance->getFieldStorageDefinition();
$max = $cardinality = $field_storage->getCardinality();
if ($cardinality == FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED) {
// Just an arbitrary number for 'unlimited'
$max = rand(1, 3);
}
$field_name = $field_storage->getName();
$entity->{$field_name}
->generateSampleItems($max);
}
}
/**
* {@inheritdoc}
*/
public function handleDrushParams($args) {
}
/**
* Set a message for either drush or the web interface.
*
* @param string $msg
* The message to display.
* @param string $type
* (optional) The message type, as defined by drupal_set_message(). Defaults
* to 'status'
*/
protected function setMessage($msg, $type = 'status') {
$function = 'drupal_set_message';
if (function_exists('drush_log')) {
$function = 'drush_log';
$msg = strip_tags($msg);
}
$function($msg, $type);
}
/**
* Check if a given param is a number.
*
* @param mixed $number
* The parameter to check.
*
* @return bool
* TRUE if the parameter is a number, FALSE otherwise.
*/
public static function isNumber($number) {
if ($number == NULL) {
return FALSE;
}
if (!is_numeric($number)) {
return FALSE;
}
return TRUE;
}
/**
* Returns the random data generator.
*
* @return \Drupal\Component\Utility\Random
* The random data generator.
*/
protected function getRandom() {
if (!$this->random) {
$this->random = new Random();
}
return $this->random;
}
protected function isDrush8() {
return function_exists('drush_drupal_load_autoloader');
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
DevelGenerateBase::$random | protected | property | The random data generator. | ||
DevelGenerateBase::$settings | protected | property | The plugin settings. | ||
DevelGenerateBase::generate | public | function | Execute the instructions in common for all DevelGenerate plugin | Overrides DevelGenerateBaseInterface::generate | |
DevelGenerateBase::generateElements | protected | function | Business logic relating with each DevelGenerate plugin | 6 | |
DevelGenerateBase::getDefaultSettings | public | function | Returns the default settings for the plugin. | Overrides DevelGenerateBaseInterface::getDefaultSettings | |
DevelGenerateBase::getRandom | protected | function | Returns the random data generator. | ||
DevelGenerateBase::getSetting | public | function | Returns the array of settings, including defaults for missing settings. | Overrides DevelGenerateBaseInterface::getSetting | |
DevelGenerateBase::getSettings | public | function | Returns the current settings for the plugin. | Overrides DevelGenerateBaseInterface::getSettings | |
DevelGenerateBase::handleDrushParams | public | function | |||
DevelGenerateBase::isDrush8 | protected | function | |||
DevelGenerateBase::isNumber | public static | function | Check if a given param is a number. | ||
DevelGenerateBase::populateFields | public static | function | Populate the fields on a given entity with sample values. | ||
DevelGenerateBase::setMessage | protected | function | Set a message for either drush or the web interface. | ||
DevelGenerateBase::settingsForm | public | function | Returns the form for the plugin. | Overrides DevelGenerateBaseInterface::settingsForm | 6 |
DevelGenerateBase::settingsFormValidate | function | Form validation handler. | Overrides DevelGenerateBaseInterface::settingsFormValidate | 1 | |
DevelGenerateBaseInterface::validateDrushParams | function | Responsible for validating Drush params. | 6 |