class WebformDevelSchemaController in Webform 8.5
Same name and namespace in other branches
- 6.x modules/webform_devel/src/Controller/WebformDevelSchemaController.php \Drupal\webform_devel\Controller\WebformDevelSchemaController
Provides route responses for webform devel schema.
Hierarchy
- class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\webform_devel\Controller\WebformDevelSchemaController implements ContainerInjectionInterface
Expanded class hierarchy of WebformDevelSchemaController
File
- modules/
webform_devel/ src/ Controller/ WebformDevelSchemaController.php, line 16
Namespace
Drupal\webform_devel\ControllerView source
class WebformDevelSchemaController extends ControllerBase implements ContainerInjectionInterface {
/**
* The config factory.
*
* @var \Drupal\Core\Config\ConfigFactoryInterface
*/
protected $configFactory;
/**
* The webform devel schema generator.
*
* @var \Drupal\webform_devel\WebformDevelSchemaInterface
*/
protected $schema;
/**
* Constructs a WebformDevelSchemaController object.
*
* @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
* The factory for configuration objects.
* @param \Drupal\webform_devel\WebformDevelSchemaInterface $schema
* The webform devel schema generator.
*/
public function __construct(ConfigFactoryInterface $config_factory, WebformDevelSchemaInterface $schema) {
$this->configFactory = $config_factory;
$this->schema = $schema;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container
->get('config.factory'), $container
->get('webform_devel.schema'));
}
/**
* Returns a webform's schema as a CSV.
*
* @param \Drupal\webform\WebformInterface $webform
* The webform to be exported.
*
* @return \Symfony\Component\HttpFoundation\StreamedResponse
* A streamed response containing webform's schema as a CSV.
*/
public function index(WebformInterface $webform) {
$multiple_delimiter = $this->configFactory
->get('webform.settings')
->get('export.multiple_delimiter') ?: ';';
// From: http://obtao.com/blog/2013/12/export-data-to-a-csv-file-with-symfony/
$response = new StreamedResponse(function () use ($webform, $multiple_delimiter) {
$handle = fopen('php://output', 'r+');
// Header.
fputcsv($handle, $this->schema
->getColumns());
// Rows.
$elements = $this->schema
->getElements($webform);
foreach ($elements as $element) {
$element['options'] = implode($multiple_delimiter, $element['options']);
fputcsv($handle, $element);
}
fclose($handle);
});
$response->headers
->set('Content-Type', 'application/force-download');
$response->headers
->set('Content-Disposition', 'attachment; filename="' . $webform
->id() . '.schema.csv"');
return $response;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ControllerBase:: |
protected | property | The current user service. | 1 |
ControllerBase:: |
protected | property | The entity form builder. | |
ControllerBase:: |
protected | property | The entity manager. | |
ControllerBase:: |
protected | property | The entity type manager. | |
ControllerBase:: |
protected | property | The form builder. | 2 |
ControllerBase:: |
protected | property | The key-value storage. | 1 |
ControllerBase:: |
protected | property | The language manager. | 1 |
ControllerBase:: |
protected | property | The module handler. | 2 |
ControllerBase:: |
protected | property | The state service. | |
ControllerBase:: |
protected | function | Returns the requested cache bin. | |
ControllerBase:: |
protected | function | Retrieves a configuration object. | |
ControllerBase:: |
private | function | Returns the service container. | |
ControllerBase:: |
protected | function | Returns the current user. | 1 |
ControllerBase:: |
protected | function | Retrieves the entity form builder. | |
ControllerBase:: |
protected | function | Retrieves the entity manager service. | |
ControllerBase:: |
protected | function | Retrieves the entity type manager. | |
ControllerBase:: |
protected | function | Returns the form builder service. | 2 |
ControllerBase:: |
protected | function | Returns a key/value storage collection. | 1 |
ControllerBase:: |
protected | function | Returns the language manager service. | 1 |
ControllerBase:: |
protected | function | Returns the module handler. | 2 |
ControllerBase:: |
protected | function |
Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait:: |
|
ControllerBase:: |
protected | function | Returns the state storage service. | |
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. | |
WebformDevelSchemaController:: |
protected | property |
The config factory. Overrides ControllerBase:: |
|
WebformDevelSchemaController:: |
protected | property | The webform devel schema generator. | |
WebformDevelSchemaController:: |
public static | function |
Instantiates a new instance of this class. Overrides ControllerBase:: |
|
WebformDevelSchemaController:: |
public | function | Returns a webform's schema as a CSV. | |
WebformDevelSchemaController:: |
public | function | Constructs a WebformDevelSchemaController object. |