class File

Same name in this branch

10 core/modules/media/src/Plugin/media/Source/File.php \Drupal\media\Plugin\media\Source\File
10 core/modules/file/src/Entity/File.php \Drupal\file\Entity\File
10 core/modules/file/src/Plugin/views/field/File.php \Drupal\file\Plugin\views\field\File
10 core/modules/file/src/Plugin/migrate/source/d6/File.php \Drupal\file\Plugin\migrate\source\d6\File
10 core/modules/file/src/Plugin/migrate/source/d7/File.php \Drupal\file\Plugin\migrate\source\d7\File
10 core/lib/Drupal/Core/Render/Element/File.php \Drupal\Core\Render\Element\File

Same name in other branches

9 core/modules/media/src/Plugin/media/Source/File.php \Drupal\media\Plugin\media\Source\File
9 core/modules/file/src/Entity/File.php \Drupal\file\Entity\File
9 core/modules/file/src/Plugin/views/field/File.php \Drupal\file\Plugin\views\field\File
9 core/modules/file/src/Plugin/views/wizard/File.php \Drupal\file\Plugin\views\wizard\File
9 core/modules/file/src/Plugin/migrate/source/d6/File.php \Drupal\file\Plugin\migrate\source\d6\File
9 core/modules/file/src/Plugin/migrate/source/d7/File.php \Drupal\file\Plugin\migrate\source\d7\File
9 core/lib/Drupal/Core/Render/Element/File.php \Drupal\Core\Render\Element\File
8.9.x core/modules/media/src/Plugin/media/Source/File.php \Drupal\media\Plugin\media\Source\File
8.9.x core/modules/file/src/Entity/File.php \Drupal\file\Entity\File
8.9.x core/modules/file/src/Plugin/views/field/File.php \Drupal\file\Plugin\views\field\File
8.9.x core/modules/file/src/Plugin/views/wizard/File.php \Drupal\file\Plugin\views\wizard\File
8.9.x core/modules/file/src/Plugin/migrate/source/d6/File.php \Drupal\file\Plugin\migrate\source\d6\File
8.9.x core/modules/file/src/Plugin/migrate/source/d7/File.php \Drupal\file\Plugin\migrate\source\d7\File
8.9.x core/lib/Drupal/Core/Render/Element/File.php \Drupal\Core\Render\Element\File
11.x core/modules/media/src/Plugin/media/Source/File.php \Drupal\media\Plugin\media\Source\File
11.x core/modules/file/src/Entity/File.php \Drupal\file\Entity\File
11.x core/modules/file/src/Plugin/views/field/File.php \Drupal\file\Plugin\views\field\File
11.x core/modules/file/src/Plugin/views/wizard/File.php \Drupal\file\Plugin\views\wizard\File
11.x core/modules/file/src/Plugin/migrate/source/d6/File.php \Drupal\file\Plugin\migrate\source\d6\File
11.x core/modules/file/src/Plugin/migrate/source/d7/File.php \Drupal\file\Plugin\migrate\source\d7\File
11.x core/lib/Drupal/Core/Render/Element/File.php \Drupal\Core\Render\Element\File

Tests creating managed files views with the wizard.

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
  - class \Drupal\views\Plugin\views\PluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\views\Plugin\views\ViewsPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Security\TrustedCallbackInterface
    - class \Drupal\views\Plugin\views\wizard\WizardPluginBase extends \Drupal\views\Plugin\views\PluginBase implements \Drupal\views\Plugin\views\wizard\WizardInterface
      - class \Drupal\file\Plugin\views\wizard\File extends \Drupal\views\Plugin\views\wizard\WizardPluginBase

Expanded class hierarchy of File

349 string references to 'File'

