Jump to content

Recommended Posts

On 2/5/2020 at 8:30 PM, xportde said:

Do you mean Image maximum width / height? So I misunderstood the notes Maximum width / height of resized images (pixels),

Yes.

On 2/5/2020 at 8:30 PM, xportde said:

I thought, this settings are for resizing, not for uploading?

They are for both. If using resizing feature, the images will be constrained to those limits. If they fall short of the minimum, the images are discarded. If not using resizing, original images should meet the minimum and maximum constraints. 

On 2/5/2020 at 8:30 PM, xportde said:

Maybe you could write the notes accordingly (Max width / height for uploaded images)?

Good idea. I'll see how to better word this. I am coming up blank at the moment 😁

Share this post


Link to post
Share on other sites

Downloading Media From Media Manager Library

I was recently asked whether it was possible to download media already uploaded to Media Manager. Currently, there is no automated way to do this. However, using the ProcessWire API, one can achieve this. Below is a starter code showing how one can download image media from Media Manager. I'll consider adding this feature to Media Manager.

Please note that I have deliberately left Tracy debugging statements in the code. You will want to wrap this around a check if user is Superuser.

// get limited number of media manager images
$mmPages = $pages->find('template=media-manager-image, limit=10');
$tempName = 'media_manager_downloads';// temporary name for folder to place images in

// 1. MAKE DIRECTORY
// @note: could have used $files->tempDir('hello-world'); but not working for some reason
// create a new directory in ProcessWire's cache dir
$copyTo = $config->paths->cache . $tempName;
if($files->mkdir($copyTo)) {
    // directory created: /site/assets/cache/media_manager_downloads/

    // 2. COPY IMAGES
    // get and copy image assets
    foreach($mmPages as $p) {
        $images = $p->media_manager_image;
        foreach($images as $image) {
            //bd($image->filename,'image path')// to debug image path
            $copyFrom = $image->filename;
            $bool = $files->copy($copyFrom, $copyTo);
            //bd($bool,'copied?');// just to test if files were copied
        }
    }

    // 3. ZIP IMAGES
    // if files were copied, zip them
    if(!empty($files->find($copyTo))){
        // create zip of all files in directory $copyTo to file $zip
        $zip = $config->paths->cache . "media-manager-image-files.zip";
        $result = $files->zip($zip, $copyTo);

        echo "<h3>These files were added to the ZIP:</h3>";
        foreach($result['files'] as $file) {
            echo "<li>" . $sanitizer->entities($file) . "</li>";
        }

        if(count($result['errors'])) {
            echo "<h3>There were errors:</h3>";
            foreach($result['errors'] as $error) {
                echo "<li>" . $sanitizer->entities($error) . "</li>";
            }
        }

        // 4. SEND FILES TO BROWSER FOR DOWNLOADING
        // if files were added to zip file, send them
        if(!empty($result['files'])){
            bd($zip,'files were added');
            $files->send($zip);
        }
    }

    else {
        bd('NO FILES FOUND!');
    }


}

Hope this helps.

  • Like 2

Share this post


Link to post
Share on other sites

I just installed the Media Manager on a clean PW installation and encountered a problem: Multiple image upload is not working.

I am unter the "upload" tab and drag some images into the field. Then click "start". The upload progress bar is growing for 1 second then suddenly it shrinks back to zero and the image upload list is cleared. No images were uploaded. What is wrong? 
The image size is lower than the max upload size setting in my PHP.ini so that cannot be the reason. The images are about 3 MB each with a resolution of 5184x3456px. That should not be a problem at all?

Second - whenever I alter something in the "settings" tab it is NOT saved. For example: Upload mode -> Single file uploads set to false.

Share this post


Link to post
Share on other sites
20 hours ago, Stefanowitsch said:

I just installed the Media Manager on a clean PW installation and encountered a problem:

Hi @Stefanowitsch,

Sorry for the issues you are currently experiencing.

20 hours ago, Stefanowitsch said:

whenever I alter something in the "settings" tab it is NOT saved. For example: Upload mode -> Single file uploads set to false.

This is a strange one. It might mean Media Manager was not installed correctly and the settings page is not found. It might be the cause of your other issue.

Via email (using the email in your receipt) or PM could you please:

  1. Send me a screenshot of the open tree at Admin > Media Manager.
  2. Confirm that these fields were created: media_manager_audio, media_manager_document, media_manager_image, media_manager_settings, media_manager_video.
  3. Confirm that these templates were created: media-manager, media-manager-audio, media-manager-document, media-manager-image, media-manager-settings, media-manager-video.
  4. The version of ProcessWire you are using.
  5. The PHP version your server is running.
  6. Any error messages, in the console and in TracyDebugger (hopefully, you have this installed)

Thanks.

Share this post


Link to post
Share on other sites

Hi @kongondo

We have a problem with uploading some mp3 files.

We can't upload a specific .mp3 file in the media manager because on the server it returns application/octet-stream as mime-type instead of audio/mpeg.

But when I check with finfo or mime_content_type on a localhost it returns audio/mpeg mimetype.

Even when I check the mime-type on the mac osx terminal (file --mime-type -b filename) it returns audio/mpeg.

What should I do? I also can't find an online tool where the customer could repair the mp3 file or something.

I downloaded the file from the dropbox account/link of the customer.

The funny thing is, when i convert that mp3 file to wav it can be uploaded.

KR
Orkun

Share this post


Link to post
Share on other sites

@kongondo Any news on this? 

What I could do is, is to add the "application/octet-stream" mimetype for mp3 extensions. I could do this inside the method "mimeTypes" of the File "MediaManagerUtilities.php" but don't know if this is a good Idea.

KR
Orkun

Share this post


Link to post
Share on other sites
On 3/6/2020 at 7:48 AM, Orkun said:

@kongondo Any news on this? 

What I could do is, is to add the "application/octet-stream" mimetype for mp3 extensions. I could do this inside the method "mimeTypes" of the File "MediaManagerUtilities.php" but don't know if this is a good Idea.

KR
Orkun

Sorry for the late response @Orkun...

No, that wouldn't be a good idea. One, it would just get overwritten on an upload and secondly, that is not a correct mimetype for mp3s. 

On 3/9/2020 at 8:40 AM, Orkun said:

I found a tool which "fixed" the mp3 file so that I could upload it again in media manager.

Glad you got it sorted. 

It seems PHP will sometimes misclassify the the mimetypes of some mp3s. Here's a discussion about it on SO. This might also be of relevance (corrupt ID3 tags)

Share this post


Link to post
Share on other sites

Hi @kongondo

Is it normal that the folder in /site/assets/MediaManager/jqfu/.files_no_show/ is full of files/duplicate files? We can't upload any files anymore, because we are getting the error of duplicate media page (empty file upload result). It looks like he tries to create a page from a file from the .files_no_show folder but that page with the name already exists.

Isn't the /site/assets/MediaManager/jqfu/.files_no_show/ just a temporary folder? Shouldn't be the file deleted after the media page was created?

KR
Orkun

Share this post


Link to post
Share on other sites

Hi @Orkun,

On 3/20/2020 at 7:35 AM, Orkun said:

Isn't the /site/assets/MediaManager/jqfu/.files_no_show/ just a temporary folder?

Yes it is just a temporary folder.

On 3/20/2020 at 7:35 AM, Orkun said:

Shouldn't be the file deleted after the media page was created?

It should. It works fine here. Could you please tell me about your setup? (ProcessWire and PHP versions, etc).

I am not sure whether it is a file permission issue. Are you on a Windows machine?

Alternatively, maybe you are trying to upload very large images and the system does not finish and you are trying to re-upload?

Please let me know.

Share this post


Link to post
Share on other sites

Hello,

This is primarily directed to MAC users and/or MAMP users.

