CINXE.COM

<!DOCTYPE html> <html lang="en" dir="ltr" class="no-js"> <head> <meta charset="utf-8" /> <title>plugin:settingstree [DokuWiki]</title> <meta name="generator" content="DokuWiki"/> <meta name="theme-color" content="#008800"/> <meta name="robots" content="index,follow"/> <meta name="keywords" content="plugin,settingstree"/> <link rel="search" type="application/opensearchdescription+xml" href="/lib/exe/opensearch.php" title="DokuWiki"/> <link rel="start" href="/"/> <link rel="contents" href="/plugin:settingstree?do=index" title="Sitemap"/> <link rel="manifest" href="/lib/exe/manifest.php"/> <link rel="alternate" type="application/rss+xml" title="Recent Changes" href="/feed.php"/> <link rel="alternate" type="application/rss+xml" title="Current namespace" href="/feed.php?mode=list&ns=plugin"/> <link rel="edit" title="Edit this page" href="/plugin:settingstree?do=edit"/> <link rel="alternate" type="text/html" title="Plain HTML" href="/_export/xhtml/plugin:settingstree"/> <link rel="alternate" type="text/plain" title="Wiki Markup" href="/_export/raw/plugin:settingstree"/> <link rel="canonical" href="https://www.dokuwiki.org/plugin:settingstree"/> <link rel="stylesheet" href="/lib/exe/css.php?t=dokuwiki&tseed=f1005bad3d81fc9c803c7f93d32a390e"/> <script >var NS='plugin';var JSINFO = {"plugins":{"edittable":{"default columnwidth":""}},"id":"plugin:settingstree","namespace":"plugin","ACT":"show","useHeadingNavigation":0,"useHeadingContent":0};(function(H){H.className=H.className.replace(/\bno-js\b/,'js')})(document.documentElement);</script> <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.6.4/jquery.min.js" defer="defer"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/jqueryui/1.13.2/jquery-ui.min.js" defer="defer"></script> <script src="/lib/exe/js.php?t=dokuwiki&tseed=f1005bad3d81fc9c803c7f93d32a390e&lang=en" defer="defer"></script> <meta name="viewport" content="width=device-width,initial-scale=1" /> <link rel="shortcut icon" href="/lib/tpl/dokuwiki/images/favicon.ico" /> <link rel="apple-touch-icon" href="/lib/tpl/dokuwiki/images/apple-touch-icon.png" /> <meta name="verify-v1" content="OVxl3gsCv2MhZqh1cBQyl0JytWXSwXMjyvwc+4w3WtA=" /> <meta name="google-site-verification" content="YhTVK69hW94ZXUtc2zSLPxTkZKbZIn0zK67mz5WQB-E" />  <script async src="https://www.googletagmanager.com/gtag/js?id=UA-83791-1"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-83791-1', { 'anonymize_ip': true }); </script> </head> <body> <div id="dokuwiki__site"><div id="dokuwiki__top" class="site dokuwiki mode_show tpl_dokuwiki showSidebar hasSidebar">  <header id="dokuwiki__header"><div class="pad group"> <div class="headings group"> <ul class="a11y skip"> <li><a href="#dokuwiki__content">skip to content</a></li> </ul> <h1 class="logo"><a href="/start" accesskey="h" title="Home [h]"><img src="/lib/tpl/dokuwiki/images/logo.png" width="64" height="64" alt="" /><span>DokuWiki</span></a></h1> <p class="claim">It's better when it's simple</p> </div> <div class="tools group">  <div id="dokuwiki__usertools"> <h3 class="a11y">User Tools</h3> <ul> <li class="action login"><a href="/plugin:settingstree?do=login&sectok=" title="Log In" rel="nofollow"><span>Log In</span><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path d="M10 17.25V14H3v-4h7V6.75L15.25 12 10 17.25M8 2h9a2 2 0 0 1 2 2v16a2 2 0 0 1-2 2H8a2 2 0 0 1-2-2v-4h2v4h9V4H8v4H6V4a2 2 0 0 1 2-2z"/></svg></a></li> </ul> </div>  <div id="dokuwiki__sitetools"> <h3 class="a11y">Site Tools</h3> <form action="/start" method="get" role="search" class="search doku_form" id="dw__search" accept-charset="utf-8"><input type="hidden" name="do" value="search" /><input type="hidden" name="id" value="plugin:settingstree" /><div class="no"><input name="q" type="text" class="edit" title="[F]" accesskey="f" placeholder="Search" autocomplete="on" id="qsearch__in" value="" /><button value="1" type="submit" title="Search">Search</button><div id="qsearch__out" class="ajax_qsearch JSpopup"></div></div></form> <div class="mobileTools"> <form action="/doku.php" method="get" accept-charset="utf-8"><div class="no"><input type="hidden" name="id" value="plugin:settingstree" /><select name="do" class="edit quickselect" title="Tools"><option value="">Tools</option><optgroup label="Page Tools"><option value="edit">Edit this page</option><option value="revisions">Old revisions</option><option value="backlink">Backlinks</option></optgroup><optgroup label="Site Tools"><option value="recent">Recent Changes</option><option value="media">Media Manager</option><option value="index">Sitemap</option></optgroup><optgroup label="User Tools"><option value="login">Log In</option></optgroup></select><button type="submit">></button></div></form> </div> <ul> <li class="action recent"><a href="/plugin:settingstree?do=recent" title="Recent Changes [r]" rel="nofollow" accesskey="r">Recent Changes</a></li><li class="action media"><a href="/plugin:settingstree?do=media&ns=plugin" title="Media Manager" rel="nofollow">Media Manager</a></li><li class="action index"><a href="/plugin:settingstree?do=index" title="Sitemap [x]" rel="nofollow" accesskey="x">Sitemap</a></li> </ul> </div> </div>  <div class="breadcrumbs"> <div class="trace"><span class="bchead">Trace:</span> <span class="bcsep">•</span> <span class="curid"><bdi><a href="/plugin:settingstree" class="breadcrumbs" title="plugin:settingstree">settingstree</a></bdi></span></div> </div> <hr class="a11y" /> </div></header> <div class="wrapper group">  <nav id="dokuwiki__aside" aria-label="Sidebar"><div class="pad aside include group"> <h3 class="toggle">Sidebar</h3> <div class="content"><div class="group"> <p> <strong>Learn about DokuWiki</strong> </p> <ul> <li class="level1"><div class="li"> <a href="/features" class="wikilink1" title="features" data-wiki-id="features">Features</a> & <a href="/blogroll" class="wikilink1" title="blogroll" data-wiki-id="blogroll">reviews</a> </div> </li> <li class="level1"><div class="li"> <a href="/install" class="wikilink1" title="install" data-wiki-id="install">Installation guide</a></div> </li> <li class="level1"><div class="li"> <a href="/manual" class="wikilink1" title="manual" data-wiki-id="manual">User manual</a> & <a href="/wiki:syntax" class="wikilink1" title="wiki:syntax" data-wiki-id="wiki:syntax">syntax</a></div> </li> <li class="level1"><div class="li"> <a href="/changes" class="wikilink1" title="changes" data-wiki-id="changes">Release notes</a></div> </li> <li class="level1"><div class="li"> <a href="/faq" class="wikilink1" title="faq" data-wiki-id="faq">FAQ</a></div> </li> </ul> <p> <strong>Advanced Use</strong> </p> <ul> <li class="level1"><div class="li"> <a href="/extensions" class="wikilink1" title="extensions" data-wiki-id="extensions">Extensions</a></div> </li> <li class="level1"><div class="li"> <a href="/development" class="wikilink1" title="development" data-wiki-id="development">Development manual</a></div> </li> </ul> <p> <strong>Corporate Use</strong> </p> <ul> <li class="level1"><div class="li"> <a href="/faq:support" class="wikilink1" title="faq:support" data-wiki-id="faq:support">Get support</a></div> </li> <li class="level1"><div class="li"> <a href="/donate" class="wikilink1" title="donate" data-wiki-id="donate">Donations</a></div> </li> </ul> <p> <strong>Our Community</strong> </p> <ul> <li class="level1"><div class="li"> <a href="/teams:getting_involved" class="wikilink1" title="teams:getting_involved" data-wiki-id="teams:getting_involved">Get involved</a></div> </li> <li class="level1"><div class="li"> <a href="/dokuinstall" class="wikilink1" title="dokuinstall" data-wiki-id="dokuinstall">Users</a></div> </li> <li class="level1"><div class="li"> <a href="http://forum.dokuwiki.org" class="urlextern" title="http://forum.dokuwiki.org">User forum</a></div> </li> <li class="level1"><div class="li"> <a href="/mailinglist" class="wikilink1" title="mailinglist" data-wiki-id="mailinglist">Development mailinglist</a></div> </li> </ul> <hr /> <p> Follow us on <a href="https://phpc.social/@dokuwiki" class="urlextern" title="https://phpc.social/@dokuwiki">Mastodon</a> and other <a href="/social" class="wikilink1" title="social" data-wiki-id="social">social networks</a>. </p> <p> <a href="/privacy" class="wikilink1" title="privacy" data-wiki-id="privacy">Our Privacy Policy</a> </p> </div></div> </div></nav>  <main id="dokuwiki__content"><div class="pad group"> <div class="pageId"><span>plugin:settingstree</span></div> <div class="page group">   <div id="dw__toc" class="dw__toc"> <h3 class="toggle">Table of Contents</h3> <div> <ul class="toc"> <li class="level1"><div class="li"><a href="#settingstree_plugin">settingstree Plugin</a></div> <ul class="toc"> <li class="level2"><div class="li"><a href="#installation">Installation</a></div></li> <li class="level2"><div class="li"><a href="#overview">Overview</a></div></li> <li class="level2"><div class="li"><a href="#embed">Embed</a></div></li> <li class="level2"><div class="li"><a href="#configuration_and_settings">Configuration and Settings</a></div></li> <li class="level2"><div class="li"><a href="#development">Development</a></div></li> <li class="level2"><div class="li"><a href="#discussion">Discussion</a></div></li> </ul></li> </ul> </div> </div>  <h1 class="sectionedit1" id="settingstree_plugin">settingstree Plugin</h1> <div class="level1"> <div class="pluginrepo_entry"><div class="usageInfo"><div class="compatibility"><p class="label">Compatible with DokuWiki</p><p>Hrun</p></div><ul class="actions"><li><a class="download" href="https://github.com/fajan/settingstree/archive/master.zip">Download</a></li><li><a class="bugs" href="https://github.com/fajan/settingstree/issues">Report bugs</a></li></ul><div class="clearer"></div></div><div class="mainInfo"><p class="description"><a class="media" href="/plugins"><img alt="plugin" class="medialeft" src="/lib/plugins/pluginrepo/images/dwplugin.png" width="60" height="60" /></a> DokuWiki helper and admin for setting up settings based on NS/page hierarchy to a plugin</p><a href="/lib/exe/fetch.php?tok=ddeebc&media=https%3A%2F%2Fraw.githubusercontent.com%2Ffajan%2Fsettingstree%2Fmaster%2Fexample-screenshot.png" class="media screenshot" title="Screenshot of settingstree" rel="lightbox" data-url="/lib/exe/fetch.php?tok=ddeebc&media=https%3A%2F%2Fraw.githubusercontent.com%2Ffajan%2Fsettingstree%2Fmaster%2Fexample-screenshot.png"><img src="/lib/exe/fetch.php?w=220&tok=85aed1&media=https%3A%2F%2Fraw.githubusercontent.com%2Ffajan%2Fsettingstree%2Fmaster%2Fexample-screenshot.png" alt="" width="220" /></a></div><div class="metaInfo"><dl><dt>Last updated on</dt><dd>2015-08-10</dd><dt>Provides</dt><dd><a href="/plugins?plugintype=16#extension__table" class="wikilink1" title="List all Helper plugins">Helper</a></dd><dt>Repository</dt><dd><a class="urlextern" href="https://github.com/fajan/settingstree">Source</a></dd><dt>Requires</dt><dd><a href="/plugin:config" class="wikilink1" title="plugin:config" data-wiki-id="plugin:config">config</a>, <a href="/plugin:explorertree" class="wikilink1" title="plugin:explorertree" data-wiki-id="plugin:explorertree">explorertree</a>, <a href="/plugin:memcache" class="wikilink1" title="plugin:memcache" data-wiki-id="plugin:memcache">memcache</a></dd></dl></div><div class="moreInfo"><div class="notify"><p>This extension has not been updated in over 2 years. It may no longer be maintained or supported and may have compatibility issues.</p></div><p class="similar">Similar to <a href="/plugin:acl" class="wikilink1" title="plugin:acl" data-wiki-id="plugin:acl">acl</a>, <a href="/plugin:config" class="wikilink1" title="plugin:config" data-wiki-id="plugin:config">config</a></p><p class="tags">Tagged with <a href="/plugins?plugintag=admin#extension__table" class="wikilink1" title="List all plugins with this tag">admin</a>, <a href="/plugins?plugintag=config#extension__table" class="wikilink1" title="List all plugins with this tag">config</a>, <a href="/plugins?plugintag=embed#extension__table" class="wikilink1" title="List all plugins with this tag">embed</a>, <a href="/plugins?plugintag=hierarchy#extension__table" class="wikilink1" title="List all plugins with this tag">hierarchy</a>, <a href="/plugins?plugintag=settings#extension__table" class="wikilink1" title="List all plugins with this tag">settings</a></p></div><div class="authorInfo"><strong>By <a href="mailto:jan%20%5Bat%5D%20fjan%20%5Bdot%5D%20eu" class="mail" title="jan [at] fjan [dot] eu">János Fekete</a></strong><ul><li><a href="/plugin:memcache" class="wikilink1" title="plugin:memcache" data-wiki-id="plugin:memcache">memcache</a></li> <li><a href="/plugin:explorertree" class="wikilink1" title="plugin:explorertree" data-wiki-id="plugin:explorertree">explorertree</a></li> </ul></div></div> <p> <strong>This plugin is currently in RC!</strong> Current version is in testing, with a few limitations (only the common settings types are tested/implemented, no special cases yet). Stable version should be out after some more testing. </p> </div> <div class="secedit editbutton_section editbutton_1"><form class="button btn_secedit" method="post" action="/plugin:settingstree"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1659132629" /><input type="hidden" name="summary" value="[settingstree Plugin] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="settingstree_plugin" /><input type="hidden" name="codeblockOffset" value="0" /><input type="hidden" name="range" value="1-934" /><button type="submit" title="settingstree Plugin">Edit</button></div></form></div> <h2 class="sectionedit2" id="installation">Installation</h2> <div class="level2"> <p> The plugin depends on <a href="/plugin:explorertree" class="wikilink1" title="plugin:explorertree" data-wiki-id="plugin:explorertree">explorertree</a> and <a href="/plugin:config" class="wikilink1" title="plugin:config" data-wiki-id="plugin:config">config</a>. It also uses <a href="/plugin:memcache" class="wikilink1" title="plugin:memcache" data-wiki-id="plugin:memcache">memcache</a> if installed. </p> <p> This plugin <strong>requires</strong> a html5 browser to work! If you need to use the admin pages via commandline- or pre-html5 browsers (e.g. lynx or ie7), do not use plugins which depends on this one. </p> <p> Search and install the plugin using the <a href="/plugin:extension" class="wikilink1" title="plugin:extension" data-wiki-id="plugin:extension">Extension Manager</a>. Refer to <a href="/plugins" class="wikilink1" title="plugins" data-wiki-id="plugins">Plugins</a> on how to install plugins manually. </p> </div> <div class="secedit editbutton_section editbutton_2"><form class="button btn_secedit" method="post" action="/plugin:settingstree"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1659132629" /><input type="hidden" name="summary" value="[Installation] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="installation" /><input type="hidden" name="codeblockOffset" value="0" /><input type="hidden" name="range" value="935-1408" /><button type="submit" title="Installation">Edit</button></div></form></div> <h2 class="sectionedit3" id="overview">Overview</h2> <div class="level2"> <p> This plugin is for plugin authors, to simply embed an admin page allowing to set settings (aka. plugin configs) based on namespace hierarchy of the wiki. </p> <p> Demo based on dw2pdf: <a href="/lib/exe/fetch.php?tok=9e5700&media=https%3A%2F%2Fraw.githubusercontent.com%2Ffajan%2Fsettingstree%2Fmaster%2Fexample-screenshot-explain.png" class="media" title="https://raw.githubusercontent.com/fajan/settingstree/master/example-screenshot-explain.png"><img src="/lib/exe/fetch.php?tok=9e5700&media=https%3A%2F%2Fraw.githubusercontent.com%2Ffajan%2Fsettingstree%2Fmaster%2Fexample-screenshot-explain.png" class="media" loading="lazy" alt="" /></a> </p> <p> The helper can be included to your plugin's admin page, and it displays an area as see in the screenshot. The area have 3 parts: </p> <ul> <li class="level1"><div class="li"> explorertree (top left) to select page/NS, </div> </li> <li class="level1"><div class="li"> settings (right, main area) to edit settings,</div> </li> <li class="level1"><div class="li"> and a hierarchical view for a setting value (middle/bottom left) to overview where and how it was changed.</div> </li> </ul> <p> The settings are borrowed from config, with a bit of update to the interface and functionalities: </p> <ul> <li class="level1"><div class="li"> ajax based interface (hence html5 browser with enabled javascript is required)</div> </li> <li class="level1"><div class="li"> you can override settings by namespace or page which applies to current and descendant pages/NS-es</div> </li> <li class="level1"><div class="li"> you can set protection to settings which applies to all descendant pages/NS-es or before-action config popups.</div> </li> <li class="level1 node"><div class="li"> uses (memcached) hierarchy for each plugin stored in <code>DW/data/settingstree/<pluginname><type>.json</code> as json.</div> <ul> <li class="level2"><div class="li"> settings are manually editable there with a json editor, but be sure remove cached value.</div> </li> </ul> </li> <li class="level1 node"><div class="li"> settings meta, default values are stored with a “version” (timestamp) so if you update the plugin's config meta/defaults, they will be applied.</div> <ul> <li class="level2"><div class="li"> example code checks/sets version by the timestamp of the latest file modification time of the plugin's <code>conf/metadata.php</code>, <code>conf/default.php</code> and <code>conf/extend.php</code></div> </li> </ul> </li> <li class="level1 node"><div class="li"> settings in the admin may overlap settings in config:</div> <ul> <li class="level2 node"><div class="li"> plugins's configs (what you see in config manager) can be included as is</div> <ul> <li class="level3"><div class="li"> with optionally ignoring a some</div> </li> </ul> </li> <li class="level2"><div class="li"> plugins's configs can be extended.</div> </li> </ul> </li> <li class="level1 node"><div class="li"> settings extend config in order:</div> <ol> <li class="level2 node"><div class="li"> config value: (in config plugin)</div> <ol> <li class="level3"><div class="li"> default value</div> </li> <li class="level3"><div class="li"> local value (overrides default)</div> </li> <li class="level3"><div class="li"> protected value (overrides default or local)</div> </li> </ol> </li> <li class="level2 node"><div class="li"> root namespace:</div> <ol> <li class="level3"><div class="li"> default: effective value from config</div> </li> <li class="level3"><div class="li"> value protection: if config has protected value</div> </li> <li class="level3"><div class="li"> local: value (overrides config's effective value) → can not set if protected.</div> </li> <li class="level3"><div class="li"> set protection (descendant levels will see current level's effective value as protected)</div> </li> </ol> </li> <li class="level2 node"><div class="li"> child namespace/page:</div> <ol> <li class="level3"><div class="li"> default: effective value from parent</div> </li> <li class="level3"><div class="li"> value protection: if any level above (including config) has protected value</div> </li> <li class="level3"><div class="li"> local: value (overrides parent's effective value) → can not set if protected.</div> </li> <li class="level3"><div class="li"> set protection (descendant levels will see current level's effective value as protected)</div> </li> </ol> </li> </ol> </li> <li class="level1 node"><div class="li"> if a value is set/local on (config→root→level1→<strong>level2</strong>) and config, root or level1 became protected, the local value of level2 is kept but ignored, and the protected value is the effective.</div> <ul> <li class="level2"><div class="li"> after removing the protection level2 local value is effective again.</div> </li> <li class="level2"><div class="li"> see example on screenshot (on <code>test1</code> → “Value is set to <code>A4</code> but ignored”)</div> </li> </ul> </li> <li class="level1 node"><div class="li"> You can not leave a level if there is changed but unsaved values: </div> <ul> <li class="level2"><div class="li"> You need to either save or cancel changes</div> </li> <li class="level2"><div class="li"> all unsaved but changed values are highlighted with wheat cell background.</div> </li> </ul> </li> </ul> </div> <div class="secedit editbutton_section editbutton_3"><form class="button btn_secedit" method="post" action="/plugin:settingstree"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1659132629" /><input type="hidden" name="summary" value="[Overview] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="overview" /><input type="hidden" name="codeblockOffset" value="0" /><input type="hidden" name="range" value="1409-4599" /><button type="submit" title="Overview">Edit</button></div></form></div> <h2 class="sectionedit4" id="embed">Embed</h2> <div class="level2"> <p> Example: </p> <pre class="code php"><span class="kw2">class</span> admin_plugin_<span class="sy0"><</span>yourplugin<span class="sy0">></span> <span class="kw2">extends</span> DokuWiki_Admin_Plugin <span class="br0">{</span> <span class="kw2">private</span> <span class="re0">$settings_helper</span> <span class="sy0">=</span> <span class="kw4">null</span><span class="sy0">;</span> <span class="kw2">private</span> <span class="re0">$settings_registered</span> <span class="sy0">=</span> <span class="kw4">false</span><span class="sy0">;</span> <span class="kw2">function</span> get_settings_helper<span class="br0">(</span><span class="br0">)</span><span class="br0">{</span> <span class="kw1">if</span> <span class="br0">(</span><span class="sy0">!</span><span class="re0">$this</span><span class="sy0">-></span><span class="me1">settings_helper</span><span class="br0">)</span><span class="br0">{</span> <span class="re0">$this</span><span class="sy0">-></span><span class="me1">settings_helper</span> <span class="sy0">=</span> plugin_load<span class="br0">(</span><span class="st_h">'helper'</span><span class="sy0">,</span><span class="st_h">'settingstree'</span><span class="br0">)</span><span class="sy0">;</span> <span class="br0">}</span> <span class="kw1">return</span> <span class="re0">$this</span><span class="sy0">-></span><span class="me1">settings_helper</span><span class="sy0">;</span> <span class="br0">}</span> <span class="kw2">function</span> init_settingstree<span class="br0">(</span><span class="br0">)</span><span class="br0">{</span> <span class="kw1">if</span> <span class="br0">(</span><span class="sy0">!</span><span class="br0">(</span><span class="re0">$e</span> <span class="sy0">=</span> <span class="re0">$this</span><span class="sy0">-></span><span class="me1">get_settings_helper</span><span class="br0">(</span><span class="br0">)</span><span class="br0">)</span><span class="br0">)</span> <span class="kw1">return</span><span class="sy0">;</span> <span class="kw1">if</span> <span class="br0">(</span><span class="re0">$this</span><span class="sy0">-></span><span class="me1">settings_registered</span><span class="br0">)</span> <span class="kw1">return</span> <span class="re0">$e</span><span class="sy0">;</span> <span class="re0">$confdir</span> <span class="sy0">=</span> DOKU_INC<span class="sy0">.</span><span class="st_h">'lib/plugins/<yourplugin>/conf/'</span><span class="sy0">;</span> <span class="co1">// check if the already stored version is the same as the current one we offer, and reregister options if the settingstree version is older.</span> <span class="kw1">if</span> <span class="br0">(</span><span class="re0">$e</span><span class="sy0">-></span><span class="me1">checkSettingsVersion</span><span class="br0">(</span><span class="st_h">'<yourplugin>'</span><span class="sy0">,</span> <span class="re0">$ver</span> <span class="sy0">=</span> <a href="http://www.php.net/max"><span class="kw3">max</span></a><span class="br0">(</span> <span class="co1">// we're comparing the registered settings versus the configuration files' last change.</span> <span class="co1">// metadata may have an extra '_ignore_for_settingstree' =>true, in which case it won't be configurable by settingstree</span> <a href="http://www.php.net/filemtime"><span class="kw3">filemtime</span></a><span class="br0">(</span><span class="re0">$confdir</span><span class="sy0">.</span><span class="st_h">'metadata.php'</span><span class="br0">)</span><span class="sy0">,</span> <a href="http://www.php.net/filemtime"><span class="kw3">filemtime</span></a><span class="br0">(</span><span class="re0">$confdir</span><span class="sy0">.</span><span class="st_h">'default.php'</span><span class="br0">)</span><span class="sy0">,</span> <span class="co1">// extends.php have exactly the same syntax as default.php + metadata.php (in the same file), but these settings are only configurable by settingstree plugin and not by config.</span> <span class="sy0">@</span><a href="http://www.php.net/filemtime"><span class="kw3">filemtime</span></a><span class="br0">(</span><span class="re0">$confdir</span><span class="sy0">.</span><span class="st_h">'extends.php'</span><span class="br0">)</span> <span class="br0">)</span><span class="br0">)</span><span class="br0">)</span><span class="br0">{</span> <span class="re0">$meta</span> <span class="sy0">=</span> <a href="http://www.php.net/array"><span class="kw3">array</span></a><span class="br0">(</span><span class="br0">)</span><span class="sy0">;</span> <span class="re0">$conf</span> <span class="sy0">=</span> <a href="http://www.php.net/array"><span class="kw3">array</span></a><span class="br0">(</span><span class="br0">)</span><span class="sy0">;</span> <span class="kw1">include</span><span class="br0">(</span><span class="re0">$confdir</span><span class="sy0">.</span><span class="st_h">'metadata.php'</span><span class="br0">)</span><span class="sy0">;</span> <span class="kw1">include</span><span class="br0">(</span><span class="re0">$confdir</span><span class="sy0">.</span><span class="st_h">'default.php'</span><span class="br0">)</span><span class="sy0">;</span> <span class="kw1">if</span> <span class="br0">(</span><a href="http://www.php.net/file_exists"><span class="kw3">file_exists</span></a><span class="br0">(</span><span class="re0">$confdir</span><span class="sy0">.</span><span class="st_h">'extends.php'</span><span class="br0">)</span><span class="br0">)</span> <span class="br0">{</span><span class="kw1">include</span><span class="br0">(</span><span class="re0">$confdir</span><span class="sy0">.</span><span class="st_h">'extends.php'</span><span class="br0">)</span><span class="sy0">;</span><span class="br0">}</span> <span class="co1">// this file may not exist</span> <span class="re0">$e</span><span class="sy0">-></span><span class="me1">registerSettings</span><span class="br0">(</span><span class="st_h">'<yourplugin>'</span><span class="sy0">,</span><span class="re0">$ver</span><span class="sy0">,</span><span class="re0">$meta</span><span class="sy0">,</span><span class="re0">$conf</span><span class="br0">)</span><span class="sy0">;</span> <span class="co1">// (re)register settings for this plugin..</span> <span class="br0">}</span> <span class="re0">$this</span><span class="sy0">-></span><span class="me1">settings_registered</span> <span class="sy0">=</span> <span class="kw4">true</span><span class="sy0">;</span> <span class="kw1">return</span> <span class="re0">$e</span><span class="sy0">;</span> <span class="br0">}</span>   <span class="kw2">function</span> __construct<span class="br0">(</span><span class="br0">)</span><span class="br0">{</span> <span class="re0">$this</span><span class="sy0">-></span><span class="me1">init_settingstree</span><span class="br0">(</span><span class="br0">)</span><span class="sy0">;</span> <span class="br0">}</span> <span class="kw2">function</span> handle<span class="br0">(</span><span class="br0">)</span> <span class="br0">{</span> <span class="co1">// changes are handled with ajax, so nothing to do here.</span> <span class="br0">}</span> <span class="kw2">function</span> html<span class="br0">(</span><span class="br0">)</span><span class="br0">{</span> <span class="kw1">echo</span> <span class="st_h">'<h1>'</span><span class="sy0">.</span><span class="re0">$this</span><span class="sy0">-></span><span class="me1">getLang</span><span class="br0">(</span><span class="st_h">'admin_set_options'</span><span class="br0">)</span><span class="sy0">.</span><span class="st_h">'</h1>'</span><span class="sy0">.</span>NL<span class="sy0">;</span> <span class="kw1">if</span> <span class="br0">(</span><span class="sy0">!</span><span class="br0">(</span><span class="re0">$e</span> <span class="sy0">=</span> <span class="re0">$this</span><span class="sy0">-></span><span class="me1">init_settingstree</span><span class="br0">(</span><span class="br0">)</span><span class="br0">)</span><span class="br0">)</span><span class="br0">{</span> <span class="kw1">echo</span> <span class="st0">"something's wrong..."</span><span class="sy0">;</span> <span class="kw1">return</span><span class="sy0">;</span> <span class="br0">}</span> <span class="kw1">echo</span> <span class="re0">$e</span><span class="sy0">-></span><span class="me1">showAdmin</span><span class="br0">(</span><span class="st_h">'<yourplugin>'</span><span class="sy0">,</span><span class="st_h">':'</span><span class="br0">)</span><span class="sy0">;</span> <span class="co1">// yeah... that's it. we embedded it to our admin. YAAY!!</span> <span class="br0">}</span> <span class="kw2">function</span> forAdminOnly<span class="br0">(</span><span class="br0">)</span> <span class="br0">{</span> <span class="co1">// for only superusers (true) or also for managers (false)?</span> <span class="kw1">return</span> <span class="re0">$this</span><span class="sy0">-></span><span class="me1">getConf</span><span class="br0">(</span><span class="st_h">'admin_only_setoptions'</span><span class="br0">)</span><span class="sy0">;</span> <span class="br0">}</span> <span class="kw2">function</span> getMenuText<span class="br0">(</span><span class="re0">$language</span><span class="br0">)</span> <span class="br0">{</span> <span class="kw1">return</span> <span class="re0">$this</span><span class="sy0">-></span><span class="me1">getLang</span><span class="br0">(</span><span class="st_h">'admin_set_options'</span><span class="br0">)</span><span class="sy0">;</span> <span class="br0">}</span> <span class="kw2">function</span> getMenuSort<span class="br0">(</span><span class="br0">)</span> <span class="br0">{</span> <span class="kw1">return</span> <span class="nu0">100</span><span class="sy0">;</span> <span class="br0">}</span> <span class="br0">}</span></pre> </div> <div class="secedit editbutton_section editbutton_4"><form class="button btn_secedit" method="post" action="/plugin:settingstree"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1659132629" /><input type="hidden" name="summary" value="[Embed] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="embed" /><input type="hidden" name="codeblockOffset" value="0" /><input type="hidden" name="range" value="4600-6976" /><button type="submit" title="Embed">Edit</button></div></form></div> <h2 class="sectionedit5" id="configuration_and_settings">Configuration and Settings</h2> <div class="level2"> <p> The plugin uses the same settings meta, defaults and lang structure as config manager plugin. </p> </div> <div class="secedit editbutton_section editbutton_5"><form class="button btn_secedit" method="post" action="/plugin:settingstree"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1659132629" /><input type="hidden" name="summary" value="[Configuration and Settings] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="configuration_and_settings" /><input type="hidden" name="codeblockOffset" value="1" /><input type="hidden" name="range" value="6977-7111" /><button type="submit" title="Configuration and Settings">Edit</button></div></form></div> <h2 class="sectionedit6" id="development">Development</h2> <div class="level2"> <p> Current status: </p> <ul> <li class="level1 node"><div class="li"> feature freeze, prepare to stable</div> <ul> <li class="level2"><div class="li"> unplanned, but required feature before stable: “export-config”, which will be merged in a week.</div> </li> <li class="level2"><div class="li"> “export-config” feature added, returning to feature freeze.</div> </li> </ul> </li> <li class="level1"><div class="li"> documentation needs to be extended added here.</div> </li> <li class="level1"><div class="li"> admin interface is done.</div> </li> <li class="level1"><div class="li"> export-modal interface is done.</div> </li> <li class="level1 node"><div class="li"> helper methods added</div> <ul> <li class="level2"><div class="li"> helper methods currently only documented by getMethod (see methods parameters there)</div> </li> </ul> </li> <li class="level1"><div class="li"> test for all setting types.</div> </li> </ul> </div> <h4 id="change_log">Change Log</h4> <div class="level4"> <ul> <li class="level1 node"><div class="li"> <strong>2015-07-20</strong></div> <ul> <li class="level2"><div class="li"> Beta / demo release</div> </li> </ul> </li> <li class="level1 node"><div class="li"> <strong>2015-07-22</strong></div> <ul> <li class="level2 node"><div class="li"> minor fixes.</div> <ul> <li class="level3"><div class="li"> script / gui cosmetic fixes.</div> </li> </ul> </li> <li class="level2"><div class="li"> testing/RC release</div> </li> </ul> </li> <li class="level1 node"><div class="li"> <strong>2015-07-23</strong></div> <ul> <li class="level2"><div class="li"> disable caching if it's emulated</div> </li> <li class="level2"><div class="li"> trigger error on unmet dependency</div> </li> <li class="level2"><div class="li"> clean up commented out codes</div> </li> </ul> </li> <li class="level1 node"><div class="li"> <strong>2015-07-27</strong></div> <ul> <li class="level2"><div class="li"> removed explorertree's js callbacks, instead listening to explorertree's events (this to preparation for export-config feature)</div> </li> <li class="level2"><div class="li"> added id to explorertree, but currently hardcoded.</div> </li> <li class="level2 node"><div class="li"> removed global functions, now instead listening to events:</div> <ul> <li class="level3"><div class="li"> <code>settingstree_selectlevel</code> → listen to explorertree's <code>tree_selected</code> event instead</div> </li> <li class="level3"><div class="li"> <code>settingstree_show_in_hierarchy</code> → listen to <code>show_in_hierarchy</code> event on root instead.</div> </li> </ul> </li> <li class="level2"><div class="li"> exploded <code>settingslevel</code>-'s and <code>settingswrapper</code>-'s <code>showHtml</code> method to smaller parts (in preparation for export-config feature)</div> </li> </ul> </li> <li class="level1 node"><div class="li"> <strong>2015-07-29</strong></div> <ul> <li class="level2 node"><div class="li"> added 'export-config' feature:</div> <ul> <li class="level3"><div class="li"> display modal to set temporary settings override. can be used for changing configuration temorarly for a process (such as exporting, hence the name)</div> </li> <li class="level3"><div class="li"> export-modal has much more similar interface to config plugin, as area is wider and protection checkbox is not present.</div> </li> <li class="level3"><div class="li"> added ``_ignore_for_export`` meta option to hide settings from export-config modal.</div> </li> </ul> </li> <li class="level2"><div class="li"> fixed: if invalid value prevented save, all changed values remain changed</div> </li> <li class="level2"><div class="li"> fixed: in update info, “updated from '[default value]'” now displays the effective value and displays '(default value)' behind it.</div> </li> <li class="level2"><div class="li"> fixed: lost event when selecting root after initialization.</div> </li> </ul> </li> <li class="level1 node"><div class="li"> <strong>2015-07-30</strong></div> <ul> <li class="level2"><div class="li"> minor fixes.</div> </li> </ul> </li> <li class="level1 node"><div class="li"> <strong>2015-07-30</strong></div> <ul> <li class="level2"><div class="li"> fix: modal placement and size on low resolution devices</div> </li> </ul> </li> </ul> </div> <h4 id="known_bugs_and_issues">Known Bugs and Issues</h4> <div class="level4"> <p> I currently don't have much time to test with all possible setting-type, and browsers… The current release (07-29) works with Chrome, FF, and IE10. </p> </div> <h4 id="todo_wish_list">ToDo/Wish List</h4> <div class="level4"> <p> … </p> </div> <div class="secedit editbutton_section editbutton_6"><form class="button btn_secedit" method="post" action="/plugin:settingstree"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1659132629" /><input type="hidden" name="summary" value="[Development] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="development" /><input type="hidden" name="codeblockOffset" value="1" /><input type="hidden" name="range" value="7112-9589" /><button type="submit" title="Development">Edit</button></div></form></div> <h2 class="sectionedit7" id="discussion">Discussion</h2> <div class="level2"> </div> <div class="secedit editbutton_section editbutton_7"><form class="button btn_secedit" method="post" action="/plugin:settingstree"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="1659132629" /><input type="hidden" name="summary" value="[Discussion] " /><input type="hidden" name="target" value="section" /><input type="hidden" name="hid" value="discussion" /><input type="hidden" name="codeblockOffset" value="1" /><input type="hidden" name="range" value="9590-" /><button type="submit" title="Discussion">Edit</button></div></form></div>  </div> <div class="docInfo"><bdi>plugin/settingstree.txt</bdi> · Last modified: <time datetime="2022-07-30T00:10:29+0200">2022-07-30 00:10</time> by <bdi>Klap-in</bdi></div> <hr class="a11y" /> </div></main>  <nav id="dokuwiki__pagetools" aria-labelledby="dokuwiki__pagetools__heading"> <h3 class="a11y" id="dokuwiki__pagetools__heading">Page Tools</h3> <div class="tools"> <ul> <li class="edit"><a href="/plugin:settingstree?do=edit" title="Edit this page [e]" rel="nofollow" accesskey="e"><span>Edit this page</span><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg></a></li><li class="revs"><a href="/plugin:settingstree?do=revisions" title="Old revisions [o]" rel="nofollow" accesskey="o"><span>Old revisions</span><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path d="M11 7v5.11l4.71 2.79.79-1.28-4-2.37V7m0-5C8.97 2 5.91 3.92 4.27 6.77L2 4.5V11h6.5L5.75 8.25C6.96 5.73 9.5 4 12.5 4a7.5 7.5 0 0 1 7.5 7.5 7.5 7.5 0 0 1-7.5 7.5c-3.27 0-6.03-2.09-7.06-5h-2.1c1.1 4.03 4.77 7 9.16 7 5.24 0 9.5-4.25 9.5-9.5A9.5 9.5 0 0 0 12.5 2z"/></svg></a></li><li class="backlink"><a href="/plugin:settingstree?do=backlink" title="Backlinks" rel="nofollow"><span>Backlinks</span><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path d="M10.59 13.41c.41.39.41 1.03 0 1.42-.39.39-1.03.39-1.42 0a5.003 5.003 0 0 1 0-7.07l3.54-3.54a5.003 5.003 0 0 1 7.07 0 5.003 5.003 0 0 1 0 7.07l-1.49 1.49c.01-.82-.12-1.64-.4-2.42l.47-.48a2.982 2.982 0 0 0 0-4.24 2.982 2.982 0 0 0-4.24 0l-3.53 3.53a2.982 2.982 0 0 0 0 4.24m2.82-4.24c.39-.39 1.03-.39 1.42 0a5.003 5.003 0 0 1 0 7.07l-3.54 3.54a5.003 5.003 0 0 1-7.07 0 5.003 5.003 0 0 1 0-7.07l1.49-1.49c-.01.82.12 1.64.4 2.43l-.47.47a2.982 2.982 0 0 0 0 4.24 2.982 2.982 0 0 0 4.24 0l3.53-3.53a2.982 2.982 0 0 0 0-4.24.973.973 0 0 1 0-1.42z"/></svg></a></li><li class="top"><a href="#dokuwiki__top" title="Back to top [t]" rel="nofollow" accesskey="t"><span>Back to top</span><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"/></svg></a></li> </ul> </div> </nav> </div>  <footer id="dokuwiki__footer"><div class="pad"> <div class="license">Except where otherwise noted, content on this wiki is licensed under the following license: <bdi><a href="https://creativecommons.org/licenses/by-sa/4.0/deed.en" rel="license" class="urlextern">CC Attribution-Share Alike 4.0 International</a></bdi></div> <div class="buttons"> <a href="https://creativecommons.org/licenses/by-sa/4.0/deed.en" rel="license"><img src="/lib/images/license/button/cc-by-sa.png" alt="CC Attribution-Share Alike 4.0 International" /></a> <a href="https://www.dokuwiki.org/donate" title="Donate" ><img src="/lib/tpl/dokuwiki/images/button-donate.gif" width="80" height="15" alt="Donate" /></a> <a href="https://php.net" title="Powered by PHP" ><img src="/lib/tpl/dokuwiki/images/button-php.gif" width="80" height="15" alt="Powered by PHP" /></a> <a href="//validator.w3.org/check/referer" title="Valid HTML5" ><img src="/lib/tpl/dokuwiki/images/button-html5.png" width="80" height="15" alt="Valid HTML5" /></a> <a href="//jigsaw.w3.org/css-validator/check/referer?profile=css3" title="Valid CSS" ><img src="/lib/tpl/dokuwiki/images/button-css.png" width="80" height="15" alt="Valid CSS" /></a> <a href="https://dokuwiki.org/" title="Driven by DokuWiki" ><img src="/lib/tpl/dokuwiki/images/button-dw.png" width="80" height="15" alt="Driven by DokuWiki" /></a> </div> <div style="margin-top: 2em; font-size:90%" class="dokuwiki"><div style="float:right"><a href="http://www.splitbrain.org/personal#imprint" style="float:right; text-decoration: none; color:#333">Imprint</a></div></div> <style type="text/css"> @media screen { body { padding-top: 30px; } #global__header { position: absolute; top: 0; left: 0; text-align: left; vertical-align: middle; line-height: 1.5; background-color: #333; box-shadow: 0 0 8px rgba(0,0,0,0.5); width: 100%; margin: 0; padding: 5px 20px; -moz-box-sizing: border-box; -webkit-box-sizing: border-box; box-sizing: border-box; white-space: nowrap; overflow: hidden; } #global__header h2 { position: absolute; left: -99999em; top: 0; overflow: hidden; display: inline; } #global__header ul, #global__header li { margin: 0; padding: 0; list-style: none; display: inline; line-height: 1.5; } #global__header a { color: #bbb; text-decoration: none; margin-right: 20px; font-size: 14px; font-weight: normal; } #global__header a:hover, #global__header a:active, #global__header a:focus { color: #fff; text-decoration: underline; } #global__header form { float: right; margin: 0 0 0 20px; } #global__header input { background-color: #333; background-image: none; border: 1px solid #bbb; color: #fff; box-shadow: none; border-radius: 2px; margin: 0; line-height: normal; padding: 1px 0 1px 0; height: auto; } #global__header input.button { border: none; color: #bbb; } #global__header input.button:hover, #global__header input.button:active, #global__header input.button:focus { color: #fff; text-decoration: underline; } } /* /@media */ @media only screen and (min-width: 601px) { /* changes specific for www.dokuwiki.org */ #dokuwiki__header { padding-top: 3em; } #dokuwiki__usertools { top: 3em; } /* changes specific for bugs.dokuwiki.org */ div#container div#showtask { top: 40px; } } /* /@media */ @media only screen and (max-width: 600px) { body { padding-top: 0; } #global__header { position: static; white-space: normal; overflow: auto; } #global__header form { float: none; display: block; margin: 0 0 .4em; } } /* /@media */ @media print { #global__header { display: none; } } /* /@media */ </style> <div id="global__header"> <h2>Global DokuWiki Links</h2> <form method="get" action="https://search.dokuwiki.org/" target="_top"> <input type="text" name="q" title="Search all DokuWiki sites at once" class="input" /> <input type="submit" title="Search all DokuWiki sites at once" value="Search" class="button" /> </form> <ul> <li><a href="https://download.dokuwiki.org" title="Download the latest release" target="_top">Download</a></li> <li><a href="https://www.dokuwiki.org" title="Read the DokuWiki documentation" target="_top">Wiki</a></li> <li><a href="https://forum.dokuwiki.org" title="Ask questions in the DokuWiki forum" target="_top">Forum</a></li> <li><a href="https://irc.dokuwiki.org" title="Check IRC chat logs or join the chat" target="_top">IRC</a></li> <li><a href="https://github.com/splitbrain/dokuwiki/issues" title="Report and track bugs" target="_top">Bugs</a></li> <li><a href="https://translate.dokuwiki.org/" title="Help translating the DokuWiki interface" target="_top">Translate</a></li> <li><a href="https://github.com/splitbrain/dokuwiki" title="Access the most recent git commits" target="_top">Git</a></li> <li><a href="https://xref.dokuwiki.org/reference/dokuwiki/" title="Cross-Reference of the DokuWiki source code" target="_top">XRef</a></li> <li><a href="https://codesearch.dokuwiki.org/" title="Search through the sources of DokuWiki, plugins and templates" target="_top">Code Search</a></li> </ul> </div>  </div></footer> </div></div> <div class="no"><img src="/lib/exe/taskrunner.php?id=plugin%3Asettingstree&1743433347" width="2" height="1" alt="" /></div> <div id="screen__mode" class="no"></div></body> </html>