从Yii中的registerScript方法强制执行脚本顺序

时间:2012-07-25 14:18:12

标签: php yii

我创建了一个小部件,可以注册自己的脚本,如下所示

class MyWidget extends CWidget {
    public function run(){
        Yii::app()->clientScript->registerScript(__CLASS__, <<<JAVASCRIPT
var a = "Hello World!";
JAVASCRIPT
        , CClientScript::POS_END);
    }
}

在布局中,我像这样调用小部件

<?php $this->widget('MyWidget');?>
<?php echo $content;?>

但是在视图文件中,我需要该窗口小部件声明的变量。

<?php 
Yii::app()->clientScript->registerScript('script', <<<JAVASCRIPT
    alert(a);
JAVASCRIPT
    , CClientScript::POS_END);
?>

请注意,在两个registerScript方法中,我都使用POS_END作为脚本位置,因为我打算在<body>标记之后放置所有脚本(包括CoreScript,例如jQuery,jQueryUI等)。

问题在于渲染的脚本将显示视图文件中的一个,然后是小部件中的一个。

alert(a);
var a = "Hello World!";

正如我们所看到的,上面的代码不起作用所以我需要将第二行放在第一行之上。

关于如何强制下单的任何想法?我可以扩展CClientScript(并创建一个新的registerScript方法),只要所有脚本都在最终位置呈现,我不必拉这些内联的Javascript代码以上是一个新的包或文件。

5 个答案:

答案 0 :(得分:8)

所以我终于找到了一个黑客来做到这一点。我扩展了一个新的ClientScript类并修改了registerScript方法,因此它将接受另一个参数$level

public function registerScript($id, $script, $position = self::POS_END, $level = 1);

在CSS中考虑$levelz-index一样,除了$level的数量越大,脚本的位置就越低。

例如

Yii::app()->clientScript->registerScript('script1', '/** SCRIPT #1 **/', CClientScript::POS_END, 1);
Yii::app()->clientScript->registerScript('script2', '/** SCRIPT #2 **/', CClientScript::POS_END, 2);
Yii::app()->clientScript->registerScript('script3', '/** SCRIPT #3 **/', CClientScript::POS_END, 1);

即使在script3之后声明了script2,但在呈现的脚本中,由于script2的{​​{1}}值大于$level,因此它会显示在script2之上script3

这是我的解决方案的代码。虽然我不确定排列方法是否足够优化,但它的工作方式与我想要的一样。

/**
 * ClientScript manages Javascript and CSS.
 */
class ClientScript extends CClientScript {
    public $scriptLevels = array();

    /**
     * Registers a piece of javascript code.
     * @param string $id ID that uniquely identifies this piece of JavaScript code
     * @param string $script the javascript code
     * @param integer $position the position of the JavaScript code.
     * @param integer $level the rendering priority of the JavaScript code in a position.
     * @return CClientScript the CClientScript object itself (to support method chaining, available since version 1.1.5).
     */
    public function registerScript($id, $script, $position = self::POS_END, $level = 1) {
        $this->scriptLevels[$id] = $level;
        return parent::registerScript($id, $script, $position);
    }

    /**
     * Renders the registered scripts.
     * Overriding from CClientScript.
     * @param string $output the existing output that needs to be inserted with script tags
     */
    public function render(&$output) {
        if (!$this->hasScripts)
            return;

        $this->renderCoreScripts();

        if (!empty($this->scriptMap))
            $this->remapScripts();

        $this->unifyScripts();

        //===================================
        //Arranging the priority
        $this->rearrangeLevels();
        //===================================

        $this->renderHead($output);
        if ($this->enableJavaScript) {
            $this->renderBodyBegin($output);
            $this->renderBodyEnd($output);
        }
    }


    /**
     * Rearrange the script levels.
     */
    public function rearrangeLevels() {
        $scriptLevels = $this->scriptLevels;
        foreach ($this->scripts as $position => &$scripts) {
            $newscripts = array();
            $tempscript = array();
            foreach ($scripts as $id => $script) {
                $level = isset($scriptLevels[$id]) ? $scriptLevels[$id] : 1;
                $tempscript[$level][$id] = $script;
            }
            foreach ($tempscript as $s) {
                foreach ($s as $id => $script) {
                    $newscripts[$id] = $script;
                }
            }
            $scripts = $newscripts;
        }
    }
}

所以我只需要将类作为clientScript组件放在config

'components' => array(
  'clientScript' => array(
      'class' => 'ClientScript'
  )
)

答案 1 :(得分:1)

尝试注册HEAD

Yii::app()->clientScript->registerScript(__CLASS__, <<<JAVASCRIPT
var a = "Hello World!";
JAVASCRIPT
, CClientScript::POS_HEAD);

答案 2 :(得分:1)

我为Yii提供了一个补丁,允许订购(前置,追加,号码)

你可以在这里找到它 https://github.com/yiisoft/yii/pull/2263

如果它没有找到你的位置,那么你可以将CClientScript扩展到你自己的类来应用我的更改

但一般来说,正确编写的JS应该独立于订单工作 例如,不是定义一些全局范围变量,而是可以将它们作为属性分配给窗口(访问不存在的属性不会在js中引发错误)

答案 3 :(得分:0)

无需扩展CClienScript。解决此问题的一个简单方法是在控制器的控制器中创建$ script数组,并将视图脚本添加到该变量中。在布局文件中,在注册了要在其之前呈现的脚本之后,您将注册存储在$ scripts数组中的脚本。 e.g:

控制器中的

public $scripts = [];

在您的布局中:

$baseURL = Yii::app()->request->baseUrl;
$clientScript = Yii::app()->clientScript;
$clientScript->registerScriptFile( $baseURL . '/js/jquery.min.js', CClientScript::POS_END );
$clientScript->registerScriptFile( $baseURL . '/js/bootstrap.min.js', CClientScript::POS_END);

并在您的视图中

<?php array_push($this->scripts,"/js/summernote.min.js");?>

答案 4 :(得分:0)

覆盖CClientScript类,因为@Petra说,这是我使用的代码,在使用@Petra代码之后,并没有为我解决。

class ClientScript extends CClientScript {

public $scriptLevels;

public function registerScript($id, $script, $position = null, $level = 1, array $htmlOptions = array()) {
    $this->scriptLevels[$id] = $level;
    return parent::registerScript($id, $script, $position, $htmlOptions);
}

public function render(&$output) {
    foreach ($this->scripts as $key => $value) {
        $this->scripts[$key] = $this->reorderScripts($value);
    }
    parent::render($output);
}

public function reorderScripts($element) {
    $tempScripts = array();
    $buffer = array();
    foreach ($element as $key => $value) {
        if (isset($this->scriptLevels[$key])) {
            $tempScripts[$this->scriptLevels[$key]][$key] = $value;
        }
    }
    ksort($tempScripts);
    foreach ($tempScripts as $value) {
        foreach ($value as $k => $v) {
            $buffer[$k] = $v;
        }
    }
    return $buffer;
}

}

然后转到配置文件,在组件部分编辑以下内容:

'components' => array(
    .
    .
    'clientScript' => array(
        'class' => 'ClientScript'
    ),
)