Recently, some Media Manager users have reported that their settings are not getting saved, especially the After Uploading setting. I have to replicate the issue on clean installs with nothing but MM, JqueryFileUpload and Tracy without success. Here's what we know so far:

  • The settings actually get saved in the Database; the issue is what is saved is not what gets displayed in the GUI. Meaning, it always shows the default setting.
  • For one user, the issue only appeared when they were using WAMP or XAMP. For the other user the issue appeared on both MAC and Windows. I don't have a MAC to test on.
  • I have tested on both single language and multilingual sites. I can't replicate the issue.
  • PHP, MySQL versions don't seem to be the issue. We've been testing on PHP 7.2+.
  • I have tested on both the latest master and dev versions of PW.
  • Those experiencing the issue see the same behaviour in Chrome, FF and Edge. I am not sure about Safari.
  • We don't think there's a browser extension interfering.
  • Media Manager version 012 (latest).

Is there anyone with MM version 012, a bit of time and preferably a MAC and MAMP who can help us figure this out please? Any other ideas?

Many thanks.

 

Share this post


Link to post
Share on other sites
Posted (edited)

Hi kongondo,

I just wanted to report a little UI inconsistency: I was editing a CKEditor-textarea and inserted a link by using "Select Media from Media Manager". In the Media Manager modal window, I used the table view, in order to see the filenames. Now, selecting any of the thumbnails didn't give any visual feedback. The red frame indicator only appears in the grid view, but not in the table view. I did a clean install of Processwire and Media Manager, but the issue persisted.

Update: I think I found the issue. Here is a fix for insertMediaLINK($s) in MediaManager.js:

Before:

$inputs.each(function () {
    // skip current input
    if ($(this).attr('id') == 'media-' + $dataValue) return;
    // invert checked status
    $(this).prop("checked", inverseState).change();
});

After:

$inputs.each(function () {
	// skip current input
	var $dv = $(this).attr('id').substr(6).replace('-tabular', '');
	if ($dv == $dataValue) return;
	// invert checked status
	$(this).prop("checked", inverseState).change();
});

The line was taken from removeMediaThumbsView($a) in InputfieldMediaManager.js.

Edited by nurkka
Found issue, (hopefully) fixed it
  • Like 1

Share this post


Link to post
Share on other sites

Hi @nurkka,

On 4/3/2020 at 4:09 PM, nurkka said:

I just wanted to report a little UI inconsistency

Thanks for the report and the suggested fix. I'll look into this.

Share this post


Link to post
Share on other sites
On 4/2/2020 at 3:14 PM, kongondo said:

Recently, some Media Manager users have reported that their settings are not getting saved, especially the After Uploading setting.

This seems to have been an issue with sites installed in sub-folders. I'll fix this in next update. 

Thanks.

Share this post


Link to post
Share on other sites

Hi @kongondo,

On 2/27/2020 at 2:43 PM, Stefanowitsch said:

I just installed the Media Manager on a clean PW installation and encountered a problem: Multiple image upload is not working.

I am unter the "upload" tab and drag some images into the field. Then click "start". The upload progress bar is growing for 1 second then suddenly it shrinks back to zero and the image upload list is cleared. No images were uploaded. What is wrong?

I'm encountering the same problem as @Stefanowitsch on the latest Media Manager: Multiple image uploads not working, exactly how he described it. Did you find a solution?

Quote

Second - whenever I alter something in the "settings" tab it is NOT saved. For example: Upload mode -> Single file uploads set to false.

I do *not* experience this problem, so it may be unrelated...

Thank you 🙂

Share this post


Link to post
Share on other sites

Hi @dynweb,

Sorry about the issue you are encountering.

46 minutes ago, dynweb said:

Did you find a solution?

Yes. The value of PHP (php.ini) post_max_size was low. Please let me know what your settings are for the following:

  • post_max_size
  • memory_limit
  • file_uploads
  • upload_max_filesize
49 minutes ago, dynweb said:

I do *not* experience this problem, so it may be unrelated...

This one (settings not getting saved) was related (at least in one case) to ProcessWire being installed in a sub-directory 🙂

 

