First functional version of config search

netz98 · Dec 26, 2023 · c846d5c · c846d5c
1 parent a04f0e0
commit c846d5c
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 50 deletions.
diff --git a/src/N98/Magento/Command/Config/SearchCommand.php b/src/N98/Magento/Command/Config/SearchCommand.php
@@ -9,10 +9,9 @@
 
 namespace N98\Magento\Command\Config;
 
-use Magento\Backend\Model\Search\Config\Result\Builder;
-use Magento\Backend\Model\Search\Config as ConfigSeaerch;
 use Magento\Config\Model\Config\Structure as ConfigStructure;
 use Magento\Config\Model\Config\Structure\Data as ConfigStructureData;
+use Magento\Config\Model\Config\Structure\Element\AbstractComposite;
 use Magento\Framework\App\Area;
 use Magento\Framework\App\AreaList;
 use Magento\Framework\App\State;
@@ -28,7 +27,9 @@ class SearchCommand extends AbstractMagentoCommand
 {
     private ConfigStructure $configStructure;
     private ConfigStructureData $configStructureData;
-    private Builder $resultBuilder;
+    private array $results = [];
+
+    private $tabMap = [];
 
     protected function configure()
     {
@@ -65,85 +66,72 @@ protected function execute(InputInterface $input, OutputInterface $output)
 
         $this->setAdminArea();
 
-        $appState = $this->getObjectManager()->get(State::class);
-        $appState->emulateAreaCode('adminhtml', function () use ($input, $output) {
-            $results = $this->getObjectManager()->create(ConfigSeaerch::class)
-                ->setStart(0)
-                ->setLimit(100)
-                ->setQuery($input->getArgument('text'))
-                ->load()
-                ->getResults();
-
-            var_dump($results);
-            die;
-        });
+        // We cannot use the search objects from Magento_Backend modules because they are
+        // using the ACL resource reader which is not available in the CLI context without
+        // defining loading a admin user. So we load the data by the using the data layer below.
 
         $this->configStructure = $this->getObjectManager()->create(ConfigStructure::class);
-        $tabs = $this->configStructure->getTabs();
-
-        die;
-
-        if ($tabs instanceof \Iterator) {
-            $tabs = iterator_to_array($tabs);
-        }
-        var_dump($tabs);
-        die;
         $this->configStructureData = $this->getObjectManager()->create(ConfigStructureData::class);
-        $this->resultBuilder = $this->getObjectManager()->create(Builder::class);
 
         $configData = $this->configStructureData->get();
+
+        $this->tabMap = $configData['tabs'];
+
         if (isset($configData['sections'])) {
             $this->findInStructure(
                 $configData['sections'],
-                $input->getArgument('text')
+                $input->getArgument('text'),
+                ''
             );
         }
 
-        $results = $this->resultBuilder->getAll();
-
-        if (empty($results)) {
+        if (count($this->results) === 0) {
             $output->writeln('<info>No results found.</info>');
             return self::SUCCESS;
         }
 
-        $tableData = [];
-        foreach ($results as $result) {
-            $tableData[] = [
-                $result['name'],
-                $result['description'],
-            ];
-        }
-
         $this->getHelper('table')
-            ->setHeaders(['Name', 'Description'])
-            ->renderByFormat($output, $tableData, $input->getOption('format'));
+            ->setHeaders(array_keys($this->results[0]))
+            ->renderByFormat($output, $this->results, $input->getOption('format'));
 
         return self::SUCCESS;
     }
 
     /**
      * @param array $elements
      * @param string $searchTerm
+     * @param string $pathLabel
      */
-    private function findInStructure($elements, $searchTerm)
+    private function findInStructure($elements, $searchTerm, $pathLabel = '')
     {
         if (empty($searchTerm)) {
             return;
         }
 
-        foreach ($elements as $elementData) {
-            // search in label
-            if (isset($elementData['label']) && mb_stripos((string)$elementData['label'], $searchTerm) !== false) {
-                // if element has a path, add it to the result
-                if (isset($elementData['path'])) {
-                    $element = $this->configStructure->getElementByConfigPath($elementData['path']);
-                    $this->resultBuilder->add($element, $elementData['path']);
+        foreach ($elements as $structureElement) {
+
+            // Initial call contains only the sections and need to extract the tabs
+            if (is_array($structureElement)) {
+                if (isset($structureElement['tab'])) {
+                    $pathLabel =  $this->tabMap[$structureElement['tab']]['label'];
                 }
+                $structureElement = $this->configStructure->getElement($structureElement['id']);
+            }
+
+            if (mb_stripos((string)$structureElement->getLabel(), $searchTerm) !== false
+                || mb_stripos((string)$structureElement->getComment(), $searchTerm) !== false
+            ) {
+                $elementData = $structureElement->getData();
+                $this->results[] = [
+                    'id' => trim($structureElement->getPath(), '/'),
+                    'type' => $elementData['_elementType'],
+                    'name' => trim($pathLabel . ' / ' . trim((string)$structureElement->getLabel()), '/'),
+                ];
             }
 
-            // If the element has children (like groups), recurse
-            if (isset($elementData['children'])) {
-                $this->findInStructure($elementData['children'], $searchTerm);
+            $elementPathLabel = $pathLabel . ' / ' . $structureElement->getLabel();
+            if ($structureElement instanceof AbstractComposite && $structureElement->hasChildren()) {
+                $this->findInStructure($structureElement->getChildren(), $searchTerm, $elementPathLabel);
             }
         }
     }

diff --git a/tests/bats/functional_magerun_commands.bats b/tests/bats/functional_magerun_commands.bats
@@ -117,6 +117,11 @@ function cleanup_files_in_magento() {
   assert_output --partial "backend.frontName"
 }
 
+@test "Command: config:search" {
+  run $BIN "config:search" "tax"
+  assert_output --partial "Sales / Tax"
+}
+
 @test "Command: config:store:set" {
   run $BIN "config:store:set" n98/magerun/example defaultValue
   assert_output --partial "n98/magerun/example => defaultValue"