Jump to content

Recommended Posts

Just now, Lutz said:

Media Manager for storing the images?

Each media is a PW page, hidden in admin part of the tree. Non-supersusers never get to see them :-).

Share this post


Link to post
Share on other sites
27 minutes ago, David Karich said:

Apropos: I never received a download link for the update to 012 by mail. Or do I have to buy a new license?

Subscriptions (update + VIP support) are valid for 1 year. After that you can renew for a fraction of the original price. Otherwise, I don't send out update reminders but post here in the forums. If you have a valid subscription, you can use the resend download links form to get an email with the download link to the latest version (or use the link in the original email you received after purchase). For renewals, please use the renewal form. Any problems, please PM or send me an email.

  • Like 1

Share this post


Link to post
Share on other sites
47 minutes ago, kongondo said:

Each media is a PW page, hidden in admin part of the tree. Non-supersusers never get to see them :-).

@kongondo To prevent a misunderstanding: each media is stored in the database, not in the file system?

Share this post


Link to post
Share on other sites
33 minutes ago, Lutz said:

@kongondo To prevent a misunderstanding: each media is stored in the database, not in the file system?

Sorry I wasn't clear.

Media = $page

Media has one MM field. In the case of images, it is an multi image field. So $page->image_field will give you the image

Media has a title field: $page->title;// title of your media

If you had own fields to Media, you can access them using $page->your_field, as usual.

However, we don't use the variable $page. Instead what you get is a MediaManager Object.

So, Media page object is $mm.

Echo $mm->id: id of the media

Echo $mm->title;

// this is the image field

foreach($mm->media) {

}

Hope this makes sense.

 

Share this post


Link to post
Share on other sites
31 minutes ago, kongondo said:

Hope this makes sense.

 

@kongondo Yes, thank you, this is what I had expected and hoped for. My question was in terms of scalability, regarding file system limits. In PW, files are stored in subdirectories under /site/assets/files, therefore we normally have to deal with max directory limits (e.g. 32k). We have $config->pagefileExtendedPaths, but it's marked as beta. So as you mentioned +500k, I hoped for an info regarding the stability of pagefileExtendedPaths (or another way to avoid collisions with max directory limits). When they manage +500k, did they enable pagefileExtendedPaths?

Share this post


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

When they manage +500k, did they enable pagefileExtendedPaths?

I have no idea. I never asked. I could try and find out.

  • Like 1

Share this post


Link to post
Share on other sites

Thanks for this awesome module! Here is some feedback after some hours of testing: When using MediaManager along with Ryan’s ProDrafts, I had to manually disable ProDrafts support for the MediaManager specific templates. Otherwise, inserted images from the MediaManager would not display in the saved pages (neither drafts nor published versions). I figure this was because the images in MediaManager were by default also handled as drafts. After disabling ProDrafts for the MediaManager templates, everything – including working with drafts – works just fine.

  • Like 1

Share this post


Link to post
Share on other sites
11 hours ago, tb76 said:

Thanks for this awesome module!

Glad you like it.

11 hours ago, tb76 said:

I figure this was because the images in MediaManager were by default also handled as drafts. After disabling ProDrafts for the MediaManager templates, everything – including working with drafts – works just fine.

Thanks for testing and reporting back. I guess it doesn't make much sense to have a draft media (i.e. using ProDrafts). However, if you have added other fields to your Media Manager templates, you might want those to work with drafts. Hmm. I've never used ProDrafts before but you've given me something to think about.

Share this post


Link to post
Share on other sites

Hi kongondo,

one of our customers asks, if it would be possible to write out not only the usage amount of media manager items, but also all usages as list with concrete info about field, page etc. I know, this isn't going to be easy, but maybe it's worth the effort, if other users reported the same idea?

Greetings,

Thomas.

  • Like 1

Share this post


Link to post
Share on other sites
On 6/21/2019 at 3:57 PM, xportde said:

one of our customers asks, if it would be possible to write out not only the usage amount of media manager items, but also all usages as list with concrete info about field, page etc. I know, this isn't going to be easy, but maybe it's worth the effort, if other users reported the same idea?

Hi Thomas,

I'll have a think. The interface will need careful thought as it would need to be separate from the tooltip.

Share this post


Link to post
Share on other sites
On 5/10/2019 at 3:09 PM, kongondo said:

However, two people have reported an error about class ProcessMediaManager not found in line 20 of MediaManagerUtilities.

Three people now! haha

Any news on this bug?? Thanks!

I rolled back but now I am having issues with JqueryUpload version 008 working, tried rolling back to 002 but I still can't open when I click on Add Media on any of the pages, getting:

 Uncaught Error: Class 'ProcessWire\JqueryFileUpload' not found in /srv/users/serverpilot/apps/ladosis/public/site/modules/ProcessMediaManager/ProcessMediaManager.module:209

