Features

1. The client JavaScript and example server php script implement the following dojo.data APIs:
   • dojo.data.api.Read and
   • dojo.data.api.Identity.
2. A deliberately simple client side implementation for use as a reference when implementing other server side stores that wish to provide lazy-loading as defined by the dojo.data.api.Read spec. The client code is deliberately small to make it easy to understand.
3. The ability to search across a variety of attributes, such as name, path, parentDir, lastModified, etc. It also allows for matching on multiple fields, such as all files with parentDir of ‘foo’, that have filename: ‘bar*.js’.
4. The datastore can do shallow searching (root dir only), or recursive searching (scan the entire file system for matches across the parameters).
5. The client store can directly access information about a specific about a file through RESTlike patterns that work well with servlets that allow mapping of a context root to a servlet, and the servlet’s ability to get extra path information. It can also work with back-end services like PHP that do not provide a mechanism to do URL path based queries by converting the path into a query param, ‘path’. This is enabled by setting pathAsQueryParam to true on the store instance.
6. Support for all normal query options as defined by the dojo.data.api.Read specification. Deep provides recursive tree searching, ignoreCase provides the ability to ignore the case sensitivity of attributes when matching, and so on.
7. An example implementation of the back end service in PHP. The example is documented cleanly and is less than five hundred lines of code, making it relatively easy to dissect and understand.
8. Works directly with all current data bound widgets in dijit, including dijit.Tree, dijit.form.ComboBox, and as well dojox.grid.

Item structure

All items returned by a query to the FileStore and will generally have the following attributes accessible via FileStore.getValue(item, attribute) and FileStore.getValues(item, attribute):

Query Structure

The dojox.data.FileStore query structure follows that of dojo.data.ItemFileReadStore. It is an object-based query structure where the store queries for file items using patterns defined for the attributes to be matched. For example a query object of:

{
  name: "foo*.txt"
}

would return all files that have the name foo at the start of the name and end with the extension .txt.

Please note that the store is a hierarchical store and if you wish to query the entire file system (not just the root of it), for a file name, you must set the standard dojo.data.api.Read queryOption 'deep' to the value true.

Examples

Using the dojox.dataFileStore is generally simple. The store takes three possible constructor options which can also be declared in markup. These options configure the store and its operating behavior. The options are defined below in a table.

Some usage examples for using the service in code as well as declarative markup attaching it to a widget such as dijit.Tree, dijit.form.ComboBox, and dojox.grid.DataGrid are shown below.

var fileStore = new dojox.data.FileStore({url: "myService.php", pathAsQueryParam: true});
  function searchDone(items, request){
    if(items){
      var i;
      for(i = 0; i < items.length; i++){
        console.log("Found file: " + fileStore.getValue(items[i], "name") + " in directory: " + fileStore.getValue(items[i], "parentDir"));
      }
    }
  }
  fileStore.fetch({query: {name:"foo*.txt"}, onComplete: searchDone, queryOptions: {deep:true}});
}

dojo.require("dijit.Tree");
dojo.require("dojox.data.FileStore");

<div>
  <div data-dojo-type="dojox.data.FileStore" data-dojo-props="url:'{{dataUrl}}dojox/data/demos/stores/filestore_dojotree.php', pathAsQueryParam:true" data-dojo-id="dojoFiles"></div>
  <div data-dojo-type="dijit.tree.ForestStoreModel" data-dojo-id="fileModel" data-dojo-props="store:dojoFiles, query:{}, rootId:'DojoFiles', rootLabel:'Dojo Files', childrenAttrs:'children'"></div>
  <div id="tree" data-dojo-type="dijit.Tree" data-dojo-props="model:fileModel" ></div>
</div>

dojo.require("dijit.form.ComboBox");
dojo.require("dojox.data.FileStore");

<div>
  <div data-dojo-type="dojox.data.FileStore" data-dojo-props="url:'{{dataUrl}}dojox/data/demos/stores/filestore_dojoxdata.php', pathAsQueryParam:true" data-dojo-id="comboStore"></div>
  <div data-dojo-type="dijit.form.ComboBox" data-dojo-props="store:comboStore, searchAttr:'path'" value="./demos"></div>
</div>

dojo.require("dojox.grid.DataGrid");
dojo.require("dojox.data.FileStore");

<span data-dojo-type="dojox.data.FileStore"
  data-dojo-id="fileStore3"
  data-dojo-props="url:'{{dataUrl}}dojox/data/demos/stores/filestore_dojoxdata.php',
  pathAsQueryParam:true">
</span>

<table data-dojo-type="dojox.grid.DataGrid"
    data-dojo-props="store:fileStore3,
    query:{},
    queryOptions:{deep:true},
    sortFields:[{'attribute':'path','descending':false}],
    clientSort:true"
    style="width: 400px; height: 200px;">
  <thead>
    <tr>
      <th width="100px" field="name">Filename</th>
      <th width="100px" field="size">File Size</th>
      <th width="100px" field="directory">Is Directory</th>
      <th width="100px" field="path">Path</th>
    </tr>
  </thead>
</table>

@import "{{baseUrl}}dojox/grid/resources/Grid.css";
@import "{{baseUrl}}dojox/grid/resources/nihiloGrid.css";

.dojoxGrid table {
  margin: 0;
}

Technical/Protocol Details

The following section is not necessary to fully understand how to just use the existing dojox.data.FileStore back end implementation, it is intended for people who wish to implement their own back end service in another language, such as python or java.

Protocol Information