DUPUIS Arnaud > Slackware-Slackget > Slackware::Slackget::Date

Download:
Slackware-Slackget-0.17.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  1
View/Report Bugs
Module Version: 1.0.1   Source  

NAME ^

Slackware::Slackget::Date - A class to manage date for slack-get.

VERSION ^

Version 1.0.1

SYNOPSIS ^

This class is an abstraction of a date. It centralyze all operation you can do on a date (like comparisons)

    use Slackware::Slackget::Date;

    my $date = Slackware::Slackget::Date->new('day-name' => Mon, 'day-number' => 5, 'year' => 2005);
    $date->year ;
    my $status = $date->compare($another_date_object);
    if($date->is_equal($another_date_object))
    {
        print "Nothing to do : date are the same\n";
    }

CONSTRUCTOR ^

new

The constructor take the followings arguments :

        day-name => the day name in : Mon, Tue, Wed, Thu, Fri, Sat, Sun
        day-number => the day number from 1 to 31. WARNINGS : there is no verification about the date validity !
        month-name  => the month name (Jan, Feb, Apr, etc.)
        month-number => the month number (1 to 12)
        hour => the hour ( a string like : 12:52:00). The separator MUST BE ':'
        year => a chicken name...no it's a joke. The year as integer (ex: 2005).
        use-approximation => in this case the comparisons method just compare the followings : day, month and year. (default: no)

You have to manage by yourself the date validity, because this class doesn't check the date validity. The main reason of this, is that this class is use to compare the date of specials files.

So I use the predicate that peoples which make thoses files don't try to do a joke by a false date.

        my $date = Slackware::Slackget::Date->new(
                'day-name' => Mon, 
                'day-number' => 5, 
                'year' => 2005,
                'month-number' => 2,
                'hour' => '12:02:35',
                'use-approximation' => undef
        );

FUNCTIONS ^

compare

This mathod compare the current date object with a date object passed as parameter.

        my $status = $date->compare($another_date);

The returned status is :

        0 : $another_date is equal to $date
        1 : $date is greater than $another_date
        2 : $date is lesser than $another_date

compare_ng

This method behave exactly the same way than compare() but is compliant with '<=>' and 'cmp' Perl operators.

Instead of returning 2 if left operand is lesser than the right one, it return -1.

The purpose of not modifying compare() directly is the backward compatibility.

is_equal

Take another date object as parameter and return TRUE (1) if this two date object are equal (if compare() return 0), and else return false (0).

        if($date->is_equal($another_date)){
                ...do something...
        }

WARNING : this method also return undef if $another_date is not a Slackware::Slackget::Date object, so be carefull.

_fill_undef [PRIVATE]

This method is call by the constructor to resolve the month equivalence (name/number).

This method affect 0 to all undefined numerical values.

today

This method fill the Slackware::Slackget::Date object with the today parameters. This method fill the followings object value : day-number, year, month-number,

        $date->today ;
        print "Today date is ",$date->to_string,"\n";

to_xml

return the date as an XML encoded string.

        $xml = $date->to_xml();

to_XML (deprecated)

same as to_xml() provided for backward compatibility.

to_html

return the date as an HTML encoded string.

        $xml = $date->to_html();

to_HTML (deprecated)

same as to_html() provided for backward compatibility.

to_string

return the date as a plain text string.

        print "Date of the package is ", $package->date()->to_string,"\n";

ACCESSORS ^

year

return the year

        my $string = $date->year;

monthname

return the monthname

        my $string = $date->monthname;

dayname

return the 'day-name'

        my $string = $date->'day-name';

hour

return the hour

        my $string = $date->hour;

daynumber

return the daynumber

        my $string = $date->daynumber;

monthnumber

return the monthnumber

        my $string = $date->monthnumber;

AUTHOR ^

DUPUIS Arnaud, <a.dupuis@infinityperl.org>

BUGS ^

Please report any bugs or feature requests to bug-Slackware-Slackget@rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Slackware-Slackget. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT ^

You can find documentation for this module with the perldoc command.

    perldoc Slackware::Slackget

You can also look for information at:

ACKNOWLEDGEMENTS ^

Thanks to Bertrand Dupuis (yes my brother) for his contribution to the documentation.

SEE ALSO ^

COPYRIGHT & LICENSE ^

Copyright 2005 DUPUIS Arnaud, All Rights Reserved.

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

syntax highlighting: