From cacc12a4ee30d58bf9e806ba6cf11401db1abae1 Mon Sep 17 00:00:00 2001
From: Demian Katz <demian.katz@villanova.edu>
Date: Wed, 24 Oct 2012 08:56:39 -0400
Subject: [PATCH] Fixed comments.
---
.../VuFind/src/VuFind/RecordDriver/SolrDefault.php | 12 ++++++++++--
module/VuFind/src/VuFind/RecordDriver/SolrMarc.php | 12 ++++++++++--
2 files changed, 20 insertions(+), 4 deletions(-)
diff --git a/module/VuFind/src/VuFind/RecordDriver/SolrDefault.php b/module/VuFind/src/VuFind/RecordDriver/SolrDefault.php
index 9d11a3cb47b..d778d5da22d 100644
--- a/module/VuFind/src/VuFind/RecordDriver/SolrDefault.php
+++ b/module/VuFind/src/VuFind/RecordDriver/SolrDefault.php
@@ -1004,8 +1004,16 @@ class SolrDefault extends AbstractBase
}
/**
- * Return an associative array of URLs associated with this record (key = URL,
- * value = description).
+ * Return an array of associative URL arrays with one or more of the following
+ * keys:
+ *
+ * <li>
+ * <ul>desc: URL description text to display (optional)</ul>
+ * <ul>url: fully-formed URL (required if 'route' is absent)</ul>
+ * <ul>route: VuFind route to build URL with (required if 'url' is absent)</ul>
+ * <ul>routeParams: Parameters for route (optional)</ul>
+ * <ul>queryString: Query params to append after building route (optional)</ul>
+ * </li>
*
* @return array
*/
diff --git a/module/VuFind/src/VuFind/RecordDriver/SolrMarc.php b/module/VuFind/src/VuFind/RecordDriver/SolrMarc.php
index 6018ee1dc12..685179d3c51 100644
--- a/module/VuFind/src/VuFind/RecordDriver/SolrMarc.php
+++ b/module/VuFind/src/VuFind/RecordDriver/SolrMarc.php
@@ -544,8 +544,16 @@ class SolrMarc extends SolrDefault
}
/**
- * Return an associative array of URLs associated with this record (key = URL,
- * value = description).
+ * Return an array of associative URL arrays with one or more of the following
+ * keys:
+ *
+ * <li>
+ * <ul>desc: URL description text to display (optional)</ul>
+ * <ul>url: fully-formed URL (required if 'route' is absent)</ul>
+ * <ul>route: VuFind route to build URL with (required if 'url' is absent)</ul>
+ * <ul>routeParams: Parameters for route (optional)</ul>
+ * <ul>queryString: Query params to append after building route (optional)</ul>
+ * </li>
*
* @return array
*/
--
GitLab