GANCHIKU.com » PHP

still working on routing cache issue

shin — Thu, 23 Jul 2009 06:10:43 +0000

I’m getting know routing cache problem now, but still struggling how to fix this. In my last post, I introduced lazy_routes_deserialize is the way to avoid this problem. Well, I believe some is true, but not everything. After I fixed my factories.yml configuration for sfPatterRouting, it seems that the performance of the application got a lot better, and I no longer across the error messages which I was frustrated very much.

However, I ran the application for a couple days, and found different problem. As the symfony blog mentioned , it generates too many routing cache files!!!!! It was more than 600000. 600000 in one directory is not very healthy. So, I changed my idea to use lazy_routes_deserialize. Instead, I decided to use sfAPCCache. The application was using APC anyway, so I thought put every routing cache in it. It worked fine, but I came across the exact same problem again, which is the size of routing cache gets huge! It ate almost 150M in 3 days, and it seems it is going to consume more in the near future. For now, I just run apache reload task one in a day, so it is working great. However, I don’t like the idea I’m using now. I have to find other strategies for this routing cache.

I think the base of this problem is my routing configuration. It gets so huge, and I need to find out better way to avoid it. The more specific URL you have, the bigger your routing cache gets. I understand it, but it seems the number it grows exponentially! It is not fair!

Is there any way to optimize my routing cache issue?

O.K, I found an answer. Do not use routing cache. Set sfNoCache instead.

symfony routing cache and memory error

shin — Sun, 19 Jul 2009 07:18:09 +0000

I was struggling with this trouble for almost 2 months!!!! My current project uses symfony as always, but I had a big problem with memory issue.

I am engaging this project for almost a year. This application was first created with symfony1.1, but now it is compatible with 1.2. Currently it uses many only 1.2 features such as routing, cache, and etc. I was very satisfied with symfony1.2, except this memory problem.

There were many out of memory error lines in my httpd error log.

PHP Fatal error: Allowed memory size of 100663296 bytes exhausted (tried to allocate 5926568 bytes) in /xxxxx/cache/frontend/prod/config/config_core_compile.yml.php on line 3366

Because of this error, I increased memory_limit to 96M in php.ini. However, it was not enough. Plus, because my server was a bit old and has only 512M, it always uses swap, and gets really bad sometimes. I was so frustrated with this problem, and googled this a lot. It is still a guess, and I don't know the solution I did was the exact one. BUT, It is working very good so far.

After I googled this issue, I found a couple similar topics in symfony forum as follows:

The first one was the problem with symfony1.2.4, and it said routing cache files size gets huge and takes too much memory to serialize it. At first, I did not know this post relates with my problem, because I was too lazy to look inside of line 3366 in config_core_compile.yml.php. After checking line 3366, I found it was the same problem. Too much memory consumption exceeded allowed memory size. One of this fix is using SQLite to handle this cache, but in my understanding, symfony1.2.7 provides different way to solve this problem, which you can find symfony 1.2.7 - more power.

all:
routing:
class: sfPatternRouting
param:
generate_shortest_url: true
extra_parameters_as_query_string: true
lazy_routes_deserialize: true
lookup_cache_dedicated_keys: true

I checked how this fix affects. This fix generate many routing cache files in cache/app_name/prod/config/routing/. The file size was not huge, but number of files is huge, as the symfony blog says. I might need to use different storage for this cache handling, but now the memory error is disappeared. I am very happy with it.

Man, i should have noticed symfony1.2.7 fix.

BUT, it did not fix, but it is working now, The answer is "Do not use routing cache. Set sfNoCache instead."

Don’t want .html file extention for my link!

shin — Thu, 09 Apr 2009 00:23:58 +0000

To make the symfony1.1 base application compatible with symfony1.2 is not very difficult. Because symfony1.2 considers backward compatibility. If you look inside of symfony, you will find many strange implements, such as link_to1, link_to2. In this case, link_to1 is for symfony1.1 base application, and link_to2 is for symfony1.2.

It made us easy to move on to symfony1.2. And I also upgrade the application I developed with symfony1.1 to symfony1.2. One of the new symfony1.2 feature is routing. Yeah! When I did Jobeet tutorial, it took a bit time to understand the new routing framework. I understand it after I implemented askeet with symfony1.2. When I developed askeet with symfony1.2, I used pure symfony1.2, so the generated codes are symfony1.2 base, and did not have any problems. However, an application I'm currently working on was developed with symfony1.1 first. It works with symfony1.2 now , but routing ruling is still syfmony1.1 base, and there are other symfony1.1 base code as well.

One of the routing features which added in symfony1.2 is sfPropelRouteCollection. Before the emergence of the useful class, I had to write many CRUD and more rule in routing.yml, but sfPropelRouteCollection helped me a lot to implement model base module. I was trying my symfony1.1 base application to upgrading routing rule for symfony1.2. After adding sfPropelRouteCollection in routing.yml, it seemed it is working great, and result of app:routes command is just what I was expected. However, urls displayed converted with link_to or url_for are not what I wanted. These helper functions add ".html" for urls. I don't want them! I struggled to removing this for a bit. Well, It was easy, but it took me two hours to find this fix. When I found the solution, I was so happy that I could not write post related with my problems.

The problem is generate_shortest_url and extra_parameters_as_query_string values in factories.yml. Well, if you used symfony1.2 to generate application using generate:app, you do not have this problem, because symfony1.2 generate factories.yml with this values. However my application was generated with symfony1.1 almost half year ago, and generate_shortest_url and extra_parameters_as_query_string was not in factories.yml.

As you find in symfony1.2 base application's factories.yml, you need following values in your symfony1.1 base factories.yml.

all:
routing:
class: sfPatternRouting
param:
generate_shortest_url: true
extra_parameters_as_query_strings: true

O.K, that's it! It is very simple, if you know the reason.

Playing with sfForm with Askeet Part 2

shin — Mon, 06 Apr 2009 03:37:05 +0000

It's another post related with sfForm. After using symfony1.2 several months, I found mastering sfForm is crucial for symfony developers. I'm still learning it, too.

In this post, I will explain QuesionForm, QuestionTagForm. Maybe I should also explain BackendQuestionForm, because QuestionForm uses tag form with auto complete, and BackendQuestionForm does not, and you might want to choose whether you use it or not. Well, I do!

O.K, let's clarify the specification of posting question and tagging. In askeet, you can only post a question from question posting page. Yeah, as it is. Look at the image below. This is the question posting form.

However, tagging is different. You can set tags when you post a question as an author of the question. Plus, if you are authenticated user, you can set/add tag for the questions no matter who post the question. So, there are two ways for tagging. The one you see above, which is tagging with posting question, and the form you found in sidebar when you logined askeet and go to the question detail page as a below image:

To explain how to do it, I use following codes:

