[Rt-commit] rt branch, 4.4/external-storage, updated. rt-4.2.11-63-gba31033

[Shawn Moore]

The branch, 4.4/external-storage has been updated
       via  ba31033dd021f6541d5012188fb1dbdf41dfe438 (commit)
      from  e8431bc37e3a183437255a3f07bf5b0fe84054d7 (commit)

Summary of changes:
 lib/RT/System.pm | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

- Log -----------------------------------------------------------------
commit ba31033dd021f6541d5012188fb1dbdf41dfe438
Author: Shawn M Moore <shawn at bestpractical.com>
Date:   Fri May 22 22:42:25 2015 +0000

    Document the ExternalStorage-related RT::System methods

diff --git a/lib/RT/System.pm b/lib/RT/System.pm
index 547988f..9103d14 100644
--- a/lib/RT/System.pm
+++ b/lib/RT/System.pm
@@ -327,6 +327,13 @@ sub ParsedUpgradeHistory {
     return ($version_status, @lines);
 }
 
+=head2 ExternalStorage
+
+Accessor for the storage engine selected by L<RT::ExternalStorage>. Will
+be undefined if external storage is not configured.
+
+=cut
+
 sub ExternalStorage {
     my $self = shift;
     if (@_) {
@@ -335,6 +342,17 @@ sub ExternalStorage {
     return $self->{ExternalStorage};
 }
 
+=head2 ExternalStorageURLFor object
+
+Returns a URL for direct linking to an L<RT::ExternalStorage>
+engine. Will return C<undef> if external storage is not configured, or
+if direct linking is disabled in config (C<$ExternalStorageDirectLink>),
+or if the external storage engine doesn't support hyperlinking (as in
+L<RT::ExternalStorage::Disk>), or finally, if the object is for whatever
+reason not present in external storage.
+
+=cut
+
 sub ExternalStorageURLFor {
     my $self = shift;
     my $Object = shift;

-----------------------------------------------------------------------