Jump to content
pmarki

General site settings module

Recommended Posts

@Macrura, think that wire(‘settings’) doesn't work, at least if we deal with PW 3.x and ProcessGeneralSettings. Your approach gives the error:

Error: Function name must be a string 

Share this post


Link to post
Share on other sites

Please try...

wire('settings')

Note the difference in quotation marks - the forum editor changes single quotes to curly quotes (at least, they look like it to me) Such quotes are not accepted as string markers in PHP, so if you copied-and-pasted directly from Macrura's reply, you would probably get an error like that.

  • Like 3

Share this post


Link to post
Share on other sites

sorry my phone kb doesn't have straight quotes🔨

  • Like 1

Share this post


Link to post
Share on other sites

Hi,

Help: Echo field label?

echo $settings->as_tel->label; //dont work

or

$module = wire('modules')->get('ProcessGeneralSettings');
echo $field = $module->get('as_tel')->label; //dont work

Thanks

Share this post


Link to post
Share on other sites

Hello all.

I was wondering about the use of this module and would like to check for your opinion, guys, before I start testing it. Presently I setup manually a simple page where all my general site settings fields resign (Settings) with  no template assigned on it.

After that I define a variable $settings (could be a name of your preference ) in _init.php

$settings = $pages->get('/settings/'); // Grab the page url and add it here
or 
$settings = $pages->get(settings_page_id); // Grab the page ID and add it here

After that, I am able to print any field value in the markup by using:

echo $settings->fied_name // text and integer value fields
or
echo $settings->some_image_field->first->size(X,Y)->url // Just an example for images etc.

For sure the limit is the API of PW for any field and the parameters with it.

So my wondering is would the use of the module give more functionality as of the present setup? Bear in mind, that for a few clients I already setup the access to Settings page and they can change anything that is there or provide access to somebody else using PW user permissions options.

The Settings page can hold all sorts of PW fields available + custom ones that you've created/added and text and text area has absolutely no issues being multilanguage.

Respect to the mod development team for the time and efforts for sure, I am just trying to figure out the benefits of use over the present setup.

Share this post


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

So my wondering is would the use of the module give more functionality as of the present setup? Bear in mind, that for a few clients I already setup the access to Settings page and they can change anything that is there or provide access to somebody else using PW user permissions options.

The Settings page can hold all sorts of PW fields available + custom ones that you've created/added and text and text area has absolutely no issues being multilanguage.

Respect to the mod development team for the time and efforts for sure, I am just trying to figure out the benefits of use over the present setup.

i would stick with your regular fields page for editing settings; I don't think this module is maintained; i have a fork of it with a lot of new features and I use it on some sites, but then i made the Settings Factory module, so I use that instead now. You should be aware that the stock module is only accessible to super admin; one of my mods to the module was to create the permissions to enable other users to access settings; also i had to split it into a process module and the module that holds the settings, else settings not accessible to front end etc..

 

Share this post


Link to post
Share on other sites

I see Macrura. I would watch closely the development of your mod, however, the options and setups seems sort of way too much for the purpose of my simple projects that hold a logo, few text fields etc. At least I got on the right track using a settings page to hold general variables ;)

Share this post


Link to post
Share on other sites
26 minutes ago, MilenKo said:

I see Macrura. I would watch closely the development of your mod, however, the options and setups seems sort of way too much for the purpose of my simple projects that hold a logo, few text fields etc. At least I got on the right track using a settings page to hold general variables ;)

yes, if you need to hold those sorts of things, especially images, you should stick with real fields.

The main advantages of using a settings module could be summed up as:

(1) fast an easy to add a settings page (since you can reuse the same json file) and don't need to setup fields
(2) dedicated edit screen with no tabs as on the edit screen (no children, settings etc), no delete
(3) settings stored as JSON in 1 table/field (module config)
(4) human readable editing url, no url param
(5) since it is a process module, easy to link to the settings page directly in the admin menus

more discussions on the Settings Factory topic..
 

  • Like 2

Share this post


Link to post
Share on other sites

Hi, sorry for not being up to date, I'm working with Magento now.

@msncom I don't think it's possible.

I am happy to pass ownership of this module to someone who will be able to maintain it. In community we trust ;)

  • Like 1

Share this post


Link to post
Share on other sites

Thanks again, @Macrura Will give the module a try and will see how can I fit it in one of my next projects. Thanks to you and @pmarki for the idea and the code.

Share this post


Link to post
Share on other sites
16 hours ago, pmarki said:

I am happy to pass ownership of this module to someone who will be able to maintain it.

@pmarkii can take it over if you want, and i do have an updated version as described above.

  • Like 1

