Adriano Ferreira > DateTime-Cron-Simple-0.3 > DateTime::Cron::Simple

Download:
DateTime-Cron-Simple-0.3.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  1
View/Report Bugs
Module Version: 0.3   Source  

NAME ^

DateTime::Cron::Simple - Parse a cron entry and check against current time

SYNOPSIS ^

  use DateTime::Cron::Simple;

  $c = DateTime::Cron::Simple->new($cron);

  $boolean = $c->validate_time;

  $c->new_cron($cron);

DESCRIPTION ^

This module is a quick and dirty way to determine if a cron time format is valid for the current date and time.

A cron entry follows the cron format from crontab(5).

The validate_time function uses the current date and time for comparison, but will also accept a valid DateTime object as a parameter.

FUNCTIONS

new
    $c = DateTime::Cron::Simple->new('0-59/2 10,12 * * 5');

Creates a cron entry.

new_cron
    $c->new_cron($cron);

Updates the cron entry to the given argument.

validate_time
    $boolean = $c->validate_time;
    $boolean = $c->validate_time($dt);

Validates a datetime against the cron entry. If the argument is ommitted, it validates against the current time (DateTime-now>).

_parse_cron_field
    $data = $c->_parse_cron_field($field, $min, $max)

EXAMPLE ^

  use DateTime::Cron::Simple;

  $c = DateTime::Cron::Simple->new('0-59/2 10,12 * * 5');

  if($c->validate_time) { ... }

  $c->new_cron('* * 1 * 0');

  if($c->validate_time) { ... }

SEE ALSO ^

   DateTime::Event::Cron

It is very likely that this module will soon be deprecated. It was created without coordination with the developers of DateTime modules, which may be reached via

   http://datetime.perl.org/
   datetime@perl.org (the mailing list)

This module would better belong to the DateTime::Event namespace or else have its functionality incorporated into DateTime::Event::Cron. This release is transitional, while the right way to do it is being studied.

AUTHORS/MAINTAINERS ^

The original author of this module is

Brendan Fagan <suburbanantihero (at) yahoo (dot) com>.

At version 0.3, a full rewrite was done to set it free from license issues. The current maintainer is

Adriano Ferreira <ferreira (at) cpan (dot) org>.

Comments, bug reports, patches and flames are still appreciated.

COPYRIGHT AND LICENSE ^

Brendan Fagan holds the copyright from 2002 to 2006 over versions 0.1 and 0.2 of the distribution.

Copyright (C) 2006 by A. R. Ferreira

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

syntax highlighting: