class FileExampleStateHelper

A state helper class for the file_example module.

Hierarchy

Expanded class hierarchy of FileExampleStateHelper

1 file declares its use of FileExampleStateHelper
FileExampleReadWriteForm.php in modules/file_example/src/Form/FileExampleReadWriteForm.php
1 string reference to 'FileExampleStateHelper'
file_example.services.yml in modules/file_example/file_example.services.yml
modules/file_example/file_example.services.yml
1 service uses FileExampleStateHelper
file_example.state_helper in modules/file_example/file_example.services.yml
Drupal\file_example\FileExampleStateHelper

File

modules/file_example/src/FileExampleStateHelper.php, line 10

Namespace

Drupal\file_example
View source 
class FileExampleStateHelper {
    const KEY_DEFAULT_FILE = 'file_example_default_file';
    const KEY_DEFAULT_DIRECTORY = 'file_example_default_directory';
    const DEFAULT_FILE = 'session://drupal.txt';
    const DEFAULT_DIRECTORY = 'session://directory1';
    
    /**
     * Constructs a new FileExampleHelper object.
     *
     * @param \Drupal\Core\State\StateInterface $state
     *   The state.
     */
    public function __construct(StateInterface $state) {
    }
    
    /**
     * Gets the default file.
     *
     * @return string
     *   The URI of the default file.
     */
    public function getDefaultFile() : string {
        return $this->state
            ->get(self::KEY_DEFAULT_FILE, self::DEFAULT_FILE);
    }
    
    /**
     * Sets the default file.
     *
     * @param string $uri
     *   URI to save for future display in the form.
     */
    public function setDefaultFile(string $uri) : void {
        $this->state
            ->set(self::KEY_DEFAULT_FILE, $uri);
    }
    
    /**
     * Gets the default directory.
     *
     * @return string
     *   The URI of the default directory.
     */
    public function getDefaultDirectory() : string {
        return $this->state
            ->get(self::KEY_DEFAULT_DIRECTORY, self::DEFAULT_DIRECTORY);
    }
    
    /**
     * Sets the default directory.
     *
     * @param string $uri
     *   URI to save for later form display.
     */
    public function setDefaultDirectory(string $uri) : void {
        $this->state
            ->set(self::KEY_DEFAULT_DIRECTORY, $uri);
    }
    
    /**
     * Removes the default file and default directory from the state storage.
     */
    public function deleteDefaultState() : void {
        $this->state
            ->delete(self::KEY_DEFAULT_DIRECTORY);
        $this->state
            ->delete(self::KEY_DEFAULT_FILE);
    }

}

Members

Title Modifiers Object type Summary
FileExampleStateHelper::DEFAULT_DIRECTORY constant
FileExampleStateHelper::DEFAULT_FILE constant
FileExampleStateHelper::deleteDefaultState public function Removes the default file and default directory from the state storage.
FileExampleStateHelper::getDefaultDirectory public function Gets the default directory.
FileExampleStateHelper::getDefaultFile public function Gets the default file.
FileExampleStateHelper::KEY_DEFAULT_DIRECTORY constant
FileExampleStateHelper::KEY_DEFAULT_FILE constant
FileExampleStateHelper::setDefaultDirectory public function Sets the default directory.
FileExampleStateHelper::setDefaultFile public function Sets the default file.
FileExampleStateHelper::__construct public function Constructs a new FileExampleHelper object.