ivopetkov/html-server-components-bearframework-addon

HTML Server Components addon for Bear Framework

Thursday, July 12, 2018
by ivopetkov
Repository
1 Watchers
0 Stars
1,057 Installations

PHP
9 Dependents
0 Suggesters
0 Forks
0 Open issues
16 Versions
14 % Grown

The README.md

HTML Server Components

Addon for Bear Framework, _(*1)

This addon brings HTML Server Components to Bear Framework., _(*2)

, _(*3)

Download and install

Install via Composer, _(*4)

composer require ivopetkov/html-server-components-bearframework-addon

Download an archive, _(*5)

Download the latest release from the GitHub page and include the autoload file., _(*6)

include '/path/to/the/addon/autoload.php';

Enable the addon

Enable the addon for your Bear Framework application., _(*7)

$app->addons->add('ivopetkov/html-server-components-bearframework-addon');

Documentation

A reference to the HTML Server Components object (IvoPetkov\BearFramework\Addons\HTMLServerComponents) is available at $app->components, _(*8)

Examples

Let's create a demo component file at app/components/footer.php, _(*9)

<html>
    <body>
        <footer>This is the footer</footer>
    </body>
</html>

Convert components code into HTML code, _(*10)

echo $app->components->process('<component src="file:app/components/footer.php" />');
// Output:
// <!DOCTYPE html><html><head></head><body><footer>This is the footer</footer></body></html>

Create aliases, _(*11)

$app->components->addAlias('footer', 'file:app/components/footer.php');
echo $app->components->process('<component src="footer" />');
// Output:
// <!DOCTYPE html><html><head></head><body><footer>This is the footer</footer></body></html>

Classes

IvoPetkov\BearFramework\Addons\HTMLServerComponents

HTML Server Components utilities, _(*12)

Methods

public void addAlias ( string $alias , string $original )

Adds an alias, _(*13)

Parameters, _(*14)

$alias, _(*15)

The alias, _(*16)

$original, _(*17)

The original source name, _(*18)

Returns, _(*19)

No value is returned, _(*20)

public string process ( string $content [, array $options = [] ] )

Converts components code (if any) into HTML code, _(*21)

Parameters, _(*22)

$content, _(*23)

The content to be processed, _(*24)

$options, _(*25)

Compiler options, _(*26)

Returns, _(*27)

The result HTML code, _(*28)

public string processFile ( string $file [, array $attributes = [] ]  [, string $innerHTML = '' ]  [, array $variables = [] ]  [, array $options = [] ] )

Creates a component from the file specified and processes the content, _(*29)

Parameters, _(*30)

$file, _(*31)

The file to be run as component, _(*32)

$attributes, _(*33)

Component object attributes, _(*34)

$innerHTML, _(*35)

Component object innerHTML, _(*36)

$variables, _(*37)

List of variables that will be passes to the file. They will be available in the file scope., _(*38)

$options, _(*39)

Compiler options, _(*40)

Returns, _(*41)

The result HTML code, _(*42)

License

HTML Server Components addon for Bear Framework is open-sourced software. It's free to use under the MIT license. See the license file for more information., _(*43)