| HTML-FormFu-Model-DBIC documentation | Contained in the HTML-FormFu-Model-DBIC distribution. |
HTML::FormFu::Model::DBIC - Integrate HTML::FormFu with DBIx::Class
Example of typical use in a Catalyst controller:
sub edit : Chained {
my ( $self, $c ) = @_;
my $form = $c->stash->{form};
my $book = $c->stash->{book};
if ( $form->submitted_and_valid ) {
# update dbic row with submitted values from form
$form->model->update( $book );
$c->response->redirect( $c->uri_for('view', $book->id) );
return;
}
elsif ( !$form->submitted ) {
# use dbic row to set form's default values
$form->model->default_values( $book );
}
return;
}
For the form object to be able to access your DBIx::Class schema, it needs
to be placed on the form stash, with the name schema.
This is easy if you're using Catalyst-Controller-HTML-FormFu, as you can set this up to happen in your Catalyst app's config file.
For example, if your model is named MyApp::Model::Corp, you would set this
(in Config::General format):
<Controller::HTML::FormFu>
<model_stash>
schema Corp
</model_stash>
</Controller::HTML::FormFu>
Or if your app's config file is in YAML format:
'Controller::HTML::FormFu':
model_stash:
schema: Corp
Arguments: $dbic_row, [\%config]
Return Value: $form
$form->model->default_values( $dbic_row );
Set a form's default values from the database, to allow a user to edit them.
Arguments: [$dbic_row], [\%config]
Return Value: $dbic_row
$form->model->update( $dbic_row );
Update the database with the submitted form values.
Arguments: [\%config]
Return Value: $dbic_row
my $dbic_row = $form->model->create( {resultset => 'Book'} );
Like update, but doesn't require a $dbic_row argument.
You need to ensure the DBIC schema is available on the form stash - see SYNOPSIS for an example config.
The resultset must be set either in the method arguments, or the form or
block's model_config.
An example of setting the ResultSet name on a Form:
---
model_config:
resultset: FooTable
elements:
# [snip]
Populates a multi-valued field with values from the database.
This method should not be called directly, but is called for you during
$form->process by fields that inherit from
HTML::FormFu::Element::_Group. This includes:
To use you must set the appropriate resultset on the element model_config:
element:
- type: Select
name: foo
model_config:
resultset: TableClass
To edit the values in a row with no related rows, the field names simply have to correspond to the database column names.
For the following DBIx::Class schema:
package MySchema::Book;
use base 'DBIx::Class';
__PACKAGE__->load_components(qw/ Core /);
__PACKAGE__->table("book");
__PACKAGE__->add_columns(
id => { data_type => "INTEGER" },
title => { data_type => "TEXT" },
author => { data_type => "TEXT" },
blurb => { data_type => "TEXT" },
);
__PACKAGE__->set_primary_key("id");
1;
A suitable form for this might be:
elements:
- type: Text
name: title
- type: Text
name: author
- type: Textarea
name: blurb
Set field values from a related row with a might_have or has_one
relationship by placing the fields within a
Block (or any element that inherits from
Block, such as Fieldset) with its
nested_name in HTML::FormFu set to the relationship name.
For the following DBIx::Class schemas:
package MySchema::Book;
use base 'DBIx::Class';
__PACKAGE__->load_components(qw/ Core /);
__PACKAGE__->table("book");
__PACKAGE__->add_columns(
id => { data_type => "INTEGER" },
title => { data_type => "TEXT" },
);
__PACKAGE__->set_primary_key("id");
__PACKAGE__->might_have( review => 'MySchema::Review', 'book' );
1;
package MySchema::Review;
use base 'DBIx::Class';
__PACKAGE__->load_components(qw/ Core /);
__PACKAGE__->table("review");
__PACKAGE__->add_columns(
id => { data_type => "INTEGER" },
book => { data_type => "INTEGER", is_nullable => 1 },
review_text => { data_type => "TEXT" },
);
__PACKAGE__->set_primary_key("book");
__PACKAGE__->belongs_to( book => 'MySchema::Book' );
1;
A suitable form for this would be:
elements:
- type: Text
name: title
- type: Block
nested_name: review
elements:
- type: Textarea
name: review_text
For might_have and has_one relationships, you generally shouldn't need
to have a field for the related table's primary key, as DBIx::Class will
handle retrieving the correct row automatically.
You can also set a has_one or might_have relationship using a multi value
field like Select.
elements:
- type: Text
name: title
- type: Select
nested: review
model_config:
resultset: Review
This will load all reviews into the select field. If you select a review from
that list, a current relationship to a review is removed and the new one is
added. This requires that the primary key of the Review table and the
foreign key do not match.
The general principle is the same as for might_have and has_one above,
except you should use a Repeatable
element instead of a Block, and it needs to contain a
Hidden field corresponding to the foreign key.
The Repeatable block's nested_name must be set to the name of the relationship.
The Repeable block's increment_field_names must be true (which is the default value).
The Repeable block's
counter_name must be set to
the name of a Hidden field, which is placed
outside of the Repeatable block.
This field is used to store a count of the number of repetitions of the
Repeatable block were created.
When the form is submitted, this value is used during $form->process
to ensure the form is rebuilt with the correct number of repetitions.
For the following DBIx::Class schemas:
package MySchema::Book;
use base 'DBIx::Class';
__PACKAGE__->load_components(qw/ Core /);
__PACKAGE__->table("book");
__PACKAGE__->add_columns(
id => { data_type => "INTEGER" },
title => { data_type => "TEXT" },
);
__PACKAGE__->set_primary_key("id");
__PACKAGE__->has_many( review => 'MySchema::Review', 'book' );
1;
package MySchema::Review;
use base 'DBIx::Class';
__PACKAGE__->load_components(qw/ Core /);
__PACKAGE__->table("review");
__PACKAGE__->add_columns(
book => { data_type => "INTEGER" },
review_text => { data_type => "TEXT" },
);
__PACKAGE__->set_primary_key("book");
__PACKAGE__->belongs_to( book => 'MySchema::Book' );
1;
A suitable form for this would be:
elements:
- type: Text
name: title
- type: Hidden
name: review_count
- type: Repeatable
nested_name: review
counter_name: review_count
elements:
- type: Hidden
name: book
- type: Textarea
name: review_text
To select / deselect rows from a many_to_many relationship, you must use
a multi-valued element, such as a
Checkboxgroup or a
Select with
multiple set.
The field's name (name in HTML::FormFu::Element::_Field) must be set to the
name of the many_to_many relationship.
If you want to search / associate the related table by a column other it's
primary key, set $field->model_config->{default_column}.
---
element:
- type: Checkboxgroup
name: authors
model_config:
default_column: foo
If you want to set columns on the link table you can do so if you add a
link_values attribute to model_config:
---
element:
- type: Checkboxgroup
name: authors
model_config:
link_values:
foo: bar
The default implementation will first remove all related objects and set the
new ones (see http://search.cpan.org/perldoc?DBIx::Class::Relationship::Base#set_$rel).
If you want to add the selected objects to the current set of objects
set additive in the model_config.
---
element:
- type: Checkboxgroup
name: authors
model_config:
additive: 1
options_from_model: 0
options_from_model is set to 0 because it will try to fetch
all objects from the result class Authors if model_config is specified
without a resultset attribute.)
The following items are supported in the optional config hash-ref argument
to the methods default_values, update and create.
If you want the method to process a particular Block element, rather than the
whole form, you can pass the element as a base argument.
$form->default_values(
$row,
{
base => $formfu_element,
},
);
If you want the method to process a particular Block element by name, you can pass the name as an argument.
$form->default_values(
$row,
{
nested_base => 'foo',
}'
);
The following items are supported as model_config options on form fields.
If set, accessor will be used as a method-name accessor on the
DBIx::Class row object, instead of using the field name.
Useful for editing a "might_have" related row containing only one field.
If the submitted value is blank, the related row is deleted.
For the following DBIx::Class schemas:
package MySchema::Book;
use base 'DBIx::Class';
__PACKAGE__->load_components(qw/ Core /);
__PACKAGE__->table("book");
__PACKAGE__->add_columns(
id => { data_type => "INTEGER" },
title => { data_type => "TEXT" },
);
__PACKAGE__->set_primary_key("id");
__PACKAGE__->might_have( review => 'MySchema::Review', 'book' );
1;
package MySchema::Review;
use base 'DBIx::Class';
__PACKAGE__->load_components(qw/ Core /);
__PACKAGE__->table("review");
__PACKAGE__->add_columns(
book => { data_type => "INTEGER" },
review_text => { data_type => "TEXT" },
);
__PACKAGE__->set_primary_key("book");
__PACKAGE__->belongs_to( book => 'MySchema::Book' );
1;
A suitable form for this would be:
elements:
- type: Text
name: title
- type: Block
nested_name: review
elements:
- type: Text
name: review_text
model_config:
delete_if_empty: 1
To use a column value for a form field's label (label in HTML::FormFu::Element::_Field).
Intended for use on a Checkbox field.
If the checkbox is checked, the following occurs: for a has-many relationship, the related row is deleted; for a many-to-many relationship, the relationship link is removed.
An example of use might be:
elements:
- type: Text
name: title
- type: Hidden
name: review_count
- type: Repeatable
nested_name: review
counter_name: review_count
elements:
- type: Hidden
name: book
- type: Textarea
name: review_text
- type: Checkbox
name: delete_review
label: 'Delete Review?'
model_config:
delete_if_true: 1
Note: make sure the name of this field does not clash with one of your DBIx::Class::Row method names (e.g. "delete") - see CAVEATS.
For a Repeatable block corresponding to a has-many or many-to-many
relationship, to allow the user to insert new rows, set empty_rows to
the number of extra repetitions you wish added to the end of the Repeatable
block.
Set to the maximum number of new rows that a Repeatable block is allowed to add.
If not set, it will fallback to the value of empty_rows.
The column used for the element values is set with the model_config
value id_column - or if not set, the table's primary column is used.
element:
- type: Select
name: foo
model_config:
resultset: TableClass
id_column: pk_col
The column used for the element labels is set with the model_config
value label_column - or if not set, the first text/varchar column found
in the table is used - or if one is not found, the id_column is used
instead.
element:
- type: Select
name: foo
model_config:
resultset: TableClass
label_column: label_col
To pass the database label values via the form's localization object, set
localize_label
element:
- type: Select
name: foo
model_config:
localize_label: 1
You can set a condition, which will be passed as the 1st argument to
search in DBIx::Class::ResultSet.
element:
- type: Select
name: foo
model_config:
resultset: TableClass
condition:
type: is_foo
You can set a condition_from_stash, which will be passed as the 1st argument to
search in DBIx::Class::ResultSet.
key is the column-name to be passed to
search,
and stash_key is the name of a key on the form stash
from which the value to be passed to search
is found.
element:
- type: Select
name: foo
model_config:
resultset: TableClass
condition_from_stash:
key: stash_key
Is comparable to:
$form->element({
type => 'Select',
name => 'foo',
model_config => {
resultset => 'TableClass',
condition => {
key => $form->stash->{stash_key}
}
}
})
You can set attributes, which will be passed as the 2nd argument to
search in DBIx::Class::ResultSet.
To update values to the database which weren't submitted to the form, you can first add them to the form with add_valid.
my $passwd = generate_passwd();
$form->add_valid( passwd => $passwd );
$form->model->update( $row );
add_valid works for fieldnames that don't exist in the form.
You can make a field read only. The value of such fields cannot be changed by the user even if they submit a value for it.
$field->model_config->{read_only} = 1;
- Name: field
model_config:
read_only: 1
To ensure your column's inflators and deflators are called, we have to
get / set values using their named methods, and not with get_column /
set_column.
Because of this, beware of having column names which clash with DBIx::Class
built-in method-names, such as delete. - It will have obviously
undesirable results!
See empty_rows in "Config options for Repeatable blocks" instead.
See new_rows_max in "Config options for Repeatable blocks" instead.
See empty_rows in "Config options for Repeatable blocks" instead.
Project Page:
http://code.google.com/p/html-formfu/
Mailing list:
http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/html-formfu
Mailing list archives:
Please submit bugs / feature requests to http://code.google.com/p/html-formfu/issues/list (preferred) or http://rt.perl.org.
The publicly viewable subversion code repository is at http://html-formfu.googlecode.com/svn/trunk/HTML-FormFu-Model-DBIC.
If you wish to contribute, you'll need a GMAIL email address. Then just ask on the mailing list for commit access.
If you wish to contribute but for some reason really don't want to sign up for a GMAIL account, please post patches to the mailing list (although you'll have to wait for someone to commit them).
If you have commit permissions, use the HTTPS repository url: https://html-formfu.googlecode.com/svn/trunk/HTML-FormFu-Model-DBIC
Carl Franks
Based on the code of DBIx::Class::HTML::FormFu, which was contributed to
by:
Adam Herzog
Daisuke Maki
Mario Minati
Copyright (C) 2007 by Carl Franks
Based on the original source code of DBIx::Class::HTMLWidget, copyright Thomas Klausner.
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.8 or, at your option, any later version of Perl 5 you may have available.
| HTML-FormFu-Model-DBIC documentation | Contained in the HTML-FormFu-Model-DBIC distribution. |
package HTML::FormFu::Model::DBIC; use strict; use warnings; use base 'HTML::FormFu::Model'; use HTML::FormFu::Util qw( _merge_hashes ); use List::MoreUtils qw( none notall ); use Scalar::Util qw( blessed ); use Storable qw( dclone ); use Carp qw( croak ); our $VERSION = '0.09000'; $VERSION = eval $VERSION; sub options_from_model { my ( $self, $base, $attrs ) = @_; my $form = $base->form; my $resultset = _get_resultset( $base, $form, $attrs ); my $source = $resultset->result_source; my $id_col = $attrs->{id_column}; my $label_col = $attrs->{label_column}; my $condition = $attrs->{condition}; my $attributes = $attrs->{attributes} || {}; if ( !defined $id_col ) { ($id_col) = $source->primary_columns; } if ( !defined $label_col ) { # use first text column ($label_col) = grep { my $data_type = $source->column_info($_)->{data_type}; defined $data_type && $data_type =~ /text|varchar/i } $source->columns; } $label_col = $id_col if !defined $label_col; if ( defined( my $from_stash = $attrs->{condition_from_stash} ) ) { $condition = $condition ? { %{$condition} } : {}; # avoid overwriting attrs->{condition} for my $name ( keys %$from_stash ) { croak "config value must not be a reference" if ref $from_stash->{$name}; my $value = $form->stash->{ $from_stash->{$name} }; $condition->{$name} = $value; } } # save the expanded condition for later use $attrs->{'-condition'} = $condition if ($condition); $attributes->{'-columns'} = [ $id_col, $label_col ]; my $result = $resultset->search( $condition, $attributes ); my @defaults = $result->all; if ( $attrs->{localize_label} ) { @defaults = map { { value => $_->get_column($id_col), label_loc => $_->get_column($label_col), } } @defaults; } else { my $has_column = $source->has_column($label_col); @defaults = map { [ $_->get_column($id_col), $has_column ? $_->get_column($label_col) : $_->$label_col, ] } @defaults; } return @defaults; } sub _get_resultset { my ( $base, $form, $attrs ) = @_; my $schema = $form->stash->{schema}; my $context = $form->stash->{context}; if ( defined $schema ) { my $rs_name = $attrs->{resultset} || ucfirst $base->name; return $schema->resultset($rs_name); } elsif ( defined $context && defined $attrs->{model} ) { my $model = $context->model( $attrs->{model} ); if ( defined( my $rs = $attrs->{resultset} ) ) { $model = $model->resultset($rs); } return $model; } elsif ( defined $context ) { my $model = $context->model; return $model if defined $model; } croak "need a schema or context"; } sub default_values { my ( $self, $dbic, $attrs ) = @_; my $form = $self->form; my $base = defined $attrs->{base} ? delete $attrs->{base} : $form; $base = $form->get_all_element( { nested_name => $attrs->{nested_base} } ) if defined $attrs->{nested_base} && ( !defined $base->nested_name || $base->nested_name ne $attrs->{nested_base} ); _fill_in_fields( $base, $dbic ); _fill_nested( $self, $base, $dbic ); return $form; } # returns 0 if there is a node with nested_name set on the path from $field to $base sub is_direct_child { my ( $base, $field ) = @_; while ( defined $field->parent ) { $field = $field->parent; return 1 if $base == $field; return 0 if defined $field->nested_name; } } # fills in values for all direct children fields of $base sub _fill_in_fields { my ( $base, $dbic ) = @_; for my $field ( @{ $base->get_fields } ) { my $name = $field->name; my $config = $field->model_config; next if not defined $name || $config->{accessor}; next if not is_direct_child( $base, $field ); $name = $field->original_name if $field->original_name; my $accessor = $config->{accessor}; if ( defined $accessor ) { $field->default( $dbic->$accessor ); } elsif ( $dbic->can($name) ) { my $has_col = $dbic->result_source->has_column($name); my $has_rel = $dbic->result_source->has_relationship($name); if ( $has_col && $has_rel ) { # can't use direct accessor, if there's a rel of the same name $field->default( $dbic->get_column($name) ); } elsif ($has_col) { $field->default( $dbic->$name ); } elsif ( $field->multi_value && ($config->{default_column} || ( ref( $dbic->$name ) && $dbic->$name->can('result_source') ) ) ) { my ($col) = $config->{default_column} || $dbic->$name->result_source->primary_columns; my $info = $dbic->result_source->relationship_info($name); if ( !defined $info or $info->{attrs}{accessor} eq 'multi' ) { my @defaults = $dbic->$name->get_column($col)->all; $field->default( \@defaults ); } else { # has_one/might_have my ($pk) = $dbic->result_source->primary_columns; $field->default( $dbic->$name->$pk ); } } else { # This field is a method expected to return the value $field->default( $dbic->$name ); } } # handle {label} if ( defined( my $label = $config->{label} ) ) { my $has_rel = $dbic->result_source->has_relationship($label); if ($has_rel) { # can't use direct accessor, if there's a rel of the same name $field->label( $dbic->get_column($label) ); } else { $field->label( $dbic->$label ); } } } } # loop over all child blocks with nested_name that is a method on the DBIC row # and recurse sub _fill_nested { my ( $self, $base, $dbic ) = @_; for my $block ( @{ $base->get_all_elements } ) { next if $block->is_field && !$block->is_block; next if !$block->can('nested_name'); my $config = $block->model_config; # first handle {label} if ( defined( my $label = $config->{label} ) && $block->can('label') ) { my $has_rel = $dbic->result_source->has_relationship($label); if ($has_rel) { # can't use direct accessor, if there's a rel of the same name $block->label( $dbic->get_column($label) ); } else { $block->label( $dbic->$label ); } } my $rel = $block->nested_name; next if !defined $rel; my $has_rel = $dbic->result_source->relationship_info($rel) || ( $dbic->can($rel) && $dbic->can( 'add_to_' . $rel ) ) ; # many_to_many # recursing only when $rel is a relation or non-column accessor on $dbic next unless $has_rel || ( $dbic->can($rel) && !$dbic->result_source->has_column($rel) ); if ( $block->is_repeatable && $block->increment_field_names ) { # check there's a field name matching the PK my ($pk) = $dbic->$rel->result_source->primary_columns; next unless grep { $pk eq ( defined $_->original_name ? $_->original_name : $_->name ) } @{ $block->get_fields( { type => 'Hidden' } ) }; my @rows = $dbic->$rel->all; my $count = $config->{empty_rows} ? scalar @rows + $config->{empty_rows} : scalar @rows; my $blocks = $block->repeat($count); $block->process; for my $rep ( 0 .. $#rows ) { default_values( $self, $rows[$rep], { base => $blocks->[$rep] } ); } # set the counter field to the number of rows if ( defined( my $param_name = $block->counter_name ) ) { my ($field) = grep { $param_name eq ( defined $_->original_name ? $_->original_name : $_->name ) } @{ $base->get_fields }; $field->default($count) if defined $field; } # remove 'delete' checkbox from the last repetition ? if ( $config->{empty_rows} ) { my $new_row_count = $config->{empty_rows} ? $config->{empty_rows} : 1; my @reps = reverse @{ $block->get_elements }; for my $i ( 0 .. ( $new_row_count - 1 ) ) { my $rep = $reps[$i]; my ($del_field) = grep { $_->model_config->{delete_if_true} } @{ $rep->get_fields }; if ( defined $del_field ) { $del_field->parent->remove_element($del_field); } } } } else { if ( defined( my $row = $dbic->$rel ) ) { default_values( $self, $row, { base => $block } ); } } } return; } sub create { my ( $self, $attrs ) = @_; croak "invalid arguments" if @_ > 2; my $form = $self->form; my $base = defined $attrs->{base} ? delete $attrs->{base} : $form; my $schema = $form->stash->{schema} or croak 'schema required on form stash, if no row object provided'; my $resultset = $attrs->{resultset} || $base->model_config->{resultset} || $form->model_config->{resultset} or croak 'could not find resultset name'; $resultset = $schema->resultset($resultset); my $dbic = $resultset->new_result( {} ); return $self->update( $dbic, { %$attrs, base => $base } ); } sub update { my ( $self, $dbic, $attrs ) = @_; croak "row object missing" if !defined $dbic; my $form = $self->form; my $base = defined $attrs->{base} ? delete $attrs->{base} : $form; $base = $form->get_all_element( { nested_name => $attrs->{nested_base} } ) if defined $attrs->{nested_base} && ( !defined $base->nested_name || $base->nested_name ne $attrs->{nested_base} ); my $rs = $dbic->result_source; my @rels = $rs->relationships; my @cols = $rs->columns; _save_columns( $base, $dbic, $form ) or return; $dbic->update_or_insert; _save_relationships( $self, $base, $dbic, $form, $rs, $attrs, \@rels ); _save_multi_value_fields_many_to_many( $base, $dbic, $form, $attrs, \@rels, \@cols ); _save_repeatable_many_to_many( $self, $base, $dbic, $form, $attrs, \@rels, \@cols ); # handle non-rel, non-column, nested_base accessors. # - this highlights a failing of the approach of iterating over # db cols + rels - we should maybe refactor to iterate over # form blocks and fields instead ? for my $block ( @{ $base->get_all_elements } ) { next if $block->is_field; next if !$block->can('nested_name'); my $rel = $block->nested_name; next if !defined $rel; next unless $dbic->can($rel); next if grep { $rel eq $_ } @cols; next if grep { $rel eq $_ } @rels; next if $dbic->can( "add_to_" . $rel ); # many-to-many if ( defined( my $row = $dbic->$rel ) ) { update( $self, $row, { base => $block } ); } } return $dbic; } sub _save_relationships { my ( $self, $base, $dbic, $form, $rs, $attrs, $rels ) = @_; return if $attrs->{no_follow}; for my $rel (@$rels) { # don't follow rels to where we came from next if defined $attrs->{from} && $attrs->{from} eq $rs->related_source($rel)->result_class; my @elements = @{ $base->get_all_elements( { nested_name => $rel } ) }; my ($block) = grep { !$_->is_field } @elements; my ($multi_value) = grep { $_->is_field && $_->multi_value } @elements; next if !defined $block && !defined $multi_value; next if !$form->valid($rel); my $params = $form->param($rel); if ( defined $block && $block->is_repeatable ) { # Handle has_many _save_has_many( $self, $dbic, $form, $rs, $block, $rel, $attrs ); } elsif ( defined $block && ref $params eq 'HASH' ) { # It seems that $dbic->$rel must be called otherwise the following # find_related() can fail. # However, this can die - so we're just wrapping it in an eval eval { $dbic->$rel; } or $dbic->discard_changes; my $target = $dbic->find_related( $rel, {} ); if ( !defined $target && grep { length $_ } values %$params ) { $target = $dbic->new_related( $rel, {} ); } next if !defined $target; update( $self, $target, { %$attrs, base => $block, nested_base => $rel, from => $dbic->result_class, } ); unless ( $dbic->$rel ) { $dbic->$rel($target); $dbic->update; } } elsif ( defined $multi_value ) { # belongs_to, has_one or might_have relationship my $info = $dbic->result_source->relationship_info($rel); my @fpkey = $dbic->related_resultset($rel) ->result_source->primary_columns; my @cond = ( %{ $info->{cond} } ); # make sure $rel is a has_one or might_have rel # stolen from SQL/Translator/Parser/DBIx/Class my $fk_constraint; # Get the key information, mapping off the foreign/self markers my @refkeys = map {/^\w+\.(\w+)$/} @cond; my @keys = map { $info->{cond}{$_} =~ /^\w+\.(\w+)$/ } grep { exists $info->{cond}{$_} } @cond; #first it can be specified explicitly if ( exists $info->{attrs}{is_foreign_key_constraint} ) { $fk_constraint = $info->{attrs}{is_foreign_key_constraint}; } # it can not be multi elsif ($info->{attrs}{accessor} && $info->{attrs}{accessor} eq 'multi' ) { $fk_constraint = 0; } # if indeed single, check if all self.columns are our primary keys. # this is supposed to indicate a has_one/might_have... # where's the introspection!!?? :) else { $fk_constraint = not _compare_relationship_keys( \@keys, \@fpkey ); } next if ($fk_constraint); my $fpkey = shift @fpkey; my ( $fkey, $skey ) = @cond; $fkey =~ s/^foreign\.//; $skey =~ s/^self\.//; my $fclass = $info->{class}; croak 'The primary key and the foreign key may not be the same column in class ' . $fclass if $fpkey eq $fkey; croak 'multiple primary keys are not supported for has_one/might_have relationships' if ( @fpkey > 1 ); my $schema = $dbic->result_source->schema; # use transactions if supported by storage $schema->txn_do( sub { # reset any previous items which were related to $dbic $rs->schema->resultset($fclass) ->search( { $fkey => $dbic->$skey } ) ->update( { $fkey => undef } ); # set new related item my $updated = $rs->schema->resultset($fclass) ->search( { $fpkey => $params } ) ->update( { $fkey => $dbic->$skey } ); $schema->txn_rollback if $updated != 1; } ); } } } # Copied from DBIx::Class::ResultSource sub _compare_relationship_keys { my ( $keys1, $keys2 ) = @_; # Make sure every keys1 is in keys2 my $found; foreach my $key (@$keys1) { $found = 0; foreach my $prim (@$keys2) { if ( $prim eq $key ) { $found = 1; last; } } last unless $found; } # Make sure every key2 is in key1 if ($found) { foreach my $prim (@$keys2) { $found = 0; foreach my $key (@$keys1) { if ( $prim eq $key ) { $found = 1; last; } } last unless $found; } } return $found; } sub _save_has_many { my ( $self, $dbic, $form, $rs, $block, $rel, $attrs ) = @_; return unless $block->increment_field_names; # check there's a field name matching the PK my ($pk) = $rs->related_source($rel)->primary_columns; return unless grep { $_->original_name eq $pk } @{ $block->get_fields( { type => 'Hidden' } ) }; my @blocks = @{ $block->get_elements }; my $max = $#blocks; my $config = $block->model_config; my $new_rows_max = $config->{new_rows_max} || $config->{empty_rows} || 0; my $new_rows_counter = 0; # iterate over blocks, not rows # new rows might have been created in the meantime for my $i ( 0 .. $max ) { my $rep = $blocks[$i]; # find PK field my ($pk_field) = grep { $_->original_name eq $pk } @{ $rep->get_fields( { type => 'Hidden' } ) }; next if !defined $pk_field; my $value = $form->param_value( $pk_field->nested_name ); my $row; if (( !defined $value || $value eq '' ) && ( $new_rows_max && ( ++$new_rows_counter <= $new_rows_max ) ) ) { # insert a new row $row = _insert_has_many( $dbic, $form, $config, $rep, $rel, $pk_field ); next if !defined $row; } elsif ( !defined $value || $value eq '' ) { next; } else { $row = $dbic->find_related( $rel, $value ); } next if !defined $row; # should we delete the row? next if _delete_has_many( $form, $row, $rep ); update( $self, $row, { %$attrs, base => $rep, repeat_base => $rel, from => $dbic->result_class, } ); } } sub _insert_has_many { my ( $dbic, $form, $config, $repetition, $rel, $pk_field ) = @_; return if !_can_insert_new_row( $dbic, $form, $config, $repetition, $rel, $pk_field ); my $row = $dbic->new_related( $rel, {} ); return $row; } sub _can_insert_new_row { my ( $dbic, $form, $config, $repetition, $rel, $pk_field ) = @_; my @rep_fields = @{ $repetition->get_fields }; my $pk_name = $pk_field->nested_name; my @constraints = grep { $_->when->{field} eq $pk_name } grep { defined $_->when } map { @{ $_->get_constraints( { type => 'Required' } ) } } @rep_fields; my @required_fields; if (@constraints) { # if there are any Required constraints whose 'when' clause points to # the PK field - check that all these fields are filled in - as # the PK value is missing on new reps, so the constraint won't have run return if notall { defined && length } map { $form->param_value( $_->nested_name ) } map { $_->parent } @constraints; } else { # otherwise, just check at least 1 field that matches either a column # name or an accessor, is filled in my $result_source = $dbic->$rel->result_source; # only create a new record if (read from bottom)... return if none { defined && length } map { $form->param_value( $_->nested_name ) } grep { $result_source->has_column( $_->original_name ) || $result_source->can( $_->original_name ) } grep { defined $_->original_name } @rep_fields; } return 1; } sub _delete_has_many { my ( $form, $row, $rep ) = @_; my ($del_field) = grep { $_->model_config->{delete_if_true} } @{ $rep->get_fields }; return if !defined $del_field; my $nested_name = $del_field->nested_name; return unless $form->valid($nested_name) && $form->param_value($nested_name); $row->delete if ( $row->in_storage ); return 1; } sub _fix_value { my ( $dbic, $col, $value, $field, ) = @_; my $col_info = $dbic->column_info($col); my $is_nullable = $col_info->{is_nullable} || 0; my $data_type = $col_info->{data_type} || ''; if ( defined $value ) { if ( ( $is_nullable && $data_type =~ m/^timestamp|date|int|float|numeric/i ) # comparing to '' does not work for inflated objects && !ref $value && $value eq '' ) { $value = undef; } } if ( !defined $value && defined $field && $field->isa('HTML::FormFu::Element::Checkbox') && !$is_nullable ) { $value = 0; } return $value; } sub _save_columns { my ( $base, $dbic, $form ) = @_; for my $field ( @{ $base->get_fields }, ) { next if not is_direct_child( $base, $field ); my $config = $field->model_config; next if $config->{delete_if_true}; next if $config->{read_only}; my $name = $field->name; $name = $field->original_name if $field->original_name; my $accessor = $config->{accessor} || $name; next if not defined $accessor; my $value = ( $dbic->result_source->has_column($accessor) and exists $dbic->result_source->column_info($accessor)->{is_array} ) ? $form->param_array( $field->nested_name ) : $form->param_value( $field->nested_name ) ; next if $config->{ignore_if_empty} && ( !defined $value || $value eq "" ); my ($pk) = $dbic->result_source->primary_columns; # don't set primary key to null or '' - for Pg SERIALs next if ( $name eq $pk ) && !( defined $value && length $value ); if ( $config->{delete_if_empty} && ( !defined $value || !length $value ) ) { $dbic->discard_changes if $dbic->is_changed; $dbic->delete if $dbic->in_storage; return; } if ( $dbic->result_source->has_column($accessor) ) { $value = _fix_value( $dbic, $accessor, $value, $field ); } elsif ( $field->isa('HTML::FormFu::Element::Checkbox') ) { # We are a checkbox. unless ( defined $value ) { $value = 0; } } if ( !$config->{accessor} and $dbic->result_source->has_relationship($accessor) and $dbic->result_source->has_column($accessor) ) { $dbic->set_column( $accessor, $value ); } elsif ( $dbic->can($accessor) # and $accessor is not a has_one or might_have rel where the foreign key is on the foreign table and !$dbic->result_source->relationship_info($accessor) ) { $dbic->$accessor($value); } else { # We should just ignore #croak "cannot call $accessor on $dbic"; } } # for values inserted by add_valid - and not correlated to any field in the form my $parent = $base; do { return 1 if defined $parent->nested_name; $parent = $parent->parent; } until ( !defined $parent ); for my $valid ( $form->valid ) { next if @{ $base->get_fields( name => $valid ) }; next if not $dbic->can($valid); my $value = $form->param_value($valid); $dbic->$valid($value); } return 1; } sub _save_multi_value_fields_many_to_many { my ( $base, $dbic, $form, $attrs, $rels, $cols ) = @_; my @fields = grep { ( defined $attrs->{nested_base} && defined $_->parent->nested_name ) ? $_->parent->nested_name eq $attrs->{nested_base} : !$_->nested } grep { $_->multi_value } grep { defined $_->name } @{ $base->get_fields }; for my $field (@fields) { my $name = $field->name; next if grep { $name eq $_ } @$rels, @$cols; if ( $dbic->can($name) ) { my $related = $dbic->$name; next if !blessed($related) || !$related->can('result_source'); my $nested_name = $field->nested_name; next if $form->has_errors($nested_name); my @values = $form->param_list($nested_name); my @rows; my $config = $field->model_config; my ($pk) = $config->{default_column} || $related->result_source->primary_columns; if (@values) { $pk = "me.$pk" unless $pk =~ /\./; @rows = $related->result_source->resultset->search( { %{ $config->{condition} || {} }, $pk => { -in => \@values } } )->all; } if ( $config->{additive} ) { $pk =~ s/^.*\.//; my $set_method = "add_to_$name"; my $remove_method = "remove_from_$name"; foreach my $row (@rows) { $dbic->$remove_method($row); $dbic->$set_method( $row, $config->{link_values} ); } } else { # check if there is a restricting condition on here # if so life is more complex my $condition = $config->{'-condition'}; if ($condition) { my $set_method = "add_to_$name"; my $remove_method = "remove_from_$name"; foreach ( $dbic->$name->search($condition)->all ) { $dbic->$remove_method($_); } foreach my $row (@rows) { $dbic->$set_method( $row, $config->{link_values} ); } } else { my $set_method = "set_$name"; $dbic->$set_method( \@rows, $config->{link_values} ); } } } } } sub _save_repeatable_many_to_many { my ( $self, $base, $dbic, $form, $attrs, $rels, $cols ) = @_; my @blocks = grep { !$_->is_field && $_->is_repeatable && $_->increment_field_names } @{ $base->get_all_elements }; for my $block (@blocks) { my $rel = $block->nested_name; next if !defined $rel; next if grep { $rel eq $_ } @$rels, @$cols; if ( $dbic->can($rel) ) { # check there's a field name matching the PK my ($pk) = $dbic->$rel->result_source->primary_columns; my @blocks = @{ $block->get_elements }; my $max = $#blocks; # iterate over blocks, not rows # new rows might have been created in the meantime for my $i ( 0 .. $max ) { my $rep = $blocks[$i]; # find PK field my ($pk_field) = grep { $_->original_name eq $pk } @{ $rep->get_fields( { type => 'Hidden' } ) }; next if !defined $pk_field; my $value = $form->param_value( $pk_field->nested_name ); my $row; my $is_new; my $config = $block->model_config; my $new_rows_max = $config->{new_rows_max} || $config->{empty_rows} || 0; my $new_rows_counter = 0; if (( !defined $value || $value eq '' ) && ( $new_rows_max && ( ++$new_rows_counter <= $new_rows_max ) ) ) { # insert a new row $row = _insert_many_to_many( $dbic, $form, $config, $rep, $rel, $pk_field ); next if !defined $row; $is_new = 1; } elsif ( !defined $value || $value eq '' ) { next; } else { $row = $dbic->$rel->find($value); } next if !defined $row; # should we delete the row? next if _delete_many_to_many( $form, $dbic, $row, $rel, $rep ); update( $self, $row, { %$attrs, base => $rep, repeat_base => $rel, from => $dbic->result_class, } ); if ($is_new) { # new rows need to be related my $add_method = "add_to_$rel"; $dbic->$add_method($row); } } } } return; } sub _insert_many_to_many { my ( $dbic, $form, $config, $repetition, $rel, $pk_field ) = @_; return if !_can_insert_new_row( $dbic, $form, $config, $repetition, $rel, $pk_field ); my $row = $dbic->$rel->new( {} ); # add_to_* will be called later, after update is called on this row return $row; } sub _delete_many_to_many { my ( $form, $dbic, $row, $rel, $rep ) = @_; my ($del_field) = grep { $_->model_config->{delete_if_true} } @{ $rep->get_fields }; return if !defined $del_field; my $nested_name = $del_field->nested_name; return unless $form->valid($nested_name) && $form->param_value($nested_name); my $remove = "remove_from_$rel"; $dbic->$remove($row); return 1; } 1; __END__