Ok this took me through a tour of namespacing issuer all over the MediaManager modules and got it working back. 

Share this post


Link to post
Share on other sites
On 7/31/2019 at 6:23 AM, elabx said:

Three people now! haha

Any news on this bug?? Thanks!

I rolled back but now I am having issues with JqueryUpload version 008 working, tried rolling back to 002 but I still can't open when I click on Add Media on any of the pages, getting:

 Uncaught Error: Class 'ProcessWire\JqueryFileUpload' not found in /srv/users/serverpilot/apps/ladosis/public/site/modules/ProcessMediaManager/ProcessMediaManager.module:209

Ok this took me through a tour of namespacing issuer all over the MediaManager modules and got it working back. 

Hey @elabx,

Sorry for the delay in responding. I have just tested in a new PW install with only 3 modules: MM, JFU and Tracy. I had to click on Clear Compiled Files 3 or 4 times for it to finally work. Here's what I did.

  1. Upgrade JqueryFileUpload by overwriting the existing files
  2. Delete MediaManagerTabs.php and pocketgrid.css in the current (old) Media Manager install
  3. Overwrite MM version 011 files with version 012 files
  4. Access Media Manager
  5. You might see Class not found error (either MediaManagerUtilities or JqueryFileUpload
  6. Access Modules (on same tab in #4) and click on Clear Compiled Files
  7. Once step #6 is finished, click browser back button to go back to Media Manager.
  8. If you get class error again, repeat steps 6 - 7 as necessary

Please let me know if this works for you. Thanks.

  • Like 1

Share this post


Link to post
Share on other sites

@kongondo Finally managed to updated!! But you know what, now I didn't have to clear anything, it just worked after a module refresh!! Just so you have more info, the only difference was that I namespaced the old modules (in a desperate attempt to bring back everything to work because it kind of broke after I rolled back from my first install failure). honestly don't have very clear what happened, but indeed the new version works flawlessly.

Questions/issues: 

  • I don't seem to be able to drag and drop over the Inputfield. I can give you access to my site if you need to debug.
  • I cannot seem to find the edit button for the image description now, the one that was placed at the top right? Is there a new way to edit the descriptions? Appending how my images look when I click on them.   Jut realized now this is done in a normal, maybe you could enable an Edit link right on the Inputfield? At least on my site it's not showing, I'd guess that's the most practical for editors, instead of opening the Media Manager Popup.
  • I cannot get the alt text on images placed in CKEditor to update accordingly, I also have the setting updated in the Inputfield configuration, have you had any issues with this?

All my questions crossed where solved configuring the Inputfield :)

This is a GREAT update kongondo! I know this has been mentioned before but the improvement in the UI is a huge plus! I see you mentioned you have a lot of users that had never mentioned this, but in my case as with other PW users, all my clients complained about the lack of polish in UI, but this update really solves a lot of the inconveniences. 

Share this post


Link to post
Share on other sites
10 hours ago, elabx said:

Just so you have more info, the only difference was that I namespaced the old modules

Aah, nice workaround. I never thought to do that 😊.

10 hours ago, elabx said:

This is a GREAT update kongondo! I know this has been mentioned before but the improvement in the UI is a huge plus! I see you mentioned you have a lot of users that had never mentioned this, but in my case as with other PW users, all my clients complained about the lack of polish in UI, but this update really solves a lot of the inconveniences. 

Glad you like it :-).

10 hours ago, elabx said:

I cannot get the alt text on images placed in CKEditor to update accordingly, I also have the setting updated in the Inputfield configuration, have you had any issues with this?

I don't follow. What is this alt text please? Please clarify which inputfield configuration, CKEditor or MM?

Full documentation is available here, by the way :-).

Thanks.

Edited by kongondo

Share this post


Link to post
Share on other sites
5 hours ago, kongondo said:

I don't follow. What is this alt text please? Please clarify which inputfield configuration, CKEditor or MM?

 

When you insert an image through CKEditor, ideally I'd want to grab the description from the image's description field. CKEditor Inputfields fields have an option called "Image management" that should enable this:

https://processwire.com/docs/fields/textarea-fieldtype/#markup-html-option

I just can't get this to work well, if I add a new image to the text fields, their descriptions are not pulled from the images. 

My bad again man, I kept on reviewing this on the CKeditor source and just realized this is done on runtime. 

Share this post


Link to post
Share on other sites
21 minutes ago, elabx said:

My bad again man, I kept on reviewing this on the CKeditor source and just realized this is done on runtime. 

😀

  • Like 1

