gebeer
-
Posts
1,489 -
Joined
-
Last visited
-
Days Won
43
Everything posted by gebeer
-
I knew that this would cause conflict because there are so many different ways of implementing script loading. So your comments on this are more then welcome. I read and revived this discussion about how to best approach script inclusion when developing a module. And chose a mixed approach because I'm really not sure myself how to best do it and to experiment with different methods. The original approach of the Google Maps module just didn't seem perfect since it forces users to include stuff in the head. So what to do as a user if you don't want to have scripts in <head>. But then I guess there is no perfect way. Main reason for injecting the "inline script" at the very end: wanted to make sure that scripts get loaded in the right order. @Soma why wouldn't you want to have it before </body>? @Wanze thanks for clarifying the terminology. I'm quite new to PW module development. So I really appreciate any input that I can learn from.
- 14 replies
-
- 1
-
-
- hook
- non autoload
- (and 1 more)
-
Solved this way: I made an additional autoload module 'MarkupAddInlineScript' to execute the hook. In the render() method of the map markup module I assign my inline script string to the page object $this->page->inlineScript = $inlineScript; Now in init() of MarkupAddInlineScript I execute the hook $this->addHookAfter('Page::render', $this, 'addInlineScript'); that calls my hook method public function addInlineScript($event) { $page = $event->object; if ($page->inlineScript) { $event->return = str_replace("</body>", $page->inlineScript . "</body>", $event->return); } } My hook method only executes when $page->inlineScript returns a value other then null. This will happen only on pages that instantiate a map object with $map = $modules->get('MarkupLeafletMap'); As a result I have the script that was previously insertet inline on the page, neatly attached to the end of my page body <script type="text/javascript">...</script> </body> All other scripts that are required for rendering the map are also attached at the end of the body before the "inline script" through $config->scripts->add() in the init() method of the 'MarkupLeafletMap' module. Now when people install this module, they don't have to worry about including the various scripts themselves in the head or body and I can be sure that they get executed in the right order, too. Only thing users of the module need to do now is include <?php foreach($config->scripts as $url) echo "<script src='$url'></script>"; ?> before </body>
-
Thank you all for the insights on how hooks are working. This really helps me to better understand what is going on. @Wanze How would I approach that? My guess is that it needs to happen during init() of my module, am I right?
-
I see '<script src="https://maps.gstatic.com/maps-api-v3/api/js/20/9/main.js"></script>' In the body of your html after the map div. Also you have meta tags in your body. This suggests that your template code is somehow messed up and things get loaded in the wrong order. It would help if you could post your postcard.php and head.inc. Sorry, have to go now. Can take a look again tomorrow.
-
try $map = $modules->get('MarkupGoogleMap'); echo $map->render($page, location);
-
Great idea Will give this a shot.
-
I reinstalled the module to make PW know that it is not autoload anymore. Now $this->addHookAfter('Page::render', $this, 'addInlineScript'); is not executed anymore. Doesn't matter whether I call it from init() or render() This confirms for me that modules need to be autoload in order to place hooks in them, like the wiki suggests. I guess I need to find another way of implementing my logic... But thanks again for your help.
-
Thank ou for the quick reply. Maybe there is some misunderstanding here. I don't want to make a function ___hookable that is part of my module. I want to add an after hook to Page::render where I call my method 'addInlineScript': $page->addHookAfter('render', $this, 'addInlineScript'); This hook call I placed inside the render() method of my module. In the meantime I found out that the hook gets called when I place it in init() method of my module. But I don't want to call it from init() because the 'addInlineScript' method depends on some property that is created in render(). So I need to call the hook from there. The exit() is just there to confirm that my method gets called. I don't want the module to be autoload. I just understood from the wiki that it needs to be autoload in order to call a hook from within it. But I guess I got this wrong. So I made the module none autoload again but it is still being loaded. Has this to do with module cache and how can I make it not autoload again?
-
Hello, I have a hook in a custom method of a non autoload module and it is not calling my hook method. In the wiki I read Modules that are intended to attach hooks in the application typically should be autoload because they listen in to classes rather than have classes call upon them. If they weren't autoload, then they might never get to attach their hooks. Does this mean that hooks are only working in autoload modules? I added 'singular' => true and 'autoload' => true to getModuleInfo() but still my hook funktion does not get called. My hook call at the end of this render method $this->inlineScript = $inlineScript; $page->addHookAfter('render', $this, 'addInlineScript'); $page object is available. Also tried $this->addHookAfter('Page::render', $this, 'addInlineScript'); and my hook method public function addInlineScript($event) { exit("gbr"); // $value contains the full rendered markup of a $page $value = $event->return; $value = str_replace("</body>", $this->inlineScript . "</body>", $value); // set the modified value back to the return value $event->return = $value; } Why is this not working? Any help would be much appreciated.
-
I agree. Added all available providers to the select dropdown and have set OpenStreetMap.Mapnik as default. Will post the next days with update on awesome icons...
-
How to insert scripts and stylesheets from your module?
gebeer replied to hdesigns's topic in Module/Plugin Development
That's true. But if your instruction go something like: "You need to include these 4 scripts in your head tag to make this module work and you need to download them from these 4 different places first", it may drive people off. Imagine a developer who cares about page loading optimization and he cannot do it right because of your module. Or he has to go and alter the module code so it fits his needs. Wouldn't it be better if the module followed commonly accepted best practices and people who use the module don't need to care about things like manual script inclusion? I personally don't feel really comfortable with the proposed approach 3, too. The $this->config->scripts->add() method seems to be the preferable way to go. But then you need to instruct the users of your module to include the necessary php for rendering the scripts tags before </body>. Which I consider to be a PW best practice anyway when it comes to conditional loading of scripts. The only point that I really wanted to make is that we should follow best practices and include our scripts at the end of the page and not in the head. If this limits developers freedom, it at least forces something on them that is generally a good thing. -
How to insert scripts and stylesheets from your module?
gebeer replied to hdesigns's topic in Module/Plugin Development
I came across this thread while working on my first PW module that needs to load quite a lot of scripts. So I am going to revive this thread because the OP makes an important point here: how to best find the balance between easy module integration and freedom for PW users when it comes to template structure . In my opinion, best practices for script inclusion should also be considered here. So while giving users the most possible freedom in how to structure their templates, they should at the same time be made aware of ways how to best implement script loading. Not only with PW, but in general. I for myself am still learning a lot about web development best practices while developing sites with PW. There is a lot of useful information to be found here in the forums which is absolutely great. One thing that most of web devs seem to agree upon is that loading scripts at the end of your template just before </body> increases site loading speed and thus user experience. Besides that it also makes sure that the DOM is already available to those scripts. And here lies the culprit of approach 3 proposed by the OP: all additional scripts get loaded in the <head> which slows down page loading time. Thus I would implement the addScripts method like this public function addScripts($event) { $page = $event->object; // don't add this to the admin pages if($page->template == 'admin') return; //other mechanisms to ensure the script only loads when this module was called in the front-end $additionalScripts = '[myScripts...]'; $event->return = str_replace("</body>", $additionalHeadScripts.'</body>', $event->return); } Only drawback I can see: following this approach, the module developer has to make sure that all inline scripts wait for the scripts they depend upon before they are executed (eg with $(window).load or $(document).ready) -
Thanks again for the port to leaflet! I prefer OSM over google maps and have been using it for quite some time. Leaflet is very powerful and opens up many possibilities. I forked Mats' module and added support for leaflet-providers so we can choose different map tile providers (see my post here). It is still a work in progress but seems stable. Once it is ready for production I'll make a pull request. Mats, do you think we should use leaflet-providers as standard or offer the user a choice whether they want to use it or not? Next up I will add an icon field and support for Leaflet.awesome-markers.
-
@Mats thank you so much for your OSM version of the module. Have you opened a thread dedicated to it, yet? Couldn't find it in the forums. I forked your module and added basic support for leaflet-providers. In the field settings we can now choose the map tile provider. and the map renders accordingly (example with MapQuest.Open) (example with OpenStreetMap.BlackAndWhite) I'm thinking adding this on a per marker basis also but I'm not quite sure yet if it makes sense at all to define tiles per marker? We should definitely open a separate thread for your module, what do you think?
-
This request was aborted because it appears to be forged
gebeer replied to Gazley's topic in General Support
I just noticed that I get the error on my vagrant box with latest stable 2.5.3. The error was related to wrong apache user/group in my vagrant box and previously I had solved it like this. But dev versions 2.5.26 and 2.5.27 don't throw this error anymore. -
Thank you for your patience with an OOP noob. I don't know how I would copy the array to my module. So some example code would be great. So that I can go on from there with removing keys etc.
-
How can I access $defaultMarkup from within my hook: public function init() { $this->addHookBefore('Page::render', $this, 'addTooltipJS'); $this->addHookBefore('InputfieldWrapper::render', $this, 'addTooltip'); } public function addTooltip(HookEvent $event) { $defaultMarkup = ; $event->return; }
-
That is a beast, indeed. And I'm quite new to PW modules. Have read the documentation. But don't no how to access $defaultMarkup in this case. The $event->object is of type InputfieldForm with lots of protected and private properties. Any help would be much appreciated.
-
@LostKobrakai Thank you. I already had a look at InputfieldWrapper.php and am currently trying to add my hook there. Will report back with results or questions.
-
I have searched the forum and google but couldn't find anything related. I want to show all field descriptions in admin forms as tooltips. Has this request really not come up before? I imagine a module that hooks into the Inputfield class, adds the description as title value to the inputfield and then makes use of https://jqueryui.com/tooltip/. Am I on the right track here? EDIT: I made a module "InputfieldHookAddTitle": <?php class InputfieldHookAddTitle extends WireData implements Module { public static function getModuleInfo() { return array( 'title' => 'Inputfield Hook Add Title', 'version' => 100, 'summary' => 'Adds title attribute to inputfields with field description as value', 'singular' => true, 'autoload' => true, ); } public function init() { $this->addHookBefore('Inputfield::render', $this, 'addTitle'); } public function addTitle(HookEvent $event) { $inputfield = $event->object; if ($inputfield->description == "") return; $inputfield->setAttribute('title', $inputfield->description); $event->return; } } This adds title attribute with value description to inputfields. Now I need to get rid of the original <p class="description"> tag which is set in the constructor method. How would I unset this? I don't see a unset method. And how do I add the Jquery tooltip js? EDIT: I managed to add the custom JS to the admin pages, thanks to Soma's blog post. In my site/templates/admin.php I added: // add tooltip JS to admin pages $modules->get('JqueryCore'); $modules->get('JqueryUI'); $config->scripts->add($config->urls->templates . "js/admintooltips.js"); and the admintooltips.js $(function() { var tooltips = $( "[title]" ).tooltip({ position: { my: "left top", at: "right+5 top-5" } }); }); Now I only need to get rid of the original description. Any pointers would be much appreciated.
-
I made this into a blank site profile. Download and instructions here. Tested on a new PW install and it is working fine. Maybe some of you want to test it in other environments and let me know if I need to amend the README. Thank you.
-
This is very inspiring. Thank you for sharing! Before I sit down and do this, do you have any plans on releasing this as a site profile? Edit: OK, I sat down and am working on it. Going smoothly so far. Will report back...
-
@Soma I am sorry, didn't mean to flood the forum with this. Was just exited about the whole thing and that maybe made me go a bit far... Your proposed solution for setup and custom selector to get this working with pages that don't share the same tree is great. Very much appreciated. I put something together quickly to have the same functionality in a frontend form with the help of a jQuery plugin.
-
@Soma that looks great! I am only having trouble understanding where exactly I need to put the "select_page" field and what the selector for this one would be. Because I am not sure what "options pages" refers to. Are these the area and event pages in your example? EDIT: I got it working now for my scenario. Thanks again. -destination template with title and country single page select field -tour template with title, country field and a destinations multi page select field with custom selector "country=page.country, select_page!='', template=destination"
-
Your welcome. This is just on a playground site at the moment and will not be online until much later this year. But the code I posted is working for me.
