How should components add JavaScript and CSS in Symfony

Question

My layout.php calls include_javascripts() before my componet could call sfResponse::addJavascript(). Is there a "helper" or a "best practice" to handle this?

Do I have to Seperate the call sfResponse::addJavascript()? I were happy to avoid it.

Here ist my actual workaround:

<head>
  <?php $nav = get_component('nav', 'nav') /* Please show me a better way. */ ?>
  <?php include_javascripts() ?>
  ...
</head>
<body>
  <?php /* include_component('nav', 'nav') */ ?>
  <?php echo $nav ?>
  ...
</body>

Thanks

Tom · Accepted Answer · 2010-02-16 02:49:22Z

11

From: http://www.symfony-project.org/book/1_2/07-Inside-the-View-Layer

File Inclusion Configuration

// In the view.yml

indexSuccess:
  stylesheets: [mystyle1, mystyle2]
  javascripts: [myscript]

// In the action

$this->getResponse()->addStylesheet('mystyle1'); 
$this->getResponse()->addStylesheet('mystyle2'); 
$this->getResponse()->addJavascript('myscript');

// In the Template

<?php use_stylesheet('mystyle1') ?>
<?php use_stylesheet('mystyle2') ?>
<?php use_javascript('myscript') ?>

answered Feb 16, 2010 at 2:49

Tom

30.8k27 gold badges94 silver badges126 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

nortron · Accepted Answer · 2010-02-16 05:16:53Z

3

If your component is always used just move your javascript inclusion into the layout's rendering in your app's view.yml:

default:
  javascripts: [my_js]

There is no need to separate the JS call when it is always used.

UPDATE:

If you must maintain the JS inclusion with the component you can place your component call in a slot before your include_javascripts() call to add it to the stack to be rendered and then include the slot in the appropriate place:

<?php slot('nav') ?>
<?php include_component('nav', 'nav'); ?>
<?php end_slot(); ?>
<html>
  <head>
    <?php include_javascripts() ?>
    ...
  </head>
  <body>
    <?php include_slot('nav'); ?>
    <?php echo $nav ?>
    ...
  </body>
</html>

edited Feb 16, 2010 at 5:16

answered Feb 14, 2010 at 7:27

nortron

3,9031 gold badge27 silver badges27 bronze badges

2 Comments

koalabruder Over a year ago

And when I remove the component I have to stress my brain to clean the view.yml? If I remember and if I have no dependencies?

nortron Over a year ago

@koalabruder: Yes, you would have to remember to remove the JS as well. If you really must have the JS in the component file then you'll want to move the component inclusion into a slot. I've updated my answer with the details.

timmow · Accepted Answer · 2010-02-13 12:28:21Z

0

You may have to disable the sfCommonFiter which is now deprecated. The common filter automatically adds css / js into the layout.

Once you have done this, you can move the include_javascripts call anywhere within the layout.php file, below the include_component('nav', 'nav') call

answered Feb 13, 2010 at 12:28

timmow

3,6232 gold badges26 silver badges22 bronze badges

1 Comment

Felix Kling Over a year ago

This wont work for CSS as include_css returns link tags which are not allowed inside body. And I guess the sfCommonFilter has little to do with the problem. In fact, I guess it was working with this filter, as the link and script tags where added through this filter after the template was rendered. It may work with include_javascripts though.

Collectives™ on Stack Overflow

How should components add JavaScript and CSS in Symfony

3 Answers 3

Comments

2 Comments

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

Comments

2 Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related