Klasa Edit

namespace Kei\Webas\Dedicated\SecuritySsl

Klasa służy do edycji ustawień certyfikatu SSL analogicznie jak w panelu Webas pod adresem https://webas12345.tld.pl/SecuritySsl/Edit/<id>.

Klasa dziedziczy bezpośrednio z obiektu AbstractActionResult.

UWAGA! Dla zachowania bezpieczeństwa skorzystaj najpierw z metod zaczynających się od has np. hasKeyPassword, aby dowiedzieć się czy edycja tego certyfikatu wspiera wybraną funkcję do której chcesz się odnieść.

Dostępne metody klasy

__construct($a)	Konstruktor dzięki któremu utworzysz nowy obiekt klasy. $a → Identyfikator certyfikatu. Pobierzesz go z obiektu InfoTable.
hasCertificateFile() return bool	Czy istnieje możliwość wgrania nowego certyfikatu ?
hasKeyFile() return bool	Czy istnieje możliwość wgrania nowego klucza certyfikatu ?
hasKeyPassword() return bool	Czy istnieje możliwość zmiany hasła klucza certyfikatu ?
hasCertificateAuthorityProvider() return bool	Czy istnieje możliwość zmiany certyfikatu pośredniego (tzw. CA) ?
hasInstallOnDomain() return bool	Czy istnieje możliwość zmiany/wyboru opcji instalacji certyfikatu na domenach ?
hasInstallOnDomain() return bool	Czy istnieje możliwość zmiany/wyboru opcji instalacji certyfikatu na IP ?
hasFtpAccess() return bool	Czy istnieje możliwość zmiany/wyboru opcji udostępnienia certyfikatu innym kontom FTP ?
hasFtpAccount() return bool	Czy istnieje możliwość zmiany właściciela (konto FTP) certyfikatu SSL ?
setCertificateFile($a) return $this	Prześlij plik z certyfikatem. $a → Plik certyfikatu. Użyj obiektu \Kei\Webas\Dedicated\SecuritySsl\ExternalFile
getCertificateFile() return ExternalFile\|null	Zwraca informacje nt. pliku certyfikatu
setKeyFile($a) return $this	Prześlij plik z kluczem. $a → Plik klucza. Użyj obiektu \Kei\Webas\Dedicated\SecuritySsl\ExternalFile
getKeyFile() return ExternalFile\|null	Zwraca informacje nt. pliku klucza
setFtpAccess($a) return $this	Zdecyduj czy certyfikat ma być dostępny do użytku dla innych kont FTP, czyli będą mogli go instalować we własnych domenach. $a → Użyj enumeratora \Kei\Webas\YesNoEnum
getFtpAccess() return string	Zwraca informacje o dostępności do użytku przez konta FTP
setFtpAccount($a) return $this	Konto FTP, do którego będzie przypisany certyfikat. Użytkownik tego konta samodzielnie może zarządzać certyfikatami do niego przypisanymi poprzez własny panel. $a → Nazwa konta FTP
getFtpAccount() return string	Zwraca nazwę konta FTP
setInstallOnDomain($a) return $this	Instalacja certyfikatu w domenach po jego dodaniu. Uwaga! Certyfikat zostanie zinstalowany tylko na tych stronach WWW, które pasują do certyfikatu. Certyfikat może być zainstalowany w każdej pasującej domenie, bez wględu na to z jakiego certyfikatu korzysta w chwili obecnej lub tylko w tych pasujących domenach, które nie posiadają jeszcze własnego certyfikatu. $a → Użyj enumeratora \Kei\Webas\YesNoEnum
getInstallOnDomain() return string	Zwraca informacje nt. instalacji certyfikatu w domenach
setInstallOnIp($a) return $this	Instalacja certyfikatu na adresie IP po jego dodaniu. $a → Użyj enumeratora \Kei\Webas\YesNoEnum
getInstallOnIp() return string	Zwraca informacje nt. instalacji certyfikatu na adresie IP
setPassword($a) return $this	Hasło do klucza (jeśli jest niepuste). Jeśli hasło jest zakodowane konieczne jest podane hasła, jakie zostało użyte podczas jego tworzenia. $a → hasło do klucza
getPassword() return string	Zwraca informacje nt. hasła do klucza. UWAGA! Ta metoda nie odczytuje już raz zapisanego hasła do klucza na serwerze.
execute() return Edit*	Bezparametrowa metoda zatwierdzająca i wykonująca akcję opisaną główną funkcją tej klasy.
getActionResult() return bool*	Bezparametrowa metoda zwracająca status ostatniej operacji.

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...

// Edycja certyfikatu o wybranym identyfikatorze
$cert = $webas->SecuritySsl()->Edit('af06d58cb8d0e1475b608b28f81440e6');

// Czy jest opcja zmiany pliku z certyfikatem ?
if($cert->hasCertificateFile())
{
    $cert_file = \Kei\Webas\Dedicated\SecuritySsl\ExternalFile::Factory()->
    setFilePath('moja/lokalizacja/6ec30ad735f01024d8498cbd4759992d.cer');

    $cert->setCertificateFile($cert_file);
}

// Czy jest opcja zmiany pliku z kluczem ?
if($cert->hasKeyFile())
{
    $key_file = \Kei\Webas\Dedicated\SecuritySsl\ExternalFile::Factory()->
    setFilePath('moja/lokalizacja/private.key');

    $cert->setKeyFile($key_file);
}

// Czy jest opcja zmiany konta FTP ?
if($cert->hasFtpAccount()) { $cert->setFtpAccount('admin'); }

// Wykonanie edycji i zastosowanie zmian w wybranym certyfikacie
$result = $cert->execute()->getActionResult();
\Kei\Library\Out::vd($result);

Klasa Edit

namespace Kei\Webas\Dedicated\SecuritySsl

Dostępne metody klasy

__construct($a)

hasCertificateFile()

return bool

hasKeyFile()

return bool

hasKeyPassword()

return bool

hasCertificateAuthorityProvider()

return bool

hasInstallOnDomain()

return bool

hasInstallOnDomain()

return bool

hasFtpAccess()

return bool

hasFtpAccount()

return bool

setCertificateFile($a)

return $this

getCertificateFile()

return ExternalFile|null

setKeyFile($a)

return $this

getKeyFile()

return ExternalFile|null

setFtpAccess($a)

return $this

getFtpAccess()

return string

setFtpAccount($a)

return $this

getFtpAccount()

return string

setInstallOnDomain($a)

return $this

getInstallOnDomain()

return string

setInstallOnIp($a)

return $this

getInstallOnIp()

return string

setPassword($a)

return $this

getPassword()

return string

*execute()

return Edit

*getActionResult()

return bool

Wyjątki

Przykłady wykorzystania

Newsletter NiceAPI

Produkt

Wsparcie

Kontakt

Dołącz do nas

Menu