Joostina CMS / CMF v2.* API
  • Docs
  • Package
  • Class
  • Tree
  • Todo
Overview

Packages

  • Components
    • Acls
      • Models
        • Admin
        • Site
    • BlogCategory
      • Models
        • Admin
        • Site
    • Blogs
      • Controllers
        • Admin
        • Site
      • Helpers
      • Models
        • Admin
        • Site
    • Coder
      • Controllers
        • Admin
      • Models
        • Admin
    • Comments
      • Controllers
        • Admin
        • Site
      • Helpers
      • Models
        • Admin
        • Site
    • CommentsCounter
      • Models
        • Admin
        • Site
    • Mainpage
      • Controllers
        • Site
    • News
      • Controllers
        • Admin
        • Site
      • Helpers
      • Models
        • Admin
        • Site
    • Pages
      • Controllers
        • Admin
        • Site
      • Models
        • Site
    • Search
      • Controllers
        • Site
    • Site
      • Controllers
        • Admin
        • Site
    • Sitemap
      • Controllers
        • Admin
        • Site
      • Models
        • Admin
        • Site
    • Test
      • Controllers
        • Site
    • Torrents
      • Controllers
        • Site
    • Users
      • Controllers
        • Admin
        • Site
      • Models
        • Admin
        • Site
  • Compression
  • Core
    • Libraries
      • Arhive
      • Array
      • Attached
      • Autoadmin
      • Autoloader
      • Benchmark
      • Breadcrumbs
      • Cache
      • Config
      • Cookie
      • Csrf
      • Database
        • Drivers
          • Interfaces
      • Datetime
      • Debug
      • Editor
      • Events
      • File
      • Filter
      • Flashmessage
      • Folder
      • Hit
      • Html
      • Image
      • Inflector
      • Inputfilter
      • Libraries
      • Mail
      • Module
      • Nestedset
      • Pager
      • Pages
      • Params
      • Randomizer
      • Request
      • RobotLoader
      • Route
      • Security
      • Session
      • Static
      • String
      • Text
      • Trash
      • Validate
  • Email
  • Extra
    • Libraries
      • Basket
  • Joostina
    • Controller
    • Core
    • Document
  • JSMin
  • Libraries
    • Extra
      • Basket
        • Models
          • Site
  • None
  • Plugins
    • Autoadmin
    • Editor
    • Sitemap
  • SimpleMail
  • Vendors
    • Libraries
      • Email

Classes

  • joosFile

Class joosFile

Работа с файлами

Category: Libraries
Copyright: (C) 2007-2012 Joostina Team
License: License http://www.opensource.org/licenses/mit-license.php Информация об авторах и лицензиях стороннего кода в составе Joostina CMS: docs/copyrights
Author: Joostina Team <info@joostina.ru>
Version: 1.0
Todo: оценить необходимость использования clearstatcache
Located at: core/libraries/file.php

Methods summary

public static string|integer
# convert_size( string $num )

Логическое представление размера файлов, памяти и прочив байтовых данных

Логическое представление размера файлов, памяти и прочив байтовых данных

Parameters

$num
string
исходные строка или число для форматирования

Returns

string|integer

Tutorial

joosFile::convert_size(123);
joosFile::convert_size(123456);
public static mixed
# create( string $file_name, mixed $data )

Создание файла

Создание файла

Parameters

$file_name
string
Полный путь к файлу
$data
mixed
Содержимое файла

Returns

mixed
Результат создания (false при неудаче)

Tutorial

joosFile::create( JPATH_BASE . DS. 'create_file.php', $content );
public static boolean
# delete( string $file_name )

Удаление файла

Удаление файла

Parameters

$file_name
string
полный путь к файлу, либо массив полный путей к удаляемым файлам

Returns

boolean
результат удаления

Tutorial

joosFile::delete( JPATH_BASE . DS. '_to_delete.php' );
public static boolean
# exists( string $file_name )

Проверка существования файла

Проверка существования файла

Parameters

$file_name
string

Returns

boolean
результат проверки

Tutorial

joosFile::exists( JPATH_BASE . DS. 'index.php' );
public static string
# get_mime_content_type( string $file_name )

Получение MIME типа файла

Получение MIME типа файла

Parameters

$file_name
string

Returns

string

