Jet\IO_Dir
Důležitý rozdíl oproti běžnému použití samotných PHP funkcí je ten, že při selhání operace je vždy vyhozena výjimka Jet\IO_Dir_Exception.
Používá nastavení Jet\SysConf_Jet_IO::setDirMod() pro výchozí práva adresářů.
Přehled metod
Metoda | Význam | public static exists( string $dir_path ): bool |
Indikuje zda adresář existuje (a jedná se o adresář). |
---|---|
public static isReadable( string $dir_path ): bool |
Indikuje zda je adresář přístupný - čitelný. |
public static isWritable( string $dir_path ): bool |
Indikuje zda je do adresáře možné zapisovat. |
public static rename( string $source_path, string $target_path, bool $overwrite_if_exists = true ): void |
Přejmenuje / přesune adresář a to včetně obsahu (souborů a podadresářů). Pokud je parametr $overwrite_if_exists = true a adresář na cílovém místě již existuje, pak je tento nejprve smazán a pak je nahrazen adresářem zdrojovým. Pokud je parametr $overwrite_if_exists = false a adresář na cílovém místě již existuje, pak je vyhozena výjimka. V případě neúspěchu vyhazuje výjimku. |
public static move( string $source_path, string $target_path, bool $overwrite_if_exists = true ): void |
Alias pro metodu rename. |
public static copy( string $source_path, string $target_path, bool $overwrite_if_exists = true ): void |
Kopíruje adresář a to včetně obsahu (souborů a podadresářů). Pokud je parametr $overwrite_if_exists = true a adresář na cílovém místě již existuje, pak je tento nejprve smazán a pak je nahrazen adresářem zdrojovým. Pokud je parametr $overwrite_if_exists = false a adresář na cílovém místě již existuje, pak je vyhozena výjimka. V případě neúspěchu vyhazuje výjimku. |
public static create( string $dir_path, bool $overwrite_if_exists = false ): void |
Vytvoří adresář a nastaví jeho práva. Operuje rekurzivně. Tedy v případě neexistence vytvoří i nadřazené adresáře (rovněž včetně nastavení výchozích práv). V případě neúspěchu vyhazuje výjimku. |
public static remove( string $dir_path ): void |
Smaže adresář a to včetně veškerého obsahu. V případě neúspěchu vyhazuje výjimku. |
public static getList( string $dir_path, string $mask = '*', bool $get_dirs = true, bool $get_files = true ): array |
Podle dané masky (parametr $mask - smysl stejný jako v OS) vrátí obsah (seznam souborů a podadresářů) daného adresáře. Je možné určit zda v seznamu chcete / nechcete adresáře (parametr $get_dirs) a soubory (parametr $get_files). Seznam je vrácen v podobě asociovaného pole, kde klíčem je plná cesta a hodnotou název (souboru / adresáře). V případě neúspěchu vyhazuje výjimku. |
public static getFilesList( string $dir_path, string $mask = '*' ): array |
Podle dané masky (parametr $mask - smysl stejný jako v OS) vrátí seznam souborů v daném adresáři. Seznam je vrácen v podobě asociovaného pole, kde klíčem je plná cesta a hodnotou název (souboru / adresáře). V případě neúspěchu vyhazuje výjimku. |
public static getSubdirectoriesList( string $dir_path, string $mask = '*' ): array |
Podle dané masky (parametr $mask - smysl stejný jako v OS) vrátí seznam podadresářů v daném adresáři. Seznam je vrácen v podobě asociovaného pole, kde klíčem je plná cesta a hodnotou název (souboru / adresáře). V případě neúspěchu vyhazuje výjimku. |