Variables, constants and translations

[NKL-aatu]

Hi.

Developing a template. Just a few quick questions:

1. In the default template there are variables like $isCpct, $isDark and $isPage and constants like $SYNTAXHIGHLIGHTING and $MARKDOWN. Have I understood correctly that those variables are used to refer browser/UA settings and constants are used to refer current PrivateBin installation settings in the configuration file?
2. What are $isCpct, $isDark and $isPage variables? My guess is $isCpct refers to mobile view and $isDark should read UA's darkmode setting (but doesn't work at least on my phone)... I haven't been able to find an instance where $isPage condition gets triggered.
3. Are current paste's settings and content all fetched with JavaScript? So no PHP variable or constant in the template file holds this data?
4. Does PrivateBin currently support adding organization specific translations to UI texts? At the moment I'm using a less pretty workaround: an extra find and replace function that's always called before actual translation functions.

[elrido]

1. In the default template there are variables like $isCpct, $isDark and $isPage and constants like $SYNTAXHIGHLIGHTING and $MARKDOWN. Have I understood correctly that those variables are used to refer browser/UA settings and constants are used to refer current PrivateBin installation settings in the configuration file?
2. What are $isCpct, $isDark and $isPage variables? My guess is $isCpct refers to mobile view and $isDark should read UA's darkmode setting (but doesn't work at least on my phone)... I haven't been able to find an instance where $isPage condition gets triggered.

The camelCased ones are specific to the bootstrap templates and is how the single file re-arranges it's content to render the 5 different variants of the bootstrap and bootstrap-* templates, as depicted on our screenshots page. They are calculated at the top of that template file and are based on the template configuration setting, not dynamic based on user agent:

PrivateBin/tpl/bootstrap.php

Lines 3 to 5 in 910675c

	$isCpct = substr($template, 9, 8) === '-compact';
	$isDark = substr($template, 9, 5) === '-dark';
	$isPage = substr($template, -5) === '-page';

The ALLCAPS ones are assigned to the View and present in all templates. They represent configuration values, or are based on dynamic properties of the server or client, etc.

PrivateBin/lib/Controller.php

Lines 383 to 417 in 910675c

	$page = new View;
	$page->assign('CSPHEADER', $metacspheader);
	$page->assign('ERROR', I18n::_($this->_error));
	$page->assign('NAME', $this->_conf->getKey('name'));
	if ($this->_request->getOperation() === 'yourlsproxy') {
	$page->assign('SHORTURL', $this->_status);
	$page->draw('yourlsproxy');
	return;
	}
	$page->assign('BASEPATH', I18n::_($this->_conf->getKey('basepath')));
	$page->assign('STATUS', I18n::_($this->_status));
	$page->assign('VERSION', self::VERSION);
	$page->assign('DISCUSSION', $this->_conf->getKey('discussion'));
	$page->assign('OPENDISCUSSION', $this->_conf->getKey('opendiscussion'));
	$page->assign('MARKDOWN', array_key_exists('markdown', $formatters));
	$page->assign('SYNTAXHIGHLIGHTING', array_key_exists('syntaxhighlighting', $formatters));
	$page->assign('SYNTAXHIGHLIGHTINGTHEME', $this->_conf->getKey('syntaxhighlightingtheme'));
	$page->assign('FORMATTER', $formatters);
	$page->assign('FORMATTERDEFAULT', $this->_conf->getKey('defaultformatter'));
	$page->assign('INFO', I18n::_(str_replace("'", '"', $this->_conf->getKey('info'))));
	$page->assign('NOTICE', I18n::_($this->_conf->getKey('notice')));
	$page->assign('BURNAFTERREADINGSELECTED', $this->_conf->getKey('burnafterreadingselected'));
	$page->assign('PASSWORD', $this->_conf->getKey('password'));
	$page->assign('FILEUPLOAD', $this->_conf->getKey('fileupload'));
	$page->assign('ZEROBINCOMPATIBILITY', $this->_conf->getKey('zerobincompatibility'));
	$page->assign('LANGUAGESELECTION', $languageselection);
	$page->assign('LANGUAGES', I18n::getLanguageLabels(I18n::getAvailableLanguages()));
	$page->assign('EXPIRE', $expire);
	$page->assign('EXPIREDEFAULT', $this->_conf->getKey('default', 'expire'));
	$page->assign('URLSHORTENER', $this->_conf->getKey('urlshortener'));
	$page->assign('QRCODE', $this->_conf->getKey('qrcode'));
	$page->assign('HTTPWARNING', $this->_conf->getKey('httpwarning'));
	$page->assign('HTTPSLINK', 'https://' . $this->_request->getHost() . $this->_request->getRequestUri());
	$page->assign('COMPRESSION', $this->_conf->getKey('compression'));
	$page->draw($this->_conf->getKey('template'));

3. Are current paste's settings and content all fetched with JavaScript? So no PHP variable or constant in the template file holds this data?

The paste's and comment's settings are all fetched from the API. There are some server settings that get injected into data-attributes, if present, i.e.:

PrivateBin/tpl/bootstrap.php

Line 525 in 910675c

<button id="shortenbutton" data-shortener="<?php echo I18n::encode($URLSHORTENER); ?>" type="button" class="btn btn-<?php echo $isDark ? 'warning' : 'primary'; ?> btn-block">

The JS client enables or disables bits parts of the static HTML as needed, if present. For a custom template, the HTML structure is pretty flexible, just the key id-attributes have to exist and relevant HTML elements within them, e.g. a textarea with id "message":

PrivateBin/tpl/bootstrap.php

Line 564 in 910675c

<p class="col-md-12"><textarea id="message" name="message" cols="80" rows="25" class="form-control hidden"></textarea></p>

4. Does PrivateBin currently support adding organization specific translations to UI texts? At the moment I'm using a less pretty workaround: an extra find and replace function that's always called before actual translation functions.

Right now only the name option can be used to replace the "PrivateBin" labels in the translations. For any other adjustments you would have to change the relevant messages in all the translation files. During upgrades you would then have to add any newly translated strings on the bottom of your modified translation files - we append new messages there to make it easy to spot new and untranslated messages for the translaters (less relevant now that most of them use the Crowdin UI, where the untranslated messages are automatically flagged).

And of course you can add other, untranslated messages in any place of your new template - many instance operators change the footer text blurb, for example.

[NKL-aatu]

Thank you so much! I would have never guessed :D

So now I know that if I want to set a single layout for my site, I can propably remove most of the $isPage and $isCpct conditions.