lib/form/QuestionForm.class.php
lib/form/QuestionTagForm.class.php
lib/form/BackendQuestionForm.class.php
lib/form/sfWidgetFormProtoculousAutocompleter.class.php
apps/frontend/modules/question/actions/actions.class.php(executeNew, executeCreate)
apps/frontend//modules/question/templates/newSuccess.php
apps/frontend/modules/tag/actions/actions.class.php(executeCreate, executeAutocomplete)
apps/frontend/modules/tag/components/components.class.php
apps/frontend/modules/tag/templates/_add.php
apps/frontend/modules/tag/templates/autocompleteSuccess.php

O.K, let's start with the posting question form.

lib/form/QuestionForm.class.php

class QuestionForm extends BaseQuestionForm
{
protected $questionTagForm = null;
public function configure()
{
unset(
$this['created_at'],
$this['updated_at'],
$this['interested_users'],
$this['reports'],
$this['user_id'],
$this['html_body'],
$this['stripped_title'],
$this['report_question_list'],
$this['question_tag_list'],
$this['interest_list']
);
$this->widgetSchema['title'] = new sfWidgetFormInput( array('label' => 'question:')
);
$this->validatorSchema['title'] = new sfValidatorString(
array(),
array('required' => 'You must give a title to your question')
);
$this->widgetSchema['body'] = new sfWidgetFormTextarea(
array('label' => 'describe it:'),
array('cols' => 40, 'rows' => 10)
);
$this->validatorSchema['body'] = new sfValidatorString(
array('min_length' => 10),
array(
'required' => 'You must provide a brief context for your question',
'min_length' => 'Please, give some more details'
)
);
$this->setQuestionTagForm();
$this->mergeForm($this->questionTagForm);
}
public function updateObject($values = null)
{
$object = parent::updateObject($values);
if (is_null($object->getUserId())) {
$userId = sfContext::getInstance()->getUser()->getSubscriberId();
$object->setUserId($userId);
}
$interest = new Interest();
$interest->setUserId($userId);
$object->addInterest($interest);
return $object;
}
public function doSave($con = null)
{
parent::doSave($con);
$this->taintedValues['question_id'] = $this->object->getId();
$this->questionTagForm->bind($this->taintedValues);
$this->questionTagForm->doSave($con);
}
protected function setQuestionTagForm()
{
$this->questionTagForm = new QuestionTagForm(
null,
array('url' => sfContext::getInstance()->getController()->genUrl('tag_autocomplete'))
);
}
}

Check out doSave method. It is a bit tricky, because we need to save posted tags as well. When tagging, you are not going to set only one tag. You might want to tag more than one phrases. Also, using mergeForm does not call doSave for the merged form, so you have to override doSave method here. I need to bind the question_id for QuestionTagForm

In the end of configure method, I called setQuestionTagForm and mergeForm, because I will override setQuestionTagForm in BackendQuestionForm, not to use auto completing feature. See the BackendQuestionForm now.

lib/form/BackendQuestionForm.class.php

class BackendQuestionForm extends QuestionForm
{
public function configure()
{
parent::configure();
$this->widgetSchema['user_id'] = new sfWidgetFormInputHidden();
$this->validatorSchema['user_id'] = new sfValidatorPropelChoice(array(
'model' => 'User', 'column' => 'id', 'required' => false
));
}
protected function setQuestionTagForm()
{
$this->questionTagForm = new QuestionTagForm(null);
}
public function updateDefaultsFromObject()
{
parent::updateDefaultsFromObject();
$tag = implode(" ", $this->object->getTags());
$values['tag'] = $tag;
if ($this->isNew) {
$this->setDefaults(array_merge($values, $this->getDefaults()));
} else {
$this->setDefaults(array_merge($this->getDefaults(), $values));
}
}
}

As I saild above, I overrided the setQuestionTagFrom for without auto completing function.

O.K, now it's about time for tagging.

lib/form/QuestionTagForm.class.php

class QuestionTagForm extends BaseQuestionTagForm
{
public function configure()
{
unset(
$this['user_id'],
$this['normalized_tag'],
$this['created_at']
);
$this->widgetSchema['question_id'] = new sfWidgetFormInputHidden();
$this->validatorSchema['question_id'] = new sfValidatorPropelChoice(array('model' => 'Question', 'column' => 'id', 'required' => false));
$url = $this->getOption('url');
if (!empty($url)) {
$this->widgetSchema['tag'] = new sfWidgetFormProtoculousAutocompleter(array(
'label' => 'tags:',
'url' => $url,
'use_style' => true
));
} else {
$this->widgetSchema['tag'] = new sfWidgetFormInput(array(
'label' => 'tags:'
));
}
$this->widgetSchema->setNameFormat('question[%s]');
}
public function doSave($con = null)
{
$tags = Tag::splitPhrase($this->taintedValues['tag'] . (sfConfig::get('app_permanent_tag') ? ' '.sfConfig::get('app_permanent_tag') : '' ));
$question = QuestionPeer::retrieveByPk($this->taintedValues['question_id']);
foreach ($tags as $tag) {
try {
$questionTag = new QuestionTag();
$questionTag->setQuestionId($question->getId());
$questionTag->setUserId($question->getUserId());
$questionTag->setTag($tag);
$questionTag->save($con);
} catch (PropelException $e) {
// do nothing
}
}
// hmm, i don't like this...
$this->object = $question;
}
}

To create auto complete widget, I made sfWidgetFormProtoculousAutocompleter. There was JavaScript helper for auto complete. However, I do not want to use it, because I prefer to use sfForm. Also symfony1.2 integrated some useful function with jQuery. jQuery is a wonderful library, but I hate use two different JavaScript library in one application. If I use jQuery, I only use jQuery, and askeet has a lot of prototype base code, so I created autocompletor widget for sfProtoculousPlugin. Well, it was easy anyway.
So, if there was url option when intiating QuestionTagForm, use sfWidgetFormProtoculousAutocompleter. Without option, use another sfWigetFormInput.

Actually I do not like my implementation of doSave. As I saild above, you need to set more than one tag same time when posting. So, I need to save all the tags. Because saving more than one tag, i don't know what to return. I just return the question object here.

Good thing about this QuestionTagForm, you can use this both mergeForm and only itself. As I mentioned above, there are two ways to tag, and both are using this class.

lib/form/sfWidgetFormProtoculousAutocompleter.class.php

