Чтение INI-файла в PHP. Установка PHP

INI-файлы - это обычные текстовые файлы, состоящие из определённых секций. Как правило, INI-файлы используются для сохранения определённых настроек, например, настроек языка. И, разумеется, чтобы наш сайт мог легко изменяться тем или иным образом, можно все параметры, отвечающие за это изменение, поместить в отдельный файл. И как быстро извлечь в PHP из этого файла все настройки мы и разберём в этой статье.

Для чтения INI-файла в PHP используется функция parse_ini_file() . Но прежде, чем её использовать, создадим INI-файл "settings.ini ":

Par1=10
Par2=20

В этом файле мы описали два параметра и присвоили им определённые значения. А теперь создадим PHP-файл , в котором считаем данные из созданного файла с помощью функции parse_ini_file() :

$arr = parse_ini_file("settings.ini");
print_r($arr);
?>

В результате, Вы увидите следующую строку: "Array ( => 10 => 20) ". Как видите, функция parse_ini_file() вернула массив с ключами в виде названия параметров и значениями в виде тех, что мы задавали в файле "settings.ini ".

Теперь разберём пример из реальной практики. Сделаем одну страничку, которая будет выводить текст на языке, заданным GET-параметром . Для начала создадим INI-файл "lang_en.ini ":

HELLO=Hello
WORLD=world

Теперь создадим PHP-скрипт :

$lang = isset($_GET["lang"])? $_GET["lang"]: "en";
$langconst = parse_ini_file("lang_$lang.ini");
echo $langconst["HELLO"]." ".$langconst["WORLD"]."!";
?>

Первой строкой мы проверяем: если был передан GET-параметр lang , то тогда считываем оттуда значение и записываем в переменную lang . А если никакого значения передано не было, то устанавливаем значение по умолчанию, в нашем случае: "en ". Дальше мы обращаемся к файлу нужного языка и вытаскиваем оттуда данные. Затем уже просто выводим строку, используя полученные языковые константы . В результате, мы увидим: "Hello World! ".

А теперь пришла пора доказать, почему это так удобно. Для того, чтобы добавить новый язык достаточно создать лишь ещё один файл, где перевести все языковые константы:

HELLO=Привет
WORLD=мир

Сохраните данный файл под названием "lang_ru.ini ", и запустите скрипт: "адрес_скрипта.php?lang=ru ". В результате, Вы увидите: "Привет мир!".

Как видите, мы создали лишь ещё один INI-файл , перевели константы на нужный язык и всё! Таким образом, Вы легко можете создать несколько языковых версий Вашего сайта, что смотрится очень здорово, а, главное, реализация этого достаточно простая.

Конечно же вы попадали в такую ситуацию, когда приложение, разработанное вами ранее, могло быть снова использовано в рамках другого проекта. Вначале вы конечно же подумали, что это не создаст никаких проблем. Всего-то необходимо скопировать код из одного каталога в другой! Со временем вы осознали, что проекты могут различаться между собой различными параметрами, пусть даже самыми незначительными. Например, это может быть e-mail адрес на который отсылаются сообщения. В таком случае вам ничего не остается, как открыть множество файлов в редакторе и изменить их содержимое, вставляя нужный e-mail при помощи функции найти/заменить. Эта статья расскажет вам о том, как можно избавить себя от подобной работы, а так же порекомендует ряд дополнительных средств для создания и чтения конфигурационных файлов.

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

Компьютер был изобретен для того, чтобы избавить человека от лишней работы. Развитие компьютерных технологий привело к тому, что человек стал стремиться все меньше времени проводить за компьютером. Допустим, вы программист. Не будь компьютера, вы бы остались без работы. Но в то же время вы стараетесь с помощью компьютера упростить свою ежедневную работы, с этой целью вы используете, например, функцию автозавершения кода в редакторе. Мы хотим подвести вас к той мысли, что код созданный вами, должен быть организован так, чтобы работы по его модификации были сведены к минимуму. Чаще всего это удается, когда вы создаете код, автоматизирующий рутинные операции, такие как создание и прорисовка формы, а так же отправка e-mail. Однако не стоит забывать, что функции для выполнения рутинных операций никогда не бывают на 100% идентичными в различных приложениях. Один формуляр не похож на другой, а сообщения электронной почты предназначены разным адресатам. Однако логика на уровне приложения остается прежней, функции различаются между собой только некоторыми параметрами. Таким образом, вы должны ясно представлять свою цель – разработать код, параметры которого можно было бы определять извне.

