The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
FWS-V2-1.13091122
River stage zero No dependents
++
/ FWS::V2::Admin

NAME

FWS::V2::Admin - Framework Sites version 2 internal administration

VERSION

Version 1.13091122

SYNOPSIS

    use FWS::V2;

    #
    # Create $fws
    #
    my $fws = FWS::V2->new();

DESCRIPTION

These methods are used by the FWS to perform web based admin features. Most methods here are not for general use and can change at any time, reference these in plugins and element for experimental reasons only.

METHODS

These modules are used for FWS admin display and logic. They should not be used outside of the context of FWS admin modules specific to the current build.

runAdminAction

Run admin actions. This will be depricated once they are all moved into the FWS display elements.

adminPageHeader

Return a standard HTML admin header for admin elements that open in new pages.

    #
    # Header for an admin page that opens in a new window
    #
    $valueHash{html} .= $fws->adminPageHeader(    
        name            => 'Page Name in the upper right',
        rightContent    => 'This will show up on the right,' .
                           'usually its a saving widget',
        title           => 'This is title on the left, it will' .
                           'look just like a panel title',
        icon            => 'somethingInTheFWSIconDirectory.png');

NOTE: This should only be used in the context of the FWS Administration, and is only here as a reference for modifiers of the admin.

displayAdminLogin

Return the HTML used for a default FWS admin login.

editField

Some legacy fields still use this render drop downs. For new code do not use this.

tabs

Return jQueryUI tab html. The tab names, tab content, tinyMCE editing field name, and any javascript for the tab onclick is passed as arrays to the method.

    #
    # add the data to the tabs and panels to the HTML
    #
    $valueHash{html} .= $self->tabs(
        id              => 'theIdOfTheTabContainer',
        tabs            => [@tabs],
        tabContent      => [@tabContent],
        tabJava         => [@tabJava],

        # html and file tab support
        tabType         => [@tabType],       # file, html or leave empty for standard panel
                                             # setting type will overwrite content and java provided

        tabFields       => [@tabFields],     # field your updating

        guid            => 'someGUID',       # guid your updating

        # optional if your talking to a non-data table
        tabUpdateType   => [@tabUpdateType], # defaults to AJAXExt
        table           => 'data',           # defaults to data

        # for file type only (required)
        currentFile     => [@currentFile],   #
    );

NOTE: This should only be used in the context of the FWS Administration, and is only here as a reference for modifiers of the admin. In future versions this will be replaced with a hash array style paramater to make this less cumbersome, but this will be avaiable for legacy controls.

importSiteImage

Unpack a agnostic DB and File administration packages via FWS administration distrubuted by framworksites.com.

adminField

Return an edit field or field block for the FWS Admin. The adminField method is a very configurable tool used by the FWS administration maintainers.

    #
    # Create a admin edit field
    #
    $valueHash{html} .= $fws->adminField( %paramHash );

NOTE: This should only be used in the context of the FWS Administration, and is only here as a reference for modifiers of the admin.

Passable Keys: fieldType fieldName fieldValue fieldOptions unilingual: [1|0] ajaxUpdateGUID ajaxUpdateParentId id class style onSaveComplete updateType guid onKeyDown note afterFieldHTML

systemInfo

Return the system info page accessed by clicking "System" from the admin menu.

aceTextArea

Create an ace editor UI componate.

onOffLight

Return an on off lightbulb.

editBox

Return a edit box for the passed element hash;

FWSMenu

Return the FWS top menu bar.

panel

FWS panel HTML: Pass title, content and panelStyle keys.

displayAdminPage

Run the lookup and display admin pages wrapped in security precautions.

GNFTree

Tree render componate. At some point this will be rewritten using a JQuery tree and migrate away from this server side rendering method.

uploadSiteFile

Execute a file upload from a form post.

AUTHOR

Nate Lewis, <nlewis at gnetworks.com>

BUGS

Please report any bugs or feature requests to bug-fws-v2 at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=FWS-V2. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc FWS::V2::Admin

You can also look for information at:

LICENSE AND COPYRIGHT

Copyright 2013 Nate Lewis.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.