class sfWidgetFormProtoculousAutocompleter extends sfWidgetFormInput
{
protected function configure($options = array(), $attributes = array())
{
$this->addRequiredOption('url');
$this->addOption('config', '{ }');
$this->addOption('use_style');
parent::configure($options, $attributes);
}
public function render($name, $value = null, $attributes = array(), $errors = array())
{
$response = sfContext::getInstance()->getResponse();
$response->addJavascript(sfConfig::get('sf_prototype_web_dir').'/js/prototype');
$response->addJavascript(sfConfig::get('sf_prototype_web_dir').'/js/effects');
$response->addJavascript(sfConfig::get('sf_prototype_web_dir').'/js/controls');
if ($this->getOption('use_style')) {
$response->addStylesheet(sfConfig::get('sf_prototype_web_dir').'/css/input_auto_complete_tag');
}
return parent::render($name, '', $attributes, $errors) .
content_tag('div' , '', array('id' => $this->generateId($name) . '_autocomplete', 'class' => 'auto_complete')) .
sprintf('',
$this->generateId($name),
$this->generateId($name . '_autocomplete'),
$this->getOption('url'),
$this->getOption('config')
);
}
}

I was a bit lazy, so above code is not well written. That's all for form code, and let's see the action and templates from here.

/apps/frontend/modules/questions/actions/actions.class.php

// snip
public function executeNew(sfWebRequest $request)
{
$this->form = new QuestionForm();
}
public function executeCreate(sfWebRequest $request)
{
$this->form = new QuestionForm();
$this->form->bind($request->getParameter($this->form->getName()));
if ($this->form->isValid()) {
$this->form->save();
$this->redirect($this->generateUrl('question_show', $this->form->getObject()));
}
$this->setTemplate('new');
}
// snip

executeNew and executeCreate is very simple, and probably, you don't need any instruction with this. Good thing about mergeForm is you don't need to know you are using tag form in action class, because we have already merge it in QuestionForm class. You just render the quetion form, and bind and save it.

apps/frontend/modules/question/template/newSuccess.php

echo __('ask a question') ?>
class="in_form">
echo __('Have you looked for similar questions? Check if a related question already exists: The more interesting a question is, the more people will be willing to answer it.') ?>
echo __('Be as accurate as you can when giving a title to your question. Keep it short and put the details in the question body.') ?>

"" method="post" class="form">

     echo $form['title']->renderError() ?>

     echo $form['title']->renderLabel() ?>

     echo $form['title'] ?>

    
class="clearleft" />

     echo $form['body']->renderError() ?>

     echo $form['body']->renderLabel() ?>

     echo $form['body'] ?>

    
class="clearleft" />

     echo include_partial('content/markdown_help') ?>

     echo $form['tag']->renderError() ?>

     echo $form['tag']->renderLabel() ?>

     echo $form['tag'] ?>

    
class="clearleft" />

class="small in_form">echo __('example: askeet "how to"') ?>

class="right">

    "submit" value="" />

View file is also simple. Because we merge the QuestionTagForm, you can use $form['tag'], here! O.K, now you are able to post a question with tagging with auto complete feature!

O.K, it is about time to write about tag form that you find in sidebar. We will use the same QuestionTagForm here. To add tag, you have to be authenticated and go to the question/show page. In the component slot, _question.php, you include tag/add component. This component displays the tagging form.

/apps/frontend/modules/tag/actions/components.class.php

class tagComponents extends sfComponents
{
public function executeAdd(sfWebRequest $request)
{
$questionTag = new QuestionTag();
$questionTag->setQuestionId($this->question_id);
$this->form = new QuestionTagForm($questionTag, array('url' => $this->generateUrl('tag_autocomplete')));
}
}

In the action, executeAdd, we set QuestionTag object with question_id. Plus auto_complete url is also set when initialize form class. As you can see the template file, this form is ajax form.

 endif; ?> 

This form request action goes tag_create rule, which is tag/executeCreate action.

As I mentioned above QuestionTagForm's doSave method returns not QuestionTag object, but Question Object, which is not really nice I think. Anyway, let's render the tags value to the view file and return value for ajax request. In createSuccess.php, it is same as tag/question_tags partial. What you need to do here is just updating the question tags list which has just tagged by you.

Playing with sfForm with Askeet Part 1

shin — Sun, 29 Mar 2009 08:10:19 +0000

It took time to write a new post. My current project had a tight schedule, and it is very important for me to work on this project. Sorry.

So, in this post, I will explain some tips for sfForm using the code I implemented in Askeet. I will explain these two cases for form handling:

user login / registration switching
~~question posting with tags and tags posting~~(next post)

To explain the code, I will use following files.

