bp_document_readfile_chunked( string $file, int $start, int $length )

Read file chunked.

Description

Reads file in chunks so big downloads are possible without changing PHP.INI – http://codeigniter.com/wiki/Download_helper_for_large_files/.

Parameters

$file: (Required) File.
$start: (Required) Byte offset/position of the beginning from which to read from the file.
$length: (Required) Length of the chunk to be read from the file in bytes, 0 means full file.

Return

(bool) Success or fail

Source

File: bp-document/bp-document-filters.php

function bp_document_readfile_chunked( $file, $start = 0, $length = 0 ) {
    if ( ! defined( 'BP_DOCUMENT_CHUNK_SIZE' ) ) {
        define( 'BP_DOCUMENT_CHUNK_SIZE', 1024 * 1024 );
    }
    $handle = @fopen( $file, 'r' ); // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged, WordPress.WP.AlternativeFunctions.file_system_read_fopen
 
    if ( false === $handle ) {
        return false;
    }
 
    if ( ! $length ) {
        $length = @filesize( $file ); // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged
    }
 
    $read_length = (int) BP_DOCUMENT_CHUNK_SIZE;
 
    if ( $length ) {
        $end = $start + $length - 1;
 
        @fseek( $handle, $start ); // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged
        $p = @ftell( $handle ); // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged
 
        while ( ! @feof( $handle ) && $p <= $end ) { // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged
            // Don't run past the end of file.
            if ( $p + $read_length > $end ) {
                $read_length = $end - $p + 1;
            }
 
            echo @fread( $handle, $read_length ); // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged, WordPress.XSS.EscapeOutput.OutputNotEscaped, WordPress.WP.AlternativeFunctions.file_system_read_fread
            $p = @ftell( $handle ); // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged
 
            if ( ob_get_length() ) {
                ob_flush();
                flush();
            }
        }
    } else {
        while ( ! @feof( $handle ) ) { // @codingStandardsIgnoreLine.
            echo @fread( $handle, $read_length ); // @codingStandardsIgnoreLine.
            if ( ob_get_length() ) {
                ob_flush();
                flush();
            }
        }
    }
 
    return @fclose( $handle ); // phpcs:ignore Generic.PHP.NoSilencedErrors.Discouraged, WordPress.WP.AlternativeFunctions.file_system_read_fclose
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyBoss 1.4.1	Introduced.

Used By
Used By	Description
bp-document/bp-document-filters.php: bp_document_download_file_force()	Force download – this is the default method.

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.

Contents