Overview

Classes

  • Card
  • CardRegular
  • Component
  • ComponentAvatar
  • ComponentFlag
  • ComponentImage
  • ComponentLabel
  • ComponentXPBar
  • ErrorImage
  • OsuAPI
  • OsuSignature
  • PredefinedColours
  • Signature
  • Template
  • TemplateNormal
  • Utils
  • Overview
  • Class

Class Template

A template for signatures. This predefines the background Card and Components.

Direct known subclasses

TemplateNormal
Author: Lemmmy
See: Card
See: Component
See: TemplateNormal
Located at Template.php
Methods summary
public
# __construct( OsuSignature $signature )

Add the components.

Add the components.

Parameters

$signature
The base signature.
public array
# getComponents( )

This template's components.

This template's components.

Returns

array
public Signature
# getSignature( )

Returns

Signature
The signature that this is a template of.
public Card
# getCard( )

Returns

Card
The background card of this signature template.
public
# setCard( Card $card )

Sets the background card of this signature template.

Sets the background card of this signature template.

Parameters

$card
The card to set to.
public integer
# getImageMarginWidth( )

Returns

integer
The width to be added to the image.
public integer
# getImageMarginHeight( )

Returns

integer
The height to be added to the image.
public integer
# calculateBaseWidth( )

Calculates the required width of the template based on the components and their layout.

Calculates the required width of the template based on the components and their layout.

Returns

integer
The width we calculated.
public integer
# calculateBaseHeight( )

Calculates the required height of the template based on the components and their layout.

Calculates the required height of the template based on the components and their layout.

Returns

integer
The height we calculated.
public
# addComponent( Component $component )

Adds a component to this template

Adds a component to this template

Parameters

$component
The component to add
public
# drawComponents( )

Draws the template's components

Draws the template's components

Properties summary
protected integer $extraWidth

Extra padding to be added to the signature.

Extra padding to be added to the signature.

#
protected integer $extraHeight

Extra padding to be added to the signature.

Extra padding to be added to the signature.

#
API documentation generated by ApiGen