Tutorial

joosFile::get_mime_content_type( __FILE__ );
joosFile::get_mime_content_type( JPATH_BASE . DS . 'media' . DS . 'favicon.ico' );
joosFile::get_mime_content_type( JPATH_BASE . DS . 'media' . DS . 'js' . DS . 'jquery.js');
public static string
# get_mime_content_type_by_extension( string $file_name )

Получение MIME типа файла по расширению

Получение MIME типа файла по расширению

Parameters

$file_name
string

Returns

string

Tutorial

joosFile::get_mime_content_type_by_extension( __FILE__ );
joosFile::get_mime_content_type_by_extension( JPATH_BASE . DS . 'media' . DS . 'favicon.ico' );
joosFile::get_mime_content_type_by_extension( JPATH_BASE . DS . 'media' . DS . 'js' . DS . 'jquery.js');
public static string
# make_file_location( integer $id, $split_by = 3, $capacity = 9, $round = false )

Формирование вложенного пути к файлу с учетом разделения по каталогам

Формирование вложенного пути к файлу с учетом разделения по каталогам

Parameters

$id
integer
- номер файла в БД
$split_by
$capacity
$round

Returns

string
- путь к файлу в структуре подкаталогов

Tutorial

joosFile::make_file_location( 1 );
joosFile::make_file_location( 123 );
joosFile::make_file_location( 123456789123456789 );

Todo

задокументировать новые параметры
public static array
# file_info( string $file_name )

Получение полной информации о файле

Получение полной информации о файле

Parameters

$file_name
string
абсолюютный или относительный путь до файла

Returns

array
массив информации о файле mime - mime тип файла size - размер файла в байтах ext - расширение файла name - имя файла с расширением

Tutorial

joosFile::file_info( __FILE__ );
joosFile::file_info( JPATH_BASE . DS. 'index.php' );
joosFile::file_info( 'index.html' );

Todo

переделать на SplFileInfo
public static type
# make_safe_name( type $file_name )

Преобразование имени файла к безопасному для файлвоой системы виду Из строки удаляются все спецсимволы, кирилические символы транслитерируются

Преобразование имени файла к безопасному для файлвоой системы виду Из строки удаляются все спецсимволы, кирилические символы транслитерируются

Parameters

$file_name
type

Returns

type

Tutorial

joosFile::get_safe_name('имя файла номер 1 - ( раз)');
joosFile::get_safe_name(' eminem feat dr.dre i need a doctor.mp3 ');
public static boolean
# get_modified_date( string $file_name )

Получение даты последнего изменения файла

Получение даты последнего изменения файла

Parameters

$file_name
string
абсолюютный или относительный путь до файла

Returns

boolean

Throws

joosFileLibrariesException
public static type
# get_size( string $file_name )

Получение размера файла ( в байта )

Получение размера файла ( в байта )

Parameters

$file_name
string
абсолюютный или относительный путь до файла

Returns

type

Throws

joosFileLibrariesException
public static type
# get_type( string $file_name )

Получение типа файла

Получение типа файла

Parameters

$file_name
string
абсолюютный или относительный путь до файла

Returns

type

Throws

joosFileLibrariesException
public static type
# put_content( string $file_name, string $data )

Записи данных в файл

Записи данных в файл

Parameters

$file_name
string
абсолюютный или относительный путь до файла
$data
string
данные для записи в файл

Returns

type

Throws

joosFileLibrariesException
public static type
# get_content( string $file_name )

Получение содержимого файла

Получение содержимого файла

Parameters

$file_name
string
абсолюютный или относительный путь до файла

Returns

type

Throws

joosFileLibrariesException
public static boolean
# is_writable( string $file_location )

Проверка прав доступа на запись в файл

Проверка прав доступа на запись в файл

Parameters

$file_location
string
полный путь к каталогу

Returns

boolean
результат проверки доступа на запись в указанный каталог
public static boolean
# is_readable( string $file_location )

Проверка прав доступа на чтение файла

Проверка прав доступа на чтение файла

Parameters

$file_location
string
полный путь к каталогу

Returns

boolean
результат проверки доступа на запись в указанный каталог
Joostina CMS / CMF v2.* API API documentation generated by ApiGen 2.6.1 – Template adapted by @olvlv and Joostina Team