Jump to content
pmarki

General site settings module

Recommended Posts

This module provides a solution for keeping various site settings in one place (titles, slogans, api keys, emails, addresses, etc.).

Features

- Admin can create unlimited number of settings
- Settings can be grouped
- Admin can set setting label, notes, property name, field width and type
- Settings can be of type text, checkbox, radios, select, email, url, integer

How to use

In module configuration create as many settings as needed. Customize their label, type, width and provide a name you want to use in a template files (property name). After that admin can set those  settings on "General Settings" page in "Setup" section.
Every time you wish to output eg. site name you can use $settings->site_name or wire('settings')->site_name or $settings->option2 to get value of 'Check it' as seen on the first screenshot. (Checked checkbox returns 1).
You can change global name ($settings) to something else in module configuration.

To get basic markup with all settings and their values use $settings->render(), usefull to check returning values (esp. select/radios - their values are sanitized as page names).

Current limitation:
-no way to change order of settings,
-new settings can only be added at the bottom.

Multilanguage

To make fields multilanguage aware create a field with a same property name with '_languageName' appended. Example: Your site has two languages: default and french, create site_title and site_title_french fields. Put in a template $settings->site_title. If a user has set french language, this module output site_title_french, otherwise site_title. Please notice that render() function is not language aware.

https://github.com/pmarki/ProcessGeneralSettings

Screenshot_20160920_110011.pngScreenshot_20160830_180429.png

Edited by pmarki
new features added
  • Like 11

Share this post


Link to post
Share on other sites

I'm using my MultiValueTextformatter module for such things, added to the Home page. Works fine, though it's for the developer only, not for the client because he could easily mess things up. If I use an InputfieldTextaraeaLanguage then it's multilanguage too - btw, is your module multilang capable?

I have another idea in mind for such a module that would heavily depend on JavaScript (namely Vue.js). It would be responsible for the UI, all settings would be saved as one JSON.

  • Like 1

Share this post


Link to post
Share on other sites
4 hours ago, tpr said:

I'm using my MultiValueTextformatter module for such things, added to the Home page. Works fine, though it's for the developer only, not for the client because he could easily mess things up. If I use an InputfieldTextaraeaLanguage then it's multilanguage too - btw, is your module multilang capable?

I have another idea in mind for such a module that would heavily depend on JavaScript (namely Vue.js). It would be responsible for the UI, all settings would be saved as one JSON.

Yes, I used to use MultiValueTextformatter for this and had the same worries. Just modified it a little to have 'some kind of multilanguage support', not as convenient as built in pw, but better than nothing :rolleyes:

  • Like 1

Share this post


Link to post
Share on other sites

Multilanguage can complicate things a lot and most non-techie people doesn't even recognize that. At one of my workplaces they asked me to place 3 language flags to the header - they thought it's just as easy like that :)

  • Like 2

Share this post


Link to post
Share on other sites

I have reorganize module settings, it uses JSON and ASM Select for fields, now it's possible to reorder settings, add, delete and so on. The only drawback is that it's not compatible with previous version. If you want to update, you will lose all entered  settings.

  • Like 1

Share this post


Link to post
Share on other sites

Nice! I haven't used it yet just had a quick look.

How about removing the "pencil" icon from the asm items and open the edit modal on click? I think this is the "natural" way of setting asmList item options in PW so people should be aware of that.

Share this post


Link to post
Share on other sites
27 minutes ago, tpr said:

asmList item options

Where are those options? Have I missed them so far? The only similar behavior is the action of the "drop down headers" of Repeater items (but those have the arrow like "greater-than sign") like this:

repeater-example.png

We can only drag-and-drop or delete standard asmSelect list items, at least that's what I have thought so far. Am I missing something?

Share this post


Link to post
Share on other sites

Eg when editing a template you can click on a field (asmList item) and set a few things there (overrides). Is that new to you? :) 

Share this post


Link to post
Share on other sites

Luckily, I have not had to update templates recently :P Jokes aside, yeah, now I see what you meant, but as a side note let me add that even those asmSelects have "text with links on them" and I thought you were referring to simply clicking on the bounding box itself and not on an additional element of it like the <a> in this case. The pencil icon might not be used in the ProcessWire admin in this context, but some sort of indicator is used, and generally I like these indicators, so that even newcomers can figure out the intended behavior. 