lib/form/UserLoginForm.class.php
lib/form/UserMixForm.class.php
apps/frontend/modules/user/actions/actions.class.php(executeNew, executeLogin, executeCreate
apps/frontend/templates/layout.php
apps/frontend/modules/user/actions/components.class.php
apps/frontend/modules/user/templates/login.php
apps/frontend/modules/user/templates/newSuccess.php

Before I explain the code I need to clarify the specification of user login and registration process in Askeet. There are two ways to login Askeet:

For unauthorized users, when some actions require authentication, such as posting questions and answers, voting for interest, moderating and etc, the login form dynamically appears on the page. Like following image.

Following signin/register link lead you the page you can login and register. When login failed by both ways this page is used as well. Like following image.

O.K, let's start from the first one. Because I'm using symfony1.2, I should use sfForm instead writing every input tags or tag_helper in the view template. I didn't know how to implement such form, but I got a good idea from Exgear's tutorial, and I followed the instruction.
Here, I wrote some code in UserLoginForm.class.php, layout.php, components.class.php, and its template, _login.php. The code are follows:

UserLoginForm.class.php

class UserLoginForm extends BaseUserForm
{
public function configure()
{
unset(
$this['id'],
$this['created_at'],
$this['first_name'],
$this['last_name'],
$this['email'],
$this['sha1_password'],
$this['salt'],
$this['ask_interest_list'],
$this['ask_relevancy_list']
);
$this->validatorSchema['nickname'] = new sfValidatorString(
array('min_length' => 5),
array('required' => 'your nickname is required', 'min_length' => 'nickname must be 5 or more characters')
);
$this->widgetSchema['password'] = new sfWidgetFormInputPassword();
$this->validatorSchema['password'] = new sfValidatorString(
array(),
array('required' => 'your password is required')
);
$this->widgetSchema['referer'] = new sfWidgetFormInputHidden();
$this->validatorSchema['referer'] = new sfValidatorPass();
$request = sfContext::getInstance()->getRequest();
if ($request->isMethod('get')) {
$this->setDefault('referer', $request->getReferer());
} else {
$this->setDefault('referer', $request->getParameter($this->getName().'[referer]'));
}
// check valid user
$this->validatorSchema->setPostValidator(new sfValidatorCallback(array(
'callback' => array($this, 'validUser'),
)));
$this->validatorSchema->setOption('allow_extra_fields', true);
}
public function validUser($validator, $values)
{
if (empty($values['nickname']) or empty($values['password'])) {
return;
}
$nickname = $values['nickname'];
$c = new Criteria();
$c->add(UserPeer::NICKNAME, $nickname);
$user = UserPeer::doSelectOne($c);
if (is_null($user) || sha1($user->getSalt().$values['password']) != $user->getSha1Password()) {
throw new sfValidatorError($validator, 'no user available');
}
$this->object = $user;
return $values;
}
}

Well, this code is straightforward and not many tricks.If I have to say something, I would say using sfValidatorCallback to authorizing user request as post validator. Actually this idea is also from exgear's site. They are really good.
BTW, some might think why I put allow_extra_fields there? Well, I will explain this later. As it is, extra fields are expecting for UserLoginForm.

So, create apps/frontend/modules/user/actions/components.class.php, and render the form object of the class.

components.class.php

class userComponents extends sfComponents
{
public function executeLogin(sfWebRequest $request)
{
$this->form = new UserLoginForm();
}
}

Simple! Huh!

Now its view file, apps/frontend/modules/users/templates/_login.php

_login.php

"" method="POST" id="loginform">
echo $form['nickname']->renderLabel() ?> echo $form['nickname'] ?>
echo $form['password']->renderLabel() ?> echo $form['password'] ?>
echo $form['referer'] ?>
'submit' value="">
echo link_to_function(__('cancel'), visual_effect('blind_up', 'login', array('duration' => 0.5))) ?>

As I am a programmer, I do not like to write every echo $form['blabla'] in view files, but I was too lazy to think other way right now. I might try better ways later if I had any chances. Anyway, this is very easy, so no explanation here either. Blinding up animation is there, because it was found in the Askeet tutorial, and I liked the cool animation. I did not write any error message in this template, you will see why later.

Now you need to include this components in layout.php

layout.php

// snip
"login" style="display: none">
echo __('please sign-in first') ?>
include_component('user', 'login') ?>

// snip 

Now you can see the form container is invisible, and use link_to_function to will change the status to visible. When actions need user authentication, echo the next helper function, and the login form will appear!

link_to_function('some action label', visual_effect('blind_down', 'login', array('duration' => 0.5)));

O.K, that's one way to login for user. It was longer than I thought. We didn't reach the tricky tips yet. Now you might think "what about login error page? How do users know if he or she typed right nickname and password? ", Well, those error messages are displayed signin /register page. So, when user login failed, you have different login page, which I will explain from now.

For easy user registration and login, many web applications use the same form to login or registering. Askeet also use this strategy. The default page of signin/register page only displays nickname and password fields, and a checkbox. Yes, this checkbox having label as "click here to create a new account", switches this form action to be login or registering. Look at the image again.

If you check the checkbox, two more fields will appear in the page like following image:

O.K, finally! I had struggled a bit to implementing this with sfForm. Askeet tutorial was easy, because the tutorial write the input helper directly. I'm using sfForm framework, and I want to avoid this. To implement this form, I created UserMixForm.class.php for this page. UserLoginForm.class.php was for only login, but this form class is for registration mainly. Maybe naming is not good, though
Anyway, I copy all the source of UserMixForm.class.php here:

class UserMixForm extends BaseUserForm
{
public function configure()
{
unset(
$this['id'],
$this['created_at'],
$this['first_name'],
$this['last_name'],
$this['sha1_password'],
$this['salt'],
$this['ask_interest_list'],
$this['ask_relevancy_list']
);
$this->widgetSchema['nickname'] = new sfWidgetFormInput(array('label' => 'Nickname:'));
$this->validatorSchema['nickname'] = new sfValidatorString(
array('min_length' => 5),
array('required' => 'your nickname is required', 'min_length' => 'nickname must be 5 or more characters')
);
$this->widgetSchema['password'] = new sfWidgetFormInputPassword(array('label' => 'Password:'));
$this->validatorSchema['password'] = new sfValidatorString(
array(),
array('required' => 'your password is required')
);
$controller = sfContext::getInstance()->getController();
$this->widgetSchema['new'] = new sfWidgetFormInputCheckbox(array(
'label' => 'click here to create a new account'
),
array('style' => 'display: inline; float: none',
'onclick' => "
if (Element.visible('new_account')) {
Effect.BlindUp('new_account');
$('login_form').action = '" . $controller->genUrl('login') . "';
} else {
Effect.BlindDown('new_account');
$('login_form').action = '" . $controller->genUrl('user_create') . "';
}
"));
$this->validatorSchema['new'] = new sfValidatorPass();
$this->widgetSchema['password_biz'] = new sfWidgetFormInputPassword(
array('label' => 'confirm your password')
);
$this->validatorSchema['password_biz'] = new sfValidatorString(
array(),
array('required' => 'password confirmation is required')
);
$this->widgetSchema['email'] = new sfWidgetFormInput(
array('label' => 'your email')
);
$this->validatorSchema['email'] = new sfValidatorEmail(
array('min_length' => 5),
array(
'required' => 'your email is required',
'invalid' => 'email address is invalid'
)
);
$this->validatorSchema->setPostValidator(new sfValidatorAnd(array(
new sfValidatorSchemaCompare(
'password', '==', 'password_biz', array(),
array('invalid' => 'password and confirmed password does not match')
),
new sfValidatorPropelUnique(
array('model' => 'User', 'column' => array('nickname')),
array('invalid' => 'the nickname is already taken.')
),
new sfValidatorPropelUnique(
array('model' => 'User', 'column' => array('email')),
array('invalid' => 'the email address is areadly registered.')
)
)));
$this->widgetSchema['referer'] = new sfWidgetFormInputHidden();
$this->validatorSchema['referer'] = new sfValidatorPass();
$request = sfContext::getInstance()->getRequest();
if ($request->isMethod('get')) {
$this->setDefaults(array('referer' => $request->getReferer()));
}
}
public function updateObject($values = null)
{
$object = parent::updateObject($values);
$password = $this->taintedValues['password'];
$object->setPassword($password);
return $object;
}
public function mergeStatus($loginform)
{
if (isset($loginform)) {
$nickname = $loginform->taintedValues['nickname'];
$referer = $loginform->taintedValues['referer'];
$this->errorSchema = $loginform->getErrorSchema();
$this->setDefault('nickname', $nickname);
$this->setDefault('referer', $referer);
}
}
}

Wow, this is long, but the longest method, configure, does not need any explanation I think. The method, updateObject call setPassword, because there is no password field for user model. There are sha1_password and sha1 fields. So, setPassword of user model set both fields. Actually it is same as Askeet tutorial, so I skip this, too. I just need to update the field, so I overrided the method.

What about mergeStatus method? Well, this is something new. Hehehe. Because this is my original idea. I did not refer any site to implement this, and I believe this is a tricky part. As I mentioned above, UserMixForm is actually for user registration. However, this form also handles user login and displaying login error messages as well. To succeed the login failure messages and input values, this method was needed. You will see the reason soon.

So, the signin/register page is assigned to executeNew method in actions. executeCreate is for binding, validating, and saving the user registration form. Finally executeLogin binding, validating login authentication, and if the validation failed it will render the error messages as well. O.K, let's see the code

// snip
public function executeNew(sfWebRequest $request)
{
if ($this->getUser()->isAuthenticated()) {
$this->redirect('homepage');
}
$this->form = new UserMixForm();
}
public function executeCreate(sfWebRequest $request)
{
$this->form = new UserMixForm();
$this->form->bind($request->getParameter($this->form->getName()));
if ($this->form->isValid()) {
$this->form->save();
$this->forward('user', 'login');
}
// use user registration form in login template
$this->getRequest()->setAttribute('newaccount', true);
$this->setTemplate('new');
}
public function executeLogin(sfWebRequest $request)
{
$loginform = new UserLoginForm();
$loginform->bind($request->getParameter($loginform->getName()));
if ($loginform->isValid()) {
$this->getUser()->signIn($loginform->getObject());
$this->redirect($request->getParameter($loginform->getName() .'[referer]', 'homepage'));
}
$this->form = new UserMixForm();
$this->form->mergeStatus($loginform);
$this->setTemplate('new');
}
// snip

The method, executeNew does not need any explanation. It just renders the UserMixForm object. I don't want authorized user to access this page, so let them forward to homepage route. O.K. the method, executeCreate is also straightforward. It is just another form transaction (bind, validate, save). In case the validation failed, set newaccount attribute for checkbox to be checked, and use the same template as executeNew.

O.K, finally! We are in tricky part, executeLogin. Because UserMixForm and UserLoginForm are children of BaseUserForm class, both share same fields, such as nickname, password. So, UserLoginForm require nickname, password, referer, and the for send the parameters. UserMixForm also send nickname, password, referer(and other fields, too). Well, yes! UserMixForm has other fields. That's why allow_extra_fields is on in UserLoginForm. If the user authentication failed, this action uses newTemplate which means using UserMixForm. You need to render the form value, and you need to set the error messages and input values from the last request to the form as well. To do this, you have to pass them from userLoginForm to UserMixForm. Here is mergeStatus method. I don't know if this name is proper, though.

Oops, I forgot to mention newSuccess.php.

newSuccess.php

echo __('sign in / register') ?>
class="in_form">
echo __('Registration is free and required only to create a new question or rate an answer.') ?>

 echo $form->renderGlobalErrors() ?>

"getAttribute('newaccount', false) ? url_for('user_create') : url_for('login') ?>" method="POST" id="login_form" class="form">

     echo $form['nickname']->renderLabel() ?>

     echo $form['nickname']->renderError() ?>echo $form['nickname'] ?>

    
class="clearleft"/>

     echo $form['password']->renderLabel() ?>echo $form['password']->renderError() ?>

     echo $form['password'] ?> echo link_to(__('forgot your password?'), 'user_require_password') ?>

    
class="clearleft"/>

class="in_form">

       echo $form['new'] ?>

       echo $form['new']->renderLabelName() ?>

    
class="clearleft"/>

"new_account" echo $sf_request->getAttribute('newaccount', false) ? '' : ' style="display: none"' ?>>

       echo $form['password_biz']->renderLabel() ?>

       echo $form['password_biz']->renderError() ?>

       echo $form['password_biz'] ?>

      
class="clearleft"/>

       echo $form['email']->renderLabel() ?>

       echo $form['email']->renderError() ?>

       echo $form['email'] ?>

      
class="clearleft"/>

class="small in_form">echo __('askeet will never disclose this address to a third party') ?>

   echo $form['referer'] ?>

class="right">

  'submit' value="">

It is another usual form. No explanation.

Because there are difficulties to explain in English (Probably it would be hard to write this topic in Japanese anyway), I may fix some words or explanation I posted today.

Anway, that's it. Wow, this is a long post, I have to split the tips to two posts. Hmm. Next is Question and QuestionTag form handling. Have fun!

How about sfAskeetPlugin!

shin — Tue, 10 Mar 2009 07:04:57 +0000

I was talking with akky a few minutes ago, and he had a great idea!

It was posting askeet as symfony plugin like a sfJobeetPlugin!

I'm going to work on this for my free time, so it might take a little time. Please wait!

BTW, I replaced the tar ball, because I found a bug. Answering by anonymous user broke the table constraint, so I fixed some code.

I need more unit / functional testing.

Askeet with symfony1.2

shin — Tue, 10 Mar 2009 04:07:31 +0000

O.K, this is my first post in English. I will try my best.

After symfony1.2 launched, Jobeet was introduced to the world for users to learn through developing it. The tutorial is very effective for symfony users. I also did the tutorial and learned a lot of symfony1.2 new feature.

Back to 2005, when symfony emerged, there was an application like Jobeet for symfony learners. The application was Askeet! I have used symfony since symfony0.6, and learned a lot from the Askeet tutorial that time. However, the tutorial had some small mistakes, and the source code you can get from svn repository and tar ball was a bit buggy. I struggled a lot to complete the tutorial. Maybe Fabien and Francois did it on purpose to motivate us to investigate inside of symfony further. Hehe. Currently nobody care the Askeet tutorial, because there is Jobeet, and Askeet tutorial is obsolete, since symfony is now 1.2!

Is Askeet just a tutorial? Even Askeet is an open source application, I have not encountered any web sites integrate Askeet. Why? I have some reasons in my mind. First, as I wrote on above, it is a bit buggy, such as same duplicate question title cause error, user_interest rule and related actions are never used, and etc. Second, even there was a cache chapter in the tutorial, more caching is needed for real world applications. Third, symfony is growing rapidly, which is good, but applications written by old version of symfony are hard to be taken care. Forth, there is no active source code repository for the application. Of course there is a repository for tutorial, but not for the application.

I was waiting for that somebody develops Askeet with symfony1.2, and give us its tutorial. Actually there were a couple tries in Japan, and I was excited about their work to finish.... BUT, after symfony team introduced Jobeet, everybody went to Jobeet, and the tries are gone to somewhere.

So, I did it!

Well, since I am too lazy, I'm not going to write tutorials for beginners, but I will give you some tips I found from the experience that I was developing Askeet with symfony1.2. I'm still working on caching strategy for this application, so any help is welcome. Actually my friend, akky, is helping for i18n now.

O.K, for today, I give you the current source code. License? Same as symfony! I'm using symfony1.2.4(current version:3/10/09). You can learn a lot of symfony features from the code I believe. Why I open the source code? Well, there are some reasons. First I love symfony and would like to contribute to symfony community, and second, askeet was an open source application, and why not to. Third, to show how much I can do. People will know my current skill, so that I might get job requests in the future. Finally, even I open the code, I know I am the one who know the code most.

You can download the source code from here:Askeet with symfony1.2

O.K. In a few weeks, I will probably post following topics which I found from developing Askeet with symfony1.2:

Playing with sfForm
Building complex Criteria
Cross filtering between different models in Admin Generator
Command task from Web

In English version, it works good. However my language, Japanese, has some problems because of full text search and multibyte issues. We are working on it now, and probably, I will post the fixed one later. Well, I need a svn repository, where to use?

mergeFormかembedFormか

shin — Sun, 22 Feb 2009 10:38:09 +0000

フォームオブジェクトを使う際にはどちらを使うのがいいのかな、と私も瞬間悩んだけど、sfForm.class.phpやsfPropelForm.class.phpを読んでみると、結構動作が違うね。embedFormForEachはembedFormをかぶせただけなので、それほど違いはないとは思う。未だにバグがあると私は思っているので、使う予定はないけども。

mergeFormの場合

単純にフォームをくっつけたいときに使う
具体的には、FormオブジェクトのDefault値とwidgetSchema、widgetValidatorのみmergeをしている
mergeをしているという名前のごとく、widgetのfield値が同じであった場合には、mergeされてしまうので、複数追加することができない
mergeされたFormオブジェクトの更新系のメソッド(updateObjectとかdoSave)が呼ばれることはないので、手元のフォームで呼んであげないといけないupdateDefaultFromObjectは、呼ばれる。コンストラクタ内なので

embedFormの場合

フォームを入れ子にしたいときに使う
embedされたFormオブジェクトは、sfFormクラスのインスタンスオブジェクト$embedFormsに格納される
新しくfieldを指定して、その中にembedするので、embedFormの中のwidgetのfield値が同じであっても構わない（新しいfieldはユニークでなければいけないが）
embedされたFormオブジェクトのupdateObject, doSaveが呼ばれる

パッと見た感じ、似たようなもんかなー、と思っていたら、データの保存とかが結構違うのでmergeされたFormクラスのupdateObjectなどを独自で書いている際には、明示してあげないと呼ばれないので、ちょっとビックリする。呼ばれることを前提として書いていたので。。。

あと、sfGuardPluginのsfGuardUserAdminForm.class.phpには、mergeFormが出てくるけど、このupdateObjectってトランザクションを持たずにsaveメソッドを呼んでいるような気がするのだが。。。

というわけでちょっとした自分用のメモ。

symfony1.2 embedFormでファイルアップロード

shin — Thu, 12 Feb 2009 17:42:37 +0000

symfonyでFormを使うときって、mergeFormやらembedFormって使っていますか？

私は、最近までは別々のFormクラスを作って、アクションクラスで使うFormクラスをtemplateにrenderしていました。はい。力業力業。よくないねぇ。

最近は、その辺を激しくリファクタリングして、前から気になっていたmergeFormやembedForm使ってみました。で、いろいろ使ってみると、これいいじゃない？というわけで、そのことをブログに書いてみることにします。

環境は、1.2.5-dev。まぁ、1.2.4でも動きます。embedFormForEachというのもあって、複数のフォームを使いたいときは、そちらを使う方がスマートのような感じがしますが、バグがあるせいか、どうもうまくいかないので、embedFormをループで回して使ってみることにしました。今回は、複数個アップロードするということで、mergeFormは扱わずに説明します。まぁ、いつか説明してもいいけど、こちらはすでにいくつもサンプルがあるので、そちらを勝手に調べてくださいな。私は、embedFormで画像のアップロードを扱うことにします。

超簡単なサンプルということで、スキーマはこんな感じでどうかしら？

propel:
posts:
_attributes: { phpName: Post }
id:
title:
type: varchar(128)
required: true
description:
type: longvarchar
required: true
created_at:
updated_at:
pictures:
_attributes: { phpName: Picture }
id:
post_id:
type: integer
required: true
foreignTable: posts
foreignReference: id
onDelete: cascade
onUpdate: cascade
filename:
type: varchar(255)
required: true
caption:
type: varchar(128)
required: true

相変わらずpropel使っています。説明はいらないと思うけども、一応。

postsというテーブルと、picturesというテーブルを用意して、picturesにはpost_idというカラムを持たせて、postsテーブルにリレーションをさせます。まぁ、そんだけ。つまり、postsとpicturesは、1-N関係なのですね。

databases.ymlなどの設定をしておいて、propel:build-allをするとformクラスやmodelクラスの雛形を作成してくれますね。モジュールも手で作るのが面倒なのと今回の説明には大事なところではないので、propel:generate-module post Postで作っておきます。post/templates/_form.phpは、現在のPostFormオブジェクトによって、作成されるので、echo $formだけで超シンプルにしておきます。つまり、以下のようにしておいてください。

if (!$form->getObject()->isNew()): ?>
"hidden" name="sf_method" value="put" />
endif; ?>

    
       echo $form->renderGlobalErrors() ?>                                 
       echo $form ?>                                                       
    
"2">                                                        

           echo $form->renderHiddenFields() ?>                             
           "">Cancel        
           if (!$form->getObject()->isNew()): ?>                           
             echo link_to('Delete', 'post/delete?id='.$form->getObject()->getId(), array('method' => 'delete', 'confirm' => 'Are you sure?')) ?>     
           endif; ?>                                                       
          "submit" value="Save" />

では、まずPostフォームを用意します。propel:build-allをするとbuild-formもついでにしてくれるので、lib/form/PostForm.class.phpができていると思います。これをちょいといじってみます。

public function configure() {
unset($this['created_at'], $this['updated_at']);
$this->setWidgets(array(
'id' => new sfWidgetFormInputHidden(),
'title' => new sfWidgetFormInput(array(
'label' => 'タイトル',
)),
'description' => new sfWidgetFormTextarea(array(
'label' => '説明',
)),
));
$this->setValidators(array(
'id' => new sfValidatorPropelChoice(
array('model' => 'Post', 'column' => 'id', 'required' => false)
),
'title' => new sfValidatorString(
array('max_length' => 128, 'min_length' => 3),
array(
'max_length' => 'タイトルは128文字以内でお願いします。',
'min_length' => 'タイトルは3文字以上でお願いします。'
)
),
'description' => new sfValidatorString(
array('max_length' => 2048, 'min_length' => 3),
array(
'max_length' => '説明本文は2000文字以内でお願いします。',
'min_length' => '説明本文は3文字以上でお願いします。'
)
),
));
$this->widgetSchema->setNameFormat('post[%s]');
}
}

左の画像のようになりますね。まぁ、こんなもんでしょう。titleとdescriptionだけを入力する単純なフォームですね。バリデーションは適当に書いてみました。ごくごく初歩的なsfPropelFormの使い方だと思います。説明はいらないですね。

では、PictureFormも書いてみます。

class PictureForm extends BasePictureForm
{
public function configure()
{
unset($this['post_id']);
$captions = array('A', 'B', 'C', 'D');
$this->setWidgets(array(
'id' => new sfWidgetFormInputHidden(),
'filename' => new sfWidgetFormInputFileEditable(array(
'label' => false,
'delete_label' => 'ファイルを削除する',
'file_src' => '/uploads/' . $this->getObject()->getFilename(),
'is_image' => true,
'edit_mode' => !$this->isNew(),
'template' => '
%file%
%input%
%delete% %delete_label%
',
)),
'caption' => new sfWidgetFormSelect(
array(
'label' => '説明',
'choices' => array_combine($captions, $captions)
)
)
));
$this->setValidators(array(
'id' => new sfValidatorPropelChoice(array(
'model' => 'Picture', 'column' => 'id', 'required' => false
)),
'filename' => new sfValidatorFile(
array('required' => false, 'path' => sfConfig::get('sf_upload_dir')),
array(
'max_size' => 'ファイルサイズが大きすぎます。',
'mime_types' => '投稿できる画像フォーマットではありません。',
'partial' => 'ファイルアップロードに失敗しました。もう一度、投稿してください
。',
'no_tmp_dir' => 'システムエラーです。管理者にお伝えください。',
'cant_write' => 'システムエラーです。管理者にお伝えください。',
'extension' => 'システムエラーです。管理者にお伝えください。'
)),
'caption' => new sfValidatorString(array(
'max_length' => 255, 'required' => false
)),
'filename_delete' => new sfValidatorPass()
));
$this->widgetSchema->setFormFormatterName('list');
}
}

これも説明の必要はないかな。symfony1.2からsfWidgetFormInputFileEditableというwidgetが追加されて、これがファイルアップロード関係でいろいろやってくれるのですね。便利になったものです。使い方はこのソースを読んでもいいですし、jobeetのadmin-generatorの章にも書いてありますので、それを参照してください。ここでは、画像だけをアップロードしてもいいのですが、せっかくなので、画像の説明としてcaptionというカラムもpictureテーブルに持たせてみることにします。A,B,C,Dというのはいいアイデアがなかったのとサンプルなので、まぁ、適当に。

これで、二つの独立したテーブルができましたね。しかし、postの投稿フォームにpictureも一緒に投稿させたいじゃないですか。さらに、pictureが複数投稿できたら尚良さそうですよね。ということで、PostFormにPictureFormをembedすることにします。しかも、複数。ここは決め打ちで3つとします。まぁ、サンプルなので。
PostFormのバリデーションの記述の後にでも、次のコードを追記してみましょう。

$pictures = ($this->getObject()->isNew()) ? null: $this->getObject()->getPictures();
for ($i = 0; $i <3; $i++) {
$picture = (isset($pictures) and isset($pictures[$i])) ? $pictures[$i] : null;
$pictureForm = new PictureForm($picture);
$this->embedForm('picture_' . $i, $pictureForm, '%content%');
$this->widgetSchema['picture_' . $i]->setLabel('画像');
}

少し説明しますと、Postが新規投稿であれば、何もしないですが、編集の際には、PictureFormに初期値を設定させて、それをembedFormしていきます。embedFormをする際には、picture_0, picture_1, picture_2というnameを与えて指定してみることにします。また、embedですから入れ子になりますし、ちょっと見た目がダサくなるのでデコレーションは、%content%にしておきます。ついでにlabelも指定しておきます。Formとして表示させるには、これだけ追加するだけで、左の画像のように、title, descriptionだけではなく、3つのPictureFormつまり、filename, captionが3つあるフォームができあがります。

ただ、これだけでは、このpictureがこのpostに関連づけられているかどうかがわからないので、PostFormのupdateObjectでsetPostしてあげます。

public function updateObject($values = null)
{
$object = parent::updateObject($values);
$values = $this->getValues();
foreach ($this->embeddedForms as $i => $picture) {
if ($picture->getObject()) {
if ($picture->getObject()->getFilename() == '') {
unset($this->embeddedForms[$i]);
} else {
$picture->getObject()->setPost($object);
}
}
}
}

ここは少し説明がいりますね。まず、PostのupdateObjectはそのまま親のメソッド呼んで、設定させておきます。embedFormでembedしたFormオブジェクトは、このPostFormクラスのembedFormsフィールドに配列で保持されているので(sfForm.class.php参照)、これをループで回して、どのpostと関連つけているかを指定してあげます。ついでにファイルがアップロードされない場合も保存されてしまいますので、getFilename()が空文字列の場合は、embedFormsからその要素をunsetしておきます。これで、ファイルが入っていたときのみ、保存されることになります。

これで新規投稿に関してはファイルがアップロードがちゃんとできるようになりました。また、編集時には、ちゃんとそのフォームに画像が表示されます。
しかし、このままでは実は編集時に使うfilename_deleteを使うことができないのですね。このままですと、そのpictureオブジェクトを削除せずにpictureオブジェクトのfilenameのカラムを空にしてくれるだけです。まぁ、当たり前と言えば当たり前か。ということで、ファイルを削除できるようにしてみます。

チェックボックスには、filename_deleteという名前を与えているので、フォームから渡ってきた値にfilename_deleteがあった場合には、そのPictureのオブジェクトをインスタンス変数のremovePicturesという配列に格納しておくことにします。そして、doSaveでDBをいじるときに一緒にremovePicturesにあるPictureオブジェクトを削除することにします。ということで、最終的にできあがったPostFormは以下のようになります。

class PostForm extends BasePostForm
{
private $removePictures = array();
public function configure() {
unset($this['created_at'], $this['updated_at']);
$this->setWidgets(array(
'id' => new sfWidgetFormInputHidden(),
'title' => new sfWidgetFormInput(array(
'label' => 'タイトル',
)),
'description' => new sfWidgetFormTextarea(array(
'label' => '説明',
)),
));
$this->setValidators(array(
'id' => new sfValidatorPropelChoice(
array('model' => 'Post', 'column' => 'id', 'required' => false)
),
'title' => new sfValidatorString(
array('max_length' => 128, 'min_length' => 3),
array(
'max_length' => 'タイトルは128文字以内でお願いします。',
'min_length' => 'タイトルは3文字以上でお願いします。'
)
),
'description' => new sfValidatorString(
array('max_length' => 2048, 'min_length' => 3),
array(
'max_length' => '説明本文は2000文字以内でお願いします。',
'min_length' => '説明本文は3文字以上でお願いします。'
)
),
));
$pictures = ($this->getObject()->isNew()) ? null: $this->getObject()->getPictures();
for ($i = 0; $i <3; $i++) {
$picture = (isset($pictures) and isset($pictures[$i])) ? $pictures[$i] : null;
$pictureForm = new PictureForm($picture);
$this->embedForm('picture_' . $i, $pictureForm, '%content%');
$this->widgetSchema['picture_' . $i]->setLabel('画像');
}
$this->widgetSchema->setNameFormat('post[%s]');
}
public function updateObject($values = null)
{
$object = parent::updateObject($values);
$values = $this->getValues();
foreach ($this->embeddedForms as $i => $picture) {
if (isset($values[$i]['filename_delete'])) {
$this->removePictures[] = $picture->getObject();
} else if ($picture->getObject()->getFilename() == '') {
unset($this->embeddedForms[$i]);
} else {
$picture->getObject()->setPost($object);
}
}
}
public function doSave($con = null)
{
parent::doSave($con);
foreach ($this->removePictures as $p) {
$p->delete($con);
}
}
}

symfony1.2を使いこなせるかどうかのポイントの一つはsfFormがちゃんと使えるかどうかになると思います。今後もsfFormを追いかけてみようと思います。
propel:generate-module post Postで生成されたindexSuccess.phpも少しだけ修正して、ちゃんと一覧画面に表示させるようにてみますか。

Post List

  
     foreach ($post_list as $post): ?>
    
     endforeach; ?>
  
Id

Title

Description

Created at

Pictures

"getId()) ?>">echo $post->getId() ?>

echo $post->getTitle() ?>

echo $post->getDescription() ?>

echo $post->getCreatedAt() ?>

       foreach ($post->getPictures() as $picture): ?>
      "/uploads/getFilename() ?>" alt="getCaption() ?>" width="100" />
       endforeach; ?>

"">New

Id	Title	Description	Created at	Pictures
"getId()) ?>">echo $post->getId() ?>	echo $post->getTitle() ?>	echo $post->getDescription() ?>	echo $post->getCreatedAt() ?>	foreach ($post->getPictures() as $picture): ?> "/uploads/getFilename() ?>" alt="getCaption() ?>" width="100" /> endforeach; ?>

本当は、編集フォームページにあるDeleteボタンを押すと、ちゃんとデータベースからはPostとそれに関連するPictureが削除されるのですが、実際の画像はunlinkされないので、そこの修正も必要になりますね。編集フォームページで画像だけを削除する際には、sfPropelFormにあるremoveFileが呼ばれますので、unlinkされるのですが、単純にdeleteアクションだけを呼んだ場合には、formクラスとは別のロジックになりますので、ファイルは消えませんので、Pictureモデルのdeleteにでも書いて置かないといけなさそうですね。ちょっとredundantなので、微妙だなぁーと思って今回は、それは載せませんでした。つーか、そもそも削除させないとかw

今回は、サンプルでしたので、書きませんでしたが、画像をconvertしたりする必要があるかもしれないですね。私が作っている本番用では、同時にサムネイルを作ったり、もっとformが複雑だったり、キャプションの与え方が動的だったりします。しかし、embedFormのやり方はこのままですので、これを元にすれば、いろんなところに適応ができそうです。

今回は、symfony1.2を用いて、複数の画像投稿を実現するために、embedFormを用いて実装する方法を説明しました。確かにその複数分ループで回せばいいのですが、embedFormForEachがちゃんと動けば、そちらの方がスマートな気がします。それができるまでは、このembedFormで実現しましょう。

間違いがありましたら、教えてくださいな。

symfony1.1でswiftを使ってみた。

shin — Sun, 21 Sep 2008 12:30:52 +0000

最近の開発は、ずっとsymfonyなので心中するしかないかなー、なんて思っていたりします。しかし、実際に使っていると、フレームワークではカバーしきれないコードを、ゴリゴリと、かっこ悪い方法で実装してしまったりして、嫌悪感いっぱいになってしまうことがあります。

その一つがメール周りです。symfony1.1からsfMailを使わない方向になりました（まぁ、使おうと思えば使えるけど）。そこで、代替とされているのが、Swift　Mailerですね。直接SMTPが叩くので、速いだとか負荷が減るだとか、ほげほげだということで、swiftが採用されているようですが、個人的な感想を言えば、私はsfMailerで十分間に合っていたと思います。。。

とも言っていられないので、ちょっとswiftを使ってみました。でも、
How to send emails in symfony 1.1やThe symfony Cookbook How to send an emailを読んでもなんかしっくり来ないんですよね。理由は、これらのハウツーには、メールの本文をコントローラに書く方法しか提供していないからだと思います。確か前のsfMailerではViewテンプレートにメールの本文が書けたのですが、それってswiftでどうやったらいいのかなー、なんて思って調べてやってみました。まぁ、Jonathan Wageさんのアイデアなんだけどね。

というわけで、彼のアイデアをまとめると次のような感じか。
メールを使うアクションクラスをすべてsfSwiftMailerActionsの子クラスとする。
実際に呼び出す際には、親クラスの実装メソッドsendMailにモジュール名とアクション名を渡して、そのテンプレートに本文を書く。

class sfSwiftMailerActions extends sfActions
{
public function preExecute()
{
$mailVars = sfSwiftMailerVars::getInstance()->getAll();
foreach ($mailVars as $key => $value)
{
$this->$key = $value;
}
}
public function sendEmail($module, $action)
{
sfConfig::set('symfony.view.' . $module . '_' . $action . '_layout', false);
$body = sfContext::getInstance()->getController()->getPresentationFor($module, $action);
$mailVars = sfSwiftMailerVars::getInstance();
$message = $mailVars->has('message')
? $mailVars->get('message')
: new Swift_Message(null, null, 'text/html');
$swift = $mailVars->has('swift')
? $mailVars->get('swift')
: new Swift(new Swift_Connection_Sendmail(Swift_Connection_Sendmail::AUTO_DETECT));
$message->setSubject($mailVars->get('subject'));
$message->setBody($body);
$swift->send($message, $mailVars->get('recipients'), $mailVars->get('from'));
$swift->disconnect();
$mailVars->clear();
}
public function __set($key, $value)
{
sfSwiftMailerVars::getInstance()->set($key, $value);
return parent::__set($key, $value);
}
}
class sfSwiftMailerVars extends sfParameterHolder
{
static $instance = null;
public static function getInstance()
{
if (!self::$instance)
{
self::$instance = new sfSwiftMailerVars();
}
return self::$instance;
}
}

ふむ。なるほど。テンプレートの内容を取るだけななら

$body = sfContext::getInstance()->getController()->getPresentationFor($module, $action);

でできてしまうのですね。

私が手元で実装したものでは、もう少し劣化させて、上記とは違って、SwiftクラスやSwift_Messageクラスは直書きでやってしまっています。まぁ、デフォルトの挙動なんていらないと思うので。というわけで、このソースはテストはしていません。ほぼ同じものを手元で書いて、その動作は確認しているので、だいたいのロジックはこれでいいようです。

あとは、実際のアクションクラスにこんな感じで書けばいいのですね。

class hogeActions extends sfSwiftMailerActions
{
public function executeEdit($request)
{ $swift->send($message, $mailVars->get('recipients'), $mailVars->get('from'));
$this->recipients = 'example@ganchiku.com';
$this->from = 'example@ganchiku.com';
$this->subject = 'hello world';
$this->sendEmail('hoge', 'confirm');
}
public function executeConfirm($request)
{
}
}

で、あとは、confirmSuccess.phpに本文を適当に書けばいいのですね。ふーむ。確かに、すっきりはしますが、結構面倒ですね。。。もっといい方法があったら教えてください。