Interface IElFinderHashEncoder

All Superinterfaces:
Serializable
All Known Subinterfaces:
IElFinderHashCodec
All Known Implementing Classes:
DefaultElFinderHashCodec
public interface IElFinderHashEncoder extends Serializable
Encoder for file and directory file paths. Used by the elFinder API to avoid having to use real file paths from the file system.

Note: Despite the elFinder docs calling it a "hash", it is NOT a hash at all. A hash is (usually) irreversible, while this is a reversible encoding. It is more of a "file path encoder".

The hash is used to identify a file in the elFinder client-server API.

Since:
8.3.0
Author:
XIMA MEDIA GmbH

  • Method Details

    • encodeFileHash

      String encodeFileHash(String volume, String path)
      Creates the hash for the given file system entry.
      Parameters:
      volume - The volume of the file system entry.
      path - The path of the file system entry.
      Returns:
      Hash for the given volume and path.

    • encodeFileHash

      default String encodeFileHash(ElfinderFileHash hash)
      Creates the hash for the given file system entry.
      Parameters:
      hash - The volume and path of the file system entry.
      Returns:
      Hash for the given volume and path.