Class site

[Строка 14]

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




Описание


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


Copyright © 2005-2010 ООО "Хостмэйк" (Hostmake LLC), http://www.hostcms.ru
Класс модуля "Сайты".
Файл: /modules/Site/Site.class.php

	
author

		
Hostmake LLC

	
version

		
5.x






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








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



    
	






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







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








Методы
 


    
		
		
  • void AdminMainPage()
		
    Функция обратного вызова для отображения блока  на основной странице центра администрирования.
		
		
  • unknown CopySite()
		
    Копирование сайта
		
		
  • true current_alias()
		
    Метод установки алиаса (домена) сайта в статус "основной"
		
		
  • bool del_alias()
		
    Метод преобразования алиаса (домена) сайта в основной
		
		
  • resource del_site()
		
    Удаление информации о сайте
		
		
  • mixed GetAlias()
		
    Получение данных об алиасе сайта
		
		
  • mixed GetAliasById()
		
    Метод возвращает информацию об алиасе (домене)
		
		
  • resource GetAllAlias()
		
    Метод возвращает информацию обо всех доменах
		
		
  • string GetCurrentAlias()
		
    Определение основного алиаса сайта
		
		
  • array GetSite()
		
    Получение данных о сайте по его идентификатору
		
		
  • string GetXmlForSite()
		
    Создание XML с информацией о сайте и алиасах
		
		
  • int insert_alias()
		
    Метод вставки/обновления информации об алиасе (домене) сайта
		
		
  • int insert_site()
		
    Вставка/обновление информации о сайте
		
		
  • string ReplaceMask()
		
    Удаляет маску "*." из адреса домена
		
		
  • resource SelectSites()
		
    Выбор всех сайтов, поддерживаемых системой управления
		
		
  • resource select_alias()
		
    Получение информации об алиасе (домене) сайта
		
		
  • resource select_site()
		
    Получение данных о сайте
	





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







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



    



    site::AdminMainPage
    


    
AdminMainPage(
 );

    




    Описание
    

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

    



    site::CopySite
    


    
CopySite(
int
$site_id );

    




    Описание
    

    Копирование сайта
    
		
    Принимаемые параметры
    
			
    $site_id
    
		
    идентификатор сайта
    
			
    [ Наверх ]
    

    



    site::current_alias
    


    
current_alias(
int
$site_id, int
$alias_id );

    




    Описание
    

    Метод установки алиаса (домена) сайта в статус "основной"
    
		
    Принимаемые параметры
    
			
    $site_id
    
		
    – идентификатор сайта
    
			
    $alias_id
    
		
    – идентификатор алиаса сайта, который необходимо сделать основным  
    1.  <?php
      2. 

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

    3.  
      4. 

    4.  $alias_id = 8;
      5. 

    5.  $site_id = 1;
      6. 

    6.  
      7. 

    7.  $site->current_alias($site_id, $alias_id);
      8. 

    8.  ?>
      9. 

    
			
    [ Наверх ]
    

    



    site::del_alias
    


    
del_alias(
int
$alias_id );

    




    Описание
    

    Метод преобразования алиаса (домена) сайта в основной
    
		
    Принимаемые параметры
    
			
    $alias_id
    
		
    – – идентификатор алиаса сайта, который необходимо сделать основным  
    1.  <?php
      2. 

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

    3.  
      4. 

    4.  $alias_id = 7;
      5. 

    5.  
      6. 

    6.  $site->del_alias($alias_id);
      7. 

    7.  ?>
      8. 

    
			
    Возвращает
    
		
    результат работы ф-ции
    
	
    [ Наверх ]
    

    



    site::del_site
    


    
del_site(
int
$site_id );

    




    Описание
    

    Удаление информации о сайте
    
		
    Принимаемые параметры
    
			
    $site_id
    
		
    – идентификатор удаляемого сайта  
    1.  <?php
      2. 

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

    3.  
      4. 

    4.  $site_id = 2;
      5. 

    5.  
      6. 

    6.  $resource = $site->del_site($site_id);
      7. 

    7.  
      8. 

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

    9.  while($row = mysql_fetch_assoc($resource))
      10. 

    10.  {
      11. 

    11.      print_r($row);
      12. 

    12.  }
      13. 

    13.  ?>
      14. 

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

    



    site::GetAlias
    


    
GetAlias(
string
$alias_name, [array
$param = array()] );

    




    Описание
    

    Получение данных об алиасе сайта
    
		
    Принимаемые параметры
    
			
    $alias_name
    
		
    
			
    $param
    
		
    ассоциативный массив параметров 
    • bool $param['cache_off'] - если параметр установлен - данные не кэшируются
    • bool $param['use_star'] - использовать ли подставновки *.site.ru, по умолчанию true
 
      1.  <?php
        2. 

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

      3.  
        4. 

      4.  $alias_name = 'test3';
        5. 

      5.  
        6. 

      6.  $row = $site->GetAlias($alias_name);
        7. 

      7.  
        8. 

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

      9.  print_r ($row);
        10. 

      10.  ?>
        11. 

    
			
    Возвращает
    
		
    array данные об алиасе, false - если алиас не найден
    
	
    [ Наверх ]
    

    



    site::GetAliasById
    


    
GetAliasById(
int
$alias_id );

    




    Описание
    

    Метод возвращает информацию об алиасе (домене)
    
		
    Принимаемые параметры
    
			
    $alias_id
    
		
    идентификатор домена  
    1.  <?php
      2. 

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

    3.  
      4. 

    4.  $alias_id = 2;
      5. 

    5.  
      6. 

    6.  $row = $site->GetAliasById($alias_id);
      7. 

    7.  
      8. 

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

    9.  print_r ($row);
      10. 

    10.  ?>
      11. 

    
			
    Возвращает
    
		
    ассоциативный массив с информацией об алиасе или false
    
	
    [ Наверх ]
    

    



    site::GetAllAlias
    


    
GetAllAlias(
[int
$site_id = false] );

    




    Описание
    

    Метод возвращает информацию обо всех доменах
    
		
    Принимаемые параметры
    
			
    $site_id
    
		
    идентификатор сайта, которому принадлежит домен, если false - учитываются все сайты  
    1.  <?php
      2. 

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

    3.  
      4. 

    4.  $site_id = 1;
      5. 

    5.  
      6. 

    6.  $row = $site->GetAllAlias($site_id);
      7. 

    7.  
      8. 

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

    9.  print_r ($row);
      10. 

    10.  ?>
      11. 

    
			
    Возвращает
    
		
    с информацией о доменах (алиасах)
    
	
    [ Наверх ]
    

    



    site::GetCurrentAlias
    


    
GetCurrentAlias(
int
$site_id );

    




    Описание
    

    Определение основного алиаса сайта
    
		
    Принимаемые параметры
    
			
    $site_id
    
		
    – идентификатор сайта  
    1.  <?php
      2. 

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

    3.  
      4. 

    4.  $site_id = 1;
      5. 

    5.  
      6. 

    6.  $result = $site->GetCurrentAlias($site_id);
      7. 

    7.  
      8. 

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

    9.  echo $result;
      10. 

    10.  ?>
      11. 

    
			
    Возвращает
    
		
    имя основного алиаса сайта или false – в случае если основной алиас не найден
    
	
    [ Наверх ]
    

    



    site::GetSite
    


    
GetSite(
[int
$site_id = CURRENT_SITE], [array
$param = array()] );

    




    Описание
    

    Получение данных о сайте по его идентификатору
    
		
    Принимаемые параметры
    
			
    $site_id
    
		
    – идентификатор сайта (по умолчанию равен идентификатору текущего сайта)
    
			
    $param
    
		
    ассоциативный массив параметров 
    • bool $param['cache_off'] - если параметр установлен - данные не кэшируются
 
      1.  <?php
        2. 

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

      3.  
        4. 

      4.  $site_id = 1;
        5. 

      5.  
        6. 

      6.  $row = $site->GetSite($site_id);
        7. 

      7.  
        8. 

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

      9.  print_r ($row);
        10. 

      10.  ?>
        11. 

    
			
    Возвращает
    
		
    ассоциативный массив с информацией о сайте, если такой сайт существует или false – в противном случае
    
	
    [ Наверх ]
    

    



    site::GetXmlForSite
    


    
GetXmlForSite(
int
$site_id );

    




    Описание
    

    Создание XML с информацией о сайте и алиасах
    
		
    Принимаемые параметры
    
			
    $site_id
    
		
    идентификатор сайта  
    1.  <?php
      2. 

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

    3.  
      4. 

    4.  $site_id = 1;
      5. 

    5.  
      6. 

    6.  $xml = $site->GetXmlForSite($site_id);
      7. 

    7.  
      8. 

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

    9.  echo htmlspecialchars($xml);
      10. 

    10.  ?>
      11. 

    
			
    Возвращает
    
		
    созданный XML
    
	
    [ Наверх ]
    

    



    site::insert_alias
    


    
