Understanding SOLR and TYPO3 Integration

Oct 13, 2025 by leolavanderia.com.br 34 views

Introduction

In this article, we will explore the process of setting up a readable URL in TYPO3 12 with SOLR. This involves configuring the SOLR plugin to index and retrieve data from the TYPO3 database, and then creating a custom route to display the indexed data in a user-friendly format.

Understanding SOLR and TYPO3 Integration

SOLR (Search Engine Library) is a powerful search engine that can be integrated with TYPO3 to provide advanced search functionality. The SOLR plugin for TYPO3 allows you to index and retrieve data from the TYPO3 database, making it possible to create custom search interfaces and display search results in a user-friendly format.

Configuring the SOLR Plugin

To configure the SOLR plugin, you need to create a configuration file in the typo3conf directory. This file is typically named solr.xml and contains the configuration settings for the SOLR plugin.

<?xml version="1.0" encoding="UTF-8" ?>
<plugin>
    <tx_solr>
        <index>
            <queue>
                <pressphotos>
                    <type>tx_company_z_pressphotos</type>
                    <label>myPressphotosLabel</label>
                    <fields>
                        <!-- Add fields to index here -->
                    </fields>
                </pressphotos>
            </queue>
        </index>
    </tx_solr>
</plugin>

In the above configuration file, we have defined a queue named pressphotos that indexes data from the tx_company_z_pressphotos table. We have also specified the label for the queue as myPressphotosLabel.

Creating a Custom Route

To create a custom route for displaying the indexed data, you need to create a new PHP class that extends the TYPO3\CMS\Core\Routing\Aspect\AspectInterface. This class will contain the logic for retrieving the indexed data and displaying it in a user-friendly format.

namespace Vendor\Package\Controller;

use TYPO3\CMS\Core\Routing\Aspect\AspectInterface;
use TYPO3\CMS\Core\Routing\RouteInterface;
use TYPO3\CMS\Core\Routing\RouteCollection;
use TYPO3\CMS\Core\Utility\GeneralUtility;

class PressphotosRouteAspect implements AspectInterface
{
    public function getAspect(RouteInterface $route, RouteCollection $routeCollection)
    {
        // Retrieve the indexed data from the SOLR plugin
        $solr = GeneralUtility::makeInstance('TYPO3\CMS\Extbase\Utility\TypoScriptService');
        $solr->setTypoScriptPath('plugin.tx_solr.index.queue.pressphotos');
        $solr->setTypoScriptSetup('plugin.tx_solr.index.queue.pressphotos');
        $solr->setTypoScriptSetup('plugin.tx_solr.index.queue.pressphotos.fields');
        $solrData = $solr->getTypoScriptSetup();

        // Display the indexed data in a user-friendly format
        $output = '<h1>Press Photos</h1>';
        $output .= '<ul>';
        foreach ($solrData as $data) {
            $output .= '<li>' . $data['title'] . '</li>';
        }
        $output .= '</ul>';

        // Return the output as a string
        return $output;
    }
}

In the above code, we have created a custom route aspect that retrieves the indexed data from the SOLR plugin and displays it in a user-friendly format.

Registering the Custom Route

To register the custom route, you need to add the following code to the typo3conf directory.

<?xml version="1.0" encoding="UTF-8" ?>
<routes>
    <route>
        <name>pressphotos</name>
        <pattern>/pressphotos</pattern>
        <controller>Vendor\Package\Controller\PressphotosController</controller>
        <aspect>Vendor\Package\Controller\PressphotosRouteAspect</aspect>
    </route>
</routes>

In the above code, we have registered the custom route with the name pressphotos and the pattern /pressphotos. We have also specified the controller and aspect for the route.

Conclusion

In this article, we have explored the process of setting up a readable URL in TYPO3 12 with SOLR. We have configured the SOLR plugin to index and retrieve data from the TYPO3 database, and then created a custom route to display the indexed data in a user-friendly format. We have also registered the custom route in the typo3conf directory.

Troubleshooting

If you encounter any issues while setting up the readable URL, you can try the following troubleshooting steps:

Check the SOLR plugin configuration file to ensure that it is correctly configured.
Verify that the custom route is correctly registered in the typo3conf directory.
Check the PHP error logs to ensure that there are no errors related to the custom route.

Future Development

In the future, we plan to enhance the SOLR plugin to support more advanced search functionality, such as faceting and filtering. We also plan to create more custom routes to display the indexed data in different formats.

References

SOLR Plugin Documentation
TYPO3 Routing Documentation
TYPO3 12 with SOLR - Readable URL Q&A =====================================

Q: What is SOLR and how does it integrate with TYPO3?

A: SOLR (Search Engine Library) is a powerful search engine that can be integrated with TYPO3 to provide advanced search functionality. The SOLR plugin for TYPO3 allows you to index and retrieve data from the TYPO3 database, making it possible to create custom search interfaces and display search results in a user-friendly format.

Q: How do I configure the SOLR plugin in TYPO3?

A: To configure the SOLR plugin, you need to create a configuration file in the typo3conf directory. This file is typically named solr.xml and contains the configuration settings for the SOLR plugin. You can add fields to index, specify the label for the queue, and configure other settings as needed.

Q: What is a custom route and how do I create one in TYPO3?

A: A custom route is a way to display the indexed data in a user-friendly format. To create a custom route, you need to create a new PHP class that extends the TYPO3\CMS\Core\Routing\Aspect\AspectInterface. This class will contain the logic for retrieving the indexed data and displaying it in a user-friendly format.

Q: How do I register a custom route in TYPO3?

A: To register a custom route, you need to add the following code to the typo3conf directory.

<?xml version="1.0" encoding="UTF-8" ?>
<routes>
    <route>
        <name>pressphotos</name>
        <pattern>/pressphotos</pattern>
        <controller>Vendor\Package\Controller\PressphotosController</controller>
        <aspect>Vendor\Package\Controller\PressphotosRouteAspect</aspect>
    </route>
</routes>

Q: What are some common issues that I may encounter while setting up a readable URL in TYPO3 with SOLR?

A: Some common issues that you may encounter while setting up a readable URL in TYPO3 with SOLR include:

Incorrect configuration of the SOLR plugin
Failure to register the custom route
Errors related to the custom route

Q: How do I troubleshoot issues with the SOLR plugin or custom route?

A: To troubleshoot issues with the SOLR plugin or custom route, you can try the following steps:

Check the SOLR plugin configuration file to ensure that it is correctly configured.
Verify that the custom route is correctly registered in the typo3conf directory.
Check the PHP error logs to ensure that there are no errors related to the custom route.

Q: What are some future development plans for the SOLR plugin in TYPO3?

A: Some future development plans for the SOLR plugin in TYPO3 include:

Enhancing the SOLR plugin to support more advanced search functionality, such as faceting and filtering.
Creating more custom routes to display the indexed data in different formats.

Q: Where can I find more information about the SOLR plugin and custom routes in TYPO3?

A: You can find more information about the SOLR plugin and custom routes in TYPO3 by visiting the following resources: