psy

DropboxAPI

Recommended Posts

try really quickly to start writing a folder select fieldtype module to be used with the DropboxAPI module. However, I didnt get very far as the fieldtype inputfield module structure is super confusing to me, is there any documentation about creting a simple field type - and yes I've looked at the mapmaker module, i bascially want a list saying you need XYZ functions to make it appear (as I tried implementing from info in Fieldtype.php and wouldnt show up as an option when creating a new field). Any help would be grateful.

Share this post


Link to post
Share on other sites

@benbyf, What you need is an inputfield that extends InputfieldTextarea and implements at least render() and processInput() methods. Using some JS and a process module you can let user select a folder and save it to the textarea.

Start by creating a class that extends InputfieldTextarea, and add a button that fires up a modal to an intermediate process module. You use this module to show a list of folders that user can select using DropboxAPI. then when you get the input from the modal (check out JavaScript files for pwimage and pwlink CKEditor plugins, and ProcessPageEditImageSelect and ProcessPageLinkSelect modules), you save it to a (hidden) textarea (that you rendered in render() method). Using processInput() method you then validate the folder path, clean it up and send it to PW to save on the DB.

 

  • Like 3

Share this post


Link to post
Share on other sites

Thanks @abdus (also nice website!), I'm justing working on the module now and finding i need both inputfield and fieldtypes modules to get things going. Think I'm having trouble still on what both of their relationship is together and what functions are required. I now have them both shoing up (i.e. as a fieldtype to select and showing something on page edit), but can't currently save the info :( not ideal  :)  - I was went back to the MApMaker module for reference which helped abit but couldnt instruct me on how these two modules working toegther.

 

Share this post


Link to post
Share on other sites

Thanks @benbyf, I really appreciate it. I'm working on a v2, and hopefully I'll release it in a few weeks.

You dont have to create a new Fieldtype, using a Textarea field (to store Dropbox folder path or JSON) with a custom Inputfield (for picking Dropbox folders) should suffice. I'll try to flesh out how you would go about creating what I meant in the previous post:

Note: I haven't tested the code below. Regard it as pseudo-code if you will.

  • Create an Inputfield
    class InputfieldDropboxFolderPicker extends InputfieldTextarea {
        public function ___renderReady() {
            $this->modules->JqueryUI->use('modal');
            $this->config->scripts->add(__DIR__ . '/dropboxfolderpicker.js');
        }
        public function ___render() {
            $attrs = $this->getAttributes();
            unset($attrs['value'], $attrs['size'], $attrs['type']);
            $attrs = $this->getAttributesString($attrs);
    
            return "
                <div class='InputfieldDropboxFolderPicker'>
                    <textarea $attrs class='hidden'></textarea>
                    <a class='pw-modal' href='/url/to/my/process/module/?modal=1'>Pick Dropbox Folder</a>
                </div>
            ";
        }
    }

     

  • Continue by creating a ProcessField that uses DropboxAPI and shows a list of folders. Use ProcessPageEditLink.module and ProcessPageEditSelectImage.module modules as your guide.
     

    class ProcessDropboxFolderPicker extends Process {
        public static function getModuleInfo() { ... }
    
        public function execute()
        {
            /** @var $form InputfieldForm */
            $form = $this->modules->InputfieldForm;
            $form->action = './';
            $form->method = 'GET';
    
            $folders = $dropboxApi->getFolders();
            $form->add([
                [
                    'type' => 'radios',
                    'id' => 'pickedFolder',
                    'label' => 'Your folders',
                    'optionColumns' => 2,
                    'options' => $folders
                ]
            ]);
    
            return $form->render();
        }
        function install()
        {
            /** @var $p Page */
            $p = $this->installPage('dropbox-picker', null, 'Dropbox Folder Picker', 'admin');
            $p->addStatus(Page::statusHidden);
        }
        function uninstall()
        {
            $this->uninstallPage();
        }
    }

     

  • Finally a JS file to bring it all together. (\wire\modules\Inputfield\InputfieldCKEditor\plugins\pwlink\plugin.js)

    // dropboxfolderpicker.js
    
    let $textarea = $('.InputfieldDropboxFolderPicker textarea');
    let modalSettings = {
        title: "<i class='fa fa-link'></i> Pick Dropbox Folder",
        open: function() {
            //
        },
        buttons: [{
            'class': "",
            'html': "<i class='fa fa-link'></i> Submit",
            'click': clickInsert
        }]
    };
    
    // create modal window
    let $iframe = pwModalWindow(modalUrl, modalSettings, 'medium');
    
    // modal window load event
    $iframe.load(function() {
    
        let $i = $iframe.contents();
        $i.find("#ProcessPageEditLinkForm").data('iframe', $iframe);
    
        // capture enter key in main URL text input
        jQuery("#link_page_url", $i).keydown(function(event) {
            let $this = jQuery(this);
            let val = jQuery.trim($this.val());
            if (event.keyCode === 13) {
                event.preventDefault();
                if(val.length > 0) clickInsert();
                return false;
            }
        });
    
    }); // load
    
    function clickInsert() {
        let $i = $iframe.contents();
        let pickedFolder = jQuery("#pickedFolder", $i).val();
        let data = {
            'picked': pickedFolder
        };
        $textarea.val(JSON.stringify(data));
        $iframe.dialog("close");
    }

     

