MacroFileParser
in package
IQRF IDE Macro file parser
Table of Contents
- $description : string
- $groups : array<string|int, Group>
- $type : int
- $version : int
- $fileName : string
- __construct() : mixed
- Constructor
- getMacroSize() : int
- Returns IQRF IDE Macro's size
- read() : array<string|int, Group>
- Read IQRF IDE Macro's file and parse it
- toArray() : array<string|int, array<string, array<string, bool|string|null>>>
- Convert objects into arrays
- parse() : array<string|int, Group>
- Parse IQRF IDE Macros into objects
Properties
$description
public
string
$description
IQRF IDE Macro's file description
$groups
public
array<string|int, Group>
$groups
IQRF IDE Macro's groups
$type
public
int
$type
IQRF IDE Macro's file type
$version
public
int
$version
IQRF IDE Macro's file version
$fileName
private
string
$fileName
IQRF IDE Macro's file name
Methods
__construct()
Constructor
public
__construct(string $fileName) : mixed
Parameters
- $fileName : string
-
IQRF IDE Macro's file name
Return values
mixed —getMacroSize()
Returns IQRF IDE Macro's size
public
getMacroSize() : int
Return values
int —IQRF IDE Macro's size
read()
Read IQRF IDE Macro's file and parse it
public
read() : array<string|int, Group>
Return values
array<string|int, Group> —Parsed macros
toArray()
Convert objects into arrays
public
toArray(array<string|int, Group> $macros) : array<string|int, array<string, array<string, bool|string|null>>>
Parameters
- $macros : array<string|int, Group>
-
IQRF IDE Macros in an array of objects
Return values
array<string|int, array<string, array<string, bool|string|null>>> —IQRF IDE Macros in an array
parse()
Parse IQRF IDE Macros into objects
private
parse(array<string, int|string> $fileContent) : array<string|int, Group>
Parameters
- $fileContent : array<string, int|string>
-
IQRF IDE Macro's file content
Return values
array<string|int, Group> —Array of objects with IQRF IDE macros