class CmisBrowser in CMIS API 8

Description of CmisBrowser

@author dj

Hierarchy

• class \Drupal\cmis\CmisBrowser

1 file declares its use of CmisBrowser

CmisRepositoryController.php in src/Controller/CmisRepositoryController.php

File

src/CmisBrowser.php, line 16

Namespace

Drupal\cmis

class CmisBrowser {

  /**
   * Configuration id.
   *
   * @var string
   *    the configuration id
   */
  protected $config;

  /**
   * Connection object
   *
   * @var object
   *    the connection object.
   */
  protected $connection;

  /**
   * Content data
   *
   * @var array
   *    the renderable content data
   */
  protected $data;

  /**
   * Parent folders list data
   *
   * @var array
   *    the renderable breadcrumb data
   */
  protected $breadcrumbs = [];

  /**
   * Folder id.
   *
   * @var string
   *    the folder id to browse
   */
  protected $folder_id;

  /**
   * Current object.
   *
   * @var object
   *    the current object
   */
  protected $current;

  /**
   * Popup.
   *
   * @var boolean
   *    the browser popup flag
   */
  protected $popup;

  /**
   * Cacheable.
   *
   * @var boolean
   *    the browser cacheable flag
   */
  protected $cacheable;

  /**
   * Constructing the object.
   *
   * @param type $config
   * @param type $folder_id
   */
  public function __construct($config = '', $folder_id = '') {
    if (!empty($config)) {
      $this
        ->init($config, $folder_id);
    }
  }

  /**
   * Call from ajaxify url.
   *
   * @param string $config
   * @param string $folder_id
   */
  public function ajaxCall($config, $folder_id) {
    $this
      ->init($config, $folder_id);
    if ($this->connection && !empty($this->current) && ($browse = $this
      ->browse())) {
      $response = new AjaxResponse();
      $content = render($browse);
      $response
        ->addCommand(new HtmlCommand('#cmis-browser-wrapper', $content));
      return $response;
    }
  }

  /**
   * Get document by id.
   *
   * @param type $config
   * @param type $document_id
   */
  public function getDocument($config = '', $document_id = '') {
    $this
      ->init($config, $document_id, 'cmis:document');
    if ($this->connection && !empty($this->current) && $this->current
      ->getBaseTypeId()
      ->__toString() == 'cmis:document') {
      $id = $this->current
        ->getId();
      try {
        $content = $this->current
          ->getContentStream($id);
      } catch (CMISException $e) {

        // TODO: testing this.
        $headers = [
          '' => 'HTTP/1.1 503 Service unavailable',
        ];
        $response = new Response($content, 503, $headers);
        $response
          ->send();
        exit;
      }
      $mime = $this->current
        ->getContentStreamMimeType();
      $headers = [
        'Cache-Control' => 'no-cache, must-revalidate',
        'Content-type' => $mime,
        'Content-Disposition' => 'attachment; filename="' . $this->current
          ->getName() . '"',
      ];
      $response = new Response($content, 200, $headers);
      $response
        ->send();
      print $content;
      exit;
    }
  }

  /**
   * Get document properties.
   *
   * @return array
   *    the renderable array
   */
  public function getDocumentProperties() {
    if ($this->connection && !empty($this->current)) {
      $type_id = $this->current
        ->getBaseTypeId()
        ->__toString();
      $path = [];
      if ($type_id == 'cmis:document') {
        $url = \Drupal\Core\Url::fromUserInput('/cmis/document/' . $this->config . '/' . $this->current
          ->getId());
        $path = \Drupal\Core\Link::fromTextAndUrl(t('Download'), $url)
          ->toRenderable();
      }
      return [
        '#theme' => 'cmis_content_properties',
        '#object' => $this->current,
        '#download' => render($path),
      ];
    }
  }

  /**
   * Init variables.
   *
   * @param string $config
   * @param string $folder_id
   */
  private function init($config, $folder_id) {
    $this->config = $config;
    $this->folder_id = $folder_id;
    $this->connection = new CmisConnectionApi($this->config);

    //$cacheable = $this->connection->getConfig()->getCmisCacheable();

    // TODO: find out the best cache options.

    //$cache_parameters = [

    //  'contexts' => ['user'],
    //  'max-age' => $cacheable ? 300 : 0,

    //];

    //$this->cacheable = $cache_parameters;
    if (!empty($this->connection
      ->getHttpInvoker())) {
      $popup = \Drupal::request()->query
        ->get('type');
      $this->popup = $popup == 'popup';
      $this->connection
        ->setDefaultParameters();
      if (empty($this->folder_id)) {
        $root_folder = $this->connection
          ->getRootFolder();
        $this->folder_id = $root_folder
          ->getId();
        $this->current = $root_folder;
      }
      else {
        $this->current = $this->connection
          ->getObjectById($this->folder_id);
      }
    }
  }

  /**
   * Get current object.
   *
   * @return object
   */
  public function getCurrent() {
    return $this->current;
  }

  /**
   * Get connection.
   *
   * @return object
   */
  public function getConnection() {
    return $this->connection;
  }

  /**
   * Set General parameters.
   */
  private function setParameters() {
    if ($this->connection) {
      $this->connection
        ->setDefaultParameters();
    }
  }

