Class Cache

[Строка 23]

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




Описание


Класс модуля "Кэш"






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



    
		
		
  • $cache_dir_is_exist =  false
		
    
		Флаг наличия директории для сохранения файлов кэша
		
		
  • $cache_systems = array()
		
    
		Массив доступных способов кэширования
		
		
  • $default_cache_systems =  'file'
		
    
		Способ кэширования по умолчанию
		
		
  • $dividend =  100
		
    
		Максимальное значение, генерируемое для определения необходимости удаления истекших элементов кэша
		
		
  • $is_dir_array = array()
		
    
		Кэш существующих директорий
		
		
  • $probability =  1
		
    
		Вероятность удаления истекших элементов кэша
		
		
  • $read_lock =  false
		
    
		Блокировать ли файл кэша при чтении. по умолчанию false
		
		
  • $use_read_control =  true
		
    
		Использовать контроль данных с помощью crc32
	






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



    
	






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







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








Методы
 






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







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



    



    Cache::Cache
    


    
Cache(
 );

    




    Описание
    

    Конструктор
    
		
    [ Наверх ]
    

    



    Cache::AdminMainPage
    


    
AdminMainPage(
 );

    




    Описание
    

    Функция обратного вызова для отображения блока  на основной странице центра администрирования.
    
		
    [ Наверх ]
    

    



    Cache::CallProbability
    


    
CallProbability(
 );

    




    Описание
    

    Определяет необходимости удаления истекших элементов кэша
    
		
    [ Наверх ]
    

    



    Cache::ClearAllCache
    


    
ClearAllCache(
 );

    




    Описание
    

    Очистка всех кэшей (не очищая кэш статичных файлов)
    

    1.  <?php
      2. 

    2.  $Cache = & singleton('Cache');
      3. 

    3.  
      4. 

    4.  $result = $Cache->ClearAllCache();
      5. 

    5.  
      6. 

    6.  if ($result)
      7. 

    7.  {
      8. 

    8.      echo "Очистка выполнена успешно";
      9. 

    9.  }
      10. 

    10.  else
      11. 

    11.  {
      12. 

    12.      echo "Ошибка очистки кэшей";
      13. 

    13.  }
      14. 

    14.  ?>
      15. 

    
		
    [ Наверх ]
    

    



    Cache::ClearCache
    


    
ClearCache(
string
$cache_name );

    




    Описание
    

    Очистка кэша
    
		
    Принимаемые параметры
    
			
    $cache_name
    
		
    имя кэша  
    1.  <?php
      2. 

    2.  $Cache = & singleton('Cache');
      3. 

    3.  
      4. 

    4.  // Для кэширования различных элементов используются различные кэши. Список кэшей задается в настройках модуля "Кэширование"
      5. 

    5.  $cache_name = "TMP";
      6. 

    6.  
      7. 

    7.  $result = $Cache->ClearCache($cache_name);
      8. 

    8.  
      9. 

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

    10.  echo $result;
      11. 

    11.  ?>
      12. 

    
			
    [ Наверх ]
    

    



    Cache::ClearExpireItems
    


    
ClearExpireItems(
string
$cache_name );

    




    Описание
    

    Удаление истекших элементов кэша
    
		
    Принимаемые параметры
    
			
    $cache_name
    
		
    имя кэша  
    1.  <?php
      2. 

    2.  $Cache = & singleton('Cache');
      3. 

    3.  
      4. 

    4.  // Для кэширования различных элементов используются различные кэши. Список кэшей задается в настройках модуля "Кэширование"
      5. 

    5.  $cache_name = "TMP";
      6. 

    6.  
      7. 

    7.  $result = $Cache->ClearExpireItems($cache_name);
      8. 

    8.  
      9. 

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

    10.  echo $result;
      11. 

    11.  ?>
      12. 

    
			
    [ Наверх ]
    

    



    Cache::ClearStaticCache
    


    
ClearStaticCache(
mixed
$site_id );

    




    Описание
    

    Очистка кэша в статичных файлах
    
		
    Принимаемые параметры
    
			
    $site_id
    
		
    идентифкатор сайта или false, если для всех сайтов  
    1.  <?php
      2. 

    2.  $Cache = & singleton('Cache');
      3. 

    3.  
      4. 

    4.  $site_id = CURRENT_SITE;
      5. 

    5.  
      6. 

    6.  $result = $Cache->ClearStaticCache($site_id);
      7. 

    7.  
      8. 

    8.  if ($result)
      9. 

    9.  {
      10. 

    10.      echo "Очистка выполнена успешно";
      11. 

    11.  }
      12. 

    12.  else
      13. 

    13.  {
      14. 

    14.      echo "Ошибка очистки кэша";
      15. 

    15.  }
      16. 

    16.  ?>
      17. 

    
			
    [ Наверх ]
    

    



    Cache::DeleteCacheItem
    


    
