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.

// Add your custom path inside ready or init function, didn't tested outside
Mystique::add('your-configs-path');

All config files need to return a php array like examples.

Same as ProcessWire Inputfield Api, only difference is set and showIf usage
<?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 18
  • 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

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.

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.

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 1

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 8
  • 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.

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 2

Share this post


Link to post
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.


  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By teppo
      This module tracks changes, additions, removals etc. of public (as in "not under admin") pages of your site. Like it's name says, it doesn't attempt to be a version control system or anything like that - just a log of what's happened.
      At the moment it's still a work in progress and will most likely be a victim of many ruthless this-won't-work-let's-try-that-instead cycles, but I believe I've nailed basic functionality well enough to post it here.. so, once again, I'll be happy to hear any comments you folks can provide
      https://modules.processwire.com/modules/process-changelog/
      https://github.com/teppokoivula/ProcessChangelog
      How does it work?
      Exactly like it's (sort of) predecessor, Process Changelog actually consists of two modules: Process Changelog and Process Changelog Hooks. Hooks module exists only to serve main module by hooking into various functions within Pages class, collecting data of performed operations, refining it and keeping up a log of events in it's own custom database table (process_changelog.) Visible part is managed by Process Changelog, which provides users a (relatively) pretty view of the contents of said log table.
      How do you use it?
      When installed this module adds new page called Changelog under Admin > Setup which provides you with a table view of collected data and basic filtering tools See attached screenshots to get a general idea about what that page should look like after a while.
      For detailed installation instructions etc. see README.md.
       


    • By Gadgetto
      Status update links (inside this thread) for SnipWire development will be always posted here:
      2019-08-08
      2019-06-15
      2019-06-02
      2019-05-25
      If you are interested, you can test the current state of development:
      https://github.com/gadgetto/SnipWire
      Please note that the software is not yet intended for use in a production system (alpha version).
      If you like, you can also submit feature requests and suggestions for improvement. I also accept pull requests.
      ---- INITIAL POST FROM 2019-05-25 ----
      I wanted to let you know that I am currently working on a new ProcessWire module that fully integrates the Snipcart Shopping Cart System into ProcessWire. (this is a customer project, so I had to postpone the development of my other module GroupMailer).
      The new module SnipWire offers full integration of the Snipcart Shopping Cart System into ProcessWire.
      Here are some highlights:
      simple setup with (optional) pre-installed templates, product fields, sample products (quasi a complete shop system to get started immediately) store dashboard with all data from the snipcart system (no change to the snipcart dashboard itself required) Integrated REST API for controlling and querying snipcart data webhooks to trigger events from Snipcart (new order, new customer, etc.) multi currency support self-defined/configurable tax rates etc. Development is already well advanced and I plan to release the module in the next 2-3 months.
      I'm not sure yet if this will be a "Pro" module or if it will be made available for free.
      I would be grateful for suggestions and hints!
      (please have a look at the screenshots to get an idea what I'm talking about)
       




    • By apeisa
      Update 31.7.2019: AdminBar is now maintained by @teppo. Modules directory entry has been updated, as well as the "grab the code" link below.
      ***
      Latest screencast: http://www.screencas...73-ab3ba1fea30c
      Grab the code: https://github.com/teppokoivula/AdminBar
      ***
      I put this Adminbar thingy (from here: http://processwire.c...topic,50.0.html) to modules section and to it's own topic.
      I recorded quick and messy screencast (really, my first screencast ever) to show what I have made so far. You can see it from here: http://www.screencas...18-1bc0d49841b4
      When the modal goes off, I click on the "dark side". I make it so fast on screencast, so it might seem a little bit confusing. Current way is, that you can edit, go back to see the site (without saving anything), continue editing and save. After that you still have the edit window, but if you click "dark side" after saving, then the whole page will be reloaded and you see new edits live.
      I am not sure if that is best way: there are some strengths in this thinking, but it is probably better that after saving there shouldn't be a possibility to continue editing. It might confuse because then if you make edits, click on dark side -> *page refresh* -> You lose your edits.
      ***
      When I get my "starting module" from Ryan, I will turn this into real module. Now I had to make some little tweaks to ProcessPageEdit.module (to keep modal after form submits). These probably won't hurt anything:
      if($this->redirectUrl) $this->session->redirect($this->redirectUrl); if(!empty($_GET['modal'])) $this->session->redirect("./?id={$this->page->id}&modal=true"); // NEW LINE else $this->session->redirect("./?id={$this->page->id}");   and...
      if(!empty($_GET['modal'])) { $form->attr('action', './?id=' . $this->id . '&modal=true'); } else { $form->attr('action', './?id=' . $this->id); // OLD LINE }  
    • By Mike Rockett
      Jumplinks for ProcessWire
      Release: 1.5.54
      Composer: rockett/jumplinks
      Jumplinks is an enhanced version of the original ProcessRedirects by Antti Peisa.
      The Process module manages your permanent and temporary redirects (we'll call these "jumplinks" from now on, unless in reference to redirects from another module), useful for when you're migrating over to ProcessWire from another system/platform. Each jumplink supports wildcards, shortening the time needed to create them.
      Unlike similar modules for other platforms, wildcards in Jumplinks are much easier to work with, as Regular Expressions are not fully exposed. Instead, parameters wrapped in curly braces are used - these are described in the documentation.
      Under Development: 2.0, to be powered by FastRoute
      As of version 1.5.0, Jumplinks requires at least ProcessWire 2.6.1 to run.
      View on GitLab
      Download via the Modules Directory
      Read the docs
      Features
      The most prominent features include:
      Basic jumplinks (from one fixed route to another) Parameter-based wildcards with "Smart" equivalents Mapping Collections (for converting ID-based routes to their named-equivalents without the need to create multiple jumplinks) Destination Selectors (for finding and redirecting to pages containing legacy location information) Timed Activation (activate and/or deactivate jumplinks at specific times) 404-Monitor (for creating jumplinks based on 404 hits) Additionally, the following features may come in handy:
      Stale jumplink management Legacy domain support for slow migrations An importer (from CSV or ProcessRedirects) Feedback & Feature Requests
      I’d love to know what you think of this module. Please provide some feedback on the module as a whole, or even regarding smaller things that make it whole. Also, please feel free to submit feature requests and their use-cases.
      Note: Features requested so far have been added to the to-do list, and will be added to 2.0, and not the current dev/master branches.
      Open Source

      Jumplinks is an open-source project, and is free to use. In fact, Jumplinks will always be open-source, and will always remain free to use. Forever. If you would like to support the development of Jumplinks, please consider making a small donation via PayPal.
      Enjoy! :)
×
×
  • Create New...