Klasa Generate

namespace Kei\Webas\Dedicated\SecuritySsl

Klasa służy do generowanie żądania certyfikatu (CSR) analogicznie jak w panelu Webas pod adresem https://webas12345.tld.pl/SecuritySsl/Generate.

Klasa dziedziczy bezpośrednio z obiektu AbstractActionResult.


Dostępne metody klasy

__construct($a, $b, $c, $d)

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

  • $a → Ilość domen. Użyj enumeratora \Kei\Webas\Dedicated\SecuritySsl\WildcardEnum
  • $b → Domena certyfikatu (Common name) np. v12345.tld.pl. Możesz podać więcej domen podając zamiast ciągu znaku tablicę.
  • $c → Nazwa firmy (Organization name).
  • $d → Adres e-mail

setActionMode($a)
return $this

Rodzaj generowanego dokumentu
$a → Użyj enumeratora \Kei\Webas\Dedicated\SecuritySsl\ActionModeEnum

getActionMode()
return string

Zwraca rodzaj generowanego dokumentu

setFtpAccount($a)
return $this

Konto FTP, do którego będzie przypisany certyfikat.
$a → Nazwa konta FTP

getFtpAccount()
return string

Zwraca nazwę konta FTP

addDomain($a)
return $this

Domena certyfikatu (Common name). Metoda DODAJE nową domenę do listy
$a → Podaj ciąg znakowy (string)

setDomain($a)
return $this

Jedna lub więcej domena certyfikatu (Common name). Metoda napisuje aktualną listę domen
$a → Podaj ciąg znakowy (string) lub tablicę jeśli chcesz umieścić więcej domen

getDomain()
return string|array

Zwraca nazwy ustawionych domen

domainExistsOnList($a)
return bool

Sprawdza czy podana domena została umieszczona wcześniej już na liście
$a → Nazwa domeny

setCountryName($a)
return $this

$a → Nazwa kraju

getCountryName()
return string

Zwraca nazwę kraju

setEmailAddress($a)
return $this

$a → Adres e-mail

getEmailAddress()
return string

Zwraca adres e-mail

setKeyLength($a)
return $this

$a → Długość klucza. Użyj enumeratora \Kei\Webas\Dedicated\SecuritySsl\SslKeyLengthEnum

getKeyLength()
return int

Zwraca długość klucza

setLocalityName($a)
return $this

$a → Miasto (locality name)

getLocalityName()
return string

Zwraca nazwę miasta

setOrganizationName($a)
return $this

$a → Nazwa organizacji (Organization name)

getOrganizationName()
return string

Zwraca nazwę firmy

setOrganizationUnitName($a)
return $this

$a → Departament podanej firmy

getOrganizationUnitName()
return string

Zwraca nazwę departamentu

setStateName($a)
return $this

$a → Województwo (State or province name)

getStateName()
return string

Zwraca nazwę województwa

setWildcard($a)
return $this

$a → Ilość domen. Użyj enumeratora \Kei\Webas\Dedicated\SecuritySsl\WildcardEnum

getWildcard()
return string

Zwraca ilość domen

*execute()
return Generate

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

// Add CSR request
$webas->SecuritySsl()->
    Generate(\Kei\Webas\Dedicated\SecuritySsl\WildcardEnum::OneDomainWithSubdomains, ['qwerty.com', 'asdf.pl'], 'MojaFirmaNet', 'biuro@mojafirma.pl')->
    setFtpAccount('admin')->
    setActionMode(\Kei\Webas\Dedicated\SecuritySsl\ActionModeEnum::SelfSignedCertificate)->
    execute();

Klasa Generate · NiceAPI dla PHP 5.6