Share this post


Link to post
Share on other sites

I haven't used this module, but I have used @Macrura's Settings Factory which is awesome. Is there any reason to consider this module over Settings Factory? Genuine question because I don't know what the differences are :)

Share this post


Link to post
Share on other sites
9 minutes ago, adrian said:

I haven't used this module, but I have used @Macrura's Settings Factory which is awesome. Is there any reason to consider this module over Settings Factory? Genuine question because I don't know what the differences are :)

@adrian  do you have a link for this module? I searched " Settings Factory " in the modules section and it returned zero results.

I am curious to check it out

thank you

Share this post


Link to post
Share on other sites
Just now, neosin said:

@adrian  do you have a link for this module? I searched " Settings Factory " in the modules section and it returned zero results.

I am curious to check it out

thank you

 

  • Like 1

Share this post


Link to post
Share on other sites

@adrian thank you, figures it was in the forum and not the modules section I needed to search lol

 

Share this post


Link to post
Share on other sites
54 minutes ago, adrian said:

I haven't used this module, but I have used @Macrura's Settings Factory which is awesome. Is there any reason to consider this module over Settings Factory? Genuine question because I don't know what the differences are :)

Objectively, this module provides a clever interface for adding fields to your settings. My fork of it supported more fields, and other improvements. The warning here, as is mentioned earlier in this thread is that you do not want to install this module if you use Lister Pro, there is a serious incompatibility that causes your Lister Pro listers to lose their settings.

Besides that, Settings Factory allows multiple settings pages (unlimited) that you can link to in your admin menus; this module would be a single settings screen only. Further, you must use the fork if you want to have the settings be accessible to non-Superusers.

  • Like 1

Share this post


Link to post
Share on other sites
3 minutes ago, Macrura said:

you do not want to install this module if you use Lister Pro, there is a serious incompatibility that causes your Lister Pro listers to lose their settings.

Just to clarify - is it just this module, or also Settings Factory that has this issue?

If it's just this module then I can't see a reason to promote/maintain this module anymore. Am I missing something?

Share this post


Link to post
Share on other sites
30 minutes ago, adrian said:

Just to clarify - is it just this module, or also Settings Factory that has this issue?

My module (Settings Factory) has no relation to this module (General Settings), it doesn't share or inherit any code. Settings Factory does not set a global var for the settings (that is left to the user and how they interact with the SF api), therefore it does not suffer from the same issue which is that this module by default/upon installation sets a global $wire var for $settings, which is already being used by LP.

33 minutes ago, adrian said:

If it's just this module then I can't see a reason to promote/maintain this module anymore. Am I missing something?

I don't personally endorse or promote, or recommend this module – i advise that it NOT be used until the $settings problem is fixed; as i stated in earlier posts, i used it on a couple of sites, forked it and fixed all the issues, but for the last 10 months i only use Settings Factory and i don't use this module at all. It is fine with me if this module is deprecated.

  • Like 2

Share this post


Link to post
Share on other sites
5 minutes ago, Macrura said:

sets a global $wire var for $settings, which is already being used by LP

Thanks for the explanation on this (apparently I didn't read above). 

I must admit that I think LP shouldn't use $settings - it should be more specific, like $listerProSettings or similar.

I actually defined a global $wire var $settings for use with Settings Factory on one of my current projects - time to change that I guess :)

Share this post


Link to post
Share on other sites

so one of the first things i did was change the global to g_settings

https://github.com/outflux3/ProcessGeneralSettings/blob/master/GeneralSettings.module#L31

besides that i added support for placeholders, collapsed states, markup, import/export of settings..

15 minutes ago, adrian said:

I must admit that I think LP shouldn't use $settings - it should be more specific, like $listerProSettings or similar.

+1, i'm super paranoid about global vars now, since i lost all of the listers on one site... not sure if this problem still exists, i may have posted an issue report on the LP thread and Ryan may have changed it, haven't checked though...\

17 minutes ago, adrian said:

I actually defined a global $wire var $settings for use with Settings Factory on one of my current projects - time to change that I guess :)

did you encounter any problems with LP? i usually use more verbose globals for that, but on the other hand i have a new module that uses a $meta global, and another one with $theme; sometimes it's nice for the globals to be concise

  • Like 3

Share this post


Link to post
Share on other sites
1 hour ago, Macrura said:

did you encounter any problems with LP?

