Jump to content
Chris Bennett

[SOLVED] How/can you add/append InputfieldWrapper to api generated Fieldgroup used as template for page?

Recommended Posts

Hi all, I am going round and round in circles and would greatly appreciate if anyone can point me in the right direction.
I am sure¬†I am doing something dumb, or missing something I should know, but don't. Story of my life¬†ūüėČ

Playing round with a module and my basic problem is I want to upload an image and also use InputfieldMarkup and other Inputfields.
Going back and forth between trying an api generated page defining Fieldgroup, Template, Fields, Page and the InputfieldWrapper method.

InputfieldWrapper method works great for all the markup stuff, but I just can't wrap my head around what I need to do to save the image to the database.
Can generate a Field for it (thanks to the api investigations) but not sure what I need to do to link the Inputfield to that. Tried a lot of stuff from various threads, of varying dates without luck.
Undoubtedly not helped by me not knowing enough.

Defining Fieldgroup etc through the api seems nice and clean and works great for the images but I can't wrap my head around how/if I can add/append/hook the InputfieldWrapper/InputfieldMarkup stuff I'd like to include on that template as well. Not even sure if it should be where it is on ___install with the Fieldtype stuff or later on . Not getting Tracy errors, just nothing seems to happen.

If anyone has any ideas or can point me in the right direction, that would be great because at the moment I am stumbling round in the dark.
 

