SwiftFileBackendList.php

Go to the documentation of this file.

<?php
abstract class SwiftFileBackendList implements Iterator {
    protected $bufferIter = [];
 
    protected $bufferAfter = null;
 
    protected $pos = 0;
 
    protected $params = [];
 
    protected $backend;
 
    protected $container;
 
    protected $dir;
 
    protected $suffixStart;
 
    const PAGE_SIZE = 9000; // file listing buffer size
 
    public function __construct( SwiftFileBackend $backend, $fullCont, $dir, array $params ) {
        $this->backend = $backend;
        $this->container = $fullCont;
        $this->dir = $dir;
        if ( substr( $this->dir, -1 ) === '/' ) {
            $this->dir = substr( $this->dir, 0, -1 ); // remove trailing slash
        }
        if ( $this->dir == '' ) { // whole container
            $this->suffixStart = 0;
        } else { // dir within container
            $this->suffixStart = strlen( $this->dir ) + 1; // size of "path/to/dir/"
        }
        $this->params = $params;
    }
 
    public function key() {
        return $this->pos;
    }
 
    public function next() {
        // Advance to the next file in the page
        next( $this->bufferIter );
        ++$this->pos;
        // Check if there are no files left in this page and
        // advance to the next page if this page was not empty.
        if ( !$this->valid() && count( $this->bufferIter ) ) {
            $this->bufferIter = $this->pageFromList(
                $this->container, $this->dir, $this->bufferAfter, self::PAGE_SIZE, $this->params
            ); // updates $this->bufferAfter
        }
    }
 
    public function rewind() {
        $this->pos = 0;
        $this->bufferAfter = null;
        $this->bufferIter = $this->pageFromList(
            // @phan-suppress-next-line PhanTypeMismatchArgumentPropertyReferenceReal
            $this->container, $this->dir, $this->bufferAfter, self::PAGE_SIZE, $this->params
        ); // updates $this->bufferAfter
    }
 
    public function valid() {
        if ( $this->bufferIter === null ) {
            return false; // some failure?
        } else {
            return ( current( $this->bufferIter ) !== false ); // no paths can have this value
        }
    }
 
    abstract protected function pageFromList( $container, $dir, &$after, $limit, array $params );
}