Patch to add support for custom layouts

I needed to have more flexibility in using WebFM for one of my projects.. and it became the following general purpose change that I want to donate back to the community.

The patch attached to the next comment is designed to make WebFM easier to use in themes, modules, and custom blocks. This is basically done by adding a new webfm_custom_layout function to the webmf.module and changing code needed in the PhP and JavaScript needed to support this.

Here's a quick overview of the function and it's arguments that can change the various aspects of webfm's output.

function webfm_custom_layout( $path = NULL, 
                              $displayTree = NULL, 
                              $displayDir = NULL,
                              $breadcrumbRoot = NULL,
                              $displayColumns = NULL )
                              
$path              The "current" directory to use.  This is the path as a normal user would see it.  E.g. /roleDir/subdirA/subdirA1
                      
$displayTree     If false, suppress the folder tree display on left.

$displayDir        If false, suppress the directory list on right.

$breadcrumbRoot    A path used to "truncate" the dir list breadcrumb. E.g. /roleDir/subDirA will cause the breadcrumb display 
                           to start with /subDirA.  Useful to "psuedo-lock" users to a subtree.

$displayColumns    An array of "column_name => boolean" that determines which columns to display. "column_name" is one of:  
                          name, modified, size, or owner.  A true value = display (the default). A false value = do not display.
                          Generally, you only need to turn off column.  E.g. array( 'modified' => false) will display the other three.  
                          Note, if the owner column is turned off in the admin, it will never be displayed.

Returns            The HTML outout to display webfm.

Here are some usage examples to help clarify how to use this:

CASE: Display normal WebFM display but show a specific directory

You want to display a normal WebFM type page but have a different default directory.

1) Create a node or custom block using the PhP Input filter.

2) Add the following PhP code as the body. (assumes WebFM module installed)

<?php
   $path = '/MyRole/MyFiles';             //Current path
   print webfm_custom_layout($path);
?>

3) Set up required navigation/conditions to this node or block.

CASE: Display only the documents related to a specific product.

Product document on a website are maintained by the DocManager role. They are uploaded via the normal WebFM process into a directory like:

/ProductManager/MyProduct

This has subdirectories like SalesInfo, Manuals, etc.

You want to use WebFM to allow normal users access to just the MyProduct area and its subdirectories.

1) Create a node or custom block using the PhP Input filter.

2) Add the following PhP code as the body. (assumes WebFM module installed)

<?php
   $path = '/ProductManager/MyProduct';             //Current path
   $displayTree = false;                            //Don't display left hand folder navigation
   $displayDir = true;                              //Do display right hand directory listing
   $breadcrumbRoot = '/ProductManager/MyProduct';   //Limit directory listing breadcrumb to this. 
   print webfm_custom_layout($path, $displayTree, $displayDir, $breadcrumbRoot);
?>

3) Set up required navigation/conditions to this node or block.

CASE: Need a WebFM display of files in a directory for a sidebar.

You need a sidebar block that will list files in a directory. This means that the normal display is too wide, so you want to just display the name column.

1) Create a custom block using the PhP Input filter.

2) Add the following PhP code as the body. (assumes WebFM module installed)

<?php
   $path = '/MyRole/MyFiles';             //Current path
   $displayTree = false;                  //Don't display left hand folder navigation
   $displayDir = true;                    //Do display right hand directory listing
   $breadcrumbRoot = '/MyRole/MyFiles';   //Limit directory listing breadcrumb to this. 
   $displayColumns = array( 
                     'owner' => false,    //Don't display owner column (if enabled)
                     'modified' => false, //Don't display date modified column
                     'size' => false, );  //Don't display size column
   
   print webfm_custom_layout($path, $displayTree, $displayDir, $breadcrumbRoot, $displayColumns);
?>

3) Set up required navigation/conditions to this node or block.

Important Usage Notes:

The file display will still follow the standard WebFM security rules. E.g., Nothing will be displayed unless the user has at least "Access" rights.

THERE CAN BE ONLY ONE... WebFM display on a page. E.g., you can't have two custom blocks that display different directories.

Extra Credit:

You can also change display options via embedded Javascript on the page. See the Webfm.options variable in the webfm.js file.