SpaceUsedTest.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\file\Kernel;

use Drupal\file\Entity\File;
use Drupal\file\FileInterface;

/**
 * Tests the spaceUsed() function.
 *
 * @group file
 */
class SpaceUsedTest extends FileManagedUnitTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        // Create records for a couple of users with different sizes.
        $this->createFileWithSize('public://example1.txt', 50, 2);
        $this->createFileWithSize('public://example2.txt', 20, 2);
        $this->createFileWithSize('public://example3.txt', 100, 3);
        $this->createFileWithSize('public://example4.txt', 200, 3);
        // Now create some non-permanent files.
        $this->createFileWithSize('public://example5.txt', 1, 2, 0);
        $this->createFileWithSize('public://example6.txt', 3, 3, 0);
    }
    
    /**
     * Creates a file with a given size.
     *
     * @param string $uri
     *   URI of the file to create.
     * @param int $size
     *   Size of the file.
     * @param int $uid
     *   File owner ID.
     * @param int $status
     *   Whether the file should be permanent or temporary.
     *
     * @return \Drupal\Core\Entity\EntityInterface
     *   The file entity.
     */
    protected function createFileWithSize($uri, $size, $uid, $status = FileInterface::STATUS_PERMANENT) {
        file_put_contents($uri, $this->randomMachineName($size));
        $file = File::create([
            'uri' => $uri,
            'uid' => $uid,
            'status' => $status,
        ]);
        $file->save();
        return $file;
    }
    
    /**
     * Tests different users with the default status.
     */
    public function testFileSpaceUsed() : void {
        $file = $this->container
            ->get('entity_type.manager')
            ->getStorage('file');
        // Test different users with default status.
        $this->assertEquals(70, $file->spaceUsed(2));
        $this->assertEquals(300, $file->spaceUsed(3));
        $this->assertEquals(370, $file->spaceUsed());
        // Test the status fields
        $this->assertEquals(4, $file->spaceUsed(NULL, 0));
        $this->assertEquals(370, $file->spaceUsed());
        // Test both the user and status.
        $this->assertEquals(0, $file->spaceUsed(1, 0));
        $this->assertEquals(0, $file->spaceUsed(1));
        $this->assertEquals(1, $file->spaceUsed(2, 0));
        $this->assertEquals(70, $file->spaceUsed(2));
        $this->assertEquals(3, $file->spaceUsed(3, 0));
        $this->assertEquals(300, $file->spaceUsed(3));
    }

}