insert_alias(
int
$type, int
$alias_id, int
$site_id, string
$alias_name, int
$alias_current, [int
$users_id = false] );

    




    Описание
    

    Метод вставки/обновления информации об алиасе (домене) сайта
    
		
    Принимаемые параметры
    
			
    $type
    
		
    – параметр, определяющий производится вставка или обновление информации об алиасе сайта (0 – вставка, 1 - обновление)
    
			
    $alias_id
    
		
    – идентификатор обновляемого алиаса сайта (при вставке алиаса равен 0)
    
			
    $site_id
    
		
    – идентификатор сайта, для которого добавляется/обновляется алиас
    
			
    $alias_name
    
		
    – название алиаса сайта
    
			
    $alias_current
    
		
    – параметр, указывающий является ли алиас сайта основным (1 – основной, 0 - неосновной)
    
			
    $users_id
    
		
    идентификатор пользователя, если false - берется текущий пользователь.  
    1.  <?php
      2. 

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

    3.  
      4. 

    4.  $type = 0;
      5. 

    5.  $site_id = 4;
      6. 

    6.  $alias_id = 0;
      7. 

    7.  $alias_current = 1;
      8. 

    8.  $alias_name = 'Новый алиас';
      9. 

    9.  
      10. 

    10.  $newid = $site->insert_alias($type, $alias_id, $site_id, $alias_name, $alias_current, $users_id = false);
      11. 

    11.  
      12. 

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

    13.  echo $newid;
      14. 

    14.  ?>
      15. 

    
			
    Возвращает
    
		
    идентификатор добавляемого/обновляемого алиаса сайта
    
	
    [ Наверх ]
    

    



    site::insert_site
    


    
insert_site(
array
$param );

    




    Описание
    

    Вставка/обновление информации о сайте
    
		
    Принимаемые параметры
    
			
    $param
    
		
    массив параметров сайта 
    • $param['site_id'] идентификатор сайта, информация о котором обновляется
    • $param['site_name'] название добавляемого/обновляемого сайта
    • $param['site_is_active'] параметр, определяющий  активность (доступность) сайта (0 - неактивен (по умолчанию), 1 – активен)
    • $param['site_coding'] кодировка, используемая сайтом
    • $param['site_order'] порядок сортировки сайта в административной части
    • $param['site_locale'] используемая локаль
    • $param['site_timezone'] часовой пояс
    • $param['site_max_size_load_image'] максимальный размер малых изображений загружаемых на сайт
    • $param['site_max_size_load_image_big'] максимальный размер больших картинок загружаемых на сайт
    • $param['site_admin_email'] электронный адрес администратора сайта
    • $param['site_chmod'] права доступа к файлам
    • $param['site_files_chmod'] права доступа к файлам
    • $param['site_date_format'] формат даты
    • $param['site_date_time_format'] формат даты-времени
    • $param['site_error'] режим вывода ошибок
    • $param['site_error404'] страница, отображаемая при возникновении 404 ошибки (страница не найдена),  если страница не указана, производится редирект на главную страницу
    • $param['site_access_denied'] страница, отображаемая при попытке доступа пользователя, не имеющего права доступа
    • $param['site_robots'] содержимое файла robots.txt для данного сайта
    • $param['site_key'] регистрационный ключ
    • $param['site_is_close'] идентификатор узла структуры, содержащего страницу, отображаемую при отключении сайта администратором
    • $param['users_id'] идентификатор пользователя, если false - берется текущий пользователь.
    • $param['site_safe_email'] параметр, определяющий защищен e-mail на страницах сайта от просмотра спам-ботами или нет (1 - защищен (по умолчанию), 0 - не защищен)
    • $param['site_html_cache_use'] использовать ли кэш на сайте
    • $param['site_html_cache_with'] список страниц которые должны кэшироваться
    • $param['site_html_cache_without'] список страниц которые не должны кэшироваться
    • $param['site_html_cache_clear_probability'] параметр, определяющий вероятность очистки кэша
    • $param['site_send_attendance_report'] параметр, устанавливающий ежедневную отправку отчета о посещаемости сайта (1 - отправлять отчет (по умолчанию), 0 - не отправлять)
    • $param['site_uploaddir'] параметр, определяющий путь к разделу, в котором будут сохраняться загруженные файлы. Первым символом значения параметра не может быть символ '/', данным символом обязательно должно заканчиваться значение. Значение по умолчанию 'UPLOAD/'.
    • $param['site_nesting_level'] число уровней вложенности директорий для хранения файлов сущностей системы (основных и дополнительных свойств типа "Файл" информационных элементов, основных и дополнительных свойств типа "Файл" информационных групп, дополнительных свойств типа "Файл" узлов структуры).
   
       по умолчанию равен 3.
      
    1.  <?php
      2. 

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

    3.  
      4. 

    4.  $param['site_name'] = 'Новый сайт';
      5. 

    5.  
      6. 

    6.  $newid = $site->insert_site($param);
      7. 

    7.  
      8. 

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

    9.  echo $newid;
      10. 

    10.  ?>
      11. 

    
			
    Возвращает
    
		
    идентификатор добавленного или обновленного сайта
    
	
    [ Наверх ]
    

    



    site::ReplaceMask
    


    