public function ___install() { 
			
		parent::___install();		
        $page = $this->pages->get('name='.self::PAGE_NAME);
		
		if (!$page->id) {

		    // Create fieldgroup, template, fields and page
		
		    // Create new fieldgroup
            $fmFieldgroup               = new Fieldgroup();
            $fmFieldgroup->name         = MODULE_NAME.'-fieldgroup';
            $fmFieldgroup->add($this->fields->get('title')); // needed title field
            $fmFieldgroup->save();

            // Create new template using the fieldgroup
            $fmTemplate                   = new Template();
            $fmTemplate->name             = MODULE_NAME;
            $fmTemplate->fieldgroup       = $fmFieldgroup;
		    $fmTemplate->noSettings       = 1;
            $fmTemplate->noChildren       = 1;
            $fmTemplate->allowNewPages    = 0;
            $fmTemplate->tabContent       = MODULE_NAME;
            $fmTemplate->noChangeTemplate = 1;
		    $fmTemplate->setIcon(ICON);	
			
            $fmTemplate->save();
            			
			// Favicon source
            $fmField                      = new Field();
            $fmField->type                = $this->modules->get("FieldtypeImage"); 
            $fmField->name                = 'fmFavicon';
            $fmField->label               = 'Favicon';
            $fmField->focusMode           = 'off';
			$fmField->gridMode            = 'grid';
            $fmField->extensions          = 'svg png';
            $fmField->columnWidth         = 50;
            $fmField->collapsed           = Inputfield::collapsedNever;
		    $fmField->setIcon(ICON);
            $fmField->addTag(MODULE_NAME);
			$fmField->save();
			
			$fmFieldgroup->add($fmField);
			
			// Favicon Silhouette source
            $fmField                      = new Field();
            $fmField->type                = $this->modules->get("FieldtypeImage"); 
            $fmField->name                = 'fmFaviconSilhouette';
            $fmField->label               = 'SVG Silhouette';
			$fmField->notes               = 'When creating a silhouette/mask svg version for Safari Pinned Tabs and  Windows Tiles, we recommend setting your viewbox for 0 0 16 16, as this is what Apple requires.

In many cases, the easiest way to do this in something like illustrator is a sacrificial rectangle with no fill, and no stroke at 16 x 16. This forces the desired viewbox and can then be discarded easily using something as simple as notepad. Easy is good, especially when you get the result you want without a lot of hassle.';
            $fmField->focusMode           = 'off';
            $fmField->extensions          = 'svg';
            $fmField->columnWidth         = 50;
            $fmField->collapsed           = Inputfield::collapsedNever;
		    $fmField->setIcon(ICON);
            $fmField->addTag(MODULE_NAME);
            $fmField->save();

			$fmFieldgroup->add($fmField);		
			
			// Create: Open Settings Tab
			$tabOpener = new Field();
            $tabOpener->type = new FieldtypeFieldsetTabOpen();
            $tabOpener->name = 'fmTab1';
            $tabOpener->label = "Favicon Settings";
            $tabOpener->collapsed  = Inputfield::collapsedNever;
            $tabOpener->addTag(MODULE_NAME);
            $tabOpener->save();
            // Create: Close Settings Tab				
            $tabCloser = new Field();
            $tabCloser->type = new FieldtypeFieldsetClose;
            $tabCloser->name = 'fmTab1' . FieldtypeFieldsetTabOpen::fieldsetCloseIdentifier;
            $tabCloser->label = "Close open tab";
            $tabCloser->addTag(MODULE_NAME);
            $tabCloser->save();
			// Create: Opens wrapper for Favicon Folder Name
            $filesOpener = new Field();
            $filesOpener->type            = new FieldtypeFieldsetOpen();
			$filesOpener->name            = 'fmOpenFolderName';
            $filesOpener->label           = 'Wrap Folder Name';
            $filesOpener->class           = 'inline';
			$filesOpener->collapsed       = Inputfield::collapsedNever;
			$filesOpener->addTag(MODULE_NAME);
            $filesOpener->save();
			// Create: Close wrapper for Favicon Folder Name
			$filesCloser                 = new Field();
            $filesCloser->type           = new FieldtypeFieldsetClose();
            $filesCloser->name           = 'fmOpenFolderName' . FieldtypeFieldsetOpen::fieldsetCloseIdentifier;
            $filesCloser->label          = "Close open fieldset";
            $filesCloser->addTag(MODULE_NAME);
            $filesCloser->save();
			
			// Create Favicon Folder Name
            $fmField                      = new Field();
            $fmField->type                = $this->modules->get("FieldtypeText"); 
            $fmField->name                = 'folderName';
            $fmField->label               = 'Favicon Folder:';
            $fmField->description         = $this->config->urls->files;
            $fmField->placeholder         = 'Destination Folder for your generated favicons, webmanifest and browserconfig';
            $fmField->columnWidth         = 100;
            $fmField->collapsed           = Inputfield::collapsedNever;
		    $fmField->setIcon('folder');
            $fmField->addTag(MODULE_NAME);
			$fmField->save();
			
            $fmFieldgroup->add($tabOpener);
			    $fmFieldgroup->add($filesOpener);
			        $fmFieldgroup->add($fmField);
			    $fmFieldgroup->add($filesCloser);
            $fmFieldgroup->add($tabCloser);
			
			$fmFieldgroup->save();
			 
			
			///////////////////////////////////////////////////////////////
			
            // Experimental Markup Tests
				
		$wrapperFaviconMagic = new InputfieldWrapper();
		$wrapperFaviconMagic->attr('id','faviconMagicWrapper');
		$wrapperFaviconMagic->attr('title',$this->_('Favicon Magic'));
		
			    // field show info what
	    $field = $this->modules->get('InputfieldMarkup');
	    $field->name = 'use';
	    $field->label = __('How do I use it?');
	    $field->collapsed = Inputfield::collapsedNever;
	    $field->icon('info');
        $field->attr('value', 'Does this even begin to vaguely work?');
	    $field->columnWidth = 50;

		
		$wrapperFaviconMagic->add($field);		
				
		$fmTemplate->fields->add($wrapperFaviconMagic);
        $fmTemplate->fields->save();
			
			/////////////////////////////////////////////////////////////
			
            // Create page
            $page = $this->wire( new Page() );
            $page->template = MODULE_NAME;
            $page->parent = $this->wire('pages')->get('/');
            $page->addStatus(Page::statusHidden);
            $page->title = 'Favicons';
            $page->name = self::PAGE_NAME;
            $page->process = $this;
            $page->save();
	   
	    }
	}	

 

Edited by Chris Bennett
Marked as Solved

Share this post


Link to post
Share on other sites

Might this discussion help?

Also, it might be useful to say what the overall purpose of your module is.

  • Like 1

Share this post


Link to post
Share on other sites

Many thanks @BillH, I will certainly investigate that thread further, it expands on some of the snippets I tried unsuccessfully along the way.

In the meantime, I lucked upon the thread below, thanks to Bernard posting, which got me a lot further along the path. 
Still experimenting, with a fair degree of success so far, but not yet ready to claim it is "solved". Enjoying learning more as I go.

