Composr API documentation

Functions

Augment an array of CSS colours with colours that are derived actually inside the CSS-sheets.

calculate_dynamic_css_colours(array $colours, \ID_TEXT $source_theme) : array

package	themewizard

Parameters

$colours

array

Map of colours.

$source_theme

\ID_TEXT

The theme it's being generated from

Returns

arrayA pair: extended map of colours, colour expression landscape

Calculate some component relating to a theme from a colour seed.

calculate_theme(string $seed, \ID_TEXT $source_theme, \ID_TEXT $algorithm, \ID_TEXT $show = 'colours', \?boolean $dark = null, \?array $colours = null, \?array $landscape = null, \?LANGUAGE_NAME $lang = null) : mixed

package	themewizard
set	equations hsv

Parameters

$seed

string

Colour seed.

$source_theme

\ID_TEXT

The theme it's being generated from

$algorithm

\ID_TEXT

The algorithm to use

$show

\ID_TEXT

What to generate ('colours', or the name of a theme image).

$dark

\?boolean

Whether it will be a dark theme (null: autodetect).

$colours

\?array

The colour map to use (null: compute).

$landscape

\?array

The computed colour landscape to use (null: compute).

$lang

\?LANGUAGE_NAME

The language to work in (null: default).

Returns

mixedImage resource OR A pair: extended map of colours, colour expression landscape

Execute CSS colour expression.

execute_css_colour_expression(mixed $expression, array $colours) : \?string

package	themewizard

Parameters

$expression

mixed

Expression tree (array) OR leaf (string).

$colours

array

Known colours at this point.

Returns

\?stringRRGGBB colour or possibly just a number (null: answer cannot be computed).

Find whether a theme is dark.

find_theme_dark(\ID_TEXT $theme) : boolean

package	themewizard

Parameters

$theme

\ID_TEXT

The theme name

Returns

booleanWhether the theme is dark

Called by find_theme_image to allow on-the-fly previewing of what theme wizard output would look like.

find_theme_image_themewizard_preview(\ID_TEXT $id, boolean $silent_fail = false) : \?URLPATH

package	themewizard

Parameters

$id

\ID_TEXT

The theme image ID

$silent_fail

boolean

Whether to silently fail (i.e. not give out an error message when a theme image cannot be found)

Returns

\?URLPATHURL to image (null: use standard one, this one is not theme wizard influenced).

Find the seed of a theme.

find_theme_seed(\ID_TEXT $theme, boolean $no_easy_anchor = false) : \ID_TEXT

package	themewizard

Parameters

$theme

\ID_TEXT

The theme name

$no_easy_anchor

boolean

Whether we can't assume the theme has any Composr default colour information defined, if not in theme.ini

Returns

\ID_TEXTThe seed colour

Make sure a colour component fits within the necessary range (0<=x<256).

fix_colour(mixed $x, boolean $hue = false) : integer

package	themewizard

Parameters

$x

mixed

Colour component (float or integer).

$hue

boolean

Whether this is hue (meaning it cycles around)

Returns

integerConstrained colour component.

Generate a gradient for a theme.

generate_gradient(string $top, string $bottom) : resource

package	themewizard

Parameters

$top

string

Colour for the top.

$bottom

string

Colour for the bottom.

Returns

resourceThe image

Generate a logo from the template.

generate_logo(string $name, string $font_choice = 'Vera', string $logo_theme_image = 'logo/default_logos/1', string $background_theme_image = 'logo/default_backgrounds/banner1', boolean $raw = false, \?string $theme = null, boolean $standalone_version = false) : resource

package	themewizard

Parameters

$name

string

The site name.

$font_choice

string

The font name (in data/fonts).

$logo_theme_image

string

The logo theme image.

$background_theme_image

string

The background theme image.

$raw

boolean

Whether to output the logo to the browser, destroy then image, and exit the script (i.e. never returns)

$theme

\?string

The theme to use the logo template from (null: default root zone theme).

$standalone_version

boolean

Whether we are generating the standalone version (smaller, used in e-mails etc).

Returns

resourceThe image resource.

Generate a theme image by converting an existing one to a new colour scheme via intelligent blending correlation.

generate_recoloured_image(mixed $path, string $colour_a_orig, string $colour_a_new, string $colour_b1_orig, string $colour_b1_new, \?string $colour_b2_orig = null, \?string $colour_b2_new = null, string $gradient_direction = 'vertical', \?array $pixel_x_start_array = null, integer $gradient_offset = 0, boolean $end_array = false) : resource

package	themewizard
set	vertical horizontal

Parameters

$path

mixed

The image path OR a preloaded GD image resource

$colour_a_orig

string

