Готовые решения

Пример программной структуры сайта

Начинающий веб-разработчик обычно не знает многих тонкостей, связанных с проектированием программной структуры сайта. Поэтому отмечу основные пункты, которые следует учитывать.

1. Все обращения пользователей к страницам сайта должны осуществляться через один индексный файл, а в нем уже происходить подключения остальных файлов в зависимости от страницы, которую запрашивает пользователь. Это позволит централизовано определить общие переменные для всего сайта, подключить файлы функций, инициировать старт сессии, подключение к базам данных и т.д. Для реализации подобной структуры на сервере апач используется mod_rewrite.

Данная схема может не распространяться на некоторые внешние скрипты, типа форумов, досок объявлений, которые не способны работать таким образом. Для них нужно настроить исключения.

2. Страницы сайта рекомендуется объединить в разделы и подразделы, сайт, таким образом, будет иметь древовидную структуру. Логично распространить ее и на адреса страниц, ведь пользователю понятнее "папочная" структура ссылок, а не строки с параметрами, типа http://www.mysite.ru/?acticle_id=5. Также, в адресе лучше использовать слова, отражающие название статьи (возможно, в транслитерации), это полезно для SEO. Поэтому ссылки у нас будут выглядеть так:

http://www.mysite.ru/acticles/ – список статей

http://www.mysite.ru/acticles/koe-chto-o-pitanii-homyachkov/ – конкретная статья

http://www.mysite.ru/new/ – список новостей

http://www.mysite.ru/new/5/ – конкретная новость, можно вместо идентификатора "5" использовать и заголовок новости, в этом случае придется следить за их уникальностью

3. Css- и javascript-код нужно стараться максимально вынести во внешние файлы. Это поможет разделить структуру сайта на логические части, уменьшить трафик и упростить его индексацию поисковыми роботами.

4. Весь вывод в браузер пользователя должен происходить в самом конце сценария, уже после формирования контента и завершения работы с БД. Для этого можно было бы собирать вывод в строку, однако, это не очень удобно, поэтому лучше перед формированием контента включить буферизацию вывода запуском функции ob_start(), а после сохранить все содержимое буфера в переменную вызовом ob_get_clean().

Итак, приступим.

Создадим в корне сайта файл .htaccess

#устанавливаем кодировку сайта - в данном случае utf-8
AddType "text/html; charset=utf-8" .html .htm .shtml
AddDefaultCharset utf-8
‏
#запрещаем магические кавычки
php_flag magic_quotes_gpc 0
php_flag magic_quotes_runtime 0
‏
#включаем mod_rewrite
RewriteEngine on
Options +FollowSymlinks
‏
#перечисляем правила рерайта ссылок - каждое с новой строки
RewriteRule ^[a-z,0-9,_,/,\-,:]*$ index.php #строки из этих символов передаем на обработку index.php
RewriteRule ^index.php$ - [L] #как только дошли до index.php, обрабатываем обычным способом
RewriteRule ^forum*$ - [L] #исключение для форума
RewriteRule ^.*\.(php|html).*$ index.php #запрещаем запуск файлов .php и .html
‏
#устанавливаем страницы ошибок
ErrorDocument 404 /index.php?error=404
ErrorDocument 403 /index.php?error=403
ErrorDocument 500 /index.php?error=500

Теперь поясним, что здесь, что.

RewriteEngine on
Options +FollowSymlinks

Эти две строки инициируют работу mod_rewrite.

RewriteRule ^[a-z,0-9,_,/,\-,:]*$ index.php

Правило выше означает, что любая строка в url после корня, состоящая из букв латинского алфавита, цифр, символов "_", "/" ,"-", ":" передается на обработку index.php. Предполагается, что все ссылки у нас будут состоять из этих символов. Символ точка среди них не указываем, чтобы обработка файлов, например robots.txt, производилась обычным способом

RewriteRule ^index.php$ - [L]

Это правило указывает, что если в url после корня оказалось "index.php" – рерайта ссылки не происходит, а обработка передается индексному файлу. Таким образом, параметр [L] выводит строку из под действия mod_rewrite

RewriteRule ^forum*$ - [L]

Допустим, мы хотим настроить исключение для запуска форума. Если url после корня начинается с "forum", запрещаем рерайт (как и в предыдущем правиле используем параметр [L]) – обработка осуществляется обычным способом в зависимости от того, что идет дальше в строке ссылки.

RewriteRule ^.*\.(php|html).*$ index.php

