Klasa Add

namespace Kei\Webas\VPS\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)

Konstruktor dzięki któremu utworzysz nowy obiekt klasy.

setCertificateFile($a)
return $this

Prześlij plik z certyfikatem.
$a → Plik certyfikatu. Użyj obiektu \Kei\Webas\VPS\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\VPS\SecuritySsl\ExternalFile

getKeyFile()
return ExternalFile|null

Zwraca informacje nt. pliku klucza

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\VPS\SecuritySsl\ExternalFile::Factory()->
    setFilePath('moja/lokalizacja/6ec30ad735f01024d8498cbd4759992d.cer');

// Plik z kluczem
$key = \Kei\Webas\VPS\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)->
    execute();

Klasa Add · NiceAPI dla PHP 5.6