The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
Rose-DBx-Garden-Catalyst-0.09_03
River stage zero No dependents
/ Rose::DBx::Garden::Catalyst::YUI

NAME

Rose::DBx::Garden::Catalyst::YUI - playing nice with YUI, TT, and RHTMLO

DESCRIPTION

This class implements methods for easing development of YUI applications using TT and RHTMLO.

METHODS

This class inherits from Rose::Object. Only new and overridden methods are documented here.

show_remove_button

Boolean method. Default is false. Used in serialize().

init_datetime_format

Set strftime-style DateTime format string. Default is '%Y-%m-%d %H:%M:%S'. Used in serialize().

datatable( opts )

Returns a Rose::DBx::Garden::Catalyst::YUI::DataTable object ready for the yui_datatable.tt template.

opts should consist of:

results

results may be either a CatalystX::CRUD::Results object or a CatalystX::CRUD::Object object.

controller

The Catalyst::Controller instance for the request.

form

The current Form object.

rel_info

If results is a CatalystX::CRUD::Object object, then a rel_info should be passed indicating which relationship to pull data from.

field_names

Optional arrayref of field names to include. Defaults to yui_datatable_methods() defined in form->meta.

serialize( params )

Serialize a RDBO object rdbo. params should be a hash or hashref of key/value pairs. The "rdbo" key pair is required.

Optional params are:

  • rel_info is the struct returned by Form->meta->relationship_info() method.

  • col_names is the list of column names to include in the serialized struct.

  • parent_object is the originating RDBO object, in the case where you are serializing related objects.

  • cat_context is a $c object.

  • show_related_values is a hash ref of methods and foreign fields, as defined by RDGC::YUI::DataTable.

  • takes_object_as_argument is a hashref of method names where parent_object is expected as a single argument.

AUTHOR

Peter Karman, <karman at cpan.org>

BUGS

Please report any bugs or feature requests to bug-rose-dbx-garden-catalyst at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Rose-DBx-Garden-Catalyst. 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 Rose::DBx::Garden::Catalyst

You can also look for information at:

ACKNOWLEDGEMENTS

The Minnesota Supercomputing Institute http://www.msi.umn.edu/ sponsored the development of this software.

COPYRIGHT & LICENSE

Copyright 2008 by the Regents of the University of Minnesota.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.