[RFC|Rejected] hook_template_snippet

Kellanved · Post by **Kellanved** » Fri Aug 20, 2010 2:01 pm

Name: hook_template_snippet
Rationale: It's hard to deploy small markup additions over several templates. This hook enables code to inject code prior to template compilation, allowing MODs to alter several templates without changes to the actual template files. By using includes, these snippets can use template-dependent snippets.
Input:

region: The name of the region where the snippet should be placed

Output:

snippet: The actual snippet to be included

Placement: In the template compiler
Semantics: The return value gets stored in a region => HTML array and then embedded into the template on compile.
Infrastructure: Termplate syntax has to be extended to have a region marker construct. Such region markers have to be placed throughout template files. The template compiler has to be extended to understand regions and embed the snippets.
Related: viewtopic.php?f=84&t=32796

Please post your RFCs for template regions in this topic

sajaki · Post by **sajaki** » Fri Aug 20, 2010 7:12 pm

hmm. this sounds useful. Since 90 % of mods touch overall_header, i think this may possibly eliminate mod conflicts in templates.

ameeck · Post by **ameeck** » Fri Aug 20, 2010 9:15 pm

Region: HTML <head>
Use: Injecting additional content into the page header, e.g.:

Custom CSS files
JavaScript library inclusions
Additional meta tags

Nelsaidi · Post by **Nelsaidi** » Fri Aug 20, 2010 11:51 pm

Cant you have a Template::add_script($url, $param1, $etc) method (and et cetra) for the above purposes?

nickvergessen · Post by **nickvergessen** » Sat Aug 21, 2010 1:37 pm

Region: overall_header.html next to the FAQ-Link
Use: Adding a new link to a MOD-Page, as part of this hook: viewtopic.php?f=111&t=33714

Post by **Derky** » Thu Aug 26, 2010 9:02 pm

ameeck wrote:Region: HTML <head>
Use: Injecting additional content into the page header, e.g.:
Custom CSS files
JavaScript library inclusions
Additional meta tags

Additional Feeds
Preferably below the current feeds.

Region: overall_footer.html next to the powered by phpBB copyright
Use: Injecting additional content into the footer like copyrights

Michaelo · Post by **Michaelo** » Mon Jan 10, 2011 6:47 am

This should not require a specific hook...

An assign_block_vars hook should deal with adding content no matter where it is called from...
For example, the following would work for all instances:

Code: Select all

 hook_assign_block_vars('page', 'location', 'array_name');

Where the page would be the current phpbb page, the location could identify header, footer, block, body, etc. and of course the array_name equals the array to modify...

Notes:

phpBB is page orientated so adding the current page makes perfect sense...
Adding a location identifier would allow a simple switch process in the mods hooked file to allowing storing of all potential edits in on file...
In reality there is going to be a lot of unique hooks but common hooks would IMHO satisfy most mod edits...

Possible hook code...

Code: Select all

if(!function_exists('hook_assign_block_vars_mymod'))
{
    function hook_assign_block_vars_mymod($array_name)
    {
        if ($page == 'viewtopic')
        {
            switch ($location)
            {
                case 'head';
                    $template->assign_block_vars($array_name, array(
                        'BLOCKS'        => $value,
                        'BLOCK_ID'        => $block_id,
                        'BLOCK_TITLE'    => $block_title,
                    ));
                break;

                case 'body';
                    ...
                break;

                case 'footer';
                    ...
                break;

                case 'block';
                    ...
                break;

                case default;
                    ...
                break;
            }
        }
    }
}

I'm not sure how the hook management will be implementation but for the purposes of this example lets assume the mod provides an array of function calls, dependencies and priorities... The hook manager would then be responsible for linking the correct hook to the correct function and in the right sequence. If the dependencies were not met, the hook would not be implemented...

Post by **MichaelC** » Thu May 31, 2012 3:05 pm

No longer relevant

Michaelo · Post by **Michaelo** » Fri Jun 01, 2012 2:50 am

18 months for a reply... that's gota be a record

Development Discussion Board

[RFC|Rejected] hook_template_snippet

[RFC|Rejected] hook_template_snippet

Re: [RFC] hook_template_snippet : Injecting code into the te

Re: [RFC] hook_template_snippet : Injecting into the templa

Re: [RFC] hook_template_snippet : Injecting into the templa

Re: [RFC] hook_template_snippet : Injecting into the templa

Re: [RFC] hook_template_snippet : Injecting into the templa

Re: [RFC] hook_template_snippet : Injecting into the templa

Re: [RFC|Rejected] hook_template_snippet

Re: [RFC|Rejected] hook_template_snippet