Klasa Edit

namespace Kei\Webas\VPS\Cron

Klasa służy do dodania edycji zadania CRON dostępnego w panelu Webas pod adresem https://webas12345.tld.pl/Cron/Edit/.

Klasa dziedziczy bezpośrednio z obiektu AbstractActionResult.


Dostępne metody klasy

__construct($task_id)

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

  • $task_id - ID zadania CRON (pobrane za pomocą metody Index)

setDescription($description)
return Edit

Ustawia opis zadania CRON

getDescription()
return string

Zwraca opis dla zadania CRON.

setBlocked($blocked)
return Edit

Ustawia blokadę zadania CRON

getBlocked()
return string

Zwraca opis dla zadania CRON.

setCronEntry($cron_entry)
return Edit

Ustawia właściciela zadania CRON
$cron_entry → Ustawia regułę CRON (jak korzystać ?)

getCronEntry()
return string

Pobiera regułę CRON

*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 wybranego zadania CRON (ID zadania pobrano za pomocą metody Index)
$result = $webas->Cron()->
    Edit("admin-1bcc28b14ea04956a8719489ee0fdd89")->
    setCronEntry("* */4 * * * wget example.com >> /dev/null 2>&1")->
    setDescription("Nowy cron ".rand(100,999))->
    execute();

\Kei\Library\Out::vd($result->getActionResult());

Klasa Edit · NiceAPI dla PHP 5.6