Klasa Add

namespace Kei\Webas\Dedicated\SecuritySsl

Klasa służy do dodania nowego certyfikatu SSL analogicznie jak w panelu Webas pod adresem https://webas12345.tld.pl/SecuritySsl/Add.

Klasa dziedziczy bezpośrednio z obiektu AbstractActionResult.

Dostępne metody klasy

__construct($a, $b, $c)	Konstruktor dzięki któremu utworzysz nowy obiekt klasy. $a → Plik z certyfikatem. Użyj obiektu \Kei\Webas\Dedicated\SecuritySsl\CertificateAuthorityProvider $b → Plik z kluczem. Użyj obiektu \Kei\Webas\Dedicated\SecuritySsl\CertificateAuthorityProvider $c → Nazwa konta FTP
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 Add*	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...

// Dodanie nowego certyfikatu SSL...
// Plik z certyfikatem
$cert = \Kei\Webas\Dedicated\SecuritySsl\ExternalFile::Factory()->
    setFilePath('moja/lokalizacja/6ec30ad735f01024d8498cbd4759992d.cer');

// Plik z kluczem
$key = \Kei\Webas\Dedicated\SecuritySsl\ExternalFile::Factory()->
    setFilePath('moja/lokalizacja/private.key');

// Połączenie wszystkiego w całość i zapisanie certyfikatu na stałe na serwerze
$webas->SecuritySsl()->
    Add($cert, $key, 'g5dg0abi')->
    execute();

Klasa Add

namespace Kei\Webas\Dedicated\SecuritySsl

Dostępne metody klasy

__construct($a, $b, $c)

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 Add

*getActionResult()

return bool

Wyjątki

Przykłady wykorzystania

Newsletter NiceAPI

Produkt

Wsparcie

Kontakt

Dołącz do nas

Menu