The colour code of what we have as our "minor" colour (often a border colour)

$colour_a_new

string

The colour code of what we want as our "minor" colour (often a border colour)

$colour_b1_orig

string

The colour code of what we have as our first major colour (often the only major colour)

$colour_b1_new

string

The colour code of what we want as our first major colour (often the only major colour)

$colour_b2_orig

\?string

The colour code of what we have as our second major colour (the gradient target, at the bottom/right of the image) (null: not gradiented)

$colour_b2_new

\?string

The colour code of what we want as our second major colour (the gradient target, at the bottom/right of the image) (null: not gradiented)

$gradient_direction

string

The directional code for the gradient

$pixel_x_start_array

\?array

An array that is used to limit where we do our conversion on. It specifies, for each y-offset, the x-offset we start from (null: no such limitation)

$gradient_offset

integer

What the gradient assumed start-position will be offset by (in the gradient direction).

$end_array

boolean

Whether the pixel_x_start array is actually an end array.

Returns

resourceThe image

Convert HSV colour components to an RGB colour. Based on publicly distributed code fragments which were themselves based on others: reasonably assumed as public domain.

hsv_to_rgb(float $h, float $s, float $v) : string

package	themewizard

Parameters

$h

float

H component

$s

float

S component

$v

float

V component

Returns

stringRGB colour.

Given a source theme name, configure the theme wizard for theme generation from it.

load_themewizard_params_from_theme(\ID_TEXT $theme, boolean $guess_images_if_needed = false)

package	themewizard

Parameters

$theme

\ID_TEXT

The theme name

$guess_images_if_needed

boolean

Whether we suspect the theme might not be well defined

Make a theme. Note that this will trigger the AFM.

make_theme(string $themename, \ID_TEXT $source_theme, \ID_TEXT $algorithm, string $seed, boolean $use, \?boolean $dark = false, boolean $inherit_css = false)

package	themewizard
set	equations hsv

Parameters

$themename

string

Name of the theme.

$source_theme

\ID_TEXT

The theme it's being generated from

$algorithm

\ID_TEXT

The algorithm to use

$seed

string

Seed colour to use.

$use

boolean

Whether to use the theme immediately.

$dark

\?boolean

Whether it will be a dark theme (null: autodetect).

$inherit_css

boolean

Whether to inherit the CSS, for easier theme upgrading.

Convert a textual CSS colour expression into an expression tree.

parse_css_colour_expression(string $textual) : \?array

package	themewizard

Parameters

$textual

string

Textual expression.

Returns

\?arrayExpression tree (null: not real).

Generate a theme image by converting an existing one to a new colour scheme via re-hueing.

re_hue_image(mixed $path, string $seed, \ID_TEXT $source_theme, boolean $also_s_and_v = false, boolean $invert = false) : resource

package	themewizard

Parameters

$path

mixed

The image path OR a preloaded GD image resource

$seed

string

The colour code of our hue

$source_theme

\ID_TEXT

The theme this is being generated from

$also_s_and_v

boolean

Whether to also adjust the S and V components

$invert

boolean

Whether to invert the colours

Returns

resourceThe image

Convert an RGB colour to HSV colour components. Based on publicly distributed code fragments which were themselves based on others: reasonably assumed as public domain.

rgb_to_hsv(string $rgb) : array

package	themewizard

Parameters

$rgb

string

RRGGBB colour.

Returns

arrayTriplet of (0-255) components: H, S, V

Rewrite some CSS code according to a CSS landscape.

theme_wizard_colours_to_css(string $contents, array $landscape, \ID_TEXT $source_theme, \ID_TEXT $algorithm, \ID_TEXT $seed) : string

package	themewizard
set	equations hsv

Parameters

$contents

string

CSS to apply to.

$landscape

array

The colour expression landscape which we'll make substitutions using.

$source_theme

\ID_TEXT

The theme this is being generated from

$algorithm

\ID_TEXT

The algorithm to use

$seed

\ID_TEXT

The seed colour

Returns

stringThe sheet

Rewrite some CSS code according to a CSS landscape.

theme_wizard_colours_to_sheet(\ID_TEXT $sheet, array $landscape, \ID_TEXT $source_theme, \ID_TEXT $algorithm, \ID_TEXT $seed) : string

package	themewizard
set	equations hsv

Parameters

$sheet

\ID_TEXT

CSS filename of source file.

$landscape

array

The colour expression landscape which we'll make substitutions using.

$source_theme

\ID_TEXT

The theme this is being generated from

$algorithm

\ID_TEXT

The algorithm to use

$seed

\ID_TEXT

The seed colour

Returns

stringThe sheet

Output a theme component straight to the browser.

themewizard_script()

package	themewizard