Scroll to navigation

App::Dochazka::CLI::Commands::Schedule(3pm) User Contributed Perl Documentation App::Dochazka::CLI::Commands::Schedule(3pm)

NAME

App::Dochazka::CLI::Commands::Schedule - Schedule commands

PACKAGE VARIABLES

FUNCTIONS

The functions in this module are called from the parser when it recognizes a command.

Command handlers

The routines in this section are called as command handlers.

schedule_all

    SCHEDULE ALL
    SCHEDULE ALL DISABLED

show_schedule_as_at

    SCHEDULE
    EMPLOYEE_SPEC SCHEDULE
    SCHEDULE _DATE
    EMPLOYEE_SPEC SCHEDULE _DATE

add_memsched_entry

    SCHEDULE _DOW _TIME _DOW1 _TIME1
    SCHEDULE _DOW _TIME _HYPHEN _DOW1 _TIME1
    SCHEDULE _DOW _TIMERANGE

replicate_memsched_entry

    SCHEDULE ALL _TIMERANGE

Apply timerange to all five days MON-FRI

clear_memsched_entries

    SCHEDULE CLEAR

fetch_all_schedules

    SCHEDULES FETCH ALL 
    SCHEDULES FETCH ALL DISABLED

Get all schedules and dump them to the screen.

dump_memsched_entries

Dumps "memsched" (i.e. working schedule stored in memory) to the screen.

Note that App::Dochazka::CLI will happily let you build up a completely illegal and nonsensical schedule in memory, and submit it to the REST server. Data integrity controls for new schedule records are performed on server-side.

    SCHEDULE DUMP
    SCHEDULE MEMORY

schedule_new

Submits the "memsched" (i.e. working schedule stored in memory) to the REST server via 'POST submit/new'.

    SCHEDULE NEW

assign_memsched_scode

    SCHEDULE SCODE _TERM

Assign an 'scode' value to the "memsched" (local memory buffer) schedule.

schedulespec

    SCHEDULE_SPEC
    SCHEDULE_SPEC SHOW

schedulespec_remark

    SCHEDULE_SPEC REMARK _TERM

schedulespec_scode

    SCHEDULE_SPEC SCODE _TERM

Helper functions

Functions called by multiple command handlers

_canonicalize_th

The canonical form is "SCHEDULE _DOW _TIME _DOW1 _TIME1" so if we get one of the other forms, we "canonicalize th"

_clear_memsched_entries

Since clear_memsched_entries is a command handler, if we want to call it from within this module we have to use a special argument. Thus we can have our cake and eat it, too.

_dump_memsched_entries

Since dump_memsched_entries is a command handler, if we want to call it from within this module we have to use a special argument. Thus we can have our cake and eat it, too.

2016-09-15 perl v5.40.0