うえちょこ＠ぼろぐ» symfony

[OpenPNE3]管理画面付きプラグイン(opFreepagePlugin)#5 ルーティング拡張でプラグイン独自のURL

Posted under OpenPNE3,php,symfony by uechoco on 日曜日 1 3月 2009 at 10 : 10 : 25

前回まででほとんどの機能は完成しています。今回は利便性の向上を目的として、ルーティングの拡張を行います。前回までの内容ですと、フリーページにアクセスする際は/freepage/id/1といったURLでした。どうせなら、/id/というのを削りたいですね。しかしながら、プラグインとして追加する以上、サイト管理者にrouting.ymlを書き換えてもらうなどという対応はよろしくありません。OpenPNE3のベースとなるsymfonyではプラグインからルーティングを拡張するための仕組みが用意されています。symfony 1.1 日本語マニュアル第17章 - symfonyを拡張する - プラグインの機能にもその記述があります。OpenPNE3.0系ではこの機能にのっとってルーティング拡張をしているようです。

早速試してみましょう。/plugins/opFreepagePlugin/config/config.phpを新規作成し、以下の内容を追加します。

php:

<?php
$this->dispatcher->connect('routing.load_configuration', array('opFreepagePluginRouting', 'listenToRoutingLoadConfigurationEvent'));
?>

そして、/plugins/opFreepagePlugin/lib/opFreepagePluginRouting.class.phpを新規作成し、以下の内容を記述します。

php:

<?php
class opFreepagePluginRouting
{
  static public function listenToRoutingLoadConfigurationEvent(sfEvent $event)
  {
    $routing = $event->getSubject();
 
    $routes = array(
      'freepage_id' => new sfPropelRoute(
        '/freepage/:id',
        array('module' => 'freepage', 'action' => 'index'),
        array('id' => '\d+'),
        array('model' => 'Freepage', 'type' => 'object')
      ),
    );
 
    $routes = array_reverse($routes);
    foreach ($routes as $name => $route)
    {
      $routing->prependRoute($name, $route);
    }
  }
}

さきほどご紹介したマニュアルのページとは少しソースコードの形式が違っていますね。これはopDiaryPluginのルーティング拡張部分を参考にしたコードです。特徴としては、配列によって簡単にルーティング設定を追加することができるようになっています。

これだけでURLが変わります。

BASH:

./symfony cc

でキャッシュをクリアして、新しいルーティングを適応させます。

試しに/freepage/1、/mobile_frontend.php/freepage/1とURLを打ってみてください。ちゃんとアクセスできると思います。

次回は最終回です。OpenPNE3のプラグインのパッケージング方法をご紹介したいと思います。

Comments (0)

[OpenPNE3]管理画面付きプラグイン(opFreepagePlugin)#4 PC/モバイルの動作画面の作成

Posted under OpenPNE3,php,symfony by uechoco on 金曜日 27 2月 2009 at 11 : 36 : 23

前回まででopFreepagePluginの管理画面側は完成しています。今回はいよいよＰＣとモバイルの動作画面を作ります。

まずはPC版から。symfonyコマンドでpc_frontendのappとmoduleを作ります。moduleはfreepageという名前にします。

BASH:

./symfony opGenerate:app opFreepagePlugin pc_frontend
./symfony opGenerate:module opFreepagePlugin pc_frontend freepage

新しく作られたapps/pc_frontend/modules/freepage/actions/actions.class.phpのexecuteIndexメソッドを変更します。

php:

public function executeIndex($request)
  {
    // forward 404 page unless freepage does exist
    $this->forward404Unless($this->freepage = FreepagePeer::retrieveByPk($request->getParameter('id')), sprintf('Object freepage does not exist (%s).', $request->getParameter('id')));
 
    if ($this->freepage->getAuth()) {
      if (($member = $this->getUser()->getMember()) && $member->getIsActive()) {
        // ok
      } else {
        $this->forward404('This page is for sns members.');
      }
    }
 
    // forward 404 page unless app_type is 'pc';
    $this->forward404Unless($this->freepage->getAppType() == 'pc', sprintf('This page is for %s application.', $this->freepage->getAppType()));
 
    $this->getResponse()->setTitle($this->freepage->getTitle());
  }

このIndexアクションでは、