Модульная организация

Для решения этой задачи, планируя структуру приложения, вы должны позаботиться о модульности. То есть вам необходимо поместить часто используемые функции или классы в отдельный файл, который будет подключаться через require_once. В этом случае файлы приложения не будут наполнены избыточным кодом. Допустим, вы часто осуществляете запись в лог-файл. В таком случае было бы неплохо код, выполняющий эту операцию, заключить в рамки класса или функции. Будет еще лучше, если вы воспользуетесь уже готовым классом, взятым из какой-нибудь библиотеки исходных кодов, например PEAR.

Параметры процедурального кода

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

Листинг 1 демонстрирует функцию, которая занимается отправкой e-mail. В ее теле содержится только одна php-функция - mail(). Таким образом, мы избавляемся от необходимости каждый раз указывать получателя при отправке сообщения. Следующая переменная, которую мы определяем, обозначает префикс, предшествующий теме сообщения. Конфигурационный файл, подключаемый через require_once, мог бы выглядеть следующим образом.

Listing 1

$to = "webmaster@localhost" ;
$prefix = " " ;
?>

function sendMail ($subject , $body )
{
global $to , $prefix ;
$subject = $prefix . $subject ;
return mail ($to , $subject , $body );
}
require_once "config1.php" ;
sendMail ("Test" , "Это тестовое сообщение." );
?>

Есть способ лучше

Даже если рассмотренный выше способ и является действенным, однако это не самое лучшее решение. По мере того как код вашего приложения будет усложняться, вырастет и число опций, тогда могут возникнуть следующие проблемы:

• Глобальные переменные, которые мы используем, могут породить конфликты в пространстве имен.
• В том случае, если конфигурационные файлы редактируются не программистом, а дилетантом, в системе могут возникнуть синтаксические ошибки, например из-за незакрытых кавычек.
• Для того, чтобы получить доступ к различным переменным, необходимо обращаться к массиву $_GLOBALS.

Вместо php-модулей существуют другие форматы, которые могут быть легко поняты и изменены дилетантами, а так же php-скриптами. Мы имеем в виду два формата: этого широко используемые операционной системой Windows ini-файлы, а так же формат XML.

В этом примере вы уже заметили, что внутри тега указывается тип значения. Названия типов идентичны тем, что используются в php-функции settype(). Если тип не указан, тогда значение интерпретируется как строка. Для часто используемых опций можно определить отдельный тег.

webmaster@localhost
100

Наряду с функцией getConfigValue, существует функция setConfigValue(), с помощью которой можно изменить значение опции. Затем конфигурационный файл может быть заново записан с помощью writeConfigFile() (см листинг 7).

patConfiguration предлагает также серию дополнительных возможностей. Например, наряду с тегами, существует возможность определять атрибуты и пространства имен (Namespace), а к тегу можно привязать внешний файл, таким образом, опции будут распределены по нескольким файлам. Кроме этого patConfiguration включает систему кэширования, благодаря которой пропадает необходимость в многократном считывании конфигурационного файла.

Дополнительную информацию вы сможете найти на PHP Application Tools-Homepage и в patConfiguration-Tutorial на DevShed .

Listing 7

require_once "include/patConfiguration.php" ;