DeleteCacheItem(
string
$cache_name, string
$item_name );

    




    Описание
    

    Метод удаляет элемент с именем $item_name из кэша $cache_name
    
		
    Принимаемые параметры
    
			
    $cache_name
    
		
    название кэша
    
			
    $item_name
    
		
    название элемента в кэше  
    1.  <?php
      2. 

    2.  $Cache = & singleton('Cache');
      3. 

    3.  
      4. 

    4.  // Имя элемента, наиболее часто используется идентификатор или строка идентификаторов
      5. 

    5.  $item_name = 'my_item_1';
      6. 

    6.  
      7. 

    7.  // Для кэширования различных элементов используются различные кэши. Список кэшей задается в настройках модуля "Кэширование"
      8. 

    8.  $cache_name = "TMP";
      9. 

    9.  
      10. 

    10.  $Cache->DeleteCacheItem($cache_name, $item_name);
      11. 

    11.  
      12. 

    12.  if ($result)
      13. 

    13.  {
      14. 

    14.      echo "Удаление выполнена успешно";
      15. 

    15.  }
      16. 

    16.  else
      17. 

    17.  {
      18. 

    18.      echo "Ошибка удаления";
      19. 

    19.  }
      20. 

    20.  ?>
      21. 

    
			
    [ Наверх ]
    

    



    Cache::DisableModule
    


    
DisableModule(
 );

    




    Описание
    

    Служебный метод, вызываемый при отключении модуля.
    

    Осуществляет очистку кэша.
    
		
    [ Наверх ]
    

    



    Cache::eacceleratorClearCache
    


    
eacceleratorClearCache(
[string
$cache_name = false], [string
$item_name = false] );

    




    Описание
    

    Очистка кэша $cache_name и элемента $item_name в eAccelerator
    
		
    Принимаемые параметры
    
			
    $cache_name
    
		
    имя кэша, если не передан - очищается полностью кэш
    
			
    $item_name
    
		
    имя элемента в кэше, если не передан - очищается элемент кэша $cache_name с именем $item_name
    
			
    [ Наверх ]
    

    



    Cache::eacceleratorGetCountItem
    


    
eacceleratorGetCountItem(
string
$cache_name );

    




    Описание
    

    Определение количества элементов в кэше для eaccelerator
    
		
    Принимаемые параметры
    
			
    $cache_name
    
		
    имя кэша  
    1.  <?php
      2. 

    2.  $Cache = & singleton('Cache');
      3. 

    3.  
      4. 

    4.  // Для кэширования различных элементов используются различные кэши. Список кэшей задается в настройках модуля "Кэширование"
      5. 

    5.  $cache_name = "TMP";
      6. 

    6.  
      7. 

    7.  $count_item = $Cache->eacceleratorGetCountItem($cache_name);
      8. 

    8.  
      9. 

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

    10.  echo $count_item;
      11. 

    11.  ?>
      12. 

    
			
    Возвращает
    
		
    количество элементов в кэше
    
	
    [ Наверх ]
    

    



    Cache::FileClearCache
    


    
FileClearCache(
string
$cache_name );

    




    Описание
    

    Очистка кэша в файле
    
		
    Принимаемые параметры
    
			
    $cache_name
    
		
    имя кэша  
    1.  <?php
      2. 

    2.  $Cache = & singleton('Cache');
      3. 

    3.  
      4. 

    4.  // Для кэширования различных элементов используются различные кэши. Список кэшей задается в настройках модуля "Кэширование"
      5. 

    5.  $cache_name = "TMP";
      6. 

    6.  
      7. 

    7.  $result = $Cache->ClearCache($cache_name);
      8. 

    8.  
      9. 

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

    10.  echo $result;
      11. 

    11.  ?>
      12. 

    
			
    [ Наверх ]
    

    



    Cache::FileDeleteCacheItem
    


    
FileDeleteCacheItem(
string
$cache_name, string
$item_name );

    




    Описание
    

    Метод удаляет элемент с именем $item_name из кэша $cache_name в файле
    
		
    Принимаемые параметры
    
			
    $cache_name
    
		
    название кэша
    
			
    $item_name
    
		
    название элемента в кэше  
    1.  <?php
      2. 

    2.  $Cache = & singleton('Cache');
      3. 

    3.  
      4. 

    4.  // Имя элемента, наиболее часто используется идентификатор или строка идентификаторов
      5. 

    5.  $item_name = 'my_item_1';
      6. 

    6.  
      7. 

    7.  // Для кэширования различных элементов используются различные кэши. Список кэшей задается в настройках модуля "Кэширование"
      8. 

    8.  $cache_name = "TMP";
      9. 

    9.  
      10. 

    10.  $Cache->FileDeleteCacheItem($cache_name, $item_name);
      11. 

    11.  
      12. 

    12.  if ($result)
      13. 

    13.  {
      14. 

    14.      echo "Удаление выполнена успешно";
      15. 

    15.  }
      16. 

    16.  else
      17. 

    17.  {
      18. 

    18.      echo "Ошибка удаления";
      19. 

    19.  }
      20. 

    20.  ?>
      21. 

    
			
    see
    
		
    Cache::DeleteCacheItem()
    
	
    [ Наверх ]
    

    



    Cache::FileGetCountItem
    


    
