{"id":18293180,"url":"https://github.com/getolympus/hera-renderer","last_synced_at":"2026-05-04T05:33:38.734Z","repository":{"id":56983094,"uuid":"237736352","full_name":"GetOlympus/Hera-Renderer","owner":"GetOlympus","description":"Ἥρα — Olympus Hera is a bundle used to render all components views through the Twig template engine.","archived":false,"fork":false,"pushed_at":"2020-03-30T00:07:28.000Z","size":21,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-15T02:22:02.920Z","etag":null,"topics":["engine","hera","olympus","olympus-bundle","php","render","renderer","twig","wordpress"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/GetOlympus.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-02-02T07:41:51.000Z","updated_at":"2020-03-30T00:06:59.000Z","dependencies_parsed_at":"2022-08-21T12:20:19.662Z","dependency_job_id":null,"html_url":"https://github.com/GetOlympus/Hera-Renderer","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GetOlympus%2FHera-Renderer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GetOlympus%2FHera-Renderer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GetOlympus%2FHera-Renderer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GetOlympus%2FHera-Renderer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GetOlympus","download_url":"https://codeload.github.com/GetOlympus/Hera-Renderer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247999864,"owners_count":21031046,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["engine","hera","olympus","olympus-bundle","php","render","renderer","twig","wordpress"],"created_at":"2024-11-05T14:23:06.454Z","updated_at":"2026-05-04T05:33:38.681Z","avatar_url":"https://github.com/GetOlympus.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Olympus Hera Renderer\n\u003e **Olympus Hera Renderer** is a bundle used to render all components views through the TWIG template engine.\n\n```sh\ncomposer require getolympus/olympus-hera-renderer\n```\n\n---\n\n[![Olympus Component][olympus-image]][olympus-url]\n[![CodeFactor Grade][codefactor-image]][codefactor-url]\n[![Packagist Version][packagist-image]][packagist-url]\n[![MIT][license-image]][license-blob]\n\n---\n\n## Example\n\nYou can easily use the `Hera` renderer to display TWIG template:\n\n```php\nnamespace MyCustomPackage;\n\nuse GetOlympus\\Hera\\Hera;\n\nclass MyPackage\n{\n    protected function displayContent()\n    {\n        /**\n         * Sample extracted from the `Metabox` Zeus-Core component.\n         * @see https://github.com/GetOlympus/Zeus-Core/blob/master/src/Zeus/Metabox/Metabox.php\n         */\n\n        // Prepare admin scripts and styles\n        $assets = [\n            'scripts' =\u003e [],\n            'styles'  =\u003e [],\n        ];\n\n        $vars = [];\n\n        // Display fields\n        foreach ($fields as $field) {\n            if (!$field) {\n                continue;\n            }\n\n            // Update scripts and styles\n            $fieldassets = $field-\u003eassets();\n\n            if (!empty($fieldassets)) {\n                $assets['scripts'] = array_merge($assets['scripts'], $fieldassets['scripts']);\n                $assets['styles']  = array_merge($assets['styles'], $fieldassets['styles']);\n            }\n\n            $vars['fields'][] = $field-\u003eprepare('metabox', $post, 'post');\n        }\n\n        /**\n         * Outside the loop, you'll get an array with these elements:\n         *\n         * $vars = [\n         *     'fields' =\u003e [\n         *         [\n         *             'context' =\u003e 'wordpress',\n         *             'path' =\u003e '/path/to/resources/views',\n         *             'template' =\u003e 'wordpress.html.twig',\n         *             'vars' =\u003e [-- vars used in the target template --]\n         *         ],\n         *         [-- more and more --],\n         *     ]\n         * ];\n         */\n\n        // Render view\n        $render = new Hera('core', 'layouts'.S.'metabox.html.twig', $vars, $assets);\n        $render-\u003eview();\n    }\n}\n```\n\n## Initialization\n\nThe `Hera` component needs to be initialized by this way:\n\n```php\n/**\n * Constructor.\n *\n * @param  string  $context\n * @param  string  $template\n * @param  array   $vars\n * @param  array   $assets\n * @param  bool    $usecache\n */\nnew Hera($context, $template, $vars, $assets, $usecache);\n```\n\n| Variable      | Type    | Default value if not set | Details |\n| ------------- | ------- | ------------------------ | ------- |\n| `context`     | String  | *mandatory* | Used by the TWIG template engine to retrieve wanted template |\n| `template`    | String  | *mandatory* | TWIG template to load |\n| `vars`        | Array   | *mandatory* | List of vars used in the TWIG loaded template |\n| `assets`      | Array   | `[]` | List of assets files to load to render template |\n| `usecache`    | Boolean | `false` | Define wether to use or not TWIG engine cache system |\n\n## Customization\n\nIf you need to add your custom TWIG functions, you can use the `ol_hera_render_functions` action hook:\n\n```php\nadd_action('ol.hera.render_functions', function ($twig) {\n    // Example to use the WordPress `get_header()` function through TWIG: {{ get_header(file) }}\n    $twig-\u003eaddFunction(new \\Twig\\TwigFunction('get_header', function ($file = '') {\n        get_header($file);\n    }));\n});\n```\n\n## Release History\n\nSee [**CHANGELOG.md**][changelog-blob] for all details.\n\n## Contributing\n\n1. Fork it (\u003chttps://github.com/GetOlympus/Hera-Renderer/fork\u003e)\n2. Create your feature branch (`git checkout -b feature/fooBar`)\n3. Commit your changes (`git commit -am 'Add some fooBar'`)\n4. Push to the branch (`git push origin feature/fooBar`)\n5. Create a new Pull Request\n\n---\n\n**Built with ♥ by [Achraf Chouk](http://github.com/crewstyle \"Achraf Chouk\") ~ (c) since a long time.**\n\n\u003c!-- links \u0026 imgs dfn's --\u003e\n[olympus-image]: https://img.shields.io/badge/for-Olympus-44cc11.svg?style=flat-square\n[olympus-url]: https://github.com/GetOlympus\n[changelog-blob]: https://github.com/GetOlympus/Hera-Renderer/blob/master/CHANGELOG.md\n[codefactor-image]: https://www.codefactor.io/repository/github/GetOlympus/Hera-Renderer/badge?style=flat-square\n[codefactor-url]: https://www.codefactor.io/repository/github/getolympus/Hera-Renderer\n[license-blob]: https://github.com/GetOlympus/Hera-Renderer/blob/master/LICENSE\n[license-image]: https://img.shields.io/badge/license-MIT_License-blue.svg?style=flat-square\n[packagist-image]: https://img.shields.io/packagist/v/getolympus/olympus-Hera-Renderer.svg?style=flat-square\n[packagist-url]: https://packagist.org/packages/getolympus/olympus-Hera-Renderer","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgetolympus%2Fhera-renderer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgetolympus%2Fhera-renderer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgetolympus%2Fhera-renderer/lists"}