Class File

[Строка 14]

Размещен: /Kernel/File.class.php




Описание


Система управления сайтом HostCMS v. 5.xx


Copyright © 2005-2010 ООО "Хостмэйк" (Hostmake LLC), http://www.hostcms.ru
Ядро, класс для работы с файлами.
Файл: /modules/Kernel/File.class.php

	
author

		
Hostmake LLC

	
version

		
5.x






Свойства класса








Константы класса



    
	






Унаследованные константы класса







Унаследованные свойства класса








Методы
 


    
		
		
  • File __construct()
		
    
		
		
  • boolean CopyDir()
		
    Копирование директории
		
		
  • boolean DeleteDir()
		
    Метод удаления директории вместе с вложенными файлами и директориями.
		
		
  • boolean DeleteFile()
		
    Удаление файла с проверкой на его существованием
		
		
  • boolean Download()
		
    Метод возвращает содержимое файла в поток вместе с заголовком в соответствии с типом файла
		
		
  • void flush()
		
    
		
		
  • void GetChmodFile()
		
    Получение прав доступа к создаваемым объектом файлов
		
		
  • string GetFileContent()
		
    Получение содержимого файла
		
		
  • string get_file_perms()
		
    Получение строки прав доступа к файлу
		
		
  • string PathCorrection()
		
    Метод удаляет потенциально опасные символы из пути или имени файла
		
		
  • boolean SaveToFile()
		
    Сохранение содержимого $content в файл с путем $filepath
		
		
  • void SetChmodFile()
		
    Установка прав доступа к создаваемых объектом файлов
	





Унаследованные методы
 







Описания методов



    



    File::__construct
    


    
__construct(
 );

    



		
    [ Наверх ]
    

    



    File::CopyDir
    


    
CopyDir(
string
$source, string
$target );

    




    Описание
    

    Копирование директории
    
		
    Принимаемые параметры
    
			
    $source
    
		
    директория источник
    
			
    $target
    
		
    target директория получатель
    
			
    [ Наверх ]
    

    



    File::DeleteDir
    


    
DeleteDir(
string
$dir, [boolean
$delete_self = true] );

    




    Описание
    

    Метод удаления директории вместе с вложенными файлами и директориями.
    

    При указании $delete_self в true удаляет переданную дерикторию тоже.
    
		
    Принимаемые параметры
    
			
    $dir
    
		
    абсолютный путь к директории
    
			
    $delete_self
    
		
    необязательный флаг удаления переданной директории, по умолчанию true  
    1.  <?php
      2. 

    2.  $File = new File();
      3. 

    3.  
      4. 

    4.  $dir = CMS_FOLDER . 'dir';
      5. 

    5.  
      6. 

    6.  $File->DeleteDir($dir, true);
      7. 

    7.  
      8. 

    8.  ?>
      9. 

    
			
    [ Наверх ]
    

    



    File::DeleteFile
    


    
DeleteFile(
string
$filepath );

    




    Описание
    

    Удаление файла с проверкой на его существованием
    
		
    Принимаемые параметры
    
			
    $filepath
    
		
    путь к файлу  
    1.  <?php
      2. 

    2.  $File = new File();
      3. 

    3.  
      4. 

    4.  $filepath = CMS_FOLDER . 'dir/myfile.txt';
      5. 

    5.  
      6. 

    6.  $File->DeleteFile($filepath);
      7. 

    7.  
      8. 

    8.  ?>
      9. 

    
			
    [ Наверх ]
    

    



    File::Download
    


    
Download(
string
$file, string
$filename, [array
$param = array()] );

    




    Описание
    

    Метод возвращает содержимое файла в поток вместе с заголовком в соответствии с типом файла
    
		
    Принимаемые параметры
    
			
    $file
    
		
    абсолютный путь к файлу
    
			
    $filename
    
		
    имя файла
    
			
    $param
    
		
    массив дополнительных параметров 
    • $param['content_disposition'] заголовок, определяющий вывод файла (inline - открывается в браузере (по умолчанию), attachment - скачивается)
 
      1.  <?php
        2. 

      2.  $File = new File();
        3. 

      3.  
        4. 

      4.  $file = CMS_FOLDER . 'file.dat';
        5. 

      5.  $filename = 'Пользовательское_имя_файла.dat';
        6. 

      6.  
        7. 

      7.  $File->Download($file, $filename);
        8. 

      8.  
        9. 

      9.  exit();
        10. 

      10.  ?>
        11. 

    
			
    [ Наверх ]
    

    



    File::flush
    


    
