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 anderson
      Hi all,
      I'm a new to website building. Learned some CRASH course of js,jquery,php. Then I found CMS. Still learning around forum, youtube....
      Anyway, please help me with some beginer questions:
      1, About template - please correct me if I understand wrong : every page should be (or recommended) built on a template. So if in total I'll have 10 pages, 2 of them have same layout, I'll need 9 templates.  And, what fields a page includes, is not defined in page, but defined in the template that page uses. 
      2,  Where to see what modules I've installed? is it in "Modules - Site"? 
      3, I installed "PageTable Extended", then what?  As in a youtube tutorial, it should appear in Setup tab, but it doesn't.  What's in there: templates,fields,logs,comments. (I installed "Uikit 3 site_blog profile".)
      4, I did a search in Processwire website for the famous "repeater matrix" module, and can not find it, there's a Repeater, as well as a Matrix. Is it not a module?
      5, I watched this youtube tuts: https://www.youtube.com/watch?v=IHqnLQy9R1A
      Anybody familiar with this tuts please help: 
      After he analysed a target webpage layout he wanted to mimic, he created some fields, some template, then based on those he created a page and input some "content" in there, then clicked "view", it's just some text. So, here comes my question, he copied a folder "assets" (subfolders are: css,fonts,js,img) over, then the page have the appearance/layout he wanted to mimic. Where does that assets folder come from?
      Appreciate any help.
    • By mtwebit
      I've created a set of modules for importing (manipulating and displaying) data from external resources. A key requirement was to handle large (100k+) number of pages easily.
      Main features
      import data from CSV and XML sources in the background (using Tasker) purge, update or overwrite existing pages using selectors user configurable input <-> field mappings on-the-fly data conversion and composition (e.g. joining CSV columns into a single field) download external resources (files, images) during import handle page references by any (even numeric) fields How it works
      You can upload CSV or XML files to DataSet pages and specify import rules in their description.
      The module imports the content of the file and creates/updates child pages automatically.
      How to use it
      Create a DataSet page that stores the source file. The file's description field specifies how the import should be done:
      After saving the DataSet page an import button should appear below the file description.

      When you start the import the DataSet module creates a task (executed by Tasker) that will import the data in the background.
      You can monitor its execution and check its logs for errors.

      See the module's wiki for more details.
      The module was already used in three projects to import and handle large XML and CSV datasets. It has some rough edges and I'm sure it needs improvement so comments are welcome.
    • By dreerr
      TemplateEnginePug (formally TemplateEngineJade)
       
      This module adds Pug templates to the TemplateEngineFactory. It uses https://github.com/pug-php/pug to render templates.
      doctype html html(lang='en') head meta(http-equiv='content-type', content='text/html; charset=utf-8') title= $page->title link(rel='stylesheet', type='text/css', href=$config->urls->templates . 'styles/main.css') body include header.pug h1= $page->title if $page->editable() p: a(href=$page->editURL) Edit Project on GitHub: github.com/dreerr/TemplateEnginePug
      Project in modules directory: modules.processwire.com/modules/template-engine-pug/
       
      For common problems/features/questions about the Factory, use the TemplateEngineFactory thread.
       
    • By Robin S
      Pages At Bottom
      Keeps selected pages at the bottom of their siblings.
      A "bottom page" will stay at the bottom even if it is drag-sorted to a different location or another page is drag-sorted below it (after Page List is refreshed the bottom page will still be at the bottom).
      Newly added sibling pages will not appear below a bottom page.
      The module also prevents the API methods $pages->sort() and $pages->insertAfter() from affecting the position of bottom pages.
      Note: the module only works when the sort setting for children on the parent page/template is "Manual drag-n-drop".
      Why?
      Because you want some pages to always be at the bottom of their siblings for one reason or another. And someone requested it. 🙂
      Usage
      Install the Pages At Bottom module.
      Select one or more pages to keep at the bottom of their siblings. If you select more than one bottom page per parent then their sort order in the page list will be the same as the sort order in the module config.

       
      https://github.com/Toutouwai/PagesAtBottom
      https://modules.processwire.com/modules/pages-at-bottom/
    • By Robin S
      Another little admin helper module...
      Template Field Widths
      Adds a "Field widths" field to Edit Template that allows you to quickly set the widths of inputfields in the template.

      Why?
      When setting up a new template or trying out different field layouts I find it a bit slow and tedious to have to open each field individually in a modal just to set the width. This module speeds up the process.
      Installation
      Install the Template Field Widths module.
      Config options
      You can set the default presentation of the "Field widths" field to collapsed or open. You can choose Name or Label as the primary identifier shown for the field. The unchosen alternative will become the title attribute shown on hover. You can choose to show the original field width next to the template context field width.  
      https://github.com/Toutouwai/TemplateFieldWidths
      https://modules.processwire.com/modules/template-field-widths/