HtmlTag helper #6709

nikolaposa · 2014-09-27T18:45:32Z

New view helper used for rendering <html> tag of a web page, to which some custom attributes can be added dynamically.

Intent

Idea is to have ability to dynamically attach some attributes to the opening HTML tag in a layout. For example:
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:og="http://ogp.me/ns#">

Usage

Rendering tag in a layout:

echo $this->html()->openTag(); 
//...
echo $this->html()->closeTag();

Adding attributes:

//single
$this->html()->setAttribute('xmlns', 'http://www.w3.org/1999/xhtml');

//multiple
$this->html()->setAttributes(array(
    'xmlns' => 'http://www.w3.org/1999/xhtml',
    'prefix' => 'og: http://ogp.me/ns#'
));

//shortcut method
$this->html(array(
    'xmlns' => 'http://www.w3.org/1999/xhtml',
    'prefix' => 'og: http://ogp.me/ns#'
));

There is also option to automatically pre-set appropriate namespace attributes, based on currently set DOCTYPE (Doctype helper):

//At some point:
$this->doctype('xhtml');

$this->html()
    ->setUseNamespaces(true) //'xmlns' attribute will be automatically set to 'http://www.w3.org/1999/xhtml'
    ->setAttributes(array(
        'prefix' => 'og: http://ogp.me/ns#'
    ));

Close zendframework#6643

…some custom attributes can be added dynamically.

samsonasik · 2014-09-27T19:12:00Z

library/Zend/View/Helper/HtmlTag.php

+     * Retrieve object instance; optionally add attributes.
+     *
+     * @param array $attribs
+     * @return \Zend\View\Helper\HtmlTag


@return self

Obviously there is no consensus inside ZF2 codebase when it comes to that @return annotation in case of some fluent-interface method which returns self reference. Somewhere you will see self, while on some other place name of the class or a fully qualified class name, like in case of this class. I prefer that variant, so I would rather leave it as is. At least until some coding standard for this purpose is defined. :)

nikolaposa · 2014-09-28T09:14:20Z

I'm in doubt whether this is an appropriate view helper name. It is kind of undetermined, neutral. And it can also be confused with existing Html* helpers, like HtmlObject, HtmlPage, HtmlFlash, etc.

Any better ideas?

…Also added new test case for that method.

froschdesign · 2014-12-05T14:17:12Z

Why do I need to know the correct URL for XHTML, if I want to use the helper?
The helper should help me!

Please compare with the HeadLink helper.

Otherwise, the helper would be useless. (imo)

nikolaposa · 2014-12-05T18:15:07Z

Ok, good point. I will try to make same changes in that direction, but I'd rather limit those new "helping" abilities of this helper to standard, default attributes, like xmlns.

DASPRiD · 2014-12-05T18:31:51Z

With that example, how do you add multiple namespaces?

nikolaposa · 2014-12-05T18:48:08Z

I suppose that you are referring example from the initial description, so appropriate helper invocation might look like:

$this->html()->setAttributes(array(
    'xmlns' => 'http://www.w3.org/1999/xhtml',
    'xmlns:og' => 'http://ogp.me/ns#'
));

DASPRiD · 2014-12-05T18:51:48Z

And what was this for in the example?

    'prefix' => 'og: http://ogp.me/ns#'

nikolaposa · 2014-12-05T18:56:25Z

Open Graph protocol: http://ogp.me/. It is recommended that prefix attribute on the HTML tag is used in favor of xmlns, as advised in the top answer on this topic: http://stackoverflow.com/questions/8235687/open-graph-namespace-declaration-html-with-xmlns-or-head-prefix.

nikolaposa · 2014-12-05T19:02:10Z

By the way, I have created a ZF2 module which facilitates OG integration (https://github.com/nikolaposa/ZfOpenGraph), which internally relies on the HeadMeta helper. This proposal was created exactly because I lacked ability to dynamically attach necessary OG-specific attribute on the html tag itself, from the context of a OpenGraph view helper that I created.

…r the html tag based on currently set doctype.

nikolaposa · 2014-12-05T19:41:33Z

@froschdesign What do you think about that approach with setUseNamespaces() method that I've just added?

Martin-P · 2014-12-05T19:53:56Z

Please choose a better name for setAddDoctypeAttributes(). The method does not add doctype attributes (does a doctype have attributes?) and does not set (overwrite) doctype attributes either. Looking at the code it adds namespaces, perhaps it is better to reffer to that? IMHO setUseNamespaces() is a better name for this.

nikolaposa · 2014-12-05T20:00:57Z

Ok, thanks for the feedback, it makes sense.

…butes.

samsonasik · 2015-01-01T15:08:53Z

library/Zend/View/Helper/HtmlTag.php

+ * Zend Framework (http://framework.zend.com/)
+ *
+ * @link      http://github.com/zendframework/zf2 for the canonical source repository
+ * @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)


Do I really have to modify that? :) I also have some other PRs planned for 2.4.0 within which new classes are added, like this one: #6058, and I haven't got such remark from a code reviewer.

