class CountryController in Ubercart 8.4
Utility functions to enable and disable country configuration entities.
Hierarchy
- class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\uc_country\Controller\CountryController
Expanded class hierarchy of CountryController
File
- uc_country/
src/ Controller/ CountryController.php, line 11
Namespace
Drupal\uc_country\ControllerView source
class CountryController extends ControllerBase {
/**
* Enables a country.
*
* @param \Drupal\uc_country\Entity\Country $uc_country
* The country object to enable.
*
* @return \Symfony\Component\HttpFoundation\RedirectResponse
* A redirect response to the country listing page.
*/
public function enableConfig(Country $uc_country) {
$uc_country
->enable()
->save();
$this
->messenger()
->addMessage($this
->t('The country %label has been enabled.', [
'%label' => $uc_country
->label(),
]));
return $this
->redirect('entity.uc_country.collection');
}
/**
* Disables a country.
*
* @param \Drupal\uc_country\Entity\Country $uc_country
* The country object to disable.
*
* @return \Symfony\Component\HttpFoundation\RedirectResponse
* A redirect response to the country listing page.
*/
public function disableConfig(Country $uc_country) {
$uc_country
->disable()
->save();
$this
->messenger()
->addMessage($this
->t('The country %label has been disabled.', [
'%label' => $uc_country
->label(),
]));
return $this
->redirect('entity.uc_country.collection');
}
/**
* Returns a list of all installed/available countries.
*
* @return array
* Associative array keyed by the country's ISO 3166-1 alpha_2 country
* code and containing the translated ISO 3166-1 country name.
*/
public static function countryOptionsCallback() {
return \Drupal::service('country_manager')
->getEnabledList();
}
/**
* Helper function to return zone options, grouped by country.
*/
public static function zoneOptionsCallback() {
$options = [];
// Must use \Drupal:: because we're in a static function.
$countries = \Drupal::entityTypeManager()
->getStorage('uc_country')
->loadByProperties([
'status' => TRUE,
]);
foreach ($countries as $country) {
foreach ($country
->getZones() as $id => $zone) {
$options[$id] = $country
->label() . ': ' . $zone;
}
}
uasort($options, 'strnatcasecmp');
return $options;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ControllerBase:: |
protected | property | The configuration factory. | |
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:: |
public static | function |
Instantiates a new instance of this class. Overrides ContainerInjectionInterface:: |
40 |
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. | |
CountryController:: |
public static | function | Returns a list of all installed/available countries. | |
CountryController:: |
public | function | Disables a country. | |
CountryController:: |
public | function | Enables a country. | |
CountryController:: |
public static | function | Helper function to return zone options, grouped by country. | |
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. |