Koha-community/Koha: Main Koha release repository - Koha - Koha: The world's first free and open source library system

Main Koha release repository https://koha-community.org

History

Jonathan Druart 19a977dc7b Bug 15758: Koha::Libraries - Remove GetBranchName This is the fourth and last patch set to remove C4::Branch. The real purpose of this patch is to standardise and refactor some code which is related to the libraries selection/display. Its unconfessed purpose is to remove the C4::Branch package. Before this patch set, only 6 subroutines still existed in the C4::Branch package: - GetBranchName - GetBranchesLoop - mybranch - onlymine - GetBranches - GetBranch GetBranchName basically returns the branchname for a given branchcode. The branchname is only used for a display purpose and we don't need to retrieve it in package or pl scripts (unless for a few exceptions). We have a `Branches` template plugin with a `GetName` method which does exactly this job. To achieve this removal, we will use this template plugin and delete the GetBranchName from pl and pm files. The `Branches.all()` will now select the library of the logged in user if no `selected` parameter has been passed. This new behavior could cause regressions, for instance there are some places where we do not want an option preselected (batch item modification for instance), keep that in mind when testing. GetBranchesLoop took 3 parameters: $branch and $onlymine. The first one was used to set a "selected" flag, for a display purpose: select an option in the libraries dropdown lists. The second one was useless: If not passed or set to 0, the `C4::Branch::onlymine` subroutine was called. This onlymine flag was use to know if the logged in user was able to see other libraries infos. A patron can see the infos from other libraries if IndependentBranches is not set OR if he has the superlibrarian permission. Prior to this patch set, the "onlymine test" was done on different places (neworderempty.pl, additem.pl, holidays.pl, etc.), including the Branches TT plugin. In this patch set, this test is only done on one place (C4::Context::only_my_library, code moved from C4::Branch::onlymine). To accomplish the same job as this subroutine, we just need to call the `Branches.all()` method from the `Branches` TT plugin. It already accepts a `selected` parameter to set a flag on the option to select. To avoid the repetitive [% IF selected %]<option selected="selected">[% ELSE %]<option>[% END %] pattern, a new `html_helpers` TT include file has been created, it defines an `options_for_libraries` block, which takes a `selected` parameter. We could imagine to use this include file for other selects. The 'mybranch` and `onlymine` subroutines of the C4::Branch package have been moved to C4::Context. onlymine has been renamed with only_my_library. There are only 4 occurrences of it, against 11 before this patch set. There 2 subroutines are Context-centric and it makes sense to put them in `C4::Context` (at least it's the least worst place!) GetBranches is the tricky part of this patch set: It retrieves all the libraries, independently of the value of IndependentBranches. To keep the same way as the existing calls of `Branches.all()`, I have added a `unfiltered` parameter. If set, the `Branches.all()` will call a usual Koha::Libraries->search method, otherwise Koha::Libraries->search_filtered will be called. This new method will check if the logged in user is allowed to see other libraries or only its library. Note that this `GetBranches` subroutine also created a `category` key: it allowed to get the list of groups (of libraries) where this library existed. Thanks to a previous patch set (bug 15295), this value was not used anymore (I may have missed something!). Note that the only use of `GetBranch` was buggy (see bug 15746). Test plan (for the whole patch set): The best way to test this whole patch set is to test with 2 instances: 1 with the patch set applied, 1 using master, to be sure there is no regression. It would be good to test the same with `IndependentBranches` and the without `IndependentBranches`. No difference should be found. The tester must focus on the library dropdowns on as many forms as possible. You will notice changes in the order of the options: the libraries will now be ordered by branchname (instead of branchcode in some places). A special attention will be given to the following page: - acqui/neworderempty.pl - catalogue/search.pl - members/members-home.pl (header?) - opac/opac-topissues.pl - tools/holidays.pl - admin/branch_transfer_limits.pl - admin/item_circulation_alerts.pl - rotating_collections/transferCollection.pl - suggestion/suggestion.pl - tools/export.pl Notes for QA: - There are 2 FIXMEs in the patch set, I have kept the existing behavior, but I am not sure it's the good one. Feel free to open a bug report and I will fill a patch if you think it's not correct. Otherwise, remove the FIXME lines in a follow-up patch. - The whole patch set is huge and makes a lot of changes. But it finally will tremendously reduce the number of lines: 716 insertions for 1910 deletions Signed-off-by: Owen Leonard <oleonard@myacpl.org> Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>		8 years ago
..
tables	Bug 17076 - Format fines in patron search results table	8 years ago
boraccount.tt	Bug 16888: Add Font Awesome Icons to Members	8 years ago
deletemem.tt	Bug 17097: here the var is 'member', not 'borrowernumber'	8 years ago
discharge.tt	Bug 15758: Koha::Libraries - Remove GetBranchName	8 years ago
discharges.tt	Bug 15758: Koha::Libraries - Remove GetBranchName	8 years ago
files.tt	Bug 15542: Always display the patron's info the same way.	8 years ago
mancredit.tt	Bug 4041: Third step - Display address on patron's pages using the system preference	9 years ago
maninvoice.tt	Bug 4041: Third step - Display address on patron's pages using the system preference	9 years ago
member-flags.tt	Bug 15758: Koha::Libraries - Remove GetBranchName	8 years ago
member-password.tt	Bug 15758: Koha::Libraries - Remove GetBranchName	8 years ago
member.tt	Bug 15407: Koha::Patron::Categories - replace C4::Category->all	8 years ago
memberentrygen.tt	Bug 14060: Add the datepicker class to dateofbirth	8 years ago
members-update.tt	Bug 16990: Display branch names instead of code in patron mod requests	8 years ago
moremember-brief.tt	Bug 16730 - Use member-display-address-style*-includes in moremember-brief.tt	8 years ago
moremember-print.tt	Bug 17100: Restore previous logic	8 years ago
moremember-receipt.tt	Bug 16218: printfeercpt.tt (and others) does not include jQuery	8 years ago
moremember.tt	Bug 15758: Koha::Libraries - Remove GetBranchName	8 years ago
nl-search.tt	Bug 15304: Remove Norwegian strings from nl-search.tt	8 years ago
notices.tt	Bug 15758: Koha::Libraries - Remove GetBranchName	8 years ago
pay.tt	Bug 15758: Koha::Libraries - Remove GetBranchName	8 years ago
paycollect.tt	Bug 15758: Koha::Libraries - Remove GetBranchName	8 years ago
printfeercpt.tt	Bug 16218: printfeercpt.tt (and others) does not include jQuery	8 years ago
printinvoice.tt	Bug 16241 - Move staff client CSS out of language directory	8 years ago
purchase-suggestions.tt	Bug 15758: Koha::Libraries - Remove GetBranchName	8 years ago
readingrec.tt	Bug 16478: Fix checkout history tabs - intranet	8 years ago
routing-lists.tt	Bug 15758: Koha::Libraries - Remove GetBranchName	8 years ago
statistics.tt	Bug 15758: Koha::Libraries - Remove GetBranchName	8 years ago
update-child.tt	Bug 15407: Koha::Patron::Categories - replace GetborCatFromCatType	8 years ago