How to pass literal JavaScript code to Yii framework methods?

Question

I am generating a checkbox using the corresponding method of CHtml, and I want to run some JavaScript code before and after the AJAX request. Here is the code:

echo CHtml::checkBox('markComplete', FALSE, 
    array(
        'class' => 'markComplete',
        'ajax'  => array(
            'type'       => 'POST',
            'url'        => $this->createUrl('/events/events/MarkComplete'),
            'data'       => 'event_status='.$events['id'],
            'beforeSend' => 'function(){ $(this).parent("TR").hide(); }',
            'success'    => 'function(resp) { $("#right").append(resp); }'
        ),
    )
);

How can I tell Yii that beforeSend and success are JavaScript code and not plain strings?

Jon · Accepted Answer · 2013-05-20 15:20:21Z

4

Better option available starting from Yii 1.1.11

All framework classes now support custom JavaScript snippets through CJavaScriptExpression. Use it like this:

'ajax' => array(
    'beforeSend' => new CJavaScriptExpression(
        'function(){ $(this).parent("TR").hide(); }'
    ),
    // ...
)

The option of prefixing strings with js: is still available by default, but it can now be disabled as required using an optional parameter on CJavaScript::encode.

Original answer

If you want to include literal JavaScript code as part of options, the convention in Yii is to prefix the code with js:. So you would write it like this:

'ajax' => array(
    'type'=>'POST',
    'url'=>$this->createUrl('/events/events/MarkComplete'),
    'data'=>'event_status='.$events['id'],
    'beforeSend' => 'js:function(){            
        $(this).parent("TR").hide();

    }',
    'success'=>'js:function(resp) {
        $("#right").append(resp);

    }'
    ),
)

Unfortunately this is not well documented, which is why people run into exactly this problem every now and then.

edited May 20, 2013 at 15:20

answered May 4, 2012 at 10:49

Jon

439k85 gold badges756 silver badges820 bronze badges

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

3 Comments

Alizain Prasla Over a year ago

if console.log it... it show error on firebug console. ** elem.nodeName is undefined [Break On This Error] ...ks = jQuery.valHooks[ elem.nodeName.toLowerCase() ] || jQuery.valHooks[ elem.typ... jquery.js (line 2317)**

Alizain Prasla Over a year ago

when i print $(this) in console it returns me ajax object

Jon Over a year ago

@AlizainPrasla: That means that your code needs debugging, not that putting js: in front isn't what you should do. So go ahead and debug it; unfortunately I can't help with that.

Collectives™ on Stack Overflow

How to pass literal JavaScript code to Yii framework methods?

1 Answer 1

Better option available starting from Yii 1.1.11

Original answer

3 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Better option available starting from Yii 1.1.11

Original answer

3 Comments

Your Answer

Sign up or log in

Post as a guest

Related