Module I am playing around with - mainly to force myself to learn more about how everything really works - is an attempt to recreate what I am already using (via normal admin page, a couple of fields with a nifty preview/review using RuntimeMarkup and a couple of php templates).

It generates favicons from svg right the way through (unlike realfavicongenerator), with a fallback for pngs and all the necessary markup, manifest, browserconfig etc.

Similar to realfavicongenerator (which I have long loved), but tweaked according to my personal wishlist.
Could accomplish what is *needed* pretty easily, but would really like to add some polish for clients.
Also so they can easily see what we have done¬†and/or do that stuff themselves¬†ūüėČ

The php templates I am currently using simply by accessing the normal hidden admin page automatically generate: 

  • svg favicons for current gen browsers (if svg source provided)
  • black safari pinned tab mask icon and white¬†mstiles¬†(if svg silhouette provided)
  • automatic mask icon with required safe space for webmanifest
  • automatic cropping of svgs/pngs so small icons can use the whole 16x16 or 32 x32 - because 3 or 4 px makes a big difference when you only start with 16
  • generation of webmanifest and browserconfig
  • frontend markup for inclusion that basically just checks if the right file exists and plonks in the correct markup if it does

Was a little surprised it seemed to work well.
No zip files, no code, no third parties, plonk new sources in, click generate new, check results and done. 