ReplaceMask(
string
$str );

    




    Описание
    

    Удаляет маску "*." из адреса домена
    
		
    Принимаемые параметры
    
			
    $str
    
		
    1.  <?php
      2. 

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

    3.  
      4. 

    4.  $str = '*.test3';
      5. 

    5.  
      6. 

    6.  echo $site->ReplaceMask($str);
      7. 

    7.  ?>
      8. 

    
			
    [ Наверх ]
    

    



    site::SelectSites
    


    
SelectSites(
[array
$param = array()] );

    




    Описание
    

    Выбор всех сайтов, поддерживаемых системой управления
    
		
    Принимаемые параметры
    
			
    $param
    
		
    массив дополнительных параметров, необязательный параметр 
    • $param['limit0'] - с какого совпадения начинать отбор, по умолчанию 0
    • $param['limit1'] - число элементов для выбора, по умолчанию не ограничено
    • $param['users_type_id'] - группа пользователей центра администрирования, для которой выбираются доступные сайты
 
      1.  <?php
        2. 

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

      3.  
        4. 

      4.  $resource = $site->SelectSites();
        5. 

      5.  
        6. 

      6.  // Распечатаем результат
        7. 

      7.  while($row = mysql_fetch_assoc($resource))
        8. 

      8.  {
        9. 

      9.      print_r($row);
        10. 

      10.  }
        11. 

      11.  ?>
        12. 

    
			
    [ Наверх ]
    

    



    site::select_alias
    


    
select_alias(
int
$alias_id );

    




    Описание
    

    Получение информации об алиасе (домене) сайта
    
		
    Принимаемые параметры
    
			
    $alias_id
    
		
    – идентификатор алиаса, о котором необходимо получить информацию, -1 - выбрать все  
    1.  <?php
      2. 

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

    3.  
      4. 

    4.  $alias_id = 2;
      5. 

    5.  
      6. 

    6.  $resource = $site->select_alias($alias_id);
      7. 

    7.  
      8. 

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

    9.  while($row = mysql_fetch_assoc($resource))
      10. 

    10.  {
      11. 

    11.      print_r($row);
      12. 

    12.  }
      13. 

    13.  ?>
      14. 

    
			
    Возвращает
    
		
    данные об алиасе сайта
    
	
    [ Наверх ]
    

    



    site::select_site
    


    
select_site(
int
$site_id );

    




    Описание
    

    Получение данных о сайте
    
		
    Принимаемые параметры
    
			
    $site_id
    
		
    - идентификатор сайта, -1 выбрать все  
    1.  <?php
      2. 

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

    3.  
      4. 

    4.  $site_id = 1;
      5. 

    5.  
      6. 

    6.  $resource = $site->select_site($site_id);
      7. 

    7.  
      8. 

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

    9.  while($row = mysql_fetch_assoc($resource))
      10. 

    10.  {
      11. 

    11.      print_r($row);
      12. 

    12.  }
      13. 

    13.  ?>
      14. 

    
			
    [ Наверх ]
    

    









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



    


  • $CacheSite =  [Строка 23]
    • 

  • Data type: string
    • 


    Описание
    

    Кэш данных о сайтах
    

    


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

  • Data type: mixed
    • 


    









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