Share this post


Link to post
Share on other sites

Well if they get used to the pencil icon then when wil they learn the default PW workings? :)

There's an issue in the module: its SettingsJS.js is added not only in the module's page but every (admin) page and asmList items get the "pencil" icons. Of course clicking on them do nothing, apart from this error:

SettingsJS.js:50 Uncaught TypeError: Cannot read property 'undefined' of null

Setting line 42 to this fixes it:

if ($this->wire('user')->isLoggedin() && $this->input->get('name') == __CLASS__) {

 

  • Like 3

Share this post


Link to post
Share on other sites
2 hours ago, tpr said:

How about removing the "pencil" icon from the asm items and open the edit modal on click?

I think I'll leave it as is. It's a good indicator for newcomers and obvious for advanced.

 

38 minutes ago, tpr said:

Setting line 42 to this fixes it:

Thanks, fixed

Share this post


Link to post
Share on other sites

Have you updated the module in the module directory? Update says the latest is v110.

Share this post


Link to post
Share on other sites
20 minutes ago, pmarki said:

Done, but honestly I thought it's done automatically.

It is done automatically, once a day I think (?)...However, you can always do it manually if you can't wait :-) 

Share this post


Link to post
Share on other sites

Hi pmarki, can I use this module for pw 3.xx version?

Share this post


Link to post
Share on other sites
9 hours ago, monchu said:

Hi pmarki, can I use this module for pw 3.xx version?

Yes, it works with pw3. Just updated module info and added textarea field.

  • Like 2

Share this post


Link to post
Share on other sites

If only I knew how to do this...

Adding file fields isn't easy, beacuse you have to store a file somewhere. So far I haven't find a way to achieve this :(

But any advice would be appreciated :)

Share this post


Link to post
Share on other sites

I'm sorry, but I'm facing exactly the same problem. I'm no expert at all, but I guess the module has to create a new file/image field, a new template with that field assigned and finally a new page based on that template. Then this page could be used to store the image. Somehow. Maybe. :rolleyes:

Share this post


Link to post
Share on other sites

i would think that a general site settings module should just store settings, and not any files or images - if you need those just add a custom field to your settings template (?)

alternately ftp upload the image to a specific folder and then reference that file's path in the setting...

 

  • Like 1

Share this post


Link to post
Share on other sites
14 hours ago, Macrura said:

alternately ftp upload the image to a specific folder and then reference that file's path in the setting...

There's certainly nothing wrong with that approach and for sure it's quite common, but I think it is somewhat limited:

  • the customer/editor has to leave his known environment (ProcessWire backend in this case) and has to use FTP/SSH whatever
  • the referenced image is not available for image manipulations, for example: automatic creation a favicons in different solutions

Share this post


Link to post
Share on other sites

it depends - a lot of times if you are talking about a logo, that is a really specific image that might be precisely sized and optimized for display, may have light/dark versions, smaller icon version for mobile, maybe a version with a tagline, as well as possibly retina versions;

it could be something you don't want the client to have access to change.

On the other hand if you did want the client to have access to it and be able to change it, you might need a multi-image field with tags, so that you could upload all of the versions of the logo and tag them (light, dark, retina, icon or whatever). This is why i would recommend using the system's native image fields for images...

  • Like 1

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By bernhard
      --- Please use RockFinder3 ---
    • By MoritzLost
      Cacheable Placeholders
      This module allows you to have pieces of dynamic content inside cached output. This aims to solve the common problem of having a mostly cacheable site, but with pieces of dynamic output here and there.  Consider this simple example, where you want to output a custom greeting to the current user:
      <h1>Good morning, <?= ucfirst($user->name) ?></h1> This snippet means you can't use the template cache (at least for logged-in users), because each user has a different name. Even if 99% of your output is static, you can only cache the pieces that you know won't include this personal greeting. A more common example would be CSRF tokens for HTML forms - those need to be unique by definition, so you can't cache the form wholesale.
      This module solves this problem by introducing cacheable placeholders - small placeholder tokens that get replaced during every request. The replacement is done inside a Page::render hook so it runs during every request, even if the response is served from the template cache. So you can use something like this:
      <h1>Good morning, {{{greeting}}}</h1> Replacement tokens are defined with a callback function that produces the appropriate output and added to the module through a simple hook:
      // site/ready.php wire()->addHookAfter('CachePlaceholders::getTokens', function (HookEvent $e) { $tokens = $e->return; $tokens['greeting'] = [ 'callback' => function (array $tokenData) { return ucfirst(wire('user')->name); } ]; $e->return = $tokens; }); Tokens can also include parameters that are parsed and passed to the callback function. There are more fully annotated examples and step-by-step instructions in the README on Github!
      Features
      A simple and fast token parser that calls the appropriate callback and runs automatically. Tokens may include multiple named or positional parameters, as well as multi-value parameters. A manual mode that allows you to replace tokens in custom pieces of cached content (useful if you're using the $cache API). Some built-in tokens for common use-cases: CSRF-Tokens, replacing values from superglobals and producing random hexadecimal strings. The token format is completely customizable, all delimiters can be changed to avoid collisions with existing tag parsers or template languages. Links
      Github Repository & documentation Module directory (pending approval) If you are interested in learning more, the README is very extensive, with more usage examples, code samples and usage instructions!
    • By Craig
      I've been using Fathom Analytics for a while now and on a growing number of sites, so thought it was about time there was a PW module for it.
      WayFathomAnalytics
      WayFathomAnalytics is a group of modules which will allow you to view your Fathom Analytics dashboard in the PW admin panel and (optionally) automatically add and configure the tracking code on front-end pages.
      Links
      GitHub Readme & documentation Download Zip Modules directory Module settings screenshot What is Fathom Analytics?
      Fathom Analytics is a simple, privacy-focused website analytics tool for bloggers and businesses.

      Stop scrolling through pages of reports and collecting gobs of personal data about your visitors, both of which you probably don't need. Fathom is a simple and private website analytics platform that lets you focus on what's important: your business.
      Privacy focused Fast-loading dashboards, all data is on a single screen Easy to get what you need, no training required Unlimited email reports Private or public dashboard sharing Cookie notices not required (it doesn't use cookies or collect personal data) Displays: top content, top referrers, top goals and more
    • By daniels
      This is a lightweight alternative to other newsletter & newsletter-subscription modules.
      You can find the Module in the Modules directory and on Github
      It can subscribe, update, unsubscribe & delete a user in a list in Mailchimp with MailChimp API 3.0. It does not provide any forms or validation, so you can feel free to use your own. To protect your users, it does not save any user data in logs or sends them to an admin.
      This module fits your needs if you...
      ...use Mailchimp as your newsletter / email-automation tool ...want to let users subscribe to your newsletter on your website ...want to use your own form, validation and messages (with or without the wire forms) ...don't want any personal user data saved in any way in your ProcessWire environment (cf. EU data regulation terms) ...like to subscribe, update, unsubscribe or delete users to/from different lists ...like the Mailchimp UI for creating / sending / reviewing email campaigns *I have only tested it with PHP 7.x so far, so use on owners risk
      EDIT:
      Since 0.0.4, instructions and changelog can be found in the README only. You can find it here  🙂
      If you have questions or like to contribute, just post a reply or create an issue or pr on github, thanks!
    • By MoritzLost
      Sorry for the convoluted title. I have a problem with Process modules that define a custom page using the page key through getModuleInfo (as demonstrated in this excellent tutorial by @bernhard). Those pages are created automatically when the module is installed. The problem is that the title of the page only gets set in the current language. That's not a problem if the current language (language of the superuser who is installing the module) is the default language; if it isn't, the Process page is missing a title in the default language. This has the very awkward effect that a user using the backend in the default language (or any other language) will see an empty entry in the setup menu:

      This screenshot comes from my Cache Control module which includes a Process page. Now I realize the description sounds obscure, but for us it's a common setup: We a multiple bilingual sites where the default language is German and the second language is English. While the clients use the CMS in German, as a developer I prefer the English interface, so whenever I install a Process module I get this problem.
      As a module author, is there a way to handle this situation? I guess it would be possible to use post-installation hooks or create the pages manually, but I very much prefer the declarative approach. The page title is already translatable (through the __ function), but of course at the time of installation there is no translation, and as far as I'm aware it's not possible to ship translations with a module so they are used automatically. Could this situation be handled better in the core? I would prefer if the module installation process would always set the title of the Process page in the default language, instead of the language of the current user.
×
×
  • Create New...