Share this post


Link to post
Share on other sites

@kongondo Thank you for that module. Befor I go and order it, I'd like to make sure that the feature my client needs is included already.

For that client each media item should be available as a public download. So in the list of media in the manager there should be something like a button to copy that public link and when editing media that public link should be displayed also.

I guess the module needs some customizing to do this. Would this be possible through hooks? Especially for the media lists in the manager. Are there hooks available where I could inject some markup or even an extra column in list view?

Since all media are pages, I guess I can hook into ProcessPageEdit for those templates and add the link to display in the page editor screen? 

Share this post


Link to post
Share on other sites
On 8/28/2019 at 10:54 AM, gebeer said:

So in the list of media in the manager there should be something like a button to copy that public link and when editing media that public link should be displayed also.

Where is the link being copied from?

On 8/28/2019 at 10:54 AM, gebeer said:

Since all media are pages, I guess I can hook into ProcessPageEdit for those templates and add the link to display in the page editor screen? 

Yes, but Media Manager methods are currently not hookable. I'm not sure you've seen it, but Media Manager allows you to add your own (ProcessWire) fields to the media pages templates. Those will then be displayed in the list (table) view if you configure them to be displayed in Media Manager settings. However, you will not be able to edit the values directly in the table view. Instead, each media has an edit link that when clicked will open the full page for editing - this is a normal (almost) ProcessWire page edit form. You can use it to edit any of the fields in the template as well as the media themselves. In the frontend you access them as $m->your_public_link_field. I hope this makes sense. If not, please let me know.

Thanks.

Share this post


Link to post
Share on other sites

Hi kongondo!

Recently, I used Media Manager in a client project. In this real world use case, the media library very quickly grew to an extent, where it was too confusing for the client. Of course I know how to apply filters, but for my client, configuring and applying filters was to complicated - even with the relatively new feature of pre-defined filters. So I thought I would ask you, if you could image to implement some additional filter-features, that would make it easier for clients:

- It would be great, if it was possible to set a default filter for every MediaManager-Field. I have a lot of different "image-types", like icons, fotos, sketches and so on. With such a feature, it would be possible to limit the displayed images to just the "type" of image, that suits the context of the current MediaManager-field. Like when applying some product icons, you don't want to choose from the whole library with all the staff portraits.

- Another great feature would be, if pre-defined filters could be applied with one click in the overview. I tried to sketch this in a fake screenshot:

image.png.e2ba4df88805529eb8e8537ea84bd795.png

In this way, an admin could pre-define all needed filters, and the user/client could just apply them with one click - without worrying about or even understanding the actual filter definition.

I guess those features don't exist already, but if so, I would be very happy, if you could point me to any existing solution.
Otherwise it would be great to have those - or similar - features in a future version.

Thanks again for the great module!

Share this post


Link to post
Share on other sites
On 11/29/2019 at 1:33 PM, nurkka said:

Recently, I used Media Manager in a client project. In this real world use case, the media library very quickly grew to an extent, where it was too confusing for the client.

Hi @nurkka. Sorry for the late response. I have been away.

On 11/29/2019 at 1:33 PM, nurkka said:

It would be great, if it was possible to set a default filter for every MediaManager-Field. I have a lot of different "image-types", like icons, fotos, sketches and so on. With such a feature, it would be possible to limit the displayed images to just the "type" of image, that suits the context of the current MediaManager-field. Like when applying some product icons, you don't want to choose from the whole library with all the staff portraits.

This is an excellent suggestion! I'll have a think on how to best implement it but theoretically, it is doable.

On 11/29/2019 at 1:33 PM, nurkka said:

In this way, an admin could pre-define all needed filters, and the user/client could just apply them with one click - without worrying about or even understanding the actual filter definition

Another great suggestion! I would have to rethink the GUI a bit since tabs (Filter: Icons, Filter:Photos, etc) would quickly become unwieldy. 

On a related note, I have been planning to refactor the items shown in the Inputfield Selector (the filters) as there are a number of things not directly relevant to Media Manager that would confuse editors. For instance, the Inputfield shows non-Media Manager fields, items like Path/URL, etc.

I am planning to work on your suggestions and the refactoring in the next update.

I might call on you for a bit of testing before release, if that's OK.

Thanks. 

  • Like 2

Share this post


Link to post
Share on other sites
On 12/8/2019 at 2:04 PM, kongondo said:

I might call on you for a bit of testing before release, if that's OK.

Hi @kongondo, thank you for your feedback. I am glad that you like my suggestions. And I would be happy to help you with testing!

  • Like 1

Share this post


Link to post
Share on other sites
On 12/15/2019 at 6:28 PM, nurkka said:

And I would be happy to help you with testing!

