EntityDirLocator.php

Go to the documentation of this file.

<?php

namespace Elgg;

class EntityDirLocator {

    const BUCKET_SIZE = 5000;
    
    protected $guid;

    public function __construct($guid) {
        $guid = (int) $guid;

        if (!$guid || $guid < 1) {
            // Don't throw a ClassException to keep this class completely atomic.
            throw new \InvalidArgumentException("GUIDs must be integers > 0.");
        }

        $this->guid = $guid;
    }
    
    public function getPath() {
        $bound = $this->getLowerBucketBound($this->guid);
        return "$bound/$this->guid/";
    }

    public function __toString() {
        return $this->getPath();
    }

    private static function getLowerBucketBound(int $guid, int $bucket_size = 0) {
        if ($bucket_size < 1) {
            $bucket_size = self::BUCKET_SIZE;
        }
        
        return (int) max(floor($guid / $bucket_size) * $bucket_size, 1);
    }
}