23a7f61f-1db3-407d-a6dd-eb4731995c9f.yml in core/tests/fixtures/default_content/file/23a7f61f-1db3-407d-a6dd-eb4731995c9f.yml: core/tests/fixtures/default_content/file/23a7f61f-1db3-407d-a6dd-eb4731995c9f.yml
2b8e0616-3ef0-4a91-8cfb-b31d9128f9f8.yml in core/tests/fixtures/default_content/file/2b8e0616-3ef0-4a91-8cfb-b31d9128f9f8.yml: core/tests/fixtures/default_content/file/2b8e0616-3ef0-4a91-8cfb-b31d9128f9f8.yml
344b943c-b231-4d73-9669-0b0a2be12aa5.yml in core/tests/fixtures/default_content/media/344b943c-b231-4d73-9669-0b0a2be12aa5.yml: core/tests/fixtures/default_content/media/344b943c-b231-4d73-9669-0b0a2be12aa5.yml
7fb09f9f-ba5f-4db4-82ed-aa5ccf7d425d.yml in core/tests/fixtures/default_content/file/7fb09f9f-ba5f-4db4-82ed-aa5ccf7d425d.yml: core/tests/fixtures/default_content/file/7fb09f9f-ba5f-4db4-82ed-aa5ccf7d425d.yml
a6b79928-838f-44bd-a8f0-44c2fff9e4cc.yml in core/tests/fixtures/default_content/a6b79928-838f-44bd-a8f0-44c2fff9e4cc.yml: core/tests/fixtures/default_content/a6b79928-838f-44bd-a8f0-44c2fff9e4cc.yml

... See full list

File

core/modules/file/src/Plugin/views/wizard/File.php, line 12

Namespace

Drupal\file\Plugin\views\wizard

View source

class File extends WizardPluginBase {
    
    /**
     * Set the created column.
     *
     * @var string
     */
    protected $createdColumn = 'created';
    
    /**
     * {@inheritdoc}
     */
    protected function defaultDisplayOptions() {
        $display_options = parent::defaultDisplayOptions();
        // Add permission-based access control.
        $display_options['access']['type'] = 'perm';
        // Remove the default fields, since we are customizing them here.
        unset($display_options['fields']);
        
        /* Field: File: Name */
        $display_options['fields']['filename']['id'] = 'filename';
        $display_options['fields']['filename']['table'] = 'file_managed';
        $display_options['fields']['filename']['field'] = 'filename';
        $display_options['fields']['filename']['entity_type'] = 'file';
        $display_options['fields']['filename']['entity_field'] = 'filename';
        $display_options['fields']['filename']['label'] = '';
        $display_options['fields']['filename']['alter']['alter_text'] = 0;
        $display_options['fields']['filename']['alter']['make_link'] = 0;
        $display_options['fields']['filename']['alter']['absolute'] = 0;
        $display_options['fields']['filename']['alter']['trim'] = 0;
        $display_options['fields']['filename']['alter']['word_boundary'] = 0;
        $display_options['fields']['filename']['alter']['ellipsis'] = 0;
        $display_options['fields']['filename']['alter']['strip_tags'] = 0;
        $display_options['fields']['filename']['alter']['html'] = 0;
        $display_options['fields']['filename']['hide_empty'] = 0;
        $display_options['fields']['filename']['empty_zero'] = 0;
        $display_options['fields']['filename']['plugin_id'] = 'field';
        $display_options['fields']['filename']['type'] = 'file_link';
        return $display_options;
    }

}

Members