Данное правило запрещает выполнение файлов с расширением .php и .html, оно, как и раньше, передается файлу index.php. Поэтому при запуске /articles.php даже если такой файл существует, будет исполнен index.php и как показано дальше выведется ошибка 404. Это нужно, чтобы исключить возможность запуска пользователем промежуточных файлов и, таким образом, повысить надежность сайта.

ErrorDocument 404 /index.php?error=404
ErrorDocument 403 /index.php?error=403
ErrorDocument 500 /index.php?error=500

Эти строки определяют, какие страницы показывать пользователю в случае возникновения ошибок с соответствующими кодами.

Теперь разберемся с организацией файлов на сервере. Пускай все общие файлы у нас лежат в папке /common/. Директория /common/scripts/ будет хранить файл функций phpfuncs.php и конфигурационный файл config.php, директория /common/html/templates/ – все html-шаблоны, /common/html/сss/ и /common/html/js/ соответственно css- и js- файлы. В папке /sections/ у нас будут директории разделов, например, /sections/articles/ станет директорией с разделом "Статьи".

Выделим три глобальные переменные-массива: $CONFIG – конфигурация сайта, $SCRIPT – вся информация, касающаяся текущего сценария, и $USER – массив данных пользователя, который запускает сценарий. К сожалению, в php нет возможности централизованно определить область видимости переменной, поэтому нам придется объявлять их глобальными в каждой функции, где они могут понадобиться при помощи оператора global.

Создадим в корне файл /index.php. Далее все понятно из комментариев, объясню только основные моменты. В index.php мы подключаем файлы phpfuncs.php и config.php, устанавливаем параметры кодировки, стартуем сессию, подключаемся к БД, идентифицируем пользователя, беря информацию о нем из баз данных и формируем контент $SCRIPT['html_content']. В самом конце идет запуск функции завершения сценария, которая осуществляет вывод.

<?
// подключение файла конфигураций, формирующего массив $CONFIG
require dirname(__FILE__).'common/scripts/config.php';
// подключение файла, содержащего функции
require $CONFIG['site_dir'].'common/scripts/phpfuncs.php';
// подключаемся к БД
dbConnect();
// опции кодировки
mb_internal_encoding('UTF-8');
mb_regex_encoding('UTF-8');
// устанавливаем локаль
setlocale(LC_ALL, 'Russian_Russia.65001');
// инициируем старт сессии на всех поддоменах
ini_set('session.cookie_domain', $CONFIG['common_cookie_domain']);
session_start();
‏
// идентифицируем пользователя - создаем глобальную переменную $USER
$user_id = (int)$_COOKIE['user_id'];
$password = $_COOKIE['password'];
$db_password = $user_id ? dbFetchResult("SELECT password FROM users WHERE id=$user_id") : '';
// зарегистрированный пользователь
if ($user_id && $db_password == md5($CONFIG['common_cookie_login_seed'].$password))
$USER = dbFetchString("SELECT * FROM users WHERE id=".$_COOKIE['user_id']);
// гость
else $USER = array();
‏
// ссылка от корня, по которой обратился пользователь
// на некоторых серверах $_SERVER['REQUEST_URI'] - это ссылка от корня, а на некоторых полная ссылка, учитываем это
$SCRIPT['root_url'] = mb_substr($_SERVER['REQUEST_URI'], 0, 4) == 'http' ? mb_strstr(mb_substr(mb_strstr($_SERVER['REQUEST_URI'], '//'), 2), '/') : $_SERVER['REQUEST_URI'];
// полная ссылка, по которой обратился пользователь
$SCRIPT['this_url'] = 'http'.($_SERVER['HTTPS']?'s':'').'://'.$_SERVER['HTTP_HOST'].$SCRIPT['root_url'];
‏
// определяем заголовки - части ссылки, разделенные символом "/"
$SCRIPT['headers'] = explode('/', $SCRIPT['root_url']);
‏
// подключаемый html-шаблон по умолчанию
$SCRIPT['html_template'] = 'main.php';
‏
// все разделы, существующие на сайте
$sections = array('main', 'articles');
// имя раздела, контент каждого раздела у нас формируют файлы /sections/<имя_раздела>/<имя_раздела>.php
$section = in_array($SCRIPT['headers'][1], $sections) ? $SCRIPT['headers'][1] : 'main';
‏
// если есть параметр $_GET['error'], значит это страница с ошибкой - завершаем работу
if ($_GET['error']) PageError($_GET['error']);
‏
// контент
ob_start(); // включаем буферизацию вывода
require $CONFIG['site_dir'].'sections/'.$section.'/'.$section.'.php';
$SCRIPT['html_content'] = ob_get_clean(); // теперь весь контент сохранен в переменную $SCRIPT['html_content'], буферизация выключена
‏
‏
// добавление слеша к псевдопапкам в ссылках, таким образом, /articles редиректится на /articles/
if (!$_GET['error'] && $SCRIPT['this_url'][mb_strlen($SCRIPT['this_url'])-1] != '/'
&& !mb_strstr($SCRIPT['root_url'], '.') && !mb_strstr($SCRIPT['root_url'], '?'))
{
array_push($SCRIPT['http_headers'], 'HTTP/1.1 301 Moved Permanently',
'Location: '.$SCRIPT['this_url'].'/');
$SCRIPT['html_template'] = '';
}
‏
// завершаем выполнения сценария
ScriptEnd();
?>
‏
‏

