Method parse

hngts.com :: Funcdown :: Funcdown Manual :: Encapsulators :: Method parse

Info

  public function parse (array|string $input, bool $retVal = true): ?self;

Transforms funcdown syntax to desired markup. Chews content, be it raw array or funcdown string or filepath. Optionally fills populated object with usable property values.

Arguments

@input - Valid funcdown array or string or filepath to funcdown file.
@retVal - Optional. If FALSE it will return NULL, thus preventing method chaining.

Return Value

If $retVal is set to true, returns funcdown object, with populated data. How much data is preserved within object is based on runtime factors or overall configuration. If $retVal is set to false, further manipulation is required with release or expose methods.