main
en
Alexander Stehlik
This extension documentation is published under the CC BY-NC-SA 4.0 (Creative Commons) license
This extensions allows you to cut down long URLs. It basically works like bitly or TinyURL.
It converts a normal URL to a tiny URL. It works similar as services provided by https://bitly.com/ or http://tinyurl.com/ .
It has multiple integration options. You can create tiny URLs in the backend by adding a tiny URL database record. You can convert any typolink to a tinyurl by simply adding some configuration options. And you can use the API of this extension to create tiny URLs in your own extensions.
Settings for a tiny URL in the Backend;
You can either use the extension as an administrator / integrator by using additional TypoScript (see Administrator Manual section) or as a developer by using the API of the extension (see Developer Corner section).
A tiny URL key consists of two parts:
A URL key might look like this:
Aefc-3E
The first part is generated from the UID of the tiny URL database record which is converted to a base62 integer.
The second part (after the dash) is simply a random hexadecimal string.
In the extension configuration you can edit two options that influence the tiny URL key generation. If minimalTinyurlKeyLength is set the URL key must have at least this amount of characters. If the base62 part is shorter the missing characters will be appended. An example:
Another option is the minimalRandomKeyLength . If this is set to a value greater than zero the defined number of random characters will always be appended to the base62 part. Another example:
The first step, to get this extension up and running is importing it in the extension manager and install it.
Alternatively you can use composer to install the extension:
composer require de-swebhosting-typo3-extension/tinyurls
Then you can edit the extension configuration according to your needs.
Now you are able to create and use tiny URLs in your TYPO3 instance.
Once the extension is installed you can add tiny URLs in the TYPO3 backend. If you didn't change the
default value of url in the extension configuration you must add the records
in the TYPO3 root. Otherwise you can add them in the page (folder) with the PID you specified in the config.
You can convert any typolink to a tinyurl by simply setting the property tinyurl to 1. For more information about the TypoScript configuration options please have a look in the TypoScript configuration section.
This is a quick example:
page.30 = TEXT
page.30 {
value = Permalink
typolink = 1
typolink.parameter.data = getIndpEnv:REQUEST_URI
typolink.tinyurl = 1
}By default, a tiny URL created by this extension will look like this:
http://mytypo3page.tld/index.php?eID=tx_tinyurls&tx_tinyurls[key ]=Aefc-3E
This is not very short and readable. This is why using speaking URLs is recommended. For this to work you need to set createSpeakingURLs to 1 and maybe edit the speakingUrlTemplate . By default, speaking URLs will look like this:
http://mytypo3page.tld/goto/Aefc-3E
Obviously you will need to tell you webserver how to handle these URLs.
When you are using mod_rewrite you can use this line in your .htaccess file or your webserver configuration:
RewriteRule ^tinyurl/([a-zA-Z0-9]+(-[a-zA-Z0-9]+)?)$ /index.php?eID=tx_tinyurls&tx_tinyurls[key]=$1
When you use lighttpd you can use this configuration for rewriting tiny URLs:
url.rewrite-if-not-file = (
# rewrite goto urls to tinyurls extension
"^/tinyurl/(.*)$" => typo3path + "index.php?eID=tx_tinyurls&tx_tinyurls[key]=$1",
)Most of the configuration is done in the extension configuration.
New in version 13.x: Every Extension configuration setting can now be overwritten in the Site Configuration
in the tinyurls key, e.g.:
tinyurls:
baseUrl: 'https://example.com'When using the typolink configuration, there are also additional TypoScript settings available.
<Empty string>00TYPO3CMSCoreUtilityGeneraulUtility::getIndpEnv()
as template markers (e.g. ###TYPO3_SITE_URL### and the ###TINY_URL_KEY###
template marker will be replaced with the shortened URL key.###TYPO3_SITE_URL###tinyurl/###TINY_URL_KEY### abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789 28These additional properties are available for typolink objects when the extension is installed:
If you set this to 1 (TRUE) the final typolink URL is converted to a tiny URL.
You an set some configuration options for the tiny URL generator int the
tinyurl. namespace (see below).
When you want to generate tiny URLs in your own extension you can use the
\Tx\
class to set the properties and then use the
\Tx\ service
to generate the Tiny URL.
Please have a look at the PHPDoc annotations for further information. This is a quick example how to use it:
<?php
use Tx\Tinyurls\Domain\Model\TinyUrl;
use Tx\Tinyurls\TinyUrl\TinyUrlGeneratorInterface;
class MyDemo
{
public function __construct(private TinyUrlGeneratorInterface $tinyUrlGenerator)
{
}
public function createTinyUrl(string $theKey, DateTimeInterface $validUntil): string
{
$tinyUrl = TinyUrl::createForUrl('http://www.typo3.org');
$tinyUrl->enableDeleteOnUse();
$tinyUrl->setCustomUrlKey($theKey);
$tinyUrl->setValidUntil($validUntil);
return $this->tinyUrlGenerator->generateTinyUrl($tinyUrl);
}
}You can find the current problems, TODOs and changelogs on GitHub: