function drush_ds_field in Display Suite 8.3

Same name and namespace in other branches

1. 8.2 drush/ds.drush.inc \drush_ds_field()

Create a Display Suite plugin.

File

drush/ds.drush.inc, line 240

Display Suite drush integration.

Code

function drush_ds_field($name = NULL) {

  // Determine the layout name.
  if (!isset($name)) {
    $name = drush_get_option('name');
  }
  if (!$name) {
    drush_die(dt('You need to set a name for your field class'));
  }

  // We assume you run this command in the root of your module
  // Fetch the current path.
  $current_path = drush_cwd();

  // Fetch the module name from the path.
  $parts = explode('/', $current_path);
  $module_name = end($parts);

  // Class path.
  $class_path = $current_path . "/src/Plugin/DsField/";
  drush_mkdir($class_path);

  // Determine the path to our example layout templates.
  $ds_class_path = dirname(__FILE__);

  // Copy the example templates.
  drush_op('copy', $ds_class_path . '/ExampleField.php', $class_path . "/{$name}.php");

  // Prepare an array of things that need to be rewritten in our class.
  $find = [];
  $replace = [];

  // Replace example text.
  $find[] = '/ExampleField/';
  $replace[] = $name;
  $find[] = '/example_field/';
  $replace[] = $module_name;

  // Determine entity_type.
  $entity_type = drush_get_option('entity');
  if ($entity_type) {
    $find[] = '/entity_type = \\"node\\"/';
    $replace[] = 'entity_type = "' . $entity_type . '"';
  }

  // Rewrite class.
  drush_op('ds_file_preg_replace', [
    $class_path . "/{$name}.php",
  ], $find, $replace);

  // Notify user of the newly created class.
  drush_print(dt('"@name" class created in: @class_path', [
    '@name' => $name,
    '@class_path' => $class_path,
  ]));
}