class FileModuleTestForm

Same name in other branches
  1. 9 core/modules/file/tests/file_module_test/src/Form/FileModuleTestForm.php \Drupal\file_module_test\Form\FileModuleTestForm
  2. 10 core/modules/file/tests/file_module_test/src/Form/FileModuleTestForm.php \Drupal\file_module_test\Form\FileModuleTestForm
  3. 11.x core/modules/file/tests/file_module_test/src/Form/FileModuleTestForm.php \Drupal\file_module_test\Form\FileModuleTestForm

Form controller for file_module_test module.

@internal

Hierarchy

Expanded class hierarchy of FileModuleTestForm

1 string reference to 'FileModuleTestForm'
file_module_test.routing.yml in core/modules/file/tests/file_module_test/file_module_test.routing.yml
core/modules/file/tests/file_module_test/file_module_test.routing.yml

File

core/modules/file/tests/file_module_test/src/Form/FileModuleTestForm.php, line 13

Namespace

Drupal\file_module_test\Form
View source
class FileModuleTestForm extends FormBase {
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'file_module_test_form';
    }
    
    /**
     * {@inheritdoc}
     *
     * @param array $form
     *   An associative array containing the structure of the form.
     * @param \Drupal\Core\Form\FormStateInterface $form_state
     *   The current state of the form.
     * @param bool $tree
     *   (optional) If the form should use #tree. Defaults to TRUE.
     * @param bool $extended
     *   (optional) If the form should use #extended. Defaults to TRUE.
     * @param bool $multiple
     *   (optional) If the form should use #multiple. Defaults to FALSE.
     * @param array $default_fids
     *   (optional) Any default file IDs to use.
     */
    public function buildForm(array $form, FormStateInterface $form_state, $tree = TRUE, $extended = TRUE, $multiple = FALSE, $default_fids = NULL) {
        $form['#tree'] = (bool) $tree;
        $form['nested']['file'] = [
            '#type' => 'managed_file',
            '#title' => $this->t('Managed <em>@type</em>', [
                '@type' => 'file & butter',
            ]),
            '#upload_location' => 'public://test',
            '#progress_message' => $this->t('Please wait...'),
            '#extended' => (bool) $extended,
            '#size' => 13,
            '#multiple' => (bool) $multiple,
        ];
        if ($default_fids) {
            $default_fids = explode(',', $default_fids);
            $form['nested']['file']['#default_value'] = $extended ? [
                'fids' => $default_fids,
            ] : $default_fids;
        }
        $form['textfield'] = [
            '#type' => 'textfield',
            '#title' => $this->t('Type a value and ensure it stays'),
        ];
        $form['submit'] = [
            '#type' => 'submit',
            '#value' => $this->t('Save'),
        ];
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        if ($form['#tree']) {
            $uploads = $form_state->getValue([
                'nested',
                'file',
            ]);
        }
        else {
            $uploads = $form_state->getValue('file');
        }
        if ($form['nested']['file']['#extended']) {
            $uploads = $uploads['fids'];
        }
        $fids = [];
        foreach ($uploads as $fid) {
            $fids[] = $fid;
        }
        \Drupal::messenger()->addStatus($this->t('The file ids are %fids.', [
            '%fids' => implode(',', $fids),
        ]));
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
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
FileModuleTestForm::buildForm public function Overrides FormInterface::buildForm
FileModuleTestForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
FileModuleTestForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
FormBase::$configFactory protected property The config factory. 3
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. 3
FormBase::container private function Returns the service container.
FormBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 105
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 73
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. 17
MessengerTrait::messenger public function Gets the messenger. 17
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a &#039;destination&#039; 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.
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.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.