class SimpleSitemapCommands in Simple XML sitemap 4.x

Class SimpleSitemapCommands

Hierarchy

• class \Drupal\simple_sitemap\Commands\SimpleSitemapCommands extends \Drush\Commands\DrushCommands

1 string reference to 'SimpleSitemapCommands'

drush.services.yml in ./drush.services.yml

drush.services.yml

1 service uses SimpleSitemapCommands

simple_sitemap.commands in ./drush.services.yml

\Drupal\simple_sitemap\Commands\SimpleSitemapCommands

File

src/Commands/SimpleSitemapCommands.php, line 13

Namespace

Drupal\simple_sitemap\Commands

class SimpleSitemapCommands extends DrushCommands {

  /**
   * @var \Drupal\simple_sitemap\Manager\Generator
   */
  protected $generator;

  /**
   * SimplesitemapCommands constructor.
   *
   * @param \Drupal\simple_sitemap\Manager\Generator $generator
   */
  public function __construct(Generator $generator) {
    $this->generator = $generator;
    parent::__construct();
  }

  /**
   * Regenerate all XML sitemap variants or continue generation.
   *
   * @command simple-sitemap:generate
   *
   * @usage drush simple-sitemap:generate
   *   Regenerate all XML sitemap variants or continue generation.
   *
   * @validate-module-enabled simple_sitemap
   *
   * @aliases ssg, simple-sitemap-generate
   */
  public function generate() : void {
    $this->generator
      ->generateSitemap(QueueWorker::GENERATE_TYPE_DRUSH);
  }

  /**
   * Queue all or specific sitemap variants for regeneration.
   *
   * @command simple-sitemap:rebuild-queue
   *
   * @option variants
   *   Queue all or specific sitemap variants for regeneration.
   *
   * @usage drush simple-sitemap:rebuild-queue
   *   Rebuild the sitemap queue for all sitemap variants.
   * @usage drush simple-sitemap:rebuild-queue --variants=default,test
   *   Rebuild the sitemap queue queuing only variants 'default' and 'test'.
   *
   * @validate-module-enabled simple_sitemap
   *
   * @aliases ssr, simple-sitemap-rebuild-queue
   *
   * @param array $options
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginException
   */
  public function rebuildQueue(array $options = [
    'variants' => '',
  ]) : void {
    $variants = array_keys(SimpleSitemap::loadMultiple());
    if (strlen($options['variants']) > 0) {
      $chosen_variants = array_map('trim', array_filter(explode(',', $options['variants'])));
      if (!empty($erroneous_variants = array_diff($chosen_variants, $variants))) {
        $message = 'The following variants do not exist: ' . implode(', ', $erroneous_variants) . '. Available variants are: ' . implode(', ', $variants) . '.';
        $this
          ->logger()
          ->log('error', $message);
        return;
      }
      $variants = $chosen_variants;
    }
    $this->generator
      ->setVariants($variants)
      ->rebuildQueue();
    $this
      ->logger()
      ->log('notice', 'The following variants have been queued for regeneration: ' . implode(', ', $variants) . '.');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
SimpleSitemapCommands::$generator	protected	property
SimpleSitemapCommands::generate	public	function	Regenerate all XML sitemap variants or continue generation.
SimpleSitemapCommands::rebuildQueue	public	function	Queue all or specific sitemap variants for regeneration.
SimpleSitemapCommands::__construct	public	function	SimplesitemapCommands constructor.