Bugzilla – Attachment 168148 Details for
Bug 37198
POD for GetPreparedLetter doesn't include 'objects'
Home
|
New
|
Browse
|
Search
|
[?]
|
Reports
|
Help
|
New Account
|
Log In
[x]
|
Forgot Password
Login:
[x]
[patch]
Bug 37198: Improve GetPreparedLetter documentation
Bug-37198-Improve-GetPreparedLetter-documentation.patch (text/plain), 3.32 KB, created by
Martin Renvoize (ashimema)
on 2024-06-26 14:29:45 UTC
(
hide
)
Description:
Bug 37198: Improve GetPreparedLetter documentation
Filename:
MIME Type:
Creator:
Martin Renvoize (ashimema)
Created:
2024-06-26 14:29:45 UTC
Size:
3.32 KB
patch
obsolete
>From 881308f02ad17d969056f408e0be9961a0e59363 Mon Sep 17 00:00:00 2001 >From: Martin Renvoize <martin.renvoize@ptfs-europe.com> >Date: Wed, 26 Jun 2024 15:24:01 +0100 >Subject: [PATCH] Bug 37198: Improve GetPreparedLetter documentation > >--- > C4/Letters.pm | 42 ++++++++++++++++++++++++------------------ > 1 file changed, 24 insertions(+), 18 deletions(-) > >diff --git a/C4/Letters.pm b/C4/Letters.pm >index f938f611b51..eec8081b3ee 100644 >--- a/C4/Letters.pm >+++ b/C4/Letters.pm >@@ -557,24 +557,30 @@ sub SendAlerts { > > =head2 GetPreparedLetter( %params ) > >- %params hash: >- module => letter module, mandatory >- letter_code => letter code, mandatory >- branchcode => for letter selection, if missing default system letter taken >- tables => a hashref with table names as keys. Values are either: >- - a scalar - primary key value >- - an arrayref - primary key values >- - a hashref - full record >- substitute => custom substitution key/value pairs >- repeat => records to be substituted on consecutive lines: >- - an arrayref - tries to guess what needs substituting by >- taking remaining << >> tokensr; not recommended >- - a hashref token => @tables - replaces <token> << >> << >> </token> >- subtemplate for each @tables row; table is a hashref as above >- want_librarian => boolean, if set to true triggers librarian details >- substitution from the userenv >- Return value: >- letter fields hashref (title & content useful) >+ my $letter = GetPreparedLetter( >+ { >+ module => "letter module", # mandatory >+ letter_code => "letter code", # mandatory >+ branchcode => "for letter selection", # if missing default system letter taken >+ objects => {}, # a hashref with object names as keys and objects as values >+ tables => {}, # a hashref with table names as keys. Values are either: >+ # - a scalar - primary key value >+ # - an arrayref - primary key values >+ # - a hashref - full record >+ substitute => {}, # custom substitution key/value pairs >+ repeat => '', # records to be substituted on consecutive lines, accepts either: >+ # - an arrayref >+ # tries to guess what needs substituting by taking remaining >+ # << >> tokensr; not recommended >+ # - a hashref token => @tables >+ # replaces <token> << >> << >> </token> subtemplate for each >+ # @tables row; table is a hashref as above >+ want_librarian => '' # boolean, if set to true triggers librarian details substitution >+ # from the userenv >+ } >+ ); >+ >+Return value: letter fields hashref (title & content useful) > > =cut > >-- >2.45.2
You cannot view the attachment while viewing its details because your browser does not support IFRAMEs.
View the attachment on a separate page
.
View Attachment As Diff
View Attachment As Raw
Actions:
View
|
Diff
|
Splinter Review
Attachments on
bug 37198
: 168148