FileGetCountItem(
string
$cache_name );

    




    Описание
    

    Определение количества элементов в кэше для файлов
    
		
    Принимаемые параметры
    
			
    $cache_name
    
		
    имя кэша  
    1.  <?php
      2. 

    2.  $Cache = & singleton('Cache');
      3. 

    3.  
      4. 

    4.  // Для кэширования различных элементов используются различные кэши. Список кэшей задается в настройках модуля "Кэширование"
      5. 

    5.  $cache_name = "TMP";
      6. 

    6.  
      7. 

    7.  $count_item = $Cache->FileGetCountItem($cache_name);
      8. 

    8.  
      9. 

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

    10.  echo $count_item;
      11. 

    11.  ?>
      12. 

    
			
    Возвращает
    
		
    количество элементов в кэше
    
	
    [ Наверх ]
    

    



    Cache::GetCacheContent
    


    
GetCacheContent(
string
$item_name, string
$cache_name, [int
$time = false] );

    




    Описание
    

    Получение данных из кэша
    
		
    Принимаемые параметры
    
			
    $item_name
    
		
    имя элемента
    
			
    $cache_name
    
		
    имя кэша
    
			
    $time
    
		
    время актуальности элемента кэша. по умолчанию false.  Если false - данные берутся из параметров кэша с именем $cache_name  
    1.  <?php
      2. 

    2.  $Cache = & singleton('Cache');
      3. 

    3.  
      4. 

    4.  // Имя элемента, наиболее часто используется идентификатор или строка идентификаторов
      5. 

    5.  $item_name = 'my_item_1';
      6. 

    6.  
      7. 

    7.  // Для кэширования различных элементов используются различные кэши. Список кэшей задается в настройках модуля "Кэширование"
      8. 

    8.  $cache_name = "TMP";
      9. 

    9.  
      10. 

    10.  if ($in_cache = $Cache->GetCacheContent($item_name, $cache_name))
      11. 

    11.  {
      12. 

    12.      $value = $in_cache['value'];
      13. 

    13.  
      14. 

    14.      // В $value содержится закэшированный элемент
      15. 

    15.      echo $value;
      16. 

    16.  }
      17. 

    17.  else
      18. 

    18.  {
      19. 

    19.      echo "Элемент в кэше не найден!";
      20. 

    20.  }
      21. 

    21.  ?>
      22. 

    
			
    Возвращает
    
		
    если элемент найден в кэше и актуален возвращает array ('value' => значение), если элемент не найден или не актуален возвращает false
    
	
    [ Наверх ]
    

    



    Cache::GetCacheSystem
    


    
GetCacheSystem(
$cache_name
$cache_name );

    




    Описание
    

    Определение системы кэширования для кэша
    
		
    Принимаемые параметры
    
			
    $cache_name
    
		
    имя кэша
    
			
    [ Наверх ]
    

    



    Cache::GetChmod
    


    
GetChmod(
 );

    



		
    [ Наверх ]
    

    



    Cache::GetChmodFile
    


    
GetChmodFile(
 );

    



		
    [ Наверх ]
    

    



    Cache::GetCountItem
    


    
GetCountItem(
string
$cache_name );

    




    Описание
    

    Определение количества элементов в кэше
    
		
    Принимаемые параметры
    
			
    $cache_name
    
		
    имя кэша  
    1.  <?php
      2. 

    2.  $Cache = & singleton('Cache');
      3. 

    3.  
      4. 

    4.  // Для кэширования различных элементов используются различные кэши. Список кэшей задается в настройках модуля "Кэширование"
      5. 

    5.  $cache_name = "TMP";
      6. 

    6.  
      7. 

    7.  $count_item = $Cache->GetCountItem($cache_name);
      8. 

    8.  
      9. 

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

    10.  echo $count_item;
      11. 

    11.  ?>
      12. 

    
			
    Возвращает
    
		
    количество элементов в кэше
    
	
    [ Наверх ]
    

    



    Cache::GetItemPath
    


    
