class CatalogAdminController in Ubercart 8.4

Convenience methods for catalog administration.

Hierarchy

• class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\uc_catalog\Controller\CatalogAdminController

File

uc_catalog/src/Controller/CatalogAdminController.php, line 12

Namespace

Drupal\uc_catalog\Controller

class CatalogAdminController extends ControllerBase {

  /**
   * Repairs the catalog taxonomy field if it is lost or deleted.
   */
  public function repairField() {
    foreach (uc_product_types() as $type) {
      uc_catalog_add_node_type($type);
    }
    uc_catalog_add_image_field();
    $this
      ->messenger()
      ->addMessage($this
      ->t('The catalog taxonomy reference field has been repaired.'));
    return $this
      ->redirect('uc_store.admin');
  }

  /**
   * Displays links to all products that have not been categorized.
   *
   * @return array
   *   Renderable form array.
   */
  public function orphans() {
    $build = [];
    if ($this
      ->config('taxonomy.settings')
      ->get('maintain_index_table')) {
      $vid = $this
        ->config('uc_catalog.settings')
        ->get('vocabulary');
      $product_types = uc_product_types();
      $field = FieldStorageConfig::loadByName('node', 'taxonomy_catalog');

      // @todo - figure this out.
      // $field is a config object, not an array, so this doesn't work.
      // $types = array_intersect($product_types, $field['bundles']['node']);
      $types = $product_types;

      // Temporary, to get this to work at all.
      $result = \Drupal::database()
        ->query('SELECT DISTINCT n.nid, n.title FROM {node_field_data} n LEFT JOIN (SELECT ti.nid, td.vid FROM {taxonomy_index} ti LEFT JOIN {taxonomy_term_data} td ON ti.tid = td.tid WHERE td.vid = :vid) txnome ON n.nid = txnome.nid WHERE n.type IN (:types[]) AND txnome.vid IS NULL', [
        ':vid' => $vid,
        ':types[]' => $types,
      ]);
      $rows = [];
      while ($node = $result
        ->fetchObject()) {
        $rows[] = Link::createFromRoute($node->title, 'entity.node.edit_form', [
          'node' => $node->nid,
        ], [
          'query' => [
            'destination' => 'admin/store/products/orphans',
          ],
        ])
          ->toString();
      }
      if (count($rows) > 0) {
        $build['orphans'] = [
          '#theme' => 'item_list',
          '#items' => $rows,
        ];
      }
      else {
        $build['orphans'] = [
          '#markup' => $this
            ->t('All products are currently listed in the catalog.'),
          '#prefix' => '<p>',
          '#suffix' => '</p>',
        ];
      }
    }
    else {
      $build['orphans'] = [
        '#markup' => $this
          ->t('The node terms index is not being maintained, so Ubercart can not determine which products are not entered into the catalog.'),
        '#prefix' => '<p>',
        '#suffix' => '</p>',
      ];
    }
    return $build;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CatalogAdminController::orphans	public	function	Displays links to all products that have not been categorized.
CatalogAdminController::repairField	public	function	Repairs the catalog taxonomy field if it is lost or deleted.
ControllerBase::$configFactory	protected	property	The configuration factory.
ControllerBase::$currentUser	protected	property	The current user service.	1
ControllerBase::$entityFormBuilder	protected	property	The entity form builder.
ControllerBase::$entityManager	protected	property	The entity manager.
ControllerBase::$entityTypeManager	protected	property	The entity type manager.
ControllerBase::$formBuilder	protected	property	The form builder.	2
ControllerBase::$keyValue	protected	property	The key-value storage.	1
ControllerBase::$languageManager	protected	property	The language manager.	1
ControllerBase::$moduleHandler	protected	property	The module handler.	2
ControllerBase::$stateService	protected	property	The state service.
ControllerBase::cache	protected	function	Returns the requested cache bin.
ControllerBase::config	protected	function	Retrieves a configuration object.
ControllerBase::container	private	function	Returns the service container.
ControllerBase::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create	40
ControllerBase::currentUser	protected	function	Returns the current user.	1
ControllerBase::entityFormBuilder	protected	function	Retrieves the entity form builder.
ControllerBase::entityManager Deprecated	protected	function	Retrieves the entity manager service.
ControllerBase::entityTypeManager	protected	function	Retrieves the entity type manager.
ControllerBase::formBuilder	protected	function	Returns the form builder service.	2
ControllerBase::keyValue	protected	function	Returns a key/value storage collection.	1
ControllerBase::languageManager	protected	function	Returns the language manager service.	1
ControllerBase::moduleHandler	protected	function	Returns the module handler.	2
ControllerBase::redirect	protected	function	Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state	protected	function	Returns the state storage service.
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.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' 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.	1
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.