Rozdział 1. UI -- Interfejs Użytkownika

Rozdział 1. UI -- Interfejs Użytkownika
Poprzedni		Następny

Spis treści

display($title, $msg)
display_error($title, $msg)
get_single($plugname, $optname, $synopsis, $description, $default, @answers)
get_long($plugname, $optname, $synopsis, $description, $default)
get_password($plugname, $optname, $synopsis, $description, $default)

Wszelka interakcja z użytkownikiem powinna odbywać się przy wykorzystaniu interfejsów użytkownika. Zapewniają one odpowiednią funkcjonalność wymaganą przez wtyczki, a także dają użytkownikowi komfort korzystania z AddUser-NG w sposób taki jak chce lub taki jak musi.

API

`display($title, $msg)`

Wyświetl komunikat.

$title: Tytuł komunikatu.
$msg: Treść komunikatu.

`display_error($title, $msg)`

Wyświetl komunikat informujący o błędzie.

$title: Tytuł komunikatu.
$msg: Treść komunikatu.

`get_single($plugname, $optname, $synopsis, $description, $default, @answers)`

Wybór jednej opcji z kilku.

Metoda zwraca odpowiedź użytkownika (przekonwertowaną na małe litery) lub, w przypadku jej braku, wartość $default.

$plugname: Nazwa wtyczki. Powinna być taka sama jak nazwa moduły w którym się ona znajduje.
$optname: Nazwa opcji, o którą pytamy.
$synopsis: Krótki opis opcji. Powinien pochodzić prosto z dokumentu XML opisującego tę wtyczkę.
$description: Dłuższy opis opcji. Powinien pochodzić prosto z dokumentu XML opisującego tę wtyczkę.
$default: Wartość jaka zostanie zwrócona, gdy użytkownik nie udzieli żadnej odpowiedzi.
@answers: Lista odpowiedzi, z spośród których może wybierać użytkownik.

`get_long($plugname, $optname, $synopsis, $description, $default)`

Pobranie dłuższej odpowiedzi od użytkownika.

Metoda zwraca odpowiedź użytkownika lub, w przypadku jej braku, wartość $default.

$plugname: Nazwa wtyczki. Powinna być taka sama jak nazwa moduły w którym się ona znajduje.
$optname: Nazwa opcji, o którą pytamy.
$synopsis: Krótki opis opcji. Powinien pochodzić prosto z dokumentu XML opisującego tę wtyczkę.
$description: Dłuższy opis opcji. Powinien pochodzić prosto z dokumentu XML opisującego tę wtyczkę.
$default: Wartość jaka zostanie zwrócona, gdy użytkownik nie udzieli żadnej odpowiedzi.

`get_password($plugname, $optname, $synopsis, $description, $default)`

Pobranie hasła od użytkownika.

Metoda zwraca odpowiedź użytkownika lub, w przypadku jej braku, wartość $default.

$plugname: Nazwa wtyczki. Powinna być taka sama jak nazwa moduły w którym się ona znajduje.
$optname: Nazwa opcji, o którą pytamy.
$synopsis: Krótki opis opcji. Powinien pochodzić prosto z dokumentu XML opisującego tę wtyczkę.
$description: Dłuższy opis opcji. Powinien pochodzić prosto z dokumentu XML opisującego tę wtyczkę.
$default: Wartość jaka zostanie zwrócona, gdy użytkownik nie udzieli żadnej odpowiedzi.

Poprzedni		Następny
AddUser Next Generation -- Dokumentacja developerów	Spis treści	Wrappers