Вопросы Теги

Распределение маленького приложения PHP

Я рекомендую 2 инструмента, которые мне очень пригодились:
Typedoc
-> https://typedoc.org/
apiDoc
-> (веб-сайт) http://apidocjs.com
-> (очень крутое и простое руководство) https://speakerdeck.com/ rottmann / api-Documentation? slide = 12

Typedoc поможет вам с автоматическим извлечением из иерархии классов ваших проектов, другой поможет Вы с документацией API автоматически сгенерированы.

надеюсь, вы найдете здесь то, что вам нужно.

7
задан Robert Gamble 12 November 2008 в 16:01
поделиться

3 ответа

Конфигурация

Можно использовать php файл как это:

<?php
return array(
  'option1' =&gt; 'foobar',
  'option2' =&gt; 123,
  //and so on...
  );
?>

И в основном классе просто используйте:

$config = (array) include 'path/to/config/file';

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

Шаблонная обработка

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

I10N

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

Интеграция

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

ДОБЕРИТЕСЬ по сравнению с POST

Ваш класс использует пароли, и Вы даже думаете об отправке их через, ДОБИРАЮТСЯ?;) Думайте об истории браузера, заголовках ссылающегося домена и т.д. - пароли Ваших пользователей были бы видимы там.

7
ответ дан 6 December 2019 в 23:15
поделиться

  1. Конфигурация может быть локальна для экземпляров класса? Или Вы могли создать немного класса, из которого Вы могли создать экземпляр запросить для значений конфигурации? Также предварительно ожидая любой глобальный Вар с Вами название приложения должно пойти некоторым путем для остановки столкновений.

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

  3. Для 3 строк? Да сделайте их тот же способ, которым Вы обрабатываете конфигурацию.

  4. Хорошие комментарии повсюду с введением, объясняющим, как Вы используете класс.

  5. Я так не думаю. Если это беспокоит Вас, Вы могли бы использовать параметры по умолчанию для использования данный аргументы сначала, то искать, ПОЛУЧАЮТ/POST значения, если ни один не обеспечивается (хотя это могло бы быть угрозой безопасности),

Существуют другие вещи учесть. Много людей находится на общих хостах и в результате не управляет их php.ini или их php версией. Необходимо удостовериться, что Вы только используете функции, которые максимально распространены.

Один пример - то, что shorttags не включены на некоторых хостах (необходимо использовать <?php ... ?> и <?php echo "..."?> вместо <? ... ?> или <?= "..." ?>) который может быть королевским ЛАВАШЕМ.

2
ответ дан 6 December 2019 в 23:15
поделиться

В дополнение к хорошему совету Krzysztof:

  • Использовать <?php только
  • Если Вы используете функции, которые могут быть отключены, использовать function_exists() для обеспечения они доступны. @missing_function() заставляет PHP умереть тихо без любой зарегистрированной ошибки.
  • Вы не можете полагаться на вещи, которые могут быть отключены/изменены через php.ini. Использовать ini_get() адаптироваться к различным настройкам.
  • Если magic_quotes включены, разделяют наклонные черты только на из Вашей копии входа – не изменяют глобальные массивы! Безопасность некоторого хромого кода может полагаться на эти присутствующие наклонные черты.
  • Ожидайте, что пользователи будут бессмысленно copy&paste код из Вашей документации/веб-сайта.
2
ответ дан 6 December 2019 в 23:15
поделиться
Другие вопросы по тегам:

Похожие вопросы: