VLMAppendCommand.php in Views Load More 2.x

Namespace

Drupal\views_load_more\Ajax

File

src/Ajax/VLMAppendCommand.php

<?php

namespace Drupal\views_load_more\Ajax;

use Drupal\Core\Ajax\CommandInterface;
use Drupal\Core\Ajax\CommandWithAttachedAssetsInterface;
use Drupal\Core\Ajax\CommandWithAttachedAssetsTrait;
use Drupal\views_load_more\Plugin\views\pager\LoadMore;

/**
 * Provides an AJAX command for appending new rows in a paged AJAX response
 * to the rows on the page.
 *
 * This command is implemented in
 * Drupal.AjaxCommands.prototype.viewsLoadMoreAppend.
 */
class VLMAppendCommand implements CommandInterface, CommandWithAttachedAssetsInterface {
  use CommandWithAttachedAssetsTrait;

  /**
   * The options for the command.
   *
   * @var array
   */
  protected $options;

  /**
   * The content to append.
   *
   * Either a render array or an HTML string.
   *
   * @var string|array
   */
  protected $content;

  /**
   * Constructs a \Drupal\views\Ajax\ScrollTopCommand object.
   * @todo document
   *
   * @param $content
   * @param array $options
   *   Array with the following keys:
   *   - method
   *   - wrapper_selector
   *   - content_selector
   *   - pager_selector
   *   - effect
   *   - speed
   *   - target_list
   */
  public function __construct($content, $options) {
    $this->content = $content;
    $defaults = array(
      'method' => 'append',
      'wrapper_selector' => NULL,
      'content_selector' => LoadMore::DEFAULT_CONTENT_SELECTOR,
      'pager_selector' => LoadMore::DEFAULT_PAGER_SELECTOR,
      'effect' => '',
      'speed' => '',
      'target_list' => '',
    );
    $this->options = array_merge($defaults, $options);
  }

  /**
   * Implements \Drupal\Core\Ajax\CommandInterface::render().
   */
  public function render() {
    return array(
      'command' => 'viewsLoadMoreAppend',
      'data' => $this
        ->getRenderedContent(),
      'options' => $this->options,
    );
  }

}

Classes

Name	Description
VLMAppendCommand	Provides an AJAX command for appending new rows in a paged AJAX response to the rows on the page.