Thanks!

Share this post


Link to post
Share on other sites

Hi kongondo,

because there's no option for limiting uploaded images to image width and/or height in MM settings (or is there?), we've found out, that the PW-native image field limitations from the underlaying field media_manager_image works (input > maximum image dimensions). Unfortunately, this restriction works quiet, i.e. the MM-upload will be finished without error or warning, but the image will correctly not stored because of violating the image field dimension rules.

Would it be possible to apply the image field rules already in MM upload screen, so that the user can see possible violations before start uploading (like the maximum file size rule from MM settings)?

Greetings,

Thomas.

Share this post


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

there's no option for limiting uploaded images to image width and/or height in MM settings (or is there?),

Actually, there is 😁. See under Settings > Upload Settings > Image. There are settings for min/max height and min/max width. These are directly coupled to the the field's (media_manager_image) corresponding settings. If you change one it will change the other. However, I have just noticed a bug. The min values are decoupled! This shouldn't matter much though since Media Manager will still honour the min values. I will fix these later (i.e. the 'decoupling' issue).

1 hour ago, xportde said:

so that the user can see possible violations before start uploading (like the maximum file size rule from MM settings)?

Excellent suggestion! I will add this to my TODO as well. 

NO ETA for above, just yet, sorry. I hope it isn't urgent?

Thanks!

 

 

 

Share this post


Link to post
Share on other sites
Quote

Actually, there is 😁. See under Settings > Upload Settings > Image. There are settings for min/max height and min/max width

Do you mean Image maximum width / height? So I misunderstood the notes Maximum width / height of resized images (pixels), I thought, this settings are for resizing, not for uploading? But in fact, it corresponds with the equivalent image fields. Maybe you could write the notes accordingly (Max width / height for uploaded images)?

Greetings, Thomas.

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

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

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

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

      The module doesn't make any assumptions about how you might want to use the depth structure array, but here is a way you might use it to output a nested unordered list.
      // Output a nested unordered list from a depth structure array function outputNestedList($depth_structure, $repeater_items) { $out = "<ul>"; foreach($depth_structure as $page_id => $nested_children) { $out .= "<li>" . $repeater_items->get("id=$page_id")->title; // Go recursive if there are nested children if(is_array($nested_children)) $out .= outputNestedList($nested_children, $repeater_items); $out .= "</li>"; } $out .= "</ul>"; return $out; } $repeater_items = $page->my_repeater; $depth_structure = $repeater_items->getDepthStructure(); echo outputNestedList($depth_structure, $repeater_items);
       
      https://github.com/Toutouwai/RepeaterDepthHelper
      https://modules.processwire.com/modules/repeater-depth-helper/
    • By MoritzLost
      Cacheable Placeholders
      This module allows you to have pieces of dynamic content inside cached output. This aims to solve the common problem of having a mostly cacheable site, but with pieces of dynamic output here and there.  Consider this simple example, where you want to output a custom greeting to the current user:
      <h1>Good morning, <?= ucfirst($user->name) ?></h1> This snippet means you can't use the template cache (at least for logged-in users), because each user has a different name. Even if 99% of your output is static, you can only cache the pieces that you know won't include this personal greeting. A more common example would be CSRF tokens for HTML forms - those need to be unique by definition, so you can't cache the form wholesale.
      This module solves this problem by introducing cacheable placeholders - small placeholder tokens that get replaced during every request. The replacement is done inside a Page::render hook so it runs during every request, even if the response is served from the template cache. So you can use something like this:
      <h1>Good morning, {{{greeting}}}</h1> Replacement tokens are defined with a callback function that produces the appropriate output and added to the module through a simple hook:
      // site/ready.php wire()->addHookAfter('CachePlaceholders::getTokens', function (HookEvent $e) { $tokens = $e->return; $tokens['greeting'] = [ 'callback' => function (array $tokenData) { return ucfirst(wire('user')->name); } ]; $e->return = $tokens; }); Tokens can also include parameters that are parsed and passed to the callback function. There are more fully annotated examples and step-by-step instructions in the README on Github!
      Features
      A simple and fast token parser that calls the appropriate callback and runs automatically. Tokens may include multiple named or positional parameters, as well as multi-value parameters. A manual mode that allows you to replace tokens in custom pieces of cached content (useful if you're using the $cache API). Some built-in tokens for common use-cases: CSRF-Tokens, replacing values from superglobals and producing random hexadecimal strings. The token format is completely customizable, all delimiters can be changed to avoid collisions with existing tag parsers or template languages. Links
      Github Repository & documentation Module directory If you are interested in learning more, the README is very extensive, with more usage examples, code samples and usage instructions!
×
×
  • Create New...