No, it will be done after merge. I don't feel like burdening existing PRs with these changes is needed at all ;-)

HtmlTag helper

Close #6709

- to 2015

Update copyright in new files introduced in #6709

weierophinney · 2015-02-23T18:54:28Z

Merged to develop for release in 2.4.

…eature/html_tag_helper HtmlTag helper

Close zendframework/zendframework#6709

- to 2015

Update copyright in new files introduced in zendframework/zendframework#6709

Ocramius and others added 3 commits September 24, 2014 21:34

Merge branch 'hotfix/zendframework#6643-is-null-removal'

f77f90b

Close zendframework#6643

Created helper used for rendering <html> tag of a web page, to which …

727b8d8

…some custom attributes can be added dynamically.

Fixing trailing spaces.

0cfdaca

samsonasik reviewed Sep 27, 2014
View reviewed changes

EvanDotPro force-pushed the master branch from f77f90b to 21a17e5 Compare September 28, 2014 00:35

Renamed HtmlTag::addAttributes() method to HtmlTag::setAttributes(). …

e8dcef2

…Also added new test case for that method.

Added ability for automatically pre-setting approrpiate attributes fo…

4781f5d

…r the html tag based on currently set doctype.

Choosing a better naming for the funtonality for pre-setting NS attri…

5bdee52

…butes.

Ocramius added enhancement View labels Dec 24, 2014

Ocramius self-assigned this Dec 24, 2014

Ocramius added this to the 2.4.0 milestone Dec 24, 2014

samsonasik reviewed Jan 1, 2015
View reviewed changes

weierophinney added a commit that referenced this pull request Feb 23, 2015

Merge pull request #6709 from nikolaposa/feature/html_tag_helper

f53030c

HtmlTag helper

weierophinney added a commit that referenced this pull request Feb 23, 2015

Merge branch 'feature/6709' into develop

9bdf1a3

Close #6709

weierophinney added a commit that referenced this pull request Feb 23, 2015

[#6709] Updated copyright

6e0b758

- to 2015

weierophinney added a commit that referenced this pull request Feb 23, 2015

Merge branch 'feature/6709' into develop

cf48419

Update copyright in new files introduced in #6709

weierophinney closed this Feb 23, 2015

weierophinney added a commit to zendframework/zend-view that referenced this pull request May 15, 2015

Merge pull request zendframework/zendframework#6709 from nikolaposa/f…

d965d92

…eature/html_tag_helper HtmlTag helper

weierophinney added a commit to zendframework/zend-view that referenced this pull request May 15, 2015

Merge branch 'feature/6709' into develop

a7a8f49

Close zendframework/zendframework#6709

weierophinney added a commit to zendframework/zend-view that referenced this pull request May 15, 2015

[zendframework/zendframework#6709] Updated copyright

3586e28

- to 2015

weierophinney added a commit to zendframework/zend-view that referenced this pull request May 15, 2015

Merge branch 'feature/6709' into develop

64a8215

Update copyright in new files introduced in zendframework/zendframework#6709

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

HtmlTag helper #6709

HtmlTag helper #6709

nikolaposa commented Sep 27, 2014

samsonasik Sep 27, 2014

nikolaposa Sep 27, 2014

nikolaposa commented Sep 28, 2014

froschdesign commented Dec 5, 2014

nikolaposa commented Dec 5, 2014

DASPRiD commented Dec 5, 2014

nikolaposa commented Dec 5, 2014

DASPRiD commented Dec 5, 2014

nikolaposa commented Dec 5, 2014

nikolaposa commented Dec 5, 2014

nikolaposa commented Dec 5, 2014

Martin-P commented Dec 5, 2014

nikolaposa commented Dec 5, 2014

samsonasik Jan 1, 2015

nikolaposa Jan 1, 2015

Ocramius Jan 1, 2015

weierophinney commented Feb 23, 2015

HtmlTag helper #6709

HtmlTag helper #6709

Conversation

nikolaposa commented Sep 27, 2014

Intent

Usage

samsonasik Sep 27, 2014

Choose a reason for hiding this comment

nikolaposa Sep 27, 2014

Choose a reason for hiding this comment

nikolaposa commented Sep 28, 2014

froschdesign commented Dec 5, 2014

nikolaposa commented Dec 5, 2014

DASPRiD commented Dec 5, 2014

nikolaposa commented Dec 5, 2014

DASPRiD commented Dec 5, 2014

nikolaposa commented Dec 5, 2014

nikolaposa commented Dec 5, 2014

nikolaposa commented Dec 5, 2014

Martin-P commented Dec 5, 2014

nikolaposa commented Dec 5, 2014

samsonasik Jan 1, 2015

Choose a reason for hiding this comment

nikolaposa Jan 1, 2015

Choose a reason for hiding this comment

Ocramius Jan 1, 2015

Choose a reason for hiding this comment

weierophinney commented Feb 23, 2015