GetItemPath(
string
$cache_name, string
$item_name );

    




    Описание
    

    Определение пути к элементу
    
		
    Принимаемые параметры
    
			
    $cache_name
    
		
    название кэша
    
			
    $item_name
    
		
    название элемента в кэше  
    1.  <?php
      2. 

    2.  $Cache = & singleton('Cache');
      3. 

    3.  
      4. 

    4.  // Имя элемента, наиболее часто используется идентификатор или строка идентификаторов
      5. 

    5.  $item_name = 'my_item_1';
      6. 

    6.  
      7. 

    7.  // Для кэширования различных элементов используются различные кэши. Список кэшей задается в настройках модуля "Кэширование"
      8. 

    8.  $cache_name = "TMP";
      9. 

    9.  
      10. 

    10.  $pathitem = $Cache->GetItemPath($cache_name, $item_name);
      11. 

    11.  
      12. 

    12.  // Распечатаем результат
      13. 

    13.  echo $pathitem;
      14. 

    14.  ?>
      15. 

    
			
    Возвращает
    
		
    путь
    
	
    [ Наверх ]
    

    



    Cache::Insert
    


    
Insert(
string
$item_name, string
$value, string
$cache_name );

    




    Описание
    

    Вставка значения в кэш
    
		
    Принимаемые параметры
    
			
    $item_name
    
		
    имя элемента в кэше
    
			
    $value
    
		
    значение элемента
    
			
    $cache_name
    
		
    имя кэша  
    1.  <?php
      2. 

    2.  $Cache = & singleton('Cache');
      3. 

    3.  
      4. 

    4.  // Имя элемента, наиболее часто используется идентификатор или строка идентификаторов
      5. 

    5.  $item_name = 'my_item_1';
      6. 

    6.  
      7. 

    7.  $value = "Некое значение, может быть разных типов";
      8. 

    8.  
      9. 

    9.  // Для кэширования различных элементов используются различные кэши. Список кэшей задается в настройках модуля "Кэширование"
      10. 

    10.  $cache_name = "TMP";
      11. 

    11.  
      12. 

    12.  $result = $Cache->Insert($item_name, $value, $cache_name);
      13. 

    13.  
      14. 

    14.  if ($result)
      15. 

    15.  {
      16. 

    16.      echo "Вставка выполнена успешно";
      17. 

    17.  }
      18. 

    18.  else
      19. 

    19.  {
      20. 

    20.      echo "Ошибка вставки";
      21. 

    21.  }
      22. 

    22.  ?>
      23. 

    
			
    Возвращает
    
		
    статус вставки в кэш (истину или ложь)
    
	
    [ Наверх ]
    

    



    Cache::is_dir
    


    
is_dir(
string
$dir_name );

    




    Описание
    

    Проверяет наличие директории и в случае успеха сохраняет результат. Служебный метод.
    
		
    Принимаемые параметры
    
			
    $dir_name
    
		
    
			
    [ Наверх ]
    

    



    Cache::xcacheClearCache
    


    
xcacheClearCache(
[string
$cache_name = false], [string
$item_name = false] );

    




    Описание
    

    Очистка кэша $cache_name и элемента $item_name в xcache
    
		
    Принимаемые параметры
    
			
    $cache_name
    
		
    имя кэша, если не передан - очищается полностью кэш
    
			
    $item_name
    
		
    имя элемента в кэше, если не передан - очищается элемент кэша $cache_name с именем $item_name
    
			
    [ Наверх ]
    

    









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



    


  • $cache_dir_is_exist =  false [Строка 45]
    • 

  • Data type: boolean
    • 


    Описание
    

    Флаг наличия директории для сохранения файлов кэша
    

    


  • $cache_systems = array() [Строка 80]
    • 

  • Data type: array
    • 


    Описание
    

    Массив доступных способов кэширования
    

    


  • $default_cache_systems =  'file' [Строка 87]
    • 

  • Data type: string
    • 


    Описание
    

    Способ кэширования по умолчанию
    

    


  • $dividend =  100 [Строка 66]
    • 

  • Data type: int
    • 


    Описание
    

    Максимальное значение, генерируемое для определения необходимости удаления истекших элементов кэша
    
	
    var
    
		
    целое число, по умолчанию имеет значение 100
    

    


  • $is_dir_array = array() [Строка 52]
    • 

  • Data type: array
    • 


    Описание
    

    Кэш существующих директорий
    

    


  • $probability =  1 [Строка 59]
    • 

  • Data type: int
    • 


    Описание
    

    Вероятность удаления истекших элементов кэша
    
	
    var
    
		
    целое число от 1 до dividend
    

    


  • $read_lock =  false [Строка 73]
    • 

  • Data type: bool
    • 


    Описание
    

    Блокировать ли файл кэша при чтении. по умолчанию false
    

    


  • $use_read_control =  true [Строка 38]
    • 

  • Data type: boolean
    • 


    Описание
    

    Использовать контроль данных с помощью crc32
    

    









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