I don't have any listers set up on this site, although I probably will before it is released, so glad I learned about this now :)

  • 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 Gadgetto
      SnipWire - Snipcart integration for ProcessWire
      Snipcart is a powerful 3rd party, developer-first HTML/JavaScript shopping cart platform. SnipWire is the missing link between Snipcart and the content management framework ProcessWire.
      With SnipWire, you can quickly turn any ProcessWire site into a Snipcart online shop. The SnipWire plugin helps you to get your store up and running in no time. Detailed knowledge of the Snipcart system is not required.
      SnipWire is free and open source licensed under Mozilla Public License 2.0! A lot of work and effort has gone into development. It would be nice if you could donate an amount to support further development:

      Status update links (inside this thread) for SnipWire development
      2020-07-03 -- SnipWire 0.8.7 (beta) released! Fixes some small bugs and adds an indicator for TEST mode 2020-04-06 -- SnipWire 0.8.6 (beta) released! Adds support for Snipcart subscriptions and also fixes some problems 2020-03-21 -- SnipWire 0.8.5 (beta) released! Improves SnipWires webhooks interface and provides some other fixes and additions 2020-03-03 -- SnipWire 0.8.4 (beta) released! Improves compatibility for Windows based Systems. 2020-03-01 -- SnipWire 0.8.3 (beta) released! The installation and uninstallation process has been heavily revised. 2020-02-08 -- SnipWire 0.8.2 (beta) released! Added a feature to change the cart and catalogue currency by GET, POST or SESSION param 2020-02-03 -- SnipWire 0.8.1 (beta) released! All custom classes moved into their own namespaces. 2020-02-01 -- SnipWire is now available via ProcessWire's module directory! 2020-01-30 -- SnipWire 0.8.0 (beta) first public release! (module just submitted to the PW modules directory) 2020-01-28 -- added Custom Order Fields feature (first SnipWire release version is near!) 2020-01-21 -- Snipcart v3 - when will the new cart system be implemented? 2020-01-19 -- integrated taxes provider finished (+ very flexible shipping taxes handling) 2020-01-14 -- new date range picker, discount editor, order notifiactions, order statuses, and more ... 2019-11-15 -- orders filter, order details, download + resend invoices, refunds 2019-10-18 -- list filters, REST API improvements, new docs platform, and more ... 2019-08-08 -- dashboard interface, currency selector, managing Orders, Customers and Products, Added a WireTabs, refinded caching behavior 2019-06-15 -- taxes provider, shop templates update, multiCURL implementation, and more ... 2019-06-02 -- FieldtypeSnipWireTaxSelector 2019-05-25 -- SnipWire will be free and open source Plugin Key Features
      Fast and simple store setup Full integration of the Snipcart dashboard into the ProcessWire backend (no need to leave the ProcessWire admin area) Browse and manage orders, customers, discounts, abandoned carts, and more Multi currency support Custom order and cart fields Process refunds and send customer notifications from within the ProcessWire backend Process Abandoned Carts + sending messages to customers from within the ProcessWire backend Complete Snipcart webhooks integration (all events are hookable via ProcessWire hooks) Integrated taxes provider (which is more flexible then Snipcart own provider) Useful Links
      SnipWire in PW modules directory SnipWire Docs (please note that the documentation is a work in progress) SnipWire @GitHub (feature requests and suggestions for improvement are welcome - I also accept pull requests) Snipcart Website  

       
      ---- INITIAL POST FROM 2019-05-25 ----
       
    • By Sten
      Hello
      Till now I hacked something with the twig template but it works no more with new PW versions so I look forward to create a module. I am working on a site in multiple languages : French, English, Italian, German, Spanish, Portuguese, Hebrew, Russian. The new posts are entered in any language with a field for language. Till now, I got twig files to get the translations with constants defined for each part of the pages.
      So I'd like to create a module to include theses files added according to the url /fr/en/...
      Have you some observations to do before I begin about the direction to take ?
      Thank you
    • By ukyo
      Mystique Module for ProcessWire CMS/CMF
      Github repo : https://github.com/trk/Mystique
      Mystique module allow you to create dynamic fields and store dynamic fields data on database by using a config file.
      Requirements
      ProcessWire 3.0 or newer PHP 7.0 or newer FieldtypeMystique InputfieldMystique Installation
      Install the module from the modules directory:
      Via Composer:
      composer require trk/mystique Via git clone:
      cd your-processwire-project-folder/ cd site/modules/ git clone https://github.com/trk/Mystique.git Module in live reaction with your Mystique config file
      This mean if you remove a field from your config file, field will be removed from edit screen. As you see on youtube video.
      Using Mystique with your module or use different configs path, autoload need to be true for modules
      Default configs path is site/templates/configs/, and your config file name need to start with Mystique. and need to end with .php extension.
      Adding custom path not supporting anymore !
      // Add your custom path inside your module class`init` function, didn't tested outside public function init() { $path = __DIR__ . DIRECTORY_SEPARATOR . 'configs' . DIRECTORY_SEPARATOR; Mystique::add($path); } Mystique module will search site/modules/**/configs/Mystique.*.php and site/templates/Mystique.*.php paths for Mystique config files.
      All config files need to return a PHP ARRAY like examples.
      Usage almost same with ProcessWire Inputfield Api, only difference is set and showIf usage like on example.
      <?php namespace ProcessWire; /** * Resource : testing-mystique */ return [ 'title' => __('Testing Mystique'), 'fields' => [ 'text_field' => [ 'label' => __('You can use short named types'), 'description' => __('In file showIf working like example'), 'notes' => __('Also you can use $input->set() method'), 'type' => 'text', 'showIf' => [ 'another_text' => "=''" ], 'set' => [ 'showCount' => InputfieldText::showCountChars, 'maxlength' => 255 ], 'attr' => [ 'attr-foo' => 'bar', 'attr-bar' => 'foo' ] ], 'another_text' => [ 'label' => __('Another text field (default type is text)') ] ] ]; Example:
      site/templates/configs/Mystique.seo-fields.php <?php namespace ProcessWire; /** * Resource : seo-fields */ return [ 'title' => __('Seo fields'), 'fields' => [ 'window_title' => [ 'label' => __('Window title'), 'type' => Mystique::TEXT, // or InputfieldText 'useLanguages' => true, 'attr' => [ 'placeholder' => __('Enter a window title') ] ], 'navigation_title' => [ 'label' => __('Navigation title'), 'type' => Mystique::TEXT, // or InputfieldText 'useLanguages' => true, 'showIf' => [ 'window_title' => "!=''" ], 'attr' => [ 'placeholder' => __('Enter a navigation title') ] ], 'description' => [ 'label' => __('Description for search engines'), 'type' => Mystique::TEXTAREA, 'useLanguages' => true ], 'page_tpye' => [ 'label' => __('Type'), 'type' => Mystique::SELECT, 'options' => [ 'basic' => __('Basic page'), 'gallery' => __('Gallery'), 'blog' => __('Blog') ] ], 'show_on_nav' => [ 'label' => __('Display this page on navigation'), 'type' => Mystique::CHECKBOX ] ] ]; Searching data on Mystique field is limited. Because, Mystique saving data to database in json format. When you make search for Mystique field, operator not important. Operator will be changed with %= operator.
      Search example
      $navigationPages = pages()->find('my_mystique_field.show_on_nav=1'); $navigationPages = pages()->find('my_mystique_field.page_tpye=gallery');
    • By Robin S
      This is a module I made as an experiment a while ago and never got around to releasing publicly. At the time it was prompted by discussions around using Repeater fields for "page builder" purposes, where the depth feature could possibly be used for elements that would be nested inside other elements. I thought it would be useful to enforce some depth rules and translate the depth data into a multi-dimensional array structure.
      I'm not using this module anywhere myself but maybe it's useful to somebody.
      Repeater Depth Helper
      This module does two things relating to Repeater fields that have the "Item depth" option enabled:
      It enforces some depth rules for Repeater fields on save. Those rules are:
      The first item must have a depth of zero. Each item depth must not be more than one greater than previous item depth. It provides a RepeaterPageArray::getDepthStructure helper method that returns a nested depth structure for a Repeater field value.
      Helper method
      The module adds a RepeaterPageArray::getDepthStructure method that returns a multi-dimensional array where the key is the page ID and the value is an array of nested "child" items, or null if there are no nested children.
      Example

      The module doesn't make any assumptions about how you might want to use the depth structure array, but here is a way you might use it to output a nested unordered list.
      // Output a nested unordered list from a depth structure array function outputNestedList($depth_structure, $repeater_items) { $out = "<ul>"; foreach($depth_structure as $page_id => $nested_children) { $out .= "<li>" . $repeater_items->get("id=$page_id")->title; // Go recursive if there are nested children if(is_array($nested_children)) $out .= outputNestedList($nested_children, $repeater_items); $out .= "</li>"; } $out .= "</ul>"; return $out; } $repeater_items = $page->my_repeater; $depth_structure = $repeater_items->getDepthStructure(); echo outputNestedList($depth_structure, $repeater_items);
       
      https://github.com/Toutouwai/RepeaterDepthHelper
      https://modules.processwire.com/modules/repeater-depth-helper/
    • 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 If you are interested in learning more, the README is very extensive, with more usage examples, code samples and usage instructions!
×
×
  • Create New...