UciProvider
in package
Represents the information for the UCI System.
Table of Contents
- ALL_INDEXES_SECTION = -5
- This constant load all options in each section.
- IS_OBJECT_SECTION = -10
- This constant is for represent that is an array.
- dispatchAction() : array<string|int, mixed>
- Execute the action in the uci system.
- getUciConfiguration() : array<string|int, mixed>
- Return an object with the representation for the UCI System.
- getUciSection() : void
- - If a section is an array is saved as a Array.
Constants
ALL_INDEXES_SECTION
This constant load all options in each section.
public
mixed
ALL_INDEXES_SECTION
= -5
IS_OBJECT_SECTION
This constant is for represent that is an array.
public
mixed
IS_OBJECT_SECTION
= -10
Methods
dispatchAction()
Execute the action in the uci system.
public
abstract dispatchAction(string $action, string $config, string $section, int $indexSection, string $option, string $value) : array<string|int, mixed>
Parameters
- $action : string
- $config : string
- $section : string
- $indexSection : int
- $option : string
- $value : string
Return values
array<string|int, mixed> —getUciConfiguration()
Return an object with the representation for the UCI System.
public
abstract static getUciConfiguration() : array<string|int, mixed>
For example: { app:{ port } }
Return values
array<string|int, mixed> —getUciSection()
- If a section is an array is saved as a Array.
protected
abstract static getUciSection(array<string|int, mixed>|UciSection &$configSection, string $sectionName, string $optionName, array<string|int, mixed> $content) : void
-
This array is saved with the position described by the uci system
-
If a section is not an array, so it's saved as a UciSection
- This UciSection has an attribute 'options' for each option in this section
Parameters
- $configSection : array<string|int, mixed>|UciSection
- $sectionName : string
- $optionName : string
- $content : array<string|int, mixed>