Lots more previews/config options I could/will add but figured it might be wise to work out any inevitable kinks with implementation of a module along these lines within the api before I got carried away too much more. 

 

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 totoff
      Dear all,
      I'm upgrading an older side with the new custom fields for images feature as of 3.0.142. My image field is set to "Automatic" and holds a bunch of images together with their respective description on each page. New custom fields include "caption" among others and to make my live easier I I'm trying to populate "caption" with the value from the (default) description field. But unfortunately I can't seem to find out how to save the newly set values. This is my code:
      <?php foreach (page()->images as $image) { $image->set('caption', $image->description); bd($image->caption); echo files()->render("markup/views/view-card-image-fancybox.php", array('image'=>$image)); } ?> <?php $page->save(); bd($page->save()); ?> This sets the value as intended (see screenshot) but doesn't save it permanently to the database. What am I doing wrong?
      Thanks!
       

    • By jploch
      Hey folks,
      for a module (a pagebuilder based on PageTable) I need to save some settings as JSON. The values are saved for each page table item (a pw page). It's working well, but I am looking for ways to improve the structure I have. As I'm not that experienced with JSON, maybe someone more experienced can take a look and tell me if my approach is good practice. 

      My goal is to make all the items accessible by page id, without looping over them (using objects instead of arrays):
      // access from template with pw page var $jsonObject->items->{$page}->cssClass; Her is an example of my JSON structure:
      { "items": { "3252": { "id": "3252", "cssClass": "pgrid-main", "breakpoints": { "base": { "css": { "grid-column-end": "auto", "grid-row-end": "auto", "grid-column-start": "auto", "grid-row-start": "auto", "align-self": "auto", "z-index": "auto", "padding-left": "60px", "padding-right": "60px", "padding-top": "60px", "padding-bottom": "60px", "background-color": "rgb(255, 255, 255)", "color": "rgb(0, 0, 0)" }, "size": "@media (min-width: 576px)", "name": "base" } } }, "3686": { "id": "3686", "cssClass": "test_global", "breakpoints": { "base": { "css": { "grid-column-end": "-1", "grid-row-end": "span 1", "grid-column-start": "1", "grid-row-start": "auto", "align-self": "auto", "z-index": "auto", "padding-left": "0px", "padding-right": "0px", "padding-top": "0px", "padding-bottom": "0px", "background-color": "rgba(0, 0, 0, 0)", "color": "rgb(0, 0, 0)" }, "size": "@media (min-width: 576px)", "name": "base" } } }, "3687": { "id": "3687", "cssClass": "block_editor-3687", "breakpoints": { "base": { "css": { "grid-column-end": "span 2", "grid-row-end": "span 1", "grid-column-start": "auto", "grid-row-start": "auto", "align-self": "auto", "z-index": "auto", "padding-left": "0px", "padding-right": "0px", "padding-top": "0px", "padding-bottom": "0px", "background-color": "rgba(0, 0, 0, 0)", "color": "rgb(0, 0, 0)" }, "size": "@media (min-width: 576px)", "name": "base" } } }, "3696": { "id": "3696", "cssClass": "block_editor-3696", "breakpoints": { "base": { "css": { "grid-column-end": "span 2", "grid-row-end": "span 1", "grid-column-start": "auto", "grid-row-start": "auto", "align-self": "auto", "z-index": "auto", "padding-left": "0px", "padding-right": "0px", "padding-top": "0px", "padding-bottom": "0px", "background-color": "rgba(0, 0, 0, 0)", "color": "rgb(0, 0, 0)" }, "size": "@media (min-width: 576px)", "name": "base" } } } }, "breakpointActive": "base", "breakpointActiveSize": "@media (min-width: 576px)" }  
    • By jploch
      Fieldtype Page Table Grid
      This is a sneak preview of a side project I've been working on for quite some time now. A lot of work and thought has gone into this, so I will most likely release this as a commercial module at some point in the near future. 

      As a designer (and developer) I get the appeal of a WYSIWYG editor. After playing around with some WYSIWYG page builder tools, I always felt something was wrong about them. So I decided to build my own PW version based on PageTable.

      Here is a small demo (using AdminThemeCanvas, but its working with other admin themes as well) :
      There is also a complete website that I built for a friend of mine using this module and some custom blocks.
      Concept
      This fieldtype shares a lot of features with PageTableExtended: it's also an extension of PageTable and renders the block templates in the backend and frontend (native PW templates and fields). You can also add your own css via module settings.
      The difference is, this fieldtype also gives you the ability to rearrange and resize elements in a visual way as well as enable inline editing for text, ckeditor and file fields. Similar (and promising) attempts have been made, but I wanted something based on native CSS grid instead of a CSS framework...so I built my own version. Most CSS frameworks are based on flexbox, which is great for layouting elements horizontally. With CSS grid, you can place elements horizontally and vertically, allowing for layouts that were not previously possible with CSS. Similar to webflow, this fieldtype uses javascript (in the backend) to let you manipulate CSS grid in a visual way to design fully responsive websites (or parts of them). It should still be possible to include a CSS framework if you like (just add the classes to your block markup and include the CSS via module settings).
      The CSS grid layout manipulations are saved in a single field as a JSON array and used to generate a dynamic stylesheet that you simply include in your main template (no inline styles). The styles are saved within the breakpoint you select and cascade down to smaller breakpoints. That means you can specify just the basic breakpoint and adjust other breakpoints if needed. The exception is the mobile breakpoint which will display everything in one column as a default (you can change the layout here too).
      The fieldtype also comes with an optional style panel to manipulate some additional CSS properties directly on the page. You can customize the panel or disable it completely from the module settings (and just use a CSS file that you include via module settings). The style panel is based on inputfields (nothing is saved to the database). This means that you just have to install the module and all fields are available to all blocks automatically (this can be customized). It also has the benefit that your installation is not flooded with fields; this module only installs one field.
      Don't want to give your customer all that power? Design features can be disabled for certain roles. The grid editor role can just edit the content and use the inline editing feature to edit content quickly. You can then also grant access individually to the style panel, resize or drag functionality.
      Features
      Blocks are just pages Blocks are defined by native PW templates and fields Manipulate CSS grid in a visual way to design fully responsive websites (or parts of them) Design features can be disabled for certain roles Inline editing of text, ckeditor and file fields The layout is 100% CSS grid (very small css file size) Simply drag and resize to manipulate grid items directly inside the backend Manipulate grid columns and rows directly on the page (use any number of columns you want) All style manipulations are saved as JSON and used to generate a dynamic stylesheet that you just include in your main template (no inline styles) Nested groups/grids (child pages of nested blocks are created under group parent) Global blocks work with page reference field (changes on one page, changes all blocks on all pages) Manual and auto placement of grid items Define custom icons for your blocks via native template settings (template -> advanced -> icon) Option to load lazysizes in the backend to enable lazy loading of assets with class lazyload Works with all default and ui-kit based admin themes If you have any questions or feedback, let me know.
    • By bernhard
      I built this module because I needed a versatile solution to replace tags and simple if-blocks in some E-Mails and PDF documents.
      If you only need to replace static tags (no if-conditions), then you can use default PW api and need no module:
      $str = "My favourite color is {color}."; $texttools = $sanitizer->getTextTools(); echo $texttools->populatePlaceholders($str, ['color' => 'red']); // output: My favourite color is red. Usage:
      See the two example Files in the folder /replacements

       
      Methods:
      replacementsTable()
      Renders an overview of all available replacements (see the example in the Module's config file:
       
      Create new Replacements:
      Simply copy the sample file and adopt to your needs.
       
      Download:
      https://gitlab.com/baumrock/RockReplacer
    • By bernhard
      DEPRECATED
      I'm using this module in several projects, but it will likely not see any updates in the future. I'm not happy with it and I'm looking for ways to develop better solutions. RockTabulator was my first try, but I'm also not 100% happy with that. The tabulator library is great, but my module implementation is not. I hope to get a good solution soon, but it will be a lot of work...
      ---
      Some of you might have followed the development of this module here: https://processwire.com/talk/topic/15524-previewdiscussion-rockdatatables/ . It is the successor of "RockDataTables" and requires RockFinder to get the data for the grid easily and efficiently. It uses the open source part of agGrid for grid rendering.
       
      WHY?
      ProcessWire is awesome for creating all kinds of custom backend applications, but where it is not so awesome in my opinion is when it comes to listing this data. Of course we have the built in page lister and we have ListerPro, but none of that solutions is capable of properly displaying large amounts of data, for example lists of revenues, aggregations, quick and easy sorts by the user, instant filter and those kind of features. RockGrid to the rescue ūüėȬ†
       
      Features/Highlights:
      100k+ rows Instant (client side) filter, search, sort (different sort based on data type, eg "lower/greater than" for numbers, "contains" for strings) extendable via plugins (available plugins at the moment: fullscreen, csv export, reload, batch-processing of data, column sum/statistics, row selection) all the agGrid features (cell renderers, cell styling, pagination, column grouping etc) vanilla javascript, backend and frontend support (though not all plugins are working on the frontend yet and I don't plan to support it as long as I don't need it myself)  
      Limitations:
      While there is an option to retrieve data via AJAX the actual processing of the grid (displaying, filtering, sorting) is done on the client side, meaning that you can get into troubles when handling really large datasets of several thousands of rows. agGrid should be one of the most performant grid options in the world (see the official example page with a 100k row example) and does a lot to prevent problems (such as virtual row rendering), but you should always have this limitation in mind as this is a major difference to the available lister options that do not have this limitation.
      Currently it only supports AdminThemeUikit and I don't plan to support any other admin theme.
       
      Download: https://gitlab.com/baumrock/FieldtypeRockGrid
      Installation: https://gitlab.com/baumrock/RockGrid/wikis/Installation
      Quikckstart: https://gitlab.com/baumrock/RockGrid/wikis/quickstart
      Further instructions: https://gitlab.com/baumrock/RockGrid/wikis/quickstart#further-instructions
      German Translation File: site--modules--fieldtyperockgrid--fieldtyperockgrid-module-php.json
      Changelog: https://gitlab.com/baumrock/FieldtypeRockGrid/raw/master/changelog.md
       
      Module status: alpha, License: MIT
      Note that every installation and uninstallation sends an anonymous google analytics event to my google analytics account. If you don't want that feel free to remove the appropriate lines of code before installation/uninstallation.
       
      Contribute:
      You can contribute to the development of this and other modules or just say thank you by
      testing, reporting issues and making PRs at gitlab liking this post buying me a drink: paypal.me/baumrock/5 liking my facebook page: facebook.com/baumrock hiring me for pw work: baumrock.com  
      Support: Please note that this module might not be as easy and plug&play as many other modules. It needs a good understanding of agGrid (and JavaScript in general) and it likely needs some looks into the code to get all the options. Please understand that I can not provide free support for every request here in the forum. I try to answer all questions that might also help others or that might improve the module but for individual requests I offer paid support (please contact me via PM).
       
      Use Cases / Examples:
      Colored grid cells, Icons, Links etc. The Grid also has a "batcher" feature built in that helps communicating with the server via AJAX and managing resource intensive tasks in batches:

      Filters, PW panel links and instant reload on panel close:

      You can combine the grid with a chart library like I did with the (outdated) RockDataTables module:

√ó
√ó
  • Create New...