Gallery

Modules

Documentation

Context Navigation

YUI Library is not responsible for bugs or support with this module. It is available as a free service. For support please contact the module owner with the provided links.

This module has been deprecated and is no longer supported by the module author.

Data Finder (gallery-datafinder)

Last Updated: 10/22/10

Greg Hinch

YUI Contributor

See 14 more by this user.

Created: 11/25/09
Project: YUI 3
License: YUI BSD
YUI Version: 3.2.0
Free for use.

The DataFinder class is a utility that works with a Y.DataSource instance to generate query strings, keep track of previously set query parameters, and turn a list of results into a RecordSet. The Record and RecordSet classes are currently almost direct ports of those classes in the YUI 2 DataTable widget.

DataFinder is fairly simple to use, you start by creating a DataSource instance and configuring that with your DataSchema. You then instantiate a DataFinder and attach the DataSource, subscribe to the success and failure events, set any number of query parameters, and execute a fetch.

Code Sample

YUI().use('gallery-datafinder', function(Y) {
    var ds = new Y.DataSource.IO({
        source : 'test.php?action=testFn'
    });
 
    ds.plug({fn : Y.Plugin.DataSourceJSONSchema, cfg : {
        schema : {
            resultListLocator : "results.list",
            resultFields : [
                "name",
                "email"
            ]
        }
    }});
 
    var df = new Y.DataFinder({
        dataSource : ds
    });
 
    df.after('success', function (args) {
        if (args.records) {
            var myRecordSet = args.records;
            // use RecordSet
        }
    });
 
    df.after('failure', function (args) {
        // Handle the IO failure
    });
 
    df.setParam('foo', 'bar');
    df.fetch();
});

Forum Posts

No forum posts for this module.