Component Traits

PHP traits are used to provide common implementations of an attribute's conversion from $attributes array element to object field.
This provides a central location for validation logic and documentation, reducing duplication and ensuring consistency.

BackgroundColor

Property: backgroundColorType: ThemeColor
Background colour keyword
Method: set_background_color_from_attrsReturns: void
Retrieves the relevant properties from the component $attributes array, validates them, and assigns them to the corresponding component instance field.
Method: get_background_colorReturns: ThemeColor
Get the background colour of the component.
Method: set_background_colorReturns: void
Allows the background colour of a component to be set based on contextual factors not available at instantiation.
Method: simplify_all_background_colorsReturns: void
Clean up duplication of background colours between this and its inner components simplify HTML and CSS. Runs either remove_redundant_background_colors() or set_background_color_based_on_children() as appropriate.
Method: remove_redundant_background_colorsReturns: void
If this component has a background colour set, remove the same background from any children that have it to simplify HTML and CSS. This method is public as there are some components where we want to do this, but not assign a background colour to the component.

Example usage

namespace Doubleedesign\Comet\Core;
class MyComponent {
	use BackgroundColor;
	
	function __construct(array $attributes, array $innerComponents) {
		parent::__construct($attributes, $innerComponents);
		$this->set_background_color_from_attrs($attributes);
	}
}

ColorTheme

Property: colorThemeType: ThemeColor
Colour keyword for the fill or outline colour
Method: set_color_theme_from_attrsReturns: void
Retrieves the relevant properties from the component $attributes array, validates them, and assigns them to the corresponding component instance field.

Example usage

namespace Doubleedesign\Comet\Core;
class MyComponent {
	use ColorTheme;
	
	function __construct(array $attributes, array $innerComponents) {
		parent::__construct($attributes, $innerComponents);
		$this->set_color_theme_from_attrs($attributes);
	}
}

Icon

Property: iconPrefixType: ?string
Icon prefix class name
Property: iconType: ?string
Icon class name
Method: set_icon_from_attrsReturns: void

Example usage

namespace Doubleedesign\Comet\Core;
class MyComponent {
	use Icon;
	
	function __construct(array $attributes, array $innerComponents) {
		parent::__construct($attributes, $innerComponents);
		$this->set_icon_from_attrs($attributes);
	}
}

LayoutAlignment

Property: hAlignType: Alignment
Property: vAlignType: Alignment
Method: set_layout_alignment_from_attrsReturns: void
Retrieves the relevant properties from the component $attributes array, validates them, and assigns them to the corresponding component instance field.

Example usage

namespace Doubleedesign\Comet\Core;
class MyComponent {
	use LayoutAlignment;
	
	function __construct(array $attributes, array $innerComponents) {
		parent::__construct($attributes, $innerComponents);
		$this->set_layout_alignment_from_attrs($attributes);
	}
}

LayoutContainerSize

Property: sizeType: ContainerSize
Keyword specifying the relative width of the container for the inner content
Method: set_size_from_attrsReturns: void
Retrieves the relevant properties from the component $attributes array, validates them, and assigns them to the corresponding component instance field.

Example usage

namespace Doubleedesign\Comet\Core;
class MyComponent {
	use LayoutContainerSize;
	
	function __construct(array $attributes, array $innerComponents) {
		parent::__construct($attributes, $innerComponents);
		$this->set_size_from_attrs($attributes);
	}
}

LayoutOrientation

Property: orientationType: Orientation
Method: set_orientation_from_attrsReturns: void
Retrieves the relevant properties from the component $attributes array, validates them, and assigns them to the corresponding component instance field.

Example usage

namespace Doubleedesign\Comet\Core;
class MyComponent {
	use LayoutOrientation;
	
	function __construct(array $attributes, array $innerComponents) {
		parent::__construct($attributes, $innerComponents);
		$this->set_orientation_from_attrs($attributes);
	}
}

TextAlign

Property: textAlignType: Alignment
Method: set_text_align_from_attrsReturns: void
Retrieves the relevant properties from the component $attributes array, validates them, and assigns them to the corresponding component instance field.

Example usage

namespace Doubleedesign\Comet\Core;
class MyComponent {
	use TextAlign;
	
	function __construct(array $attributes, array $innerComponents) {
		parent::__construct($attributes, $innerComponents);
		$this->set_text_align_from_attrs($attributes);
	}
}

TextColor

Property: textColorType: ThemeColor
Method: set_text_color_from_attrsReturns: void
Retrieves the relevant properties from the component $attributes array, validates them, and assigns them to the corresponding component instance field.

Example usage

namespace Doubleedesign\Comet\Core;
class MyComponent {
	use TextColor;
	
	function __construct(array $attributes, array $innerComponents) {
		parent::__construct($attributes, $innerComponents);
		$this->set_text_color_from_attrs($attributes);
	}
}