class FeedForm in Feeds 8.3
Form controller for the feed edit forms.
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Entity\EntityForm implements EntityFormInterface
- class \Drupal\Core\Entity\ContentEntityForm implements ContentEntityFormInterface
- class \Drupal\feeds\FeedForm
- class \Drupal\Core\Entity\ContentEntityForm implements ContentEntityFormInterface
- class \Drupal\Core\Entity\EntityForm implements EntityFormInterface
Expanded class hierarchy of FeedForm
File
- src/
FeedForm.php, line 15
Namespace
Drupal\feedsView source
class FeedForm extends ContentEntityForm {
/**
* The form factory.
*
* @var \Drupal\feeds\Plugin\PluginFormFactory
*/
protected $formFactory;
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
$instance = parent::create($container);
$instance
->setPluginFormFactory($container
->get('feeds_plugin_form_factory'));
return $instance;
}
/**
* Sets the form factory, used to generate forms for Feeds plugins.
*
* @param \Drupal\feeds\Plugin\PluginFormFactory $factory
* The Feeds form factory.
*/
protected function setPluginFormFactory(PluginFormFactory $factory) {
$this->formFactory = $factory;
}
/**
* {@inheritdoc}
*/
public function form(array $form, FormStateInterface $form_state) {
$feed = $this->entity;
$feed_type = $feed
->getType();
$form['advanced'] = [
'#type' => 'vertical_tabs',
'#attributes' => [
'class' => [
'entity-meta',
],
],
'#weight' => 99,
];
$form = parent::form($form, $form_state);
$form['plugin']['#tree'] = TRUE;
foreach ($feed_type
->getPlugins() as $type => $plugin) {
if ($this
->pluginHasForm($plugin, 'feed')) {
$feed_form = $this->formFactory
->createInstance($plugin, 'feed');
$plugin_state = (new FormState())
->setValues($form_state
->getValue([
'plugin',
$type,
], []));
$form['plugin'][$type] = $feed_form
->buildConfigurationForm([], $plugin_state, $feed);
$form['plugin'][$type]['#tree'] = TRUE;
$form_state
->setValue([
'plugin',
$type,
], $plugin_state
->getValues());
}
}
$form['author'] = [
'#type' => 'details',
'#title' => $this
->t('Authoring information'),
'#group' => 'advanced',
'#attributes' => [
'class' => [
'feeds-feed-form-author',
],
],
'#weight' => 90,
'#optional' => TRUE,
];
if (isset($form['uid'])) {
$form['uid']['#group'] = 'author';
}
if (isset($form['created'])) {
$form['created']['#group'] = 'author';
}
// Feed options for administrators.
$form['options'] = [
'#type' => 'details',
'#access' => $this
->currentUser()
->hasPermission('administer feeds'),
'#title' => $this
->t('Import options'),
'#collapsed' => TRUE,
'#group' => 'advanced',
];
$form['options']['status'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Active'),
'#default_value' => $feed
->isActive(),
'#description' => $this
->t('Uncheck the above checkbox to disable periodic import for this feed.'),
];
return $form;
}
/**
* {@inheritdoc}
*/
protected function actions(array $form, FormStateInterface $form_state) {
$element = parent::actions($form, $form_state);
// Add an "Import" button.
if ($this->entity
->access('import')) {
$element['submit']['#dropbutton'] = 'save';
$element['import'] = $element['submit'];
$element['import']['#dropbutton'] = 'save';
$element['import']['#value'] = $this
->t('Save and import');
$element['import']['#weight'] = 0;
$element['import']['#submit'][] = '::import';
}
$element['delete']['#access'] = $this->entity
->access('delete');
return $element;
}
/**
* {@inheritdoc}
*
* @todo Don't call buildEntity() here.
*/
public function validateForm(array &$form, FormStateInterface $form_state) {
if ($form_state
->getErrors()) {
return;
}
$feed = $this
->buildEntity($form, $form_state);
foreach ($feed
->getType()
->getPlugins() as $type => $plugin) {
if (!$this
->pluginHasForm($plugin, 'feed')) {
continue;
}
$feed_form = $this->formFactory
->createInstance($plugin, 'feed');
$plugin_state = (new FormState())
->setValues($form_state
->getValue([
'plugin',
$type,
], []));
$feed_form
->validateConfigurationForm($form['plugin'][$type], $plugin_state, $feed);
$form_state
->setValue([
'plugin',
$type,
], $plugin_state
->getValues());
foreach ($plugin_state
->getErrors() as $name => $error) {
// Remove duplicate error messages.
if (!empty($_SESSION['messages']['error'])) {
foreach ($_SESSION['messages']['error'] as $delta => $message) {
if ($message['message'] === $error) {
unset($_SESSION['messages']['error'][$delta]);
break;
}
}
}
$form_state
->setErrorByName($name, $error);
}
}
parent::validateForm($form, $form_state);
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
// Build the feed object from the submitted values.
parent::submitForm($form, $form_state);
$feed = $this->entity;
foreach ($feed
->getType()
->getPlugins() as $type => $plugin) {
if ($this
->pluginHasForm($plugin, 'feed')) {
$feed_form = $this->formFactory
->createInstance($plugin, 'feed');
$plugin_state = (new FormState())
->setValues($form_state
->getValue([
'plugin',
$type,
], []));
$feed_form
->submitConfigurationForm($form['plugin'][$type], $plugin_state, $feed);
$form_state
->setValue([
'plugin',
$type,
], $plugin_state
->getValues());
}
}
}
/**
* {@inheritdoc}
*/
public function save(array $form, FormStateInterface $form_state) {
$feed = $this->entity;
$insert = $feed
->isNew();
$feed
->save();
$context = [
'@type' => $feed
->bundle(),
'%title' => $feed
->label(),
];
$t_args = [
'@type' => $feed
->getType()
->label(),
'%title' => $feed
->label(),
];
if ($insert) {
$this
->logger('feeds')
->notice('@type: added %title.', $context);
$this
->messenger()
->addMessage($this
->t('%title has been created.', $t_args));
}
else {
$this
->logger('feeds')
->notice('@type: updated %title.', $context);
$this
->messenger()
->addMessage($this
->t('%title has been updated.', $t_args));
}
if (!$feed
->id()) {
// In the unlikely case something went wrong on save, the feed will be
// rebuilt and feed form redisplayed the same way as in preview.
$this
->messenger()
->addError($this
->t('The feed could not be saved.'));
$form_state
->setRebuild();
return;
}
if ($feed
->access('view')) {
$form_state
->setRedirect('entity.feeds_feed.canonical', [
'feeds_feed' => $feed
->id(),
]);
}
else {
$form_state
->setRedirect('<front>');
}
}
/**
* Form submission handler for the 'import' action.
*
* @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.
*/
public function import(array $form, FormStateInterface $form_state) {
$feed = $this->entity;
$feed
->startBatchImport();
return $feed;
}
/**
* Returns whether or not the plugin implements a form for the given type.
*
* @param \Drupal\feeds\Plugin\Type\FeedsPluginInterface $plugin
* The Feeds plugin.
* @param string $operation
* The type of form to check for. See
* \Drupal\feeds\Plugin\PluginFormFactory::hasForm() for more information.
*
* @return bool
* True if the plugin implements a form of the given type. False otherwise.
*
* @see \Drupal\feeds\Plugin\PluginFormFactory::hasForm()
*/
protected function pluginHasForm(FeedsPluginInterface $plugin, $operation) {
return $this->formFactory
->hasForm($plugin, $operation);
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ContentEntityForm:: |
protected | property |
The entity being used by this form. Overrides EntityForm:: |
9 |
ContentEntityForm:: |
protected | property | The entity repository service. | |
ContentEntityForm:: |
protected | property | The entity type bundle info service. | |
ContentEntityForm:: |
protected | property | The time service. | |
ContentEntityForm:: |
protected | function | Add revision form fields if the entity enabled the UI. | |
ContentEntityForm:: |
public | function |
Builds an updated entity object based upon the submitted form values. Overrides EntityForm:: |
3 |
ContentEntityForm:: |
protected | function |
Copies top-level form values to entity properties Overrides EntityForm:: |
|
ContentEntityForm:: |
protected | function | Flags violations for the current form. | 4 |
ContentEntityForm:: |
protected | function | Returns the bundle entity of the entity, or NULL if there is none. | |
ContentEntityForm:: |
protected | function | Gets the names of all fields edited in the form. | 4 |
ContentEntityForm:: |
public | function |
Gets the form display. Overrides ContentEntityFormInterface:: |
|
ContentEntityForm:: |
public | function |
Gets the code identifying the active form language. Overrides ContentEntityFormInterface:: |
|
ContentEntityForm:: |
protected | function | Should new revisions created on default. | |
ContentEntityForm:: |
protected | function |
Initializes the form state and the entity before the first form build. Overrides EntityForm:: |
1 |
ContentEntityForm:: |
protected | function | Initializes form language code values. | |
ContentEntityForm:: |
public | function |
Checks whether the current form language matches the entity one. Overrides ContentEntityFormInterface:: |
|
ContentEntityForm:: |
protected | function |
Prepares the entity object before the form is built first. Overrides EntityForm:: |
1 |
ContentEntityForm:: |
public | function |
Sets the form display. Overrides ContentEntityFormInterface:: |
|
ContentEntityForm:: |
protected | function | Checks whether the revision form fields should be added to the form. | |
ContentEntityForm:: |
public | function | Updates the changed time of the entity. | |
ContentEntityForm:: |
public | function | Updates the form language to reflect any change to the entity language. | |
ContentEntityForm:: |
public | function | Constructs a ContentEntityForm object. | 9 |
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
EntityForm:: |
protected | property | The entity type manager. | 3 |
EntityForm:: |
protected | property | The module handler service. | |
EntityForm:: |
protected | property | The name of the current operation. | |
EntityForm:: |
private | property | The entity manager. | |
EntityForm:: |
protected | function | Returns the action form element for the current entity form. | |
EntityForm:: |
public | function | Form element #after_build callback: Updates the entity with submitted data. | |
EntityForm:: |
public | function |
Form constructor. Overrides FormInterface:: |
10 |
EntityForm:: |
public | function |
Returns a string identifying the base form. Overrides BaseFormIdInterface:: |
5 |
EntityForm:: |
public | function |
Gets the form entity. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Determines which entity will be used by this form from a RouteMatch object. Overrides EntityFormInterface:: |
1 |
EntityForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
10 |
EntityForm:: |
public | function |
Gets the operation identifying the form. Overrides EntityFormInterface:: |
|
EntityForm:: |
protected | function | Invokes the specified prepare hook variant. | |
EntityForm:: |
public | function | Process callback: assigns weights and hides extra fields. | |
EntityForm:: |
public | function |
Sets the form entity. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Sets the entity manager for this form. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Sets the entity type manager for this form. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Sets the module handler for this form. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Sets the operation for this form. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function | ||
EntityForm:: |
public | function | ||
FeedForm:: |
protected | property | The form factory. | |
FeedForm:: |
protected | function |
Returns an array of supported actions for the current entity form. Overrides EntityForm:: |
|
FeedForm:: |
public static | function |
Instantiates a new instance of this class. Overrides ContentEntityForm:: |
|
FeedForm:: |
public | function |
Gets the actual form array to be built. Overrides ContentEntityForm:: |
|
FeedForm:: |
public | function | Form submission handler for the 'import' action. | |
FeedForm:: |
protected | function | Returns whether or not the plugin implements a form for the given type. | |
FeedForm:: |
public | function |
Form submission handler for the 'save' action. Overrides EntityForm:: |
|
FeedForm:: |
protected | function | Sets the form factory, used to generate forms for Feeds plugins. | |
FeedForm:: |
public | function |
This is the default entity object builder function. It is called before any
other submit handler to build the new entity object to be used by the
following submit handlers. At this point of the form workflow the entity is
validated and the form state… Overrides ContentEntityForm:: |
|
FeedForm:: |
public | function |
@todo Don't call buildEntity() here. Overrides ContentEntityForm:: |
|
FormBase:: |
protected | property | The config factory. | 1 |
FormBase:: |
protected | property | The request stack. | 1 |
FormBase:: |
protected | property | The route match. | |
FormBase:: |
protected | function | Retrieves a configuration object. | |
FormBase:: |
protected | function | Gets the config factory for this form. | 1 |
FormBase:: |
private | function | Returns the service container. | |
FormBase:: |
protected | function | Gets the current user. | |
FormBase:: |
protected | function | Gets the request object. | |
FormBase:: |
protected | function | Gets the route match. | |
FormBase:: |
protected | function | Gets the logger for a specific channel. | |
FormBase:: |
protected | function |
Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait:: |
|
FormBase:: |
public | function | Resets the configuration factory. | |
FormBase:: |
public | function | Sets the config factory for this form. | |
FormBase:: |
public | function | Sets the request stack object to use. | |
LinkGeneratorTrait:: |
protected | property | The link generator. | 1 |
LinkGeneratorTrait:: |
protected | function | Returns the link generator. | |
LinkGeneratorTrait:: |
protected | function | Renders a link to a route given a route name and its parameters. | |
LinkGeneratorTrait:: |
public | function | Sets the link generator service. | |
LoggerChannelTrait:: |
protected | property | The logger channel factory service. | |
LoggerChannelTrait:: |
protected | function | Gets the logger for a specific channel. | |
LoggerChannelTrait:: |
public | function | Injects the logger channel factory. | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
UrlGeneratorTrait:: |
protected | property | The url generator. | |
UrlGeneratorTrait:: |
protected | function | Returns the URL generator service. | |
UrlGeneratorTrait:: |
public | function | Sets the URL generator service. | |
UrlGeneratorTrait:: |
protected | function | Generates a URL or path for a specific route based on the given parameters. |