Search moodle.org's
Developer Documentation
Developer Documentation
- Bug fixes for general core bugs in 3.11.x will end 14 Nov 2022 (12 months plus 6 months extension).
- Bug fixes for security issues in 3.11.x will end 13 Nov 2023 (18 months plus 12 months extension).
- PHP version: minimum PHP 7.3.0 Note: minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is supported too.
Differences Between: [Versions 310 and 311] [Versions 311 and 400] [Versions 311 and 401] [Versions 311 and 402] [Versions 311 and 403] [Versions 39 and 311]
(no description)
| File Size: | 400 lines (13 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
Color:: (16 methods):
__construct()
getSharedComponent()
getStyleArray()
applyFromArray()
getARGB()
setARGB()
getRGB()
setRGB()
getColourComponent()
getRed()
getGreen()
getBlue()
changeBrightness()
indexedColor()
getHashCode()
exportArray1()
| __construct($pARGB = self::COLOR_BLACK, $isSupervisor = false, $isConditional = false) X-Ref |
| Create a new Color. param: string $pARGB ARGB value for the colour param: bool $isSupervisor Flag indicating if this is a supervisor or not param: bool $isConditional Flag indicating if this is a conditional style or not |
| getSharedComponent() X-Ref |
| Get the shared style component for the currently active cell in currently active sheet. Only used for style supervisor. return: Color |
| getStyleArray($array) X-Ref |
| Build style array from subcomponents. param: array $array return: array |
| applyFromArray(array $pStyles) X-Ref |
| Apply styles from array. <code> $spreadsheet->getActiveSheet()->getStyle('B2')->getFont()->getColor()->applyFromArray(['rgb' => '808080']); </code> param: array $pStyles Array containing style information return: $this |
| getARGB() X-Ref |
| Get ARGB. return: string |
| setARGB($pValue) X-Ref |
| Set ARGB. param: string $pValue see self::COLOR_* return: $this |
| getRGB() X-Ref |
| Get RGB. return: string |
| setRGB($pValue) X-Ref |
| Set RGB. param: string $pValue RGB value return: $this |
| getColourComponent($RGB, $offset, $hex = true) X-Ref |
| Get a specified colour component of an RGB value. param: string $RGB The colour as an RGB value (e.g. FF00CCCC or CCDDEE param: int $offset Position within the RGB value to extract param: bool $hex Flag indicating whether the component should be returned as a hex or a return: string The extracted colour component |
| getRed($RGB, $hex = true) X-Ref |
| Get the red colour component of an RGB value. param: string $RGB The colour as an RGB value (e.g. FF00CCCC or CCDDEE param: bool $hex Flag indicating whether the component should be returned as a hex or a return: string The red colour component |
| getGreen($RGB, $hex = true) X-Ref |
| Get the green colour component of an RGB value. param: string $RGB The colour as an RGB value (e.g. FF00CCCC or CCDDEE param: bool $hex Flag indicating whether the component should be returned as a hex or a return: string The green colour component |
| getBlue($RGB, $hex = true) X-Ref |
| Get the blue colour component of an RGB value. param: string $RGB The colour as an RGB value (e.g. FF00CCCC or CCDDEE param: bool $hex Flag indicating whether the component should be returned as a hex or a return: string The blue colour component |
| changeBrightness($hex, $adjustPercentage) X-Ref |
| Adjust the brightness of a color. param: string $hex The colour as an RGBA or RGB value (e.g. FF00CCCC or CCDDEE) param: float $adjustPercentage The percentage by which to adjust the colour as a float from -1 to 1 return: string The adjusted colour as an RGBA or RGB value (e.g. FF00CCCC or CCDDEE) |
| indexedColor($pIndex, $background = false) X-Ref |
| Get indexed color. param: int $pIndex Index entry point into the colour array param: bool $background Flag to indicate whether default background or foreground colour return: self |
| getHashCode() X-Ref |
| Get hash code. return: string Hash code |
| exportArray1() X-Ref |
| No description |