idがパラメータとして存在するか
パラメータidがfreepageテーブルに存在するか
該当フリーページが認証付きページの場合、認証済みのユーザであるかどうか
該当フリーページがPC用かどうか

をチェックしています。認証済みユーザの認証部分の処理はもっとスマートな方法がありそうですね。近いうちに調べてみます。続いてさきほど自動生成されたapps/pc_frontend/modules/freepage/templates/indexSuccess.phpにも変更を加えます。

php:

<?php echo $sf_data->getRaw('freepage')->getBody(); ?>

今回は本質的ではないのでデザインを考慮していません。大事なポイントは、HTMLエンティティがエスケープされていない生のデータを取得して、表示しているところです。こうしないと管理画面で苦労して書いたタグがそのまま出てしまうことになるので、生データを出力します。

これでPC版は完成です。（http://example.com/freepage/id/1）

続いてモバイル版も作りましょう。ほとんど同じ手順で作ることができます。まずはmobile_frontend appを作り、freepage moduleを追加します。

BASH:

./symfony opGenerate:app opFreepagePlugin mobile_frontend
./symfony opGenerate:module opFreepagePlugin mobile_frontend freepage

自動生成されたapps/mobile_frontend/modules/freepage/actions/actions.class.phpを書き換えます。PC版との違いはPC/mobile判定部分だけです。

php:

public function executeIndex($request)
  {
    // forward 404 page unless freepage does exist
    $this->forward404Unless($this->freepage = FreepagePeer::retrieveByPk($request->getParameter('id')), sprintf('Object freepage does not exist (%s).', $request->getParameter('id')));
 
    if ($this->freepage->getAuth()) {
      if (($member = $this->getUser()->getMember()) && $member->getIsActive()) {
        // ok
      } else {
        $this->forward404('This page is for sns members.');
      }
    }
 
    // forward 404 page unless app_type is 'mobile';
    $this->forward404Unless($this->freepage->getAppType() == 'mobile', sprintf('This page is for %s application.', $this->freepage->getAppType()));
 
    $this->getResponse()->setTitle($this->freepage->getTitle());
  }
[/phpocde]
 
そしてapps/mobile_frontend/modules/freepage/templates/indexSuccess.phpを変更します。こちらはデザインが入っていないのでPC版の同ファイルと同じ内容です。
[phpcode]
<?php echo $sf_data->getRaw('freepage')->getBody(); ?>

モバイル版も完成です。（http://example.com/mobile_frontend.php/freepage/id/1）

次回はルーティングの調整をします。

Comments (0)

[OpenPNE3]管理画面付きプラグイン(opFreepagePlugin)#3 管理画面編集フォーム作成

Posted under OpenPNE3,php,symfony by uechoco on 木曜日 19 2月 2009 at 22 : 46 : 10

　前回はopFreepagePluginの管理画面の一覧表示部分を作ってみました。今回はそこにデータを追加するための新規作成・編集削除の2画面を一気に作ります。symfonyを使ったことある人ならば、「propel:generate-crud的な感じ」と言えばソースコードの構成が伝わるかもしれません。

まずはactions.class.phpに以下の6つのメソッドを追加します。

php:

public function executeNew(sfWebRequest $request)
  {
    $this->form = new FreepageForm();
  }
 
  public function executeCreate(sfWebRequest $request)
  {
    $this->forward404Unless($request->isMethod('post'));
 
    $this->form = new FreepageForm();
 
    $this->processForm($request, $this->form);
 
    $this->setTemplate('new');
  }
 
  public function executeEdit(sfWebRequest $request)
  {
    $this->forward404Unless($freepage = FreepagePeer::retrieveByPk($request->getParameter('id')), sprintf('Object freepage does not exist (%s).', $request->getParameter('id')));
    $this->form = new FreepageForm($freepage);
  }
 
  public function executeUpdate(sfWebRequest $request)
  {
    $this->forward404Unless($request->isMethod('post') || $request->isMethod('put'));
    $this->forward404Unless($freepage = FreepagePeer::retrieveByPk($request->getParameter('id')), sprintf('Object freepage does not exist (%s).', $request->getParameter('id')));
    $this->form = new FreepageForm($freepage);
 
    $this->processForm($request, $this->form);
 
    $this->setTemplate('edit');
  }
 
  public function executeDelete(sfWebRequest $request)
  {
    $request->checkCSRFProtection();
 
    $this->forward404Unless($freepage = FreepagePeer::retrieveByPk($request->getParameter('id')), sprintf('Object freepage does not exist (%s).', $request->getParameter('id')));
    $freepage->delete();
 
    $this->redirect('opFreepagePlugin/list');
  }
 
  protected function processForm(sfWebRequest $request, sfFormPropel $form)
  {
    $form->bind($request->getParameter($form->getName()), $request->getFiles($form->getName()));
    if ($form->isValid())
    {
      $freepage = $form->save();
      $this->redirect('opFreepagePlugin/list');
    }
  }

