]> git.decadent.org.uk Git - maypole.git/blobdiff - lib/Maypole/Model/CDBI/AsForm.pm
fixed Maypole versions of Untaint and AsForm to pass pod::coverage tests, fixed test...
[maypole.git] / lib / Maypole / Model / CDBI / AsForm.pm
index ef67a06e14ef4c8fd6ec0c2957da8a1e17773876..7956bbbedda71ef0f069242641415246bd835186 100644 (file)
@@ -11,7 +11,6 @@ package Maypole::Model::CDBI::AsForm;
 #                  -- $class->to_field($has_many_col); # foreign inputs  
 #  $class->search_inputs; /
 
-use 5.006;
 
 use strict;
 use warnings;
@@ -32,16 +31,8 @@ our @EXPORT =
                _to_foreign_inputs _to_enum_select _to_bool_select
                _to_hidden _to_link_hidden _rename_foreign_input _to_readonly
                _options_from_objects _options_from_arrays _options_from_hashes 
-               _options_from_scalars _to_select_or_create
+               _options_from_array _options_from_hash 
     );
-                               
-our @EXPORTOK = 
-       qw( 
-               
-        
-       );
-                                 
-                                 
 
 our $VERSION = '.10'; 
 
@@ -118,6 +109,8 @@ example usages.
 
 Not all _to_* methods pay attention to all arguments. For example, '_to_textfield' does not look in $args->{'items'} at all.
  
+=over
+
 =item name -- the name the element will have , this trumps the derived name.
 
   $beer->to_field('brewery', 'readonly', {
@@ -205,6 +198,7 @@ static values. You can also specify these in the relationship arguments.
 Tell AsForm not to make hidden inputs for relationship constraints. It does
 this  sometimes when making foreign inputs . 
 
+=back
 
 =head2 to_cgi
 
@@ -363,7 +357,12 @@ sub search_inputs {
 
 
 
-#
+
+=head2 unselect_element
+
+  unselect any selected elements in a HTML::Element select list widget
+
+=cut
 sub unselect_element {
    my ($self, $el) = @_;
    #unless (ref $el eq 'HTML::Element') {
@@ -384,8 +383,6 @@ Override at will.
 
 sub _field_from_how {
        my ($self, $field, $how, $args) = @_;
-       #if (ref $how) { $args = $how; $how = undef; }
-#warn "In filed from how . filed is $field how is $how. args ar e" . Dumper($args) . " \n";
        return unless $how;
        $args ||= {};
        no strict 'refs';
@@ -409,7 +406,6 @@ For has_a it will give select box
 
 sub _field_from_relationship {
        my ($self, $field, $args) = @_;
-#warn "In filed from rel . filed is $field \n";
        return unless $field;
        my $rel_meta = $self->related_meta('r',$field) || return; 
        my $rel_name = $rel_meta->{name};
@@ -419,7 +415,6 @@ sub _field_from_relationship {
        my $fclass_is_cdbi = $fclass ? $fclass->isa('Class::DBI') : 0;
 
        # maybe has_a select 
-       #warn "Dumper of relmeta. " . Dumper($rel_meta);
        if ($rel_meta->{name} eq 'has_a' and $fclass_is_cdbi) {
            # This condictions allows for trumping of the has_a args
                if  (not $rel_meta->{args}{no_select} and not $args->{no_select}) 
@@ -435,7 +430,8 @@ sub _field_from_relationship {
                if  (not $rel_meta->{args}{no_select} and not $args->{no_select}) 
                {
                $args->{class} = $fclass;
-                       $args->{items} = $self->$field;
+                       my @itms = $self->$field; # need list not iterator
+                       $args->{items} = \@itms;
                return  $self->_to_select($field, $args);
                }
                return;
@@ -474,10 +470,8 @@ sub _field_from_column {
        my ($self, $field, $args) = @_;
        return unless $field;
        my $class = ref $self || $self;
-       #warn "Class is $class\n";
        # Get column type       
     unless ($args->{column_type}) { 
-                       $args->{column_type} = $class->column_type($field);
        if ($class->can('column_type')) {
                        $args->{column_type} = $class->column_type($field);
                }       
@@ -490,7 +484,7 @@ sub _field_from_column {
     my $type = $args->{column_type};
 
        return $self->_to_textfield($field, $args)
-               if $type  and $type =~ /(VAR)?CHAR/i;  #common type
+               if $type  and $type =~ /^(VAR)?CHAR/i;  #common type
        return $self->_to_textarea($field, $args)
                if $type and $type =~ /^(TEXT|BLOB)$/i;
        return $self->_to_enum_select($field, $args)  
@@ -531,6 +525,8 @@ sub _to_textarea {
 
 sub _to_textfield {
     my ($self, $col, $args ) = @_;
+    use Carp qw/confess/;
+    confess "No col passed to _to_textfield" unless $col;
     $args ||= {};
     my $val  = $args->{value}; 
     my $name = $args->{name} || $col; 
@@ -543,7 +539,6 @@ sub _to_textfield {
             $val = $self->can($col) ? $self->$col : ''; # in case it is a virtual column
             if (ref $val) {
                                if (my $meta = $self->related_meta('',$col)) {
-                               #warn "Meta for $col";
                                if (my $code = $meta->{args}{deflate4edit} || $meta->{args}{deflate} ) {
                        $val  = ref $code ? &$code($val) : $val->$code;
                                        }
@@ -556,7 +551,6 @@ sub _to_textfield {
                                        }
                        }
                                else {
-                                       #warn "No meta for $col but ref $val.\n";
                                        $val  = $val->id if $val->isa("Class::DBI"); 
                }
                }
@@ -567,9 +561,11 @@ sub _to_textfield {
                $val = '' unless defined $val;
         }
     }
-    my $a = HTML::Element->new("input", type => "text", name => $name, value =>
-                                                               $val);
-
+       my $a;
+       # THIS If section is neccessary or you end up with "value" for a vaiue
+       # if val is 
+       $val = '' unless defined $val; 
+       $a = HTML::Element->new("input", type => "text", name => $name, value =>$val);
     $OLD_STYLE && return $a->as_HTML;
     $a;
 }
@@ -652,15 +648,15 @@ sub _to_textfield {
 sub _to_select {
     my ($self, $col, $args) = @_;
     $args ||= {};
-# Do we have items already ? Go no further. 
-    if ($args->{items} and @{$args->{items}}) {  
+       # Do we have items already ? Go no further. 
+    if ($args->{items} and ref $args->{items}) {  
                my $a = $self->_select_guts($col,  $args);
        $OLD_STYLE && return $a->as_HTML;
                if ($args->{multiple}) { $a->attr('multiple', 'multiple');}
                return $a;
        }
 
-# Else what are we making a select box out of ?  
+       # Else what are we making a select box out of ?  
        # No Column parameter --  means making a select box of args->class or self 
     # Using all rows from class's table
     if (not $col) { 
@@ -678,7 +674,7 @@ sub _to_select {
         # related objects pre selected if object
                                
                # "Has many" -- Issues:
-               # 1) want to select one from list if self is an object
+               # 1) want to select one  or many from list if self is an object
                # Thats about all we can do really, 
                # 2) except for mapping which is TODO and  would 
                # do something like add to and take away from list of permissions for
@@ -686,7 +682,8 @@ sub _to_select {
 
                # Hasmany select one from list if ref self
                if ($rel_meta->{name} =~ /has_many/i and ref $self) {
-                       $args->{items} = [ $self->$col ];
+                   my @itms =  $self->$col; # need list not iterator
+                       $args->{items} = \@itms;
                        my $a = $self->_select_guts($col,  $args);
                    $OLD_STYLE && return $a->as_HTML;
                    return $a;
@@ -723,9 +720,8 @@ sub _to_select {
 
        # Get items to select from
     $args->{items} = _select_items($args);
-    #warn "Items selecting from are " . Dumper($args->{items});
-#use Data::Dumper;
-#warn "Just got items. They are  " . Dumper($args->{items});
+       #use Data::Dumper;
+       #warn "Just got items. They are  " . Dumper($args->{items});
 
        # Make select HTML element
        $a = $self->_select_guts($col, $args);
@@ -777,7 +773,7 @@ sub _select_items {
        $sql .= " WHERE " . $args->{where}   if $args->{where};
        $sql .= " ORDER BY " . $args->{order_by} if $args->{order_by};
        $sql .= " LIMIT " . $args->{limit} if $args->{limit};
-#warn "_select_items sql is : $sql";
+       #warn "_select_items sql is : $sql";
 
        return $fclass->db_Main->selectall_arrayref($sql);
 
@@ -787,19 +783,16 @@ sub _select_items {
 # Makes a readonly input box out of column's value
 # No args makes object to readonly
 sub _to_readonly {
-    my ($self, $col, $val) = @_;
-    if (! $col) { # object to readonly
+    my ($self, $col, $args) = @_;
+    my $val = $args->{value};
+    if (not defined $val ) { # object to readonly
+       $self->_croak("AsForm: To readonly field called as class method without a value") unless ref $self; 
         $val = $self->id;
         $col = $self->primary_column;
     }
-    unless (defined $val) {
-        $self->_croak("Cannot get value in _to_readonly .")
-            unless ref $self;
-        $val = $self->$col;
-    }
     my $a = HTML::Element->new('input', 'type' => 'text', readonly => '1',
         'name' => $col, 'value'=>$val);
-$OLD_STYLE && return $a->as_HTML;
+       $OLD_STYLE && return $a->as_HTML;
     $a;
 }
 
@@ -854,7 +847,6 @@ TODO -- test without bool string.
 # TCODO fix this mess with args
 sub _to_bool_select {
     my ($self, $col, $args) = @_;
-       #warn "In to_bool select\n";
        my $type = $args->{column_type};
        my @bool_text = ('No', 'Yes');  
        if ($type =~ /BOOL\((.+?)\)/i) {
@@ -940,13 +932,13 @@ sub _to_link_hidden {
          $name = $args->{name} || $obj->primary_column->name;
     }
     elsif ($obj = $args->{items}->[0]) {
-       # cool) 
-        $name = $args->{name} || $obj->primary_column->name; # TODO make use meta data
+        $name = $args->{name} || $accessor || $obj->primary_column->name; 
+               # TODO use meta data above maybe
     }
-       
     else {           # hiding linking related object with id in args
         $obj  = $self->related_class($r, $accessor)->retrieve($args->{id});
-        $name = $args->{name} || $obj->primary_column->name; # TODO make use meta data
+        $name = $args->{name} || $accessor ; #$obj->primary_column->name;
+               # TODO use meta data above maybe
     }
     $self->_croak("_to_link_hidden has no object") unless ref $obj;
     my $href =  $uri || $r->config->{uri_base} . "/". $obj->table."/view/".$obj->id;
@@ -957,8 +949,6 @@ sub _to_link_hidden {
     $a;
 }
 
-
-
 =head2 _to_foreign_inputs
 
 $html_els = $class_or_obj->_to_foreign_inputs($accssr, [$fields, $accssr_meta]);
@@ -1036,12 +1026,15 @@ Below handles these formats for the "selected" slot in the arguments hash:
 sub _hash_selected {
        my ($args) = shift;
        my $selected = $args->{value} || $args->{selected};
-    return $selected unless $selected and ref $selected ne 'HASH'; 
-       #warn "Selected dump : " . Dumper($selected);
+       #warn "**** SELECTED is $selected ****";
        my $type = ref $selected;
+    return $selected unless $selected and $type ne 'HASH'; 
+       #warn "Selected dump : " . Dumper($selected);
        # Single Object 
     if ($type and $type ne 'ARRAY') {
-       return  {$selected->id => 1};
+          my $id = $selected->id;
+          $id =~ s/^0*//;
+       return  {$id => 1};
     }
     # Single Scalar id 
        elsif (not $type) {
@@ -1083,9 +1076,12 @@ sub _hash_selected {
 Internal api  method to make the actual select box form elements.
 
 3 types of lists making for -- 
+  Hash, Array, 
   Array of CDBI objects.
   Array of scalars , 
-  Array or  Array refs with cols from class.
+  Array or  Array refs with cols from class,
+  Array of hashes 
+
 =cut
 
 
@@ -1094,6 +1090,7 @@ sub _select_guts {
     my ($self, $col, $args) = @_; #$nullable, $selected_id, $values) = @_;
 
     #$args->{stringify} ||=  'stringify_selectbox';
+
     $args->{selected} = _hash_selected($args) if defined $args->{selected};
        my $name = $args->{name} || $col;
     my $a = HTML::Element->new('select', name => $name);
@@ -1106,42 +1103,59 @@ sub _select_guts {
         $a->push_content($null_element);
     }
 
-    my $items = $args->{items};
-    my $proto = $items->[0];
-    my $type  = ref $proto || '';
-
-    # Objects 
-    if (not $type) {
-               $a->push_content($self->_options_from_scalars($items, $args));
-       }
-       elsif($type !~ /ARRAY|HASH/i) {
-               # make select  of objects
-               $a->push_content($self->_options_from_objects($items, $args));
-       }
-    elsif ($type =~ /ARRAY/i) {
-               $a->push_content($self->_options_from_arrays($items, $args));
+       my $items = $args->{items};
+    my $type = ref $items;
+       my $proto = eval { ref $items->[0]; } || "";
+       my $optgroups = $args->{optgroups} || '';
+       
+       # Array of hashes, one for each optgroup
+       if ($optgroups) {
+               my $i = 0;
+               foreach (@$optgroups) {
+                       my $ogrp=  HTML::Element->new('optgroup', label => $_);
+                       $ogrp->push_content($self->_options_from_hash($items->[$i], $args));
+                       $a->push_content($ogrp);
+                       $i++;
+               }
+       }               
+    # Single Hash
+    elsif ($type eq 'HASH') {
+        $a->push_content($self->_options_from_hash($items, $args));
+    }
+    # Single Array
+    elsif ( $type eq 'ARRAY' and not ref $items->[0] ) {
+        $a->push_content($self->_options_from_array($items, $args));
+    }
+    # Array of Objects
+    elsif( $type eq 'ARRAY' and $proto !~ /ARRAY|HASH/i ) {
+        # make select  of objects
+        $a->push_content($self->_options_from_objects($items, $args));
     }
-    elsif ($type =~ /HASH/i) { 
-               $a->push_content($self->_options_from_hashes($items, $args));
+    # Array of Arrays
+    elsif ( $type eq 'ARRAY' and $proto eq 'ARRAY' ) {
+        $a->push_content($self->_options_from_arrays($items, $args));
     }
-    else { 
-               die "You passed a weird type of data structure to me. Here it is: $type";
+    # Array of Hashes
+    elsif ( $type eq 'ARRAY' and $proto eq 'HASH' ) {
+        $a->push_content($self->_options_from_hashes($items, $args));
+    }
+    else {
+        die "You passed a weird type of data structure to me. Here it is: " .
+       Dumper($items );
     }
 
     return $a;
-}
-
-               
-  
-  
 
 
+}
 
 =head2 _options_from_objects ( $objects, $args);
 
 Private method to makes a options out of  objects. It attempts to call each
 objects stringify method specified in $args->{stringify} as the content. Otherwise the default stringification prevails.
 
+*Note only  single primary keys supported
+
 =cut
 sub _options_from_objects {
     my ($self, $items, $args) = @_;
@@ -1149,8 +1163,10 @@ sub _options_from_objects {
        my $stringify = $args->{stringify} || '';
     my @res;
        for (@$items) {
-               my $opt = HTML::Element->new("option", value => $_->id);
-               $opt->attr(selected => "selected") if $selected->{$_->id}; 
+               my $id = $_->id;
+               my $opt = HTML::Element->new("option", value => $id);
+               $id =~ s/^0*//; # leading zeros no good in hash key
+               $opt->attr(selected => "selected") if $selected->{$id}; 
                my $content = $stringify ? $_->stringify :  "$_";
                $opt->push_content($content);
                push @res, $opt; 
@@ -1168,8 +1184,9 @@ sub _options_from_arrays {
            my @pks; # for future multiple key support
            push @pks, shift @$item foreach $class->columns('Primary');
                my $id = $pks[0];
-               $id =~ ~ s/^0+//;  # In case zerofill is on .
-               my $opt = HTML::Element->new("option", value => $id );
+               $id =~ s/^0+//;  # In case zerofill is on .
+               my $val = defined $id ? $id : '';
+               my $opt = HTML::Element->new("option", value =>$val);
                $opt->attr(selected => "selected") if $selected->{$id};
                
                my $content = ($class and $stringify and $class->can($stringify)) ? 
@@ -1181,20 +1198,41 @@ sub _options_from_arrays {
     return @res;
 }
 
-sub _options_from_scalars {
+
+sub _options_from_array {
     my ($self, $items, $args) = @_;
-       my $selected = $args->{selected} || {};
+    my $selected = $args->{selected} || {};
     my @res;
-       for (@$items) {
-               my $opt = HTML::Element->new("option", value => $_ );
-               #$opt->attr(selected => "selected") if $selected =~/^$id$/;
-               $opt->attr(selected => "selected") if $selected->{$_};
-               $opt->push_content( $_ );
-        push @res, $opt; 
+    for (@$items) {
+               my $val = defined $_ ? $_ : '';
+        my $opt = HTML::Element->new("option", value => $val);
+        #$opt->attr(selected => "selected") if $selected =~/^$id$/;
+        $opt->attr(selected => "selected") if $selected->{$_};
+        $opt->push_content( $_ );
+        push @res, $opt;
     }
     return @res;
 }
 
+sub _options_from_hash {
+    my ($self, $items, $args) = @_;
+    my $selected = $args->{selected} || {};
+    my @res;
+
+    my @values = values %$items;
+    # hash Key is the option content  and the hash value is option value
+    for (sort keys %$items) {
+               my $val = defined $items->{$_} ? $items->{$_} : '';
+        my $opt = HTML::Element->new("option", value => $val);
+        #$opt->attr(selected => "selected") if $selected =~/^$id$/;
+        $opt->attr(selected => "selected") if $selected->{$items->{$_}};
+        $opt->push_content( $_ );
+        push @res, $opt;
+    }
+    return @res;
+}
+
+
 sub _options_from_hashes {
     my ($self, $items, $args) = @_;
        my $selected = $args->{selected} || {};
@@ -1203,10 +1241,10 @@ sub _options_from_hashes {
        my $stringify = $args->{stringify} || '';
        my @res;
        for (@$items) {
-               my $val = $_->{$pk};
-               my $opt = HTML::Element->new("option", value => $val );
+               my $val = defined $_->{$pk} ? $_->{$pk} : '';
+               my $opt = HTML::Element->new("option", value => $val);
                $opt->attr(selected => "selected") if $selected->{$val};
-               my $content = $fclass and $stringify and $fclass->can($stringify) ? 
+               my $content = ($fclass and $stringify and $fclass->can($stringify)) ? 
                              $fclass->$stringify($_) : 
                                  join(' ', @$_);
                $opt->push_content( $content );
@@ -1215,19 +1253,17 @@ sub _options_from_hashes {
        return @res;
 }
 
-sub _to_select_or_create {
-       my ($self, $col, $args) = @_;
-       $args->{name} ||= $col;
-       my $select = $self->to_field($col, 'select', $args);
-       $args->{name} = "create_" . $args->{name};
-       my $create = $self->to_field($col, 'foreign_inputs', $args);
-       $create->{'__select_or_create__'} = 
-               $self->to_field('__select_or_create__',{ name => '__select_or_create__' , value => 1 } );
-               
-       return ($select, $create);
-}
-               
-       
+# TODO -- Maybe
+#sub _to_select_or_create {
+#      my ($self, $col, $args) = @_;
+#      $args->{name} ||= $col;
+#      my $select = $self->to_field($col, 'select', $args);
+#      $args->{name} = "create_" . $args->{name};
+#      my $create = $self->to_field($col, 'foreign_inputs', $args);
+#      $create->{'__select_or_create__'} = 
+#              $self->to_field('__select_or_create__',{ name => '__select_or_create__' , value => 1 } );
+#      return ($select, $create);
+#}
        
 # 
 # checkboxes: if no data in hand (ie called as class method), replace
@@ -1241,7 +1277,6 @@ sub _to_select_or_create {
 sub _to_checkbox {
     my ($self, $col, $args) = @_;
     my $nullable = eval {self->column_nullable($col)} || 0; 
-    
     return $self->_to_radio($col) if !ref($self) || $nullable;
     my $value = $self->$col;
     my $a = HTML::Element->new("input", type=> "checkbox", name => $col);