FileDownload

The parameters are adopted from the evolution's with several changes, so the previous user can easily understand about their usages.

Basic usage is [[!FileDownload?]]

Main¶

downloadByOther¶

available since v.1.0.0-pl

Note for &downloadByOther: Example: You have the need to use javascript pop-up window to force the downloader to fill up a form before downloading. Then through AJAX, you submit the form, and expect results with conditions. If the result, for instance, returns true, the AJAX calls the download's API to start the download.

File Chunk¶

You need to create chunk for the file's rows. Eg: jsDownload chunk

<tr[[+fd.class]]>
    <td style="width:16px;"><img src="[[+fd.image]]" alt="[[+fd.image]]" /></td>
    <td>
        <a href="javascript:void(0);"
           rel="#formLink"
           id="[[+fd.hash]]"
           >[[+fd.filename]]
        </a>
        <span style="font-size:80%">([[+fd.count]] downloads)</span>
    </td>
    <td>[[+fd.sizeText]]</td>
    <td>[[+fd.date]]</td>
</tr>
[[-- This is the description row if the &chkDesc=`chunkName` is provided --]]
[[+fd.description:notempty=`<tr>
    <td></td>
    <td colspan="3">[[+fd.description]]</td>
</tr>`:default=``]]

HTML¶

downloaderForm is the basic HTML form with fields.

In this example, I'm also using jQuerytools's overlay and validator. The for is placed directly under the snippet call. It's hidden by CSS.

So the snippet call would be like this:

[[!FileDownload?
&getDir=`assets/downloads`
&tplFile=`jsDownload`
&downloadByOther=`1`
]]
<div class="form_overlay" id="formLink">
<h2>Contact Form</h2>
<form action="[[~[[*id]]]]" method="post" class="form" id="downloaderForm">
    <input type="hidden" name="nospam:blank" value="" />
    <input type="hidden" name="link" value="" />
    <label for="name">Name:</label>
    <input type="text" name="name" id="name" value="" required="required" />
    <br />
    <label for="email">Email:</label>
    <input type="email" name="email" id="email" value="" required="required" />
    <br />
    <label for="phone">Phone:</label>
    <input type="number" name="phone" id="phone" value="" required="required" />
    <br />
    <label for="country">Country:</label>
    <input type="text" name="country" id="country" value="" required="required" />
    <br />
    <div class="form-buttons">
        <button type="submit">Send Contact Inquiry</button>
        <button type="reset">Reset</button>
    </div>
</form>
</div>

javascript¶

$(function(){
var c = 'assets/components/yourpackage/c.php?';
createForm();
function createForm() {
    $(".fd-file a[rel]").each(function(i) {
        var self = $(this);
        self.overlay({
            effect: 'apple',
            onLoad: function() {
                var id = self.attr('id');
                $("#downloaderForm input[name=link]").val(id);
            },
            onBeforeClose: function(){
                $(".error").hide();
                $("#downloaderForm input").each(function(){
                    $(this).removeClass('invalid');
                });
                $("#downloaderForm input[name=link]").val('');
                clearForm($("#downloaderForm"));
            }
        });
    });
    $("#downloaderForm").validator().submit(function(e){
        var form = $(this);
        if (!e.isDefaultPrevented()) {
            $.post(c + 'action=web/form/add&ctx=web&' + form.serialize(), function(data) {
                if (data && data.success === true)  {
                    clearForm(form);
                    $(".fd-file a[rel]").each(function(i) {
                        $(this).overlay().close();
                    });
                    fileDownload(c + 'action=web/file/get&ctx=web&link=' + data.link);
                    $(".fd-file a[rel]").each(function(i) {
                        var self = $(this);
                        self.off();
                        var link = self.attr('id');
                        self.attr('onclick', 'fileDownload("' + c + 'action=web/file/get&ctx=web&link=' + link+'")');
                    });
                } else {
                    form.data("validator").invalidate(data);
                }
            }, "json");
            e.preventDefault();
        }
    });
}
function clearForm(form) {
    form.find(':input').each(function() {
        switch(this.type) {
            case 'password':
            case 'select-multiple':
            case 'select-one':
            case 'text':
            case 'email':
            case 'number':
            case 'textarea':
                $(this).val('');
                break;
            case 'checkbox':
            case 'radio':
                this.checked = false;
        }
    });
}
});
function fileDownload(link) {
$('<iframe/>',{
    src: link
}).hide().appendTo($('body'));
}

connector¶

And the connector would be like this:

