Introduction

CopixFile est une classe qui permet la lecture et l’écriture de contenus.

Son principal rôle est bien sûr d’écrire des fichiers, sans avoir à se soucier des concurrences d’accès.

Cette classe ne gère pas les problématiques de modification (c’est un remplacement de contenu qui est effectué).

read ($filePath)

Lit le contenu du fichier $filePath ($filePath est le chemin du fichier sur le serveur). read () retourne "false" en cas d’échec de lecture.

Exemple

$objectReader = new CopixFile ();
if (($content = $objectReader->read ($filePath)) !== false){
   $tpl->assign ('texte', $content);
}else{
   $tpl->assign ('texte', CopixI18N::get ('error.cannotReadFile'));
}

write ($filePath, $content)

Cette méthode va créer ou remplacer le fichier $filePath ($filePath est le chemin du fichier sur le serveur) et y placer le contenu $content (de type chaîne de caractères). Cette méthode est sûre, il n’existe pas de risque de concurrence d’accès.

Note : Sous un système de type Windows, la concurrence d’accès n’est pas assurée du fait que le système n’est pas capable de prendre en charge le "remplacement d’un fichier" (élément technique mis en oeuvre dans la méthode write). Toutefois, le risque est particulièrement minime de voir échouer un remplacement. Sous unix/linux, cette manipulation est parfaitement sûre.

Cette méthode est capable de créer le chemin menant à $filePath si ce dernier n’existe pas.

Exemple

$objectWriter = new CopixFile ();
return $objectWriter->write ($fileName, 'Contenu du fichier');

createDir ($chemin)

La méthode createDir permet de créer un répertoire dont le chemin est $chemin.

Si les sous chemins n'existent pas, ils seront crées.

La méthode retourne vrai ou faux selon la réussite de la création de l'arborescence.

search ($pPattern, $pPath, $pRecursiveSearch = true)

La méthode search permet de rechercher un ou plusieurs fichiers qui respectent le pattern de recherche $pPattern dans une arborescence qui commence dans le chemin $pPath.

Le dernier paramètre indique si vous souhaitez étendre votre recherche dans les sous répertoires (par défaut vrai).

La méthode vous retourne un tableau de chaines de caractères qui représentent l'ensemble des fichiers trouvés qui correspondent à la recherche.

trailingSlash ($pPath)

Cette méthode retourne $pPath en s'assurant que la chaine se termine par un slash.

removeDir ($pDirectory, $pStopOnFailure = false)

Cette méthode supprime le répertoire $pDirectory et ses sous répertoires. Elle retourne vrai en cas de succès et un tableau de noms de fichiers qu'il à été impossible de supprimer en cas d'échec.

Si vous spécifiez $pStopOnFailure, alors la supression sera interrompue au premier échec de suppression.

Si $pDirectory se termine par un slash "/", seul le contenu du répertoire est supprimé. Si $pDirectory ne se termine par un slash "/", le répertoire lui même est également supprimé.

removeFileFromPath ($pDirectory, $pStopOnFailure = false)

Cette méthode supprime l'ensemble des fichiers (et non les répertoires) qui sont contenus dans le répertoire $pDirectory et ses sous répertoires.

Elle retourne vrai en cas de succès et un tableau de noms de fichiers qu'il à été impossible de supprimer en cas d'échec.

Si vous spécifiez $pStopOnFailure, alors la supression sera interrompue au premier échec de suppression.

extractFileName ($pPath)

Extrait le nom du fichier du chemin passé en paramètre.

extractFilePath ($pPath)

Extrait le chemin (sans le nom du fichier) du chemin passé en paramètre.

extractFileExt ($pPath)

Extrait l'extension du fichier du chemin passé en paramètre.

getIcon ($pFilePath)

Récupère le chemin de l'icône (pour être passé à la fonction CopixUrl::getResource ()) correspondant au type de fichier. Cette correspondance est basée sur l'extension du fichier et n'est pas exhaustive.

Cette fonction est disponible depuis Copix 3.0.3+