从PHP生成Javascript / ExtJS代码最可维护的方法是什么？

时间：2011-01-27 12:46:16

标签： php javascript extjs code-generation

我正在创建一个PHP框架，它允许PHP开发人员仅使用PHP类创建ExtJS前端，例如创建网格如下所示：

$grid_import = new Backend_Layout_Grid('smart_worksheets');
$grid_import->set_width(1300);
$grid_import->set_rows_selectable(true);
$grid_import->set_title(__('backend.application.import.grid.title'));
$grid_import->set_margin('10px'); //CSS syntax, e.g. also "10px 0 0 0"
$grid_import->add_column(array('id_code'=>'name', 'label'=> __('backend.application.import.worksheetstoimport'), 'width'=>'300'));
$grid_import->add_column(array('id_code'=>'kind', 'label'=> __('backend.application.import.kind'), 'width'=>'50'));
$grid_import->add_column(array('id_code'=>'file_size', 'label'=> __('backend.application.import.sizebyte'), 'datatype' => 'int'));
$grid_import->add_column(array('id_code'=>'when_file_copied', 'label'=> __('backend.application.import.whenfilecopied'), 'datatype' => 'datetime', 'width'=>'150'));
$grid_import->add_column(array('id_code'=>'table_name', 'label'=> __('backend.application.import.mysqltablename'), 'width'=>'300'));
$grid_import->add_column(array('id_code'=>'when_table_created', 'label'=> __('backend.application.import.whentablecreated'), 'width'=>'160'));
$grid_import->add_column(array('id_code'=>'status', 'label'=> __('backend.application.import.status'), 'width'=>'300'));

$grid_import->set_doubleclick_target_uri('backend/application/importmanager/single', 0);

if (count($smart_worksheets) > 0)
{
    $row_index = 0;
    foreach ($smart_worksheets as $smart_worksheet)
    {
        $show_row = array(
            'name' => $smart_worksheet['name'],
            'kind' => $smart_worksheet['kind'],
            'file_size' => $smart_worksheet['file_size'],
            'when_file_copied' => $smart_worksheet['when_file_copied'],
            'table_name' => $smart_worksheet['table_name'],
            'when_table_created' => __($smart_worksheet['when_table_created']),
            'status' => __($smart_worksheet['status'])
        );
        $grid_import->add_row($show_row);
        if(in_array($smart_worksheet['status'], array('backend.application.import.status.needtoimport', 'backend.application.import.status.needtoreimport'))) {
            $grid_import->add_row_format($row_index, Backend_Layout_Grid::ROW_FORMAT_RED);
        }
        if(in_array($smart_worksheet['status'], array('backend.application.import.status.isuptodate'))) {
            $grid_import->add_row_format($row_index, Backend_Layout_Grid::ROW_FORMAT_GREEN);
        }

        if(intval($smart_worksheet['file_size']) > 4000000 AND (in_array($smart_worksheet['kind'], array('XLS','XLSX'))))
        {
            $grid_import->add_row_format($row_index, Backend_Layout_Grid::ROW_FORMAT_GRAY);
        }

        $row_index++;
    }
}

Backend_Layout_Window::instance()->add_item($grid_import);

到目前为止它运行良好，但由于我只是逐行输出javascript代码，我在类中构建的功能越多，if / then逻辑在构建原始Javascript文本时就越复杂，这里是典型方法，可生成Javascript代码：

public function render_main_code_block()
{
    $retval = '';

    $retval .= $this->render_data_variable();
    $retval .= $this->render_array_reader_block();
    $retval .= $this->render_grid_panel_block();


    if($this->rows_selectable)
    {
        $retval .= self::render_line("````}),");
        $retval .= self::render_line("````sm: sm,");
    }

    $retval .= self::render_line("````viewConfig: {");


    if ($this->percentage_columns)
    {
        $retval .= self::render_line("``````forceFit: true,"); // true = percentage column width (add up to 100)
    }
    else
    {
        $retval .= self::render_line("``````forceFit: false,");
    }

    $retval .= self::render_line("``````getRowClass: function(record, rowIndex, rp, ds){");
    if (count($this->row_formats) > 0)
    {
        foreach ($this->row_formats as $row_index => $row_format)
        {
            $retval .= self::render_line("````````if(rowIndex == ".$row_index."){");
            $retval .= self::render_line("``````````return '".$row_format."';");
            $retval .= self::render_line("````````}");
        }
    }
    $retval .= self::render_line("````````return '';");
    $retval .= self::render_line("``````}");
    $retval .= self::render_line("````},");

    $retval .= self::render_line("````title: '$this->title',");
    if ( ! is_null($this->width))
    {
        $retval .= self::render_line("````width: $this->width,");
    }
    $retval .= $this->render_double_click_handler();
    $retval .= self::render_line("````autoHeight: true,");
    $retval .= self::render_line("````frame: true");
    $retval .= self::render_line("``});");
    $retval .= self::render_line("");

    $retval .= self::render_line("``replaceComponentContent(targetRegion, ".$this->script_variable_name.");");
    $retval .= self::render_line("``".$this->script_variable_name.".getSelectionModel().selectFirstRow();");


    // for word wrapping in columns
    $retval .= self::render_line("``function columnWrap(val){");
    $retval .= self::render_line("````return '<div style=\"white-space:normal !important;\">'+ val +'</div>';");
    $retval .= self::render_line("``}");

    return $retval;
}

