CJSON::encode a javascript function

Question

I use jQuery widget factory (jQuery widgets) for my js widgets.

$.widget('cool.someWidget', {
     options: {
         onSomething: null
     }
     // other js code
});

Normally to run the widget from js you write

$(selector).someWidget({
    onSomething: function() { ..... }
});

In Yii I use CJSON::encode to compile all the initialization properties which include the onSomething event.

echo CJSON::encode(array(
    'onSomething' => 'function() {....}',
));

However due to the conversion (CJSON), it converts the function() {...} to a string so in the document it is written the following

$(selector).someWidget({
    onSomething: "function() { .... }"
});

because the onSomething is actually a string when I call the this._trigger('onSomething') it doesn't run the code.

This problem I have only when I "generate" the view and not with Ajax requests (which I handle differently in the system). Is there some "normal" way of making Yii actually write in the document the function withought the quotes?

I think this is what you're looking for : yiiframework.com/doc/api/1.1/CJavaScriptExpression — user1759474
– user1759474, Commented Oct 19, 2012 at 13:29

Nader Roua · Accepted Answer · 2013-06-08 18:17:06Z

3

There is actually a build in way to prevent the encode function from wrapping function declaration with quotes , you should add js: before your function declaration

CJavaScript::enocde(array(
   'prop'=>'value',
   'callback' => 'js:function(){}'
))

answered Jun 8, 2013 at 18:17

Nader Roua

6215 silver badges9 bronze badges

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

Comments

Jon · Accepted Answer · 2012-09-05 21:50:44Z

1

IMHO the premise of the question is flawed, and it would be much better if you side-stepped this issue entirely.

What is the problem here? You cannot supply JavaScript code as a PHP string.

Why do you want to do that? I don't believe a compelling reason exists. JavaScript code should be written as JavaScript code; writing it as a string is simply worse.

It is quite probable that you wanted to pass a bunch of options available to you as PHP variables to the plugin, and in the excitement it seemed a good idea to pass all the options (including those that are functions) in the same manner.

But there is another way, courtesy of $.extend: use CJSON::encode for all the scalars (strings, numbers) and switch back to pure JavaScript for the callbacks.

$(selector).someWidget($.extend(
    <?php echo CJSON::encode(array(/* no functions here, just scalars */));?>,
    { // and now, back in JavaScript-land, code follows:
        onSomething: function() { ..... }
    }
));

answered Sep 5, 2012 at 21:50

Jon

439k85 gold badges756 silver badges820 bronze badges

4 Comments

ptheofan Over a year ago

It feels fare to be able to do that. Yii has the CJSON so it correctly encodes all strings to strings. But sometimes all you need to do "bind" plugins in a chain is to run a function of a plugin on the event of another. As to why I want to do that in PHP (Yii)? So my widgets can correctly write everything and not suffer from the overhead of selecting and binding.

roman Over a year ago

This should be the answer, imho

trejder Over a year ago

@Jon: We're talking about widgets here. Reusable pieces of code, Yii developers can insert into their applications. How would you like to pass Javascript code in this case? As you can see, a compelling reason does exist. And, now what? You throw you hat in, and when defeated with a good quality argument, you're not even willing to respond? How polite...

Jon Over a year ago

@trejder: The astute reader will notice that while jQuery widgets are specifically referenced in the question, Yii widgets are not. There's a reference to Yii of course but nothing in the question talks about Yii widgets. There is even nothing in the comment above referring to Yii widgets. There's also nothing like that in the OP's "final solution" below. So before going around accusing people, perhaps checking your assumptions would be in order.

ptheofan · Accepted Answer · 2012-09-05 20:30:47Z

0

I wrote the following function which does exactly what I wanted. Still if there's some native Yii solution I'd really love to know it.

public function encodeOpts($data, $jsCode = null) {
    $rVal = CJSON::encode($data);

    if ($jsCode == null)
        return $rVal;

    foreach($jsCode as $key => $code) {
        $codeEntries[] = "\"{$key}\": {$code}";
    }

    return substr_replace($rVal, ', ' . implode(', ', $codeEntries), -1) . '}';
}

answered Sep 5, 2012 at 20:30

ptheofan

2,3003 gold badges25 silver badges37 bronze badges

Comments

Igor Parra · Accepted Answer · 2013-08-22 17:21:10Z

0

I solved like this:

if ($this->user_options !== null && is_array($this->user_options))
{
    $reqs = CJavaScript::encode(
        array_merge(
            $this->user_options,
            array(
                // adding a default callback to options 
                'onLoad' => 'js: function() {$("#info").text("Hi")}'
                )
            )
        );
}

NOTE: js: only works for CJavaScript not forCJSON

answered Aug 22, 2013 at 17:21

Igor Parra

10.4k10 gold badges74 silver badges104 bronze badges

Collectives™ on Stack Overflow

CJSON::encode a javascript function

4 Answers 4

Comments

4 Comments

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

Comments

4 Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related