Title Sort descending	Deprecated	Modifiers	Object type	Summary	Overriden Title	Overrides
DerivativeInspectionInterface::getBaseId		public	function	Gets the base_plugin_id of the plugin instance.		1
DerivativeInspectionInterface::getDerivativeId		public	function	Gets the derivative_id of the plugin instance.		1
File::$createdColumn		protected	property	Set the created column.	Overrides WizardPluginBase::$createdColumn
File::defaultDisplayOptions		protected	function		Overrides WizardPluginBase::defaultDisplayOptions
PluginBase::$definition		public	property	Plugins' definition.
PluginBase::$displayHandler		public	property	The display object this plugin is for.
PluginBase::$options		public	property	Options for this plugin will be held here.
PluginBase::$position		public	property	The handler position.
PluginBase::$renderer		protected	property	Stores the render API renderer.		3
PluginBase::$usesOptions		protected	property	Denotes whether the plugin has an additional options form.		8
PluginBase::$view		public	property	The top object of a view.		1
PluginBase::buildOptionsForm		public	function		Overrides ViewsPluginInterface::buildOptionsForm	16
PluginBase::calculateDependencies		public	function		Overrides DependentPluginInterface::calculateDependencies	14
PluginBase::defineOptions		protected	function	Information about options for all kinds of purposes will be held here.		18
PluginBase::destroy		public	function		Overrides ViewsPluginInterface::destroy	2
PluginBase::doFilterByDefinedOptions		protected	function	Do the work to filter out stored options depending on the defined options.
PluginBase::filterByDefinedOptions		public	function		Overrides ViewsPluginInterface::filterByDefinedOptions
PluginBase::getAvailableGlobalTokens		public	function		Overrides ViewsPluginInterface::getAvailableGlobalTokens
PluginBase::getProvider		public	function		Overrides ViewsPluginInterface::getProvider
PluginBase::getRenderer		protected	function	Returns the render API renderer.		1
PluginBase::globalTokenForm		public	function		Overrides ViewsPluginInterface::globalTokenForm
PluginBase::globalTokenReplace		public	function		Overrides ViewsPluginInterface::globalTokenReplace
PluginBase::INCLUDE_ENTITY			constant	Include entity row languages when listing languages.
PluginBase::INCLUDE_NEGOTIATED			constant	Include negotiated languages when listing languages.
PluginBase::init		public	function		Overrides ViewsPluginInterface::init	6
PluginBase::listLanguages		protected	function	Makes an array of languages, optionally including special languages.
PluginBase::pluginTitle		public	function		Overrides ViewsPluginInterface::pluginTitle
PluginBase::preRenderAddFieldsetMarkup		public static	function		Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup
PluginBase::preRenderFlattenData		public static	function		Overrides ViewsPluginInterface::preRenderFlattenData
PluginBase::query		public	function		Overrides ViewsPluginInterface::query	8
PluginBase::queryLanguageSubstitutions		public static	function	Returns substitutions for Views queries for languages.
PluginBase::setOptionDefaults		protected	function	Fills up the options of the plugin with defaults.
PluginBase::submitOptionsForm		public	function		Overrides ViewsPluginInterface::submitOptionsForm	16
PluginBase::summaryTitle		public	function		Overrides ViewsPluginInterface::summaryTitle	6
PluginBase::themeFunctions		public	function		Overrides ViewsPluginInterface::themeFunctions	1
PluginBase::trustedCallbacks		public static	function		Overrides TrustedCallbackInterface::trustedCallbacks	6
PluginBase::unpackOptions		public	function		Overrides ViewsPluginInterface::unpackOptions
PluginBase::usesOptions		public	function		Overrides ViewsPluginInterface::usesOptions	8
PluginBase::validate		public	function		Overrides ViewsPluginInterface::validate	6
PluginBase::validateOptionsForm		public	function		Overrides ViewsPluginInterface::validateOptionsForm	15
PluginBase::viewsTokenReplace		protected	function	Replaces Views' tokens in a given string.		1
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT			constant	Query string to indicate the site default language.
PluginInspectionInterface::getPluginDefinition		public	function	Gets the definition of the plugin implementation.		6
PluginInspectionInterface::getPluginId		public	function	Gets the plugin ID of the plugin instance.		2
TrustedCallbackInterface::THROW_EXCEPTION			constant	Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION			constant	Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING	Deprecated		constant	Untrusted callbacks trigger E_USER_WARNING errors.
WizardPluginBase::$availableSorts		protected	property	The available store criteria.
WizardPluginBase::$base_table		protected	property
WizardPluginBase::$bundleInfoService		protected	property	The bundle info service.
WizardPluginBase::$entityType		protected	property	Contains the information from entity_get_info of the $entity_type.
WizardPluginBase::$entityTypeId		protected	property	The entity type connected with the wizard.
WizardPluginBase::$filters		protected	property	Views items configuration arrays for filters added by the wizard.		2
WizardPluginBase::$filter_defaults		protected	property
WizardPluginBase::$parentFormSelector		protected	property	The parent form selector service.
WizardPluginBase::$sorts		protected	property	Views items configuration arrays for sorts added by the wizard.
WizardPluginBase::$validated_views		protected	property
WizardPluginBase::addDisplays		protected	function	Adds the array of display options to the view, with appropriate overrides.
WizardPluginBase::alterDisplayOptions		protected	function	Alters the full array of display options before they are added to the view.
WizardPluginBase::blockDisplayOptions		protected	function	Retrieves the block display options.		1
WizardPluginBase::buildDisplayOptions		protected	function	Builds an array of display options for the view.		1
WizardPluginBase::buildFilters		protected	function	Builds the form structure for selecting the view's filters.		1
WizardPluginBase::buildForm		public	function		Overrides WizardInterface::buildForm
WizardPluginBase::buildFormStyle		protected	function	Adds the style options to the wizard form.
WizardPluginBase::buildSorts		protected	function	Builds the form structure for selecting the view's sort order.
WizardPluginBase::create		public static	function		Overrides PluginBase::create	1
WizardPluginBase::createView		public	function		Overrides WizardInterface::createView
WizardPluginBase::defaultDisplayFilters		protected	function	Retrieves all filter information used by the default display.
WizardPluginBase::defaultDisplayFiltersUser		protected	function	Retrieves filter information based on user input for the default display.		2
WizardPluginBase::defaultDisplaySorts		protected	function	Retrieves all sort information used by the default display.
WizardPluginBase::defaultDisplaySortsUser		protected	function	Retrieves sort information based on user input for the default display.
WizardPluginBase::getAvailableSorts		public	function	Gets the availableSorts property.		2
WizardPluginBase::getCreatedColumn		public	function	Gets the createdColumn property.
WizardPluginBase::getFilters		public	function	Gets the filters property.		1
WizardPluginBase::getSelected		public static	function	Gets the current value of a #select element, from within a form constructor function.
WizardPluginBase::getSorts		public	function	Gets the sorts property.
WizardPluginBase::instantiateView		protected	function	Instantiates a view object from form values.
WizardPluginBase::pageDisplayOptions		protected	function	Retrieves the page display options.		1
WizardPluginBase::pageFeedDisplayOptions		protected	function	Retrieves the feed display options.
WizardPluginBase::restExportDisplayOptions		protected	function	Retrieves the REST export display options from the submitted form values.
WizardPluginBase::retrieveValidatedView		protected	function	Retrieves a validated view for a form submission.
WizardPluginBase::rowStyleOptions		protected	function	Retrieves row style plugin names.		3
WizardPluginBase::setDefaultOptions		protected	function	Sets options for a display and makes them the default options if possible.
WizardPluginBase::setOverrideOptions		protected	function	Sets options for a display, inheriting from the defaults when possible.
WizardPluginBase::setValidatedView		protected	function	Stores a validated view from a form submission.
WizardPluginBase::validateView		public	function	Implements Drupal\views\Plugin\views\wizard\WizardInterface::validate().	Overrides WizardInterface::validateView
WizardPluginBase::__construct		public	function	Constructs a WizardPluginBase object.	Overrides PluginBase::__construct	1

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

class File

Hierarchy

File

Namespace

Members

Search drupal 10

API Navigation

Breadcrumb

class File

Hierarchy

File

Namespace

Members

Search drupal 10

API Navigation