これでもうアクションの追加は終わりです。あとは対応するビューの作成とフォームの調整です。

templates/ディレクトリにnewSuccess.phpを作成し、以下のコードを入力します。

php:

<?php slot('submenu') ?>
<?php include_partial('submenu') ?>
<?php end_slot() ?>
 
<h2><?php echo __('フリーページの新規作成') ?></h2>
 
<?php include_partial('form', array('form' => $form)) ?>

続いて、editSuccess.phpを作成し、以下のコードを入力します。

php:

<?php slot('submenu') ?>
<?php include_partial('submenu') ?>
<?php end_slot() ?>
 
<h2><?php echo __('フリーページの編集') ?></h2>
 
<?php include_partial('form', array('form' => $form)) ?>

この2つのビューは新規作成と編集画面に対応するものですが、非常に似ていますし、短いですね。というのも、肝心のフォームの描画は部分テンプレートとして分離しています。templares/ディレクトリに_form.phpを作成して、以下のコードを追加します。

php:

<?php include_stylesheets_for_form($form) ?>
<?php include_javascripts_for_form($form) ?>
 
<form action="<?php echo url_for('opFreepagePlugin/'.($form->getObject()->isNew() ? 'create' : 'update').(!$form->getObject()->isNew() ? '?id='.$form->getObject()->getId() : '')) ?>" method="post" <?php $form->isMultipart() and print 'enctype="multipart/form-data" ' ?>>
<?php if (!$form->getObject()->isNew()): ?>
<input type="hidden" name="sf_method" value="put" />
<?php endif; ?>
  <table>
    <tfoot>
      <tr>
        <td colspan="2">
          <?php echo $form->renderHiddenFields() ?>
          &nbsp;<a href="<?php echo url_for('opFreepagePlugin/index') ?>">キャンセル</a>
          <?php if (!$form->getObject()->isNew()): ?>
            &nbsp;<?php echo link_to('削除', 'opFreepagePlugin/delete?id='.$form->getObject()->getId(), array('method' => 'delete', 'confirm' => '本当に削除しますか？')) ?>
          <?php endif; ?>
          <input type="submit" value="<?php echo $form->getObject()->isNew() ? '作成' : '更新' ?>" />
        </td>
      </tr>
    </tfoot>
    <tbody>
      <?php echo $form->renderGlobalErrors() ?>
      <tr>
        <th><?php echo $form['title']->renderLabel() ?></th>
        <td>
          <?php echo $form['title']->renderError() ?>
          <?php echo $form['title'] ?>
        </td>
      </tr>
      <tr>
        <th><?php echo $form['body']->renderLabel() ?></th>
        <td>
          <?php echo $form['body']->renderError() ?>
          <?php echo $form['body'] ?>
        </td>
      </tr>
      <tr>
        <th><?php echo $form['app_type']->renderLabel() ?></th>
        <td>
          <?php echo $form['app_type']->renderError() ?>
          <?php echo $form['app_type'] ?>
        </td>
      </tr>
      <tr>
        <th><?php echo $form['auth']->renderLabel() ?></th>
        <td>
          <?php echo $form['auth']->renderError() ?>
          <?php echo $form['auth'] ?>
        </td>
      </tr>
    </tbody>
  </table>
</form>

この_form部分テンプレートは、新規作成と編集の両方に対応しているテンプレートですので、ところどころで三項演算子の分岐で新規作成時と編集時の描画内容を分けています。このようにフォームの描画部分を１つのファイルにまとめることで、効率の良いコード保守ができるわけです。

　一応これでフォームは表示できるのですが、symfonyが自動で生成したフォームは余計なフィールドが混ざっているので、たいていはカスタマイズが必要です。今回もcreated_atやupdated_atを表示させないようにしたり、app_typeやauthの表示方法を変更するために、フォームファイルをカスタマイズします。/plugins/opFreepagePlugin/lib/form/FreepageForm.class.phpを開いて、クラスの中身を以下のように書き換えます。

