Download the PHP package sinso/app-routes without Composer
On this page you can find all versions of the php package sinso/app-routes. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download sinso/app-routes
More information about sinso/app-routes
Files in sinso/app-routes
Package app-routes
Short Description Easy way to route rest-like URLs to your code
License GPL-2.0-only
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package app-routes
TYPO3 App Routes
Route any URL to your application.
You use this package if you want to route certain URLs directly to your controllers, completely ignoring the TYPO3 page routing.
This is especially useful to create REST APIs.
Installation
Configuration
This package will look for Configuration/AppRoutes.yaml files in any loaded extension. Creating this file is all you need to get started:
The class you provide as defaults.handler has to implement \Psr\Http\Server\RequestHandlerInterface.
The routing parameters will be available in $request->getQueryParams().
Options
Under the hood symfony/routing is used.
Everything that is available as YAML configuration option in symfony/routing should work with this package out of the box.
This package offers these additional options:
defaults.cache: true- If true, then responses are cached (see more details below). (default:false)defaults.requiresTsfe: true- If true, then$GLOBALS['TSFE']will be initialized before your handler is called (default:false).
Generate Route URLs
To generate URLs you can use the Sinso\AppRoutes\Service\Router:
If you need to generate a URL in a Fluid template, there's also a ViewHelper for that:
Configuration Module
In the configuration module there's an entry "App Routes", that shows all configured routes. Requires TYPO3 v11
Caching
- Caching can be enabled per route via configuration
defaults.cache: true. - The TYPO3
pagescache is used to cache API responses. - Your request handler will not be called at all if the request can be served from cache.
- Only responses for
GETandHEADrequests can be cached. - The cache key is built from all query parameters that were matched by your route.
- If
$GLOBALS['TSFE']was involved in handling the request and cache tags were added to it via$tsfe->addCacheTags($tags), those are applied to the cache entry. - If you have
$GLOBALS['TYPO3_CONF_VARS']['FE']['debug']enabled, the HTTP response contains headers describing its cache status. - Responses with
Cache-Control: no-cacheorCache-Control: no-storeare not cached. - Responses with
Cache-Control: max-age=300overwrite the default TTL of thepagescache.
