File Coverage

blib/lib/Gantry/Plugins/AjaxFORM.pm

Criterion	Covered	Total	%
statement	15	80	18.7
branch	0	32	0.0
condition			n/a
subroutine	5	17	29.4
pod	11	11	100.0
total	31	140	22.1

package Gantry::Plugins::AjaxFORM;

use strict;
use Carp;
use Data::FormValidator;

use Gantry::Utils::CRUDHelp qw( clean_dates clean_params form_profile );

use base 'Exporter';

our @EXPORT_OK = qw( select_multiple_closure );

#-----------------------------------------------------------
# Constructor
#-----------------------------------------------------------

sub new {
    my $class     = shift;
    my $callbacks = { @_ };

    unless ( defined $callbacks->{template} ) {
        $callbacks->{template} = 'form.tt';
    }

    return bless $callbacks, $class;
}

#-----------------------------------------------------------
# Accessors, so we don't misspell hash keys
#-----------------------------------------------------------

sub cancel_action {
    my $self = shift;

    if ( defined $self->{cancel_action} ) {
        return $self->{cancel_action}
    }
    else {
        croak 'cancel_action not defined or misspelled';
    }
}

sub success_action {
    my $self = shift;

    if ( defined $self->{success_action} ) {
        return $self->{success_action}
    }
    else {
        croak 'success_action not defined or misspelled';
    }
}

sub process_action {
    my $self = shift;

    if ( defined $self->{process_action} ) {
        return $self->{process_action}
    }
    else {
        croak 'process_action not defined or misspelled';
    }
}

sub form {
    my $self = shift;

    if ( defined $self->{form} ) {
        return $self->{form}
    }
    else {
        croak 'form not defined or misspelled';
    }
}

sub text_descr {
    my $self = shift;
    return $self->{text_descr}
}

sub user_data {
    my $self = shift;
    return $self->{user_data}
}

sub use_clean_dates {
    my $self = shift;
    return $self->{use_clean_dates};
}

sub turn_off_clean_params {
    my $self = shift;
    return $self->{turn_off_clean_params};
}

#-----------------------------------------------------------
# Methods users call
#-----------------------------------------------------------

#-------------------------------------------------
# $self->process( $your_self )
#-------------------------------------------------
sub process {
    my ( $self, $your_self ) = @_;

    my $form;
    my $show_form = 0;
    my $params = $your_self->get_param_hash();

    if ($params->{cancel}) {

        # Redirect if user pressed 'Cancel'

        return $self->cancel_action->($your_self, $params, 'cancel');

    } else {

        # get and hold the form desription

        $form = $self->form->($your_self, $self->user_data);

        # Check form data

        my $results = Data::FormValidator->check(
            $params,
            form_profile($form->{fields}),
        );

        # check to see if we need to display the form

        $show_form = 1 if (keys %{$params} == 0);
        $show_form = 1 if ($results->has_invalid);
        $show_form = 1 if ($results->has_missing);

        if ($show_form) {

            # order is important, first put in the form...

            $your_self->stash->view->form($form);

            # ...then add any error results

            if ($your_self->method eq 'POST') {

                $your_self->stash->view->form->results($results);

            }

        } else {

            # remove submit button entry

            delete $params->{submit};

            if ($self->turn_off_clean_params) {

                if ($self->use_clean_dates) {

                    clean_dates($params, $form->{fields});

                }

            } else { clean_params($params, $form->{fields}); }

            # do something with the form data

            $self->process_action->($your_self, $params, $self->user_data);

            # move along, we're all done here

            return $self->success_action->($your_self, $params, 'submit');

        }

    }

} # END: process

#-----------------------------------------------------------
# Helper functions offered for export
#-----------------------------------------------------------

sub select_multiple_closure {
    my $field_name  = shift;
    my $db_selected = shift;

    return sub {
        my $id     = shift;
        my $params = shift;

        my @real_keys = grep ! /^\./, keys %{ $params };

        if ( @real_keys ) {
            return unless $params->{ $field_name };
            my @param_ids = split /\0/, $params->{ $field_name };
            foreach my $param_id ( @param_ids ) {
                return 1 if ( $param_id == $id );
            }
        }
        else {
            return $db_selected->{ $id };
        }
    };
}

1;

__END__