Skip to content

Latest commit

 

History

History
100 lines (54 loc) · 5.28 KB

README-ru.md

File metadata and controls

100 lines (54 loc) · 5.28 KB
Raw

#Модуль Kohana CheatSheet

Краткое описание: модуль для компактного отображения доступных классов, их свойств и методов

Текущая версия: 0.5

Демонстрация возможностей: http://ko3.kupreev.com/cs

Автор: Александр Купреев

Электронная почта: alexander точка kupreev собака gmail точка com

##Требования

  1. PHP-фреймворк Kohana 3.1.0+
  2. Наличие включенного модуля userguide.

##Установка

  1. Разархивируйте папку с модулем в директорию <путь к Kohana>/modules/
  2. Добавьте в файл <путь к Kohana>/application/botstrap.php в параметр-массив метода Kohana::modules() элемент 'cheatsheet' => MODPATH.'cheatsheet',

##Использование модуля

Перейдите браузером на страницу http://example.com/cs

По клику на вопросительном знаке около имени класса показывается блок с описанием класса

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

Вы можете изменять масштаб страницы и, тем самым, масштаб текста и количество колонок на экране.

Вы можете вручную обновить кэш, кликнув по ссылке "Invalidate cache" внизу страницы.

Вы можете указать в конфигурационном файле модуля (<путь к Kohana>/modules/cheatsheet/config/cs.php):

  1. классы, которые не нужно отображать на странице (в том числе, используя маски с '*'). В настоящей версии разрешено задавать точное название класса для игнорирования (например, 'kohana_log') либо следующие маски:

    • начало имени класса (например, 'someword*' исключит из выдачи класс 'someword_about_love')

    • конец имени класса (например, '*someword' исключит из выдачи класс 'tell_me_someword')

    • наличие в имени класса (например, '*someword*' исключит из выдачи класс 'tell_me_someword_about_love')

  2. следует ли включать кэширование (TRUE или FALSE) -- я рекомендую включить (TRUE), поскольку кэш работает не по времени хранения (expiration time), а по реальной совокупности классов

##Примечания

В текущей версии модуль не предусматривает интернационализации — работа только с английским языком.

Модуль тестировался в браузерах Firefox 3.5+, Opera 10+

##Летопись изменений

###From v. 0.4

  • апдэйт jquery до 1.4.4

  • добавлена справка о классе

  • исправлена ошибка вывода стилей и скриптов

###С версии 0.3

  • совершенствование настроек исключения классов из списка

  • исправлена несовместимость с Kohana 3.0.6

###С версии 0.2

  • добавлен ручной сброс кэша

  • запрет каталогов для отображения классов

  • добавлена кнопка "закрыть" в блоке подсказки

###С версии 0.1

  • частично исправлен выход кода в описании параметра/метода за пределы блока

  • добавлено кэширование данных

  • небольшие дизайнерские изменения

##Использованный программный код

  1. Модуль использует обращения к классам модуля Kohana Userguide, кроме того, в некоторых местах используется частично модифицированный код из данного модуля.

  2. Модуль использует JavaScript-библиотеку jQuery (jQuery JavaScript Library) v1.4.4

    http://jquery.com/ Copyright (c) 2010 John Resig Dual licensed under the MIT and GPL licenses (http://docs.jquery.com/License)

  3. Модуль использует дополнение для jQuery Columnizer jQuery Plugin v1.4.0

    http://welcome.totheinter.net/columnizer-jquery-plugin/ Copyright (c) Adam Wulf Licensed under a Creative Commons Attribution 3.0 United States License (http://creativecommons.org/licenses/by/3.0/us/)