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 22
  • 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 David Karich
      ProcessWire InputfieldRepeaterMatrixDuplicate
      Thanks to the great ProModule "RepeaterMatrix" I have the possibility to create complex repeater items. With it I have created a quite powerful page builder. Many different content modules, with many more possible design options. The RepeaterMatrix module supports the cloning of items, but only within the same page. Now I often have the case that very design-intensive pages and items are created. If you want to use a content module on a different page (e.g. in the same design), you have to rebuild each item manually every time.
      This module extends the commercial ProModule "RepeaterMatrix" by the function to duplicate repeater items from one page to another page. The condition is that the target field is the same matrix field from which the item is duplicated. This module is currently understood as proof of concept. There are a few limitations that need to be considered. The intention of the module is that this functionality is integrated into the core of RepeaterMatrix and does not require an extra module.
      Check out the screencast
      What the module can do
      Duplicate multible repeater items from one page to another No matter how complex the item is Full support for file and image fields Multilingual support Support of Min and Max settings Live synchronization of clipboard between multiple browser tabs. Copy an item and simply switch the browser tab to the target page and you will immediately see the past button Support of multiple RepeaterMatrix fields on one page Configurable which roles and fields are excluded Configurable dialogs for copy and paste Duplicated items are automatically pasted to the end of the target field and set to hidden status so that changes are not directly published Automatic clipboard update when other items are picked Automatically removes old clipboard data if it is not pasted within 6 hours Delete clipboard itself by clicking the selected item again Benefit: unbelievably fast workflow and content replication What the module can't do
      Before an item can be duplicated in its current version, the source page must be saved. This means that if you make changes to an item and copy this, the old saved state will be duplicated Dynamic loading is currently not possible. Means no AJAX. When pasting, the target page is saved completely No support for nested repeater items. Currently only first level items can be duplicated. Means a repeater field in a repeater field cannot be duplicated. Workaround: simply duplicate the parent item Dynamic reloading and adding of repeater items cannot be registered. Several interfaces and events from the core are missing. The initialization occurs only once after the page load event Changelog
      2.0.0
      Feature: Copy multiple items at once! The fundament for copying multiple items was created by @Autofahrn - THX! Feature: Optionally you can disable the copy and/or paste dialog Bug fix: A fix suggestion when additional and normal repeater fields are present was contributed by @joshua - THX! 1.0.4
      Bug fix: Various bug fixes and improvements in live synchronization Bug fix: Items are no longer inserted when the normal save button is clicked. Only when the past button is explicitly clicked Feature: Support of multiple repeater fields in one page Feature: Support of repeater Min/Max settings Feature: Configurable roles and fields Enhancement: Improved clipboard management Enhancement: Documentation improvement Enhancement: Corrected few typos #1 1.0.3
      Feature: Live synchronization Enhancement: Load the module only in the backend Enhancement: Documentation improvement 1.0.2
      Bug fix: Various bug fixes and improvements in JS functions Enhancement: Documentation improvement Enhancement: Corrected few typos 1.0.1
      Bug fix: Various bug fixes and improvements in the duplication process 1.0.0
      Initial release Support this module
      If this module is useful for you, I am very thankful for your small donation: Donate 5,- Euro (via PayPal – or an amount of your choice. Thank you!)
      Download this module (Version 2.0.0)
      > Github: https://github.com/FlipZoomMedia/InputfieldRepeaterMatrixDuplicate
      > PW module directory: https://modules.processwire.com/modules/inputfield-repeater-matrix-duplicate/
      > Old stable version (1.0.4): https://github.com/FlipZoomMedia/InputfieldRepeaterMatrixDuplicate/releases/tag/1.0.4
    • By Robin S
      A new module that hasn't had a lot of testing yet. Please do your own testing before deploying on any production website.
      Custom Paths
      Allows any page to have a custom path/URL.
      Note: Custom Paths is incompatible with the core LanguageSupportPageNames module. I have no experience working with LanguageSupportPageNames or multi-language sites in general so I'm not in a position to work out if a fix is possible. If anyone with multi-language experience can contribute a fix it would be much appreciated!
      Screenshot

      Usage
      The module creates a field named custom_path on install. Add the custom_path field to the template of any page you want to set a custom path for. Whatever path is entered into this field determines the path and URL of the page ($page->path and $page->url). Page numbers and URL segments are supported if these are enabled for the template, and previous custom paths are managed by PagePathHistory if that module is installed.
      The custom_path field appears on the Settings tab in Page Edit by default but there is an option in the module configuration to disable this if you want to position the field among the other template fields.
      If the custom_path field is populated for a page it should be a path that is relative to the site root and that starts with a forward slash. The module prevents the same custom path being set for more than one page.
      The custom_path value takes precedence over any ProcessWire path. You can even override the Home page by setting a custom path of "/" for a page.
      It is highly recommended to set access controls on the custom_path field so that only privileged roles can edit it: superuser-only is recommended.
      It is up to the user to set and maintain suitable custom paths for any pages where the module is in use. Make sure your custom paths are compatible with ProcessWire's $config and .htaccess settings, and if you are basing the custom path on the names of parent pages you will probably want to have a strategy for updating custom paths if parent pages are renamed or moved.
      Example hooks to Pages::saveReady
      You might want to use a Pages::saveReady hook to automatically set the custom path for some pages. Below are a couple of examples.
      1. In this example the start of the custom path is fixed but the end of the path will update dynamically according to the name of the page:
      $pages->addHookAfter('saveReady', function(HookEvent $event) { $page = $event->arguments(0); if($page->template == 'my_template') { $page->custom_path = "/some-custom/path-segments/$page->name/"; } }); 2. The Custom Paths module adds a new Page::realPath method/property that can be used to get the "real" ProcessWire path to a page that might have a custom path set. In this example the custom path for news items is derived from the real ProcessWire path but a parent named "news-items" is removed:
      $pages->addHookAfter('saveReady', function(HookEvent $event) { $page = $event->arguments(0); if($page->template == 'news_item') { $page->custom_path = str_replace('/news-items/', '/', $page->realPath); } }); Caveats
      The custom paths will be used automatically for links created in CKEditor fields, but if you have the "link abstraction" option enabled for CKEditor fields (Details > Markup/HTML (Content Type) > HTML Options) then you will see notices from MarkupQA warning you that it is unable to resolve the links.
      Installation
      Install the Custom Paths module.
      Uninstallation
      The custom_path field is not automatically deleted when the module is uninstalled. You can delete it manually if the field is no longer needed.
       
      https://github.com/Toutouwai/CustomPaths
      https://modules.processwire.com/modules/custom-paths/
    • By teppo
      Hey folks!
      I'm happy to finally introduce a project I've been working on for quite a while now: it's called Wireframe, and it is an output framework for ProcessWire.
      Note that I'm posting this in the module development area, maily because this project is still in rather early stage. I've built a couple of sites with it myself, and parts of the codebase have been powering some pretty big and complex sites for many years now, but this should still be considered a soft launch 🙂
      --
      Long story short, Wireframe is a module that provides the "backbone" for building sites (and apps) with ProcessWire using an MVC (or perhaps MVVM... one of those three or four letter acronyms anyway) inspired methodology. You could say that it's an output strategy, but I prefer the term "output framework", since in my mind the word "strategy" means something less tangible. A way of doing things, rather than a tool that actually does things.
      Wireframe (the module) provides a basic implementation for some familiar MVC concepts, such as Controllers and a View layer – the latter of which consists of layouts, partials, and template-specific views. There's no "model" layer, since in this context ProcessWire is the model. As a module Wireframe is actually quite simple – not even nearly the biggest one I've built – but there's still quite a bit of stuff to "get", so I've put together a demo & documentation site for it at https://wireframe-framework.com/.
      In addition to the core module, I'm also working on a couple of site profiles based on it. My current idea is actually to keep the module very light-weight, and implement most of the "opinionated" stuff in site profiles and/or companion modules. For an example MarkupMenu (which I released a while ago) was developed as one of those "companion modules" when I needed a menu module to use on the site profiles.
      Currently there are two public site profiles based on Wireframe:
      site-wireframe-docs is the demo&docs site mentioned above, just with placeholder content replaced with placeholder content. It's not a particularly complex site, but I believe it's still a pretty nice way to dig into the Wireframe module. site-wireframe-boilerplate is a boilerplate (or starter) site profile based on the docs site. This is still very much a work in progress, but essentially I'm trying to build a flexible yet full-featured starter profile you can just grab and start building upon. There will be a proper build process for resources, it will include most of the basic features one tends to need from site to site, etc. --
      Requirements and getting started:
      Wireframe can be installed just like any ProcessWire module. Just clone or download it to your site/modules/ directory and install. It doesn't, though, do a whole lot of stuff on itself – please check out the documentation site for a step-by-step guide on setting up the directory structure, adding the "bootstrap file", etc. You may find it easier to install one of the site profiles mentioned above, but note that this process involves the use of Composer. In the case of the site profiles you can install ProcessWire as usual and download or clone the site profile directory into your setup, but after that you should run "composer install" to get all the dependencies – including the Wireframe module – in place. Hard requirements for Wireframe are ProcessWire 3.0.112 and PHP 7.1+. The codebase is authored with current PHP versions in mind, and while running it on 7.0 may be possible, anything below that definitely won't work. A feature I added just today to the Wireframe module is that in case ProcessWire has write access to your site/templates/ directory, you can use the module settings screen to create the expected directories automatically. Currently that's all, and the module won't – for an example – create Controllers or layouts for you, so you should check out the site profiles for examples on these. (I'm probably going to include some additional helper features in the near future.)
      --
      This project is loosely based on an earlier project called pw-mvc, i.e. the main concepts (such as Controllers and the View layer) are very similar. That being said, Wireframe is a major upgrade in terms of both functionality and architecture: namespaces and autoloader support are now baked in, the codebase requires PHP 7, Controllers are classes extending \Wireframe\Controller (instead of regular "flat" PHP files), implementation based on a module instead of a collection of drop-in files, etc.
      While Wireframe is indeed still in a relatively early stage (0.3.0 was launched today, in case version numbers matter) for the most part I'm happy with the way it works, and likely won't change it too drastically anytime soon – so feel free to give it a try, and if you do, please let me know how it went. I will continue building upon this project, and I am also constantly working on various side projects, such as the site profiles and a few unannounced helper modules.
      I should probably add that while Wireframe is not hard to use, it is more geared towards those interested in "software development" type methodology. With future updates to the module, the site profiles, and the docs I hope to lower the learning curve, but certain level of "developer focus" will remain. Although of course the optimal outcome would be if I could use this project to lure more folks towards that end of the spectrum... 🙂
      --
      Please let me know what you think – and thanks in advance!
    • By tcnet
      PageViewStatistic for ProcessWire is a module to log page visits of the CMS. The records including some basic information like IP-address, browser, operating system, requested page and originate page. Please note that this module doesn't claim to be the best or most accurate.
      Advantages
      One of the biggest advantage is that this module doesn't require any external service like Google Analytics or similar. You don't have to modify your templates either. There is also no JavaScript or image required.
      Disadvantages
      There is only one disadvantage. This module doesn't record visits if the browser loads the page from its browser cache. To prevent the browser from loading the page from its cache, add the following meta tags to the header of your page:
      <meta http-equiv="Cache-Control" content="no-cache, no-store, must-revalidate" /> <meta http-equiv="Pragma" content="no-cache" /> <meta http-equiv="Expires" content="0" /> How to use
      The records can be accessed via the Setup-menu of the CMS backend. The first dropdown control changes the view mode. There are 4 different view modes.
      View mode "Day" shows all visits of the selected day individually with IP-address, browser, operating system, requested page and originate page. Click the update button to see new added records. View mode "Month" shows the total of all visitors per day from the first to the last day of the selected month. View mode "Year" shows the total of all visitors per month from the first to the last month of the selected year. View mode "Total" shows the total of all visitors per year for all recorded years. Please note that multiple visits from the same IP address within the selected period are counted as a single visitor.
      Settings
      You can access the module settings by clicking the Configuration button at the bottom of the records page. The settings page is also available in the menu: Modules->Configure->ProcessPageViewStat.
      IP2Location
      This module uses the IP2Location database from: http://www.ip2location.com. This database is required to obtain the country from the IP address. IP2Location updates this database at the begin of every month. The settings of ProcessPageViewStat offers the ability to automatically download the database monthly. Please note, that automatically download will not work if your webspace doesn't allow allow_url_fopen.
      Dragscroll
      This module uses DragScroll. A JavaScript available from: http://github.com/asvd/dragscroll. Dragscroll adds the ability in view mode "Day" to drag the records horizontally with the mouse pointer.
      parseUserAgentStringClass
      This module uses the PHP class parseUserAgentStringClass available from: http://www.toms-world.org/blog/parseuseragentstring/. This class is required to filter out the browser type and operating system from the server request.
      Special Feature
      PageViewStatistic for ProcessWire can record the time a visitor viewed the page. This feature is deactivated by default. To activate open the module configuration page and activate "Record view time". If activated you will find a new column "S." in the records which means the time of view in seconds. With every page request, a Javascript code is inserted directly after the <body> tag. Every time the visitor switches to another tab or closes the tab, this script reports the number of seconds the tab was visible. The initial page request is recorded only as a hyphen (-).
       
    • By MoritzLost
      This module allows you to integrate hCaptcha bot / spam protection into ProcessWire forms. hCaptcha is a great alternative to Google ReCaptcha, especially if you are in the EU and need to comply with privacy regulations.

      The development of this module is sponsored by schwarzdesign.
      The module is built as an Inputfield, allowing you to integrate it into any ProcessWire form you want. It's primarily intended for frontend forms and can be added to Form Builder forms for automatic spam protection. There's a step-by-step guide for adding the hCaptcha widget to Form Builder forms in the README, as well as instructions for API usage.
      Features
      Inputfield that displays an hCaptcha widget in ProcessWire forms. The inputfield verifies the hCaptcha response upon submission, and adds a field error if it is invalid. All hCaptcha configuration options for the widget (theme, display size etc) can be changed through the inputfield configuration, as well as programmatically. hCaptcha script options can be changed through a hook. Error messages can be translated through ProcessWire's site translations. hCaptcha secret keys and site-keys can be set for each individual inputfield or globally in your config.php. Error codes and failures are logged to help you find configuration errors. Please check the README for setup instructions.
      Links
      Github Repository and documentation InputfieldHCaptcha in the module directory Screenshots (configuration)

      Screenshots (hCaptcha widget)

       
       

       
×
×
  • Create New...