Przejdź do głównej treści

Tworzenie własnych komend

Ready_™ Developer TeamMniej niż 1 minutaWorkflowWłasne komendy workflow

Do systemu można dodawać własne komendy, poprzez dodanie pliku do katalogu apps/edokumenty/commands. Plik powinien mieć postać pliku z rozszerzeniem .inc i zawierać klasę finalną z przedrostkiem UC oraz przyrostkiem Command np. UCMyCommand należy również pamiętać aby nazwa pliku była taka sama jak nazwa klasy np. UCMyCommand.inc

Przykładową klasę znajdziemy również w swoim systemie eDokumenty wystarczy, że przejdziemy do katalogu w którym znajdują się komendy i odszukamy plik ExampleCommand.example. Klasa ta jest o wiele większa od prezentowanej. Każda użyta w niej funkcja jest również dobrze udokumentowana w komentarzu. Zanim zaczniemy pisać swoją komendę należy zrobić kopię pliku ExampleCommand.example i zmienić nazwę tej kopi na UC<nasza nazwa>Command.inc np. UCMyCommand.inc następnie odtwórzmy ten plik i zmieńmy nazwę klasy na taką samą jak nazwa pliku.

Jeśli tego pliku nie znajdziemy, zawsze możemy go pobrać. Również należy zrobić kopię oraz zmienić nazwę pliku jak i klasy na własną, zachowując powyższe zasady.

Przykład UCExampleCommand.inc

Możemy na podstawie tej klasy stworzyć swoją własną komendę, ale najpierw zróbmy kopię tego pliku i zmieńmy jego nazwę zgodnie z podanymi wyżej standardami. Nigdy nie modyfikujemy tego przykładu.

Efektem naszej pracy będzie pojawienie się na liście dostępnych komend naszej komendy - Moja nowa komenda

Własne komenda
Własne komenda