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 daniels
      This is a lightweight alternative to other newsletter & newsletter-subscription modules.
      You can find the Module in the Modules directory and on Github
      It can subscribe, update, unsubscribe & delete a user in a list in Mailchimp with MailChimp API 3.0. It does not provide any forms or validation, so you can feel free to use your own. To protect your users, it does not save any user data in logs or sends them to an admin.
      This module fits your needs if you...
      ...use Mailchimp as your newsletter / email-automation tool ...want to let users subscribe to your newsletter on your website ...want to use your own form, validation and messages (with or without the wire forms) ...don't want any personal user data saved in any way in your ProcessWire environment (cf. EU data regulation terms) ...like to subscribe, update, unsubscribe or delete users to/from different lists ...like the Mailchimp UI for creating / sending / reviewing email campaigns *I have only tested it with PHP 7.x so far, so use on owners risk
      EDIT:
      I've updated the module to 0.0.3. I removed the instructions from this forum, so I don't have to maintain it on multiple places. Just checkout the readme on github 🙂
      If you have questions or like to contribute, just post a reply or create an issue or pr on github. 
    • By blynx
      Hej,
      A module which helps including Photoswipe and brings some modules for rendering gallery markup. Feedback highly appreciated
      (Also pull requests are appreciated 😉 - have a new Job now and don't work a lot with ProcessWire anymore, yet, feel free to contact me here or on GitHub, Im'm still "online"!)

      Modules directory: http://modules.processwire.com/modules/markup-processwire-photoswipe
      .zip download: https://github.com/blynx/MarkupProcesswirePhotoswipe/archive/master.zip
      You can add a photoswipe enabled thumbnail gallery / lightbox to your site like this. Just pass an image field to the renderGallery method:
      <?php $pwpswp = $modules->get('Pwpswp'); echo $pwpswp->renderGallery($page->nicePictures); Options are provided like so:
      <?php $galleryOptions = [ 'imageResizerOptions' => [ 'size' => '500x500' 'quality' => 70, 'upscaling' => false, 'cropping' => false ], 'loresResizerOptions' => [ 'size' => '500x500' 'quality' => 20, 'upscaling' => false, 'cropping' => false ], 'pswpOptions' => (object) [ 'shareEl' => false, 'indexIndicatorSep' => ' von ', 'closeOnScroll' => false ] ]; echo $pswp->renderGallery($page->images, $galleryOptions); More info about all that is in the readme: https://github.com/blynx/MarkupProcesswirePhotoswipe
      What do you think? Any ideas, bugs, critique, requests?
      cheers
      Steffen
    • 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://gitlab.com/baumrock/RockFinder/tree/master
       
      Changelog
      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 flydev
      OAuth2Login for ProcessWire
      A Module which give you ability to login an existing user using your favorite thrid-party OAuth2 provider (i.e. Facebook, GitHub, Google, LinkedIn, etc.)..
      You can login from the backend to the backend directly or render a form on the frontend and redirect the user to a choosen page.
      Built on top of ThePhpLeague OAuth2-Client lib.
      Registration is not handled by this module but planned.
       
      Howto Install
      Install the module following this procedure:
       - http://modules.processwire.com/modules/oauth2-login/
       - https://github.com/flydev-fr/OAuth2Login
      Next step, in order to use a provider, you need to use Composer to install each provider
      ie: to install Google, open a terminal, go to your root directory of pw and type the following command-line: composer require league/oauth2-google
      Tested providers/packages :
          Google :  league/oauth2-google     Facebook: league/oauth2-facebook     Github: league/oauth2-github     LinkedIn: league/oauth2-linkedin
      More third-party providers are available there. You should be able to add a provider by simply adding it to the JSON config file.

      Howto Use It
      First (and for testing purpose), you should create a new user in ProcessWire that reflect your real OAuth2 account information. The important informations are, Last Name, First Name and Email. The module will compare existing users by firstname, lastname and email; If the user match the informations, then he is logged in.
      ie, if my Google fullname is John Wick, then in ProcessWire, I create a new user  Wick-John  with email  johnwick@mydomain.com
      Next step, go to your favorite provider and create an app in order to get the ClientId and ClientSecret keys. Ask on the forum if you have difficulties getting there.
      Once you got the keys for a provider, just paste it into the module settings and save it. One or more button should appear bellow the standard login form.
      The final step is to make your JSON configuration file.
      In this sample, the JSON config include all tested providers, you can of course edit it to suit your needs :
      { "providers": { "google": { "className": "Google", "packageName": "league/oauth2-google", "helpUrl": "https://console.developers.google.com/apis/credentials" }, "facebook": { "className": "Facebook", "packageName": "league/oauth2-facebook", "helpUrl": "https://developers.facebook.com/apps/", "options": { "graphApiVersion": "v2.10", "scope": "email" } }, "github": { "className": "Github", "packageName": "league/oauth2-github", "helpUrl": "https://github.com/settings/developers", "options": { "scope": "user:email" } }, "linkedin": { "className": "LinkedIn", "packageName": "league/oauth2-linkedin", "helpUrl": "https://www.linkedin.com/secure/developer" } } }  
      Backend Usage
      In ready.php, call the module :
      if($page->template == 'admin') { $oauth2mod = $modules->get('Oauth2Login'); if($oauth2mod) $oauth2mod->hookBackend(); }  
      Frontend Usage
      Small note: At this moment the render method is pretty simple. It output a InputfieldForm with InputfieldSubmit(s) into wrapped in a ul:li tag. Feedbacks and ideas welcome!
      For the following example, I created a page login and a template login which contain the following code :
      <?php namespace ProcessWire; if(!$user->isLoggedin()) { $options = array( 'buttonClass' => 'my_button_class', 'buttonValue' => 'Login with {provider}', // {{provider}} keyword 'prependMarkup' => '<div class="wrapper">', 'appendMarkup' => '</div>' ); $redirectUri = str_lreplace('//', '/', $config->urls->httpRoot . $page->url); $content = $modules->get('Oauth2Login')->config( array( 'redirect_uri' => $redirectUri, 'success_uri' => $page->url ) )->render($options); }
      The custom function lstr_replace() :
      /* * replace the last occurence of $search by $replace in $subject */ function str_lreplace($search, $replace, $subject) { return preg_replace('~(.*)' . preg_quote($search, '~') . '~', '$1' . $replace, $subject, 1); }  
      Screenshot
       



    • By gRegor
      Updated 2018-05-06:
      Version 2.0.0 released
      Updated 2017-03-27:
      Version 1.1.3 released
      Updated 2016-04-11:
      Version 1.1.2 released

      Updated 2016-02-26:
      Officially in the module directory! http://modules.processwire.com/modules/webmention/

      Updated 2016-02-25:
      Version 1.1.0 is now released. It's been submitted to the module directory so should appear there soon. In the meantime, it's available on GitHub: https://github.com/gRegorLove/ProcessWire-Webmention. Please refer to the updated README there and let me know if you have any questions!
      ------------
      Original post:
       
      This is now out of date. I recommend reading the official README.
       
      I've been working on this one for a while. It's not 100%, but it is to the point I'm using it on my own site, so it's time for me to release it in beta. Once I finish up some of the features described below, I will submit it to the modules directory as a stable plugin.
      For now, you can install from Github. It works on PW2.5. I haven't tested on PW2.6, but it should work there.
      Feedback and questions are welcome. I'm in the IRC channel #processwire as well as #indiewebcamp if you have any questions about this module, webmention, or microformats.
      Thanks to Ryan for the Comments Fieldtype which helped me a lot in the handling of webmentions in the admin area.
      ProcessWire Webmention Module
      Webmention is a simple way to automatically notify any URL when you link to it on your site. From the receiver's perspective, it is a way to request notification when other sites link to it.
      Version 1.0.0 is a stable beta that covers webmention sending, receiving, parsing, and display. An easy admin interface for received webmentions is under development, as well as support for the Webmention Vouch extension.
      Features
      * Webmention endpoint discovery
      * Automatically send webmentions asynchronously * Automatically receive webmentions * Process webmentions to extract microformats   Requirements * php-mf2 and php-mf2-cleaner libraries; bundled with this package and may optionally be updated using Composer. * This module hooks into the LazyCron module.   Installation Github: https://github.com/gRegorLove/ProcessWire-Webmention

      Installing the core module named "Webmention" will automatically install the Fieldtype and Inputfield modules included in this package.   This module will attempt to add a template and page named "Webmention Endpoint" if the template does not exist already. The default location of this endpoint is http://example.com/webmention-endpoint   After installing the module, create a new field of type "Webmentions" and add it to the template(s) you want to be able to support webmentions. Sending Webmentions
      When creating or editing a page that has the Webmentions field, a checkbox "Send Webmentions" will appear at the bottom. Check this box and any URLs linked in the page body will be queued up for sending webmentions. Note: you should only check the "Send Webmentions" box if the page status is "published."   Receiving Webmentions This module enables receiving webmentions on any pages that have have "Webmentions" field, by adding the webmention endpoint as an HTTP Link header. If you would like to specify a custom webmention endpoint URL, you can do so in the admin area, Modules > Webmention.   Processing Webmentions (beta) Currently no webmentions are automatically processed. You will need to browse to the page in the backend, click "Edit," and scroll to the Webmentions field. There is a dropdown for "Visibility" and "Action" beside each webmention. Select "Process" to parse the webmention for microformats.   A better interface for viewing/processing all received webmentions in one place is under development.   Displaying Webmentions (beta) Within your template file, you can use `$page->Webmentions->render()` [where "Webmentions" is the name you used creating the field] to display a list of approved webmentions. As with the Comments Fieldtype, you can also generate your own output.   The display functionality is also under development.   Logs This module writes two logs: webmentions-sent and webmentions-received.   Vouch The Vouch anti-spam extension is still under development.   IndieWeb The IndieWeb movement is about owning your data. It encourages you to create and publish on your own site and optionally syndicate to third-party sites. Webmention is one of the core building blocks of this movement.   Learn more and get involved by visiting http://indiewebcamp.com.   Further Reading * http://indiewebcamp.com/webmention * http://indiewebcamp.com/comments-presentation * http://indiewebcamp.com/reply