class S3fsCorsAdminForm in S3 File System CORS Upload 8

Config settings for S3FS Cors.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
  - class \Drupal\s3fs_cors\Form\S3fsCorsAdminForm uses StringTranslationTrait

Expanded class hierarchy of S3fsCorsAdminForm

1 string reference to 'S3fsCorsAdminForm'

s3fs_cors.routing.yml in ./s3fs_cors.routing.yml: s3fs_cors.routing.yml

File

src/Form/S3fsCorsAdminForm.php, line 15

Namespace

Drupal\s3fs_cors\Form

View source

class S3fsCorsAdminForm extends ConfigFormBase {
  use StringTranslationTrait;

  /**
   * S3 Client Interface.
   *
   * @var \Aws\S3\S3ClientInterface
   */
  private $s3Client;

  /**
   * S3fsCorsAdminForm constructor.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory interface.
   * @param \Drupal\s3fs\S3fsServiceInterface $s3fs
   *   The S3fs service interface.
   *
   * @throws \Drupal\s3fs\S3fsException
   *   The S3fs exception.
   */
  public function __construct(ConfigFactoryInterface $config_factory, S3fsServiceInterface $s3fs) {
    parent::__construct($config_factory);
    $s3_config = $this
      ->config('s3fs.settings')
      ->get();
    $this->s3Client = $s3fs
      ->getAmazonS3Client($s3_config);
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('s3fs'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 's3fs_cors_admin_form';
  }

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      's3fs_cors.settings',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('s3fs_cors.settings');
    $form['s3fs_cors_origin'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('CORS Origin'),
      '#description' => $this
        ->t('Please enter the URL from which your users access this website, e.g. <i>www.example.com</i>.
      You may optionally specifiy up to one wildcard, e.g. <i>*.example.com</i>.<br>
      Upon submitting this form, if this field is filled, your S3 bucket will be configured to allow CORS
      requests from the specified origin. If the field is empty, your bucket\'s CORS config will be deleted.'),
      '#default_value' => !empty($config
        ->get('s3fs_cors_origin')) ? $config
        ->get('s3fs_cors_origin') : '',
    ];
    $form['s3fs_https'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Use Https/Http'),
      '#description' => $this
        ->t('Select what method you will like to use with your bucket'),
      '#default_value' => !empty($config
        ->get('s3fs_https')) ? $config
        ->get('s3fs_https') : 'http',
      '#options' => [
        'http' => $this
          ->t('HTTP'),
        'https' => $this
          ->t('HTTPS'),
      ],
    ];
    $form['s3fs_access_type'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Access Type on File Uploads'),
      '#description' => $this
        ->t('Select what access permission should be there on File Upload.'),
      '#default_value' => !empty($config
        ->get('s3fs_access_type')) ? $config
        ->get('s3fs_access_type') : 'public-read',
      '#options' => [
        'public-read' => $this
          ->t('Public Read'),
        'private' => $this
          ->t('Private'),
      ],
    ];
    $form = parent::buildForm($form, $form_state);
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $cors_origin = $form_state
      ->getValue('s3fs_cors_origin');
    $this
      ->config('s3fs_cors.settings')
      ->set('s3fs_cors_origin', $cors_origin)
      ->set('s3fs_https', $form_state
      ->getValue('s3fs_https'))
      ->set('s3fs_access_type', $form_state
      ->getValue('s3fs_access_type'))
      ->save();

    // parent::submitForm($form, $form_state);
    // Get S3FS Settings.
    $s3_config = $this
      ->config('s3fs.settings');
    if (!empty($s3_config)) {
      if (!empty($cors_origin)) {

        // Create an array of allowed CORS origins
        $cors_origins = array_filter(explode(',', str_replace(' ', ',', $cors_origin)));
        $allowed_origins = [];
        foreach ($cors_origins as $origin) {
          $allowed_origins[] = 'http://' . $origin;
          $allowed_origins[] = 'https://' . $origin;
        }
        $this->s3Client
          ->putBucketCors([
          // REQUIRED.
          'Bucket' => $s3_config
            ->get('bucket'),
          // REQUIRED.
          'CORSConfiguration' => [
            // REQUIRED.
            'CORSRules' => [
              [
                'AllowedHeaders' => [
                  '*',
                ],
                'ExposeHeaders' => [
                  'x-amz-version-id',
                ],
                'AllowedMethods' => [
                  'POST',
                ],
                'MaxAgeSeconds' => 3000,
                'AllowedOrigins' => $allowed_origins,
              ],
              [
                'AllowedMethods' => [
                  'GET',
                ],
                'AllowedOrigins' => [
                  '*',
                ],
              ],
            ],
          ],
        ]);
        $this
          ->messenger()
          ->addMessage($this
          ->t("CORS settings have been succesfully updated at AWS CORS"));
      }
      else {

        // If $form_state['values']['s3fs_cors_origin'] is empty, that means we
        // need to delete their bucket's CORS config.
        $this->s3Client
          ->deleteBucketCors([
          'Bucket' => $s3_config
            ->get('bucket'),
        ]);
        $this
          ->messenger()
          ->addMessage($this
          ->t("CORS settings have been deleted succesfully"));
      }
    }
    else {
      $this
        ->messenger()
        ->addMessage($this
        ->t('No values have been saved. Please check S3 Settings First'));
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigFormBaseTrait::config	protected	function	Retrieves a configuration object.
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::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.
S3fsCorsAdminForm::$s3Client	private	property	S3 Client Interface.
S3fsCorsAdminForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
S3fsCorsAdminForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
S3fsCorsAdminForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
S3fsCorsAdminForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
S3fsCorsAdminForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
S3fsCorsAdminForm::__construct	public	function	S3fsCorsAdminForm constructor. Overrides ConfigFormBase::__construct
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.

You are here

class S3fsCorsAdminForm in S3 File System CORS Upload 8

Hierarchy

File

Namespace

Members

API Navigation