Zmienne użytkownika

Phiend umożliwia ustawienie akcji a następnie, uzyskanie dostępu do zmiennych. Zmienne te mogą być użyte do zapamiętywania informacji między akcjami lub między żądaniami. Każda zmienna posiada nazwę oraz wartość. Jej nazwa powinna być ciągiem i nie może zaczynać się od _phiend_'. Wartość zmiennej może być jakakolwiek - bardziej pierwotnym rodzajem, matrycą czy nawet obiektem. Do operowania zmiennymi użytkownika używa się trzech metod podstawowej klasy akcji:

mixed _getUserVar(string $varName)

Wyszukuje wartość zmiennej użytkownika. Jeśli wartość taka nie istnieje, zawracana jest jako NULL. Argument $varName to nazwa zmiennej użytkownika, jaka ma być wyszukana.

boolean _setUserVar(string $varName, mixed $varValue, boolean $permanent = false)

Ustawia wartość zmiennej użytkownika, jako wartość podana. Jeśli taka wartość już istnieje, zostaje ona nadpisana. Argument $permament używany jest, aby zaznaczyć, że dana zmienna ma być umieszczona w sesji użytkownika. Jeśli argument ten określony jest jako false, znaczy to, że zmienna dostępna będzie dla wszystkich akcji jedynie podczas wówczas aktualnego żądania. Jeśli jest to true, będzie ona dostępna dla wszystkich akcji podczas wszystkich żądań, używających tej samej sesji, jak długo sesja jest ważna (aktualna) lub zmienna jest usunięta. Zauważ, że jeśli zmienna o danej nazwie już istnieje, będzie ona zastąpiona, nie zważając na zasięg (nieważne, czy jest on trwały, czy nie). Niemożliwe jest posiadanie dwóch zmiennych o tej samej nazwie: jednej trwałej, a drugiej nie.

boolean_removeUserVar(string $varName)

Usuwa zmienną użytkownika o danej nazwie. Jeśli zmienna taka nie istnieje, zostaje zwrócona jako false. W innym przypadku - jako true. Zauważ, że zmienna zostanie usunięta, nieważne, czy jest trwała, czy też nie.

Właściwości

Właściwości to zmienne ustawiane przez Phiend'a, a dostępne w twoich akcjach. Liczba właściwości jest ograniczona, a nowe nie mogą być ustawiane. Nie mogą one także być w jakikolwiek zmieniane przez twoje akcje. Jako, że w Phiend'zie właściwości są niezbędne, zmienianie ich może przynieść katastrofalne rezultaty.

• Dostepne właściwościUserName (nazwa użytkownika)Nazwa użytkownika aktualnie zalogowanego. Jeśli nie ma takich użytkowników (ponieważ nie korzystasz z uwierzytelnienia lub akcja nie wymaga żadnych ról), właściwość ta ustawiona jest jako '' ( pusty string)UserRoles (role użytkownika)Role użytkownika, aktualnie zalogowanego. Jeśli nie ma w danej chwili takiego użytkownika, ponieważ nie korzystasz z uwierzytelnienia lub akcja nie wymaga żadnych ról) właściwość ta ustawiona jest jako '' ( pusty string). Jednak, ta właściwość może być również ustawiona, jako pusty string jeśli powiodło się uwierzytelnienie użytkownika, ale nie posiada on żadnych ról.RequiredRoles (wymagane role)Role, jakie są wymagane przez aktualne uruchomioną akcję. Jeśli akcja nie wymaga ról jest to '' (pusty ciąg).ActionChain (łańcuch akcji)Tablica zawierająca nazwy dotychczas wykonanych akcji z łańcucha. Włączona jest w to aktualnie uruchomiona akcja - jest traktowana, jako ostatni element tablicy. Zauważ, że jeśli dana akcja wywołuje bezpośrednio jakąś inną (np. przy użyciu metody _callAction w klasie akcji podstawowych), wywoływana akcja nie jest już w ten sposób włączana.AuthResults (efekty uwierzytelnienia)Tablica, zawierająca wyniki uwierzytelnienia dla wszystkich akcji do tej pory wykonanych w łańcuchu akcji. Może to być jedna z następujących stałych:
  • _PHIEND_AUTH_NO_USER, _PHIEND_AUTH_BAD_PASSWORD lub _PHIEND_AUTH_FAILURE opisanye w "Sterownikach uwierzytelnienia"
  • _PHIEND_AUTH_INSUFFICIENT_ROLES - jeśli uwierzytelnienie użytkownika powiodło się, ale posiadane przez niego role nie są wystarczające, aby uzyskać dostęp do żądanej akcji.
  • _PHIEND_AUTH_OK - gdy uwierzytelnienie kończy się sukcesem
  Właściwość ta używana jest głównie w sytuacji, gdy uwierzytelnienie kończy się niepowodzeniem i wykonana zostaje akcja zastępcza ( fallback) Akcja ta może następnie zapytywać tę właściwość, aby przekonać się, jaki był powód niesprawności i wyświetlić odpowiednią wiadomość użytkownikowi.Errors (Błędy)Układ zawierający wszystkie błędne wiadomości które zostały zapamiętane przez Phiend'a. To, które z błędów zostaną zapamiętane, zależy od wartości opcji store-level pliku konfiguracyjnego. Każda pozycja w tym układzie jest tablicą asocjacyjną, zawierającą pola:
  • 'file': nazwa pliku, w którym wyzwolony został błąd
  • 'line': numer wiersza, w którym wyzwolony został błąd
  • 'code': kod błędu (jeden ze stałych E_something w PHP)
  • 'message': błędna wiadomość
• Dostęp do właściwościKlasa podstawowych akcji zawiera tylko jedną funkcję współpracującą z właściwościamimixed_getProperty(string $propName)Wyszukuje ona właściwość o danej nazwie. Zauważ, że nazwy właściwości nie rozróżniają dużych i małych liter. Jeśli dana właściwość nie istnieje, jest zwracana jako NULL