Feel free to ask questions and good luck :)

Share this post


Link to post
Share on other sites

Sorry, im super dumb obviously, but dont know need the fieldtype module to implement the new inputfield? how do you choose the inputfield otherwise?

Share this post


Link to post
Share on other sites

I think a module is modifying your field editor, I don't have an "After Save" fieldset on my setup.

Also, change the field type to textarea, or change inputfield class to extend InputfieldText class instead

Share this post


Link to post
Share on other sites

like poking a bear, how we supposed to know any of this?! I don't get any inputfields for text, but i do for textarea. How would i add one for text, or any other fieldtype , and is there any docs on this would be the actually question i guess... super infuriating.

  • Like 1

Share this post


Link to post
Share on other sites

While I agree on having more detailed documentation on module development, you can still add inputfield selector to FieldtypeText by hooking FieldtypeText::getConfigInputfields

Again, not tested:

wire()->addHookAfter('FieldtypeText::getConfigInputfields', function (HookEvent $e) {
    $wrapper = $e->return;
    require_once($e->config->paths->FieldtypeTextarea . 'FieldtypeTextareaHelper.php');
    $helper = new FieldtypeTextareaHelper();
    $inputfields = $helper->getConfigInputfields($e->arguments(0), $wrapper);
});

 

Share this post


Link to post
Share on other sites

Cool thanks @abdus but again how the hell was I supposed to know that??? seems an old choice to have somethings just turn up in the admin (Process modules for example), and other types to be hookable without much reference. Think maybe a config, or function call would do the job... ?

Share this post


Link to post
Share on other sites

Still doesnt make sense to me, anyone else got a tutorial or good examples of how inputfields and field types can be implemented?

Or maybe can even pay someone for an hours english tutorial over hangout or skype, as would like to get to gribs with this for future modules.

Thanks

Share this post


Link to post
Share on other sites

Hi everyone.

I've made a tiny module for adding a folder select input in the admin, this allows you to select a folder path from the dropbox account associated with the DropboxAPI module. This module requires the above DropboxAPI module to work.

I made this with a lot of great advice from @abdus though much simpler than I think they would have done it. TBH I got totally confused about how to implement fieldtypes and inputfield modules and I hope that there could be an effort for tutorials or docs on this - e.g. requirements to register a inputfield, setting and using config options, interacting with the input on a page, creating a fieldtype and requirements, schema best practise.. etc.

 

https://github.com/benbyford/InputfieldDropbox

install / setup:

  • DropboxAPI module
    • download and install DropboxAPI module, adding to your site/modules folder
    • install in modules section of admin
    • goto: https://www.dropbox.com/developers/apps
    • add new app
    • choose dropbox api, folder access, then name the folder which will appear in your dropbox /apps/
    • copy api codes and add to DropboxAPI settings.
  • InputfieldDropbox module
    • download and install InputfieldDropbox module, adding to your site/modules folder
    • install in modules section of admin
    • add new textarea field in processwire admin, save
    • within Details tab, select Dropbox on Input type select box.

dropboxinputfield.gif.37653f28ba7f04e6bea9a09924d2d8b4.gif

This gif shows me selecting from options found within my dropbox account within folder /apps/theNameOfTheRegisteredFolder.

  • Like 2

Share this post


Link to post
Share on other sites

Hi Ben, looks great, thanks for sharing!

5 hours ago, benbyf said:

I hope that there could be an effort for tutorials or docs on this

+1 :) 

  • Like 1

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 OLSA
      Hello for all,
      ConfigurationForm fieldtype module is one my experiment from 2016.
      Main target to build this module was to store multiple setup and configuration values in just 1 field and avoid to use 1 db table to store just single "number of items on page", or another db table to store "layout type" etc. Thanks to JSON formatted storage this module can help you to reduce number of PW native fields in project, save DB space, and reduce number of queries at front-end.
      Install and setup:
      Download (at the bottom ), unzip and install like any other PW module (site/modules/...). Create some filed using this type of field (ConfigurationForm Fieldtype) Go to field setup Input tab and drag some subfields to container area (demo). Set "Name" and other params for subfields Save and place field to templates ("Action tab") How to use it:
      In my case, I use it to store setup and configurations values, but also for contact details, small content blocks... (eg. "widgets").
      Basic usage example:
      ConfigForm fieldtype "setup" has subfields:
      "limit", type select, option values: 5, 10, 15, 20
      "sort", type select, option values: "-date", "date",  "-sort", "sort"
      // get page children (items) $limit = isset($page->setup->limit) ? $page->setup->limit : 10; $sort = isset($page->setup->sort) ? $page->setup->sort : '-sort'; $items = $page->children("limit=$limit, sort=$sort");  
      Screenshots:


       
      Notes:
      Provide option to search inside subfields Provide multilanguage inputs for text and textarea field types Provide option for different field layout per-template basis Do not place/use field type "Button" or "File input" because it won't works. Please read README file for more details and examples Module use JSON format to store values. Text and textarea field types are multilanguage compatible, but please note that main target for this module was to store setup values and small content blocks and save DB space. Search part inside JSON is still a relatively new in MySQL (>=5.77) and that's on you how and for what to use this module.
      Thanks:
      Initial point for this fieldtype was jQuery plugin FormBuiled and thanks to Kevin Chappel for this plugin.
      In field type "link" I use javascript part from @marcostoll module and thanks to him for that part.
      Download:
      FieldtypeConfigForm.zip
      Edit: 14. August 2018. please delete/uninstall previously downloaded zip
      Regards.
         
    • By bernhard
      @Sergio asked about the pdf creation process in the showcase thread about my 360° feedback/survey tool and so I went ahead and set my little pdf helper module to public.
      Description from PW Weekly:
       
      Modules Directory: https://modules.processwire.com/modules/rock-pdf/
      Download & Docs: https://gitlab.com/baumrock/RockPdf
       
      You can combine it easily with RockReplacer: 
      See also a little showcase of the RockPdf module in this thread:
       
    • By bernhard
      WHY?
      This module was built to fill the gap between simple $pages->find() operations and complex SQL queries.
      The problem with $pages->find() is that it loads all pages into memory and that can be a problem when querying multiple thousands of pages. Even $pages->findMany() loads all pages into memory and therefore is a lot slower than regular SQL.
      The problem with SQL on the other hand is, that the queries are quite complex to build. All fields are separate tables, some repeatable fields use multiple rows for their content that belong to only one single page, you always need to check for the page status (which is not necessary on regular find() operations and therefore nobody is used to that).
      In short: It is far too much work to efficiently and easily get an array of data based on PW pages and fields and I need that a lot for my RockGrid module to build all kinds of tabular data.

      Basic Usage

       
      Docs & Download
      https://modules.processwire.com/modules/rock-finder/
      https://gitlab.com/baumrock/RockFinder/tree/master
       
      Changelog
      180810, v1.0.5, basic support for options fields 180528, v1.0.4, add custom select statement option 180516, change sql query method, bump version to 1.0.0 180515, multilang bugfix 180513, beta release <180513, preview/discussion took place here: https://processwire.com/talk/topic/18983-rocksqlfinder-highly-efficient-and-flexible-sql-finder-module/
    • By Thomas Diroll
      Hi guys I'm relatively new to PW and just finished developing a page for a client. I was able to include all necessary functionality using the core fieldtypes but now I it seems that I need to extend them with a custom one. What I need is a simple button, that copies the absolute url (frontend not PW-backend) of the page which is currently edited to the clipboard. As this feature is only needed inside a specific template, I tend to use a custom fieldtype which provides this feature. I've been looking inside the core modules code (eg. FieldtypeCheckbox.module) but I don't really get the structure of it and how its rendered to the admin page. I also didn't find a lot of tutorials covering custom fieldtypes.
      Maybe some of you could give me some tips on how to write a basic custom fieldtype that renders a button which copies the value of
      page->httpUrl() to the clipboard using JS. Thanks!
    • By bernhard
      Some of you might have followed the development of this module here: https://processwire.com/talk/topic/15524-previewdiscussion-rockdatatables/ . It is the successor of "RockDataTables" and requires RockFinder to get the data for the grid easily and efficiently. It uses the open source part of agGrid for grid rendering.
       
      WHY?
      ProcessWire is awesome for creating all kinds of custom backend applications, but where it is not so awesome in my opinion is when it comes to listing this data. Of course we have the built in page lister and we have ListerPro, but none of that solutions is capable of properly displaying large amounts of data, for example lists of revenues, aggregations, quick and easy sorts by the user, instant filter and those kind of features. RockGrid to the rescue 😉 
       
      Features/Highlights:
      100k+ rows Instant (client side) filter, search, sort (different sort based on data type, eg "lower/greater than" for numbers, "contains" for strings) extendable via plugins (available plugins at the moment: fullscreen, csv export, reload, batch-processing of data, column sum/statistics, row selection) all the agGrid features (cell renderers, cell styling, pagination, column grouping etc) vanilla javascript, backend and frontend support (though not all plugins are working on the frontend yet and I don't plan to support it as long as I don't need it myself)  
      Limitations:
      While there is an option to retrieve data via AJAX the actual processing of the grid (displaying, filtering, sorting) is done on the client side, meaning that you can get into troubles when handling really large datasets of several thousands of rows. agGrid should be one of the most performant grid options in the world (see the official example page with a 100k row example) and does a lot to prevent problems (such as virtual row rendering), but you should always have this limitation in mind as this is a major difference to the available lister options that do not have this limitation.
      Currently it only supports AdminThemeUikit and I don't plan to support any other admin theme.
       
      Download: https://gitlab.com/baumrock/RockGrid
      Installation: https://gitlab.com/baumrock/RockGrid/wikis/Installation
      Quikckstart: https://gitlab.com/baumrock/RockGrid/wikis/quickstart
      Further instructions: https://gitlab.com/baumrock/RockGrid/wikis/quickstart#further-instructions
       
      Module status: alpha, License: MIT
      Note that every installation and uninstallation sends an anonymous google analytics event to my google analytics account. If you don't want that feel free to remove the appropriate lines of code before installation/uninstallation.
       
      Contribute:
      You can contribute to the development of this and other modules or just say thank you by
      testing, reporting issues and making PRs at gitlab liking this post buying me a drink: paypal.me/baumrock/5 liking my facebook page: facebook.com/baumrock hiring me for pw work: baumrock.com  
      Support: Please note that this module might not be as easy and plug&play as many other modules. It needs a good understanding of agGrid (and JavaScript in general) and it likely needs some looks into the code to get all the options. Please understand that I can not provide free support for every request here in the forum. I try to answer all questions that might also help others or that might improve the module but for individual requests I offer paid support for 60€ per hour.
       
      Changelog
      180730 support subdir installations 180711 bugfix (naming issue) 180630 alpha realease  
      Use Cases / Examples:
      Colored grid cells, Icons, Links etc. The Grid also has a "batcher" feature built in that helps communicating with the server via AJAX and managing resource intensive tasks in batches:

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

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