  /**
   * Browse.
   *
   * @return array
   *   Return cmis browser render array.
   */
  public function browse($reset = FALSE) {
    if ($this->connection && !empty($this->current)) {
      $this
        ->setBreadcrumbs($this->current, 'last');
      $this
        ->printFolderContent($this->current);
      $table_header = array(
        t('Name'),
        t('Details'),
        t('Author'),
        t('Created'),
        t('Description'),
        t('Operation'),
      );
      $browse = [
        '#theme' => 'cmis_browser',
        '#header' => $table_header,
        '#elements' => $this->data,
        '#breadcrumbs' => $this->breadcrumbs,
        '#operations' => $this
          ->prepareOperations(),
        //'#cache' => $this->cacheable,
        '#attached' => [
          'library' => [
            'cmis/cmis-browser',
          ],
        ],
      ];
      return $browse;
    }
    return [];
  }

  /**
   * Prepare operation links.
   *
   * @return string
   */
  private function prepareOperations() {
    if (!\Drupal::currentUser()
      ->hasPermission('access cmis operations')) {
      return '';
    }
    $routes = [
      '/cmis/browser-create-folder/' => t('Create folder'),
      '/cmis/browser-upload-document/' => t('Add document'),
    ];
    $links = [];
    foreach ($routes as $route => $title) {
      $url = \Drupal\Core\Url::fromUserInput($route . $this->config . '/' . $this->current
        ->getId());
      $link_options = array(
        'attributes' => array(
          'class' => [
            'use-ajax',
          ],
          'data-dialog-type' => 'modal',
          'data-dialog-options' => \Drupal\Component\Serialization\Json::encode([
            'height' => 400,
            'width' => 700,
          ]),
        ),
      );
      $url
        ->setOptions($link_options);
      $path = \Drupal\Core\Link::fromTextAndUrl($title, $url)
        ->toRenderable();
      $links[] = [
        '#markup' => render($path),
        '#wrapper_attributes' => [
          'class' => [
            'object-properties',
          ],
        ],
      ];
    }
    $list = [
      '#theme' => 'item_list',
      '#items' => $links,
      '#type' => 'ul',
    ];
    return render($list);
  }

  /**
   * Add folder objects to render array.
   *
   * @param \Dkd\PhpCmis\Data\FolderInterface $folder
   */
  protected function printFolderContent(\Dkd\PhpCmis\Data\FolderInterface $folder) {
    $root = $this->connection
      ->getRootFolder();
    $element = new CmisElement($this->config, $this->popup, $this->current, '', $root
      ->getId());
    foreach ($folder
      ->getChildren() as $children) {
      $element
        ->setElement('browser', $children);
      $this->data[] = $element
        ->getDAta();
    }
  }

  /**
   * Create breadcrumbs from parent folders.
   *
   * @param type $folder
   */
  protected function setBreadcrumbs($folder, $class = '') {
    $name = $folder
      ->getName();
    $id = $folder
      ->getId();
    $this
      ->setBreadcrumb($name, $id, $class);
    if ($parent = $folder
      ->getFolderParent()) {
      $this
        ->setBreadcrumbs($parent);
    }
    else {
      $this->breadcrumbs[0]['#wrapper_attributes']['class'] = [
        'first',
      ];
    }
  }

  /**
   * Prepare a breadcrumb url.
   *
   * @param type $label
   * @param type $name
   */
  protected function setBreadcrumb($label, $id = '', $class) {
    $path = '/cmis/browser/nojs/' . $this->config;
    if (!empty($id)) {
      $path .= '/' . $id;
    }
    $url = \Drupal\Core\Url::fromUserInput($path);
    $link_options = array(
      'attributes' => array(
        'class' => array(
          'use-ajax',
        ),
      ),
    );
    if ($this->popup) {
      $link_options['query'] = [
        'type' => 'popup',
      ];
    }
    $url
      ->setOptions($link_options);
    $item = [
      'value' => \Drupal\Core\Link::fromTextAndUrl($label, $url)
        ->toRenderable(),
      '#wrapper_attributes' => [
        'class' => [
          $class,
        ],
      ],
    ];
    array_unshift($this->breadcrumbs, $item);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CmisBrowser::$breadcrumbs	protected	property	Parent folders list data
CmisBrowser::$cacheable	protected	property	Cacheable.
CmisBrowser::$config	protected	property	Configuration id.
CmisBrowser::$connection	protected	property	Connection object
CmisBrowser::$current	protected	property	Current object.
CmisBrowser::$data	protected	property	Content data
CmisBrowser::$folder_id	protected	property	Folder id.
CmisBrowser::$popup	protected	property	Popup.
CmisBrowser::ajaxCall	public	function	Call from ajaxify url.
CmisBrowser::browse	public	function	Browse.
CmisBrowser::getConnection	public	function	Get connection.
CmisBrowser::getCurrent	public	function	Get current object.
CmisBrowser::getDocument	public	function	Get document by id.
CmisBrowser::getDocumentProperties	public	function	Get document properties.
CmisBrowser::init	private	function	Init variables.
CmisBrowser::prepareOperations	private	function	Prepare operation links.
CmisBrowser::printFolderContent	protected	function	Add folder objects to render array.
CmisBrowser::setBreadcrumb	protected	function	Prepare a breadcrumb url.
CmisBrowser::setBreadcrumbs	protected	function	Create breadcrumbs from parent folders.
CmisBrowser::setParameters	private	function	Set General parameters.
CmisBrowser::__construct	public	function	Constructing the object.