Share this post


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

Yes. The value of PHP (php.ini) post_max_size was low.

Same for me 🙂 Issue solved, thank you.

Share this post


Link to post
Share on other sites
6 minutes ago, dynweb said:

Same for me 🙂 Issue solved, thank you.

Great! Glad you got it sorted.

Share this post


Link to post
Share on other sites

@kongondo

I have just bought the Media Manager Module, Upload is not working!
when i click on start button nothing shows on media manager page! check the images below

(Home + Console)

mm2.PNG.cb04759cca4281337d5c05e3d436f120.PNG

 

mm1.PNG.6964469ca32f1f94bcd1d8ed92b491bd.PNG

Share this post


Link to post
Share on other sites

Hi @Mustafa-Online,

1 hour ago, Mustafa-Online said:

I have just bought the Media Manager Module,

Thanks for the purchase.

1 hour ago, Mustafa-Online said:

Upload is not working!
when i click on start button nothing shows on media manager page!

Sorry about this. 

Please check and confirm the following:

  • post_max_size
  • memory_limit
  • file_uploads
  • upload_max_filesize

In addition, please confirm the following:

  • What are you trying to upload?
  • Are they perhaps smaller/larger than what you have in the settings for minimum/maximum sizes?
  • Is this a multilingual site?
  • ProcessWire version.
  • PHP version.

Thanks.

Share this post


Link to post
Share on other sites

@kongondo

  • post_max_size = 512M
  • memory_limit = 512M
  • file_uploads = On
  • upload_max_filesize = 2G

--------------------------------------------

  • What are you trying to upload: I tried almost every type (jpeg png pdf doc docx ppt mp3 mp4)
  • Are they perhaps smaller/larger than what you have in the settings? I even tried 3kb file size with no luck
  • Is this a multilingual site? No It's a fresh installtion
  • ProcessWire version: PW Dev 3.0.156
  • PHP version: 7.2.27

Share this post


Link to post
Share on other sites

@Mustafa-Online,

What are you Media Manager settings for the following?

After Uploading

mm_settings_after_uploading.thumb.png.68f13205c4f27fbb9a7f85df5da2ba4a.png

 

Image Extensions

mm_settings_image_extensions.thumb.png.a568c884885b54df4584dacdd6511139.png

Have a look at the dev tools, network tab, xhr when uploading:

  • Are the files posted?
  • What response does the server return?

Do you have the following directories under /site/ ?

  • /sites/assets/MediaManager/jqfu
  • /sites/assets/MediaManager/uploads

Btw, post_max_size needs to be bigger than upload_max_filesize. See this post by Horst.

 

Could you try with config->debug=true and TracyDebugger and let me know if you get any errors please? I have just tested with the latest dev version and it works OK.

Share this post


Link to post
Share on other sites

@kongondo -- Yes I have  jqfu & uploads folders. I also modeified the post_max_size so it's bigger than upload_max_filesize

I get this in network tab >> Notice: Media Manager: No valid media found to add to Media Library

trc.thumb.PNG.9795df1c6467514111bffb52d9e73ee4.PNG
 



mdddd.PNG.c61f265e9aa42d02b089273cfb5f3f80.PNG

media-1.PNG.3168054007b428906ec641b783241c7e.PNG
 

One More thing: I checked again, all the files I tried to upload are available in PW assets folder!
 

Share this post


Link to post
Share on other sites
2 hours ago, Mustafa-Online said:

One More thing: I checked again, all the files I tried to upload are available in PW assets folder!

Please confirm where exactly in the assets folder. With the settings you've shown me, they should be in /site/assets/MediaManager/jqfu/.files_no_show

Please also confirm:

  • Are you on MAMP?
  • Are you on a Windows or a Mac or other?
  • Is ProcessWire installed in a sub-folder?

Sorry for the hassle. I'd really like to get to the bottom of why for most MM works flawlessly and for a few others there are upload issues. 

Thanks.

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