$config = new patConfiguration (
array(
"configDir" => "./" ,
"errorHandling" => "nice_die"
);
$config -> parseConfigFile ("config6.xml" );
$config -> setConfigValue ("errors.email" , "errors@localhost" );
$config -> writeConfigFile ("config6_new.xml" , "xml" , array("mode" => "pretty" ));
?>

Заключение

Забота о гибкости настроек приложения может сберечь много времени, особенно если его компоненты предполагается использовать в других проектах. Вы потратите еще меньше времени, если доверите работу с конфигурационными файлами одному из готовых классов. Выбор между PEAR::Config и patConfiguration зависит от задачи. Преимуществом PEAR::Config является поддержка различных форматов конфигурационных файлов, в то время как patConfiguration прекрасно работает с XML, так же предоставляет ряд дополнительных возможностей. Однако с появлением версии 2.0.0 этот пакет будет иметь одинаковый API для считывания ini и wddx файлов. PHP-массив поддерживаются уже в текущей версии.

Курс предназначен для базовой подготовки администраторов сайтов, созданных на "1С-Битрикс: Управление сайтом" . Изучив курс, вы освоите основные методы администрирования системы, а также пополните знания по темам, изученным в курсе Контент-менеджер .

Если вы добросовестно изучите курс, то научитесь:

• управлять доступом к системе, сайтами, пользователями, группами пользователей;
• работать с инструментами системы;
• использовать возможности интерфейса по управлению системой;
• работать с модулями "1С-Битрикс: Управление сайтом", связанными с оптимизацией и безопасностью работы сайта;
• выполнять работу по конфигурированию веб-системы для оптимальной работы.

Если вам предстоит самостоятельная установка системы или перенос сайта на хостинг, то без курса Установка и настройка Курс Установка и настройка предназначен для специалистов устанавливающих "1С-Битрикс: Управление сайтом" или "Битрикс24 в коробке".

Вам не обойтись.

Необходимый минимум знаний для изучения курса:

• базовые навыки компьютерной грамотности и навыков работы с ОС Windows;
• базовые знания о WWW и организации доступа к веб-серверу;
• знание системы в рамках курса Контент-менеджер Мы считаем, что вы этот курс уже прошли и знаете многое о Битриксе. Поэтому подсказок во всплывающих окнах будет намного меньше, чем в курсе Контент-менеджер. , чтобы банально не путаться в интерфейсе.

Неплохо было бы иметь базовые навыки установки и администрирования *nix-систем.

Если данный курс берётся в качестве основы для оффлайного преподавания, то рекомендуемая продолжительность: 3 дня (24 академических часа).

Экономите время и учитесь по дороге на работу или в ВУЗ? Используйте файл формата CHM, они открываются на любых устройствах. Программы для чтения доступны в AppStore и Play Market. Файлы формата CHM обновляются ежемесячно, тем не менее, возможно некоторое отставание их от онлайновой версии курса.

Создание и использование собственного файла php.ini

Любой пользователей может создать собственный файл php.ini и разместить его в папке вызываемого срипта.
Это довольно удобно, так как Вы можете самостоятельно редактировать свои настройки, без обращения в службу тех. поддержки

Если Вы решили положить php.ini где то в public_html, то создайте файл.htaccess в корневой папке сайта (например /home/user/public_html ,где user ваш никнейм в cpanel) или если файл существует то только добавьте в любом месте (в начале или конце) в файл.htaccess директивы которые описанны ниже.

order allow,deny
deny from all

эти директивы запрещают просмотра файла php.ini посторонними.

При такой установке PHP в виде обработчика CGI, SuPHP, Вы не можете использовать в файле.htaccess следующие директивы: php_flag, php_admin_flag, php_value и прочих, которые изменяют какие-либо параметры PHP окружения это вызовет ошибку с кодом 500, Internal Server Error.

Внимание: собственный файл php.ini действителен только в пределах директории, в которой размещён, если не указана специальная опция, см. ниже.

suPHP_ConfigPath /home/user/public_html

т.е. в пишите эту строку в файл.htaccess перед кодом запрета просмотра файла php.ini, только замените user на свое имя пользователя.

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

644 - запись в файл разрешена (по умолчанию)
444 - запись в файл запрещена (только чтение и исполнение)
755 - права доступа на папки (по умолчанию, менять не требуется)

Обратите внимание - при правах доступа 644 запись разрешена только для скриптов которые запускаются в среде Вашего аккаунта. Никто другой запись произвести не сможет. Для ещё большего увлечения безопасности Вы можете сменить права доступа у файлов на 444 - в этом случае даже Ваши скрипты не смогут ничего записать в файлы, но это не обязательно.

Таким образом при установке скриптов не требуется менять права доступа, даже если в инструкции к скрипту написано что их нужно изменить. Просто пропускайте пункт смены прав доступа CHMOD.

Пример файла php.ini и описание некоторых его параметров:

; Синтаксис файла: "директива = значение"
; Знак комментария в php.ini - ";" (точка с запятой). Все, что находится в строке после ";" не воспринимается PHP

safe_mode = Off

disable_functions = ; В целях безопасности, позволяет запретить выполнение указаных функций

max_execution_time = 30 ; Максимальное кол-во секунд исполнения скрипта

memory_limit = 16M ; Максимум оперативной памяти, которую может взять себе скрипт

error_reporting = E_ALL & ~E_NOTICE ; Показывать все ошибки, кроме замечаний

display_errors = On ; Вывод ошибок в браузер. Для облегчения отладки сценариев

variables_order = "EGPCS" ; Порядок, в котором PHP будет регистрировать перменные (E - встроенные переменные, G - GET переменные, P - POST переменные, C - Cookies, S - сессии). Отсутствие какой-либо из букв не позволит вам работать с соответствующими переменными

register_globals = On ; Возможность обращения к переменным, поступающим через GET/POST/Cookie/сессии, как к обычным переменным (например, "$переменная")

post_max_size = 55M ; Максимальный объём данных который может быть принят

magic_quotes_gpc = On ; Включение автоматической обработки кавычек, поступающих через POST/GET/Cookie

file_uploads = On ; Разрешает загрузку файлов

;upload_tmp_dir = ; Каталог для временных закачанных файлов (не забудте создать этот каталог!)

upload_max_filesize = 5M ; Максимальный размер закачиваемого файла

session.save_handler = files ; Хранить данные сессий в файлах

session.save_path = /tmp ; Папка для хранения файлов сессий (не забудте создать этот каталог!)

session.use_cookies = 1 ; Использовать cookie в сессиях

session.name = PHPSESSID ; Исользовать в качестве имени сессии и сессионной cookie ID сессии

session.cookie_lifetime = 0 ; Время жизни сессионных cookie ("0" - до закрытия окна браузера)

session.use_trans_sid = 1 ; ID сессии будут добавляться ко всем ссылкам на странице автоматически (если у пользователя отключены cookie)

; и много других параметров...

Внимание!: Данная информация не актуальна для наших серверов, управлять PHP.ini, т.е. настройками PHP и версией PHP, вы можете в CPanel в раздлеле Select PHP version (Выбор PHP версии)

php имеет множество настроек, описанных в файле php.ini. Этот файл должен быть доступен в системных путях поиска для того, чтобы php мог использовать эти настройки. Обычно для этого достаточно хранить этот файл в том же каталоге, где расположен сам php, но если php сконфигурирован для работы в качестве модуля web-сервера, то этот файл необходимо скопировать в каталог, явно доступный в системных путях поиска. См. раздел инсталляции php для получения более подробных инструкций.

Здесь рассматриваются основные параметры php, разделенные по категориям. Список параметров в основном соответствует версии php 4.0.6, однако здесь рассматриваются только основные параметры. Полный список параметров с комментариями по каждому из них можно увидеть непосредственно в php.ini, а также в соответствующем разделе php manual.

Значения параметров, имеющих варианты "да/нет" могут быть следующими:

ДА - 1, on, true or yes
НЕТ - 0, off, false or no

Short_open_tag

Включение поддержки сокращенного варианта php тегов. Если эта опция отключена, то php код будет распознаваться только внутри тегов. Если включена - то разрешено использование тегов. Хорошим тоном считается не использовать сокращенной записи php тегов.

Включение поддержки asp тегов <% %> в качестве php тегов.

Output_buffering

Включение буферизированного вывода php. Использование буферизированного вывода позволит вам, к примеру, использовать любые функции, оперирующие с http header"ами (header(), setcookie()) в любом месте вашего скрипта, не заботясь о том, чтобы не выводить ничего до этого. Вы можете управлять буферизированным выводом и из ваших скриптов (см. раздел output control functions в php manual). Помните, что при включенной буферизации вывода результат работы скрипта будет возвращен браузеру только после того, как будет закончена работа скрипта, что может привести к более медленной работе сайта.

Включение безопасного режима работы php. Безопасный режим запрещает скриптам производить любые действия, которые являются небезопасными для сервера, на котором работает php. Очень подробно безопасный режим работы php рассматривается в php manual.

Max_execution_time

Максимальное время работы php скрипта (в секундах). Спустя это время работа скрипта будет принудительно завершена и выдана соответствующая ошибка. Позволяет избежать проблем с "зациклившимися" скриптами.

Максимальный объем памяти, который может быть выделен для нужд скрипта. Также позволяет избежать проблем с "зациклившимися" скриптами.

Error_reporting

Маска для сообщений об ошибках, которые должны генерироваться php. Задается в виде логического выражения с использованием набора предопределенных констант, описывающих различные типы ошибок. Список этих констант, а также правила задания выражений можно найти в php.ini.

Display_errors

Определяет, нужно ли выводить сообщения об ошибках на экран. Обычно эта опция включается во время написания php скриптов, для того, чтобы иметь возможность видеть сообщения об ошибках, а на реальных серверах в интернете она обычно выключена по соображениям безопасности.

Если включена эта опция, то все ошибки будут записываться в log файл, определенный следующей опцией.

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

Если включена эта опция, то текст последней ошибки будет всегда доступен из переменной $php_errormsg.

Register_globals

Этот параметр определяет, будут ли т.н. egpcs переменные (environment, get, post, cookies, session) доступны в виде глобальных переменных php. Если этот параметр разрешен, то переменные доступ к этим переменным будет осуществляться также, как и к любым другим глобальным переменным php:

echo "Версия http протокола: " . $server_protocol ;
echo "Параметр query string: " . $param1 ;
echo "Элемент формы: " . $txtfirstname ;
echo "Мои cookie: " . $mycookie ;
echo . $mysessionvar ;

Или то же самое, но с отключенным параметром:

echo "Версия http протокола: " . $http_env_vars [ "server_protocol" ];
echo "Параметр query string: " . $http_get_vars [ "param1" ];
echo "Элемент формы: " . $http_post_vars [ "txtfirstname" ];
echo "Мои cookie: " . $http_cookie_vars [ "mycookie" ];
echo "Мои сессионные переменные: " . $http_session_vars [ "mysessionvar" ];

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

Php начинает работать немного быстрее, т.к. не тратится дополнительное время на создание множества переменных.
Нет риска того, что какие-то две переменные будут иметь одинаковые имена, что приведет к появлению ошибок в работе скрипта, которые будет очень сложно отловить в силу их неочевидности.
variables_order

Этот параметр используется в связке с предыдущим параметром и определяет, в какой последовательности производится регистрация глобальных egpcs переменных. Например, при значении по умолчанию (egpcs) переменные, переданные через get будут замещены переменными, переданными через post и имеющими то же имя. post-переменные (а также environment и get переменные) в свою очередь могут быть замещены значениями cookies с такими же именами и т.д.

Magic_quotes_gpc

Включение этого параметра приведет к тому, что все данные, поступающие со стороны клиента (через get, post или cookie) будут обработаны: все кавычки (" и ") в них будут замещены соответственно сочетанием " или ". С одной стороны это очень удобно, если планируется, например, вставлять эти данные в строки, передаваемые, например, sql серверу. Но с другой стороны это может привести к путанице, поэтому обычно надежнее использовать для этой цели функции addslashes() и stripslashes().

Magic_quotes_runtime

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

Magic_quotes_sybase

Включение этой опции приведет к тому, что одинарные кавычки (") будут сдваиваться (""). Это необходимо для некоторых sql серверов, которые поддерживают только такой способ вставки кавычек в строки (interbase, ms sql, sybase и некоторые другие).

Auto_prepend_file

Позволяет задать путь и имя файла, который будет автоматически добавляться в начало каждого php скрипта. Используется только если имеет непустое значение.

Auto_append_file

То же самое, что предыдущий параметр, но добавление содержимого файла производится в конец каждого php скрипта.

Путь к каталогу, где лежат модули php. Обычно это подкаталог extensions в корневом каталоге php.