ivopetkov/html-server-components-bearframework-addon

HTML Server Components addon for Bear Framework

Maintainers

Details

github.com/ivopetkov/html-server-components-bearframework-addon

Homepage

Source

Issues

Installs: 3 427

Dependents: 10

Suggesters: 0

Security: 0

Stars: 0

Watchers: 3

Forks: 0

Open Issues: 0

v1.2.0 2023-11-03 09:40 UTC

Requires

Requires (Dev)

MIT d9c9fe2f2b68907c7aa40fb10591f2a658601354

htmlHTML Server ComponentsBear Framework addon

This package is auto-updated.

Last update: 2024-11-03 11:40:10 UTC

README

Addon for Bear Framework

This addon brings HTML Server Components to Bear Framework.

Build Status Latest Stable Version codecov.io License Codacy Badge

Download and install

Install via Composer

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

Download an archive

Download the latest release from the GitHub page and include the autoload file.

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

Enable the addon

Enable the addon for your Bear Framework application.

$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

Examples

Let's create a demo component file at app/components/footer.php

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

Convert components code into HTML code

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

$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

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

Adds an alias

Parameters

      $alias

            The alias

      $original

            The original source name

Returns

      No value is returned

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

Converts components code (if any) into HTML code

Parameters

      $content

            The content to be processed

      $options

            Compiler options

Returns

      The result HTML code

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

Creates a component from the file specified and processes the content

Parameters

      $file

            The file to be run as component

      $attributes

            Component object attributes

      $innerHTML

            Component object innerHTML

      $variables

            List of variables that will be passes to the file. They will be available in the file scope.

      $options

            Compiler options

Returns

      The result HTML code

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.

Author

This addon is created by Ivo Petkov. Feel free to contact me at @IvoPetkovCom or ivopetkov.com.