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 kixe
      Email Verification
      This module provides functions to validate email adresses and hosts. The module generates a textfile for blacklisted mailhosts (trashmail), which will be always up to date.
      Download
      https://modules.processwire.com/modules/email-verification/
      API
      // get module $mailcheck = $modules->get('EmailVerification'); // return bool/ string - automatted update of blacklist file $mailcheck->blacklisted(email|domain) // return bool - validate a top level domain, checks against IANA list $mailcheck->validTLD(tld) // return array of punycoded TLDs - cyclic updated, data pulled from IANA $mailcheck->getTLDs(cycle=2592000) // return bool - checks syntax converts to punycode $mailcheck->validDomainName(domain); // return bool - checks punycode encoded syntax $mailcheck->validHostName(host); // return bool - checks syntax and accessibility $mailcheck->validHost(email|domain) // add a single value to blacklist $mailcheck->addToBlacklist(email|domain) USAGE
      $mailcheck = $modules->get('EmailCheck'); $email = 'susi@trashmail.com'; if($mailcheck->blacklisted($email)) echo 'Email Provider not allowed'; if(!$mailcheck->validHost($email)) echo 'Mailhost not available'; Example blacklist file:  blacklist.txt
       
    • By teppo
      Code Blocks Textformatter is a tiny Textformatter module I cooked up to add support for code blocks to text/textarea/RTE fields on some of the sites I work with. Unlike a full-blown Markdown Textformatter – which is something that we already have in the core – this module simply adds support for fenced and inline code blocks.
      The syntax is based on the GitHub code block documentation, so please refer to that for additional instructions. The README at GitHub also includes some basic examples. As with any Textformatter, in order to enable this one, install it and enable it via field settings. Note that there's no syntax highlighting built in (at least for the time being), so use a tool of your choice for that – personally I prefer Prism.js.
      Since this module doesn't use a Markdown tool behind the scenes, but rather some home baked regular expressions, there's always the possibility that I've missed something – but please let me know if you use this module and run into any issues. On the other hand this module should be relatively fast and unobtrusive, as there are no unnecessary bits of code to run 
      GitHub repository: https://github.com/teppokoivula/TextformatterCodeBlocks Modules directory: http://modules.processwire.com/modules/textformatter-code-blocks/
    • By theo
      Here is my first processwire module (beta).
      https://github.com/theo222/ImagePickerField
      A lot of "first times". First time Github, Markdown and of course PW Modules.
      So be gentle please.
      I hope it works.

    • By horst
      Image Animated GIF  v 2.0.2
       
      Module for PW 2.5 stable or newer, but is obsolete for PW Versions greater then 3.0.89 (... read more ...)
       
      This module helps with resizing and cropping of animated GIFs when using the GD-Library.
      The GD-Library does not support this.


      This module is completely based upon the fantastic work of

         László Zsidi (http://www.gifs.hu/, builts the initial classes)
         xurei (https://github.com/xurei/GIFDecoder_optimized, enhanced the classes)


      I have ported it to a PW module and it works with core imagefields, together with Pia and with CropImagefields that uses the new naming scheme since PW 2.5.
       
      ------------------------------------------------------------------------------------------------------------------------------------------
      read more in this post about the rewrite from version 1.0.0 to version 2.0.0
      ------------------------------------------------------------------------------------------------------------------------------------------
      You can find it in the modules directory: https://modules.processwire.com/modules/image-animated-gif/
      and on Github: https://github.com/horst-n/ImageAnimatedGif
      ------
      A preview can be found here