file
Класс для работы с файлами
Методы
| mixed |
close () |
Закрывает файл |
| mixed |
convertCSVToExcelCSV ({ [fileName] }) |
Конвертирует файл csv в csv поддерживаемый ms excel |
| mixed |
drop ({ [fileName] }) |
Удаляет файл(ы). |
| mixed |
getCSVAsArray ({ [separator] }) |
Читает содержимое файла csv и конвертирует его в массив. |
| object |
getNew () |
Возвращает новую копию класса |
| mixed |
isExist ({ [fileName] }) |
Проверяет существование файла |
| mixed |
open ({ [fileName], [flag] }) |
Открывает файл |
| mixed |
putcsv ({ fields, [delimiter], [enclosure] }) |
Форматирует строку в виде CSV и записывает её в файл |
| mixed |
read () |
Читает содержимое файла |
| mixed |
sendToDownload ({ [fileName] }) |
Ооправялет файл на скачивание |
| mixed |
unlink ({ [fileName] }) |
Удаляет файл |
| mixed |
write ({ content }) |
Пишет контент в файл |
close
Закрывает файл
Возвращаемые значения
| string |
Успех |
| bool |
False - в случае ошибки |
convertCSVToExcelCSV
Конвертирует файл csv в csv поддерживаемый ms excel
Параметры
| [fileName] |
string |
Имя файла который нужно конвертировать |
Возвращаемые значения
| bool |
True - успех |
| bool |
False - в случае ошибки |
drop
Удаляет файл(ы).
Параметры
| [fileName] |
string |
Имя файла или директории |
Возвращаемые значения
| bool |
True - если удалено |
| bool |
False - если директории/файла не сущесвтует или в случае ошибки |
getCSVAsArray
Синоним: cSVAsArray
Читает содержимое файла csv и конвертирует его в массив.
Параметры
| [separator] |
string |
Разделитель поля в файле csv. По умолчанию: "," |
Возвращаемые значения
| array |
Массив разобранных данных из файла csv. Каждая строка отдельный элемент массива, где индексы колонок: 0 - перая, 1 - вторая и т.д. |
| bool |
False - в случае ошибки |
getNew
Синоним: new
Возвращает новую копию класса
isExist
Проверяет существование файла
Параметры
| [fileName] |
string |
Имя файла, включая путь. Допустимые символы в пути: a-z, 0-9, "_", /. Допустимые символы в имени файла: a-z, 0-9, -, " ", . |
Возвращаемые значения
| bool |
True - если существует |
| bool |
False - если не существует или в случае ошибки |
open
Открывает файл
Параметры
| [fileName] |
string |
Имя файла, включая путь. Допустимые символы в пути: a-z, 0-9, "_", /. Допустимые символы в имени файла: a-z, 0-9, -, " ", . |
| [flag] |
string |
Флаг операции. r - открывает файл для чтения. Помещает указатель в начало файла; a - открывает файл для чтения и записи. Помещает указатель в конец файла. Если файл не существует - пытается его создать; w - открывает файл для чтения и записи. Помещает указатель в начало файла и обрезает файл до нулевой длины. Если файл не существует - пытается его создать. По умолчанию: w |
Возвращаемые значения
| bool |
True - файл успешно открыт/создан |
| bool |
False - в случае ошибки |
putcsv
Форматирует строку в виде CSV и записывает её в файл
Параметры
| fields |
array |
Массив значений. Формат: [ "Значение 1", ... "Значение N" ] |
| [delimiter] |
string |
Устанавливает разделитель полей. По умолчанию: "," |
| [enclosure] |
string |
Устанавливает ограничитель полей. По умолчанию: '"' |
Возвращаемые значения
| bool |
True - успех |
| bool |
False - в случае ошибки |
read
Читает содержимое файла
Возвращаемые значения
| string |
Содержимое файла |
| bool |
False - в случае ошибки |
sendToDownload
Ооправялет файл на скачивание
Параметры
| [fileName] |
string |
Имя файла |
Возвращаемые значения
| bool |
True - если удалено |
| bool |
False - в случае ошибки |
unlink
Удаляет файл
Параметры
| [fileName] |
string |
Имя файла, включая путь. Допустимые символы в пути: a-z, 0-9, "_", /. Допустимые символы в имени файла: a-z, 0-9, -, " ", . |
Возвращаемые значения
| bool |
True - если удалено |
| bool |
False - в случае ошибки |
write
Пишет контент в файл
Параметры
| content |
string |
Содержимое файла |
Возвращаемые значения
| bool |
True - успех |
| bool |
False - в случае ошибки |