<?php
/**
* FileDownload R's AJAX connector file
*/
$validActions = array(
    'web/file/get',
    'web/form/add'
);
if (!empty($_REQUEST['action']) && in_array($_REQUEST['action'], $validActions)) {
    @session_cache_limiter('public');
    define('MODX_REQP', false);
}
require_once dirname(dirname(dirname(dirname(__FILE__)))) . '/config.core.php';
require_once MODX_CORE_PATH . 'config/' . MODX_CONFIG_KEY . '.inc.php';
require_once MODX_CONNECTORS_PATH . 'index.php';
$corePath = $modx->getOption('filedownload.core_path', null, $modx->getOption('core_path') . 'components/filedownload/');
require_once $corePath . 'models/filedownload/filedownload.class.php';
$modx->filedownload = new FileDownload($modx);
$modx->lexicon->load('filedownload:default');
if (in_array($_REQUEST['action'], $validActions)) {
    $version = $modx->getVersionData();
    if (version_compare($version['full_version'], '2.1.1-pl') >= 0) {
        if ($modx->user->hasSessionContext($modx->context->get('key'))) {
            $_SERVER['HTTP_MODAUTH'] = $_SESSION["modx.{$modx->context->get('key')}.user.token"];
        } else {
            $_SESSION["modx.{$modx->context->get('key')}.user.token"] = 0;
            $_SERVER['HTTP_MODAUTH'] = 0;
        }
    } else {
        $_SERVER['HTTP_MODAUTH'] = $modx->site_id;
    }
    $_REQUEST['HTTP_MODAUTH'] = $_SERVER['HTTP_MODAUTH'];
}
/* handle request */
$path = $modx->getOption('core_path') . 'components/yourpackage/processors/';
$modx->request->handleRequest(array(
    'processors_path' => $path,
    'location' => '',
));

processors¶

core/components/yourpackage/processors/web/file/get/ example:

<?php
if (!$modx->loadClass('FileDownload', $modx->getOption('core_path') . 'components/filedownload/models/', true, true)) {
    $modx->log(modX::LOG_LEVEL_ERROR, '[FileDownload] Could not load FileDownload class.');
    return '';
}
$fdl = $modx->getService('fdl', 'FileDownload' , $modx->getOption('core_path') . 'components/filedownload/models/filedownload/'
);
$configs = array();
$configs['countDownloads'] = true;
$fdl->setConfigs($configs);
$downloadFile = $fdl->downloadFile($scriptProperties['link']);    // <== THIS IS WHERE YOU DOWNLOAD THE FILE
if (!$downloadFile) {
    $output = array('success' => FALSE);
} else {
    $output = array('success' => TRUE);
}
return json_encode($output);

Salt for hash¶

The link is a hashed text of the saltText, context, and filename/dirname combination. So if you change the saltText value after a while, it will not block the content's appearance from the page, but the database will start the counter from zero again since it will not find the same hashed value.

Additional¶

Sorting¶

Multiple sorting orders are applied as these orders:

• File sort: filename
• browseDirectories : dir, filename
• groupByDirectory : path, dir, filename

Example¶

[[!FileDownload?
    &getDir=`[[++core_path]]downloads-from-core/land rover, assets/downloads`
    &browseDirectories=`1`
    &groupByDirectory=`1`
]]

Template¶

tplWrapperDir & tplWrapperFile (1.0.0-rc.5) are used to provide different wrappers between folders and files. That means that they might have different headers. There are the default chunks inside {core_path}components/filedownload/elements/chunks/, which are tpl-wrapper-dir.chunk.tpl and tpl-wrapper file.chunk.tpl, respectively. To use them, tplWrapper must be changed too or set it empty instead.

FileDownload R has @BINDING directives for the template:

• @CODE|@INLINE
• @FILE
• @CHUNK (or not at all) - default

[[!FileDownload?
    &getDir=`assets/downloads`
    &tplFile=`@CODE:    <tr[[+fd.class]]>
        <td>
            <span class="fd-icon">
                <img src="[[+fd.image]]" alt="" />
            </span>
            <a href="[[+fd.url]]">[[+fd.filename]]</a>
            <span style="font-size:80%">([[+fd.count]] downloads)</span>
        </td>
        <td>[[+fd.sizeText]]</td>
        <td>[[+fd.date]]</td>
    </tr>`
]]

Example¶

[[!FileDownload?
    &getDir=`assets/downloads`
    &browseDirectories=`1`
    &tplWrapper=``
    &tplWrapperDir=`tpl-wrapper-dir`
    &tplWrapperFile=`tpl-wrapper-file`
]]

Headers¶

Style¶