bracket_design.inc File Reference

Functions
	bracket_design_list ()
	bracket_design_description ($design)
	bracket_design_info ($design)
	bracket_design_inc ($design)
	bracket_design_path ($design)
	bracket_design_base_path ()
	bracket_design_load ($design)
	bracket_design_create_competitors (&$node, $cc)
	bracket_design_create_winner_rounds (&$node, $rounds=0)
	bracket_design_create_championship_results (&$node)
	bracket_design_create_playoff_results (&$node)
	bracket_design_create_loser_rounds (&$node, $modified=FALSE)

---

Detailed Description

This file contains the design helper functions for the bracket module

Author:

Jim Bullington <jimb@jrbcs.com>

---

Function Documentation

bracket_design_base_path

(

)

Returns the path to the designs directory

Returns:

the path to the designs directory

bracket_design_create_championship_results

(

&$

node

)

Add championship results to a bracket

Parameters:

$node

the bracket node

bracket_design_create_competitors	(	&$	node,
		$	cc
	)

Add the given number of competitors to a bracket

Parameters:

	$node	the bracket node
	$cc	the number of competitors to add

bracket_design_create_loser_rounds	(	&$	node,
		$	modified = FALSE
	)

Add loser rounds to a bracket

Parameters:

	$node	the bracket node
	$modified	indicates if the bracket is a modified double elimination bracket where the loser bracket competes for consolidation places

bracket_design_create_playoff_results

(

&$

node

)

Add playoff results to a bracket

Parameters:

$node

the bracket node

bracket_design_create_winner_rounds	(	&$	node,
		$	rounds = 0
	)

Add the given number of rounds to a bracket

Parameters:

	$node	the bracket node
	$rounds	the number of rounds to add

bracket_design_description

(

$

design

)

Parse info file for bracket design - similar to Drupal's module.info file Uses ini parser provided by php's parse_ini_file().

The following values must exist in the design.info file name - the name of the design description - A brief description of the bracket design - ex: Double Elimination 16 Competitor Championship

Parameters:

$design

the name of the design

Returns:

the design description

bracket_design_inc

(

$

design

)

Returns the pathname of the design include file

Parameters:

$design

the design name

Returns:

the path to the design include file

bracket_design_info

(

$

design

)

Returns the pathname of the design info file

Parameters:

$design

the design name

Returns:

the path to the design info file

bracket_design_list

(

)

Return a list of valid designs that are found in the designs path in the module directory tree

The design must must have a .inc file with the design code and a .info file with the design description

Returns:

a list of designs - key is name, value is design description

bracket_design_load

(

$

design

)

Returns true if design include file was successfully included

Parameters:

$design

the design name

Returns:

the design description

bracket_design_path

(

$

design

)

Returns the path to the design directory

Parameters:

$design

the design name

Returns:

the path to the design directory