Классы и функции модуля

Класс nc_auth

Это основной класс для работы с модулем. Объект этого класса доступен в глобальной области видимости по имени $nc_auth.

Так же объект этого класса можно получить так:

$nc_auth = nc_auth::get_object();

Методы класса

auth_form ( $params = array(), $template = array() )

Возвращает форму авторизации для неавторизированного пользователя и приветствие для авторизированного.

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

Первый параметр представляет собой ассоциативный массив с ключами:

• form_type — тип формы:

  • v – вертикальная ( по умолчанию )

  • h – горизонтальная

  • t- табличная

• submit_name — надпись на кнопке «Авторизоваться»

• captcha_wrong — надпись при неправильной введеной каптчи

• login_wrong — надпись при неправильно введеном логине

• auth_text — название блока «Авторизация»

• login_text — надпись «Логин»

• reg_text — надпись «Регистрация»

• pass_text — надпись «Пароль»

• recovery_text — надпись «Забыли пароль»

• hide_register_link — скрывать ссылку на регистрацию

• login_save — запомнить пароль:

• auto — checkbox не показывается, но пароль запоминается

• checked — показывается отмеченный checkbox

• none – не показывается

Все параметры являются необязательными.

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

Второй параметр также представляет с собой ассоциативный массив:

• auth_form — форма автризации, в ней доступны следующие макропеременные:

  • %form_id — id формы

  • %action — action формы

  • %register_link — ссылка на регистрацию

  • %recovery_link — ссылка на восстановление пароля

  • %login_save — блок «запомнить меня»

  • %token_form — блок авторищации по токену

  • %vk_form – блок авторизации через ВКонтакте

  • %fb_form – блок авторизации через Facebook

  • %twitter_form – блок авторизации через Twitter

  • %openid_form – блок авторизации через OpenID

• login_save — блок «запомнить меня», если на задан, используется код по умолчанию

• vk_form – форма авторизации через Вконтакте, если не задан — берется код по умолчанию

• fb_form – форма авторизации через Facebook если не задан — берется код по умолчанию

• twitter_form – форма авторизации через Twitter, если не задан — берется код по умолчанию

• openid_form – форма авторизации через OpenID, если не задан — берется код по умолчанию

• token_form – форма авторизации через токен, значения по умолчанию нет

• authorized — шаблон вывода приветствия, доступны следующие макромепеременные:

• %login — логин или имя пользователям

• %profile_link — ссылка на профайл

• %exit_link — ссылка на деавторизацию ( выход )

• %messages — информер о личных сообщениях

• messages — шаблон вывода сообщения о том, что нет новых сообщений ( этот код как раз и заменяет макропеременную %messages в предыдущем шаблоне)

• %msg_url — ссылка на личные сообщениях

• %msg_new — количество новых сообщения

• messages_new — шаблон вывода сообщения о том, что новые сообщения есть ( как и в предыдущем случае, этот код заменяет %messages ), доступны следующие макропеременные:

Все шаблоны, кроме token_form, имеют значения по умолчанию. Если вам надо изменить, допустим, только вывод информера о новых сообщения, то в метод надо передавать только шаблон messages_new:

$nc_auth->auth_form( null, array ('messages_new' => 'Есть новые сообщения!'))

Примеры использования в макете дизайна:

<?=$nc_auth->auth_form().
$nc_auth->auth_form( array('form_type' => 't') ).
$nc_auth->auth_form( null, array('authorized' => "Вы авторизированы как %login") );?>

auth_links ( $params = array(), $template = array() )

Метод возвращает HTML-код со ссылками на регистрацию и авторизацаию для неавторизированного пользователя, и приветствие для авторизированного.

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

$nc_auth->auth_links( null, array('auth_link_form' = > 'Авторизация и Регистрация'))

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

Общие функции

nc_auth_profile_url( [mixed $User_ID, [int $allow_keyword]])

Функция возвращает путь (-и) к профайлу пользователя (-ей) от корня.

Параметр $User_ID — это целое число или массив значений с идентификатором (-ами) пользователей, а флаг $allow_keyword указывает, учитывается ли keyword пользователя или нет (по умолчанию — нет).