Jump to content
Soma

DataTable

Recommended Posts

ProcessWire DataTable 1.0.0 (https://github.com/somatonic/DataTable)

This module enables you to find and edit (fancybox modal iframe) pages at a small and very large scale.

So far it has:

  • ajax suuport
  • masked pagination
  • state saving (datatable using cookie, template filter using session)
  • template filter (only showing templates user has edit access)
  • search text filter (using title|body field)
  • multilanguage support (PW's language translator)

Superuser will see all pages and system templates. Users only those with view|edit access and pages in trash.

This Module is still very simple and only in "lazy" developement and testing and this is the first official release mainly to get it out for others to see and use. It also could provide as an example/kickstart for someone. Everyone is encouraged to help and contribute to further improve or add features. The module is hosted on my github account: https://github.com/somatonic/DataTable

The plugin used in this module is the excellent jQuery Plugin DataTable 1.8.2 - http://datatables.net/

I've chosen it, because I used in in some other web projects and was really happy about it's power and ease to setup. It supports jQuery UI styling, which makes the deal perfect for a ProcessWire module.

Thanks and have fun trying it out.

------

(original post, kept for nostalgic moments)

Ok, I started trying to implement the great jQuery dataTables plugin into ProcessWire.

So far it works very well and is very powerful and fun. Best of it it support jquery themeroller.

Not sure how far this all can go with configuration and how to define which pages should be displayed, what collumns etc...

Many many things to consider. But if it could provide as an example on how to implement it, it would be great tool for site builders.

Here you can see a short video of how it looks and works.

  • Like 3

Share this post


Link to post
Share on other sites

Soma, looks very nice! You are on fire dude :)

You implemented it with ajax pagination already?

Share this post


Link to post
Share on other sites

Yeah, it's fully ajax. Pagination, filtering, sorting... and it saves state, so if you come back it's on the same spot.

It's very cool and fast. I see this as a great alternative to the page tree, when dealing with large lists of products.

  • Like 1

Share this post


Link to post
Share on other sites

Great stuff. Yeah, I have used DataTables many times in the past and always loved that. Very solid software.

EDIT: Will test this soon also. Hopely tomorrow!

Share this post


Link to post
Share on other sites

Great stuff. Yeah, I have used DataTables many times in the past and always loved that. Very solid software.

EDIT: Will test this soon also. Hopely tomorrow!

Yeah I used it in some projects too. It has many great features that can be used and the API is great.

Since I knew already how it works, It took me only a few hours to get it fully working, combined with PW's selector API it's as easy as pie, though has some pitfalls, someone not so experienced will have hard time.

Tell if you want my current version as a starting point. But it's very rough code still.

Share this post


Link to post
Share on other sites

Oh, I didn't realize there wasn't download link nor github link. I'll wait for official release ;)

Share this post


Link to post
Share on other sites

Soma this is awesome! Thanks for posting the video. Antti's right–you are on fire! I can't wait to give this a try.

Share this post


Link to post
Share on other sites

I just pushed a first version for testing to github. See first post for Infos. ;)

Edit: While at it. Ryan, I can't deinstall the module, the deinstall field is disabled to open on the module page. Why is that? How would it be possible to get it to work?

Share this post


Link to post
Share on other sites

Great work Soma, it looks and works great! A great alternate way to navigate pages in the admin. Just tested here and it works great.

Edit: While at it. Ryan, I can't deinstall the module, the deinstall field is disabled to open on the module page. Why is that? How would it be possible to get it to work?

Javascript error, ProcessDataTable.js line 26.

Share this post


Link to post
Share on other sites

Javascript error, ProcessDataTable.js line 26.

Thanks Ryan, it was autoloading the js on module page even though it shouldn't (?). SInce the module isn't loaded there's missing config it would spit out. I renamed the js and load it explicitly on init to avoid this problem.

Share this post


Link to post
Share on other sites

Soma, you are right it shouldn't be autoloading that JS, given that the module is not an autoload one. Turns out that the $modules->isUninstallable($class) was inadvertently init'ing the class when it did its check, so it was causing the modules init() function to be called when viewing its config screen. Just fixed this in latest commit.

Thanks,

Ryan

Share this post


Link to post
Share on other sites

I'm trying to use this module as a starting point for my own DataTable-based module, but I'm running into a few problems.

I've basically copied the entire code into a new folder so I can rename the class, JS file etc try to return some static JSON in my new executeGetData() method, but when my new page first loads the function is never being called. That is to say that the AJAX request isn't being made.

I'm no JS expert so I can't work out if there's some place where the initial request is being made from within the JS code in DataTable.js.

Ultimately my question is this: -

When I first load the DataTable page, from where does the very first AJAX request get called that turns the plain HTML table into the DataTable? I have the duplicated JS and CSS classes in the same folders underneath my module folder and I have checked (with Firebug) that all files are being loaded correctly, so I'm now at a brick wall!!

Thanks in advance.

Share this post


Link to post
Share on other sites

The DataTable.js contains the initialize script. There's an option "sAjaxSource": "getdata", which defines the ajax url. This is called automaticly by DataTable plugin when page is loaded.

But I can't see why it wouldn't work, even if you renamed the module it should still work. It just calls "/page-you-are-on/getdata".

I wonder if you're using this on frontend or in admin?

Edit: Or have you renamed the table class?

It is initialized in DataTable.js using

var datatable = $('.dataTable').dataTable({ ...});

So if you renamed the class on the empty table output you need to rename it here too.

Share this post


Link to post
Share on other sites

Thanks Soma.

I suspected that the init script was being run by the core DataTable code but I didn't check to be honest.

I haven't changed the table class or anything else really. I have changed module-related data such as name but I haven't fiddled the JS code. I've even run diffs on my code vs yours to try to find anything glaring but nothing jumps out at me.

Very strange!

Share this post


Link to post
Share on other sites

Are you trying to use it on frontend or is it still in the admin?

Share this post


Link to post
Share on other sites

It's in the admin.

I'm now diffing my files with yours again to see the differences and work out if there's something vital going on that I've missed.

Share this post


Link to post
Share on other sites

I assume that my module is working out of the box? Just to make sure.

Share this post


Link to post
Share on other sites

Yep your module works fine as far as I can tell.

Share this post


Link to post
Share on other sites

Hmm, make sure everything is loaded. And check if there's any js error's or any ajax request's being made. Or try to put alert("hello"); at certain points in the /DataTable/DataTable.js to see if it gets there. If you can't figure it out send me your files and I'll work it out.

Share this post


Link to post
Share on other sites

Somehow I'd ended up with this line...

$this->config->js($this->className(), $lang);

...BEFORE I'd set up the $lang array. I moved it after and it's rendering the table now.

Next up....set up the AJAX handler method to work properly.

Thanks for trying to help!

Share this post


Link to post
Share on other sites

Hi again Soma.

Did you ever experience any problems with caching? I have a strange issue where my getdata() method returns new data if I use the pagination links but does not if I use the headers to change the sort column or direction.

I thought it might be client-side cache but it seems unlikely if it works with some requests and not others. I have compared the request vars going to the server with your datatable code and I haven't spotted any extra fields or otherwise different behaviour.

The AJAX request is definitely being made and the request params are changing with the different heading clicks, but the returned data doesn't change unless I use the pagination links.

Share this post


Link to post
Share on other sites

It's hard to tell from here. There's a request being made but no data returned in the response?

I think you need to make sure the fiel(cols) you make sortable can really be sorted using PW fields. Also it can be really hard to find problems, since only 1 little thing wrong and the whole breaks.

What I did often was to output some debug info in getdata function (print_r or echo vars). If you inspect the returned data by the ajax request, you'll be able to see it or spot errors.

One thing there's still left in the code (commented) is

