208761 - Move GetFormat into Bugzilla::Template

Status: RESOLVED FIXED

(Bugzilla :: Bugzilla-General, enhancement)

Description

[Bradley Baetz (:bbaetz)]

GetFormat needs to move, and become either a sub or a method on the template 
object. Haven't decided which yet.

Comment 1

[Max Kanat-Alexander]

I think that for mod_perl stuff, it would probably make more sense if it was a
method on the object. That's information that will never change from
instantiation of the object, but may change across calls of the subroutine. 

Comment 2

[Frédéric Buclin]

my $format = $template->get_format() sounds good. :)

Comment 3

[Frédéric Buclin]

Attachment: patch, v1

I also added missing POD in Template.pm for put_header() and put_footer().

Comment 4

[Teemu Mannermaa (:wicked)]

Comment on attachment 192767 [details] [diff] [review]
patch, v1

>Index: Bugzilla/Template.pm
>-Bugzilla::Template - Wrapper arround the Template Toolkit C<Template> object
>+Bugzilla::Template - Wrapper around the Template Toolkit C<Template> object
> 
> =head1 SYNOPSYS

Nit: Here's another typo to fix. :)

>+=item C<put_header($title, $h1, $h2)>
>+
>+ Description: Display the header of the page.

Nit: I liked removed comment text more in this and put_footer methods. Atleast
add a sentence saying that these are for pre-templatized code and are in our
kill list.

>+ Description: Construct a format object from URL parameters.

Nit: Eh, an object? Return value doesn't seem an object to me. Granted, this
term was on original code too. :)

Comment 5

[Joel Peshkin]

Could you add a little more information on how this is supposed to work to the
docs?  It's still about as clear as mud.

Comment 6

[Frédéric Buclin]

(In reply to comment #5)
> Could you add a little more information on how this is supposed to work to the
> docs?  It's still about as clear as mud.

For which method(s)??

Comment 7

[Dave Miller [:justdave]]

clearing approval request pending Joel's answer to Fred's question.  Rerequest
when we've got it unless it involved a reroll of the patch, then go through
review and such of course.

Comment 8

[Dave Miller [:justdave]]

<joel> Fred didn't make the lack of documentation on that function any worse thn
it was
<joel> I was hoping he'd clear it up when he moved it, but it is a mystery to
him as well :-)

Comment 9

[Frédéric Buclin]

Checking in buglist.cgi;
/cvsroot/mozilla/webtools/bugzilla/buglist.cgi,v  <--  buglist.cgi
new revision: 1.308; previous revision: 1.307
done
Checking in chart.cgi;
/cvsroot/mozilla/webtools/bugzilla/chart.cgi,v  <--  chart.cgi
new revision: 1.14; previous revision: 1.13
done
Checking in config.cgi;
/cvsroot/mozilla/webtools/bugzilla/config.cgi,v  <--  config.cgi
new revision: 1.10; previous revision: 1.9
done
Checking in duplicates.cgi;
/cvsroot/mozilla/webtools/bugzilla/duplicates.cgi,v  <--  duplicates.cgi
new revision: 1.46; previous revision: 1.45
done
Checking in enter_bug.cgi;
/cvsroot/mozilla/webtools/bugzilla/enter_bug.cgi,v  <--  enter_bug.cgi
new revision: 1.117; previous revision: 1.116
done
Checking in globals.pl;
/cvsroot/mozilla/webtools/bugzilla/globals.pl,v  <--  globals.pl
new revision: 1.335; previous revision: 1.334
done
Checking in page.cgi;
/cvsroot/mozilla/webtools/bugzilla/page.cgi,v  <--  page.cgi
new revision: 1.17; previous revision: 1.16
done
Checking in post_bug.cgi;
/cvsroot/mozilla/webtools/bugzilla/post_bug.cgi,v  <--  post_bug.cgi
new revision: 1.125; previous revision: 1.124
done
Checking in query.cgi;
/cvsroot/mozilla/webtools/bugzilla/query.cgi,v  <--  query.cgi
new revision: 1.150; previous revision: 1.149
done
Checking in report.cgi;
/cvsroot/mozilla/webtools/bugzilla/report.cgi,v  <--  report.cgi
new revision: 1.32; previous revision: 1.31
done
Checking in show_bug.cgi;
/cvsroot/mozilla/webtools/bugzilla/show_bug.cgi,v  <--  show_bug.cgi
new revision: 1.35; previous revision: 1.34
done
Checking in summarize_time.cgi;
/cvsroot/mozilla/webtools/bugzilla/summarize_time.cgi,v  <--  summarize_time.cgi
new revision: 1.9; previous revision: 1.8
done
Checking in Bugzilla/Template.pm;
/cvsroot/mozilla/webtools/bugzilla/Bugzilla/Template.pm,v  <--  Template.pm
new revision: 1.31; previous revision: 1.30
done
Checking in docs/xml/customization.xml;
/cvsroot/mozilla/webtools/bugzilla/docs/xml/customization.xml,v  <-- 
customization.xml
new revision: 1.21; previous revision: 1.20
done

Comment 10

[Frédéric Buclin]

Oops, I forgot to include nits reported by wicked about a too vague POD
description in Template.pm. This is fixed now.

Checking in Bugzilla/Template.pm;
/cvsroot/mozilla/webtools/bugzilla/Bugzilla/Template.pm,v  <--  Template.pm
new revision: 1.32; previous revision: 1.31
done