[Koha-patches] [PATCH] Bug 1953 [6/6]: adding pod documentation for C4::Koha::displayServers

Galen Charlton galen.charlton at liblime.com
Tue Jul 29 18:42:50 CEST 2008


From: Andrew Moore <andrew.moore at liblime.com>

This method was not documented. I added some POD to it.

Signed-off-by: Galen Charlton <galen.charlton at liblime.com>
---
 C4/Koha.pm |   31 +++++++++++++++++++++++++++++++
 1 files changed, 31 insertions(+), 0 deletions(-)

diff --git a/C4/Koha.pm b/C4/Koha.pm
index 7f5bb68..846af3e 100644
--- a/C4/Koha.pm
+++ b/C4/Koha.pm
@@ -887,6 +887,37 @@ SELECT lib,
     return \%notforloan_label_of;
 }
 
+=head2 displayServers
+
+=over 4
+
+my $servers = displayServers();
+
+my $servers = displayServers( $position );
+
+my $servers = displayServers( $position, $type );
+
+=back
+
+displayServers returns a listref of hashrefs, each containing
+information about available z3950 servers. Each hashref has a format
+like:
+
+    {
+      'checked'    => 'checked',
+      'encoding'   => 'MARC-8'
+      'icon'       => undef,
+      'id'         => 'LIBRARY OF CONGRESS',
+      'label'      => '',
+      'name'       => 'server',
+      'opensearch' => '',
+      'value'      => 'z3950.loc.gov:7090/',
+      'zed'        => 1,
+    },
+
+
+=cut
+
 sub displayServers {
     my ( $position, $type ) = @_;
     my $dbh = C4::Context->dbh;
-- 
1.5.5.GIT




More information about the Koha-patches mailing list