Skip to content

Instantly share code, notes, and snippets.

@fabianmu
Last active June 29, 2020 17:04
Show Gist options
  • Save fabianmu/5f73a6c2303e08add4e00dc2e548ef2d to your computer and use it in GitHub Desktop.
Save fabianmu/5f73a6c2303e08add4e00dc2e548ef2d to your computer and use it in GitHub Desktop.
<?php
// this is in the `/config` folder
$app->on("collections.save.before.aktuelles", function($name, &$entry, $isUpdate) use ($app) {
// generate slug on create only or when an existing one is empty
if (!$isUpdate || ($isUpdate && trim($entry['slug']) == '')) {
// generate slug based on entry name
$slug = Str::slug($entry['name']);
// count existing entires in collection with given $slug
$entries = count($app->module('collections')->find('aktuelles', [
'filter' => [
'slug' => $slug
],
'limit' => 1
]));
// if slug is existing already, postfix with incremental count
if ($entries > 0) {
$slug = "{$slug}-{$entries}";
}
$entry['slug'] = $slug;
}
});
// below code taken from https://github.com/laravel/framework/blob/5.6/src/Illuminate/Support/Str.php and adopted to work as simple non-dependeny class for slug-creation only
class Str
{
public static function slug($title, $separator = '-', $language = 'en')
{
$title = static::ascii($title, $language);
// Convert all dashes/underscores into separator
$flip = $separator == '-' ? '_' : '-';
$title = preg_replace('!['.preg_quote($flip).']+!u', $separator, $title);
// Replace @ with the word 'at'
$title = str_replace('@', $separator.'at'.$separator, $title);
// Remove all characters that are not the separator, letters, numbers, or whitespace.
$title = preg_replace('![^'.preg_quote($separator).'\pL\pN\s]+!u', '', mb_strtolower($title));
// Replace all separator characters and whitespace by a single separator
$title = preg_replace('!['.preg_quote($separator).'\s]+!u', $separator, $title);
return trim($title, $separator);
}
/**
* Transliterate a UTF-8 value to ASCII.
*
* @param string $value
* @param string $language
* @return string
*/
public static function ascii($value, $language = 'en')
{
$languageSpecific = static::languageSpecificCharsArray($language);
if (! is_null($languageSpecific)) {
$value = str_replace($languageSpecific[0], $languageSpecific[1], $value);
}
foreach (static::charsArray() as $key => $val) {
$value = str_replace($val, $key, $value);
}
return preg_replace('/[^\x20-\x7E]/u', '', $value);
}
/**
* Returns the language specific replacements for the ascii method.
*
* Note: Adapted from Stringy\Stringy.
*
* @see https://github.com/danielstjules/Stringy/blob/3.1.0/LICENSE.txt
*
* @param string $language
* @return array|null
*/
protected static function languageSpecificCharsArray($language)
{
static $languageSpecific;
if (! isset($languageSpecific)) {
$languageSpecific = [
'bg' => [
['х', 'Х', 'щ', 'Щ', 'ъ', 'Ъ', 'ь', 'Ь'],
['h', 'H', 'sht', 'SHT', 'a', 'А', 'y', 'Y'],
],
'de' => [
['ä', 'ö', 'ü', 'Ä', 'Ö', 'Ü'],
['ae', 'oe', 'ue', 'AE', 'OE', 'UE'],
],
];
}
return $languageSpecific[$language] ?? null;
}
/**
* Returns the replacements for the ascii method.
*
* Note: Adapted from Stringy\Stringy.
*
* @see https://github.com/danielstjules/Stringy/blob/3.1.0/LICENSE.txt
*
* @return array
*/
protected static function charsArray()
{
static $charsArray;
if (isset($charsArray)) {
return $charsArray;
}
return $charsArray = [
'0' => ['°', '', '۰', ''],
'1' => ['¹', '', '۱', ''],
'2' => ['²', '', '۲', ''],
'3' => ['³', '', '۳', ''],
'4' => ['', '', '۴', '٤', ''],
'5' => ['', '', '۵', '٥', ''],
'6' => ['', '', '۶', '٦', ''],
'7' => ['', '', '۷', ''],
'8' => ['', '', '۸', ''],
'9' => ['', '', '۹', ''],
'a' => ['à', 'á', '', 'ã', '', 'ă', '', '', '', '', '', 'â', '', '', '', '', '', 'ā', 'ą', 'å', 'α', 'ά', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '', 'ά', '', '', '', '', '', '', '', 'а', 'أ', '', '', '', 'ǻ', 'ǎ', 'ª', '', '', 'ا', '', 'ä'],
'b' => ['б', 'β', 'ب', '', '', ''],
'c' => ['ç', 'ć', 'č', 'ĉ', 'ċ', ''],
'd' => ['ď', 'ð', 'đ', 'ƌ', 'ȡ', 'ɖ', 'ɗ', '', '', '', 'д', 'δ', 'د', 'ض', '', '', '', ''],
'e' => ['é', 'è', '', '', '', 'ê', 'ế', '', '', '', '', 'ë', 'ē', 'ę', 'ě', 'ĕ', 'ė', 'ε', 'έ', '', '', '', '', '', '', '', 'έ', 'е', 'ё', 'э', 'є', 'ə', '', '', '', '', '', 'إ', 'ئ', ''],
'f' => ['ф', 'φ', 'ف', 'ƒ', '', ''],
'g' => ['ĝ', 'ğ', 'ġ', 'ģ', 'г', 'ґ', 'γ', '', '', 'گ', ''],
'h' => ['ĥ', 'ħ', 'η', 'ή', 'ح', 'ه', '', '', '', ''],
'i' => ['í', 'ì', '', 'ĩ', '', 'î', 'ï', 'ī', 'ĭ', 'į', 'ı', 'ι', 'ί', 'ϊ', 'ΐ', '', '', '', '', '', '', '', '', '', 'ί', '', '', '', 'ΐ', '', '', 'і', 'ї', 'и', '', '', '', 'ည်', 'ǐ', '', '', 'ی', ''],
'j' => ['ĵ', 'ј', 'Ј', '', 'ج', ''],
'k' => ['ķ', 'ĸ', 'к', 'κ', 'Ķ', 'ق', 'ك', 'က', '', '', 'ک', ''],
'l' => ['ł', 'ľ', 'ĺ', 'ļ', 'ŀ', 'л', 'λ', 'ل', '', '', ''],
'm' => ['м', 'μ', 'م', '', '', ''],
'n' => ['ñ', 'ń', 'ň', 'ņ', 'ʼn', 'ŋ', 'ν', 'н', 'ن', '', '', ''],
'o' => ['ó', 'ò', '', 'õ', '', 'ô', '', '', '', '', '', 'ơ', '', '', '', '', '', 'ø', 'ō', 'ő', 'ŏ', 'ο', '', '', '', '', '', '', '', 'ό', 'о', 'و', 'θ', 'ို', 'ǒ', 'ǿ', 'º', '', '', '', 'ö'],
'p' => ['п', 'π', '', '', 'پ', ''],
'q' => ['', ''],
'r' => ['ŕ', 'ř', 'ŗ', 'р', 'ρ', 'ر', '', ''],
's' => ['ś', 'š', 'ş', 'с', 'σ', 'ș', 'ς', 'س', 'ص', '', 'ſ', '', ''],
't' => ['ť', 'ţ', 'т', 'τ', 'ț', 'ت', 'ط', '', '', 'ŧ', '', '', ''],
'u' => ['ú', 'ù', '', 'ũ', '', 'ư', '', '', '', '', '', 'û', 'ū', 'ů', 'ű', 'ŭ', 'ų', 'µ', 'у', '', '', '', 'ǔ', 'ǖ', 'ǘ', 'ǚ', 'ǜ', '', '', '', 'ў', 'ü'],
'v' => ['в', '', 'ϐ', ''],
'w' => ['ŵ', 'ω', 'ώ', '', '', ''],
'x' => ['χ', 'ξ', ''],
'y' => ['ý', '', '', '', '', 'ÿ', 'ŷ', 'й', 'ы', 'υ', 'ϋ', 'ύ', 'ΰ', 'ي', '', ''],
'z' => ['ź', 'ž', 'ż', 'з', 'ζ', 'ز', '', '', ''],
'aa' => ['ع', '', 'آ'],
'ae' => ['æ', 'ǽ'],
'ai' => [''],
'ch' => ['ч', '', '', 'چ'],
'dj' => ['ђ', 'đ'],
'dz' => ['џ', ''],
'ei' => [''],
'gh' => ['غ', ''],
'ii' => [''],
'ij' => ['ij'],
'kh' => ['х', 'خ', ''],
'lj' => ['љ'],
'nj' => ['њ'],
'oe' => ['ö', 'œ', 'ؤ'],
'oi' => [''],
'oii' => [''],
'ps' => ['ψ'],
'sh' => ['ш', '', 'ش'],
'shch' => ['щ'],
'ss' => ['ß'],
'sx' => ['ŝ'],
'th' => ['þ', 'ϑ', 'ث', 'ذ', 'ظ'],
'ts' => ['ц', '', ''],
'ue' => ['ü'],
'uu' => [''],
'ya' => ['я'],
'yu' => ['ю'],
'zh' => ['ж', '', 'ژ'],
'(c)' => ['©'],
'A' => ['Á', 'À', '', 'Ã', '', 'Ă', '', '', '', '', '', 'Â', '', '', '', '', '', 'Å', 'Ā', 'Ą', 'Α', 'Ά', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '', '', 'Ά', '', 'А', 'Ǻ', 'Ǎ', '', 'Ä'],
'B' => ['Б', 'Β', '', ''],
'C' => ['Ç', 'Ć', 'Č', 'Ĉ', 'Ċ', ''],
'D' => ['Ď', 'Ð', 'Đ', 'Ɖ', 'Ɗ', 'Ƌ', '', '', 'Д', 'Δ', ''],
'E' => ['É', 'È', '', '', '', 'Ê', '', '', '', '', '', 'Ë', 'Ē', 'Ę', 'Ě', 'Ĕ', 'Ė', 'Ε', 'Έ', '', '', '', '', '', '', 'Έ', '', 'Е', 'Ё', 'Э', 'Є', 'Ə', ''],
'F' => ['Ф', 'Φ', ''],
'G' => ['Ğ', 'Ġ', 'Ģ', 'Г', 'Ґ', 'Γ', ''],
'H' => ['Η', 'Ή', 'Ħ', ''],
'I' => ['Í', 'Ì', '', 'Ĩ', '', 'Î', 'Ï', 'Ī', 'Ĭ', 'Į', 'İ', 'Ι', 'Ί', 'Ϊ', '', '', '', '', '', '', 'Ἷ', '', '', '', 'Ί', 'И', 'І', 'Ї', 'Ǐ', 'ϒ', ''],
'J' => [''],
'K' => ['К', 'Κ', ''],
'L' => ['Ĺ', 'Ł', 'Л', 'Λ', 'Ļ', 'Ľ', 'Ŀ', '', ''],
'M' => ['М', 'Μ', ''],
'N' => ['Ń', 'Ñ', 'Ň', 'Ņ', 'Ŋ', 'Н', 'Ν', ''],
'O' => ['Ó', 'Ò', '', 'Õ', '', 'Ô', '', '', '', '', '', 'Ơ', '', '', '', '', '', 'Ø', 'Ō', 'Ő', 'Ŏ', 'Ο', 'Ό', '', '', '', '', '', '', '', 'Ό', 'О', 'Θ', 'Ө', 'Ǒ', 'Ǿ', '', 'Ö'],
'P' => ['П', 'Π', ''],
'Q' => [''],
'R' => ['Ř', 'Ŕ', 'Р', 'Ρ', 'Ŗ', ''],
'S' => ['Ş', 'Ŝ', 'Ș', 'Š', 'Ś', 'С', 'Σ', ''],
'T' => ['Ť', 'Ţ', 'Ŧ', 'Ț', 'Т', 'Τ', ''],
'U' => ['Ú', 'Ù', '', 'Ũ', '', 'Ư', '', '', '', '', '', 'Û', 'Ū', 'Ů', 'Ű', 'Ŭ', 'Ų', 'У', 'Ǔ', 'Ǖ', 'Ǘ', 'Ǚ', 'Ǜ', '', 'Ў', 'Ü'],
'V' => ['В', ''],
'W' => ['Ω', 'Ώ', 'Ŵ', ''],
'X' => ['Χ', 'Ξ', ''],
'Y' => ['Ý', '', '', '', '', 'Ÿ', '', '', '', 'Ύ', 'Ы', 'Й', 'Υ', 'Ϋ', 'Ŷ', ''],
'Z' => ['Ź', 'Ž', 'Ż', 'З', 'Ζ', ''],
'AE' => ['Æ', 'Ǽ'],
'Ch' => ['Ч'],
'Dj' => ['Ђ'],
'Dz' => ['Џ'],
'Gx' => ['Ĝ'],
'Hx' => ['Ĥ'],
'Ij' => ['IJ'],
'Jx' => ['Ĵ'],
'Kh' => ['Х'],
'Lj' => ['Љ'],
'Nj' => ['Њ'],
'Oe' => ['Œ'],
'Ps' => ['Ψ'],
'Sh' => ['Ш'],
'Shch' => ['Щ'],
'Ss' => [''],
'Th' => ['Þ'],
'Ts' => ['Ц'],
'Ya' => ['Я'],
'Yu' => ['Ю'],
'Zh' => ['Ж'],
' ' => ["\xC2\xA0", "\xE2\x80\x80", "\xE2\x80\x81", "\xE2\x80\x82", "\xE2\x80\x83", "\xE2\x80\x84", "\xE2\x80\x85", "\xE2\x80\x86", "\xE2\x80\x87", "\xE2\x80\x88", "\xE2\x80\x89", "\xE2\x80\x8A", "\xE2\x80\xAF", "\xE2\x81\x9F", "\xE3\x80\x80", "\xEF\xBE\xA0"],
];
}
}
@aheinze
Copy link

