1 package SQL::Translator::Producer::HTML;
3 # -------------------------------------------------------------------
4 # $Id: HTML.pm,v 1.4 2003-07-18 22:54:41 kycl4rk Exp $
5 # -------------------------------------------------------------------
6 # Copyright (C) 2003 Ken Y. Clark <kclark@cpan.org>
8 # This program is free software; you can redistribute it and/or
9 # modify it under the terms of the GNU General Public License as
10 # published by the Free Software Foundation; version 2.
12 # This program is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 # General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with this program; if not, write to the Free Software
19 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
21 # -------------------------------------------------------------------
25 use vars qw[ $VERSION ];
26 $VERSION = sprintf "%d.%02d", q$Revision: 1.4 $ =~ /(\d+)\.(\d+)/;
28 use SQL::Translator::Schema::Constants;
29 use SQL::Translator::Utils qw(header_comment);
31 # -------------------------------------------------------------------
34 my $schema = $t->schema;
35 my $schema_name = $schema->name || 'Schema';
36 my $args = $t->producer_args;
39 my $title = "Description of $schema_name";
40 my $html = $q->start_html(
41 { -title => $title, -bgcolor => 'lightgoldenrodyellow' }
42 ) . $q->h1( $title ). '<a name="top">', $q->hr;
44 if ( my @table_names = map { $_->name } $schema->get_tables ) {
45 $html .= $q->start_table( { -width => '100%' } ).
46 $q->Tr( { -bgcolor => 'khaki' }, $q->td( $q->h2('Tables') ) );
48 for my $table ( @table_names ) {
49 $html .= $q->Tr( $q->td( qq[<a href="#$table">$table</a>] ) );
51 $html .= $q->end_table;
54 for my $table ( $schema->get_tables ) {
55 my $table_name = $table->name or next;
56 my @fields = $table->get_fields or next;
60 { -bgcolor => 'khaki' },
61 $q->td( $q->h3( $table_name ) ) . qq[<a name="$table_name">],
62 $q->td( { -align => 'right' }, qq[<a href="#top">Top</a>] )
69 $html .= $q->start_table( { -border => 1 } ) . $q->Tr(
70 { -bgcolor => 'lightgrey' },
81 for my $field ( @fields ) {
82 my $name = $field->name;
83 $name = qq[<a name="$table_name-$name">$name</a>];
84 my $data_type = $field->data_type;
85 my $size = $field->size;
86 my $default = $field->default_value;
87 my $comment = $field->comments || '';
90 if ( $field->is_foreign_key ) {
91 my $c = $field->foreign_key_reference;
92 my $ref_table = $c->reference_table || '';
93 my $ref_field = ($c->reference_fields)[0];
95 qq[<a href="#$ref_table-$ref_field">$ref_table.$ref_field</a>];
99 push @other, 'PRIMARY KEY' if $field->is_primary_key;
100 push @other, 'UNIQUE' if $field->is_unique;
101 push @other, 'NOT NULL' unless $field->is_nullable;
102 push @other, $comment if $comment;
103 $html .= $q->Tr( $q->td(
104 { -bgcolor => 'white' },
105 [ $name, $data_type, $size, $default, join(', ', @other), $fk ]
108 $html .= $q->end_table;
113 if ( my @indices = $table->get_indices ) {
114 $html .= $q->h3('Indices');
115 $html .= $q->start_table( { -border => 1 } ) . $q->Tr(
116 { -bgcolor => 'lightgrey' },
117 $q->th( [ 'Name', 'Fields' ] )
120 for my $index ( @indices ) {
122 { -bgcolor => 'white' },
123 $q->td( [ $index->name, join( ', ', $index->fields ) ] )
127 $html .= $q->end_table;
133 $html .= qq[Created by <a href="http://sqlfairy.sourceforge.net">].
134 qq[SQL::Translator</a>];
141 # -------------------------------------------------------------------
142 # Always be ready to speak your mind,
143 # and a base man will avoid you.
145 # -------------------------------------------------------------------
149 SQL::Translator::Producer::HTML - HTML producer for SQL::Translator
153 use SQL::Translator::Producer::HTML;
157 Creates an HTML document describing the tables.
161 Ken Y. Clark E<lt>kclark@cpan.orgE<gt>