acsf_variables.drush.inc in Acquia Cloud Site Factory Connector 8

Provides drush commands for the acsf_variables module.

File

acsf_variables/acsf_variables.drush.inc

<?php

/**
 * @file
 * Provides drush commands for the acsf_variables module.
 */

/**
 * Implements hook_drush_command().
 */
function acsf_variables_drush_command() {
  return [
    'acsf-vget' => [
      'description' => dt('Retrieves a named ACSF variable.'),
      'arguments' => [
        'name' => dt('The name of the variable to retrieve.'),
      ],
      'options' => [
        'format' => [
          'description' => dt('Format to output the object. Use "var_export" for var_export (default), and "json" for JSON.'),
          'example-value' => 'json',
        ],
        'exact' => dt('Only retrieve the exact variable name specified.'),
      ],
    ],
    'acsf-vset' => [
      'description' => dt('Sets a named ACSF variable with an optional group.'),
      'arguments' => [
        'name' => dt('The name of the variable to set.'),
        'value' => dt('The value of the variable to set.'),
      ],
      'options' => [
        'group' => dt('An optional group name for the variable.'),
      ],
    ],
    'acsf-vget-group' => [
      'description' => dt('Retrieves a group of variables.'),
      'arguments' => [
        'group' => dt('The group name of the variable to retrieve.'),
      ],
      'options' => [
        'format' => [
          'description' => dt('Format to output the object. Use "var_export" for var_export (default), and "json" for JSON.'),
          'example-value' => 'json',
        ],
      ],
    ],
    'acsf-vdel' => [
      'description' => dt('Deletes a named variable.'),
      'arguments' => [
        'name' => dt('The name of the variable to delete.'),
      ],
    ],
    'acsf-info' => [
      'description' => dt('Retrieves info about a site.'),
    ],
  ];
}

/**
 * Command callback. Retrieves a named ACSF variable.
 */
function drush_acsf_variables_acsf_vget($name) {
  if (!\Drupal::moduleHandler()
    ->moduleExists('acsf_variables')) {
    return drush_set_error(dt('The acsf_variables module must be enabled.'));
  }
  if (empty($name)) {
    return drush_set_error(dt('You must provide the name of the variable to retrieve as the first argument.'));
  }
  $format = drush_get_option('format', 'var_export');
  $exact = drush_get_option('exact');
  if ($exact) {
    if (($value = \Drupal::service('acsf.variable_storage')
      ->get($name)) && !is_null($value)) {
      $variables[$name] = $value;
    }
  }
  else {
    $variables = \Drupal::service('acsf.variable_storage')
      ->getMatch($name);
  }
  if (!empty($variables)) {
    foreach ($variables as $variable_name => $variable) {
      if ($format == 'json') {
        $value = drush_format($variable, NULL, $format);
      }
      else {
        $value = dt('@name: !value', [
          '@name' => $variable_name,
          '!value' => drush_format($variable, NULL, $format),
        ]);
      }
      drush_print($value);
    }
  }
  else {
    return drush_set_error(dt('@name not found.', [
      '@name' => $name,
    ]));
  }
}

/**
 * Command callback. Sets a named variable with an optional group.
 */
function drush_acsf_variables_acsf_vset($name, $value) {
  if (!\Drupal::moduleHandler()
    ->moduleExists('acsf_variables')) {
    return drush_set_error(dt('The acsf_variables module must be enabled.'));
  }
  if (empty($name)) {
    return drush_set_error(dt('You must provide the name of the variable to set as the first argument.'));
  }
  if (empty($value)) {
    return drush_set_error(dt('You must provide the value of the variable to set as the second argument.'));
  }
  if (\Drupal::service('acsf.variable_storage')
    ->set($name, $value, drush_get_option('group'))) {
    drush_print(dt('@name was set to !value', [
      '@name' => $name,
      '!value' => $value,
    ]));
  }
  else {
    return drush_set_error(dt('The @name variable could not be set.'));
  }
}

/**
 * Command callback. Retrieves a group of variables.
 */
function drush_acsf_variables_acsf_vget_group($group) {
  if (!\Drupal::moduleHandler()
    ->moduleExists('acsf_variables')) {
    return drush_set_error(dt('The acsf_variables module must be enabled.'));
  }
  if (empty($group)) {
    return drush_set_error(dt('You must provide the group name of the variables to retrieve as the first argument.'));
  }
  $format = drush_get_option('format', 'var_export');
  if ($data = \Drupal::service('acsf.variable_storage')
    ->getGroup($group)) {
    if ($format == 'json') {
      $value = drush_format($data, NULL, $format);
    }
    else {
      $value = dt('@group: !value', [
        '@group' => $group,
        '!value' => drush_format($data, NULL, $format),
      ]);
    }
    drush_print($value);
  }
  else {
    return drush_set_error(dt('@group group not found.', [
      '@group' => $group,
    ]));
  }
}

/**
 * Command callback. Deletes a named variable.
 */
function drush_acsf_variables_acsf_vdel($name) {
  if (!\Drupal::moduleHandler()
    ->moduleExists('acsf_variables')) {
    return drush_set_error(dt('The acsf_variables module must be enabled.'));
  }
  if (empty($name)) {
    return drush_set_error(dt('You must provide the name of the variable to delete as the first argument.'));
  }
  $storage = \Drupal::service('acsf.variable_storage');
  if ($variable = $storage
    ->get($name)) {
    if ($storage
      ->delete($name)) {
      drush_print(dt('@name was deleted.', [
        '@name' => $name,
      ]));
    }
    else {
      return drush_set_error(dt('Unable to delete the @name variable.', [
        '@name' => $name,
      ]));
    }
  }
  else {
    return drush_set_error(dt('@name not found.', [
      '@name' => $name,
    ]));
  }
}

/**
 * Command callback. Prints information about the site.
 */
function drush_acsf_variables_acsf_info() {
  drush_print(drush_format(\Drupal::service('acsf.variable_storage')
    ->get('acsf_site_info'), NULL, 'var_export'));
}

Functions

Name	Description
acsf_variables_drush_command	Implements hook_drush_command().
drush_acsf_variables_acsf_info	Command callback. Prints information about the site.
drush_acsf_variables_acsf_vdel	Command callback. Deletes a named variable.
drush_acsf_variables_acsf_vget	Command callback. Retrieves a named ACSF variable.
drush_acsf_variables_acsf_vget_group	Command callback. Retrieves a group of variables.
drush_acsf_variables_acsf_vset	Command callback. Sets a named variable with an optional group.