Конфигурационный файл /common/scripts/config.php, в нем происходит формирование глобальной переменной $CONFIG.

<?
// опции БД
$CONFIG['db_host'] = 'localhost'; // имя хоста
$CONFIG['db_username'] = 'webuser'; // имя пользователя
$CONFIG['db_password'] = '12345abc'; // пароль пользователя
$CONFIG['db_base'] = 'mysite'; // имя базы данных
‏
// строка для шифрования пароля при помощи хеш-функции
$CONFIG['common_cookie_login_seed'] = '%whj24a>hnsn67rel;';
// домен, на котором стартуем сессию, точка в начале нужна, чтобы старт произошел на всех поддоменах домена mysite.ru
$CONFIG['common_cookie_domain'] = '.mysite.ru';
‏
// путь к корню сайта
$CONFIG['site_dir'] = dirname(dirname(dirname(__FILE__))).'/';
// url главной страницы
$CONFIG['site_url'] = 'http://www.mysite.ru/';
?>

Файл функций /common/scripts/phpfuncs.php, содержит также функции работы с базами данных. Родные функции php для работы с БД, например, mysql_query, лучше запускать не напрямую, а через "обертку". Это позволит легко переключаться при необходимости из режима mysql в mysqli и обратно, считать количество запросов в сценарии для статистики, выводить ошибочные запросы на экран, если включен режим отладки и т.д.

<?
// вывод страницы ошибки
function PageError($error = 404)
{
global $CONFIG, $SCRIPT;
ob_get_clean();
if ($error == 404)
{
$SCRIPT['http_headers'][] = 'HTTP/1.1 404 Not Found';
$SCRIPT['html_title'] = 'Страница не найдена';
$SCRIPT['html_content'] = '<p>Страница с таким адресом на сайте не существует, возможно она была перенесена или вы перешли по некорректной ссылке. Попробуйте воспользоваться <a href="'.$CONFIG['site_url'].'main/sitemap/">картой сайта</a>, чтобы найти нужную страницу.</p>';
}
elseif ($error == 403) // доступ запрещен
{
$SCRIPT['http_headers'][] = 'HTTP/1.1 403 Forbidden';
$SCRIPT['html_title'] = 'Доступ запрещен';
$SCRIPT['html_content'] = '<p>У вас нет прав доступа для просмотра содержимого данной страницы. Если вы забрели сюда по ошибке, попробуйте воспользоваться <a href=""'.$CONFIG['site_url'].'main/sitemap/">картой сайта</a> или свяжитесь с администратором.</p>';
}
elseif ($error == 500) // ошибка в скрипте
{
$SCRIPT['http_headers'][] = 'HTTP/1.1 500 Internal Server Error';
$SCRIPT['html_title'] = 'Ошибка на сервере';
$SCRIPT['html_content'] = '<p>Из-за ошибки на сервере невозможно отобразить страницу. В самое ближайшее время она будет исправлена.</p>';
}
$SCRIPT['html_template'] = 'main.php';
ScriptEnd();
}
‏
// завершение выполнения сценария
function ScriptEnd()
{
global $CONFIG, $SCRIPT, $USER;
$SCRIPT['http_headers'][] = 'X-Powered-By: MYSite Runner'; // кем сделан сайт
// выводим все HTTP-заголовки
for ($i=0;$i<count($SCRIPT['http_headers']);$i++) header($SCRIPT['http_headers'][$i]);
// выводим заполненный макет страницы
if ($SCRIPT['html_template']) require $CONFIG[site_dir].'common/html/templates/'.$SCRIPT['html_template'];
dbDisconnect();
exit();
}
‏
//////////////////////////////////////
// ФУНКЦИИ РАБОТЫ С БД
//////////////////////////////////////
‏
// подсоединение к БД
function dbConnect()
{
global $CONFIG;
// подключаемся к БД
mysql_connect($CONFIG['db_host'], $CONFIG['db_username'], $CONFIG['db_password']);
// выбираем базу данных
mysql_select_db($CONFIG['db_base']);
// ставим кодировку БД - Юникод в данном случае
mysql_query("SET NAMES utf8");
}
‏
// закрытие соединения к БД
function dbDisconnect()
{
mysql_close();
}
‏
// запрос к БД
function dbQuery($query)
{
global $USER; // $USER['is_test'] - включен ли режим отладки?
$result = mysql_query($query);
if (!$result && $USER['is_test']) echo '<br>'.mysql_error().'<br><b style="color: red">Запрос: </b>'.$query.'<br>';
return $result;
}
‏
// получение записи
function dbFetchArray($result, $param = 'assoc')
{
$param = ($param == 'both') ? MYSQL_BOTH : ($param == 'num' ? MYSQL_NUM : MYSQL_ASSOC);
return mysql_fetch_array($result, $param);
}
‏
// возвращение единственного поля результата
function dbFetchResult($query)
{
$arr = dbFetchArray(dbQuery($query));
return @reset($arr);
}
‏
// возвращение единственной записи результата (первой записи)
function dbFetchString($query, $param = 'assoc')
{
$result = dbQuery($query);
return dbFetchArray($result, $param);
}
?>