php:

protected static $auths = array('0' => 'なし', '1' => 'あり');
  protected static $app_types = array('pc' => 'pc', 'mobile' => 'mobile');
 
  public function configure()
  {
    unset($this['created_at'], $this['updated_at']);
 
    $this->widgetSchema['body'] = new sfWidgetFormTextarea(array(), array('cols' => 50, 'rows' => 20));
 
    $this->widgetSchema['app_type'] = new sfWidgetFormSelect(array('choices' => self::$app_types));
    $this->validatorSchema['app_type'] = new sfValidatorChoice(array('choices' => array_keys(self::$app_types)));
 
    $this->widgetSchema['auth'] = new sfWidgetFormChoice(array('choices' => self::$auths, 'multiple' => false, 'expanded' => true));
    $this->validatorSchema['auth'] = new sfValidatorChoice(array('choices' => array_keys(self::$auths)));
 
    $this->widgetSchema->setLabels(array(
      'app_type' => 'アプリケーションタイプ',
      'auth'     => '認証が必要',
    ));
  }

上から順番に処理の内容を言うと、bodyフィールドのcols・rowsの設定、app_typeフィールドをセレクトボックスとし選択肢を限定、authフィールドをオプションボタンとし選択肢を限定、いくつかのフィールドのラベルを変更、となっています。実は最初authフィールドをチェックボックスとして実装したのですが、0と1で判断するauthフィールドとはなぜか相性が良くないらしく、編集時にauth=0のはずがチェックがされた状態で描画されてしまいました。とりあえずオプションボタンにすることで回避できました。

以上で管理画面側は全て出来上がりました。実際に編集画面を見てみるとこんな感じになります。

次回はPC/mobileの実際の表示画面の作成をやります。次回の内容でプラグインの機能部分は終わって、それ以降はプラグインの微調整と、プラグインのリリースなどが待っています。あともう少しでプラグインの完成です！

Comments (0)

[symfony]Unable to execute INSERT statement. [wrapped: SQLSTATE[23000]: Integrity constraint violation: 1048 Column ‘id’ cannot be null]

Posted under php,symfony by uechoco on 水曜日 18 2月 2009 at 22 : 19 : 04

参照整合性のエラーとか、聞いたことがない。symfonyでモデルクラスを使ってテーブルにsave()すると表題のようなエラーで動いてくれない。ソースコードを疑ったが、どこにも悪いところがない。あとはもうDBだけかとおもってDBDesignerを見直してみると罠があった。該当のテーブルのidカラムのAUTO_INCREMENTのチェックが外れていた。

当然このDBDesignerの設計図から吐き出されるSQLも意図していないものなので、リバースエンジニアリングしてschema.ymlを作ったymlも知っていたはず。ところが、自分でschema.ymlを書き換えて、各テーブルのid属性の値を消してしまったので、symfonyが普通のidカラムだと思って、モデルを作ってしまったようだ。

たぶん、ご操作でたまたまAUTO_INCREMENTのチェックが外れてしまったんだと思うが、このチェックが外れていたおかげで実に2時間を浪費してしまった。なんたる失態。

Comments (0)

[OpenPNE3]管理画面付きプラグイン(opFreepagePlugin)#2 管理画面の作成

Posted under OpenPNE3,php,symfony by uechoco on 火曜日 17 2月 2009 at 09 : 22 : 26

　前回はopFreepagePluginの初期設定として、ディレクトリの作成とDBスキーマの作成を行いました。今回は管理画面内のプラグイン独自の設定画面を開発方法を学びます。開発を行う前に、OpenPNE3のプラグイン設定画面の仕組みを説明します。

　OpenPNE3では、プラグインごとに設定画面が持てるような仕組みを持っていて、設定画面がある場合はプラグイン一覧からリンクが張られています。

　プラグイン独自の設定画面を作成するには、プラグイン内にpc_backendアプリケーション用のディレクトリを用意し、そこにプラグインと同名のモジュールを追加します。つまり、プラグインと同名のモジュールがあるかないかで設定画面の有無を判断しています。例えば、opFreepagePluginであれば、/plugins/opFreepagePlugin/apps/pc_backend/modules/opFreepagePlugin/actionsディレクトリを持っていれば「設定画面あり」とみなされます。

