Klasa AppPanelCustomization

namespace Kei\Webas\Dedicated\SettingsPanel

Klasa służy do określenia pliku certyfikatu pośredniego, który zostanie później wykorzystany w panelu WebAs.

Wykorzystywana jest w klasie \Kei\Webas\Dedicated\SettingsPanel\Add

Klasa implementuje interfejs DumperInterface


Dostępne metody klasy

::Factory()
return AppPanelCustomization

Statyczna metoda zwracająca instancję klasy. Wzorzec projektowy Fabryka.

setBannerImageUrl($a)
return $this

Wskazana grafika zostanie użyta jako logo widoczne w lewym górnym rogu pulpitu po zalogowaniu się użytkownika. Rozmiar grafiki nie powinien przekraczać 247x50px. Jeśli obraz będzie zbyt duży, jego fragmenty mogą być niewidoczne.

UWAGA W przypadku braku własnego logo zostanie użyte domyślne logo.
$a → Podaj lokalizację do zewnętrznego żródła pliku obrazu (pamiętaj o https - zob. przykłady)

getBannerImageUrl()
return string

Pobiera aktualnie ustawiony adres URL do grafiki z logo

setCssExtraUrl($a)
return $this

Arkusz styli zostanie dołączony do panelu jako ostatni.
$a → Podaj lokalizację do zewnętrznego żródła pliku arkusza styli (pamiętaj o https - zob. przykłady)

getCssExtraUrl()
return string

Pobiera aktualnie ustawiony adres URL do dodatkowego arkusza styli

setLoginBannerImageUrl($a)
return $this

Wskazana grafika zostanie użyta jako logo widoczne powyżej formularza logowania się do panelu. Rozmiar grafiki nie powinien przekraczać 223x130px. Jeśli obraz będzie zbyt duży, jego fragmenty mogą być niewidoczne.

UWAGA W przypadku braku własnego logo zostanie użyte domyślne logo.
$a → Podaj lokalizację do zewnętrznego żródła pliku obrazu (pamiętaj o https - zob. przykłady)

getLoginBannerImageUrl()
return string

Pobiera aktualnie ustawiony adres URL do grafiki z logo (strona pulpit)

setSystemBanners($a)
return $this

Wyświetlaj domyślne logotypy Kei.pl
$a → Użyj enumeratora \Kei\Webas\YesNoEnum

getSystemBanners()
return string

Zwraca status prezentacji domyślnych logotypów Kei.pl

setSystemFaviconUrl($a)
return $this

Wyświetlaj domyślne logotypy Kei.pl
$a → Użyj enumeratora \Kei\Webas\YesNoEnum

getSystemFaviconUrl()
return string

Zwraca status prezentacji domyślnych logotypów Kei.pl

setThemeName($a)
return $this

Domyślny motyw kolorystyczny
$a → Użyj enumeratora \Kei\Webas\Dedicated\ColorPaletteEnum

getThemeName()
return string

Zwraca domyślny motyw kolorystyczny

*dump()
return Array

Zobacz więcej tutaj DumperInterface

Gwiazdka przed nazwą metody oznacza iż ta metoda jest własnością klasy rodzica (dziedziczącej).


Wyjątki

Przejdź do pełnej listy wyjątków

Pamiętaj o tym, aby zawsze być przygotowanym na zwrócenie wyjątku przez skrypt PHP niezależnie od tego jak bardzo małoprawdopodobnym uważasz jego wystąpienie.


Przykłady wykorzystania

W poniższym przykładzie pominięto autoryzację do serwera. Obiekt Client znajduje się w zmiennej $webas. Więcej o autoryzacji przeczytasz w dziale jak rozpocząć ?

Nie zawijaj wierszy<?php
// Autoryzacja...

// TIPS&TRICKS //
/*
    Podawaj ścieżki do plików (obrazy, css, js) z wykorzystaniem https (o ile masz prawidłowy
    certyfikat), aby uniknąć blokowania niezabezpieczonej treści na zabezpieczonej stronie (WebAs)
*/

// Ustawienia personalizacji panelu WebAs
$webas->SettingsPanel()->
    Edit()->
    setAppPanelCustomizationValue(\Kei\Webas\Dedicated\SettingsPanel\AppPanelCustomization::Factory()->
        setBannerImageUrl('https://example.com/path/banner1.jpg')->
        setCssExtraUrl('https://example.com/path/main.min.css')->
        setSystemFaviconUrl('https://example.com/path/favikonka.ico'))->
    execute();

Klasa AppPanelCustomization · NiceAPI dla PHP 5.6