website·Indexed 30 days ago
https://friendsofredaxo.github.io/tricks/A collection of technical guides, snippets, and custom tools for the REDAXO CMS. Includes implementation details for AddOns such as FOR calendar, MForm, and Consent Manager, as well as tutorials on YForm, accessibility (a11y), and development workflows using GitHub and PLESK.
YDeploy is an addon based on Deployer used to synchronize data from a local development system to a live system (or staging/other developers).
What is synchronized:
rex_media_manager or rex_redactor_profile).What is NOT synchronized:
media folder.X-Powered-By header can leak sensitive version information about PHP, Apache, or nginx. This should be disabled via server configuration.Header unset X-Powered-ByThis utility allows developers to browse and search for icons provided by the be_style addon (including FontAwesome, Glyphicons, and .rex-icon). It parses style.css to generate a visual gallery where users can filter by icon group, search by name, and double-click an icon name to copy its HTML tag to the clipboard.
Important Caveat: Since the transition to FontAwesome 6, this method has very limited functionality because icon information is now distributed across multiple files. A revised version is not currently planned.
// Save this script as «domain»/redaxo/src/addons/project/pages/icons.php
// (Create the 'pages' folder if it does not exist)
$types = ['FontAwesome'=>'fa','Glyphicons'=>'glyphicon','REX'=>'rex-icon'];
$filename = $this->getCachePath('icons.html');
$stylename = rex_path::addonAssets('be_style','css/styles.css');
if( !is_readable($stylename) ) return;
$html = false;
if( is_readable($filename) && filemtime($filename) < filemtime($stylename) ){
$html = @file_get_contents($filename);
}
$html = false;
if( !$html ) {
// Extract icons from be_style CSS
$css = file_get_contents( $stylename );
$typeset = implode('|',$types);
$p = preg_match_all(
'/((\.('.$typeset.')\-[a-z0-9_-]+)((\:before,\.('.$typeset.')\-[a-z0-9_-]+))*)\:before{content:"(?<marker>(.*?))"}/m',
$css,
$match,
);
$icons = [];
foreach( $match['marker'] as $k=>$code ) {
$code = sprintf("\\%04X",mb_ord($code));
$unicode = $result[$code] ?? [];
preg_match_all( '/(?<class>\.(?<type>('.$typeset.'))-(?<name>[a-z0-9_-]+))/',$match[1][$k],$data );
foreach( $data['class'] as $i => $class ){
$type = $data['type'][$i];
$name = $data['name'][$i];
$unicode['class'][$class] = $class;
$unicode['name'][$name] = $name;
$unicode['type'][$type] = 'x-'.$type;
if( !isset($unicode['html']) ) $unicode['html'] = "<i class=\"$type $type-$name\"></i>";
}
$icons[$code] = $unicode;
}
unset( $match );
ksort($icons);
// Build UI using rex_fragment
$umfang = new rex_fragment();
$elements = [];
foreach( $types as $k=>$v ) {
$elements[] = [
'label' => '<label class="control-label">' . $k . '</label>',
'field' => '<input onchange="f_select(this);" type="checkbox" id="scope-' . $v . '" value="x-' . $v . '" checked />',
];
}
$umfang->setVar('elements', $elements, false);
$umfang->setVar('grouped', true);
$umfang->setVar('inline', true);
$search = new rex_fragment();
$elements = [
'field' => '<input oninput="f_search(this.value)" type="text" class="form-control" placeholder="Search for..." id="search">',
'right' => '<button onclick="f_reset()"class="btn btn-default" type="button"><i class="fa fa-close"></i></button>',
];
$search->setVar('elements', [$elements], false);
$row1 = new rex_fragment();
$row1->setVar('content', [$umfang->parse('core/form/checkbox.php'),$search->parse('core/form/input_group.php')], false);
$row2 = new rex_fragment();
$row2->setVar('content', array_map(function($v){return "<i class=\"$v $v-«name»\"></i>";},$types), false);
$section = new rex_fragment();
$content = '<div ondblclick="f_copy(event)" class="'.implode(' ',array_map(function($v){return "x-$v";},$types)).'" id="iconlist">';
foreach( $icons as $k=>$v ) {
$type = implode(' ',$v['type']);
$name = implode(',',$v['name']);
$class = implode('</span><br><span>',$v['class']);
$content .= "<div class=\"panel panel-default $type\" data-search=\"$name\"><div class=\"panel-heading\"><small>$k</small>{$v['html']}</div><div class=\"panel-body\"><span>$class</span></div></div>";
}
$content .= '</div>';
$section->setVar('heading', $row1->parse('core/page/grid.php').$row2->parse('core/page/grid.php'), false);
$section->setVar('body',$content,false);
$html = $section->parse('core/page/section.php');
rex_dir::create($this->getCachePath());
file_put_contents($filename, $html);
}
echo $html;
?>
<style>
#iconlist { display: flex; flex-wrap: wrap; justify-content: center;}
#iconlist .panel { display: none; margin: 1em; width: 14em; font-size: 1em; }
#iconlist .panel-heading { font-size: 2rem; text-align: center; position: relative; }
#iconlist .panel-body { padding: 0.1rem 0.2rem; }
#iconlist small { padding: 0.1rem; position: absolute; top:0; left:0; font-size: 1rem; }
<?= implode(',',array_map(function($v){return "#iconlist.x-$v .panel.x-$v";},$types)) ?> { display: block; }
</style>
<script>
var iconlist = document.getElementById('iconlist');
var search = document.getElementById('search');
var typeList = ['<?= implode('\',\',$types) ?>'];
function f_select( node ) { iconlist.classList.toggle(node.value,node.checked); }
function f_reset() { search.value = ''; f_search( search.value ); }
function f_search( pattern ) {
if( pattern ) {
for( var node of iconlist.children ) {
var hidden = !node.dataset.search.includes(pattern.toLowerCase());
if( node.classList.contains('hidden') != hidden ) node.classList.toggle('hidden',hidden);
}
return;
}
for( var node of iconlist.children ) { if( node.classList.contains('hidden') ) node.classList.remove('hidden'); }
}
function f_copy( event ) {
var target = event.target;
if( target.tagName.toLowerCase() != 'span' ) return;
for( var type of typeList ) {
if( target.innerText.startsWith('.'+type) ) {
var node = document.createElement('textarea');
node.value = '<i class="'+type+' '+target.innerText+'"></i>';
node.style = {position: 'absolute', left: '-9999px'};
document.body.appendChild(node);
node.select();
document.execCommand('copy');
alert('HTML for "'+target.innerText+'" copied to clipboard');
document.body.removeChild(node);
event.preventDefault();
return;
}
}
}
</script>setColumnFormat with a 'custom' callback. This allows combining the current column value with values from other columns in the same row.if (rex::isBackend()) {
rex_extension::register('YFORM_DATA_LIST', function( $ep ) {
if ($ep->getParam('table')->getTableName() == "gewuenschte_tabelle") {
$list = $ep->getSubject();
$list->setColumnFormat(
'title', // Column to target
'custom', // Keyword for custom function
function($a) {
// $a['value'] is the current column value
// $a['list']->getValue('xyz') gets value of another column
return $a['value'] . " " . $a['list']->getValue('xyz');
}
);
}
});
}<footer
<a href="/barrierefreiheitserklaerung">Barrierefreiheitserklärung</a>
<a href="/feedback">Feedback zur Barrierefreiheit geben</a>
</footer>To maintain a clean multi-domain architecture in REDAXO, use root categories for each domain. Follow these structural guidelines:
send object parameter and the absence of warning after calling getForm().$yform = new rex_yform();
// Must call getForm() first
echo $yform->getForm();
if ($yform->getObjectparams('send') && !$yform->getObjectparams('warning')) {
// Access the value pool of the created record
dump($yform->getObjectparams('value_pool'));
}To integrate the icon overview script into a service addon (e.g., a 'project' addon), follow these steps:
icons.php file in «domain»/redaxo/src/addons/project/pages/icons.php.index.php in the pages directory includes the current page subpath.package.yml to make it visible in the backend menu.// In «domain»/redaxo/src/addons/project/pages/index.php
<?php
echo rex_view::title('AddOn: project');
rex_be_controller::includeCurrentPageSubPath();
?># In package.yml
page:
title: 'Projekt-Addon'
perm: project[]
subpages:
icons:
title: 'Icons'
icon: fa fa-table<h1> through <h6> in a strict logical order to define the information architecture of the page. Avoid skipping levels to ensure screen reader users can understand the relationship between sections.<h1>Page Main Title</h1>
<h2>Section Subtitle</h2>
<h3>Subsection Title</h3>rex_fragment, and parse a PHP template file (e.g., located at theme/private/fragments/forcal_terminliste.php).// In the module
$my_forcal = new my_forcal();
$res = $my_forcal->get_entries();
$fragment = new rex_fragment();
$fragment->setVar('termine', $res);
echo $fragment->parse('forcal_terminliste.php');<!-- In theme/private/fragments/forcal_terminliste.php -->
<ul>
<?php foreach ($this->termine as $i => $item) : ?>
<li>
<a href="event-detail.html">
<div class="event__date"><?= $item->get_formatted_date_and_time() ?></div>
<div class="event__category"><?= $item->sec_name ?></div>
<div class="event__title" style="color: <?= $item->color ?>"><?= $item->{'name_'.rex_clang::getCurrentId()} ?></div>
<div class="event__subtitle"><?= $item->get_val('subtitle') ?></div>
<div class="event__description"><?= $item->get_val('subline') ?></div>
</a>
<?= $item->get_val('description') ?>
<dl class="uk-description-list">
<?php if ($item->get_val('info_meetingpoint')) : ?>
<dt></dt><dd><?= $item->get_val('info_meetingpoint') ?></dd>
<?php endif ?>
<!-- Repeat for info_duration, info_price, info_registration, info_contact -->
<?php if ($item->get_val('info_1_value')) : ?>
<dt><?= $item->get_val('info_1_label') ?></dt>
<dd><?= $item->get_val('info_1_value') ?></dd>
<?php endif ?>
</dl>
<img src="/images/content/<?= $item->get_img() ?>" alt="">
</li>
<?php endforeach ?>
</ul>pages/yform.php) that includes the YForm data_edit.php page. This allows you to define YForm management pages within your addon's package.yml and control visibility and styling via configuration properties.<?php
/**
* Wrapper to call YForm Table Manager pages as native addon pages.
* Save this file as pages/yform.php in your addon.
*/
$yform = $this->getProperty('yform', []);
$yform = $yform[rex_be_controller::getCurrentPage()] ?? [];
if (isset($yform['table_name'])) {
$table_name = $yform['table_name'];
if (is_subclass_of($table_name, rex_yform_manager_dataset::class)) {
$table_name = $table_name::table()->getTableName();
} elseif (!str_starts_with($table_name, rex::getTablePrefix())) {
$table_name = rex::getTable($table_name);
}
} else {
$table_name = '';
}
$table_name = rex_request('table_name', 'string', $table_name);
$show_title = true === ($yform['show_title'] ?? false);
$wrapper_class = $yform['wrapper_class'] ?? '';
if ('' !== $table_name) {
$_REQUEST['table_name'] = $table_name;
}
if (!$show_title) {
rex_extension::register(
'YFORM_MANAGER_DATA_PAGE_HEADER',
static function (rex_extension_point $ep) {
if ($ep->getParam('yform')->table->getTableName() === $ep->getParam('table_name')) {
return '';
}
},
rex_extension::EARLY, ['table_name' => $table_name],
);
}
if ('' !== $wrapper_class) {
echo '<div class="',$wrapper_class,'">';
}
if (is_file(rex_path::addon('yform', 'pages/manager.data_edit.php'))) {
include rex_path::addon('yform', 'pages/manager.data_edit.php'); // YForm 5
} else {
include rex_path::plugin('yform', 'manager', 'pages/data_edit.php'); // YForm 4
}
if ('' !== $wrapper_class) {
echo '</div>';
}