The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
WWW-Challonge-1.01
River stage zero No dependents
++
/ WWW::Challonge::Match

NAME

WWW::Challonge::Match - A class representing a single match within a Challonge tournament.

VERSION

Version 1.01

SUBROUTINES/METHODS

new

Takes a hashref representing the match, the API key and the REST client and turns it into an object. This is mostly used by the module itself.

        my $m = WWW::Challonge::Match->new($match, $key, $client);

update

Updates the match with the results. Requires an arrayref of comma-seperated values and optional arguments for votes. The 'winner_id' is not required as the module calculates it. Returns the updated WWW::Challonge::Match object:

scores_csv

Required. An arrayref containing the match results with the following format - "x-y", where x and y are both integers, x being player 1's score and y being player 2's.

player1_votes

Integer. Overwrites the number of votes for player 1.

player2_votes

Integer. Overwrites the number of votes for player 2.

        # If votes are not given, the argument can simply be an arrayref:
        $m->update(["1-3", "3-2", "3-0"]);

        # Otherwise, a hashref is required:
        $m->update({
                scores_csv => ["1-3", "3-2", "3-0"],
                player1_votes => 2,
                player2_votes => 1,
        });

attributes

Returns a hashref of all the attributes of the match. Contains the following fields.

attachment_count
created_at
group_id
has_attachment
id
identifier
location
loser_id
player1_id
player1_is_prereq_match_loser
player1_prereq_match_id
player1_votes
player2_id
player2_is_prereq_match_loser
player2_prereq_match_id
player2_votes
prerequisite_match_ids_csv
round
scheduled_time
scores_csv
started_at
state
tournament_id
underway_at
updated_at
winner_id
        my $attr = $m->attributes;
        print $attr->{identifier}, "\n";

attachments

Returns an arrayref of WWW::Challonge::Match::Attachment objects for every attachment the match has.

        my $attachments = $m->attachments;

attachment

Returns a single WWW::Challonge::Match::Attachment object for the attachment with the given ID:

        my $ma = $m->attachment(124858);

new_attachment

Creates a new match attachment and returns the resulting WWW::Challonge::Match::Attachment object. Takes the following arguments, at least one of them is required. The tournament's "accept_attachments" attribute must be true for this to succeed.

asset

A file upload (max 250KB). If provided, the 'url' parameter will be ignored.

url

A web URL. Must include http://, https:// or ftp://.

description

Text to the describte the file or URL, or it can simply be standalone text.

        # A simple URL:
        my $ma = $m->new_attachment({
                url => http://www.example.com/image.png",
                description => "An example URL",
        });

        # File uploads require a filename:
        my $ma = $m->new_attachment({
                asset => "example.png",
                description => "An example file",
        });

__args_are_valid

Checks if the passed arguments and values are valid for updating a match.

AUTHOR

Alex Kerr, <kirby at cpan.org>

BUGS

Please report any bugs or feature requests to bug-www-challonge at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=WWW-Challonge::Match. 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 WWW::Challonge::Match

You can also look for information at:

SEE ALSO

WWW::Challonge
WWW::Challonge::Tournament
WWW::Challonge::Participant
WWW::Challonge::Match::Attachment

ACKNOWLEDGEMENTS

Everyone on the Challonge team for making such a great service.

LICENSE AND COPYRIGHT

Copyright 2015 Alex Kerr.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.