Jump to content
ukyo

Mystique (Fieldtype, Inputfield) build dynamic fields and store data by using config file

Recommended Posts

mystique.gif.ef5df542131d5bcd3fe8ad3ae03608b5.gif

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');
  • Like 21
  • Thanks 1

Share this post


Link to post
Share on other sites

Looks very cool, @ukyo! Thanks for that, but the font-size on the video was hard on my eyes. 🙂

Image result for grandma meme

  • Like 3
  • Confused 1

Share this post


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

@Sergio sorry about that, 4K screen 😞

No problem! Resolution is not the problem per se, but next time, for the sake of old fellas like myself, bump the font-size on your editor. 🙂 

  • Like 1

Share this post


Link to post
Share on other sites
8 hours ago, ukyo said:

Searching data inside this module is limited, because all data storing as a json value on to database

Maybe you could get some inspiration there from (or even improve on) my JsonNativeField module since MySQL supports searching inside JSON data.

  • Like 2

Share this post


Link to post
Share on other sites

Can you share a bit more details on how data is handled. E.g. what happens if I change a field or even remove it.

  • Like 2

Share this post


Link to post
Share on other sites
6 hours ago, BitPoet said:

Maybe you could get some inspiration there from (or even improve on) my JsonNativeField module since MySQL supports searching inside JSON data.

@BitPoet will check it, but i don't want to limit user's database options and if you need an important searchable field i am not advising to use this field, use a fully searchable field.

3 hours ago, LostKobrakai said:

Can you share a bit more details on how data is handled. E.g. what happens if I change a field or even remove it.

@LostKobrakai I will add more details on readme.md file and will update this post and module page.

About your question : as you see on youtube video, updating fields config file will update data entry form for admin page. If you remove field, you won't see this field on admin pages anymore. I am not caching your configs, always trying to get configs from selected config files.

  • Like 1

Share this post


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

About your question : as you see on youtube video, updating fields config file will update data entry form for admin page. If you remove field, you won't see this field on admin pages anymore. I am not caching your configs, always trying to get configs from selected config files.

My question was less about the field definitions, but more about the data stored in a field defined by your module. E.g. say I want to change an integer field to a float field.

  • Like 1

Share this post


Link to post
Share on other sites
2 minutes ago, LostKobrakai said:

My question was less about the field definitions, but more about the data stored in a field defined by your module. E.g. say I want to change an integer field to a float field.

Keep the field name same, do what you want. Because all data on database in string format (i am not checking user posted data), you can set field settings by using processwire fields api and you can limit user by settings.

Hook methods could be used for custom usages.

  • Like 2

Share this post


Link to post
Share on other sites

I am using this module for SEO, LANGUAGE and ELEMENTS (uikit components)

USAGE EXAMPLE : LANGUAGE

On my private module, i added my custom configs path to Mystique module by using :

Mystique::add('my-module-configs-path');

- Create config file

<?php

namespace ProcessWire;

// Filename: MyModule/configs/Mystique.language.php

// This options normally coming from a file array, i added 2 options for example
$options = [
	'tr' => 'Türkçe',
	'en' => 'English'
];
$defaultValue = 'en';

/**
 * Resource : MyModule => Language
 */
return [
    'title' => __('MyModule: Language'),
    'fields' => [
        'title' => [
            'label' => __('Language title'),
            'description' => __('Title of language'),
            'type' => Mystique::TEXT,
            'columnWidth' => 50
        ],
        'code' => [
            'label' => __('Code'),
            'description' => __('Language short code'),
            'type' => Mystique::SELECT,
            'options' => $options,
            'defaultValue' => $defaultValue,
            'required' => true,
            'columnWidth' => 50
        ],
        'flag' => [
            'label' => __('Flag'),
            'description' => __('Language flag code'),
            'type' => Mystique::TEXT,
            'columnWidth' => 50
        ],
        'direction' => [
            'label' => __('Direction'),
            'checkboxLabel' => __('Right to left'),
            'description' => __('Direction of language'),
            'type' => Mystique::TOGGLE_CHECKBOX,
            'type_fallback' => Mystique::CHECKBOX,
            'columnWidth' => 50
        ],
        'currency' => [
            'label' => __('Currency'),
            'description' => __('Code of currency'),
            'type' => Mystique::TEXT,
            'columnWidth' => 50
        ],
        'symbol' => [
            'label' => __('Symbol'),
            'description' => __('Symbol of currency'),
            'type' => Mystique::TEXT,
            'columnWidth' => 50
        ],
        'grouping_separator' => [
            'label' => __('Grouping separator'),
            'description' => __('Thousand separator for amount'),
            'type' => Mystique::TEXT,
            'columnWidth' => 50
        ],
        'decimal_separator' => [
            'label' => __('Decimal separator'),
            'description' => __('Decimal separator for amount'),
            'type' => Mystique::TEXT,
            'columnWidth' => 50
        ],
        'separator' => [
            'label' => __('Use separator'),
            'checkboxLabel' => __('YES'),
            'description' => __('Apply space between amount and currency symbol ?'),
            'type' => Mystique::TOGGLE_CHECKBOX,
            'type_fallback' => Mystique::CHECKBOX,
            'columnWidth' => 33
        ],
        'show_decimal' => [
            'label' => __('Decimal'),
            'checkboxLabel' => __('YES'),
            'description' => __('Show amount decimals ?'),
            'type' => Mystique::TOGGLE_CHECKBOX,
            'type_fallback' => Mystique::CHECKBOX,
            'columnWidth' => 33
        ],
        'symbol_after' => [
            'label' => __('Symbol after'),
            'checkboxLabel' => __('YES'),
            'description' => __('Display symbol after amount ?'),
            'type' => Mystique::TOGGLE_CHECKBOX,
            'type_fallback' => Mystique::CHECKBOX,
            'columnWidth' => 33
        ],
    ]
];

- Select config file from Mystique field settings

- Add Mystique field to language template

158007518_EkranResmi2019-04-1617_07_26.thumb.png.fc0ee438f50c25c17ac9b4fc66cd76e2.png1675030088_EkranResmi2019-04-1617_08_24.thumb.png.b24c6734f5c16bcd65d79882903f81e4.png

Access data via api (in this example mystique field name is : lang)

<?php

$language = $user->language;
// lang is Mystique field
echo 'Title : ' . $language->lang->title . '<br>';
echo 'Code : ' . $language->lang->code . '<br>';
echo 'Flag : ' . $language->lang->flag . '<br>';
echo 'Direction : ' . $language->lang->direction . '<br>';
echo 'Currency : ' . $language->lang->currency . '<br>';
echo 'Symbol : ' . $language->lang->symbol . '<br>';
echo 'Grouping separator : ' . $language->lang->grouping_separator . '<br>';
echo 'Decimal separator : ' . $language->lang->decimal_separator . '<br>';
echo 'Separator between amount and symbol : ' . $language->lang->separator . '<br>';
echo 'Show decimal : ' . $language->lang->show_decimal . '<br>';
echo 'Show symbol after amount : ' . $language->lang->symbol_after . '<br>';

Output:

Title : English
Code : en
Flag : gb
Direction : 0
Currency : GBP
Symbol : £
Grouping separator : ,
Decimal separator : .
Separator between amount and symbol : 1
Show decimal : 1
Show symbol after amount : 0

 

  • Like 9
  • Thanks 1

Share this post


Link to post
Share on other sites

Hello @ukyo.  This module is fantastic, on the level of a Pro Field.  Nicely done!

From what I can tell, it does not support multi-select options (multi-select, ASM Select, Checkboxes).  Is this a planned feature?

Share this post


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

Hello @ukyo.  This module is fantastic, on the level of a Pro Field.  Nicely done!

From what I can tell, it does not support multi-select options (multi-select, ASM Select, Checkboxes).  Is this a planned feature?

Upon further inspection, setting the 'type' to 'InputfieldAsmSelect' does work and does save properly.  Awesome.

  • Like 1

Share this post


Link to post
Share on other sites
7 hours ago, Jonathan Lahijani said:

Upon further inspection, setting the 'type' to 'InputfieldAsmSelect' does work and does save properly.  Awesome.

Nice to hear that.

Processing input field there is not special check for input field. https://github.com/trk/Mystique/blob/master/InputfieldMystique.module.php#L135

