You are here

class CmisBrowserDocumentUploadForm in CMIS API 8.2

Same name and namespace in other branches
  1. 8 src/Form/CmisBrowserDocumentUploadForm.php \Drupal\cmis\Form\CmisBrowserDocumentUploadForm
  2. 3.0.x src/Form/CmisBrowserDocumentUploadForm.php \Drupal\cmis\Form\CmisBrowserDocumentUploadForm

Provides a form to upload documents.

@package Drupal\cmis\Form

Hierarchy

Expanded class hierarchy of CmisBrowserDocumentUploadForm

1 string reference to 'CmisBrowserDocumentUploadForm'
cmis.routing.yml in ./cmis.routing.yml
cmis.routing.yml

File

src/Form/CmisBrowserDocumentUploadForm.php, line 19

Namespace

Drupal\cmis\Form
View source
class CmisBrowserDocumentUploadForm extends FormBase {

  /**
   * The file system.
   *
   * @var \Drupal\Core\File\FileSystemInterface
   */
  protected $fileSystem;

  /**
   * CMIS Connection API.
   *
   * @var \Drupal\cmis\CmisConnectionApi
   */
  protected $cmisConnectionApi;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    $instance = parent::create($container);
    $instance->cmisConnectionApi = $container
      ->get('cmis.connection_api');
    $instance->fileSystem = $container
      ->get('file_system');
    return $instance;
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() : string {
    return 'cmis_browser_document_upload_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) : array {
    $directory = $this->fileSystem
      ->getTempDirectory();
    $config = $this
      ->getRouteMatch()
      ->getParameter('config');
    $this->cmisConnectionApi
      ->checkConnectionIsAlive($config, TRUE);
    $directory_is_writable = is_writable($directory);
    if (!$directory_is_writable) {
      $this
        ->messenger()
        ->addError($this
        ->t('The directory %directory is not writable.', [
        '%directory' => $directory,
      ]));
    }
    $form['local_file'] = [
      '#type' => 'file',
      '#title' => $this
        ->t('Local file'),
      '#description' => $this
        ->t('Choose the local file to uploading'),
    ];
    $form['description'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Document description'),
      '#description' => $this
        ->t('Enter the document description'),
      '#default_value' => $form_state
        ->getValue('description'),
    ];
    $form['config'] = [
      '#type' => 'hidden',
      '#default_value' => $config,
    ];
    $form['folder_id'] = [
      '#type' => 'hidden',
      '#default_value' => $this
        ->getRouteMatch()
        ->getParameter('folder_id'),
    ];
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Upload'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $values = $form_state
      ->getValues();
    $directory = $this->fileSystem
      ->getTempDirectory();
    $requestFiles = $this
      ->getRequest()->files
      ->get('files')['local_file'];
    $requestFilesPathname = $requestFiles
      ->getPathname();
    $requestFilesName = $requestFiles
      ->getClientOriginalName();
    $filename = $directory . '/' . $requestFilesName;
    if (!is_uploaded_file($requestFilesPathname) || !copy($requestFilesPathname, $filename)) {

      // Can't create file.
      $this
        ->messenger()
        ->addWarning($this
        ->t('File can not be uploaded.'));
      return;
    }

    // Open repository.
    if ($repository = new CmisRepositoryController($values['config'], $values['folder_id'])) {
      if (!empty($repository
        ->getBrowser()
        ->getConnection()
        ->validObjectName($requestFilesName, 'cmis:document', $values['folder_id']))) {

        // Document exists. Delete file from local.
        unlink($filename);
        $this
          ->messenger()
          ->addWarning($this
          ->t('The document name @name exists in folder.', [
          '@name' => $requestFilesName,
        ]));
        return;
      }
      $session = $repository
        ->getBrowser()
        ->getConnection()
        ->getSession();
      $properties = [
        PropertyIds::OBJECT_TYPE_ID => 'cmis:document',
        PropertyIds::NAME => $requestFilesName,
      ];
      if (!empty($values['description'])) {
        $properties[PropertyIds::DESCRIPTION] = $values['description'];
      }

      // Create document.
      try {
        $session
          ->createDocument($properties, $session
          ->createObjectId($values['folder_id']), Stream::factory(fopen($filename, 'r')));

        // Delete file from local.
        unlink($filename);
        $this
          ->messenger()
          ->addStatus($this
          ->t('Document name @name has been created.', [
          '@name' => $requestFilesName,
        ]));
      } catch (Exception $exception) {
        $this
          ->messenger()
          ->addWarning($this
          ->t('Document name @name could not be created.', [
          '@name' => $requestFilesName,
        ]));
      }
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CmisBrowserDocumentUploadForm::$cmisConnectionApi protected property CMIS Connection API.
CmisBrowserDocumentUploadForm::$fileSystem protected property The file system.
CmisBrowserDocumentUploadForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
CmisBrowserDocumentUploadForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
CmisBrowserDocumentUploadForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
CmisBrowserDocumentUploadForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.