Файл /sections/articles/articles.php формирует контент раздела "Статьи", а также определяет переменные:

$SCRIPT['html_title'] – html-заголовок страницы,

$SCRIPT[‘html_description’] – содержимое метатега description,

$SCRIPT['html_keywords'] – содержимое метатега keywords,

$SCRIPT['html_revisit'] – частота поcещения страницы поисковыми роботами

$SCRIPT['html_robots'] – правила индексации страницы поисковыми роботами

Эти переменные потом будут подставлены в html-шаблон.

<?
// конкретная статья
if ($SCRIPT['headers'][2])
{
// ищем статью в БД по имени, содержащемся в ссылке
$arr = dbFetchString("SELECT * FROM articles WHERE name='".$SCRIPT['headers'][2]."'");
if ($arr)
{
$SCRIPT['html_title'] = $arr['title'];
$SCRIPT['html_keywords'] = $arr['keywords'];
// поисковой робот будет заходить на страницу статьи каждые 5 дней
$SCRIPT['html_revisit'] = '5';
$SCRIPT['html_robots'] = 'index, follow'; // разрешаем индексацию
echo '<h1>'.$arr['title'].'</h1>'.$arr['content'];
}
else PageError(404); // такой статьи не существует - выводим страницу с ошибкой
}
else
// список статей
{
// пускай поисковой робот заходит на эту страинцу каждый день
$SCRIPT['html_revisit'] = '1';
$SCRIPT['html_robots'] = 'index, follow'; // разрешаем индексацию
$result = dbQuery("SELECT * FROM articles ORDER BY title");
while ($arr = dbFetchArray($result))
echo '<a href="/articles/'.$arr['name'].'/">'.$arr['title'].'</a><br>';
}
?>
‏

Файл /common/html/templates/main.php – основной html-шаблон сайта, можно сделать также шаблоны для всплывающих окон window.php, шаблон сообщения message.php и т.д. В шаблоны подставляются переменные $SCRIPT['html_title'] , $SCRIPT['html_description'], $SCRIPT['html_keywords'], $SCRIPT['html_revisit'], $SCRIPT['html_robots'] , $SCRIPT['html_content'].

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<title><?=$SCRIPT['html_title']?></title>
<meta name="description" content="<?=$SCRIPT['html_description']?>">
<meta name="keywords" content="<?=$SCRIPT['html_keywords']?>">
<meta name="revisit" content="<?=$SCRIPT['html_revisit']?> days">
<meta name="robots" content="<?=$SCRIPT['html_robots']?>">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head>
<body>
<div id="menu">
<a href="/">Главная</a><br>
<a href="/articles/">Статьи о хомячках</a><br>
<a href="/forum/">Форум</a><br>
</div>
<div id="content">
<?=$SCRIPT['html_content']?>
</div>
</body>

Если теперь все соберем вместе и кое-что допишем, получим функциональный сайт. Понятно, что в приведенном примере учтено далеко не все, имеет смысл также сделать авторизацию пользователей, более детально продумать меню сайта, создать нужные таблицы в базах данных и т.д. Чтобы вам было проще я поместил все приведенные файлы в архив.

Теги: PHP
Другие готовые решения...

Пример программной структуры сайта

Добавление комментария