How do I use filesystem functions in PHP, using UTF-8 strings?

by

Just urlencode the string desired as a filename. All characters returned from urlencode are valid in filenames (NTFS/HFS/UNIX), then you can just urldecode the filenames back to UTF-8 (or whatever encoding they were in).

Caveats (all apply to the solutions below as well):

  • After url-encoding, the filename must be less that 255 characters (probably bytes).
  • UTF-8 has multiple representations for many characters (using combining characters). If you don’t normalize your UTF-8, you may have trouble searching with glob or reopening an individual file.
  • You can’t rely on scandir or similar functions for alpha-sorting. You must urldecode the filenames then use a sorting algorithm aware of UTF-8 (and collations).

Worse Solutions

The following are less attractive solutions, more complicated and with more caveats.

On Windows, the PHP filesystem wrapper expects and returns ISO-8859-1 strings for file/directory names. This gives you two choices:

  1. Use UTF-8 freely in your filenames, but understand that non-ASCII characters will appear incorrect outside PHP. A non-ASCII UTF-8 char will be stored as multiple single ISO-8859-1 characters. E.g. ó will be appear as ó in Windows Explorer.

  2. Limit your file/directory names to characters representable in ISO-8859-1. In practice, you’ll pass your UTF-8 strings through utf8_decode before using them in filesystem functions, and pass the entries scandir gives you through utf8_encode to get the original filenames in UTF-8.

Caveats galore!

  • If any byte passed to a filesystem function matches an invalid Windows filesystem character in ISO-8859-1, you’re out of luck.
  • Windows may use an encoding other than ISO-8859-1 in non-English locales. I’d guess it will usually be one of ISO-8859-#, but this means you’ll need to use mb_convert_encoding instead of utf8_decode.

This nightmare is why you should probably just transliterate to create filenames.

More Related Contents:

  1. How to delete a folder with contents using PHP [duplicate]
  2. Loop code for each file in a directory [duplicate]
  3. Get the hierarchy of a directory with PHP
  4. Reference: Why are my “special” Unicode characters encoded weird using json_encode?
  5. PHP DOMDocument loadHTML not encoding UTF-8 correctly
  6. SET NAMES utf8 in MySQL?
  7. Getting the names of all files in a directory with PHP
  8. preg_match and UTF-8 in PHP
  9. PHP: Replace umlauts with closest 7-bit ASCII equivalent in an UTF-8 string
  10. How do I find the mime-type of a file with php?
  11. How to avoid echoing character 65279 in php?
  12. Convert latin1 characters on a UTF8 table into UTF8
  13. PHP DOMDocument failing to handle utf-8 characters (☆)
  14. php creating zips without path to files inside the zip
  15. UTF-8 to Unicode Code Points
  16. Convert ASCII TO UTF-8 Encoding
  17. PHP replacing special characters like à->a, è->e
  18. Trim unicode whitespace in PHP 5.2
  19. PHP recursive directory path
  20. dompdf character encoding UTF-8
  21. Is “SET CHARACTER SET utf8” necessary?
  22. How to handle user input of invalid UTF-8 characters
  23. PHP: using DOMDocument whenever I try to write UTF-8 it writes the hexadecimal notation of it
  24. TCPDF UTF-8 symbols not showing up
  25. php regex word boundary matching in utf-8
  26. Multi-byte safe wordwrap() function for UTF-8
  27. MongoDB PHP UTF-8 problems
  28. How to convert all characters to their html entity equivalent using PHP
  29. UTF8 Filenames in PHP and Different Unicode Encodings
  30. How to keep json_encode() from dropping strings with invalid characters

Leave a Comment