NAME

HTML::Widget::DBIC - a subclass of HTML::Widgets for dealing with DBIx::Class

# create a widget coupled with a db record
my $widget = HTML::Widget::DBIC->create_from_config( $config, $schema, 'Tag', $item );

# process a query
my $result = $widget->process ( $query );

# and save the values from the query to the database
$result->save_to_db();

METHODS

create_from_config

Method to create widget. The parameters are configuration for all the widget fields, DBIx::Class schema, the name of the DBIC Resultset and optionally a DBIC record (item) - to fill in the current values in the form and as the target for saving the data, if not present when saving a new record will be created.

The config is a reference to a list of configuration for particular fields. Like: my $config = [ { 'foreign_class' => 'Dvd', 'widget_element' => [ 'Select', 'multiple' => 1 ], 'name' => 'dvds', 'label' => 'Dvds', 'bridge_rel' => 'dvdtags' }, { 'widget_element' => [ 'Textarea', 'rows' => 5, 'cols' => 60 ], 'constraints' => [ { 'max' => '255', 'constraint' => 'Length', 'message' => 'Should be shorten than 255 characters' }, { 'constraint' => 'All', 'message' => 'The field is required' } ], 'name' => 'name', 'label' => 'Name' }, { 'primary_key' => 1, 'name' => 'id', 'label' => 'Id' } ];

process

Like HTML::Widget->process but produces HTML::Widget::Result::DBIC - with extra info for saving to database.

save_to_db

HTML::Widget::DBIC::Result method to save the data from widget to the database

DIAGNOSTICS

Error message here, perhaps with %s placeholders

[Description of error here]

Another error message here

[Description of error here]

[Et cetera, et cetera]

CONFIGURATION AND ENVIRONMENT

Catalyst::Helper::Controller::InstantCRUD requires no configuration files or environment variables.

DEPENDENCIES

None.

INCOMPATIBILITIES

None reported.

BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests to bug-catalyst-helper-controller-instantcrud@rt.cpan.org, or through the web interface at http://rt.cpan.org.

AUTHOR

<Zbigniew Lukasiak> <<zz bb yy @ gmail.com>>

LICENCE AND COPYRIGHT

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

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

1; # Magic true value required at end of module __END__

NAME

Catalyst::Example::Controller::InstantCRUD - Catalyst CRUD example Controller

VERSION

This document describes Catalyst::Example::Controller::InstantCRUD version 0.0.1

SYNOPSIS

use base Catalyst::Example::Controller::InstantCRUD;

DESCRIPTION

INTERFACE

METHODS

column_value Returns the value of the column in the row.
get_resultset Returns the resultset appriopriate for the page parameters.
model_class Returns a class from the model.
model_resultset Returns a resultset from the model.
model_item Returns an item from the model.
model_widget Returns a HTML::Widget object filled with elements from the model.
button Returns an HTML::Widget object with a submit button.
source_name Class method for finding name of corresponding database table.
add Method for displaying form for adding new records
create_col_link Subroutine placed on stash for templates to use.
create_page_link Subroutine placed on stash for templates to use.
auto Adds Controller name as additional directory to search for templates
index Forwards to list
destroy Deleting records.
do_add Method for adding new records
do_edit Method for editin existing records
edit Method for displaying form for editing a record.
list Method for displaying pages of records
view Method for diplaying one record

DIAGNOSTICS

Error message here, perhaps with %s placeholders

[Description of error here]

Another error message here

[Description of error here]

[Et cetera, et cetera]

CONFIGURATION AND ENVIRONMENT

Catalyst::Example::Controller::InstantCRUD requires no configuration files or environment variables.

DEPENDENCIES

None.

INCOMPATIBILITIES

None reported.

BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests to bug-catalyst-example-controller-instantcrud@rt.cpan.org, or through the web interface at http://rt.cpan.org.

AUTHOR

LICENCE AND COPYRIGHT

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

DISCLAIMER OF WARRANTY

package DBIx::Class::InstantCRUD; use base qw/DBIx::Class/; use strict; use warnings; use Carp; use HTML::Widget; use Lingua::EN::Inflect::Number ();

our $VERSION = '0.01';

__PACKAGE__->mk_classdata('widget_elements'); __PACKAGE__->mk_classdata('list_columns');

sub fill_widget { my ( $dbic, $widget ) = @_;

croak('fill_widget needs a HTML::Widget object as argument')
  unless ref $widget && $widget->isa('HTML::Widget');
my @elements = $widget->get_elements;

# get embeded widgets
my @widgets = @{ $widget->{_embedded} || [] };

foreach my $emb_widget (@widgets) {
    push @elements, $emb_widget->get_elements;
}

foreach my $element (@elements) {
    my $name = $element->name;
    next unless $name && $dbic->can($name) && $element->can('value');
    if ( $element->isa('HTML::Widget::Element::Checkbox') ) {
        $element->checked( $dbic->$name ? 1 : 0 );
    }
    else {
        $element->value( $dbic->$name )
          unless $element->isa('HTML::Widget::Element::Password');
    }
}
}

sub get_widget { my ($self) = @_; my $table = $self->result_source; my $w = HTML::Widget->new( $table->from )->method('post'); for my $el ( grep $_, @{ $self->widget_elements || [] } ) {

    #next if ( grep /^$el$/, $table->primary_columns  );
    # Table column
    if ( $table->has_column($el) && !$table->relationship_info($el) ) {
        my $info = $table->column_info($el);
        next if $info->{is_auto_increment};
        $self->_build_element( $w, $el, $info );

        # Add constraints
        for my $c ( @{ $info->{constraints} || [] } ) {
            my $const =
              $w->constraint( $c->{constraint}, $el,
                $c->{args} ? @{ $c->{args} } : () );
            $c->{$_} and $const->$_( $c->{$_} )
              for qw/min max regex callback in message/;
        }
    }

    # Relationships
    else {
        my $info = $table->__relationship_info($el) || next;
        my $class =
            $info->{type} eq 'many_to_many'
          ? $info->{other_class}
          : $info->{class};
        my $ref_pk =
          ( $self->result_source->schema->source($class)->primary_columns )
          [0];
        my $w_element =
          $info->{type} eq 'belongs_to' ? 'Select' : 'DoubleSelect';
        my @options;
        @options = ( 0, '' ) unless $w_element eq 'DoubleSelect';
        for my $ref_item (
            $self->result_source->schema->resultset($class)->search )
        {
            push @options, $ref_item->$ref_pk, "$ref_item";
        }
        my $element = $w->element( $w_element, $info->{rel_name} );
        $element->options(@options);    # when done on the previous line this was
               # resulting sometimes in $element == undef

        # belongs_to relationships
        if ( $info->{type} eq 'belongs_to' ) {
            my $label = $info->{label} || join ' ',
              map { ucfirst } split '_', $el;
            $element->label($label);
            $element->selected(
                $self->in_storage ? $self->$el->$ref_pk : 0 );
        }

        # has_many and many-to-many relationships
        else {
            my $label = $class;
            $element->multiple(1)->size(5)->label($label);
            if ( $self->in_storage ) {
                my @selected = $self->search_related($el);
                $element->selected(
                    [ @selected ? map( $_->$ref_pk, @selected ) : 0 ] );
            }
        }
    }
}
return $w;
}

sub _build_element { my ( $self, $w, $el, $info ) = @_; my ( $w_element, %attrs ); my $label = $info->{label} || join ' ', map { ucfirst } split '_', $el; my $size = $info->{size} || 40; if ( ref $info->{widget_element} eq 'ARRAY' ) { $w_element = $info->{widget_element}[0]; %attrs = ref $info->{widget_element}[1] eq 'HASH' ? %{ $info->{widget_element}[1] } : (); } if ( $el =~ /password|passwd/ ) { $w_element ||= 'Password'; $size = 40 if $size > 40; $w->element( 'Password', $el )->label($label)->size($size); $w->element( 'Password', "$el\_2" )->label($label)->size($size) ->comment('(Confirm)'); return; } else { $w_element ||= $size > 40 ? 'Textarea' : 'Textfield'; if ( $w_element eq 'Textarea' ) { $attrs{cols} ||= 60; $attrs{rows} ||= 5; } elsif ( $w_element eq 'Textfield' ) { $attrs{size} ||= $size; $attrs{maxlength} ||= $size; } } my $element = $w->element( $w_element, $el )->label($label); $element->$_( $attrs{$_} ) for keys %attrs; $element->value( $self->$el ) if $self->in_storage; }

sub to_html { my ( $self, %a ) = @_; my $source = $self->result_source; my @columns = $source->columns; my @rels = grep $source->relationship_info($_)->{attrs}{accessor} eq 'multi', $source->relationships; my @elements = $source->result_class->list_columns ? @{ $source->result_class->list_columns } : ( @columns, @rels ); my %cols = map { $_ => 1 } @columns; my %rels = map { $_ => 1 } @rels;

my $str = join '', map {
    my $label = $source->column_info($_)->{label};
    "<b>$label</b>:<br/>\n" . $self->$_ . "<br/><br/>\n"
} grep $cols{$_}, @elements;
$str .= join '', map {
    my $info  = $source->__relationship_info($_);
    my $meth  = $info->{method};
    my $label = $info->{label};
    "<b>$label</b>:<br/>\n" . join( ', ', $self->$meth ) . "<br/><br/>\n"
} grep $rels{$_}, @elements;
return $str;
}

package DBIx::Class::ResultSource::Table;

sub __relationship_info { my ( $self, $rel ) = @_; my $rel_info = $self->relationship_info($rel) || return; my %attrs = ( %$rel_info, rel_name => $rel ); @attrs{ 'foreign_col', 'self_col' } = %{ $rel_info->{cond} }; $attrs{foreign_col} =~ s/foreign\.//; $attrs{self_col} =~ s/self\.//; if ( $rel_info->{attrs}{accessor} eq 'multi' ) { my $source = $self->schema->source( $rel_info->{source} ); my %rels = map { $_ => 1 } $source->relationships;

    # many-to-many ?
    if ( keys %rels == 2 && delete $rels{ $self->from } ) {
        $attrs{type} = 'many_to_many';
        my $other_rel_info = $source->relationship_info( keys %rels );
        $attrs{"other_$_"} = $other_rel_info->{$_}
          for keys %$other_rel_info;
        @attrs{ 'other_foreign_col', 'other_self_col' } =
          %{ $other_rel_info->{cond} };
        $attrs{other_foreign_col} =~ s/foreign\.//;
        $attrs{other_self_col}    =~ s/self\.//;
        $attrs{method} =
          Lingua::EN::Inflect::Number::to_PL(
            $self->schema->class( $attrs{other_class} )->table );
        $attrs{label} = join ' ', map { ucfirst } split '_', $attrs{method};
    }
    else {
        $attrs{type}  = 'has_many';
        $attrs{label} =
          Lingua::EN::Inflect::Number::to_PL(
            $self->schema->class( $attrs{class} )->table );
        $attrs{label} = join ' ', map { ucfirst } split '_', $attrs{label};
        $attrs{method} = $rel;
    }
}
else {
    $attrs{type} = 'belongs_to';
    my $info = $self->column_info($rel);
    @attrs{ keys %$info } = values %$info;
}
return \%attrs;
}

1; __END__

NAME

DBIx::Class::InstantCRUD - Like DBIx::Class::HTMLWidget but handles relationships and extra info in the columns_info metadata. It also has methods to put DBIC objects into HTML

SYNOPSIS

You'll need a working DBIx::Class setup and some knowledge of HTML::Widget and Catalyst. If you have no idea what I'm talking about, check the (sparse) docs of those modules.

   package My::Model::DBIC::User;
   use base 'DBIx::Class';
   __PACKAGE__->load_components(qw/InstantCRUD Core/);

   
   package My::Controller::User;    # Catalyst-style
   
   # this renders an edit form with values filled in from the DB 
   sub do_edit : Local {
     my ($self,$c,$id)=@_;
  
     # get the object
     my $item = $c->model('DBIC::User')->find($id);
     # get the widget
     my $w = $item->get_widget;
     $w->action($c->uri_for('do_edit/'.$id));
     
     # process the widget
     my $result = $w->process($c->request);

     if($result->has_errors){
         $c->stash->{widget} = $result;
	 $c->stash->{template} = 'edit';
     } else {
	 $item->populate_from_widget($result);
	 $c->forward('view');
     }
  
  }
  
  sub edit : Local {
    my ($self,$c,$id)=@_;
    
    # get the object from DB
    my $item=$c->model('DBIC::User')->find($id);
    $c->stash->{item}=$item;
    
    # get the widget
    my $w= $item->get_widget;
    $w->action($c->uri_for('do_edit/'.$id));
    
    # process the widget
    $c->stash->{'result'}= $w->process;
  }

DESCRIPTION

Something like DBIx::Class::HTMLWidget but handles relationships and extra info in the columns_info metadata. It also has methods to put DBIC objects into HTML

Methods

populate_from_widget

my $obj=$schema->resultset('pet)->new({})->populate_from_widget($result);
my $item->populate_from_widget($result);

Create or update a DBIx::Class row from a HTML::Widget::Result object

AUTHORS

Thomas Klausner, <domm@cpan.org>, http://domm.zsi.at

Marcus Ramberg, <mramberg@cpan.org>

Zbigniew Lukasiak> zz bb yy @ gmail.com

Jonas Alves, jonas.alves at gmail.com

CONTRIBUTORS

Simon Elliott, <cpan@browsing.co.uk>

Kaare Rasmussen

Ashley Berlin

LICENSE

You may use and distribute this module according to the same terms that Perl is distributed under.

NAME

HTML::Widget::DBIC -

SYNOPSIS

use HTML::Widget::DBIC
blah blah blah

DESCRIPTION

Stub documentation for this module was created by ExtUtils::ModuleMaker. It looks like the author of the extension was negligent enough to leave the stub unedited.

Blah blah blah.

USAGE

BUGS

SUPPORT

AUTHOR

Zbigniew Lukasiak
a.u.thor@a.galaxy.far.far.away
http://zby.aster.net.pl

COPYRIGHT

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

The full text of the license can be found in the LICENSE file included with this module.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

NAME

SYNOPSIS use HTML::Widget::DBIC;

METHODS

DIAGNOSTICS

CONFIGURATION AND ENVIRONMENT

DEPENDENCIES

INCOMPATIBILITIES

BUGS AND LIMITATIONS

AUTHOR

LICENCE AND COPYRIGHT

DISCLAIMER OF WARRANTY

NAME

VERSION

SYNOPSIS

DESCRIPTION

INTERFACE

METHODS

DIAGNOSTICS

CONFIGURATION AND ENVIRONMENT

DEPENDENCIES

INCOMPATIBILITIES

BUGS AND LIMITATIONS

AUTHOR

LICENCE AND COPYRIGHT

DISCLAIMER OF WARRANTY

NAME

SYNOPSIS

DESCRIPTION

Methods

populate_from_widget

AUTHORS

CONTRIBUTORS

LICENSE

NAME

SYNOPSIS

DESCRIPTION

USAGE

BUGS

SUPPORT

AUTHOR

COPYRIGHT

SEE ALSO

sample_function

Module Install Instructions