aheinze commented Feb 14, 2018

instead of Str::slug($entry['name']) you can also use the built-in sluggify helper function e.g $app->helper('utils')->sluggify($entry['name'])

@aheinze
Copy link

aheinze commented Feb 14, 2018

also instead of count($app->module('collections')->find(...))
you can also use $app->module('collections')->count('aktuelles', ['slug' => $slug])

@gabrielnvg
Copy link

Changes with @aheinze suggestions:

(Just change the "XXX" occurrences with your collection name and "YYY" occurrences with the entry you want your slug to be based on)

<?php

// this is in the `/config` folder

// collection: XXX
// slug is created bt reading this field: YYY

$app->on("collections.save.before.XXX", function($YYY, &$entry, $isUpdate) use ($app) {

    // generate slug on create only or when an existing one is empty
    if (!$isUpdate || ($isUpdate && trim($entry['slug']) == '')) {
        // generate slug based on defined entry
        $slug = $app->helper('utils')->sluggify($entry['YYY']);

        // count existing entires in collection with given $slug
        $entries = $app->module('collections')->count('XXX', ['slug' => $slug]);

        // if slug is existing already, postfix with incremental count
        if ($entries > 0) {
            $slug = "{$slug}-{$entries}";
        }
        $entry['slug'] = $slug;
    }
});

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment