lib/CXGN/Insitu/Form.pm

   1
   2 =head1 NAME
   3
   4 CXGN::Form.pm -- classes to deal with user-modifiable web forms
   5
   6 =head1 DESCRIPTION
   7
   8 The classes F
   9
  10 =head1 AUTHOR(S)
  11
  12 Lukas Mueller (lam87@cornell.edu)
  13
  14 =cut
  15
  16
  17 use strict;
  18
  19 package CXGN::Insitu::Form;
  20
  21 =head2 new
  22
  23  Usage:
  24  Desc:
  25  Ret:
  26  Args:
  27  Side Effects:
  28  Example:
  29
  30 =cut
  31
  32 sub new {
  33     my $class = shift;
  34     my $self = bless {}, $class;
  35     return $self;
  36 }
  37
  38 =head2 add_field
  39
  40  Usage:
  41  Desc:
  42  Ret:
  43  Args:
  44  Side Effects:
  45  Example:
  46
  47 =cut
  48
  49 sub add_field {
  50     my $self = shift;
  51     my $screen_name = shift;
  52     my $field_name = shift;
  53     my $contents = shift;
  54     my $length = shift;
  55     my $object = shift;
  56     my $getter = shift;
  57     my $setter = shift;
  58     my $field = CXGN::Insitu::Field->new($screen_name, $field_name, $contents, $length, $object, $getter, $setter);
  59     $self->add_field_obj($field);
  60 }
  61
  62 =head2 add_field_obj
  63
  64  Usage:
  65  Desc:
  66  Ret:
  67  Args:
  68  Side Effects:
  69  Example:
  70
  71 =cut
  72
  73 sub add_field_obj {
  74     my $self = shift;
  75     my $field = shift;
  76     if (!exists($self->{fields})) { $self->{fields}=(); }
  77     push @{$self->{fields}}, $field;
  78 }
  79
  80 =head2 add_selection
  81
  82  Usage:
  83  Desc:
  84  Ret:
  85  Args:
  86  Side Effects:
  87  Example:
  88
  89 =cut
  90
  91 sub add_selection {
  92     my $self = shift;
  93 }
  94
  95 =head2 set_action
  96
  97  Usage:
  98  Desc:
  99  Ret:
 100  Args:
 101  Side Effects:
 102  Example:
 103
 104 =cut
 105
 106 sub set_action {
 107     my $self = shift;
 108     $self->{action}=shift;
 109 }
 110
 111 =head2 get_action
 112
 113  Usage:
 114  Desc:
 115  Ret:
 116  Args:
 117  Side Effects:
 118  Example:
 119
 120 =cut
 121
 122 sub get_action {
 123     my $self = shift;
 124     return $self->{action};
 125 }
 126
 127 =head2 get_fields
 128
 129  Usage:
 130  Desc:
 131  Ret:
 132  Args:
 133  Side Effects:
 134  Example:
 135
 136 =cut
 137
 138 sub get_fields {
 139     my $self = shift;
 140     return @{$self->{fields}};
 141 }
 142
 143 =head2 get_form_start
 144
 145  Usage:
 146  Desc:
 147  Ret:
 148  Args:
 149  Side Effects:
 150  Example:
 151
 152 =cut
 153
 154
 155 sub get_form_start {
 156     my $self = shift;
 157     return "";
 158 }
 159
 160 =head2 get_form_end
 161
 162  Usage:
 163  Desc:
 164  Ret:
 165  Args:
 166  Side Effects:
 167  Example:
 168
 169 =cut
 170
 171
 172 sub get_form_end {
 173     my $self = shift;
 174     return "";
 175 }
 176
 177 =head2 get_field_hash
 178
 179  Usage:
 180  Desc:
 181  Ret:
 182  Args:
 183  Side Effects:
 184  Example:
 185
 186 =cut
 187
 188 sub get_field_hash {
 189     my $self = shift;
 190     my %hash = ();
 191     foreach my $f ($self->get_fields()) {
 192         $hash{$f->get_field_name()} = $f->render();
 193     }
 194
 195     $hash{FORM_START}=$self->get_form_start();
 196     $hash{FORM_END} = $self->get_form_end();
 197
 198     return %hash;
 199 }
 200
 201 =head2 store
 202
 203  Usage:
 204  Desc:
 205  Ret:
 206  Args:
 207  Side Effects:
 208  Example:
 209
 210 =cut
 211
 212 sub store {
 213     my $self = shift;
 214     my $args = shift;
 215     foreach my $f ($self->get_fields()) {
 216         my $setter = $f->get_setter();
 217         $f->get_object()->$setter($$args{$k});
 218     }
 219     $f->get_object->store();
 220
 221 }
 222
 223 package CXGN::Insitu::EditableForm;
 224
 225 use base qw / CXGN::Insitu::Form /;
 226
 227 sub new {
 228     my $class = shift;
 229     return $class->SUPER::new(@_);
 230 }
 231
 232 sub add_field {
 233     my $self = shift;
 234     my $screen_name = shift;
 235     my $field_name = shift;
 236     my $contents = shift;
 237     my $length = shift;
 238     my $object = shift;
 239     my $getter = shift;
 240     my $setter = shift;
 241     my $field = CXGN::Insitu::EditableField->new($screen_name, $field_name, $contents, $length, $object, $getter, $setter);
 242     if (!exists($self->{fields})) { $self->{fields}=(); }
 243     push @{$self->{fields}}, $field;
 244 }
 245
 246 sub get_form_start {
 247     my $self = shift;
 248     return "<form>";
 249 }
 250
 251 sub get_form_end {
 252     my $self = shift;
 253     return "<input type=\"submit\" value=\"Store\" />
 254             <input type=\"reset\" value=\"Reset form\" />
 255             </form>";
 256 }
 257
 258 =head1 NAME
 259
 260 CXGN::Insitu::Field
 261
 262 =head1 DESCRIPTION
 263
 264 =head1 AUTHOR(S)
 265
 266 Lukas Mueller (lam87@cornell.edu)
 267
 268 =cut
 269
 270
 271 package CXGN::Insitu::Field;
 272
 273 =head2 new
 274
 275  Usage:
 276  Desc:
 277  Ret:
 278  Args:
 279  Side Effects:
 280  Example:
 281
 282 =cut
 283
 284 sub new {
 285     my $class = shift;
 286     my $screen_name = shift;
 287     my $field_name = shift;
 288     my $contents = shift;
 289     my $length = shift;
 290     my $object = shift;
 291     my $getter = shift;
 292     my $setter = shift;
 293
 294     my $self = bless {}, $class;
 295     print "HELLO!\n";
 296
 297         print "Setting contents from object to ".$object->$getter."\n";
 298         $self->set_contents($object->$getter);
 299     $self->set_name($screen_name);
 300
 301     $self->set_field_name($field_name);
 302     if ($contents) { $self->set_contents($contents); }
 303     $self->set_length($length);
 304
 305     return $self;
 306 }
 307
 308 =head2 get_name
 309
 310  Usage:
 311  Desc:
 312  Ret:
 313  Args:
 314  Side Effects:
 315  Example:
 316
 317 =cut
 318
 319 sub get_name {
 320   my $self=shift;
 321   return $self->{name};
 322
 323 }
 324
 325 =head2 set_name
 326
 327  Usage:
 328  Desc:
 329  Ret:
 330  Args:
 331  Side Effects:
 332  Example:
 333
 334 =cut
 335
 336 sub set_name {
 337   my $self=shift;
 338   $self->{name}=shift;
 339 }
 340
 341 =head2 get_field_name
 342
 343  Usage:
 344  Desc:
 345  Ret:
 346  Args:
 347  Side Effects:
 348  Example:
 349
 350 =cut
 351
 352 sub get_field_name {
 353   my $self=shift;
 354   return $self->{field_name};
 355
 356 }
 357
 358 =head2 set_field_name
 359
 360  Usage:
 361  Desc:
 362  Ret:
 363  Args:
 364  Side Effects:
 365  Example:
 366
 367 =cut
 368
 369 sub set_field_name {
 370   my $self=shift;
 371   $self->{field_name}=shift;
 372 }
 373
 374 =head2 get_length
 375
 376  Usage:
 377  Desc:
 378  Ret:
 379  Args:
 380  Side Effects:
 381  Example:
 382
 383 =cut
 384
 385 sub get_length {
 386   my $self=shift;
 387   return $self->{length};
 388
 389 }
 390
 391 =head2 set_length
 392
 393  Usage:
 394  Desc:
 395  Ret:
 396  Args:
 397  Side Effects:
 398  Example:
 399
 400 =cut
 401
 402 sub set_length {
 403   my $self=shift;
 404   $self->{length}=shift;
 405 }
 406
 407 =head2 get_contents
 408
 409  Usage:
 410  Desc:
 411  Ret:
 412  Args:
 413  Side Effects:
 414  Example:
 415
 416 =cut
 417
 418 sub get_contents {
 419   my $self=shift;
 420   return $self->{contents};
 421
 422 }
 423
 424 =head2 set_contents
 425
 426  Usage:
 427  Desc:
 428  Ret:
 429  Args:
 430  Side Effects:
 431  Example:
 432
 433 =cut
 434
 435 sub set_contents {
 436   my $self=shift;
 437   $self->{contents}=shift;
 438 }
 439
 440 =head2 get_object
 441
 442  Usage:
 443  Desc:
 444  Ret:
 445  Args:
 446  Side Effects:
 447  Example:
 448
 449 =cut
 450
 451 sub get_object {
 452   my $self=shift;
 453   return $self->{object};
 454
 455 }
 456
 457 =head2 set_object
 458
 459  Usage:
 460  Desc:
 461  Ret:
 462  Args:
 463  Side Effects:
 464  Example:
 465
 466 =cut
 467
 468 sub set_object {
 469   my $self=shift;
 470   $self->{object}=shift;
 471 }
 472
 473 =head2 get_object_setter
 474
 475  Usage:
 476  Desc:
 477  Ret:
 478  Args:
 479  Side Effects:
 480  Example:
 481
 482 =cut
 483
 484 sub get_object_setter {
 485   my $self=shift;
 486   return $self->{object_setter};
 487
 488 }
 489
 490 =head2 set_object_setter
 491
 492  Usage:
 493  Desc:
 494  Ret:
 495  Args:
 496  Side Effects:
 497  Example:
 498
 499 =cut
 500
 501 sub set_object_setter {
 502   my $self=shift;
 503   $self->{object_setter}=shift;
 504 }
 505
 506 =head2 get_object_getter
 507
 508  Usage:
 509  Desc:
 510  Ret:
 511  Args:
 512  Side Effects:
 513  Example:
 514
 515 =cut
 516
 517 sub get_object_getter {
 518   my $self=shift;
 519   return $self->{object_getter};
 520
 521 }
 522
 523 =head2 set_object_getter
 524
 525  Usage:
 526  Desc:
 527  Ret:
 528  Args:
 529  Side Effects:
 530  Example:
 531
 532 =cut
 533
 534 sub set_object_getter {
 535   my $self=shift;
 536   $self->{object_getter}=shift;
 537 }
 538
 539
 540
 541 =head2 render
 542
 543  Usage:
 544  Desc:
 545  Ret:
 546  Args:
 547  Side Effects:
 548  Example:
 549
 550 =cut
 551
 552 sub render {
 553     my $self = shift;
 554     return $self->get_contents()."\n";
 555 }
 556
 557
 558
 559 package CXGN::Insitu::EditableField;
 560
 561 use base qw / CXGN::Insitu::Field /;
 562
 563 sub new {
 564     my $class = shift;
 565     return $class->SUPER::new(@_);
 566 }
 567
 568 sub render {
 569     my $self = shift;
 570     return " <input name=\"".$self->get_field_name()."\" value=\"".$self->get_contents()."\" size=\"".$self->get_length()."\" />\n";
 571 }
 572
 573
 574
 575 return 1;