Coding standards
Security in ResourceSpace
Developer reference
Database
Action functions
Admin functions
Ajax functions
Annotation functions
API functions
Collections functions
Comment functions
Config functions
CSV export functions
Dash functions
Debug functions
Encryption functions
Facial recognition functions
File functions
General functions
Language functions
Log functions
Login functions
Message functions
Migration functions
Node functions
PDF functions
Plugin functions
Render functions
Reporting functions
Request functions
Research functions
Slideshow functions
Theme permission functions
User functions
Video functions
Database functions
Metadata functions
Resource functions
Search functions
Map functions
Job functions
Tab functions
Test functions

collection_download_process_text_file()

Description

Provide resource data/collection_resource data to add to text file during a collection download.

Parameters

ColumnTypeDefaultDescription
$dl_data array Array of collection download data passed from process_collection_download()
$ref integer Resource ID
$filename string
$subbed_original: bool $dl_data['sizetext']; if $subbed_original
$subbed_original bool Has original file been substituted for unavailable size?

Return

string Text to append to file

Location

include/collections_functions.php lines 4426 to 4468

Definition

 
function collection_download_process_text_file(array $dl_data, int $ref, string $filename, bool $subbed_original): string
{
    $sizetext = $dl_data['sizetext'];
    if ($subbed_original) {
        $sizetext .= ' (' . $GLOBALS['lang']['substituted_original'] . ')';
    }
    $text = "";
    if ($dl_data['includetext'] ?? false) {
        if ((string) $dl_data['k'] === '') {
            $fields = get_resource_field_data($ref);
        } else {
            // External shares should take into account fields that are not meant to show in that case
            $fields = get_resource_field_data($ref, false, true, null, true);
        }
        $commentdata = get_collection_resource_comment($ref, $dl_data['collection']);
        $fields_count = count($fields);
        if ($fields_count > 0) {
            $hook_replace_text = hook('replacecollectiontext', '', array($text, $sizetext, $filename, $ref, $fields, $fields_count, $commentdata));
            if (!$hook_replace_text) {
                $text .= ($sizetext == '' ? '' : $sizetext) . ' ' . $filename . "\r\n-----------------------------------------------------------------\r\n";
                $text .= $GLOBALS["lang"]['resourceid'] . ': ' . $ref . "\r\n";

                for ($i = 0; $i < $fields_count; $i++) {
                    $value = $fields[$i]["value"];
                    $title = str_replace('Keywords - ', '', $fields[$i]["title"]);
                    if ((trim((string) $value) != "") && (trim((string) $value) != ',')) {
                        $text .= wordwrap('* ' . $title . ': ' . i18n_get_translated($value) . "\r\n", 65);
                    }
                }
                if (trim((string)$commentdata['comment']) != '') {
                    $text .= wordwrap($GLOBALS["lang"]['comment'] . ': ' . $commentdata['comment'] . "\r\n", 65);
                }
                if (trim((string)$commentdata['rating']) != '') {
                    $text .= wordwrap($GLOBALS["lang"]['rating'] . ': ' . $commentdata['rating'] . "\r\n", 65);
                }
                $text .= "-----------------------------------------------------------------\r\n\r\n";
            } else {
                $text = $hook_replace_text;
            }
        }
    }
    return $text;
}

This article was last updated 3rd April 2025 21:35 Europe/London time based on the source file dated 3rd April 2025 16:40 Europe/London time.