　では具体的にopFreepagePluginに設定画面を追加してみます。まずはターミナルで

BASH:

./symfony opGenerate:app opFreepagePlugin pc_backend

を実行し、/plugins/opFreepagePlugin/apps/pc_backend/modulesディレクトリを作成します。続いて

BASH:

./symfony opGenerate:module opFreepagePlugin pc_backend opFreepagePlugin

を実行し、pc_backendアプリケーション用のopFreepagePluginモジュールを追加します。デフォルトでactions.class.phpとindexSuccess.phpも作られます。また、この時点で既にプラグイン一覧にはopFreepagePluginの設定画面へのリンクが表示されています。

/actions/actions.class.phpにはexecuteIndex()メソッドが最初から記述されています。これを下記のように書き換え、さらにexecuteList()メソッドを追加します。

php:

public function executeIndex($request)
  {
    $this->redirect('opFreepagePlugin/list');
  }
 
 /**
  * Executes list action
  *
  * @param sfRequest $request A request object
  */
  public function executeList($request)
  {
    $this->freepage_list = FreepagePeer::doSelect(new Criteria());
    return sfView::SUCCESS;
  }

上記記述で追加したlistアクションはフリーページの一覧を表示するアクションで、opFreepagePluginの設定画面を開くと最初に表示されることを想定しています。このlistアクションに対応するビューとして、/templates/listSuccess.phpを作成します。

php:

<?php slot('submenu') ?>
<?php include_partial('submenu') ?>
<?php end_slot() ?>
 
<h2><?php echo __('一覧') ?></h2>
 
<table>
  <thead>
    <tr>
      <th>ID</th>
      <th><?php echo __('Title') ?></th>
      <th><?php echo __('Body') ?></th>
      <th><?php echo __('AppType') ?></th>
      <th><?php echo __('Auth') ?></th>
      <th><?php echo __('Created At') ?></th>
      <th><?php echo __('Updated At') ?></th>
    </tr>
  </thead>
  <tbody>
    <?php foreach ($freepage_list as $freepage): ?>
    <tr>
      <td><?php echo link_to($freepage->getId(), 'opFreepagePlugin/edit?id='.$freepage->getId()) ?></td>
      <td><?php echo $freepage->getTitle() ?></td>
      <td><?php echo '(' . strlen($freepage->getBody()) . __('文字') . ')' ?></td>
      <td><?php echo $freepage->getAppType() ?></td>
      <td><?php echo ($freepage->getAuth() ? 'あり' : 'なし') ?></td>
      <td><?php echo $freepage->getCreatedAt() ?></td>
      <td><?php echo $freepage->getUpdatedAt() ?></td>
    </tr>
    <?php endforeach; ?>
  </tbody>
</table>
<?php echo link_to(__('新規追加'), 'opFreepagePlugin/new') ?>

listSuccess.phpの冒頭でsubmenuという名前の部分テンプレートをスロットとして読み込んでいます。この冒頭３行は管理画面のビューの典型的なパターンですので覚えて損はないです。そのほかの部分はfreepageテーブルの内容を表形式に出力し、編集や新規作成へのリンクを加えています。

　最後に先ほど触れたsubmenuという名前の部分テンプレートを/templates/_submenu.phpに作成します。

php:

<li><strong><?php echo __('フリーページ') . __('プラグイン') ?></strong></li>
<li><?php echo link_to(__('一覧'), 'opFreepagePlugin/list') ?></li>
<li><?php echo link_to(__('新規追加'), 'opFreepagePlugin/new') ?></li>

とりあえずこれでフリーページの一覧は表示できるようになりました。まだ新規作成や編集のリンクは動いていませんが、試しにフリーページをデータベースに直接登録してみると、以下のような画面になります。

　今回はここまでです。おさらいですが、管理画面にプラグイン独自の設定画面を追加するには、プラグイン名と同名のモジュールを作成すればよいということを忘れないでください。

　次回は管理画面の残りの機能として、新規作成・編集・削除画面を作ります。フォームの使い方勉強にもなりそうです。

Comments (0)

« 前ページへ — 次ページへ »

Copyright © 2012 うえちょこ＠ぼろぐ. WP Theme created by Web Top.