flush(
 );

    



		
    [ Наверх ]
    

    



    File::GetChmodFile
    


    
GetChmodFile(
 );

    




    Описание
    

    Получение прав доступа к создаваемым объектом файлов
    
		
    [ Наверх ]
    

    



    File::GetFileContent
    


    
GetFileContent(
string
$filename );

    




    Описание
    

    Получение содержимого файла
    
		
    Принимаемые параметры
    
			
    $filename
    
		
    абсолютный путь к файлу  
    1.  <?php
      2. 

    2.  $File = new File();
      3. 

    3.  
      4. 

    4.  $filename = 'file.txt';
      5. 

    5.  
      6. 

    6.  $contents = $File->GetFileContent($filename);
      7. 

    7.  
      8. 

    8.  // Распечатаем результат
      9. 

    9.  echo $contents;
      10. 

    10.  ?>
      11. 

    
			
    Возвращает
    
		
    содержимое файла, если такой файл существует или false, если файл не существует или его невозможно прочитать
    
	
    [ Наверх ]
    

    



    File::get_file_perms
    


    
get_file_perms(
string
$filename, int
$type );

    




    Описание
    

    Получение строки прав доступа к файлу
    
		
    Принимаемые параметры
    
			
    $filename
    
		
    имя файла
    
			
    $type
    
		
    тип строки (0 - "-rw-rw-rw-"; 1 - "0755")  
    1.  <?php
      2. 

    2.  $File = new File();
      3. 

    3.  
      4. 

    4.  $filename = 'index.php';
      5. 

    5.  $type = 1;
      6. 

    6.  
      7. 

    7.  $newstr = $File->get_file_perms($filename, $type);
      8. 

    8.  
      9. 

    9.  // Распечатаем результат
      10. 

    10.  echo $newstr;
      11. 

    11.  ?>
      12. 

    
			
    Возвращает
    
		
    строка прав доступа к файлу
    
	
    [ Наверх ]
    

    



    File::PathCorrection
    


    
PathCorrection(
string
$path );

    




    Описание
    

    Метод удаляет потенциально опасные символы из пути или имени файла
    
		
    Принимаемые параметры
    
			
    $path
    
		
    путь  
    1.  <?php
      2. 

    2.  $File = new File();
      3. 

    3.  
      4. 

    4.  $path = CMS_FOLDER . 'dir//subdir/../...//.//../file.txt';
      5. 

    5.  
      6. 

    6.  $newpath = $File->PathCorrection($path);
      7. 

    7.  
      8. 

    8.  // Распечатаем результат
      9. 

    9.  echo $newpath;
      10. 

    10.  ?>
      11. 

    
			
    Возвращает
    
		
    путь без потенциально опасных символов
    
	
    [ Наверх ]
    

    



    File::SaveToFile
    


    
SaveToFile(
string
$filepath, string
$content );

    




    Описание
    

    Сохранение содержимого $content в файл с путем $filepath
    
		
    Принимаемые параметры
    
			
    $filepath
    
		
    путь к файлу
    
			
    $content
    
		
    содержимое файла
    
			
    [ Наверх ]
    

    



    File::SetChmodFile
    


    
SetChmodFile(
int
$chmod_file );

    




    Описание
    

    Установка прав доступа к создаваемых объектом файлов
    
		
    Принимаемые параметры
    
			
    $chmod_file
    
		
    права доступа к создаваемых файлам, например, 0644
    
			
    [ Наверх ]
    

    









Описания переменных



    


  • $chmod_file =  null [Строка 16]
    • 

  • Data type: mixed
    • 


    









Описание констант класса