echo $selector;
exit();

This will let you see the PW selector generated, make sure it is correct.

Share this post


Link to post
Share on other sites

Hi Soma,

can this be used in the frontend?

I want to use DataTables with my MP3-DB in the frontend with AJAX-Pagination and -Sorting.

Share this post


Link to post
Share on other sites

I haven't tried and I don't thin it would work just out of the box, but it would be easy to adapt it to use in front-end. You only need the js script to be added and run the execute like

$dt = $modules->get("DatTable");
echo $dt->execute();

Share this post


Link to post
Share on other sites

I haven't tried and I don't thin it would work just out of the box, but it would be easy to adapt it to use in front-end. You only need the js script to be added and run the execute like

$dt = $modules->get("DatTable");
echo $dt->execute();

thank you for the info. I will try it out. :)

Share this post


Link to post
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.


  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By Robin S
      A community member raised a question and I thought a new sanitizer method for the purpose would be useful, hence...
      Sanitizer Transliterate
      Adds a transliterate method to $sanitizer that performs character replacements as defined in the module config. The default character replacements are based on the defaults from InputfieldPageName, but with uppercase characters included too.
      Usage
      Install the Sanitizer Transliterate module.
      Customise the character replacements in the module config as needed.
      Use the sanitizer on strings like so:
      $transliterated_string = $sanitizer->transliterate($string);
       
      https://github.com/Toutouwai/SanitizerTransliterate
      https://modules.processwire.com/modules/sanitizer-transliterate/
       
    • By dimitrios
      Hello,
      this module can publish content of a Processwire page on a Facebook page, triggered by saving the Processwire page.
      To set it up, configure the module with a Facebook app ID, secret and a Page ID. Following is additional configuration on Facebook for developers:
      Minimum Required Facebook App configuration:
      on Settings -> Basics, provide the App Domains, provide the Site URL, on Settings -> Advanced, set the API version to 2.10, add Product: Facebook Login, on Facebook Login -> Settings, set Client OAuth Login: Yes, set Web OAuth Login: Yes, set Enforce HTTPS: Yes, add "http://www.example.com/processwire/page/" to field Valid OAuth Redirect URIs. This module is configurable as follows:
      Templates: posts can take place only for pages with the defined templates. On/Off switch: specify a checkbox field that will not allow the post if checked. Specify a message and/or an image for the post.
      Usage
      edit the desired PW page and save; it will post right after the initial Facebook log in and permission granting. After that, an access token is kept.
       
      Download
      PW module directory: http://modules.processwire.com/modules/auto-fb-post/ Github: https://github.com/kastrind/AutoFbPost   Note: Facebook SDK for PHP is utilized.


    • By thomasaull
      I created a little helper module to trigger a CI pipeline when your website has been changed. It's quite simple and works like this: As soon as you save a page the module sets a Boolean via a pages save after hook. Once a day via LazyCron the module checks if the Boolean is set and sends a POST Request to a configurable Webhook URL.
      Some ideas to extend this:
      make request type configurable (GET, POST) make the module trigger at a specified time (probably only possible with a server cronjob) trigger manually Anything else? If there's interest, I might put in some more functionality. Let me know what you're interested in. Until then, maybe it is useful for a couple of people 🙂
      Github Repo: https://github.com/thomasaull/CiTrigger
    • By Robin S
      I created this module a while ago and never got around to publicising it, but it has been outed in the latest PW Weekly so here goes the support thread...
      Unique Image Variations
      Ensures that all ImageSizer options and focus settings affect image variation filenames.

      Background
      When using methods that produce image variations such as Pageimage::size(), ProcessWire includes some of the ImageSizer settings (height, width, cropping location, etc) in the variation filename. This is useful so that if you change these settings in your size() call a new variation is generated and you see this variation on the front-end.
      However, ProcessWire does not include several of the other ImageSizer settings in the variation filename:
      upscaling cropping, when set to false or a blank string interlace sharpening quality hidpi quality focus (whether any saved focus area for an image should affect cropping) focus data (the top/left/zoom data for the focus area) This means that if you change any of these settings, either in $config->imageSizerOptions or in an $options array passed to a method like size(), and you already have variations at the requested size/crop, then ProcessWire will not create new variations and will continue to serve the old variations. In other words you won't see the effect of your changed ImageSizer options on the front-end until you delete the old variations.
      Features
      The Unique Image Variations module ensures that any changes to ImageSizer options and any changes to the focus area made in Page Edit are reflected in the variation filename, so new variations will always be generated and displayed on the front-end.
      Installation
      Install the Unique Image Variations module.
      In the module config, set the ImageSizer options that you want to include in image variation filenames.
      Warnings
      Installing the module (and keeping one or more of the options selected in the module config) will cause all existing image variations to be regenerated the next time they are requested. If you have an existing website with a large number of images you may not want the performance impact of that. The module is perhaps best suited to new sites where image variations have not yet been generated.
      Similarly, if you change the module config settings on an existing site then all image variations will be regenerated the next time they are requested.
      If you think you might want to change an ImageSizer option in the future (I'm thinking here primarily of options such as interlace that are typically set in $config->imageSizerOptions) and would not want that change to cause existing image variations to be regenerated then best to not include that option in the module config after you first install the module.
       
      https://github.com/Toutouwai/UniqueImageVariations
      https://modules.processwire.com/modules/unique-image-variations/
    • By Sebi
      I've created a small module which lets you define a timestamp after which a page should be accessible. In addition you can define a timestamp when the release should end and the page should not be accessable any more.
      ProcessWire-Module: http://modules.processwire.com/modules/page-access-releasetime/
      Github: https://github.com/Sebiworld/PageAccessReleasetime
      Usage
      PageAccessReleasetime can be installed like every other module in ProcessWire. Check the following guide for detailed information: How-To Install or Uninstall Modules
      After that, you will find checkboxes for activating the releasetime-fields at the settings-tab of each page. You don't need to add the fields to your templates manually.
      Check e.g. the checkbox "Activate Releasetime from?" and fill in a date in the future. The page will not be accessable for your users until the given date is reached.
      If you have $config->pagefileSecure = true, the module will protect files of unreleased pages as well.
      How it works
      This module hooks into Page::viewable to prevent users to access unreleased pages:
      public function hookPageViewable($event) { $page = $event->object; $viewable = $event->return; if($viewable){ // If the page would be viewable, additionally check Releasetime and User-Permission $viewable = $this->canUserSee($page); } $event->return = $viewable; } To prevent access to the files of unreleased pages, we hook into Page::isPublic and ProcessPageView::sendFile.
      public function hookPageIsPublic($e) { $page = $e->object; if($e->return && $this->isReleaseTimeSet($page)) { $e->return = false; } } The site/assets/files/ directory of pages, which isPublic() returns false, will get a '-' as prefix. This indicates ProcessWire (with activated $config->pagefileSecure) to check the file's permissions via PHP before delivering it to the client.
      The check wether a not-public file should be accessable happens in ProcessPageView::sendFile. We throw an 404 Exception if the current user must not see the file.
      public function hookProcessPageViewSendFile($e) { $page = $e->arguments[0]; if(!$this->canUserSee($page)) { throw new Wire404Exception('File not found'); } } Additionally we hook into ProcessPageEdit::buildForm to add the PageAccessReleasetime fields to each page and move them to the settings tab.
      Limitations
      In the current version, releasetime-protected pages will appear in wire('pages')->find() queries. If you want to display a list of pages, where pages could be releasetime-protected, you should double-check with $page->viewable() wether the page can be accessed. $page->viewable() returns false, if the page is not released yet.
      If you have an idea how unreleased pages can be filtered out of ProcessWire selector queries, feel free to write an issue, comment or make a pull request!
×
×
  • Create New...