一些特殊问题开始使这段代码太复杂而无法维护：

  • 一个简单的事实，即在属性列表中，只有最后一项没有逗号。到目前为止，我已经能够在列表的末尾添加必需的属性，以便始终包含没有逗号的项目。

enter image description here

  • 和一些功能（例如向网格添加复选框）需要在javascript代码中最多四个不同位置插入代码，我可以想象有些功能需要现有的要重构的代码，因此如果打开该功能，则周围的代码需要是例如包含在对象的另一部分中

所以在某些时候我想重构我创建Javascript的方式。

我目前只看到一个选项，以创建例如一个CodeFactory类，包含例如ExtJsVariable我以递归方式添加包含对象的对象，对象可以是例如simpleArray或anonymousFunction等，然后创建我输出的代码$codeFactory->render()，它会根据所有内部对象提供代码：

enter image description here

我可以使用哪些其他选项或代码生成框架来使PHP生成这个Javascript / ExtJS代码更易于维护和简单？

3 个答案:

答案 0 :(得分：2)

最好的方法是尽可能动态地避免JS生成，并将所有Javascript保存在静态JS文件中（最有可能是工厂，构建器）。并使用从服务器生成的JSON数据提供它们。这会严重改善结构，使您的应用程序更容易维护。您可能想了解Factory和Builder模式。

答案 1 :(得分：0)

事实上，我一直在通过类似的方式从PHP创建ExtJS代码，或者特别是从CakePHP创建。

在我的公司，我负责创建应用程序框架，这将加速应用程序的生产，所以我实际上推出了第一代框架，它类似于你的想法：通过PHP生成代码。

然后很快我意识到服务器非常重，速度慢。您获得的每个请求都需要重新生成代码，这是不切实际的。我与第二代出来后不久，具有缓存能力。生成的JS代码被缓存到静态文件中，并在需要时动态包含。缓存的原因是因为大多数时候JS代码是静态的，更改是内容，存储等。

所以这种方法可以工作几个月，直到我终于意识到这不是正确的方法，例如，

  • TreePanel无法通过这种方式生成，尤其是动态菜单。
  • ACL无法干扰缓存代码
  • 网格中不能包含动态列
  • 我的框架设计得非常糟糕，我需要在看到结果之前缓存代码 - 慢速开发。
  • 难以维持，难以打电话。添加一个配置或删除一个配置等简单的事情可能很乏味。就像用FormHelper来完成简单的东西一样乏味。

然后我完全重写了我的代码库，重新设计了所有内容，直到我想出了当前漂亮的ExtJS + CakePHP框架，其中：

  • 创建了Generic GridPanel / Store / View / Pagination / Editor组件，只需一些简单的配置，您就可以获得一个完整的REST网格，它可以连接到Cake的一个控制器。在Cake中，您可以包含一个专门设计的组件，只需几行代码就可以创建一个完整的REST网格。
  • 特别设计的Viewport，提供类似的外观和感觉，使用特别设计的TreePanel（菜单），TabPanel（内容）
  • 许多其他通用的，有用的组件被打包在一起，如Wizard，FieldEditor，UserImport ......等。
  • 因为它们都是可扩展的ExtJS组件，您可以使用它，扩展它，完全自定义它，无论您想要什么。

很抱歉，如果这听起来不对你，但我个人已经完成了这个，我对PHP生成代码的结果非常不满意。你最终会使整个过程变得复杂，或者让事情变得缓慢。

顺便说一句，对不起我的英语不好。感谢您阅读本文。

我不能分享我的代码，也不能开源，因为它是公司财产的一部分。

答案 2 :(得分：0)

我会提出一些建议，因为我也做了一些。

首先尽可能多地移动到库类中 其次，您可以创建PHP数据结构并将其转换为json_encode

的JSON

最后保持简单！

相关问题
最新问题