Little bit worked on a base field type (basically this field type will get entered field type's database schemas and will create 1 database table for all entered fields), if i success about this field type, i will try to use input field based checks.

For the moment getting and setting directly posted data.

  • Like 3

Share this post


Link to post
Share on other sites

First of all many thanks for the great Mystique Module.

I actually wanted to do something with Fieldset Group, but it's a ProModul so I've been looking for something similar. And I found Mystique. Could only do a few tests with it and then unfortunately made a PW update ...😭

Today I have PW3.0.140 installed and now the module does not work anymore. I am not a developer and can not determine the problem.😕

This is the output if I want to use the field:
Fatal Error: Uncaught Error: Call to a member function prepend() on null in /Applications/MAMP/htdocs/pw-pt/wire/core/Fields.php:1066
Stack trace:
#0 /Applications/MAMP/htdocs/pw-pt/wire/modules/Process/ProcessField/ProcessField.module(1412): ProcessWire\Fields->getCompatibleFieldtypes(Object(ProcessWire\Field))
#1 /Applications/MAMP/htdocs/pw-pt/wire/core/Wire.php(380): ProcessWire\ProcessField->___buildEditFormBasics()
#2 /Applications/MAMP/htdocs/pw-pt/wire/core/WireHooks.php(813): ProcessWire\Wire->_callMethod('___buildEditFor...', Array)
#3 /Applications/MAMP/htdocs/pw-pt/wire/core/Wire.php(442): ProcessWire\WireHooks->runHooks(Object(ProcessWire\ProcessField), 'buildEditFormBa...', Array)
#4 /Applications/MAMP/htdocs/pw-pt/wire/modules/Process/ProcessField/ProcessField.module(1020): ProcessWire\Wire->__call('buildEditFormBa...', Array)
#5 /Applications/MAMP/htdocs/pw-pt/wire/core/Wire.php(380): ProcessWire\ProcessField->___buildEditForm()
#6 /Applications/MAMP/htdocs/pw-pt/wire/core/WireHooks.php(813): ProcessWire\W (line 1066 of /Applications/MAMP/htdocs/pw-pt/wire/core/Fields.php)


I also have the version "next" v.0.0.6 installed but it comes to the same error.
Can someone help or does someone have the same problem?

Thank you 😊

---
I was looking for a solution and think the module SeoMaestro has a similar problem with the new Processwire DEV version:

https://processwire.com/talk/topic/20817-seomaestro/?do=findComment&comment=190656

Maybe this info helps a PW professional to solve the problem.

Share this post


Link to post
Share on other sites

@cosmo backup your project, grab the latest master release and make a downgrade. A quick fix for the time being. It's the same I did. 😉 

Share this post


Link to post
Share on other sites

Yes, that would be the fastest solution.

I've just started using Processwire, so it's not that tragic. But I had a nice project idea where I would like to use the new inputfield Toggle and Mystique. I hope for the PW professionals that they recognize the problem and make a PW or module update.

Share this post


Link to post
Share on other sites

@cosmo @wbmnfktr @next version is not fully working version. Use published version on module directory. If you want to try @next version, don't do it on live projects !

I will check @next version with latest processwire dev version.

  • Like 1

Share this post


Link to post
Share on other sites

It's not the @next version, but the latest version of Processwire 3.0.140 in combination with the Mystique Module. On my installation, both Mystique module versions do not work with Processwire 3.0.140.

Thank you for checking.

Share this post


Link to post
Share on other sites

I think thats PW core problem, see https://github.com/processwire/processwire-issues/issues/979

  • Like 1

Share this post


Link to post
Share on other sites

It works - thank you. Great how fast you have solved this.👍

I once used the example file "Example-Dive". Here is an image inputfield, how does it work? When I upload a picture, nothing happens.

Do you have any more practical examples or information for beginners?

  • Like 1

Share this post


Link to post
Share on other sites
18 hours ago, ukyo said:

@cosmo Some of fields (image, file fields) not supported.

OK - I almost thought so.

Anyway, your module is a very good timesafer. It also saves resources👍

  • Like 1

Share this post


Link to post
Share on other sites

Hi @ukyo,

I've just tried your module for the first time, but unfortunately it does not find any resources! This is the tracy dump:

PWaFGFU.png

Somehow the resources array is empty:

lrcMVym.png

I have the following files in my setup:

C:\laragon\www\kaum\site\modules\Mystique\configs\Mystique.example-dive.php
C:\laragon\www\kaum\site\templates\configs\Mystique.mystique.php

No matter what I try - the resources select is empty:

sxXg2TJ.png

I've even tried to do a $config->paths->normalizeSeparators() on the path without success (thought it might be a windows issue).

Thx for your help!

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 d'Hinnisdaël
      Happy new year, everybody 🥬
      I've been sitting on this Dashboard module I made for a client and finally came around to cleaning it up and releasing it to the wider public. This is how it looks.
      ProcessWire Dashboard

      If anyone is interested in trying this out, please go ahead! I'd love to get some feedback on it. If this proves useful and survives some real-world testing, I'll add this to the module directory.
      Download
      You can find the latest release on Github.
      Documentation
      Check out the documentation to get started. This is where you'll find information about included panel types and configuration options.
      Custom Panels
      My goal was to make it really simple to create custom panels. The easiest way to do that is to use the panel type template and have it render a file in your templates folder. This might be enough for 80% of all use cases. For anything more complex (FormBuilder submissions? Comments? Live chat?), you can add new panel types by creating modules that extend the DashboardPanel base class. Check out the documentation on custom panels or take a look at the HelloWorld panel to get started. I'm happy to merge any user-created modules into the main repo if they might be useful to more than a few people.
       Disclaimer
      This is a pre-release version. Please treat it as such — don't install it on production sites. Just making sure 🍇
      Roadmap
      These are the things I'm looking to implement myself at some point. The wishlist is a lot longer, but those are the 80/20 items that I probably won't regret spending time on.
      Improve documentation & add examples ⚙️ Panel types Google Analytics ⚙️ Add new page  🔥 Drafts 🔥 At a glance / Page counter 404s  Layout options Render multiple tabs per panel panel groups with heading and spacing between ✅ panel wrappers as grid item (e.g. stacked notices) ✅ Admin themes support AdminThemeReno and AdminThemeDefault ✅ Shortcuts panel add a table layout with icon, title & summary ✅ Chart panel add default styles for common chart types ✅ load chart data from JS file (currently passed as PHP array) Collection panel support image columns ✅ add buttons: view all & add new ✅
    • By Pip
      Hi everyone!
      I'm trying out the Login/Register module for my site. Noted that the module assigns the newly registered user to login-register role. 
      Once you modify the login-register role's permissions, particularly adding page-edit, the new member role will be set to guest. 
      Thing is I'd like to grant my new users the power to create their own pages. Any advice? 
      Thanks. 
    • 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 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/
×
×
  • Create New...