PHP Coupé

Aprendendo

Classes

Coupe_File

Funções diversas para manipulação de arquivos.

Listando

List Files

Pega a lista de arquivos de um diretório e retorna no formato de um array.

Recebe: ($string=caminho_diretorio)
Retorna: ARRAY (lista de arquivos) ou FALSE (diretorio nao existe)

...
$Coupe->import('Coupe_File');
$lista = $Coupe->Coupe_File->listFiles('caminho/do/diretorio');
...

List per Extension

Utiliza a função 'listFiles' para listar apenas arquivos especificados pela extensão.

Recebe: ($string=caminho_diretorio, $array=lista_de_extensoes)
Retorna: ARRAY (lista de arquivos) ou FALSE (diretorio nao existe)

...
$Coupe->import('Coupe_File');
$lista = $Coupe->Coupe_File->listPerExtension('caminho/do/diretorio', array('.jpg', '.png', '.gif'));
...

Informações

Size

Pega o tamanho do arquivo especificado.

Recebe: ($string=caminho_arquivo)
Retorna: STRING (tamanho do arquivo em uma unidade)

...
$Coupe->import('Coupe_File');
return $Coupe->Coupe_File->size('caminho/do/arquivo.jpg');
...

Get Extension

Retorna a extensão do arquivo indicado.

Recebe: ($string=caminho_arquivo)
Retorna: STRING (nome da extensao)

...
$Coupe->import('Coupe_File');
$nomearquivo = 'meu_arquivo.doc';
// retorna '.doc'
return $Coupe->Coupe_File->getExtension($nomearquivo);
...

Validando

Check File

Verifica se um arquivo existe de acordo com seu caminho.

Recebe: ($string=caminho_arquivo, [$bool=remover_extensao?])
Retorna: STRING (se encontrado, retorna o nome do arquivo) ou FALSE (caso não encontrado)

...
$Coupe->import('Coupe_File');
// se encontrado, retorna 'meu_arquivo.doc'
return $Coupe->Coupe_File->checkFile('caminho/meu_arquivo.doc');
...

Check Dir

Verifica se um diretório existe de acordo com seu caminho.

Recebe: ($string=caminho_diretorio)
Retorna: STRING (se encontrado, retorna o caminho do diretório) ou FALSE (caso nao encontrado)

...
$Coupe->import('Coupe_File');
// se encontrado, retorna 'caminho/do/diretorio'
return $Coupe->Coupe_File->checkDir('caminho/do/diretorio');
...

Check Type

Verifica se o caminho passado é um arquivo ou diretório.

Recebe: ($string=caminho)
Retorna: STRING ('f' se for um arquivo, 'd' se for um diretorio) ou FALSE (caso nao encontrado)

...
$Coupe->import('Coupe_File');
// retonarah 'd' por que o caminho eh um diretorio
return $Coupe->Coupe_File->checkType('caminho/do/diretorio');
...

Manipulando

Remove Extension

Remove a extensão do nome de um arquivo buscando a última ocorrência de '.'.
Pode-se indicar a extensão como parâmetro para remover ela do arquivo.

Recebe: ($string=caminho_arquivo, [$string=extensao])
Retorna: STRING (nome do arquivo sem extensao)

...
$Coupe->import('Coupe_File');
$nomearquivo = 'meu_arquivo.doc';
// retorna 'meu_arquivo'
return $Coupe->Coupe_File->removeExtension($nomearquivo);
...

Read

Lê o conteúdo de um arquivo especificado.

Recebe: ($string=caminho_arquivo)
Retorna: STRING (conteudo do arquivo)

...
$Coupe->import('Coupe_File');
return $Coupe->Coupe_File->read('caminho/meu_arquivo.doc');
...

Write

Cria um arquivo qualquer no caminho escolhido e grava o conteúdo nele.
Caso o arquivo já exista, ele será substituido. Por tanto, é recomendável ler primeiro seu conteúdo, acrescentar novas informações, e então reescrevê-lo.

Recebe: ($string=conteudo, $string=caminho_arquivo)
Retorna: STRING (caminho do arquivo criado) ou FALSE (em caso de erro)

...
$Coupe->import('Coupe_File');
$conteudo = 'Meu novo arquivo';
return $Coupe->Coupe_File->write($conteudo, 'caminho/meu_arquivo.txt');
...

Delete

Deleta arquivos e diretorios indicados no parâmetro passado.
Caso o segundo parametro seja TRUE, as subpastas serão deletadas.
Juntamente, se terceiro parametro for 1, a pasta indicada no caminho tambem é deletada.

Recebe: ($string=caminho, [$bool=deletar_pastas], [$int=0|1])
Retorna: VOID

...
$Coupe->import('Coupe_File');
return $Coupe->Coupe_File->delete('caminho/do/diretorio');
...