Symfony中文教程 » jobeet

jobeet第十九天:国际化和本地化

napoleon — Fri, 27 Mar 2015 09:28:00 +0000

*这一系列文章来源于Fabien Potencier，基于Symfony1.4编写的Jobeet Tutirual。

昨天我们为搜索引擎添加了AJAX功能，这下搜索引擎变得有趣多了。而在今天的内容中，我们来了解一下Jobeet的国际化（i18n）和本地化（l10n）。

来自维基百科： 国际化是指在设计软件，将软件与特定语言及地区脱钩的过程。当软件被移植到不同的语言及地区时，软件本身不用做内部工程上的改变或修正。 本地化是指当移植软件时，加上与特定区域设置有关的信息和翻译文件的过程。

用户

软件或者网站没有国际化就意味着有可能会造成用户的流失。如果你的网站能够支持多种语言或者是能够为世界不同地区的人们服务的话，那么就有必要为用户提供语言选择功能以最大程度地满足用户的需求。

Symfony的i18n和l10n功能是以用户文化（user culture）为基础的。文化是由语言和其所在国家的用户所构成的。比如，那些会说法语的人被称为’fr’，而那些来自法国的人（同时也会法语）则被成为’fr_FR’。

Symfony中的翻译工作是由Translator来处理的，它会根据用户的本地信息来查找并返回文本的翻译。在使用它之前，我们需要在配置中启用Translator：

# app/config/config.yml
# ...

framework:
    #esi:             ~
    translator:      { fallback: en }
    # ...
    default_locale:  "en"

# ...

Culture in the URL

Jobeet网站需要能够支持英语和法语。因为一个URL就是代表了一个单一的资源，所以我们必须在URL中加入语言参数供用户切换不同语言的资源。为了达到这个目的，我们打开routing.yml文件，除了api路由外，我们需要为所有的路由添加一个特殊的locale变量。为了使路由简单，我们在url的前面加上/{_locale}：

// src/Ibw/JobeetBundle/Resources/config/routing.yml
login:
    pattern: /login
    defaults: { _controller: IbwJobeetBundle:Default:login }

login_check:
    pattern: /login_check

logout:
  pattern: /logout

IbwJobeetBundle_category:
    pattern:  /{_locale}/category/{slug}/{page}
    defaults: { _controller: IbwJobeetBundle:Category:show, page: 1 }   
    requirements:
        _locale: en|fr

IbwJobeetBundle_job:
    resource: "@IbwJobeetBundle/Resources/config/routing/job.yml"
    prefix:   /{_locale}/job
    requirements: 
        _locale: en|fr

ibw_jobeet_homepage:
    pattern:  /
    defaults: { _controller: IbwJobeetBundle:Job:index } 

IbwJobeetBundle_api:
    pattern: /api/{token}/jobs.{_format}
    defaults: {_controller: "IbwJobeetBundle:Api:list"}
    requirements:
        _format: xml|json|yaml

IbwJobeetBundle_ibw_affiliate:
    resource: "@IbwJobeetBundle/Resources/config/routing/affiliate.yml"
    prefix:   /{_locale}/affiliate       
    requirements: 
        _locale: en|fr

我们的首页应该要尽可能多地支持不同语言（/en/，/fr/,…）。系统根据用户在url中指定的_locale值转向到特定语言版本的首页（/）。但如果用户还没有指定_locale的值（用户可能是第一次访问Jobeet），那么Jobeet会先为用户选择一种默认语言（我们上面定义的是en）。现在我们来添加一个新路由，然后再修改首页的路由：

# src/Ibw/JobeetBundle/Resources/config/routing.yml
# ...
ibw_jobeet_homepage:
    pattern:  /{_locale}/
    defaults: { _controller: IbwJobeetBundle:Job:index }
    requirements: 
        _locale: en|fr
# ...

IbwJobeetBundle_nonlocalized:
    pattern:  /
    defaults: { _controller: "IbwJobeetBundle:Job:index" }

然后我们来添加和修改这两个路由对应的控制器的行为：

// src/Ibw/JobeetBundle/Controller/JobController.php
// ...

    public function indexAction()
    {
        $request = $this->getRequest();

        if($request->get('_route') == 'IbwJobeetBundle_nonlocalized') {
            return $this->redirect($this->generateUrl('ibw_jobeet_homepage'));
        }

        $em = $this->getDoctrine()->getManager();

        // ...
    }

// ...

如果用户访问Jobeet时没有指定优先选择使用哪种语言的话（http://jobeet.local/app\_dev.php），那么用户将会被重定向到首页（/），并且系统会为用户选择默认的语言（http://jobeet.local/app\_dev.php/en/）。

Culture测试

现在是时候测试我们实现的功能了。但在编写测试之前，我们需要先来修改之前编写的测试。因为我们在上面修改过了路由，所有的URL被都改变了，所以我们需要修改之前的功能测试，在测试中的所有URL前面加上/en。

// src/Ibw/JobeetBundle/Tests/Controller/JobControllerTest.php
namespace Ibw\JobeetBundle\Tests\Controller;

use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
use Symfony\Bundle\FrameworkBundle\Console\Application;
use Symfony\Component\Console\Output\NullOutput;
use Symfony\Component\Console\Input\ArrayInput;
use Doctrine\Bundle\DoctrineBundle\Command\DropDatabaseDoctrineCommand;
use Doctrine\Bundle\DoctrineBundle\Command\CreateDatabaseDoctrineCommand;
use Doctrine\Bundle\DoctrineBundle\Command\Proxy\CreateSchemaDoctrineCommand;
use Symfony\Component\DomCrawler\Crawler;

class JobControllerTest extends WebTestCase
{  
    // ...

    public function testIndex()
    {
        // get the custom parameters from app config.yml
        $kernel = static::createKernel();
        $kernel->boot();
        $max_jobs_on_homepage = $kernel->getContainer()->getParameter('max_jobs_on_homepage');

        $client = static::createClient();

        $crawler = $client->request('GET', '/fr/');
        $this->assertEquals('Ibw\JobeetBundle\Controller\JobController::indexAction', $client->getRequest()->attributes->get('_controller'));

        // If the selected culture is italian, the page requested will not be found
        $crawler = $client->request('GET', '/it/');
        $this->assertTrue(404 === $client->getResponse()->getStatusCode());

        $crawler = $client->request('GET', '/en/');
        $this->assertEquals('Ibw\JobeetBundle\Controller\JobController::indexAction', $client->getRequest()->attributes->get('_controller'));

        // expired jobs are not listed
        $this->assertTrue($crawler->filter('.jobs td.position:contains("Expired")')->count() == 0);

        // only $max_jobs_on_homepage jobs are listed for a category
        $this->assertTrue($crawler->filter('.category_programming tr')->count()<= $max_jobs_on_homepage); 
        $this->assertTrue($crawler->filter('.category_design .more_jobs')->count() == 0);
        $this->assertTrue($crawler->filter('.category_programming .more_jobs')->count() == 1);

        // jobs are sorted by date
        $this->assertTrue($crawler->filter('.category_programming tr')->first()->filter(sprintf('a[href*="/%d/"]', $this->getMostRecentProgrammingJob()->getId()))->count() == 1);

        // each job on the homepage is clickable and give detailed information
        $job = $this->getMostRecentProgrammingJob();
        $link = $crawler->selectLink('Web Developer')->first()->link();
        $crawler = $client->click($link);
        $this->assertEquals('Ibw\JobeetBundle\Controller\JobController::showAction', $client->getRequest()->attributes->get('_controller'));
        $this->assertEquals($job->getCompanySlug(), $client->getRequest()->attributes->get('company'));
        $this->assertEquals($job->getLocationSlug(), $client->getRequest()->attributes->get('location'));
        $this->assertEquals($job->getPositionSlug(), $client->getRequest()->attributes->get('position'));
        $this->assertEquals($job->getId(), $client->getRequest()->attributes->get('id'));

        // a non-existent job forwards the user to a 404
        $crawler = $client->request('GET', '/en/job/foo-inc/milano-italy/0/painter');
        $this->assertTrue(404 === $client->getResponse()->getStatusCode());

        // an expired job page forwards the user to a 404
        $crawler = $client->request('GET', sprintf('/en/job/sensio-labs/paris-france/%d/web-developer', $this->getExpiredJob()->getId()));
        $this->assertTrue(404 === $client->getResponse()->getStatusCode());
    }

    public function testJobForm()
    {
        $client = static::createClient();
        $crawler = $client->request('GET', '/en/job/new');

        $this->assertEquals('Ibw\JobeetBundle\Controller\JobController::newAction', $client->getRequest()->attributes->get('_controller'));

        $form = $crawler->selectButton('Preview your job')->form(array(
            'job[company]'      => 'Sensio Labs',
            'job[url]'          => 'http://www.sensio.com',
            'job[file]'         => __DIR__.'/../../../../../web/bundles/ibwjobeet/images/sensio-labs.gif',
            'job[how_to_apply]' => 'Send me an email',
            'job[description]'  => 'You will work with symfony to develop websites for our customers',
            'job[location]'     => 'Atlanta, USA',
            'job[email]'        => 'for.a.job@example.com',
            'job[position]'     => 'Developer',
            'job[is_public]'    => false,
        ));

        $client->submit($form);
        $this->assertEquals('Ibw\JobeetBundle\Controller\JobController::createAction', $client->getRequest()->attributes->get('_controller'));

        $client->followRedirect();
        $this->assertEquals('Ibw\JobeetBundle\Controller\JobController::previewAction', $client->getRequest()->attributes->get('_controller'));

        $kernel = static::createKernel();
        $kernel->boot();
        $em = $kernel->getContainer()->get('doctrine.orm.entity_manager');

        $query = $em->createQuery('SELECT count(j.id) from IbwJobeetBundle:Job j WHERE j.location = :location AND j.is_activated IS NULL AND j.is_public = 0');
        $query->setParameter('location', 'Atlanta, USA');
        $this->assertTrue(0 < $query->getSingleScalarResult());

        $crawler = $client->request('GET', '/en/job/new');
        $form = $crawler->selectButton('Preview your job')->form(array(
            'job[company]'      => 'Sensio Labs',
            'job[position]'     => 'Developer',
            'job[location]'     => 'Atlanta, USA',
            'job[email]'        => 'not.an.email',
        ));
        $crawler = $client->submit($form);

        // check if we have 3 errors
        $this->assertTrue($crawler->filter('.error_list')->count() == 3);
        // check if we have error on job_description field
        $this->assertTrue($crawler->filter('#job_description')->siblings()->first()->filter('.error_list')->count() == 1);
        // check if we have error on job_how_to_apply field
        $this->assertTrue($crawler->filter('#job_how_to_apply')->siblings()->first()->filter('.error_list')->count() == 1);
        // check if we have error on job_email field
        $this->assertTrue($crawler->filter('#job_email')->siblings()->first()->filter('.error_list')->count() == 1);
    }

    public function createJob($values = array(), $publish = false)
    {
        $client = static::createClient();
        $crawler = $client->request('GET', '/en/job/new');
        $form = $crawler->selectButton('Preview your job')->form(array_merge(array(
            'job[company]'      => 'Sensio Labs',
            'job[url]'          => 'http://www.sensio.com/',
            'job[position]'     => 'Developer',
            'job[location]'     => 'Atlanta, USA',
            'job[description]'  => 'You will work with symfony to develop websites for our customers.',
            'job[how_to_apply]' => 'Send me an email',
            'job[email]'        => 'for.a.job@example.com',
            'job[is_public]'    => false,
        ), $values));

        $client->submit($form);
        $client->followRedirect();

        if($publish) {
            $crawler = $client->getCrawler();
            $form = $crawler->selectButton('Publish')->form();
            $client->submit($form);
            $client->followRedirect();
        }

        return $client;
    }

    // ...

    public function testEditJob()
    {
        $client = $this->createJob(array('job[position]' => 'FOO3'), true);
        $crawler = $client->getCrawler();
        $crawler = $client->request('GET', sprintf('/en/job/%s/edit', $this->getJobByPosition('FOO3')->getToken()));
        $this->assertTrue( 404 === $client->getResponse()->getStatusCode());
    }

    public function testExtendJob()
    {
        // A job validity cannot be extended before the job expires soon
        $client = $this->createJob(array('job[position]' => 'FOO4'), true);
        $crawler = $client->getCrawler();
        $this->assertTrue($crawler->filter('input[type=submit]:contains("Extend")')->count() == 0);

        // A job validity can be extended hen the job expires soon
        // Create a new FOO5 job
        $client = $this->createJob(array('job[position]' => 'FOO5'), true);
        // Get the job and change the expire date to today
        $kernel = static::createKernel();
        $kernel->boot();
        $em = $kernel->getContainer()->get('doctrine.orm.entity_manager');
        $job = $em->getRepository('IbwJobeetBundle:Job')->findOneByPosition('FOO5');
        $job->setExpiresAt(new \DateTime());
        $em->flush();

        // Go to preview page and extend the job
        $crawler = $client->request('GET', sprintf('/en/job/%s/%s/%s/%s', $job->getCompanySlug(), $job->getLocationSlug(), $job->getToken(), $job->getPositionSlug()));
        $crawler = $client->getCrawler();

        $form = $crawler->selectButton('Extend')->form();
        $client->submit($form);
        $client->followRedirect();
        $this->assertEquals('Ibw\JobeetBundle\Controller\JobController::previewAction', $client->getRequest()->attributes->get('_controller'));

        // Reload the job from database
        $job = $this->getJobByPosition('FOO5');

        // Check the expiration date
        $this->assertTrue($job->getExpiresAt()->format('y/m/d') == date('y/m/d', time() + 86400 * 30));
    }

    public function testSearch()
    {
        $client = static::createClient();

        $crawler = $client->request('GET', '/en/job/search');
        $this->assertEquals('Ibw\JobeetBundle\Controller\JobController::searchAction', $client->getRequest()->attributes->get('_controller'));

        $crawler = $client->request('GET', '/en/job/search?query=sens*', array(), array(), array(
            'X-Requested-With' => 'XMLHttpRequest',
        ));
        $this->assertTrue($crawler->filter('tr')->count()== 2);
    }
}

// src/Ibw/JobeetBundle/Tests/Controller/AffiliateControllerTest.php
// ...     

public function testAffiliateForm()
{
    $client = static::createClient();
    $crawler = $client->request('GET', '/en/affiliate/new');

    $this->assertEquals('Ibw\JobeetBundle\Controller\AffiliateController::newAction', $client->getRequest()->attributes->get('_controller'));

    $form = $crawler->selectButton('Submit')->form(array(
        'affiliate[url]'   => 'http://sensio-labs.com/',
        'affiliate[email]' => 'fabien.potencier@example.com'
    ));

    $client->submit($form);
    $this->assertEquals('Ibw\JobeetBundle\Controller\AffiliateController::createAction', $client->getRequest()->attributes->get('_controller'));

    $kernel = static::createKernel();
    $kernel->boot();
    $em = $kernel->getContainer()->get('doctrine.orm.entity_manager');

    $crawler = $client->request('GET', '/en/affiliate/new');
    $form = $crawler->selectButton('Submit')->form(array(
        'affiliate[email]'        => 'not.an.email',
    ));
    $crawler = $client->submit($form);

    // check if we have 1 errors
    $this->assertTrue($crawler->filter('.error_list')->count() == 1);
    // check if we have error on affiliate_email field
    $this->assertTrue($crawler->filter('#affiliate_email')->siblings()->first()->filter('.error_list')->count() == 1);
}

public function testCreate()
{
    $client = static::createClient();
    $crawler = $client->request('GET', '/en/affiliate/new');
    $form = $crawler->selectButton('Submit')->form(array(
        'affiliate[url]'   => 'http://sensio-labs.com/',
        'affiliate[email]' => 'address@example.com'
    ));

    $client->submit($form);
    $client->followRedirect();

    $this->assertEquals('Ibw\JobeetBundle\Controller\AffiliateController::waitAction', $client->getRequest()->attributes->get('_controller'));

    return $client;
}

public function testWait()
{
    $client = static::createClient();
    $crawler = $client->request('GET', '/en/affiliate/wait');

    $this->assertEquals('Ibw\JobeetBundle\Controller\AffiliateController::waitAction', $client->getRequest()->attributes->get('_controller'));
}

// ...

// src/Ibw/JobeetBundle/Tests/Controller/CategoryControllerTest.php
// ...

public function testShow()
{
    $kernel = static::createKernel();
    $kernel->boot();

    // get the custom parameters from app/config.yml
    $max_jobs_on_category = $kernel->getContainer()->getParameter('max_jobs_on_category');
    $max_jobs_on_homepage = $kernel->getContainer()->getParameter('max_jobs_on_homepage');

    $client = static::createClient();

    $categories = $this->em->getRepository('IbwJobeetBundle:Category')->getWithJobs();

    // categories on homepage are clickable
    foreach($categories as $category) {
        $crawler = $client->request('GET', '/en/');

        $link = $crawler->selectLink($category->getName())->link();
        $crawler = $client->click($link);

        $this->assertEquals('Ibw\JobeetBundle\Controller\CategoryController::showAction', $client->getRequest()->attributes->get('_controller'));
        $this->assertEquals($category->getSlug(), $client->getRequest()->attributes->get('slug'));

        $jobs_no = $this->em->getRepository('IbwJobeetBundle:Job')->countActiveJobs($category->getId()); 

        // categories with more than $max_jobs_on_homepage jobs also have a "more" link                 
        if($jobs_no > $max_jobs_on_homepage) {
            $crawler = $client->request('GET', '/en/');
            $link = $crawler->filter(".category_" . $category->getSlug() . " .more_jobs a")->link();
            $crawler = $client->click($link);

            $this->assertEquals('Ibw\JobeetBundle\Controller\CategoryController::showAction', $client->getRequest()->attributes->get('_controller'));
            $this->assertEquals($category->getSlug(), $client->getRequest()->attributes->get('slug'));
        }

        $pages = ceil($jobs_no/$max_jobs_on_category);

        // only $max_jobs_on_category jobs are listed 
        $this->assertTrue($crawler->filter('.jobs tr')->count() <= $max_jobs_on_category);
        $this->assertRegExp("/" . $jobs_no . " jobs/", $crawler->filter('.pagination_desc')->text());

        if($pages > 1) {
            $this->assertRegExp("/page 1\/" . $pages . "/", $crawler->filter('.pagination_desc')->text());

            for ($i = 2; $i <= $pages; $i++) {
                $link = $crawler->selectLink($i)->link();
                $crawler = $client->click($link);

                $this->assertEquals('Ibw\JobeetBundle\Controller\CategoryController::showAction', $client->getRequest()->attributes->get('_controller'));
                $this->assertEquals($i, $client->getRequest()->attributes->get('page'));
                $this->assertTrue($crawler->filter('.jobs tr')->count() <= $max_jobs_on_category);
                if($jobs_no > 1) {
                    $this->assertRegExp("/" . $jobs_no . " jobs/", $crawler->filter('.pagination_desc')->text());
                }
                $this->assertRegExp("/page " . $i . "\/" . $pages . "/", $crawler->filter('.pagination_desc')->text());
            }
        }     
    }
}

// ...

语言切换

为了让用户能够切换语言，我们需要在layout中添加一个表单。现在我们来修改它：

现在来添加路由：

# src/Ibw/JobeetBundle/Resources/config/routing.yml
# ...

IbwJobeetBundle_changeLanguage:
    pattern: /change_language
    defaults: { _controller: "IbwJobeetBundle:Default:changeLanguage" }

然后添加Action：

// src/Ibw/JobeetBundle/Controller/DefaultController.php
namespace Ibw\JobeetBundle\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\Security\Core\SecurityContext;

class DefaultController extends Controller
{
    // ...

    public function changeLanguageAction()
    {
        $language = $this->getRequest()->get('language');
        return $this->redirect($this->generateUrl('ibw_jobeet_homepage', array('_locale' => $language)));
    }
}

添加完成之后不要忘了清除cache。

模板

一个国际化的网站就意味着它支持多种不同国家语言版本的用户界面和用户接口。对于Jobeet来说，默认支持的是英语，然后是法语。为了翻译模板，我们会使用Twig的{% trans %}标签。Symfony在渲染模板时，每当遇到一个{% trans %}标签，Symfony就会去查找用户当前的本地信息来得到对应的翻译。如果找到了对应的翻译字符串，那么就返回它。如果没有找到，那么需要被翻译的字符串就会被当做备用（fallback）值返回。

所有的翻译文件都保存在src/Ibw/JobeetBundle/Resources/translations/目录下，我们将会使用XLIFF格式来保存翻译文本，它是一个标准，而且灵活性好。

现在我们在模板中添加{% trans %}标签：




    
        
            {% block title %}
                {% trans %}Jobeet - Your best job board{% endtrans %}
            {% endblock %}
        
        
        {% block stylesheets %}
            
            
        {% endblock %}
        {% block javascripts %}
            
            
        {% endblock %}
        
    
    
        
            
                
                    
                        
                    

                    
                        
                            {% trans %}Ask for people{% endtrans %}
                            
                                {% trans %}Post a Job{% endtrans %}
                            
                        

                        
                            {% trans %}Ask for a job{% endtrans %}
                            
                                
                                
                                
                                
                                    {% trans %}Enter some keywords (city, country, position, ...){% endtrans %}
                                
                            
                        
                    
                
            
           
                {% trans %}Recent viewed jobs:{% endtrans %}
                
                    {% for job in app.session.get('job_history') %}
                        
                            {{ job.position }} - {{ job.company }}
                        
                    {% endfor %}
                
            
           
               {% for flashMessage in app.session.flashbag.get('notice') %}
                   
                       {{ flashMessage }}
                   
               {% endfor %}

               {% for flashMessage in app.session.flashbag.get('error') %}
                   
                       {{ flashMessage }}
                   
               {% endfor %}

               
                   {% block content %}
                   {% endblock %}
               
           

           
               
                   
                       
                           powered by 
                           
                       
                   
                   
                       {% trans %}About Jobeet{% endtrans %}
                       {% trans %}Full feed{% endtrans %}
                       {% trans %}Jobeet API{% endtrans %}
                       {% trans %}Become an affiliate{% endtrans %}
                   
                   
                       {% trans %}Language{% endtrans %}


{% extends 'IbwJobeetBundle::layout.html.twig' %}

{% block title %}
    {% trans with {'%company%': entity.company, '%position%': entity.position} %}%company% is looking for a %position%{% endtrans %}
{% endblock %}

{% block stylesheets %}
    {{ parent() }}
    
{% endblock %}

{% block content %}
    {% if app.request.get('token') %}
        {% include 'IbwJobeetBundle:Job:admin.html.twig' with {'job': entity} %}
    {% endif %}
    
        {{ entity.company }}
        {{ entity.location }}
        
            {{ entity.position }}
             - {{ entity.type }}
        

        {% if entity.logo %}
            
                
                    
                
            
        {% endif %}

        
            {{ entity.description|nl2br }}
        

        {% trans %}How to apply?{% endtrans %}

        {{ entity.howtoapply }}

        
            {% trans with {'%date%': entity.createdat|date('m/d/Y')} %}posted on %date%{% endtrans %}
        
    
{% endblock %}



{% block content %}
    {% trans %}Job creation{% endtrans %}
    
        
 {% trans %}Whether the job can also be published on affiliate websites or not.{% endtrans %}



    {% if category.morejobs %}
        
            {% trans with {'%count%': '' ~  category.morejobs ~ ''} %}and %count% more...{% endtrans %}
        
    {% endif %}



{% block content %}
    {% trans %}Job edit{% endtrans %}
    
        
 {% trans %}Whether the job can also be published on affiliate websites or not.{% endtrans %}



    Admin
    
        {% if not job.isActivated %}
            
                {% trans %}Edit{% endtrans %}
                
                    
                        {{ form_widget(publish_form) }}
                            
                    
                
            
        {% endif %}
        
            
                {{ form_widget(delete_form) }}
                    
            
        
        {% if job.isActivated %}
            
                {% if job.isExpired %}
                    {% trans %}Expired{% endtrans %}
                {% else %}
                    {% trans with {'%count%':'' ~ job.getDaysBeforeExpires ~ '' } %}Expires in %count% days{% endtrans %}
                {% endif %}

                {% if job.expiresSoon %}
                    
                        {{ form_widget(extend_form) }}
                             {% trans %}for another 30 days{% endtrans %}
                    
                {% endif %}
            
        {% else %}
            
                [{% trans with {'%url%': 'URL'} %}Bookmark this %url% to manage this job in the future{% endtrans %}.]
            
        {% endif %}


{% extends 'IbwJobeetBundle::layout.html.twig' %}

{% block title %}
    {% trans with {'%category%': category.name} %}Jobs in the %category% category{% endtrans %}
{% endblock %}

{% block stylesheets %}
    {{ parent() }}
    
{% endblock %}

{% block content %}
    
        
            Feed
           
        {{ category.name }}
    

    {% include 'IbwJobeetBundle:Job:list.html.twig' with {'jobs': category.activejobs} %}

    {% if last_page > 1 %}
        
            
                
            

            
                
            

            {% for page in 1..last_page %}
                {% if page == current_page %}
                    {{ page }}
                {% else %}
                    {{ page }}
                {% endif %}
            {% endfor %}

            
                
            

            
                
            
        
    {% endif %}

    
        {% transchoice total_jobs with {'%count%': '' ~ total_jobs ~ ''} %}
            {0} No job in this category|{1} One job in this category|]1,Inf] %count% jobs in this category
        {% endtranschoice %}
        {% if last_page > 1 %}
            - page {{ current_page }}/{{ last_page }}
        {% endif %}
            
{% endblock %}


{% extends "IbwJobeetBundle::layout.html.twig" %}

{% block content %}
    
        {% trans %}Your affiliate account has been created{% endtrans %}
        
            {% trans %}Thank you!
            You will receive an email with your affiliate token
            as soon as your account will be activated.{% endtrans %}
        
    
{% endblock %}



    {% trans %}Become an affiliate{% endtrans %}

每个翻译都是通过trans-unit标签来管理的，trans-unit有一个唯一的id属性。现在我们可以在文件中添加或者修改法语翻译了：




    
        
            
                Jobeet - Your best job board
                Jobeet - Les meilleurs offres d'emplois
            
            
                Enter some keywords (city, country, position, ...)
                Entre des mots cle (ville, pays, position, ...)
            
            
                Recent viewed jobs:
                Dernier emplois vus:
            
            
                About Jobeet
                Apropos de Jobeet
            
            
                Become an affiliate
                Devenir un affilie
            
            
                and %count% more...
                et %count%
                        autres...
            
            
                Language
                Langue
            
            
                Publish
                Publier
            
            
                Edit
                Editer
            
            
                Are you sure?
                Etes-vous sur?
            
            
                Delete
                Supprimer
            
            
                Extend
                Prolonger
            
            
                for another 30 days
                pour 30 jours supplementaires
            
            
                Bookmark this %url% to manage this job in the future
                Marquer cette %url% pour gerer ce travail a l'avenir
            
            
                Whether the job can also be published on affiliate websites or not.
                Si le travail peut egalement etre publie sur les sites affilies ou non.
            
            
                %company% is looking for a %position%
                %company% est a la recherche d'un %position%
            
            
                How to apply?
                comment appliquer?
            
            
                posted on %date%
                poste en %date%
            
            
                {0} No job in this category|{1} One job in this category|]1,Inf] %count% jobs in this category
                {0}Aucune annonce dans cette categorie|{1}Une annonce dans cette categorie|]1,+Inf] %count% annonces dans cette categorie
            
            
                Jobs in the %category% category
                Travails dans le %category% categorie
            
            
                Your affiliate account has been created
                Votre compte d'affiliation a ete cree
            
            
                Thank you!
            You will receive an email with your affiliate token
            as soon as your account will be activated.
                On te remercie! Vous recevrez un email avec votre jeton d'affiliation des que votre compte sera active.
            
            
                Expires in %count% days
                Expire en %count% jours
            
            
                Ask for people
                Recherche des gens
            
            
                Ask for a job
                Recherche d'un emploi
            
            
                Jobeet API
                API Jobeet
            
            
                Job creation
                Creation d'emploi
            
            
                Job edit
                Edit l'emploi
            
            
                Expired
                Expiré
            
            
                Full feed
                Fil RSS
            
            
                Post a Job
                Poste un emploi

每次当你添加了新的翻译时，你都需要清除cache。

原文链接：http://www.intelligentbee.com/blog/2013/09/09/symfony2-jobeet-day-19-internationalization-and-localization/

jobeet第十九天:国际化和本地化，首发于Symfony中文教程。

jobeet第十八天:ajax

napoleon — Fri, 27 Mar 2015 09:13:06 +0000

*这一系列文章来源于Fabien Potencier，基于Symfony1.4编写的Jobeet Tutirual。

在昨天的教程中，我们使用了Zend Lucene库为Jobeet实现了一个功能强大的搜索引擎。而在今天的教程中，我们来提高搜索引擎的响应性，并且发挥Ajax的优点，把搜索变成实时响应的。现在我们需要给表单添加Javascript功能，但又不能往表单标签元素中嵌入Javascript，那么我们将会使用unobtrusive JavaScript来实现这个功能。在客户端代码中，如HTML，CSS和Javascript，使用unobtrusive JavaScript能够更好的遵循代码分离的概念。

安装jQuery

到jQuery官方网站下载最新版本的jQuery，然后把.js文件放在src/Ibw/JobeetBundle/Resources/public/js/目录下。

把.js文件放在js目录下之后，运行下面的命令安装到Symfony资源中：

php app/console assets:install web --symlink

包含jQuery

我们需要在所有的页面中使用到jQuery，因此我们需要修改layout文件：



    {% block javascripts %}
        
    {% endblock %}

添加行为

一个实时的搜索功能就意味着每当用户在搜索框中输入字符时，系统就会触发一个到服务器的请求。服务器会返回请求的数据，并用这些数据更新页面中的一部分区域而不用重新刷新整个页面来加载这些请求数据。jQuery背后的原则是：等待页面加载完成之后才给DOM添加行为，而不是直接在HTML标签上添加on*()行为。如果你禁用了浏览器的Javascript支持，那么任何行为都不会被注册，尽管如此，表单还是能够和之前一样正常地工作。

我们的第一步是得到用户在输入框中输入的关键字：

$('#search_keywords').keyup(function(key)
{
    if (this.value.length >= 3 || this.value == '')
    {
        // do something
    }
});

现在请不要把代码修改到文件中，因为我们还要对它进行大幅度的修改。在下面的教程中，我们会把最终的Javascript代码会在添加到layout文件里。

每当用户输入关键字时，jQuery就会执行上面代码定义的异步函数（anonymous function），但只有用户输入的字符超过三个或者不输入任何字符时才会执行里面的逻辑。

一种简单实现Ajax请求的方式就是使用DOM元素上的load()方法：

$('#search_keywords').keyup(function(key)
{
    if (this.value.length >= 3 || this.value == '')
    {
        $('#jobs').load(
            $(this).parents('form').attr('action'), { query: this.value + '*' }
        );
    }
});

为了处理AJAX请求，我们将会在下面的部分中修改action。

最后但同样重要的是，如果Javascript可以使用，我们想要把search按钮给移除掉：

$('.search input[type="submit"]').hide();

用户反馈

在执行AJAX调用时，页面有时候并不会马上进行更新，浏览器会等待服务器把数据返还回来后才进行页面的更新。与此同时，我们需要做一些反馈给用户，告诉他们数据正在获取中。

在AJAX执行期间，给用户显示一个loading图标的用法已经成为了一种惯例。我们在layout中添加loader图片，并默认把它设成隐藏的：



    
        Ask for a job
        
            
            
            
            
                Enter some keywords (city, country, position, ...)

我们完成功能所需的HTML代码都已经有了，现在我们创建search.js文件，然后把之前我们解释过的代码添加到里面去：

// src/Ibw/JobeetBundle/Resources/public/js/search.js
$(document).ready(function()
{
    $('.search input[type="submit"]').hide();

    $('#search_keywords').keyup(function(key)
    {
        if(this.value.length >= 3 || this.value == '') {
            $('#loader').show();
            $('#jobs').load(
                $(this).parent('form').attr('action'),
                { query: this.value ? this.value + '*' : this.value },
                function() {
                    $('#loader').hide();
                }
            );
        }
    });
});

运行下面的代码安装资源：

php app/console assets:install web --symlink

我们同样需要修改layout文件来包含search.js：



    {% block javascripts %}
        
        
    {% endblock %}

AJAX和Action

如果Javascript未被禁用，jQuery就会得到用户输入的关键字，然后请求searchAction()。如果Javascript被禁用了，用户可以点击search按钮来请求searchAction()。

那么searchAction()需要判断请求是否是通过AJAX发起的。不管什么时候调用AJAX，request对象的isXmlHttpRequest()方法都返回true。

// src/Ibw/JobeetBundle/Controller/JobController.php
use Symfony\Component\HttpFoundation\Response;

class JobController extends Controller
{  
    // ...

    public function searchAction(Request $request)
    {
        $em = $this->getDoctrine()->getManager();
        $query = $this->getRequest()->get('query');

        if(!$query) {
            if(!$request->isXmlHttpRequest()) {
                return $this->redirect($this->generateUrl('ibw_job'));
            } else {
                return new Response('No results.');
            }
        }

        $jobs = $em->getRepository('IbwJobeetBundle:Job')->getForLuceneQuery($query);

        if($request->isXmlHttpRequest()) {

            return $this->render('IbwJobeetBundle:Job:list.html.twig', array('jobs' => $jobs));
        }

        return $this->render('IbwJobeetBundle:Job:search.html.twig', array('jobs' => $jobs));
    }
}

如果搜索的结果不存在，我们需要在页面上显示出一条信息，而不是空白的页面。

我们来返回一个简单的字符串：

// src/Ibw/JobeetBundle/Controller/JobController.php
public function searchAction(Request $request)
{
    $em = $this->getDoctrine()->getManager();
    $query = $this->getRequest()->get('query');

    if(!$query) {
        if(!$request->isXmlHttpRequest()) {
            return $this->redirect($this->generateUrl('ibw_job'));
        } else {
            return new Response('No results.');
        }
    }

    $jobs = $em->getRepository('IbwJobeetBundle:Job')->getForLuceneQuery($query);

    if($request->isXmlHttpRequest()) {
        if('*' == $query || !$jobs || $query == '') {
            return new Response('No results.');
        }

        return $this->render('IbwJobeetBundle:Job:list.html.twig', array('jobs' => $jobs));
    }

    return $this->render('IbwJobeetBundle:Job:search.html.twig', array('jobs' => $jobs));
}

测试AJAX

因为Symfony不能够模拟AJAX请求，所以当测试AJAX调用时，我们需要给它一些帮助。这主要是意味着你需要手动在请求的header中添加X-Requested-With：

// src/Ibw/JobeetBundle/Tests/Controller/JobControllerTest.php
class JobControllerTest extends WebTestCase
{
    // ...

    public function testSearch()
    {
        $client = static::createClient();

        $crawler = $client->request('GET', '/job/search');
        $this->assertEquals('Ibw\JobeetBundle\Controller\JobController::searchAction', $client->getRequest()->attributes->get('_controller'));

        $crawler = $client->request('GET', '/job/search?query=sens*', array(), array(), array(
            'X-Requested-With' => 'XMLHttpRequest',
        ));
        $this->assertTrue($crawler->filter('tr')->count()== 2);
    }
}

在第十七天中，我们使用Zend Lucene库实现了搜索引擎。而今天我们使用jQuery让搜索引擎的响应性变得更好。Symfony提供了一些列基础工具，它使得构建一个MVC应用变得简单，而且它还能和其它第三方组件很好地集成在一起。总之，我们可以尝试着使用最佳的工具来服务我们的工作，提高工作效率。

原文链接：http://www.intelligentbee.com/blog/2013/09/03/symfony2-jobeet-day-18-ajax/

jobeet第十八天:ajax，首发于Symfony中文教程。

jobeet第十七天:搜索

napoleon — Fri, 27 Mar 2015 09:06:06 +0000

*这一系列文章来源于Fabien Potencier，基于Symfony1.4编写的Jobeet Tutirual。

在第十四天中，我们给Jobeet添加了订阅功能，用户能够实时地接收到最新发布的信息了。为了让Jobeet拥有更好的用户体验，今天我们就来给Jobeet添加新的功能：搜索引擎。

Zend Lucene

今天，我们就要给Jobeet添加搜索功能啦。对于Zend Framework，它提供了一个强大的库，叫做Zend Lucene，它也是著名的Java Lucene项目的一部分。我们的任务不是要给Jobeet写一个搜索引擎，因为那实在是个复杂的任务，所以我们会直接使用Zend Lucene。

我们今天的教程不是讲怎么样使用Zend Lucene库，而是讲怎么样把Zend Lucene集成到Jobeet网站中，或者更广泛地说，是讲怎么样在Symfony中集成其它的第三方库。如果你想要学习更多关于Zend Lucene的相关技术，你可以查阅Zend Lucene的文档。

安装和配置Zend Framework

Zend Lucene是Zend Framework的一部分。我们会把Zend Framework放在Symfony的vendor/目录下。首先，我们下载Zend Framework，然后把它解压出来，你会看到有library/Zend/目录，然后把它复制到Symfony项目中的vendor/目录下。需要注意的是，2.*版本的Zend Framework没有集成Lucene库，所以你不要去下载它们。

下面的内容已经使用1.12.3版本的Zend Framework测试过了。

你可以删除一些文件来清理一下目录，但请不要删除下面这几个文件和目录：

Exception.php
Loader/
Loader.php
Search/

然后在autoload.php文件中添加下面的代码，目的是为了提供一种简单的方式来注册Zend autoloader。

// app/autoload.php
// ...

set_include_path(__DIR__.'/../vendor'.PATH_SEPARATOR.get_include_path());
require_once __DIR__.'/../vendor/Zend/Loader/Autoloader.php';
Zend_Loader_Autoloader::getInstance();

return $loader;

索引

Jobeet搜索引擎要能够返回和用户输入关键字相匹配的信息。在实现搜索功能之前，我们需要为Job建立索引。对于Jobeet项目来说，我们会把索引文件放在/web/data/目录下，这个目录我们待会就来创建。

Zend Lucene提供了两个方法来检索索引，使用哪个方法则取决于索引是否已存在。现在，我们给Job实体创建一个助手方法，这个方法能够返回一个已存的索引或者是返回一个新建的索引给我们：

// src/Ibw/JobeetBundle/Entity/Job.php
// ...

class Job
{
    // ...

    static public function getLuceneIndex()
    {
        if (file_exists($index = self::getLuceneIndexFile())) {
            return \Zend_Search_Lucene::open($index);
        }

        return \Zend_Search_Lucene::create($index);
    }

    static public function getLuceneIndexFile()
    {
        return __DIR__.'/../../../../web/data/job.index';
    }
}

一个job被创建或者被更新时，它的索引也必须被更新。修改ORM文件，使得当一个job被序列化到数据库中时，同时也更新它的索引：

# src/Ibw/JobeetBundle/Resources/config/doctrine/Job.orm.yml
# ...
    # ...
    lifecycleCallbacks:
        # ...
        postPersist: [ upload, updateLuceneIndex ]
        postUpdate: [ upload, updateLuceneIndex ]
        # ...

现在运行generate:entities命令，它会在Job类中生成updateLuceneIndex()方法：

php app/console doctrine:generate:entities IbwJobeetBundle

然后修改updateLuceneIndex()方法来处理实际的操作：

// src/Ibw/JobeetBundle/Entity/Job.php
class Job
{
    // ...

    public function updateLuceneIndex()
    {
        $index = self::getLuceneIndex();

        // remove existing entries
        foreach ($index->find('pk:'.$this->getId()) as $hit)
        {
          $index->delete($hit->id);
        }

        // don't index expired and non-activated jobs
        if ($this->isExpired() || !$this->getIsActivated())
        {
          return;
        }

        $doc = new \Zend_Search_Lucene_Document();

        // store job primary key to identify it in the search results
        $doc->addField(\Zend_Search_Lucene_Field::Keyword('pk', $this->getId()));

        // index job fields
        $doc->addField(\Zend_Search_Lucene_Field::UnStored('position', $this->getPosition(), 'utf-8'));
        $doc->addField(\Zend_Search_Lucene_Field::UnStored('company', $this->getCompany(), 'utf-8'));
        $doc->addField(\Zend_Search_Lucene_Field::UnStored('location', $this->getLocation(), 'utf-8'));
        $doc->addField(\Zend_Search_Lucene_Field::UnStored('description', $this->getDescription(), 'utf-8'));

        // add job to the index
        $index->addDocument($doc);
        $index->commit();
    }
}

因为Zend Lucene不能够更新已存在的索引，所以我们需要先删除已存在的索引，然后再添加新的索引。

索引job的过程很简单：保存主键是为以后搜索job信息提供了参考，其他的主列（main columns）（position，company，location和description）同样能够被索引，但是它们没有被保存在索引文件中，因为我们会使用真实的对象来显示这些主列（看上面的代码）。我们同样需要创建deleteLuceneIndex()方法来移除已经被删除的job数据的索引。就像我们之前的更新操作一样，我们来添加删除操作。我们在ORM文件的postRemove部分添加deleteLuceneIndex()方法：

# src/Ibw/JobeetBundle/Resources/config/doctrine/Job.orm.yml
# ...
    # ...
    lifecycleCallbacks:
        # ...
        postRemove: [ removeUpload, deleteLuceneIndex ]

再次运行命令来生成实体：

php app/console doctrine:generate:entities IbwJobeetBundle

现在修改Job.php，实现deleteLuceneIndex()方法：

// src/Ibw/JobeetBundle/Entity/Job.php
class Job
{
    // ...

    public function deleteLuceneIndex()
    {
        $index = self::getLuceneIndex();

        foreach ($index->find('pk:'.$this->getId()) as $hit) {
            $index->delete($hit->id);
        }
    }
}

不管是通过命令行修改索引文件还是通过web修改索引文件，你都必须修改索引目录的权限，因此这取决于你的配置：

chmod -R 777 web/data

现在我们可以重新加载fixture数据了，这样fixture数据就能被索引了：

php app/console doctrine:fixtures:load

搜索

实现搜索简直就是小菜一碟嘛。首先，我们创建路由：

# src/Ibw/JobeetBundle/Resources/config/routing/job.yml
# ...

ibw_job_search:
    pattern: /search
    defaults: { _controller: "IbwJobeetBundle:Job:search" }

添加action：

// src/Ibw/JobeetBundle/Controller/JobController.php
namespace Ibw\JobeetBundle\Controller;

use Symfony\Component\HttpFoundation\Request;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Ibw\JobeetBundle\Entity\Job;
use Ibw\JobeetBundle\Form\JobType;

class JobController extends Controller
{
    // ...

    public function searchAction(Request $request)
    {
        $em = $this->getDoctrine()->getManager();
        $query = $this->getRequest()->get('query');

        if(!$query) {
            return $this->redirect($this->generateUrl('ibw_job'));
        }

        $jobs = $em->getRepository('IbwJobeetBundle:Job')->getForLuceneQuery($query);

        return $this->render('IbwJobeetBundle:Job:search.html.twig', array('jobs' => $jobs));
    }
}

在searchAction()中，如果请求的query不存在或者为空的话，那么用户就会转向到JobController::indexAction()方法。

视图模板也是简单明了的：


{% extends 'IbwJobeetBundle::layout.html.twig' %}

{% block stylesheets %}
    {{ parent() }}
    
{% endblock %}

{% block content %}
    
        {% include 'IbwJobeetBundle:Job:list.html.twig' with {'jobs': jobs} %}
    
{% endblock %}

执行搜索的逻辑在getForLuceneQuery()方法中：

// src/Ibw/JobeetBundle/Repository/JobRepository.php
namespace Ibw\JobeetBundle\Repository;

use Doctrine\ORM\EntityRepository;
use Ibw\JobeetBundle\Entity\Job;

class JobRepository extends EntityRepository
{
    // ...

    public function getForLuceneQuery($query)
    {
        $hits = Job::getLuceneIndex()->find($query);

        $pks = array();
        foreach ($hits as $hit)
        {
          $pks[] = $hit->pk;
        }

        if (empty($pks))
        {
          return array();
        }

        $q = $this->createQueryBuilder('j')
            ->where('j.id IN (:pks)')
            ->setParameter('pks', $pks)
            ->andWhere('j.is_activated = :active')
            ->setParameter('active', 1)
            ->setMaxResults(20)
            ->getQuery();

        return $q->getResult();
    }
}

我们从Lucene索引中得到结果之后，我们从中过滤掉未激活的job，然后限制结果条数为20。

为了让它能够工作，我们需要修改layout：



    
        
            Ask for a job
            
                
                
                
                    Enter some keywords (city, country, position, ...)

单元测试

我们需要为搜索引擎创建哪种类型的单元测试呢？很明显，我们当然不会去测试Zend Lucene库，而是测试和Zend Lucene集成的Job类。

在JobRepositoryTest.php文件末尾添加下面的测试：

// src/Ibw/JobeetBundle/Repository/JobRepositoryTest.php
// ... 
use Ibw\JobeetBundle\Entity\Job;

class JobRepositoryTest extends WebTestCase
{
    // ...

    public function testGetForLuceneQuery()
    {
        $em = static::$kernel->getContainer()
            ->get('doctrine')
            ->getManager();

        $job = new Job();
        $job->setType('part-time');
        $job->setCompany('Sensio');
        $job->setPosition('FOO6');
        $job->setLocation('Paris');
        $job->setDescription('WebDevelopment');
        $job->setHowToApply('Send resumee');
        $job->setEmail('jobeet@example.com');
        $job->setUrl('http://sensio-labs.com');
        $job->setIsActivated(false);

        $em->persist($job);
        $em->flush();

        $jobs = $em->getRepository('IbwJobeetBundle:Job')->getForLuceneQuery('FOO6');
        $this->assertEquals(count($jobs), 0);

        $job = new Job();
        $job->setType('part-time');
        $job->setCompany('Sensio');
        $job->setPosition('FOO7');
        $job->setLocation('Paris');
        $job->setDescription('WebDevelopment');
        $job->setHowToApply('Send resumee');
        $job->setEmail('jobeet@example.com');
        $job->setUrl('http://sensio-labs.com');
        $job->setIsActivated(true);

        $em->persist($job);
        $em->flush();

        $jobs = $em->getRepository('IbwJobeetBundle:Job')->getForLuceneQuery('position:FOO7');
        $this->assertEquals(count($jobs), 1);
        foreach ($jobs as $job_rep) {
            $this->assertEquals($job_rep->getId(), $job->getId());
        }

        $em->remove($job);
        $em->flush();

        $jobs = $em->getRepository('IbwJobeetBundle:Job')->getForLuceneQuery('position:FOO7');

        $this->assertEquals(count($jobs), 0);
    }
}

我们测试未被激活的job或者已被删除的job都不应该出现在搜索结果中。我们也测试了应该出现指定条件的搜索结果。

任务

最后，我们需要更新JobeetCleanup任务来清除无用（stale）实体的索引，这样做可以优化索引：

// src/Ibw/JobeetBundle/Command/JobeetCleanupCommand.php
// ...
use  Ibw\JobeetBundle\Entity\Job;

class JobeetCleanupCommand extends ContainerAwareCommand
{
    // ...

    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $days = $input->getArgument('days');

        $em = $this->getContainer()->get('doctrine')->getManager();

        // cleanup Lucene index
        $index = Job::getLuceneIndex();

        $q = $em->getRepository('IbwJobeetBundle:Job')->createQueryBuilder('j')
          ->where('j.expires_at < :date')
          ->setParameter('date',date('Y-m-d'))
          ->getQuery();

        $jobs = $q->getResult();
        foreach ($jobs as $job)
        {
          if ($hit = $index->find('pk:'.$job->getId()))
          {
            $index->delete($hit->id);
          }
        }

        $index->optimize();

        $output->writeln('Cleaned up and optimized the job index');

        // Remove stale jobs
        $nb = $em->getRepository('IbwJobeetBundle:Job')->cleanup($days);

        $output->writeln(sprintf('Removed %d stale jobs', $nb));
    }
}

这个任务移除了所有过期的job数据的索引，然后使用了Zend Lucene内建的optimize()方法对索引进行了优化。

在这一天中，我们实现了一个功能齐全的搜索引擎，而且这个过程还用不到一个小时就完成了。每当你想要往项目里添加新功能的时候，请你先去看看是否已经有现成的解决方案可以使用。

明天我们将会使用Javascript来提高搜索引擎的响应性，搜索结果会随着用户在搜索框中输入的关键字的变化而进行实时的更新。当然，我们也会讲解怎么样在Symfony中使用Ajax。

原文链接：http://www.intelligentbee.com/blog/2013/08/29/symfony2-jobeet-day-17-search/

jobeet第十七天:搜索，首发于Symfony中文教程。

jobeet第十六天:邮件

napoleon — Fri, 27 Mar 2015 08:56:02 +0000

*这一系列文章来源于Fabien Potencier，基于Symfony1.4编写的Jobeet Tutirual。

昨天我们为Jobeet添加一个只可读的（read-only）web service。现在用户可以申请Affiliate账户了，但是他们需要被管理员激活后才能够使用。为了affiliate能给拿到他们的token，管理员需要发送邮件来通知他们。这些就是我们今天要实现的功能。

Swift Mailer

Symfony框架捆绑了最好的PHP邮件解决方案：Swift Mailer。当然，Symfony已经完全地集成了这个库，并且在它原有的功能上添加了一些很酷很好用的功能。我们开始工作吧，我们通过发送邮件给用户通知他们已被管理员激活了，并且告诉他们对应的token是多少。但在那之前，我们需要配置我们的环境：

# app/config/parameters.yml
# ...
    # ...
    mailer_transport:  gmail
    mailer_host:       ~
    mailer_user:       address@example.com
    mailer_password:   your_password
    # ...

为了让上面的配置能够起作用，你应该把mailer_user和mailer_password修改成真实的值。

对app/config/parameters_test.yml文件做同样的修改。

修改完这两个文件之后清除test环境和development环境下的缓存：

php app/console cache:clear --env=dev
php app/console cache:clear --env=prod

因为我们把mailer_transport设置为gmail，所以你需要使用google的邮箱地址来作为mailer_user的值。

我们可以想想，平时发送一个邮件的时候，我们都会在邮箱客户端进行哪几步操作呢？我们会填写邮件主题，填写接收人，填写要发送的信息内容。

为了发送邮件，我们需要：

调用Swift_message的newInstance()方法（通过Swift Mailer的官方文档可以学习到这个对象）
通过setFrom()方法来设置发送者的地址
通过setSubject()方法来设置邮件的主题
通过setTo()，setCc()，setBcc()之一来设置接收者
通过setBody()方法设置邮件内容

用下面的代码替换activateAction()：

// src/Ibw/JobeetBundle/Controller/AffiliateAdminController.php
// ...

    public function activateAction($id)
    {
       if($this->admin->isGranted('EDIT') === false) {
            throw new AccessDeniedException();
        }

        $em = $this->getDoctrine()->getManager();
        $affiliate = $em->getRepository('IbwJobeetBundle:Affiliate')->findOneById($id);

        try {
            $affiliate->setIsActive(true);
            $em->flush();

            $message = \Swift_Message::newInstance()
                ->setSubject('Jobeet affiliate token')
                ->setFrom('address@example.com')
                ->setTo($affiliate->getEmail())
                ->setBody(
                    $this->renderView('IbwJobeetBundle:Affiliate:email.txt.twig', array('affiliate' => $affiliate->getToken())))
            ;

            $this->get('mailer')->send($message);
        } catch(\Exception $e) {
            $this->get('session')->setFlash('sonata_flash_error', $e->getMessage());
        }

        return new RedirectResponse($this->admin->generateUrl('list',$this->admin->getFilterParameters()));
    }

// ...

发送邮件很简单，我们只需给mailer实例的send()方法传递一个message对象作为参数即可。

对于邮件的内容，我们创建了一个email.txt.twig文件，它准确地包含了我们想通知给affilate的内容。

Your affiliate account has been activated.
Your secret token is {{affiliate}}.
You can see the jobs list at the following addresses:
http://jobeet.local/app_dev.php/api/{{affiliate}}/jobs.xml
or http://jobeet.local/app_dev.php/api/{{affiliate}}/jobs.json
or http://jobeet.local/app_dev.php/api/{{affiliate}}/jobs.yaml

现在我们也为batchActionActivate添加发送邮件的功能，尽管一次性同时选择多个affiliate账户同时激活，他们也能够接收到邮件：

// src/Ibw/JobeetBundle/Controller/AffiliateAdminController.php
// ... 

    public function batchActionActivate(ProxyQueryInterface $selectedModelQuery)
    {
        // ...

        try {
            foreach($selectedModels as $selectedModel) {
                $selectedModel->activate();
                $modelManager->update($selectedModel);

                $message = \Swift_Message::newInstance()
                    ->setSubject('Jobeet affiliate token')
                    ->setFrom('address@example.com')
                    ->setTo($selectedModel->getEmail())
                    ->setBody(
                        $this->renderView('IbwJobeetBundle:Affiliate:email.txt.twig', array('affiliate' => $selectedModel->getToken())))
                ;

                $this->get('mailer')->send($message);
            }
        } catch(\Exception $e) {
            $this->get('session')->setFlash('sonata_flash_error', $e->getMessage());

            return new RedirectResponse($this->admin->generateUrl('list',$this->admin->getFilterParameters()));
        }

        // ...
    }

// ...

测试

我们已经看到了怎么样使用Symfony来发送邮件，现在我们来写一些功能测试以确保它们能正确地工作。

为了测试新功能，我们需要进行登录。为了登录，我们需要用户名和密码。我们来创建先的fixture文件，在这个文件中添加admin用户：

// src/Ibw/JobeetBundle/DataFixtures/ORM/LoadUserData.php
namespace Ibw\JobeetBundle\DataFixtures\ORM;

use Doctrine\Common\Persistence\ObjectManager;
use Doctrine\Common\DataFixtures\AbstractFixture;
use Doctrine\Common\DataFixtures\FixtureInterface;
use Doctrine\Common\DataFixtures\OrderedFixtureInterface;
use Symfony\Component\DependencyInjection\ContainerAwareInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Ibw\JobeetBundle\Entity\User;

class LoadUserData implements FixtureInterface, OrderedFixtureInterface, ContainerAwareInterface
{
    /**
     * @var ContainerInterface
     */
    private $container;

    /**
     * {@inheritDoc}
     */
    public function setContainer(ContainerInterface $container = null)
    {
        $this->container = $container;
    }

    /**
     * @param \Doctrine\Common\Persistence\ObjectManager $em
     */
    public function load(ObjectManager $em)
    {
        $user = new User();
        $user->setUsername('admin');
        $encoder = $this->container
            ->get('security.encoder_factory')
            ->getEncoder($user)
        ;

        $encodedPassword = $encoder->encodePassword('admin', $user->getSalt());
        $user->setPassword($encodedPassword);

        $em->persist($user);
        $em->flush();
    }

    public function getOrder()
    {
        return 4; // the order in which fixtures will be loaded
    }
}

在测试中，我们会使用分析器（profiler）中为swiftmailer的collector来得到上一个请求中的邮件发送信息。现在我们来添加一些代码检查邮件是否正确发送：

// src/Ibw/JobeetBundle/Tests/Controller/AffiliateAdminControllerTest.php
namespace Ibw\JobeetBundle\Tests\Controller;

use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
use Symfony\Bundle\FrameworkBundle\Console\Application;
use Symfony\Component\Console\Output\NullOutput;
use Symfony\Component\Console\Input\ArrayInput;
use Doctrine\Bundle\DoctrineBundle\Command\DropDatabaseDoctrineCommand;
use Doctrine\Bundle\DoctrineBundle\Command\CreateDatabaseDoctrineCommand;
use Doctrine\Bundle\DoctrineBundle\Command\Proxy\CreateSchemaDoctrineCommand;

class AffiliateAdminControllerTest extends WebTestCase
{
    private $em;
    private $application;

    public function setUp()
    {
        static::$kernel = static::createKernel();
        static::$kernel->boot();

        $this->application = new Application(static::$kernel);

        // drop the database
        $command = new DropDatabaseDoctrineCommand();
        $this->application->add($command);
        $input = new ArrayInput(array(
            'command' => 'doctrine:database:drop',
            '--force' => true
        ));
        $command->run($input, new NullOutput());

        // we have to close the connection after dropping the database so we don't get "No database selected" error
        $connection = $this->application->getKernel()->getContainer()->get('doctrine')->getConnection();
        if ($connection->isConnected()) {
            $connection->close();
        }

        // create the database
        $command = new CreateDatabaseDoctrineCommand();
        $this->application->add($command);
        $input = new ArrayInput(array(
            'command' => 'doctrine:database:create',
        ));
        $command->run($input, new NullOutput());

        // create schema
        $command = new CreateSchemaDoctrineCommand();
        $this->application->add($command);
        $input = new ArrayInput(array(
            'command' => 'doctrine:schema:create',
        ));
        $command->run($input, new NullOutput());

        // get the Entity Manager
        $this->em = static::$kernel->getContainer()
            ->get('doctrine')
            ->getManager();

        // load fixtures
        $client = static::createClient();
        $loader = new \Symfony\Bridge\Doctrine\DataFixtures\ContainerAwareLoader($client->getContainer());
        $loader->loadFromDirectory(static::$kernel->locateResource('@IbwJobeetBundle/DataFixtures/ORM'));
        $purger = new \Doctrine\Common\DataFixtures\Purger\ORMPurger($this->em);
        $executor = new \Doctrine\Common\DataFixtures\Executor\ORMExecutor($this->em, $purger);
        $executor->execute($loader->getFixtures());
    }

    public function testActivate()
    {
        $client = static::createClient();

        // Enable the profiler for the next request (it does nothing if the profiler is not available)
        $client->enableProfiler();
        $crawler = $client->request('GET', '/login');

        $form = $crawler->selectButton('login')->form(array(
            '_username'      => 'admin',
            '_password'      => 'admin'
        ));

        $crawler = $client->submit($form);
        $crawler = $client->followRedirect();

        $this->assertTrue(200 === $client->getResponse()->getStatusCode());

        $crawler = $client->request('GET', '/admin/ibw/jobeet/affiliate/list');

        $link = $crawler->filter('.btn.edit_link')->link();
        $client->click($link);

        $mailCollector = $client->getProfile()->getCollector('swiftmailer');

        // Check that an e-mail was sent
        $this->assertEquals(1, $mailCollector->getMessageCount());

        $collectedMessages = $mailCollector->getMessages();
        $message = $collectedMessages[0];

        // Asserting e-mail data
        $this->assertInstanceOf('Swift_Message', $message);
        $this->assertEquals('Jobeet affiliate token', $message->getSubject());
        $this->assertRegExp(
            '/Your secret token is symfony/',
            $message->getBody()
        );
    }
}

如果你现在运行测试将会得到错误。为了防止错误发生，我们需要确保config_test.yml文件中的profiler在测试环境里是开启的。如果它被设成fasle，请设成true：

# app/config/config_test.yml
# ...

framework:
    test: ~
    session:
        storage_id: session.storage.mock_file
    profiler:
        enabled: true

# ...

清除缓存后运行测试命令，哈哈，好好享受green bar吧：

phpunit -c app src/Ibw/JobeetBundle/Tests/Controller/AffiliateAdminControllerTest

原文链接：http://www.intelligentbee.com/blog/2013/08/24/symfony2-jobeet-day-16-the-mailer/

jobeet第十六天:邮件，首发于Symfony中文教程。

jobeet第十五天:Web Services

napoleon — Fri, 27 Mar 2015 08:50:36 +0000

*这一系列文章来源于Fabien Potencier，基于Symfony1.4编写的Jobeet Tutirual。

在昨天的内容中，我们给Jobeet加上了订阅功能之后，用户就可以实时地接收到最新发布的信息了。

现在我们试着站在发布者的角度来思考，当发布者发布一个Job信息之后，发布者想要让尽可能多的人能够了解到这条信息。如果我们能把这些信息放在很多小网站上，这样一来看的人越多，那么发布者就将有更大几率能够找到适合这个工作的人选了。这就是所谓的长尾效应（long tail）。Affiliates能够在他们的网站上发布最新的Job信息，这些都需要web services的支持，那么我们今天就来实现web services。

Affiliates

就像我们在第二天中内容说的那样，一个Affiliate能够得到所有当前已激活的Job列表。

The fixtures

我们为Affiliates创建一个新的Fixture文件：

// src/Ibw/JobeetBundle/DataFixtures/ORM/LoadAffiliateData.php
namespace Ibw\JobeetBundle\DataFixtures\ORM;

use Doctrine\Common\Persistence\ObjectManager;
use Doctrine\Common\DataFixtures\AbstractFixture;
use Doctrine\Common\DataFixtures\OrderedFixtureInterface;
use Ibw\JobeetBundle\Entity\Affiliate;

class LoadAffiliateData extends AbstractFixture implements OrderedFixtureInterface
{
    public function load(ObjectManager $em)
    {
        $affiliate = new Affiliate();

        $affiliate->setUrl('http://sensio-labs.com/');
        $affiliate->setEmail('address1@example.com');
        $affiliate->setToken('sensio-labs');
        $affiliate->setIsActive(true);
        $affiliate->addCategorie($em->merge($this->getReference('category-programming')));

        $em->persist($affiliate);

        $affiliate = new Affiliate();

        $affiliate->setUrl('/');
        $affiliate->setEmail('address2@example.org');
        $affiliate->setToken('symfony');
        $affiliate->setIsActive(false);
        $affiliate->addCategorie($em->merge($this->getReference('category-programming')), $em->merge($this->getReference('category-design')));

        $em->persist($affiliate);
        $em->flush();

        $this->addReference('affiliate', $affiliate);
    }

    public function getOrder()
    {
        return 3; // This represents the order in which fixtures will be loaded
    }
}

现在运行下面的命令，我们把定义在Fixture文件中的数据持久化到数据库中：

php app/console doctrine:fixtures:load

在Fixture文件中，我们可以看到token是硬编码写上去的，这里的目的是为了方便测试。但当在实际的运行时，当用户需要申请为Affiliate时，这个token将会被自动生成。我们在Affiliate类中创建一个方法来生成token。我们先在ORM文件中的lifecycleCallbacks部分添加setTokenValue方法：

# src/Ibw/JobeetBundle/Resources/config/doctrine/Affiliate.orm.yml
# ... 
    lifecycleCallbacks:
        prePersist: [ setCreatedAtValue, setTokenValue ]

运行下面的命令会后，Affiliate类中将会生成setTokenValue()方法：

php app/console doctrine:generate:entities IbwJobeetBundle

现在我们来修改这个方法：

// src/Ibw/JobeetBundle/Entity/Affiliate.php
public function setTokenValue()
{
    if(!$this->getToken()) {
        $token = sha1($this->getEmail().rand(11111, 99999));
        $this->token = $token;
    }

    return $this;
}

重新加载数据：

php app/console doctrine:fixtures:load

The Job Web Service

和以前一样，我们每次创建新资源的的时候，第一件要做的事情就是定义路由，这是个好习惯：

# src/Ibw/JobeetBundle/Resources/config/routing.yml
IbwJobeetBundle_api:
    pattern: /api/{token}/jobs.{_format}
    defaults: {_controller: "IbwJobeetBundle:Api:list"}
    requirements:
        _format: xml|json|yaml

通常我们修改过路由文件之后，我们都需要去清除cache：

php app/console cache:clear --env=dev
php app/console cache:clear --env=prod

我们的下一步是创建api动作和相应的模板，它们会共享相同的动作。我们新建一个控制器文件，并把它命名为“ApiController”：

// src/Ibw/JobeetBundle/Controller/ApiController.php
namespace Ibw\JobeetBundle\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Ibw\JobeetBundle\Entity\Affiliate;
use Ibw\JobeetBundle\Entity\Job;
use Ibw\JobeetBundle\Repository\AffiliateRepository;

class ApiController extends Controller
{
    public function listAction(Request $request, $token)
    {
        $em = $this->getDoctrine()->getManager();

        $jobs = array();

        $rep = $em->getRepository('IbwJobeetBundle:Affiliate');
        $affiliate = $rep->getForToken($token);

        if(!$affiliate) { 
            throw $this->createNotFoundException('This affiliate account does not exist!');
        }

        $rep = $em->getRepository('IbwJobeetBundle:Job');
        $active_jobs = $rep->getActiveJobs(null, null, null, $affiliate->getId());

        foreach ($active_jobs as $job) {
            $jobs[$this->get('router')->generate('ibw_job_show', array('company' => $job->getCompanySlug(), 'location' => $job->getLocationSlug(), 'id' => $job->getId(), 'position' => $job->getPositionSlug()), true)] = $job->asArray($request->getHost());
        }

        $format = $request->getRequestFormat();
        $jsonData = json_encode($jobs);

        if ($format == "json") {
            $headers = array('Content-Type' => 'application/json'); 
            $response = new Response($jsonData, 200, $headers);

            return $response;
        }

        return $this->render('IbwJobeetBundle:Api:jobs.' . $format . '.twig', array('jobs' => $jobs));  
    }
}

为了能够通过token获得Affiliate的信息，我们需要创建getForToken()方法。这个方法同样会验证Affiliate是否是已激活的，所以我们这里就不需要再判断Affiliate是否已被激活。到现在为止我们还尚未使用过AffiliateRepository，因为它还不存在。我们现在就来创建它，先修改ORM文件：

# src/Ibw/JobeetBundle/Resources/config/doctrine/Affiliate.orm.yml
Ibw\JobeetBundle\Entity\Affiliate:
    type: entity
    repositoryClass: Ibw\JobeetBundle\Repository\AffiliateRepository
    # ...

运行下面的代码：

php app/console doctrine:generate:entities IbwJobeetBundle

创建完毕后，我们马上就可以使用它了：

// src/Ibw/JobeetBundle/Repository/AffiliateRepository.php
namespace Ibw\JobeetBundle\Repository;

use Doctrine\ORM\EntityRepository;

/**
 * AffiliateRepository
 *
 * This class was generated by the Doctrine ORM. Add your own custom
 * repository methods below.
 */
class AffiliateRepository extends EntityRepository
{
    public function getForToken($token)
    {
        $qb = $this->createQueryBuilder('a')
            ->where('a.is_active = :active')
            ->setParameter('active', 1)
            ->andWhere('a.token = :token')
            ->setParameter('token', $token)
            ->setMaxResults(1)
        ;

        try{
            $affiliate = $qb->getQuery()->getSingleResult();
        } catch(\Doctrine\Orm\NoResultException $e){
            $affiliate = null;
        }

        return $affiliate;
    }
}

当通过token取出对应的Affiliate之后，我们会调用getActiveJobs()方法返回属于某个分类的所有的Job信息给Affiliate。如果你打开JobRepository.php文件，可以看到getActiveJobs()方法没有提供任何的参数选项给Affiliate使用。为了能够重用这个方法，我们需要对它做一些修改：

// src/Ibw/JobeetBundle/Repository/JobRepository.php
// ...

    public function getActiveJobs($category_id = null, $max = null, $offset = null, $affiliate_id = null)
    {
        $qb = $this->createQueryBuilder('j')
            ->where('j.expires_at > :date')
            ->setParameter('date', date('Y-m-d H:i:s', time()))
            ->andWhere('j.is_activated = :activated')
            ->setParameter('activated', 1)
            ->orderBy('j.expires_at', 'DESC');

        if($max) {
            $qb->setMaxResults($max);
        }

        if($offset) {
            $qb->setFirstResult($offset);
        }

        if($category_id) {
            $qb->andWhere('j.category = :category_id')
                ->setParameter('category_id', $category_id);
        }
        // j.category c, c.affiliate a
        if($affiliate_id) {
            $qb->leftJoin('j.category', 'c')
               ->leftJoin('c.affiliates', 'a')
               ->andWhere('a.id = :affiliate_id')
               ->setParameter('affiliate_id', $affiliate_id)
            ;
        }

        $query = $qb->getQuery();

        return $query->getResult();
    }

// ...

就如你所看到的，我们调用了asArray()函数来填充jobs数组。我们来定义它：

// src/Ibw/JobeetBundle/Entity/Job.php
public function asArray($host)
{
    return array(
        'category'     => $this->getCategory()->getName(),
        'type'         => $this->getType(),
        'company'      => $this->getCompany(),
        'logo'         => $this->getLogo() ? 'http://' . $host . '/uploads/jobs/' . $this->getLogo() : null,
        'url'          => $this->getUrl(),
        'position'     => $this->getPosition(),
        'location'     => $this->getLocation(),
        'description'  => $this->getDescription(),
        'how_to_apply' => $this->getHowToApply(),
        'expires_at'   => $this->getCreatedAt()->format('Y-m-d H:i:s'),
    );
}

XML格式

支持XML格式很简单，只需要创建一个模板即可：




{% for url, job in jobs %}
    
{% for key,value in job %}
        <{{ key }}>{{ value }}
{% endfor %}
    
{% endfor %}

JSON格式

支持JSON格式也是类似的：

// src/Ibw/JobeetBundle/Resources/views/Api/jobs.json.twig
{% for url, job in jobs %}
{% i = 0, count(jobs), ++i %}
[
    "url":"{{ url }}",
{% for key, value in job %} {% j = 0, count(key), ++j %}
    "{{ key }}":"{% if j == count(key)%} {{ json_encode(value) }}, {% else %} {{ json_encode(value) }}
                 {% endif %}"
{% endfor %}]
{% endfor %}

YAML格式

# src/Ibw/JobeetBundle/Resources/views/Api/jobs.yaml.twig
{% for url,job in jobs %}
    Url: {{ url }}
{% for key, value in job %}
        {{ key }}: {{ value }}
{% endfor %}
{% endfor %}

如果你想通过一个无效的token来调用web service，那么不论你请求的是什么格式的内容，你都将会得到一个404响应。如果你想看到我们努力的成果，你可以试试访问下面的链接：http://jobeet.local/app_dev.php/api/sensio-labs/jobs.xml或者是http://jobeet.local/app_dev.php/api/symfony/jobs.xml。你可以修改URL中的扩展名来得到指定格式的内容。

测试Web Service

// src/Ibw/JobeetBundle/Tests/Controller/ApiControllerTest.php
namespace Ibw\JobeetBundle\Tests\Controller;

use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
use Symfony\Bundle\FrameworkBundle\Console\Application;
use Symfony\Component\Console\Output\NullOutput;
use Symfony\Component\Console\Input\ArrayInput;
use Doctrine\Bundle\DoctrineBundle\Command\DropDatabaseDoctrineCommand;
use Doctrine\Bundle\DoctrineBundle\Command\CreateDatabaseDoctrineCommand;
use Doctrine\Bundle\DoctrineBundle\Command\Proxy\CreateSchemaDoctrineCommand;
use Symfony\Component\DomCrawler\Crawler;
use Symfony\Component\HttpFoundation\HttpExceptionInterface;

class ApiControllerTest extends WebTestCase
{
    private $em;

    private $application;

    public function setUp()
    {
        static::$kernel = static::createKernel();
        static::$kernel->boot();

        $this->application = new Application(static::$kernel);

        // drop the database
        $command = new DropDatabaseDoctrineCommand();
        $this->application->add($command);
        $input = new ArrayInput(array(
            'command' => 'doctrine:database:drop',
            '--force' => true
        ));
        $command->run($input, new NullOutput());

        // we have to close the connection after dropping the database so we don't get "No database selected" error
        $connection = $this->application->getKernel()->getContainer()->get('doctrine')->getConnection();
        if ($connection->isConnected()) {
            $connection->close();
        }

        // create the database
        $command = new CreateDatabaseDoctrineCommand();
        $this->application->add($command);
        $input = new ArrayInput(array(
            'command' => 'doctrine:database:create',
        ));
        $command->run($input, new NullOutput());

        // create schema
        $command = new CreateSchemaDoctrineCommand();
        $this->application->add($command);
        $input = new ArrayInput(array(
            'command' => 'doctrine:schema:create',
        ));
        $command->run($input, new NullOutput());

        // get the Entity Manager
        $this->em = static::$kernel->getContainer()
            ->get('doctrine')
            ->getManager();

        // load fixtures
        $client = static::createClient();
        $loader = new \Symfony\Bridge\Doctrine\DataFixtures\ContainerAwareLoader($client->getContainer());
        $loader->loadFromDirectory(static::$kernel->locateResource('@IbwJobeetBundle/DataFixtures/ORM'));
        $purger = new \Doctrine\Common\DataFixtures\Purger\ORMPurger($this->em);
        $executor = new \Doctrine\Common\DataFixtures\Executor\ORMExecutor($this->em, $purger);
        $executor->execute($loader->getFixtures());
    }

    public function testList()
    {
        $client = static::createClient();
        $crawler = $client->request('GET', '/api/sensio-labs/jobs.xml');

        $this->assertEquals('Ibw\JobeetBundle\Controller\ApiController::listAction', $client->getRequest()->attributes->get('_controller'));
        $this->assertTrue($crawler->filter('description')->count() == 32);

        $crawler = $client->request('GET', '/api/sensio-labs87/jobs.xml');

        $this->assertTrue(404 === $client->getResponse()->getStatusCode());

        $crawler = $client->request('GET', '/api/symfony/jobs.xml');

        $this->assertTrue(404 === $client->getResponse()->getStatusCode());

        $crawler = $client->request('GET', '/api/sensio-labs/jobs.json');

        $this->assertEquals('Ibw\JobeetBundle\Controller\ApiController::listAction', $client->getRequest()->attributes->get('_controller'));
        $this->assertRegExp('/"category"\:"Programming"/', $client->getResponse()->getContent());

        $crawler = $client->request('GET', '/api/sensio-labs87/jobs.json');

        $this->assertTrue(404 === $client->getResponse()->getStatusCode());

        $crawler = $client->request('GET', '/api/sensio-labs/jobs.yaml');
        $this->assertRegExp('/category\: Programming/', $client->getResponse()->getContent());

        $this->assertEquals('Ibw\JobeetBundle\Controller\ApiController::listAction', $client->getRequest()->attributes->get('_controller'));

        $crawler = $client->request('GET', '/api/sensio-labs87/jobs.yaml');

        $this->assertTrue(404 === $client->getResponse()->getStatusCode());
    }
}

Affiliate申请表单

web service已经可以使用了，现在我们来添加创建Affiliate的表单吧。为了实现这个功能，我们需要写HTML表单，为每个表单域实现验证规则，把表单域的值处理后保存到数据库中，当表单数据有错误时还需要显示出错误信息反馈给用户。

首先我们先创建控制器文件，把它命名为AffiliateCotrolelr：

// src/Ibw/JobeetBundle/Tests/Controller/AffiliateController.php
namespace Ibw\JobeetBundle\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Ibw\JobeetBundle\Entity\Affiliate;
use Ibw\JobeetBundle\Form\AffiliateType;
use Symfony\Component\HttpFoundation\Request;
use Ibw\JobeetBundle\Entity\Category;

class AffiliateController extends Controller
{
    // Your code goes here
}

然后修改layout.html.twig中的链接：



    Become an affiliate

现在创建一个action来匹配刚才修改链接的路由：

// src/Ibw/JobeetBundle/Controller/AffiliateController.php
namespace Ibw\JobeetBundle\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Ibw\JobeetBundle\Entity\Affiliate;
use Ibw\JobeetBundle\Form\AffiliateType;
use Symfony\Component\HttpFoundation\Request;
use Ibw\JobeetBundle\Entity\Category;

class AffiliateController extends Controller
{
    public function newAction()
    {
        $entity = new Affiliate();
        $form = $this->createForm(new AffiliateType(), $entity);

        return $this->render('IbwJobeetBundle:Affiliate:affiliate_new.html.twig', array(
            'entity' => $entity,
            'form'   => $form->createView(),
        ));
    }
}

我们已经有了路由的名字还有action，但我们还没有路由。所以我们来创建它：

# src/Ibw/JobeetBundle/Resources/config/routing/affiliate.yml
ibw_affiliate_new:
    pattern:  /new
    defaults: { _controller: "IbwJobeetBundle:Affiliate:new" }

同样需要在routing.yml文件中加入下面的代码：

# src/Ibw/JobeetBundle/Resources/config/routing.yml
# ...

IbwJobeetBundle_ibw_affiliate:
    resource: "@IbwJobeetBundle/Resources/config/routing/affiliate.yml"
    prefix:   /affiliate

表单类同样需要被创建出来。尽管Affiliate有很多的字段域，但我们没有必要把它们全部显示出来，因为有些字段域是不需要用来填写的。我们来创建Affiliate表单：

// src/Ibw/JobeetBundle/Form/AffiliateType.php
namespace Ibw\JobeetBundle\Form;

use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\OptionsResolver\OptionsResolverInterface;
use Ibw\JobeetBundle\Entity\Affiliate;
use Ibw\JobeetBundle\Entity\Category;

class AffiliateType extends AbstractType
{
    public function buildForm(FormBuilderInterface $builder, array $options)
    {
        $builder
            ->add('url')
            ->add('email')
            ->add('categories', null, array('expanded'=>true))
        ;
    }

    public function setDefaultOptions(OptionsResolverInterface $resolver)
    {
        $resolver->setDefaults(array(
            'data_class' => 'Ibw\JobeetBundle\Entity\Affiliate',
        ));
    }

    public function getName()
    {
        return 'affiliate';
    }
}

现在我们需要验证提交上来的Affiliate表单对象中的数据是否有效。我们在validation.yml文件中添加下面的代码：

# src/Ibw/JobeetBundle/Resources/config/validation.yml
# ...

Ibw\JobeetBundle\Entity\Affiliate:
    constraints:
        - Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity: email
    properties:
        url:
            - Url: ~
        email:
            - NotBlank: ~
            - Email: ~

在上面的代码中，我们使用了一个新的验证器，叫做UniqueEntity。它能够验证Doctrine实体对象中的一个或者多个特殊字段域是否是唯一的。这个十分常用，例如，我们需要防止一个新注册用户的email地址和已存在用户的email地址重复。

添加了验证约束之后不要忘记清除cache！

最后一步需要创建表单试图：


{% extends 'IbwJobeetBundle::layout.html.twig' %}

{% set form_themes = _self %}

{% block form_errors %}
{% spaceless %}
    {% if errors|length > 0 %}
        
            {% for error in errors %}
                {{ error.messageTemplate|trans(error.messageParameters, 'validators') }}
            {% endfor %}
        
    {% endif %}
{% endspaceless %}
{% endblock form_errors %}

{% block stylesheets %}
    {{ parent() }}
    
{% endblock %}

{% block content %}
    Become an affiliate
        
            
                
                    
                        
                            
                        
                    
                
                
                    
                        {{ form_label(form.url) }}
                        
                            {{ form_errors(form.url) }}
                            {{ form_widget(form.url) }}
                        
                    
                    
                        {{ form_label(form.email) }}
                        
                            {{ form_errors(form.email) }}
                            {{ form_widget(form.email) }}
                        
                    
                    
                        {{ form_label(form.categories) }}
                        
                            {{ form_errors(form.categories) }}
                            {{ form_widget(form.categories) }}
                        
                    
                
            
        {{ form_end(form) }}
{% endblock %}


{{ form_label(form.url) }}	{{ form_errors(form.url) }} {{ form_widget(form.url) }}
{{ form_label(form.email) }}	{{ form_errors(form.email) }} {{ form_widget(form.email) }}
{{ form_label(form.categories) }}	{{ form_errors(form.categories) }} {{ form_widget(form.categories) }}

当提交的表单数据如果是有效的，那么表单数据就会被保存到数据库中。我们为AffiliateController添加create动作：

// src/Ibw/JobeetBundle/Controller/AffiliateController.php
class AffiliateController extends Controller 
{
    // ...    

    public function createAction(Request $request)
    {
        $affiliate = new Affiliate();
        $form = $this->createForm(new AffiliateType(), $affiliate);
        $form->bind($request);
        $em = $this->getDoctrine()->getManager();

        if ($form->isValid()) {

            $formData = $request->get('affiliate');
            $affiliate->setUrl($formData['url']);
            $affiliate->setEmail($formData['email']);
            $affiliate->setIsActive(false);

            $em->persist($affiliate);
            $em->flush();

            return $this->redirect($this->generateUrl('ibw_affiliate_wait'));
        }

        return $this->render('IbwJobeetBundle:Affiliate:affiliate_new.html.twig', array(
            'entity' => $affiliate,
            'form'   => $form->createView(),
        ));
    }
}

当表单一旦被提交，那么createAction()就会被执行，所以我们需要定义路由：

# src/Ibw/JobeetBundle/Resources/config/routing/affiliate.yml
# ...

ibw_affiliate_create:
    pattern: /create
    defaults: { _controller: "IbwJobeetBundle:Affiliate:create" }
    requirements: { _method: post }

Affiliate注册之后，他将会被重定向到等待页面。我们来为定义这个动作或试图吧：

// src/Ibw/JobeetBundle/Controller/AffiliateController.php
class AffiliateController extends Controller
{
    // ...

    public function waitAction()
    {
        return $this->render('IbwJobeetBundle:Affiliate:wait.html.twig');
    }
}


{% extends "IbwJobeetBundle::layout.html.twig" %}

{% block content %}
    
        Your affiliate account has been created
        
            Thank you!
            You will receive an email with your affiliate token
            as soon as your account will be activated.
        
    
{% endblock %}

现在添加路由：

# src/Ibw/JobeetBundle/Resources/config/routing/affiliate.yml
# ...

ibw_affiliate_wait:
    pattern: /wait
    defaults: { _controller: "IbwJobeetBundle:Affiliate:wait" }

定义好路由之后，我们需要清除cache。

现在你可以试着点击首页中的Affiliates链接，你会跳转到Affiliate表单页面。

测试

最后一步是为新功能添加功能测试：

// src/Ibw/JobeetBundle/Tests/Controller/AffiliateControllerTest.php
namespace Ibw\JobeetBundle\Tests\Controller;

use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
use Symfony\Bundle\FrameworkBundle\Console\Application;
use Symfony\Component\Console\Output\NullOutput;
use Symfony\Component\Console\Input\ArrayInput;
use Doctrine\Bundle\DoctrineBundle\Command\DropDatabaseDoctrineCommand;
use Doctrine\Bundle\DoctrineBundle\Command\CreateDatabaseDoctrineCommand;
use Doctrine\Bundle\DoctrineBundle\Command\Proxy\CreateSchemaDoctrineCommand;
use Symfony\Component\DomCrawler\Crawler;

class AffiliateControllerTest extends WebTestCase
{
    private $em;
    private $application;

    public function setUp()
    {
        static::$kernel = static::createKernel();
        static::$kernel->boot();

        $this->application = new Application(static::$kernel);

        // drop the database
        $command = new DropDatabaseDoctrineCommand();
        $this->application->add($command);
        $input = new ArrayInput(array(
            'command' => 'doctrine:database:drop',
            '--force' => true
        ));
        $command->run($input, new NullOutput());

        // we have to close the connection after dropping the database so we don't get "No database selected" error
        $connection = $this->application->getKernel()->getContainer()->get('doctrine')->getConnection();
        if ($connection->isConnected()) {
            $connection->close();
        }

        // create the database
        $command = new CreateDatabaseDoctrineCommand();
        $this->application->add($command);
        $input = new ArrayInput(array(
            'command' => 'doctrine:database:create',
        ));
        $command->run($input, new NullOutput());

        // create schema
        $command = new CreateSchemaDoctrineCommand();
        $this->application->add($command);
        $input = new ArrayInput(array(
            'command' => 'doctrine:schema:create',
        ));
        $command->run($input, new NullOutput());

        // get the Entity Manager
        $this->em = static::$kernel->getContainer()
            ->get('doctrine')
            ->getManager();

        // load fixtures
        $client = static::createClient();
        $loader = new \Symfony\Bridge\Doctrine\DataFixtures\ContainerAwareLoader($client->getContainer());
        $loader->loadFromDirectory(static::$kernel->locateResource('@IbwJobeetBundle/DataFixtures/ORM'));
        $purger = new \Doctrine\Common\DataFixtures\Purger\ORMPurger($this->em);
        $executor = new \Doctrine\Common\DataFixtures\Executor\ORMExecutor($this->em, $purger);
        $executor->execute($loader->getFixtures());
    }

    public function testAffiliateForm()
    {
        $client = static::createClient();
        $crawler = $client->request('GET', '/affiliate/new');

        $this->assertEquals('Ibw\JobeetBundle\Controller\AffiliateController::newAction', $client->getRequest()->attributes->get('_controller'));

        $form = $crawler->selectButton('Submit')->form(array(
            'affiliate[url]' => 'http://sensio-labs.com/',
            'affiliate[email]' => 'jobeet@example.com'
        ));

        $client->submit($form);
        $this->assertEquals('Ibw\JobeetBundle\Controller\AffiliateController::createAction', $client->getRequest()->attributes->get('_controller'));

        $kernel = static::createKernel();
        $kernel->boot();
        $em = $kernel->getContainer()->get('doctrine.orm.entity_manager');

        $query = $em->createQuery('SELECT count(a.email) FROM IbwJobeetBundle:Affiliate a WHERE a.email = :email');
        $query->setParameter('email', 'jobeet@example.com');
        $this->assertEquals(1, $query->getSingleScalarResult());

        $crawler = $client->request('GET', '/affiliate/new');
        $form = $crawler->selectButton('Submit')->form(array(
            'affiliate[email]'        => 'not.an.email',
        ));
        $crawler = $client->submit($form);

        // check if we have 1 errors
        $this->assertTrue($crawler->filter('.error_list')->count() == 1);
        // check if we have error on affiliate_email field
        $this->assertTrue($crawler->filter('#affiliate_email')->siblings()->first()->filter('.error_list')->count() == 1);
    }

    public function testCreate()
    {
        $client = static::createClient();
        $crawler = $client->request('GET', '/affiliate/new');
        $form = $crawler->selectButton('Submit')->form(array(
            'affiliate[url]' => 'http://sensio-labs.com/',
            'affiliate[email]' => 'address@example.com'
        ));

        $client->submit($form);
        $client->followRedirect();

        $this->assertEquals('Ibw\JobeetBundle\Controller\AffiliateController::waitAction', $client->getRequest()->attributes->get('_controller'));

        return $client;
    }

    public function testWait()
    {
        $client = static::createClient();
        $crawler = $client->request('GET', '/affiliate/wait');

        $this->assertEquals('Ibw\JobeetBundle\Controller\AffiliateController::waitAction', $client->getRequest()->attributes->get('_controller'));
    }
}

Affiliate后台管理

对于后台，我们会使用SonataAdminBundle。就像我们之前说过的那样，Affiliate注册之后需要等待admin来激活他。所以，当admin访问Affiliate页面后，他只能看到激活或者不激活这两个操作，这样有利于提高工作效率嘛。

首先，你需要在services.yml中声明Affiliate服务：

# src/Ibw/JobeetBundle/Resources/config/service.yml
# ...
    ibw.jobeet.admin.affiliate:
        class: Ibw\JobeetBundle\Admin\AffiliateAdmin
        tags:
            - { name: sonata.admin, manager_type: orm, group: jobeet, label: Affiliates }
        arguments:
            - ~
            - Ibw\JobeetBundle\Entity\Affiliate
            - 'IbwJobeetBundle:AffiliateAdmin'

然后创建Admin文件：

// src/Ibw/JobeetBundle/Admin/AffiliateAdmin.php
namespace Ibw\JobeetBundle\Admin;

use Sonata\AdminBundle\Admin\Admin;
use Sonata\AdminBundle\Datagrid\ListMapper;
use Sonata\AdminBundle\Datagrid\DatagridMapper;
use Sonata\AdminBundle\Validator\ErrorElement;
use Sonata\AdminBundle\Form\FormMapper;
use Sonata\AdminBundle\Show\ShowMapper;
use Ibw\JobeetBundle\Entity\Affiliate;

class AffiliateAdmin extends Admin
{
    protected $datagridValues = array(
        '_sort_order' => 'ASC',
        '_sort_by' => 'is_active'
    );

    protected function configureFormFields(FormMapper $formMapper)
    {
        $formMapper
            ->add('email')
            ->add('url')
        ;
    }

    protected function configureDatagridFilters(DatagridMapper $datagridMapper)
    {
        $datagridMapper
            ->add('email')
            ->add('is_active');
    }

    protected function configureListFields(ListMapper $listMapper)
    {
        $listMapper
            ->add('is_active')
            ->addIdentifier('email')
            ->add('url')
            ->add('created_at')
            ->add('token')
        ;
    }
}

为辅助管理员工作，我们想要只显示出未激活的Affiliate。我们能够通过过滤is_active值为false的Affiliate来实现这个功能：

// src/Ibw/JobeetBundle/Admin/AffiliateAdmin.php
// ...
    protected $datagridValues = array(
        '_sort_order' => 'ASC',
        '_sort_by' => 'is_active',
        'is_active' => array('value' => 2) // The value 2 represents that the displayed affiliate accounts are not activated yet
    );

// ...

现在我们创建AffiliateAdminController：

// src/Ibw/JobeetBundle/Controller/AffiliateAdminController.php
namespace Ibw\JobeetBundle\Controller;

use Sonata\AdminBundle\Controller\CRUDController as Controller;
use Sonata\DoctrineORMAdminBundle\Datagrid\ProxyQuery as ProxyQueryInterface;
use Symfony\Component\HttpFoundation\RedirectResponse;

class AffiliateAdminController extends Controller
{
    // Your code goes here
}

我们来创建activate和deactivate批量操作：

// src/Ibw/JobeetBundle/Controller/AffiliateAdminController.php
namespace Ibw\JobeetBundle\Controller;

use Sonata\AdminBundle\Controller\CRUDController as Controller;
use Sonata\DoctrineORMAdminBundle\Datagrid\ProxyQuery as ProxyQueryInterface;
use Symfony\Component\HttpFoundation\RedirectResponse;

class AffiliateAdminController extends Controller
{
    public function batchActionActivate(ProxyQueryInterface $selectedModelQuery)
    {
        if($this->admin->isGranted('EDIT') === false || $this->admin->isGranted('DELETE') === false) {
            throw new AccessDeniedException();
        }

        $request = $this->get('request');
        $modelManager = $this->admin->getModelManager();

        $selectedModels = $selectedModelQuery->execute();

        try {
            foreach($selectedModels as $selectedModel) {
                $selectedModel->activate();
                $modelManager->update($selectedModel);
            }
        } catch(\Exception $e) {
            $this->get('session')->getFlashBag()->add('sonata_flash_error', $e->getMessage());

            return new RedirectResponse($this->admin->generateUrl('list',$this->admin->getFilterParameters()));
        }

        $this->get('session')->getFlashBag()->add('sonata_flash_success',  sprintf('The selected accounts have been activated'));

        return new RedirectResponse($this->admin->generateUrl('list',$this->admin->getFilterParameters()));
    }

    public function batchActionDeactivate(ProxyQueryInterface $selectedModelQuery)
    {
        if($this->admin->isGranted('EDIT') === false || $this->admin->isGranted('DELETE') === false) {
            throw new AccessDeniedException();
        }

        $request = $this->get('request');
        $modelManager = $this->admin->getModelManager();

        $selectedModels = $selectedModelQuery->execute();

        try {
            foreach($selectedModels as $selectedModel) {
                $selectedModel->deactivate();
                $modelManager->update($selectedModel);
            }
        } catch(\Exception $e) {
            $this->get('session')->getFlashBag()->add('sonata_flash_error', $e->getMessage());

            return new RedirectResponse($this->admin->generateUrl('list',$this->admin->getFilterParameters()));
        }

        $this->get('session')->getFlashBag()->add('sonata_flash_success',  sprintf('The selected accounts have been deactivated'));

        return new RedirectResponse($this->admin->generateUrl('list',$this->admin->getFilterParameters()));
    }
}

为了能够让批量操作生效，我们把它添加到Admin::getBatchActions()方法中：

// src/Ibw/JobeetBundle/Admin/AffiliateAdmin.php
class AffiliateAdmin extends Admin
{
    // ... 

    public function getBatchActions()
    {
        $actions = parent::getBatchActions();

        if($this->hasRoute('edit') && $this->isGranted('EDIT') && $this->hasRoute('delete') && $this->isGranted('DELETE')) {
            $actions['activate'] = array(
                'label'            => 'Activate',
                'ask_confirmation' => true
            );

            $actions['deactivate'] = array(
                'label'            => 'Deactivate',
                'ask_confirmation' => true
            );
        }

        return $actions;
    }
}

在此我们还需要给Affiliate实体添加两个方法：activate()和deactivate()：

// src/Ibw/JobeetBundle/Entity/Affiliate.php
// ...

    public function activate()
    {
        if(!$this->getIsActive()) {
            $this->setIsActive(true);
        }

        return $this->is_active;
    }

    public function deactivate()
    {
        if($this->getIsActive()) {
            $this->setIsActive(false);
        }

        return $this->is_active;
    }

现在我们为每条Affiliate信息都创建两个独立的动作，activate和deactivate。首先我们先为它们创建路由，这就是为什么我们的Admin类中重写了configureRoutes函数：

// src/Ibw/JobeetBundle/Admin/AffiliateAdmin.php
use Sonata\AdminBundle\Route\RouteCollection;

class AffiliateAdmin extends Admin
{
    // ...

    protected function configureRoutes(RouteCollection $collection) {
        parent::configureRoutes($collection);

        $collection->add('activate',
            $this->getRouterIdParameter().'/activate')
        ;

        $collection->add('deactivate',
            $this->getRouterIdParameter().'/deactivate')
        ;
    }
}

现在我们在AdminController中实现这两个动作：

// src/Ibw/JobeetBundle/Controller/AffiliateAdminController.php
class AffiliateAdminController extends Controller
{
    // ...

    public function activateAction($id)
    {
        if($this->admin->isGranted('EDIT') === false) {
            throw new AccessDeniedException();
        }

        $em = $this->getDoctrine()->getManager();
        $affiliate = $em->getRepository('IbwJobeetBundle:Affiliate')->findOneById($id);

        try {
            $affiliate->setIsActive(true);
            $em->flush();
        } catch(\Exception $e) {
            $this->get('session')->getFlashBag()->add('sonata_flash_error', $e->getMessage());

            return new RedirectResponse($this->admin->generateUrl('list', $this->admin->getFilterParameters()));
        }

        return new RedirectResponse($this->admin->generateUrl('list',$this->admin->getFilterParameters()));

    }

    public function deactivateAction($id)
    {
        if($this->admin->isGranted('EDIT') === false) {
            throw new AccessDeniedException();
        }

        $em = $this->getDoctrine()->getManager();
        $affiliate = $em->getRepository('IbwJobeetBundle:Affiliate')->findOneById($id);

        try {
            $affiliate->setIsActive(false);
            $em->flush();
        } catch(\Exception $e) {
            $this->get('session')->getFlashBag()->add('sonata_flash_error', $e->getMessage());

            return new RedirectResponse($this->admin->generateUrl('list', $this->admin->getFilterParameters()));
        }

        return new RedirectResponse($this->admin->generateUrl('list',$this->admin->getFilterParameters()));
    }
}

现在为新添加的action创建模板：


{% if admin.isGranted('EDIT', object) and admin.hasRoute('activate') %}
    
        
        {{ 'activate'|trans({}, 'SonataAdminBundle') }}
    
{% endif %}


{% if admin.isGranted('EDIT', object) and admin.hasRoute('deactivate') %}
    
        
        {{ 'deactivate'|trans({}, 'SonataAdminBundle') }}
    
{% endif %}

在AffiliateAdmin::configureListFields()方法中添加新的action和button后，我们就能在页面上看到每条Affiliate信息都把它们显示出来：

// src/Ibw/JobeetBundle/Admin/AffiliateAdmin.php
class AffiliateAdmin extends Admin
{
    // ...    

    protected function configureListFields(ListMapper $listMapper)
    {
        $listMapper
            ->add('is_active')
            ->addIdentifier('email')
            ->add('url')
            ->add('created_at')
            ->add('token')
            ->add('_action', 'actions', array( 'actions' => array('activate' => array('template' => 'IbwJobeetBundle:AffiliateAdmin:list__action_activate.html.twig'),
                'deactivate' => array('template' => 'IbwJobeetBundle:AffiliateAdmin:list__action_deactivate.html.twig'))))
        ;
    }
    /// ...
}

好的，马上清除掉cache来试试吧！

今天我们就到这了，明天我们会讲解发送邮件，当Affiliate被激活后将收到一封邮件。

原文链接：http://www.intelligentbee.com/blog/2013/08/21/symfony2-jobeet-day-15-web-services/

jobeet第十五天:Web Services，首发于Symfony中文教程。

jobeet第十四天:订阅

napoleon — Fri, 27 Mar 2015 08:27:31 +0000

*这一系列文章来源于Fabien Potencier，基于Symfony1.4编写的Jobeet Tutirual。

如果你正在寻找工作，那么你可能十分想要第一时间就能了解到最新发布的Job信息。我们总不可能每时每刻都守在电脑面前，不断地刷新网站是否有发布新的Job信息吧，那样很不方便，所以我们会为Jobeet用户提供订阅（feeds）功能，这样用户就能实时地接受到最新发布的Job信息了。

模板格式

模板是能把内容渲染成任意一种格式的通用方式，但我们在大多数情况下都是使用模板来渲染HTML内容。当然，模板也很容易生成Javascript，CSS，XML或者其它任意类型格式的内容。

我们来举个例子，比如说我们需要把相同的“资源”按照不同的格式渲染出来。为了把一个文章的索引页渲染成XML格式，我们只需简单地把把格式名包含进模板名中即可：

XML模板名：AcmeArticleBundle:Article:index.xml.twig
XML模板文件名：index.xml.twig

事实上，这仅仅只是一个命名约定，模板会基于它原本的格式，而并不会再被渲染成其它的格式了。.

在多数情况下，你可能希望只使用单个控制器来渲染用户期望得到的指定格式的内容。出于这个原因，我们通常的做法会是这样的：

public function indexAction()
{
    $format = $this->getRequest()->getRequestFormat();

    return $this->render('AcmeBlogBundle:Blog:index.'.$format.'.twig');
}

Request对象的getRequestFormat()方法默认返回的值是html，但它能够基于用户请求的格式返回任意类型的格式。请求格式通常由路由进行管理，路由是可以配置的，所以/contact的请求格式是html（因为默认是html格式），而/contact.xml的请求格式是xml。

为了创建带有格式参数的链接，我们需要在参数列表中加入_format键：


    PDF Version

// src/Ibw/JobeetBundle/Controller/JobController.php
// ...

        $latestJob = $em->getRepository('IbwJobeetBundle:Job')->getLatestPost();

        if($latestJob) {
            $lastUpdated = $latestJob->getCreatedAt()->format(DATE_ATOM);
        } else {
            $lastUpdated = new \DateTime();
            $lastUpdated = $lastUpdated->format(DATE_ATOM);
        }

        $format = $this->getRequest()->getRequestFormat();
        return $this->render('IbwJobeetBundle:Job:index.'.$format.'.twig', array(
               'categories' => $categories,
               'lastUpdated' => $lastUpdated,
               'feedId' => sha1($this->get('router')->generate('ibw_job', array('_format'=> 'atom'), true)),
        ));
// ...

为了得到最新发布信息的日期，我们需要在JobRepository类中添加getLatestPost()方法：

// src/Ibw/JobeetBundle/Repository/JobRepository.php
// ...

    public function getLatestPost($category_id = null)
    {
        $query = $this->createQueryBuilder('j')
            ->where('j.expires_at > :date')
            ->setParameter('date', date('Y-m-d H:i:s', time()))
            ->andWhere('j.is_activated = :activated')
            ->setParameter('activated', 1)
            ->orderBy('j.expires_at', 'DESC')
            ->setMaxResults(1);

        if($category_id) {
            $query->andWhere('j.category = :category_id')
                ->setParameter('category_id', $category_id);
        }

        try{
            $job = $query->getQuery()->getSingleResult();
        } catch(\Doctrine\Orm\NoResultException $e){
            $job = null;
        }

        return $job;    
    }
// ...

订阅中的entity可以通过下面的代码生成：


{% for category in categories %}
    {% for entity in category.activejobs %}
        
            {{ entity.position }} ({{ entity.location }})
            
            {{ entity.id }}
            {{ entity.createdAt.format(constant('DATE_ATOM')) }}
            
                
                    {% if entity.logo %}
                        
                            
                                
                            
                        
                    {% endif %}
                    
                        {{ entity.description|nl2br }}
                    
                    How to apply?
                    {{ entity.howtoapply }}
                
            
            {{ entity.company }}
        
    {% endfor %}
{% endfor %}

订阅分类中最新的Job信息

Jobeet的目标之一就是帮助人们找到期望的工作，所以我们需要提供不同类型的Job信息订阅。

首先我们来更新模板中分类订阅的链接：



    Feed



    Feed

修改CategoryController::showAction()方法渲染适当的模板：

// src/Ibw/JobeetBundle/Controller/CategoryController.php
// ...
    public function showAction($slug, $page)
    {
        $em = $this->getDoctrine()->getManager();

        $category = $em->getRepository('IbwJobeetBundle:Category')->findOneBySlug($slug);

        if (!$category) {
            throw $this->createNotFoundException('Unable to find Category entity.');
        }

        $latestJob = $em->getRepository('IbwJobeetBundle:Job')->getLatestPost($category->getId());

        if($latestJob) {
            $lastUpdated = $latestJob->getCreatedAt()->format(DATE_ATOM); 
        } else {
            $lastUpdated = new \DateTime();
            $lastUpdated = $lastUpdated->format(DATE_ATOM);
        }

        $total_jobs = $em->getRepository('IbwJobeetBundle:Job')->countActiveJobs($category->getId());
        $jobs_per_page = $this->container->getParameter('max_jobs_on_category');
        $last_page = ceil($total_jobs / $jobs_per_page);
        $previous_page = $page > 1 ? $page - 1 : 1;
        $next_page = $page < $last_page ? $page + 1 : $last_page; 
        $category->setActiveJobs($em->getRepository('IbwJobeetBundle:Job')->getActiveJobs($category->getId(), $jobs_per_page, ($page - 1) * $jobs_per_page));

        $format = $this->getRequest()->getRequestFormat();

        return $this->render('IbwJobeetBundle:Category:show.' . $format . '.twig', array(
            'category' => $category,
            'last_page' => $last_page,
            'previous_page' => $previous_page,
            'current_page' => $page,
            'next_page' => $next_page,
            'total_jobs' => $total_jobs,
            'feedId' => sha1($this->get('router')->generate('IbwJobeetBundle_category', array('slug' => $category->getSlug(), 'format' => 'atom'), true)),
            'lastUpdated' => $lastUpdated    
        ));
    }

最后，我们创建show.atom.twig模板：




    Jobeet ({{ category.name }})
    Latest Jobs
    
    {{ lastUpdated }}
    Jobeet
    {{ feedId }}

    {% for entity in category.activejobs %}
        
            {{ entity.position }} ({{ entity.location }})
            
            {{ entity.id }}
            {{ entity.createdAt.format(constant('DATE_ATOM')) }}
            
                
                    {% if entity.logo %}
                        
                            
                                
                            
                        
                    {% endif %}
                    
                        {{ entity.description|nl2br }}
                    
                    How to apply?
                    {{ entity.howtoapply }}
                
            
            {{ entity.company }}
        
    {% endfor %}

原文链接：http://www.intelligentbee.com/blog/2013/08/20/symfony2-jobeet-day-14-feeds/

jobeet第十四天:订阅，首发于Symfony中文教程。

jobeet第十三天:安全

napoleon — Fri, 27 Mar 2015 08:19:28 +0000

*这一系列文章来源于Fabien Potencier，基于Symfony1.4编写的Jobeet Tutirual。

实现程序的安全性

应用程序的安全性是一个两步验证的过程，它的目标是阻止用户访问他/她不应该访问到的资源。实现安全性的第一步是认证（authentication），安全认证系统会取得用户提交的一些标识符，然后通过这个标识符分辨出用户的身份。一旦系统分辨出用户的身份之后，下一步就是系统对用户进行授权（authorization）操作，这一步将决定用户能够访问哪些给定的资源（系统会检查用户是否有权限进行这个操作）。我们可以通过配置app/config目录下的security.yml文件来对应用程序的安全组件进行配置。为了实现我们应用的安全性，我们修改scurity.yml文件：

# app/config/security.yml
security:
    role_hierarchy:
        ROLE_ADMIN:       ROLE_USER
        ROLE_SUPER_ADMIN: [ROLE_USER, ROLE_ADMIN, ROLE_ALLOWED_TO_SWITCH]

    firewalls:
        dev:
            pattern:  ^/(_(profiler|wdt)|css|images|js)/
            security: false

        secured_area:
            pattern:    ^/
            anonymous: ~
            form_login:
                login_path:  /login
                check_path:  /login_check
                default_target_path: ibw_jobeet_homepage

    access_control:
        - { path: ^/admin, roles: ROLE_ADMIN }

    providers:
        in_memory:
            memory:
                users:
                    admin: { password: adminpass, roles: 'ROLE_ADMIN' }

    encoders:
        Symfony\Component\Security\Core\User\User: plaintext

上面的配置会对网站的/admin部分（所有以/admin作为开头的url）进行安全性保护，并且只有ROLE_ADMIN角色的用户才能访问到/admin（可以查看security.yml中的access_controller部分）。在这个例子中，admin用户被定义在security.yml中（providers部分），而且admin用户的密码没有被编码（即没有经过加密算法处理过）（encoders部分）。对于用户认证，我们需要使用一个传统的登录表单，我们需要去实现它。首先我们需要创建两个路由：一个用来显示登录表单（例如：/login），另一个则用来处理提的交登录表单（例如：/login_check）：

# src/Ibw/JobeetBundle/Resources/config/routing.yml
login:
    pattern:   /login
    defaults:  { _controller: IbwJobeetBundle:Default:login }
login_check:
    pattern:   /login_check

# ...

我们不需要为/login_check URL实现一个控制器，因为防火墙（firewall）会自动捕捉并处理所有提交到/login_check URL的表单。我们需要做的就是创建一个路由（/login_check），我们会在登录表单的模板中使用它，这样才能把登录表单提交到/login_check。

下一步我们来创建显示登录表单的action：

// src/Ibw/JobeetBundle/Controller/DefaultController.php
namespace Ibw\JobeetBundle\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\Security\Core\SecurityContext;

class DefaultController extends Controller
{
    // ...

    public function loginAction()
    {
        $request = $this->getRequest();
        $session = $request->getSession();

        // get the login error if there is one
        if ($request->attributes->has(SecurityContext::AUTHENTICATION_ERROR)) {
            $error = $request->attributes->get(SecurityContext::AUTHENTICATION_ERROR);
        } else {
            $error = $session->get(SecurityContext::AUTHENTICATION_ERROR);
            $session->remove(SecurityContext::AUTHENTICATION_ERROR);
        }

        return $this->render('IbwJobeetBundle:Default:login.html.twig', array(
            // last username entered by the user
            'last_username' => $session->get(SecurityContext::LAST_USERNAME),
            'error'         => $error,
        ));
    }
}

当用户提交了表单，安全系统会自动处理提交的表单。如果用户提交了一个无效的用户名或者密码，那么这个操作就会从系统中读取出提交表单的错误信息，并把这个错误信息反馈给用户。我们的工作仅仅只有显示出一个登录表单和可能出现的登录错误信息，而安全系统则会对用户提交上来的用户名和密码进行验证。

最后，我们来创建模板：


{% if error %}
    {{ error.message }}
{% endif %}


    Username:
    

    Password:

现在，如果我们去访问http://jobeet.local/app_dev.php/admin/dashboard URL，我们会看到一个登录表单，我们需要输入定义在security.yml中的用户名和密码（admin/adminpass）才能进入admin部分。

User Providers

在认证过程中，用户提交了一组登录凭证（通常是用户名和密码）。认证系统的工作就是在用户数据列表中逐个匹配登录凭证。那么用户数据列表从何而来呢？

在Symfony2中，用户数据列表可以存放在任何地方，一个配置文件，一个数据库表，一个web service接口，或者是其它你能想象得到的地方。为认证系统提供一个或者多个用户的类或接口就叫做“user provider”。Symfony2 自带了两种最常见的user provider：一种是使用配置文件，另一种是使用数据库表。

在上面的例子中，我们把用户列表存放在配置文件里：

# app/config/security.yml
# ...

providers:
    in_memory:
        memory:
            users:
                admin: { password: adminpass, roles: 'ROLE_ADMIN' }

# ...

但我们更多时候是需要把用户信息存放在数据表中。为了做到这点，我们需要在数据库中创建一个user表。首先我们来为user表创建orm文件：

# src/Ibw/JobeetBundle/Resources/config/doctrine/User.orm.yml
Ibw\JobeetBundle\Entity\User:
    type: entity
    table: user
    id:
        id:
            type: integer
            generator: { strategy: AUTO }
    fields:
        username:
            type: string
            length: 255
        password:
            type: string
            length: 255

现在运行命令生成User实体类：

php app/console doctrine:generate:entities IbwJobeetBundle

然后更新数据库：

php app/console doctrine:schema:update --force

这里需要为用户类（User）实现UserInterface接口，这就意味着“用户”可是任何的东西，只要它实现了UserInterface接口。打开并修改User.php：

// src/Ibw/JobeetBundle/Entity/User.php
namespace Ibw\JobeetBundle\Entity;

use Symfony\Component\Security\Core\User\UserInterface;
use Doctrine\ORM\Mapping as ORM;

/**
 * User
 */
class User implements UserInterface
{
    /**
     * @var integer
     */
    private $id;

    /**
     * @var string
     */
    private $username;

    /**
     * @var string
     */
    private $password;

    /**
     * Get id
     *
     * @return integer 
     */
    public function getId()
    {
        return $this->id;
    }

    /**
     * Set username
     *
     * @param string $username
     * @return User
     */
    public function setUsername($username)
    {
        $this->username = $username;

    }

    /**
     * Get username
     *
     * @return string 
     */
    public function getUsername()
    {
        return $this->username;
    }

    /**
     * Set password
     *
     * @param string $password
     * @return User
     */
    public function setPassword($password)
    {
        $this->password = $password;

    }

    /**
     * Get password
     *
     * @return string 
     */
    public function getPassword()
    {
        return $this->password;
    }

    public function getRoles()
    {
        return array('ROLE_ADMIN');
    }

    public function getSalt()
    {
        return null;
    }

    public function eraseCredentials()
    {

    }

    public function equals(User $user)
    {
        return $user->getUsername() == $this->getUsername();
    }        
}

我们需要为User类实现UserInterface接口的抽象方法：getRoles，getSalt，eraseCredentials和equals。

接下来配置一个user provider实体，它指向User类：

# app/config/security.yml
...

    providers:
        main:
            entity: { class: Ibw\JobeetBundle\Entity\User, property: username }

    encoders:
        Ibw\JobeetBundle\Entity\User: sha512

我们同样改变了encoder部分，这样就能够使用sha512算法对User类的password属性进行加密了。

所有准备都已经做好了，现在我们需要先创建一个用户。为了做到这点，我们会创建一个新的Symfony命令：

// src/Ibw/JobeetBundle/Command/JobeetUsersCommand.php
namespace Ibw\JobeetBundle\Command;

use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Ibw\JobeetBundle\Entity\User;

class JobeetUsersCommand extends ContainerAwareCommand
{
    protected function configure()
    {
        $this
            ->setName('ibw:jobeet:users')
            ->setDescription('Add Jobeet users')
            ->addArgument('username', InputArgument::REQUIRED, 'The username')
            ->addArgument('password', InputArgument::REQUIRED, 'The password')
        ;
    }

    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $username = $input->getArgument('username');
        $password = $input->getArgument('password');

        $em = $this->getContainer()->get('doctrine')->getManager();

        $user = new User();
        $user->setUsername($username);
        // encode the password
        $factory = $this->getContainer()->get('security.encoder_factory');
        $encoder = $factory->getEncoder($user);
        $encodedPassword = $encoder->encodePassword($password, $user->getSalt());
        $user->setPassword($encodedPassword);
        $em->persist($user);
        $em->flush();

        $output->writeln(sprintf('Added %s user with password %s', $username, $password));
    }
}

使用命令创建第一个用户：

php app/console ibw:jobeet:users admin admin

上面的命令会创建一个用户名和密码都是“admin”的用户。你可以使用它登录并访问到admin部分。

登出（Logout）

防火墙（firewall）能够自动处理登出。我们需要做的就是激活logout配置参数：

# app/config/security.yml
security:
    firewalls:
        # ...
        secured_area:
            # ...
            logout:
                path:   /logout
                target: /
    # ...

我们不需要为/logout URL实现控制器，防火墙（firewall）会自行处理。我们来创建/logout路由：

# src/Ibw/JobeetBundle/Resources/config/routing.yml
# ...

logout:
    pattern:   /logout

# ...

一旦配置完成了，访问/logout后，当前用户就会被注销认证（un-authenticate）了。然后用户会被重定向到首页（这个值定义在target参数中）。

剩下没有做的事情就是为admin部分添加logout链接。我们会重载SonataAdminBundle的user_block.html.twig。在app/Resources/SonataAdminBundle/views/Core目录下创建user_block.html.twig文件：


{% block user_block %}Logout{% endblock%}

现在，当我们访问admin部分（请先清除缓存）时，我们会被要求填写用户名和密码，进入之后我们可以在右上角看到一个logout链接。

用户Session

Symfony2提供了一个非常好用的session对象，用户的每个不同请求都可以访问到它里面保存的信息。Symfony2默认是使用原生的PHP session把信息保存到一个cookie中。

我们可以在控制器中方便地取出session里保存的信息：

$session = $this->getRequest()->getSession();

// store an attribute for reuse during a later user request
$session->set('foo', 'bar');

// in another controller for another request
$foo = $session->get('foo');

可惜的是，在我们Jobeet的用户stories中（第二天的内容），并没有需要在用户session中保存信息的需求。所以我们来改改需求：为了方便Job信息的浏览，我们会在菜单栏上显示用户刚刚浏览过的三条Job信息的链接。

当用户访问一条Job页面时，那么这条Job信息对应的Job对象就会被添加到用户的浏览历史中，并且把它保存到session中：

// src/Ibw/JobeetBundle/Controller/JobController.php
// ...

public function showAction($id)
{
    $em = $this->getDoctrine()->getManager();

    $entity = $em->getRepository('IbwJobeetBundle:Job')->getActiveJob($id);

    if (!$entity) {
        throw $this->createNotFoundException('Unable to find Job entity.');
    }

    $session = $this->getRequest()->getSession();

    // fetch jobs already stored in the job history
    $jobs = $session->get('job_history', array());

    // store the job as an array so we can put it in the session and avoid entity serialize errors
    $job = array('id' => $entity->getId(), 'position' =>$entity->getPosition(), 'company' => $entity->getCompany(), 'companyslug' => $entity->getCompanySlug(), 'locationslug' => $entity->getLocationSlug(), 'positionslug' => $entity->getPositionSlug());

    if (!in_array($job, $jobs)) {
        // add the current job at the beginning of the array
        array_unshift($jobs, $job);

        // store the new job history back into the session
        $session->set('job_history', array_slice($jobs, 0, 3));
    }

    $deleteForm = $this->createDeleteForm($id);

    return $this->render('IbwJobeetBundle:Job:show.html.twig', array(
        'entity'      => $entity,
        'delete_form' => $deleteForm->createView(),
    ));
}

在layout文件的#content div标签之前添加下面的代码：





    Recent viewed jobs:
    
        {% for job in app.session.get('job_history') %}
            
                {{ job.position }} - {{ job.company }}
            
        {% endfor %}
    



    ...

flash信息

flash信息是存放在用户session中的简短信息（通常是用来作为反馈给用户的信息），它通常用在下一个请求中显示信息。它对表单很有用：当你想要重定向并请求一个新页面的同时，显示出一些指定的信息。我们已经在项目的发布Job信息的需求中使用过flash信息了：

// src/Ibw/JobeetBundle/Controller/JobController.php
// ...

public function publishAction($token)
{
    // ...

    $this->get('session')->getFlashBag()->add('notice', 'Your job is now online for 30 days.');

    // ...
}

getFlashBag()->add()函数的第一个参数是用来标志flash的键，第二个参数是需要显示的信息。我们可以为flash定义任何键名，但notic和error是最常用的两个。

为了显示flash信息，我们需要在模板中把它们包含进来。我们已经在layout.html.twig中做过了：




{% for flashMessage in app.session.flashbag.get('notice') %}
    
        {{ flassMessage }}
    
{% endfor %}

原文链接：http://www.intelligentbee.com/blog/2013/08/19/symfony2-jobeet-day-13-security/

jobeet第十三天:安全，首发于Symfony中文教程。

jobeet第十二天:后台管理工具包-Sonata Admin

napoleon — Fri, 27 Mar 2015 08:07:51 +0000

*这一系列文章来源于Fabien Potencier，基于Symfony1.4编写的Jobeet Tutirual。

在第十一天中，我们给Jobeet添加了一些测试，这个应用程序已经完全能够被求职者（seekers）和职位发布者（posters）使用了。现在是时候考虑我们应用程序的admin部分了。今天还好有Sonata Admin Bundle的帮助，我们会使用它开发出一个完整Jobeet后台管理接口，（这个过程）用不到一个小时。

安装Sonata Admin Bundle

下载SonataAdminBundle和它的依赖到vendor目录下：

php composer.phar require sonata-project/admin-bundle

为了安装最新版本的SonataAdminBundle和依赖，这个使用*作为输入。

ibw@ubuntu:/var/www/jobeet$ php composer.phar require sonata-project/admin-bundle
Please provide a version constraint for the sonata-project/admin-bundle requirement: *

我们同样需要安装SonataDoctrineORMADminBundle：

php composer.phar require sonata-project/doctrine-orm-admin-bundle

现在我们需要声明新的bundle和依赖，修改AppKernel.php文件，添加下面代码到文件中：

// app/AppKernel.php
// ...
public function registerBundles()
{
    $bundles = array(
        // ...
        new Sonata\AdminBundle\SonataAdminBundle(),
        new Sonata\BlockBundle\SonataBlockBundle(),
        new Sonata\jQueryBundle\SonatajQueryBundle(),
        new Sonata\DoctrineORMAdminBundle\SonataDoctrineORMAdminBundle(),
        new Knp\Bundle\MenuBundle\KnpMenuBundle(),
    );
}

// ...

修改config.yml，把下面代码添加到文件末尾：

# app/config/config.yml
# ...
sonata_admin:
    title: Jobeet Admin

sonata_block:
    default_contexts: [cms]
    blocks:
        sonata.admin.block.admin_list:
            contexts:   [admin]

        sonata.block.service.text:
        sonata.block.service.action:
        sonata.block.service.rss:

在config.yml中找到translator键。如果它被注释掉了，那么请不要注释它。

# app/config/config.yml
# ...
framework:
    # ...
    translator: { fallback: %locale%}
    # ...
#...

为了能让应用程序跑起来，我们需要导入（import）admin routes：

# app/config/routing.yml
admin:
    resource: '@SonataAdminBundle/Resources/config/routing/sonata_admin.xml'
    prefix: /admin

_sonata_admin:
    resource: .
    type: sonata_admin
    prefix: /admin

# ...

现在我们从bundle中安装资源：

php app/console assets:install web --symlink

别忘记把cache清除掉：

php app/console cache:clear --env=dev
php app/console cache:clear --env=prod

现在我们应该可以通过URL：http://jobeet.local/app_dev.php/admin/dashboard访问放到admin面板了。

以上的安装需要一步步进行，不然的话可能会报一些Bundle未找到的异常，还有就是目录必须是可写的。可能是SonataAdminBundle更新后的原因，如果在安装过程中遇到需要CoreBundle的问题，那么试着按照提示进行操作，但问题都不大。这里附上一个解决问题的链接：https://github.com/sonata-project/SonataAdminBundle/issues/1832

CRUD控制器

CRUD控制器包含了基础的CRUD操作。它是通过控制器名称映射到一个正确的Admin类的一个实例。我们可以按照项目的需求来重写任何或者所有的action。控制器使用Admin类来构造不同的操作。在控制器中可以通过configuration属性来访问Admin对象。

现在我们来为每个实体都创建一个控制器。首先是Category实体：

// src/Ibw/JobeetBundle/Controller/CategoryAdminController.php
namespace Ibw\JobeetBundle\Controller;

use Sonata\AdminBundle\Controller\CRUDController as Controller;

class CategoryAdminController extends Controller
{
    // Your code will be here
}

然后是Job实体：

// src/Ibw/JobeetBundle/Controller/JobAdminController.php
namespace Ibw\JobeetBundle\Controller;

use Sonata\AdminBundle\Controller\CRUDController as Controller;

class JobAdminController extends Controller
{
    // Your code will be here
}

创建Admin类

Admin类代表的是模型的映射和管理页面（表单，列表，页面显示（show））的部分。为模型创建Admin类的最简单方式是去继承Sonata\AdminBundle\Admin\Admin类。我们会在Admin文件夹中创建Admin类。我们先创建Admin目录，然后为Category创建Admin类：

// src/Ibw/JobeetBundle/Admin/CategoryAdmin.php
namespace Ibw\JobeetBundle\Admin;

use Sonata\AdminBundle\Admin\Admin;
use Sonata\AdminBundle\Datagrid\ListMapper;
use Sonata\AdminBundle\Datagrid\DatagridMapper;
use Sonata\AdminBundle\Validator\ErrorElement;
use Sonata\AdminBundle\Form\FormMapper;

class CategoryAdmin extends Admin
{
    // Your code will be here
}

// src/Ibw/JobeetBundle/Admin/JobAdmin.php
namespace Ibw\JobeetBundle\Admin;

use Sonata\AdminBundle\Admin\Admin;
use Sonata\AdminBundle\Datagrid\ListMapper;
use Sonata\AdminBundle\Datagrid\DatagridMapper;
use Sonata\AdminBundle\Validator\ErrorElement;
use Sonata\AdminBundle\Form\FormMapper;
use Sonata\AdminBundle\Show\ShowMapper;
use Ibw\JobeetBundle\Entity\Job;

class JobAdmin extends Admin
{
    // Your code will be here
}

现在我们需要把每个admin类添加到services.yml配置文件中：

# src/Ibw/JobeetBundle/Resources/config/services.yml
services:
    ibw.jobeet.admin.category:
        class: Ibw\JobeetBundle\Admin\CategoryAdmin
        tags:
            - { name: sonata.admin, manager_type: orm, group: jobeet, label: Categories }
        arguments:
            - ~
            - Ibw\JobeetBundle\Entity\Category
            - 'IbwJobeetBundle:CategoryAdmin'

    ibw.jobeet.admin.job:
        class: Ibw\JobeetBundle\Admin\JobAdmin
        tags:
            - { name: sonata.admin, manager_type: orm, group: jobeet, label: Jobs }
        arguments:
            - ~
            - Ibw\JobeetBundle\Entity\Job
            - 'IbwJobeetBundle:JobAdmin'

现在我们可以在管理面板页看到Jobeet分组了，还有Job和Category模块（modules），它们都有各自的Add new和List链接。

配置Admin类

如果我们去点击Add new或者List链接，我们什么都看不到。那是因为我们还没有为list和form配置字段。我们来做个基础的配置，先从Category开始：

// src/Ibw/JobeetBundle/Admin/CategoryAdmin.php
namespace Ibw\JobeetBundle\Admin;

use Sonata\AdminBundle\Admin\Admin;
use Sonata\AdminBundle\Datagrid\ListMapper;
use Sonata\AdminBundle\Datagrid\DatagridMapper;
use Sonata\AdminBundle\Validator\ErrorElement;
use Sonata\AdminBundle\Form\FormMapper;

class CategoryAdmin extends Admin
{
    // setup the default sort column and order
    protected $datagridValues = array(
        '_sort_order' => 'ASC',
        '_sort_by' => 'name'
    );

    protected function configureFormFields(FormMapper $formMapper)
    {
        $formMapper
            ->add('name')
            ->add('slug')
        ;
    }

    protected function configureDatagridFilters(DatagridMapper $datagridMapper)
    {
        $datagridMapper
            ->add('name')
        ;
    }

    protected function configureListFields(ListMapper $listMapper)
    {
        $listMapper
            ->addIdentifier('name')
            ->add('slug')
        ;
    }
}

现在是Job：

// src/Ibw/JobeetBundle/Admin/JobAdmin.php
namespace Ibw\JobeetBundle\Admin;

use Sonata\AdminBundle\Admin\Admin;
use Sonata\AdminBundle\Datagrid\ListMapper;
use Sonata\AdminBundle\Datagrid\DatagridMapper;
use Sonata\AdminBundle\Validator\ErrorElement;
use Sonata\AdminBundle\Form\FormMapper;
use Sonata\AdminBundle\Show\ShowMapper;
use Ibw\JobeetBundle\Entity\Job;

class JobAdmin extends Admin
{
    // setup the defaut sort column and order
    protected $datagridValues = array(
        '_sort_order' => 'DESC',
        '_sort_by' => 'created_at'
    );

    protected function configureFormFields(FormMapper $formMapper)
    {
        $formMapper
            ->add('category')
            ->add('type', 'choice', array('choices' => Job::getTypes(), 'expanded' => true))
            ->add('company')
            ->add('file', 'file', array('label' => 'Company logo', 'required' => false))
            ->add('url')
            ->add('position')
            ->add('location')
            ->add('description')
            ->add('how_to_apply')
            ->add('is_public')
            ->add('email')
            ->add('is_activated')
        ;
    }

    protected function configureDatagridFilters(DatagridMapper $datagridMapper)
    {
        $datagridMapper
            ->add('category')
            ->add('company')
            ->add('position')
            ->add('description')
            ->add('is_activated')
            ->add('is_public')
            ->add('email')
            ->add('expires_at')
        ;
    }

    protected function configureListFields(ListMapper $listMapper)
    {
        $listMapper
            ->addIdentifier('company')
            ->add('position')
            ->add('location')
            ->add('url')
            ->add('is_activated')
            ->add('email')
            ->add('category')
            ->add('expires_at')
            ->add('_action', 'actions', array(
                'actions' => array(
                    'view' => array(),
                    'edit' => array(),
                    'delete' => array(),
                )
            ))
        ;
    }

    protected function configureShowField(ShowMapper $showMapper)
    {
        $showMapper
            ->add('category')
            ->add('type')
            ->add('company')
            ->add('webPath', 'string', array('template' => 'IbwJobeetBundle:JobAdmin:list_image.html.twig'))
            ->add('url')
            ->add('position')
            ->add('location')
            ->add('description')
            ->add('how_to_apply')
            ->add('is_public')
            ->add('is_activated')
            ->add('token')
            ->add('email')
            ->add('expires_at')
        ;
    }
}

对于show操作，我们使用自定义的模板来显示公司的logo属性：



    Logo

通过上面的操作，我们为Job和Category创建了基础的管理模块。我们可以发现它们有以下功能：

列表分页显示
列表可以排序
列表可以过滤
可以创建，编辑，删除对象
可以批量选择对象并进行删除
拥有表单验证
快速反馈给用户的flash信息提示

批量操作（Batch Actions）

批量操作是对一个被选择的模型对象集合（所有的对象或者只是它们中的一个子集）进行的操作。我们能够方便地为列表页面添加自定义的批量操作。delete操作默认就允许我们一次删除多个实体。

为了添加新的批量操作，我们需要重写Admin类的getBatchActions()方法。我们来添加一个批量处理extend的操作：

// src/Ibw/JobeetBundle/Admin/JobAdmin.php
// ...

public function getBatchActions()
{
    // retrieve the default (currently only the delete action) actions
    $actions = parent::getBatchActions();

    // check user permissions
    if($this->hasRoute('edit') && $this->isGranted('EDIT') && $this->hasRoute('delete') && $this->isGranted('DELETE')) {
        $actions['extend'] = array(
            'label'            => 'Extend',
            'ask_confirmation' => true // If true, a confirmation will be asked before performing the action
        );

    }

    return $actions;
}

extend批量操作的核心逻辑在JobAdminController::batchActionExtend()方法中。batchActionExtend()方法有一个查询参数，通过这个查询参数我们可以检索出被选择的模型对象。如果出于某种原因，你可能不需要通过默认的选择方法（selection method）来进行批量操作（例如，你可以选择在模板级别上进行细粒度的模型选择），那么可以传递一个值为null的查询参数。

// src/Ibw/JobeetBundle/Controller/JobAdminController.php
namespace Ibw\JobeetBundle\Controller;

use Sonata\AdminBundle\Controller\CRUDController as Controller;
use Sonata\DoctrineORMAdminBundle\Datagrid\ProxyQuery as ProxyQueryInterface;
use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\Security\Core\Exception\AccessDeniedException;

class JobAdminController extends Controller
{
    public function batchActionExtend(ProxyQueryInterface $selectedModelQuery)
    {
        if ($this->admin->isGranted('EDIT') === false || $this->admin->isGranted('DELETE') === false) {
            throw new AccessDeniedException();
        }

        $modelManager = $this->admin->getModelManager();

        $selectedModels = $selectedModelQuery->execute();

        try {
            foreach ($selectedModels as $selectedModel) {
                $selectedModel->extend();
                $modelManager->update($selectedModel);
            }
        } catch (\Exception $e) {
            $this->get('session')->getFlashBag()->add('sonata_flash_error', $e->getMessage());

            return new RedirectResponse($this->admin->generateUrl('list',$this->admin->getFilterParameters()));
        }

        $this->get('session')->getFlashBag()->add('sonata_flash_success',  sprintf('The selected jobs validity has been extended until %s.', date('m/d/Y', time() + 86400 * 30)));

        return new RedirectResponse($this->admin->generateUrl('list',$this->admin->getFilterParameters()));
    }
}

我们再来添加一个批量删除所有在60天内仍未被激活的Job数据的操作。对于这个操作，我们不需要在列表中选择任何的Job数据，因为在这个操作的逻辑中会去检索符合条件的记录并删除它们。

//src/Ibw/JobeetBundle/Admin/JobAdmin.php
// ...

public function getBatchActions()
{
    // retrieve the default (currently only the delete action) actions
    $actions = parent::getBatchActions();

    // check user permissions
    if($this->hasRoute('edit') && $this->isGranted('EDIT') && $this->hasRoute('delete') && $this->isGranted('DELETE')){
        $actions['extend'] = array(
            'label'            => 'Extend',
            'ask_confirmation' => true // If true, a confirmation will be asked before performing the action
        );

        $actions['deleteNeverActivated'] = array(
            'label'            => 'Delete never activated jobs',
            'ask_confirmation' => true // If true, a confirmation will be asked before performing the action
        );
    }

    return $actions;
}

除了创建batchActionDeleteNeverActivated操作外，我们还会创建一个JobAdminController:: batchActionDeleteNeverActivatedIsRelevant()方法，这个方法需要得到确认之后才能够执行，以确保用户真的是要进行这个操作（在我们的这个例子中它总是返回true，因为选择需要被删除的Job数据的逻辑在JobRepository::cleanup()方法中）。

// src/Ibw/JobeetBundle/Controller/JobAdminController.php
// ...

public function batchActionDeleteNeverActivatedIsRelevant()
{
    return true;
}

public function batchActionDeleteNeverActivated()
{
    if ($this->admin->isGranted('EDIT') === false || $this->admin->isGranted('DELETE') === false) {
        throw new AccessDeniedException();
    }

    $em = $this->getDoctrine()->getManager();
    $nb = $em->getRepository('IbwJobeetBundle:Job')->cleanup(60);

    if ($nb) {
        $this->get('session')->getFlashBag()->add('sonata_flash_success',  sprintf('%d never activated jobs have been deleted successfully.', $nb));
    } else {
        $this->get('session')->getFlashBag()->add('sonata_flash_info',  'No job to delete.');
    }

    return new RedirectResponse($this->admin->generateUrl('list',$this->admin->getFilterParameters()));
}

今天我们就先到这了！明天我们来看看怎么样为管理员部分添加用户名（username）和密码（password），同时也会讨论Symfony的安全机制。

原文链接：http://www.intelligentbee.com/blog/2013/08/18/symfony2-jobeet-day-12-sonata-admin-bundle/

jobeet第十二天:后台管理工具包-Sonata Admin，首发于Symfony中文教程。

jobeet第十一天:表单测试

napoleon — Fri, 27 Mar 2015 07:42:15 +0000

*这一系列文章来源于Fabien Potencier，基于Symfony1.4编写的Jobeet Tutirual。

在第十天的内容中，我们使用Symfony 2.3创建了我们的第一个表单。现在用户能够在Jobeet上发布Job信息了，但是我们还没来得及给它做测试呢。别担心，我们会沿着这种（边开发边测试的）开发模式进行下去的。

提交表单

打开JobControllerTest.php，为Job信息的创建和表单验证添加功能测试。我们在文件末尾加入下面的代码，测试是否能够正确访问到创建Job的页面：

// src/Ibw/JobeetBundle/Tests/Controller/JobControllerTest.php
// ...

public function testJobForm()
{
    $client = static::createClient();

    $crawler = $client->request('GET', '/job/new');
    $this->assertEquals('Ibw\JobeetBundle\Controller\JobController::newAction', $client->getRequest()->attributes->get('_controller'));
}

为了让功能测试能够模拟点击按钮来提交表单，我们会使用selectButton()方法。这个方法能够选择button标签和submit类型的input标签。只要你有一个表示button的Crawler，你就可以调用form()方法得到包含这个button结点的表单的Form实例。

$form = $crawler->selectButton('Submit Form')->form();

上面的例子中选择了属性值为Submit Form的submit类型的input标签。

我们可以在调用form()方法的时候给它传递一个数组类型的参数来重载默认的调用：

$form = $crawler->selectButton('submit')->form(array(
    'name' => 'Fabien',
    'my_form[subject]' => 'Symfony Rocks!'
));

现在我们来实际操作一下选择表单和传递参数的过程：

// src/Ibw/JobeetBundle/Tests/Controller/JobControllerTest.php
// ...

public function testJobForm()
{
    $client = static::createClient();

    $crawler = $client->request('GET', '/job/new');
    $this->assertEquals('Ibw\JobeetBundle\Controller\JobController::newAction', $client->getRequest()->attributes->get('_controller'));

    $form = $crawler->selectButton('Preview your job')->form(array(
        'job[company]'      => 'Sensio Labs',
        'job[url]'          => 'http://www.sensio.com/',
        'job[file]'         => __DIR__.'/../../../../../web/bundles/ibwjobeet/images/sensio-labs.gif',
        'job[position]'     => 'Developer',
        'job[location]'     => 'Atlanta, USA',
        'job[description]'  => 'You will work with symfony to develop websites for our customers.',
        'job[how_to_apply]' => 'Send me an email',
        'job[email]'        => 'for.a.job@example.com',
        'job[is_public]'    => false,
    ));

    $client->submit($form);
    $this->assertEquals('Ibw\JobeetBundle\Controller\JobController::createAction', $client->getRequest()->attributes->get('_controller'));
}

我们也可以模拟浏览器中的文件上传，我们只要把上传文件的绝对路径传递给它就行了。

表单提交之后，我们需要测试处理提交表单的action是否为create。

测试表单

如果表单的值是有效的，那么Job信息应该就可以创建成功，然后用户会被重定向到preview页面：

// src/Ibw/JobeetBundle/Tests/Controller/JobControllerTest.php
public function testJobForm()
{
    // ...
    $client->followRedirect();
    $this->assertEquals('Ibw\JobeetBundle\Controller\JobController::previewAction', $client->getRequest()->attributes->get('_controller'));
}

测试数据库记录

最后，我们需要测试数据库中是否有刚才创建的Job数据，还需要测试当用户未公布Job信息时is_activated列是否被设置成false：

// src/Ibw/JobeetBundle/Tests/Controller/JobControllerTest.php
public function testJobForm()
{
    // ...
    $kernel = static::createKernel();
    $kernel->boot();
    $em = $kernel->getContainer()->get('doctrine.orm.entity_manager');

    $query = $em->createQuery('SELECT count(j.id) from IbwJobeetBundle:Job j WHERE j.location = :location AND j.is_activated IS NULL AND j.is_public = 0');
    $query->setParameter('location', 'Atlanta, USA');
    $this->assertTrue(0 < $query->getSingleScalarResult());
}

测试错误的表单

正确的Job表单信息提交后的结果和我们预期的结果一样。现在我们来为错误的Job信息表单做测试：

// src/Ibw/JobeetBundle/Tests/Controller/JobControllerTest.php
public function testJobForm()
{
    // ...
    $crawler = $client->request('GET', '/job/new');
    $form = $crawler->selectButton('Preview your job')->form(array(
        'job[company]'      => 'Sensio Labs',
        'job[position]'     => 'Developer',
        'job[location]'     => 'Atlanta, USA',
        'job[email]'        => 'not.an.email',
    ));
    $crawler = $client->submit($form);

    // check if we have 3 errors
    $this->assertTrue($crawler->filter('.error_list')->count() == 3);

    // check if we have error on job_description field
    $this->assertTrue($crawler->filter('#job_description')->siblings()->first()->filter('.error_list')->count() == 1);

    // check if we have error on job_how_to_apply field
    $this->assertTrue($crawler->filter('#job_how_to_apply')->siblings()->first()->filter('.error_list')->count() == 1);

    // check if we have error on job_email field
    $this->assertTrue($crawler->filter('#job_email')->siblings()->first()->filter('.error_list')->count() == 1);
}

现在我们来测试preview页面中的admin栏。当一条Job信息还未被激活时，我们可以对它进行edit，delete或者publish操作。为了测试这三个action，我们首先需要创建一条Job信息。为了避免过多的复制和粘贴，我们给JobControllerTest类添加一个createJob()的方法：

// src/Ibw/JobeetBundle/Tests/Controller/JobControllerTest.php
// ...

public function createJob($values = array())
{
    $client = static::createClient();
    $crawler = $client->request('GET', '/job/new');
    $form = $crawler->selectButton('Preview your job')->form(array_merge(array(
        'job[company]'      => 'Sensio Labs',
        'job[url]'          => 'http://www.sensio.com/',
        'job[position]'     => 'Developer',
        'job[location]'     => 'Atlanta, USA',
        'job[description]'  => 'You will work with symfony to develop websites for our customers.',
        'job[how_to_apply]' => 'Send me an email',
        'job[email]'        => 'for.a.job@example.com',
        'job[is_public]'    => false,
  ), $values));

    $client->submit($form);
    $client->followRedirect();

    return $client;
}

createJob()方法创建一个Job对象，然后进行页面跳转（转到preview页面）。我们可以给createJob()方法传递一个数组，这个数组的值会覆盖默认的表单值。测试Public现在就变得很简单了：

// src/Ibw/JobeetBundle/Tests/Controller/JobControllerTest.php
public function testPublishJob()
{
    $client = $this->createJob(array('job[position]' => 'FOO1'));
    $crawler = $client->getCrawler();
    $form = $crawler->selectButton('Publish')->form();
    $client->submit($form);

    $kernel = static::createKernel();
    $kernel->boot();
    $em = $kernel->getContainer()->get('doctrine.orm.entity_manager');

    $query = $em->createQuery('SELECT count(j.id) from IbwJobeetBundle:Job j WHERE j.position = :position AND j.is_activated = 1');
    $query->setParameter('position', 'FOO1');
    $this->assertTrue(0 < $query->getSingleScalarResult());
}

测试Delete操作也很类似：

// src/Ibw/JobeetBundle/Tests/Controller/JobControllerTest.php
// ...

public function testDeleteJob()
{
    $client = $this->createJob(array('job[position]' => 'FOO2'));
    $crawler = $client->getCrawler();
    $form = $crawler->selectButton('Delete')->form();
    $client->submit($form);

    $kernel = static::createKernel();
    $kernel->boot();
    $em = $kernel->getContainer()->get('doctrine.orm.entity_manager');

    $query = $em->createQuery('SELECT count(j.id) from IbwJobeetBundle:Job j WHERE j.position = :position');
    $query->setParameter('position', 'FOO2');
    $this->assertTrue(0 == $query->getSingleScalarResult());
}

用测试作保障

当一条Job信息被发布之后就不能再对它进行编辑了，尽管Edit链接已经不在preview页面中显示出来。我们来给它做个测试吧。

首先我们为createJob()方法添加另外一个参数，让createJob()方法能够自动发布Job信息。我们来添加一个getJobByPosition()方法，它能够按指定的position返回Job数据：

// src/Ibw/JobeetBundle/Tests/Controller/JobControllerTest.php
// ...

public function createJob($values = array(), $publish = false)
{
    $client = static::createClient();
    $crawler = $client->request('GET', '/job/new');
    $form = $crawler->selectButton('Preview your job')->form(array_merge(array(
        'job[company]'      => 'Sensio Labs',
        'job[url]'          => 'http://www.sensio.com/',
        'job[position]'     => 'Developer',
        'job[location]'     => 'Atlanta, USA',
        'job[description]'  => 'You will work with symfony to develop websites for our customers.',
        'job[how_to_apply]' => 'Send me an email',
        'job[email]'        => 'for.a.job@example.com',
        'job[is_public]'    => false,
  ), $values));

    $client->submit($form);
    $client->followRedirect();

    if($publish) {
      $crawler = $client->getCrawler();
      $form = $crawler->selectButton('Publish')->form();
      $client->submit($form);
      $client->followRedirect();
    }

  return $client;
}

public function getJobByPosition($position)
{
    $kernel = static::createKernel();
    $kernel->boot();
    $em = $kernel->getContainer()->get('doctrine.orm.entity_manager');

    $query = $em->createQuery('SELECT j from IbwJobeetBundle:Job j WHERE j.position = :position');
    $query->setParameter('position', $position);
    $query->setMaxResults(1);
    return $query->getSingleResult();
}

访问一个已发布Job信息的edit页面会返回404状态码：

// src/Ibw/JobeetBundle/Tests/Controller/JobControllerTest.php
// ...

public function testEditJob()
{
    $client = $this->createJob(array('job[position]' => 'FOO3'), true);
    $crawler = $client->getCrawler();
    $crawler = $client->request('GET', sprintf('/job/%s/edit', $this->getJobByPosition('FOO3')->getToken()));
    $this->assertTrue(404 === $client->getResponse()->getStatusCode());
}

如果你运行一下测试，你不会得到期望的结果，因为我们昨天忘了实现安全性。编写测试同样是一种发现Bug的好方法，就像你去考虑所有的测试边界值一样。

修改这个Bug很简单，我们只需为已激活的Job信息转向到404页面即可：

// src/Ibw/JobeetBundle/Controller/JobController.php
// ...

public function editAction($token)
{
    $em = $this->getDoctrine()->getManager();

    $entity = $em->getRepository('IbwJobeetBundle:Job')->findOneByToken($token);

    if (!$entity) {
        throw $this->createNotFoundException('Unable to find Job entity.');
    }

    if ($entity->getIsActivated()) {
        throw $this->createNotFoundException('Job is activated and cannot be edited.');
    }

  // ...
}

“穿越未来”的测试

当一条Job信息过期天数少于5天，或者Job信息已经过期了，用户能够从当前日期开始延期该条Job信息多30天。在浏览器中做这个测试并不容易，因为当一个Job信息被创建出来后需要30天才过期，所以当访问这个刚创建的Job信息页面时，延期链接是不存在的。当然，你也可以修改数据库中该Job数据的过期时间，或者是调整模板让延期链接一直都显示出来，但是这些方法都很乏味而且容易出错。你现在已经可能猜到了，编写测试能够帮助我们解决问题。

一如既往，我们需要先为extend方法添加新路由：

# src/Ibw/JobeetBundle/Resources/config/routing/Job.yml
# ...

ibw_job_extend:
    pattern:  /{token}/extend
    defaults: { _controller: "IbwJobeetBundle:Job:extend" }
    requirements: { _method: post }

然后修改admin.html.twig，用extend表单替换Extend链接：




{% if job.expiresSoon %}
    
        {{ form_widget(extend_form) }}
         for another 30 days
    
{% endif %}

然后再添加extendAction()方法和createExtendForm()方法：

// src/Ibw/JobeetBundle/Controller/JobController.php
// ...

public function extendAction(Request $request, $token)
{
    $form = $this->createExtendForm($token);
    $request = $this->getRequest();

    $form->bind($request);

    if($form->isValid()) {
        $em=$this->getDoctrine()->getManager();
        $entity = $em->getRepository('IbwJobeetBundle:Job')->findOneByToken($token);

        if(!$entity){
            throw $this->createNotFoundException('Unable to find Job entity.');
        }

        if(!$entity->extend()){
            throw $this->createNodFoundException('Unable to extend the Job');
        }

        $em->persist($entity);
        $em->flush();

        $this->get('session')->getFlashBag()->add('notice', sprintf('Your job validity has been extended until %s', $entity->getExpiresAt()->format('m/d/Y')));
    }

    return $this->redirect($this->generateUrl('ibw_job_preview', array(
        'company' => $entity->getCompanySlug(),
        'location' => $entity->getLocationSlug(),
        'token' => $entity->getToken(),
        'position' => $entity->getPositionSlug()
    )));
}

private function createExtendForm($token)
{
    return $this->createFormBuilder(array('token' => $token))
        ->add('token', 'hidden')
        ->getForm();
}

同样地，为previewAction()添加extend表单：

// src/Ibw/JobeetBundle/Controller/JobController.php
// ...

public function previewAction($token)
{
    $em = $this->getDoctrine()->getManager();

    $entity = $em->getRepository('IbwJobeetBundle:Job')->findOneByToken($token);

    if (!$entity) {
        throw $this->createNotFoundException('Unable to find Job entity.');
    }

    $deleteForm = $this->createDeleteForm($entity->getId());
    $publishForm = $this->createPublishForm($entity->getToken());
    $extendForm = $this->createExtendForm($entity->getToken());

    return $this->render('IbwJobeetBundle:Job:show.html.twig', array(
        'entity'      => $entity,
        'delete_form' => $deleteForm->createView(),
        'publish_form' => $publishForm->createView(),
        'extend_form' => $extendForm->createView(),
    ));
}

如果Job信息已经被extend了，那么Job::extend()方法返回true，否则返回false：

// src/Ibw/JobeetBundle/Entity/Job.php
// ...

public function extend()
{
    if (!$this->expiresSoon())
    {
        return false;
    }

    $this->expires_at = new \DateTime(date('Y-m-d H:i:s', time() + 86400 * 30));

    return true;
}

最后我们来添加测试：

// src/Ibw/JobeetBundle/Tests/Controller/JobControllerTest.php
// ...

public function testExtendJob()
{
    // A job validity cannot be extended before the job expires soon
    $client = $this->createJob(array('job[position]' => 'FOO4'), true);
    $crawler = $client->getCrawler();
    $this->assertTrue($crawler->filter('input[type=submit]:contains("Extend")')->count() == 0);

    // A job validity can be extended when the job expires soon

    // Create a new FOO5 job
    $client = $this->createJob(array('job[position]' => 'FOO5'), true);

    // Get the job and change the expire date to today
    $kernel = static::createKernel();
    $kernel->boot();
    $em = $kernel->getContainer()->get('doctrine.orm.entity_manager');
    $job = $em->getRepository('IbwJobeetBundle:Job')->findOneByPosition('FOO5');
    $job->setExpiresAt(new \DateTime());
    $em->flush();

    // Go to the preview page and extend the job
    $crawler = $client->request('GET', sprintf('/job/%s/%s/%s/%s', $job->getCompanySlug(), $job->getLocationSlug(), $job->getToken(), $job->getPositionSlug()));
    $crawler = $client->getCrawler();
    $form = $crawler->selectButton('Extend')->form();
    $client->submit($form);

    // Reload the job from db
    $job = $this->getJobByPosition('FOO5');

    // Check the expiration date
    $this->assertTrue($job->getExpiresAt()->format('y/m/d') == date('y/m/d', time() + 86400 * 30));
}

维护任务

尽管Symfony是一个Web框架，但是它也自带了一系列的命令行工具。我们已经使用过它的命令行工具来生成默认的应用程序包（bundle）目录结构和各种各样的model文件。在Symfony中添加自定义的命令也很简单。当用户创建了一条Job信息之后，用户必须去激活它让它上线，否则的话，久而久之数据库中就会有许多无用的（stale）Job数据。现在我们来自定义一个命令清除数据库中所有无用的Job数据，这个命令通常运行在计划任务（cron job）中。

// src/Ibw/JobeetBundle/Command/JobeetCleanupCommand.php
namespace Ibw\JobeetBundle\Command;

use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Ibw\JobeetBundle\Entity\Job;

class JobeetCleanupCommand extends ContainerAwareCommand {

  protected function configure()
  {
      $this
          ->setName('ibw:jobeet:cleanup')
          ->setDescription('Cleanup Jobeet database')
          ->addArgument('days', InputArgument::OPTIONAL, 'The email', 90)
    ;
  }

  protected function execute(InputInterface $input, OutputInterface $output)
  {
      $days = $input->getArgument('days');

      $em = $this->getContainer()->get('doctrine')->getManager();
      $nb = $em->getRepository('IbwJobeetBundle:Job')->cleanup($days);

      $output->writeln(sprintf('Removed %d stale jobs', $nb));
  }
}

我们需要在JobRepository类中添加cleanup()方法：

// src/Ibw/JobeetBundle/Repository/JobRepository.php
// ...

public function cleanup($days)
{
    $query = $this->createQueryBuilder('j')
        ->delete()
        ->where('j.is_activated IS NULL')
        ->andWhere('j.created_at < :created_at')    
        ->setParameter('created_at',  date('Y-m-d', time() - 86400 * $days))
        ->getQuery();

    return $query->execute();
}

在项目根目录下运行下面命令来执行：

php app/console ibw:jobeet:cleanup

或者：

php app/console ibw:jobeet:cleanup 10

上面命令将删除近10天内数据库中无用的Job数据。

原文链接：http://www.intelligentbee.com/blog/2013/08/17/symfony2-jobeet-day-11-testing-your-forms/

jobeet第十一天:表单测试，首发于Symfony中文教程。

jobeet第十天:表单

napoleon — Fri, 27 Mar 2015 06:40:29 +0000

*这一系列文章来源于Fabien Potencier，基于Symfony1.4编写的Jobeet Tutirual。

从简单的联系表单（contact form）到带有很多个表单域的复杂表单，任何一个网站都会有表单的身影出现。对于一位Web开发者来说，编写表单是一个复杂而且乏味的工作之一：我们需要使用HTML代码把表单显示出来，然后需要为每个表单域添加验证规则，再把提交到服务器的表单值处理后保存到数据库中，（如果表单数据有错误）还需要把错误信息反馈给用户，而且还需要填充完用户没有错误的表单域等等…

在第三天的内容中，我门使用了doctrine:generate:crud命令为Job实体类生成了一个简单的CRUD控制器。同时也生成了一个Job表单，我们可以在/src/Ibw/JobeetBundle/Form/JobType.php文件中找到它。

自定义Job表单

Job表单是一个学习如何自定义表单的一个好例子。我们来一步步地学习怎样进行自定义表单。

首先，修改layout中的Post a Job，让它能够正确转向到Post页面：


Post a Job

修改JobController::createAction()中ibw_job_show的路由参数，让它能够匹配我们在第五天中修改过的ibw_job_show路由：

// src/Ibw/JobeetBundle/Controller/JobController.php
// ...

public function createAction(Request $request)
{
    $entity  = new Job();
    $form = $this->createForm(new JobType(), $entity);
    $form->bind($request);

    if ($form->isValid()) {
        $em = $this->getDoctrine()->getManager();

        $em->persist($entity);
        $em->flush();

        return $this->redirect($this->generateUrl('ibw_job_show', array(
            'company' => $entity->getCompanySlug(),
            'location' => $entity->getLocationSlug(),
            'id' => $entity->getId(),
            'position' => $entity->getPositionSlug()
        )));
    }

    return $this->render('IbwJobeetBundle:Job:new.html.twig', array(
        'entity' => $entity,
        'form'   => $form->createView(),
    ));
}

// ...

Doctrine默认是按照数据表中的列（columns）来生成表单域的。但对于Job表单来说，有些表单域是不需要被最终用户（the end user）填写的。我们把Job表单编辑如下：

// src/Ibw/JobeetBundle/Form/JobType.php
namespace Ibw\JobeetBundle\Form;

use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\OptionsResolver\OptionsResolverInterface;

class JobType extends AbstractType
{
    public function buildForm(FormBuilderInterface $builder, array $options)
    {
        $builder
            ->add('type')
            ->add('category')
            ->add('company')
            ->add('logo')
            ->add('url')
            ->add('position')
            ->add('location')
            ->add('description')
            ->add('how_to_apply')
            ->add('token')
            ->add('is_public')
            ->add('email')
        ;
    }

    public function setDefaultOptions(OptionsResolverInterface $resolver)
    {
        $resolver->setDefaults(array(
            'data_class' => 'Ibw\JobeetBundle\Entity\Job'
        ));
    }

    public function getName()
    {
        return 'job';
    }
}

表单的设置要比数据表的设置更加精确。举个例子来说吧，email列在数据表中仅仅只要求是varchar类型的，而表单中则需要验证email要有正确的格式。在Symfony2中，表单验证被隐含在实体对象之中（比如Job）。换句话说，我们的问题不是验证表单（form）是否有效，而是验证Job对象是否有效（表单提交后的数据会被一一映射成Job对象中的属性值）。为了做到这点，我们在Resources/config目录下创建一个validation.yml文件：

# src/Ibw/JobeetBundle/Resources/config/validation.yml
Ibw\JobeetBundle\Entity\Job:
    properties:
        email:
            - NotBlank: ~
            - Email: ~

尽管type列（column）在数据表中是varchar类型的，但我们想限制它的取值只能在：full time，part time和freelance三个值之中。

// src/Ibw/JobeetBundle/Form/JobType.php
// ...
use Ibw\JobeetBundle\Entity\Job;

class JobType extends AbstractType
{
    public function buildForm(FormBuilderInterface $builder, array $options)
    {
        $builder
            ->add('type', 'choice', array('choices' => Job::getTypes(), 'expanded' => true))
            // ...
    }

    // ...

}

为了让上面的代码能够运行，我们需要在Job实体中添加下面的代码：

// src/Ibw/JobeetBundle/Entity/Job.php
// ...

public static function getTypes()
{
    return array('full-time' => 'Full time', 'part-time' => 'Part time', 'freelance' => 'Freelance');
}

public static function getTypeValues()
{
    return array_keys(self::getTypes());
}

// ...

表单利用getTypes()方法生成Job可以选择的类型，getTypeValues()方法被用来验证type表单域值的有效性。

# src/Ibw/JobeetBundle/Resources/config/validation.yml
Ibw\JobeetBundle\Entity\Job:
    properties:
        type:
            - NotBlank: ~
            - Choice: { callback: getTypeValues }
        email:
            - NotBlank: ~
            - Email: ~

对于每个表单域，Symfony会为每个表单域自动生成一个label。我们能通过label选项来修改默认的label值：

// src/Ibw/JobeetBundle/Form/JobType.php
public function buildForm(FormBuilderInterface $builder, array $options)
{
    $builder
        // ...
        ->add('logo', null, array('label' => 'Company logo'))
        // ...
        ->add('how_to_apply', null, array('label' => 'How to apply?'))
        // ...
        ->add('is_public', null, array('label' => 'Public?'))
        // ...
}

我们同样需要为剩下的表单域添加验证约束：

# src/Ibw/JobeetBundle/Resources/config/validation.yml
Ibw\JobeetBundle\Entity\Job:
    properties:
        category:
            - NotBlank: ~
        type:
            - NotBlank: ~
            - Choice: {callback: getTypeValues}
        company:
            - NotBlank: ~
        position:
            - NotBlank: ~
        location:
            - NotBlank: ~
        description:
            - NotBlank: ~
        how_to_apply:
            - NotBlank: ~
        token:
            - NotBlank: ~
        email:
            - NotBlank: ~
            - Email: ~
        url:
            - Url: ~

这里约束url表单域值只能像http://www.sitename.domain或者https://www.sitename.domain这样的格式。

修改完validation.yml之后，我们需要清除cache。

Symfony2处理上传文件

为了能够在表单中处理上传文件，我们会给Job实体添加一个新的file属性：

// src/Ibw/JobeetBundle/Entity/Job.php
// ...

public $file;

// ...

现在我们需要把logo文本域替换成文件域：

// src/Ibw/JobeetBundle/Form/JobType.php
// ...

public function buildForm(FormBuilderInterface $builder, array $options)
{
    $builder
        // ...
        ->add('file', 'file', array('label' => 'Company logo', 'required' => false))
        // ...
}
// ...

为了确保上传的文件是图片，我们需要添加图片文件的验证：

# src/Ibw/JobeetBundle/Resources/config/validation.yml
Ibw\JobeetBundle\Entity\Job:
    properties:
        # ...
        file:
            - Image: ~

当表单提交之后，文件域会被映射成UploadedFile类的一个实例。我们能通过给它一个参数来改变上传文件存放的位置。在这之后我们将会看到Job类的logo属性会被设置成上传文件的名字。

// src/Ibw/JobeetBundle/Controller/JobController.php
// ...

public function createAction(Request $request)
{
    // ...

    if ($form->isValid()) {
        $em = $this->getDoctrine()->getManager();

        $entity->file->move(__DIR__.'/../../../../web/uploads/jobs', $entity->file->getClientOriginalName());
        $entity->setLogo($entity->file->getClientOriginalName());

        $em->persist($entity);
        $em->flush();

        return $this->redirect($this->generateUrl('ibw_job_show', array(
            'company' => $entity->getCompanySlug(),
            'location' => $entity->getLocationSlug(),
            'id' => $entity->getId(),
            'position' => $entity->getPositionSlug()
        )));
    }
    // ...
}

// ...

我们需要创存放logo图片的目录（web/uploads/jobs），并且确保这个目录是可以写的。

尽管能有这种方式处理文件的上传，但我们有更好的方式，那就是使用Job实体。

首先在Job实体中添加下面的代码：

// src/Ibw/JobeetBundle/Entity/Job.php
class Job
{
    // ... 
    protected function getUploadDir()
    {
        return 'uploads/jobs';
    }

    protected function getUploadRootDir()
    {
        return __DIR__.'/../../../../web/'.$this->getUploadDir();
    }

    public function getWebPath()
    {
        return null === $this->logo ? null : $this->getUploadDir().'/'.$this->logo;
    }

    public function getAbsolutePath()
    {
        return null === $this->logo ? null : $this->getUploadRootDir().'/'.$this->logo;
    }
}

logo属性保存的值是上传文件的相对路径，它会被保存到数据库中。getAbsolutePath()方法返回的是上传文件的绝对路径，而getWebPath()方法是返回的是web路径，我们可以在模板中使用它。

我们会把数据库持久化和上传文件实现得具有“原子性（atomic）”：即如果不能成功保存Job实体到数据库或者文件上传失败，那么这两件事都将会失败（比如实体成功保存到数据库了，但文件上传失败了，这种情况属于操作失败，那么数据库保存的数据也必须撤销掉）。我们在当Doctrine成功保存实体后才把上传文件存在目录中。我们可以通过Job实体的lifecycle callback来完成这项操作。就像我们在第三天内容中所做的，我们在Job.orm.yml中添加preUpload，upload 和removeUpload回调方法：

# src/Ibw/JobeetBundle/Resources/config/doctrine/Job.orm.yml
Ibw\JobeetBundle\Entity\Job:
    # ...

    lifecycleCallbacks:
        prePersist: [ preUpload, setCreatedAtValue, setExpiresAtValue ]
        preUpdate: [ preUpload, setUpdatedAtValue ]
        postPersist: [ upload ]
        postUpdate: [ upload ]
        postRemove: [ removeUpload ]

现在运行generate:entities命令为Job实体生成新的方法：

php app/console doctrine:generate:entities IbwJobeetBundle

修改Job.php中新增的方法：

// src/Ibw/JobeetBundle/Entity/Job.php
class Job
{
    // ...

    /**
     * @ORM\PrePersist
     */
    public function preUpload()
    {
         if (null !== $this->file) {
             $this->logo = uniqid().'.'.$this->file->guessExtension();
         }
    }

    /**
     * @ORM\PostPersist
     */
    public function upload()
    {
        if (null === $this->file) {
            return;
        }

        // If there is an error when moving the file, an exception will
        // be automatically thrown by move(). This will properly prevent
        // the entity from being persisted to the database on error
        $this->file->move($this->getUploadRootDir(), $this->logo);

        unset($this->file);
    }

    /**
     * @ORM\PostRemove
     */
    public function removeUpload()
    {
        if(file_exists($this->file)) {
            if ($this->file = $this->getAbsolutePath()) {
                unlink($this->file);
            }
        }    
    }
}

现在Job实体类已经能够完成我们需要的工作了：它会在保存到数据库之前生成一个唯一的文件名，保存数据库后就会把文件存放到目录下，当实体被删除的时候上传文件也将被删除。Job实体已经能够自动处理文件上传了，我们现在需要删除JobController中处理文件上传的代码：

// src/Ibw/JobeetBundle/Controller/JobController.php
// ...

    public function createAction(Request $request)
    {
        $entity  = new Job();
        $form = $this->createForm(new JobType(), $entity);
        $form->bind($request);

        if ($form->isValid()) {
            $em = $this->getDoctrine()->getManager();

            $em->persist($entity);
            $em->flush();

            return $this->redirect($this->generateUrl('ibw_job_show', array(
                'company' => $entity->getCompanySlug(),
                'location' => $entity->getLocationSlug(),
                'id' => $entity->getId(),
                'position' => $entity->getPositionSlug()
            )));
        }

        return $this->render('IbwJobeetBundle:Job:new.html.twig', array(
            'entity' => $entity,
            'form'   => $form->createView(),
        ));
    }

// ...

表单模板

我们已经完成了表单类的自定义，现在我们需要把它显示出来。修改new.html.twig模板：


{% extends 'IbwJobeetBundle::layout.html.twig' %}

{% form_theme form _self %}

{% block form_errors %}
{% spaceless %}
    {% if errors|length > 0 %}
        
            {% for error in errors %}
                {{ error.messageTemplate|trans(error.messageParameters, 'validators') }}
            {% endfor %}
        
    {% endif %}
{% endspaceless %}
{% endblock form_errors %}

{% block stylesheets %}
    {{ parent() }}
    
{% endblock %}

{% block content %}
    Job creation
    
        
            
                
                    
                        
                    
                
            
            
                
                    {{ form_label(form.category) }}
                    
                        {{ form_errors(form.category) }}
                        {{ form_widget(form.category) }}
                    
                
                
                    {{ form_label(form.type) }}
                    
                        {{ form_errors(form.type) }}
                        {{ form_widget(form.type) }}
                    
                
                
                    {{ form_label(form.company) }}
                    
                        {{ form_errors(form.company) }}
                        {{ form_widget(form.company) }}
                    
                
                
                    {{ form_label(form.file) }}
                    
                        {{ form_errors(form.file) }}
                        {{ form_widget(form.file) }}
                    
                
                
                    {{ form_label(form.url) }}
                    
                        {{ form_errors(form.url) }}
                        {{ form_widget(form.url) }}
                    
                
                
                    {{ form_label(form.position) }}
                    
                        {{ form_errors(form.position) }}
                        {{ form_widget(form.position) }}
                    
                
                
                    {{ form_label(form.location) }}
                    
                        {{ form_errors(form.location) }}
                        {{ form_widget(form.location) }}
                    
                
                
                    {{ form_label(form.description) }}
                    
                        {{ form_errors(form.description) }}
                        {{ form_widget(form.description) }}
                    
                
                
                    {{ form_label(form.how_to_apply) }}
                    
                        {{ form_errors(form.how_to_apply) }}
                        {{ form_widget(form.how_to_apply) }}
                    
                
                
                    {{ form_label(form.token) }}
                    
                        {{ form_errors(form.token) }}
                        {{ form_widget(form.token) }}
                    
                
                
                    {{ form_label(form.is_public) }}
                    
                        {{ form_errors(form.is_public) }}
                        {{ form_widget(form.is_public) }}
                        
 Whether the job can also be published on affiliate websites or not.
                    
                
                
                    {{ form_label(form.email) }}
                    
                        {{ form_errors(form.email) }}
                        {{ form_widget(form.email) }}
                    
                
            
        
    {{ form_end(form) }}
{% endblock %}


{{ form_label(form.category) }}	{{ form_errors(form.category) }} {{ form_widget(form.category) }}
{{ form_label(form.type) }}	{{ form_errors(form.type) }} {{ form_widget(form.type) }}
{{ form_label(form.company) }}	{{ form_errors(form.company) }} {{ form_widget(form.company) }}
{{ form_label(form.file) }}	{{ form_errors(form.file) }} {{ form_widget(form.file) }}
{{ form_label(form.url) }}	{{ form_errors(form.url) }} {{ form_widget(form.url) }}
{{ form_label(form.position) }}	{{ form_errors(form.position) }} {{ form_widget(form.position) }}
{{ form_label(form.location) }}	{{ form_errors(form.location) }} {{ form_widget(form.location) }}
{{ form_label(form.description) }}	{{ form_errors(form.description) }} {{ form_widget(form.description) }}
{{ form_label(form.how_to_apply) }}	{{ form_errors(form.how_to_apply) }} {{ form_widget(form.how_to_apply) }}
{{ form_label(form.token) }}	{{ form_errors(form.token) }} {{ form_widget(form.token) }}
{{ form_label(form.is_public) }}	{{ form_errors(form.is_public) }} {{ form_widget(form.is_public) }} Whether the job can also be published on affiliate websites or not.
{{ form_label(form.email) }}	{{ form_errors(form.email) }} {{ form_widget(form.email) }}

我们可以使用下面那一行代码来显示表单，但我们需要更多的自定义内容，所以我们选择手动来添加表单域。

{{ form(form) }}

form(form)会显示每个表单域，而且还会带有label和error信息（如果有的话）。虽然这种方式简单，但是它不是很灵活。更多时候我们需要去自定义表单域的显示，以更好地控制它们的样式外观。

我们也使用一种叫做form theming的技术来自定义form errors的渲染。你可以参考Symfony2的官方文档。

对eidt.html.twig做同样的修改：


{% extends 'IbwJobeetBundle::layout.html.twig' %}

{% form_theme edit_form _self %}

{% block form_errors %}
{% spaceless %}
    {% if errors|length > 0 %}
        
            {% for error in errors %}
                {{ error.messageTemplate|trans(error.messageParameters, 'validators') }}
            {% endfor %}
        
    {% endif %}
{% endspaceless %}
{% endblock form_errors %}

{% block stylesheets %}
    {{ parent() }}
    
{% endblock %}

{% block content %}
    Job edit
    
        
            
                
                    
                        
                    
                
            
            
                
                    {{ form_label(edit_form.category) }}
                    
                        {{ form_errors(edit_form.category) }}
                        {{ form_widget(edit_form.category) }}
                    
                
                
                    {{ form_label(edit_form.type) }}
                    
                        {{ form_errors(edit_form.type) }}
                        {{ form_widget(edit_form.type) }}
                    
                
                
                    {{ form_label(edit_form.company) }}
                    
                        {{ form_errors(edit_form.company) }}
                        {{ form_widget(edit_form.company) }}
                    
                
                
                    {{ form_label(edit_form.file) }}
                    
                        {{ form_errors(edit_form.file) }}
                        {{ form(edit_form.file) }}
                    
                
                
                    {{ form_label(edit_form.url) }}
                    
                        {{ form_errors(edit_form.url) }}
                        {{ form_widget(edit_form.url) }}
                    
                
                
                    {{ form_label(edit_form.position) }}
                    
                        {{ form_errors(edit_form.position) }}
                        {{ form_widget(edit_form.position) }}
                    
                
                
                    {{ form_label(edit_form.location) }}
                    
                        {{ form_errors(edit_form.location) }}
                        {{ form_widget(edit_form.location) }}
                    
                
                
                    {{ form_label(edit_form.description) }}
                    
                        {{ form_errors(edit_form.description) }}
                        {{ form_widget(edit_form.description) }}
                    
                
                
                    {{ form_label(edit_form.how_to_apply) }}
                    
                        {{ form_errors(edit_form.how_to_apply) }}
                        {{ form_widget(edit_form.how_to_apply) }}
                    
                
                
                    {{ form_label(edit_form.token) }}
                    
                        {{ form_errors(edit_form.token) }}
                        {{ form_widget(edit_form.token) }}
                    
                
                
                    {{ form_label(edit_form.is_public) }}
                    
                        {{ form_errors(edit_form.is_public) }}
                        {{ form_widget(edit_form.is_public) }}
                        
 Whether the job can also be published on affiliate websites or not.
                    
                
                
                    {{ form_label(edit_form.email) }}
                    
                        {{ form_errors(edit_form.email) }}
                        {{ form_widget(edit_form.email) }}
                    
                
            
        
    {{ form_end(edit_form) }}
{% endblock %}


{{ form_label(edit_form.category) }}	{{ form_errors(edit_form.category) }} {{ form_widget(edit_form.category) }}
{{ form_label(edit_form.type) }}	{{ form_errors(edit_form.type) }} {{ form_widget(edit_form.type) }}
{{ form_label(edit_form.company) }}	{{ form_errors(edit_form.company) }} {{ form_widget(edit_form.company) }}
{{ form_label(edit_form.file) }}	{{ form_errors(edit_form.file) }} {{ form(edit_form.file) }}
{{ form_label(edit_form.url) }}	{{ form_errors(edit_form.url) }} {{ form_widget(edit_form.url) }}
{{ form_label(edit_form.position) }}	{{ form_errors(edit_form.position) }} {{ form_widget(edit_form.position) }}
{{ form_label(edit_form.location) }}	{{ form_errors(edit_form.location) }} {{ form_widget(edit_form.location) }}
{{ form_label(edit_form.description) }}	{{ form_errors(edit_form.description) }} {{ form_widget(edit_form.description) }}
{{ form_label(edit_form.how_to_apply) }}	{{ form_errors(edit_form.how_to_apply) }} {{ form_widget(edit_form.how_to_apply) }}
{{ form_label(edit_form.token) }}	{{ form_errors(edit_form.token) }} {{ form_widget(edit_form.token) }}
{{ form_label(edit_form.is_public) }}	{{ form_errors(edit_form.is_public) }} {{ form_widget(edit_form.is_public) }} Whether the job can also be published on affiliate websites or not.
{{ form_label(edit_form.email) }}	{{ form_errors(edit_form.email) }} {{ form_widget(edit_form.email) }}

表单行为（Action）

现在我们已经有了一个表单类（JobType）和一个利用它生成表单的模板。现在是时候让它能够做一点实际的行为了。Job表单被JobController中的四个方法所管理着：

newAction：显示一个空表单用来创建一个新job
createAction：处理表单（表单验证，表单填充）和利用用户提交的表单值实例化一个Job对象
editAction：显示一个已存在job的编辑表单
updateAction：处理表单（表单验证，表单填充）和利用用户提交的表单值更新已存在的Job对象

当你浏览/job/new page时，createForm()方法会实例化一个新的job表单实例，然后把这个表单实例传递给模板（newAction）。

当用户提交了表单（createAction），表单就绑定有用户提交的值（bind($request)方法），同时也会触发表单验证。一旦表单被绑定了，那么就可以使用isValid()方法验证表单是否有效：如果表单有效（返回true），那么Job数据就会被保存到数据库中（$em->persist($entity)），然后用户会被重定向到Job数据的预览页面；如果表单无效，那么new.html.twig模板会被重新渲染，而且表单还会自动填充用户提交上来的表单值，同时还会显示出错误信息。修改一个已存在的Job和这个过程很相似。new和edit行为唯一不同的是，需要被修改的Job对象是被作为crateForm()方法的第二个参数所使用。在模板中，这个对象的值的会被用来当做默认表单域的值。

我们也可以为creation表单定义默认的值。我们会传递一个预修改的Job对象给createForm()方法来设置type的默认值为full-time：

// src/Ibw/JobeetBundle/Controller/jobController.php
// ...

public function newAction()
{
    $entity = new Job();
    $entity->setType('full-time');
    $form = $this->createForm(new JobType(), $entity);

    return $this->render('IbwJobeetBundle:Job:new.html.twig', array(
        'entity' => $entity,
        'form'   => $form->createView()
    ));
}

// ...

使用Token来保护表单

现在一切都进展顺利，可是用户必须得填写token才能添加Job数据。通常来说，token应该是在这个Job数据被创建的时候自动生成的，我们不想让用户自己去提供这个唯一值的token。给Job实体的prePersist lifecycleCallbacks添加setTokenValue方法：

# src/Ibw/JobeetBundle/Resources/config/doctrine/Job.orm.yml
# ...

lifecycleCallbacks:
    prePersist: [ setTokenValue, preUpload, setCreatedAtValue, setExpiresAtValue ]
     # ...

重新生成实体：

php app/console doctrine:generate:entities IbwJobeetBundle

修改Job实体的setTokenValue()方法，给它添加生成token的逻辑代码：

// src/Ibw/JobeetBundle/Entity/Job.php
// ...

public function setTokenValue()
{
    if(!$this->getToken()) {
        $this->token = sha1($this->getEmail().rand(11111, 99999));
    }
}

// ...

删除表单中的token域：

// src/Ibw/JobeetBundle/Form/JobType.php
// ...

public function buildForm(FormBuilderInterface $builder, array $options)
{
    $builder
        ->add('category')
        ->add('type', 'choice', array('choices' => Job::getTypes(), 'expanded' => true))
        ->add('company')
        ->add('file', 'file', array('label' => 'Company logo', 'required' => false))
        ->add('url')
        ->add('position')
        ->add('location')
        ->add('description')
        ->add('how_to_apply', null, array('label' => 'How to apply?'))
        ->add('is_public', null, array('label' => 'Public?'))
        ->add('email')
    ;
}

// ...

删除/new.html.twig和edit.html.twig中的token域：




    {{ form_label(form.token) }}
    
        {{ form_errors(form.token) }}
        {{ form_widget(form.token) }}




    {{ form_label(edit_form.token) }}
    
        {{ form_errors(edit_form.token) }}
        {{ form(edit_form.token) }}

删除validation.yml中的token域：

# src/Ibw/JobeetBundle/Resources/config/validation.yml
# ...
    # ...
    token:
        - NotBlank: ~

还记得第二天内容中的用户stories吗，只有用户知道Job的token才能对该Job信息进行修改。很好，修改或者删除一个Job数据是多么得简单呀，你只需要去猜那个URL中的token是什么值就可以办到了，你说这不是很简单（keng ren）吗？。修改Job信息的访问URL类似于/job/ID/edit，这里的ID是Job的主键。

我们来修改路由，只有URL带上token才能修改和删除Job信息：

# src/Ibw/JobeetBundle/Resources/config/routing/job.yml
# ...

ibw_job_edit:
    pattern:  /{token}/edit
    defaults: { _controller: "IbwJobeetBundle:Job:edit" }

ibw_job_update:
    pattern:  /{token}/update
    defaults: { _controller: "IbwJobeetBundle:Job:update" }
    requirements: { _method: post|put }

ibw_job_delete:
    pattern:  /{token}/delete
    defaults: { _controller: "IbwJobeetBundle:Job:delete" }
    requirements: { _method: post|delete }

现在修改JobController，使用token来代替id：

// src/Ibw/JobeetBundle/Controller/JobController.php
// ...
class JobController extends Controller
{
    // ...

    public function editAction($token)
    {
        $em = $this->getDoctrine()->getManager();

        $entity = $em->getRepository('IbwJobeetBundle:Job')->findOneByToken($token);

        if (!$entity) {
            throw $this->createNotFoundException('Unable to find Job entity.');
        }

        $editForm = $this->createForm(new JobType(), $entity);
        $deleteForm = $this->createDeleteForm($token);

        return $this->render('IbwJobeetBundle:Job:edit.html.twig', array(
            'entity'      => $entity,
            'edit_form'   => $editForm->createView(),
            'delete_form' => $deleteForm->createView(),
        ));
    }   

    public function updateAction(Request $request, $token)
    {
        $em = $this->getDoctrine()->getManager();

        $entity = $em->getRepository('IbwJobeetBundle:Job')->findOneByToken($token);

        if (!$entity) {
            throw $this->createNotFoundException('Unable to find Job entity.');
        }

        $editForm   = $this->createForm(new JobType(), $entity);
        $deleteForm = $this->createDeleteForm($token);

        $editForm->bind($request);

        if ($editForm->isValid()) {
            $em->persist($entity);
            $em->flush();

            return $this->redirect($this->generateUrl('ibw_job_edit', array('token' => $token)));
        }

        return $this->render('IbwJobeetBundle:Job:edit.html.twig', array(
            'entity'      => $entity,
            'edit_form'   => $editForm->createView(),
            'delete_form' => $deleteForm->createView(),
        ));
    }

    public function deleteAction(Request $request, $token)
    {
        $form = $this->createDeleteForm($token);
        $form->bind($request);

        if ($form->isValid()) {
            $em = $this->getDoctrine()->getManager();
            $entity = $em->getRepository('IbwJobeetBundle:Job')->findOneByToken($token);

            if (!$entity) {
                throw $this->createNotFoundException('Unable to find Job entity.');
            }

            $em->remove($entity);
            $em->flush();
        }

        return $this->redirect($this->generateUrl('ibw_job'));
    }

    /**
     * Creates a form to delete a Job entity by id.
     *
     * @param mixed $id The entity id
     *
     * @return Symfony\Component\Form\Form The form
     */
    private function createDeleteForm($token)
    {
        return $this->createFormBuilder(array('token' => $token))
            ->add('token', 'hidden')
            ->getForm()
        ;
    }
}

修改show.html.twig模板中的ibw_job_edit路由参数：

修改edit.html.twig模板中的ibw_job_update路由：

除了job_show_user路由外，其他和Job相关的路由都已经带上了token。现在，一个Job的URL样式应该是类似于这样的：http://jobeet.local/job/TOKEN/edit

预览页面

预览页面和Job页面显示的内容是一样的。唯一不同的是，预览页面是通过token访问的，而不是通过id：

# src/Ibw/JobeetBundle/Resources/config/routing/job.yml
# ...

ibw_job_show:
    pattern:  /{company}/{location}/{id}/{position}
    defaults: { _controller: "IbwJobeetBundle:Job:show" }
    requirements:
        id:  \d+

ibw_job_preview:
    pattern:  /{company}/{location}/{token}/{position}
    defaults: { _controller: "IbwJobeetBundle:Job:preview" }
    requirements:
        token:  \w+

# ...

previewAction()（它和showAction()不同的是，它通过token来检索job，而不是通过id）：

// src/Ibw/JobeetBundle/Controller/JobController.php
// ...

public function previewAction($token)
{
    $em = $this->getDoctrine()->getManager();

    $entity = $em->getRepository('IbwJobeetBundle:Job')->findOneByToken($token);

    if (!$entity) {
        throw $this->createNotFoundException('Unable to find Job entity.');
    }

    $deleteForm = $this->createDeleteForm($entity->getId());

    return $this->render('IbwJobeetBundle:Job:show.html.twig', array(
        'entity'      => $entity,
        'delete_form' => $deleteForm->createView(),
    ));
}

// ...

如果用户是通过带token的URL访问到页面的，那么我们就会在页面顶部显示一个admin栏。在show.html.twig的开头包含（include）一个模板，这个模板是用来显示admin栏的。同时删除底部的edit链接：




{% block content %}
    {% if app.request.get('token') %}
        {% include 'IbwJobeetBundle:Job:admin.html.twig' with {'job': entity} %}
    {% endif %}

 

{% endblock %}

然后创建admin.html.twig模板：



    Admin
    
        {% if not job.isActivated %}
            Edit
            Publish
        {% endif %}
        
            
                {{ form_widget(delete_form) }}
                
            
        
        {% if job.isActivated %}
            
                {% if job.isExpired %}
                    Expired
                {% else %}
                    Expires in {{ job.getDaysBeforeExpires }} days
                {% endif %}

                {% if job.expiresSoon %}
                    - Extend for another 30 days
                {% endif %}
            
        {% else %}
            
                [Bookmark this URL to manage this job in the future.]
            
        {% endif %}

这里虽然代码很多，但是都是简单并且容易理解的。

为了让模板的可读性更好，我们为Job实体添加一组简单的方法：

// src/Ibw/JobeetBundle/Entity/Job.php
// ...

public function isExpired()
{
    return $this->getDaysBeforeExpires() < 0;
}

public function expiresSoon()
{
    return $this->getDaysBeforeExpires() < 5;    
}

public function getDaysBeforeExpires()
{
    return ceil(($this->getExpiresAt()->format('U') - time()) / 86400);
}

// ...

admin栏随着Job状态的不同显示出来的样式也会不同：

现在修改JobController中的createAction()和updateAction()，让它们重定向到预览页面：

// src/Ibw/JobeetBundle/Controller/JobController.php
public function createAction(Request $request)
{
    // ...
    if ($form->isValid()) {
        // ... 
        return $this->redirect($this->generateUrl('ibw_job_preview', array(
            'company' => $entity->getCompanySlug(),
            'location' => $entity->getLocationSlug(),
            'token' => $entity->getToken(),
            'position' => $entity->getPositionSlug()
        )));
    }
    // ...
}

public function updateAction(Request $request, $token)
{
    // ...
    if ($editForm->isValid()) {
        // ... 

        return $this->redirect($this->generateUrl('ibw_job_preview', array(
            'company' => $entity->getCompanySlug(),
            'location' => $entity->getLocationSlug(),
            'token' => $entity->getToken(), 
            'position' => $entity->getPositionSlug()
        )));
    }
    // ...
}

就像我们之前所说的，如果你知道token或者你是Jobeet的管理员的话，你就有权可以修改一条Job信息。但是我们现在去访问Job页面的话，我们可以看到页面上有一个Edit链接，这样的用户体验让人感觉不好。我们来修改show.html.twig，删除Edit链接：



    
        Edit

Job激活和发布

在Job页面的上部分有一个发布Job信息的链接，这个链接需要被指定到publishAction()上。我们先创建一个新的路由：

# src/Ibw/JobeetBundle/Resources/config/routing/job.yml
# ...

ibw_job_publish:
    pattern:  /{token}/publish
    defaults: { _controller: "IbwJobeetBundle:Job:publish" }
    requirements: { _method: post }

现在我们来修改Publish链接（我们在这里使用表单，就像删除一个Job一样，它会发送一个POST请求）：




{% if not job.isActivated %}
    Edit
    
        
            {{ form_widget(publish_form) }}
            
        
    
{% endif %}

最后一步是创建publishAction()，同时修改previewAction()给模板传递一个publish表单：

// src/Ibw/JobeetBundle/Controller/JobController.php
// ...

public function previewAction($token)
{
    // ...

    $deleteForm = $this->createDeleteForm($entity->getToken());
    $publishForm = $this->createPublishForm($entity->getToken());

    return $this->render('IbwJobeetBundle:Job:show.html.twig', array(
        'entity'      => $entity,
        'delete_form' => $deleteForm->createView(),
        'publish_form' => $publishForm->createView(),
    ));
}

public function publishAction(Request $request, $token)
{
    $form = $this->createPublishForm($token);
    $form->bind($request);

    if ($form->isValid()) {
        $em = $this->getDoctrine()->getManager();
        $entity = $em->getRepository('IbwJobeetBundle:Job')->findOneByToken($token);

        if (!$entity) {
            throw $this->createNotFoundException('Unable to find Job entity.');
        }

        $entity->publish();
        $em->persist($entity);
        $em->flush();

        $this->get('session')->getFlashBag()->add('notice', 'Your job is now online for 30 days.');
    }

    return $this->redirect($this->generateUrl('ibw_job_preview', array(
        'company' => $entity->getCompanySlug(),
        'location' => $entity->getLocationSlug(),
        'token' => $entity->getToken(),
        'position' => $entity->getPositionSlug()
    )));
}

private function createPublishForm($token)
{
    return $this->createFormBuilder(array('token' => $token))
        ->add('token', 'hidden')
        ->getForm()
    ;
}

// ...

PublishAction()方法使用的publish()可以在Job实体中定义：

// src/Ibw/JobeetBundle/Entity
// ...

public function publish()
{
    $this->setIsActivated(true);
}

// ...

现在我们可以在浏览中测试publish功能了。

但现在我们依然还有问题需要去修正。那些未被激活的Job数据是不可以被访问到的，也不能出现在首页中。我们需要修改JobRepository：

// src/Ibw/JobeetBundle/Repository/JobRepository.php
namespace Ibw\JobeetBundle\Repository;
use Doctrine\ORM\EntityRepository;

class JobRepository extends EntityRepository
{
    public function getActiveJobs($category_id = null, $max = null, $offset = null)
    {
        $qb = $this->createQueryBuilder('j')
            ->where('j.expires_at > :date')
            ->setParameter('date', date('Y-m-d H:i:s', time()))
            ->andWhere('j.is_activated = :activated')
            ->setParameter('activated', 1)
            ->orderBy('j.expires_at', 'DESC');

        if($max) {
            $qb->setMaxResults($max);
        }

        if($offset) {
            $qb->setFirstResult($offset);
        }

        if($category_id) {
            $qb->andWhere('j.category = :category_id')
                ->setParameter('category_id', $category_id);
        }

        $query = $qb->getQuery();

        return $query->getResult();
    }

    public function countActiveJobs($category_id = null)
    {
        $qb = $this->createQueryBuilder('j')
            ->select('count(j.id)')
            ->where('j.expires_at > :date')
            ->setParameter('date', date('Y-m-d H:i:s', time()))
            ->andWhere('j.is_activated = :activated')
            ->setParameter('activated', 1);

        if($category_id) {
            $qb->andWhere('j.category = :category_id')
                ->setParameter('category_id', $category_id);
        }

        $query = $qb->getQuery();

        return $query->getSingleScalarResult();
    }

    public function getActiveJob($id)
    {
        $query = $this->createQueryBuilder('j')
            ->where('j.id = :id')
            ->setParameter('id', $id)
            ->andWhere('j.expires_at > :date')
            ->setParameter('date', date('Y-m-d H:i:s', time()))
            ->andWhere('j.is_activated = :activated')
            ->setParameter('activated', 1)
            ->setMaxResults(1)
            ->getQuery();

        try {
            $job = $query->getSingleResult();
        } catch (\Doctrine\Orm\NoResultException $e) {
        $job = null;
          }

        return $job;
    }
}

修改CategoryRepository中的getWithJobs()方法：

// src/Ibw/JobeetBundle/Repository/CategoryRepository.php
namespace Ibw\JobeetBundle\Repository;
use Doctrine\ORM\EntityRepository;

class CategoryRepository extends EntityRepository
{
    public function getWithJobs()
    {
        $query = $this->getEntityManager()
            ->createQuery('SELECT c FROM IbwJobeetBundle:Category c LEFT JOIN c.jobs j WHERE j.expires_at > :date AND j.is_activated = :activated')
            ->setParameter('date', date('Y-m-d H:i:s', time()))
            ->setParameter('activated', 1);

        return $query->getResult();
    }
}

好了，今天就这些了。你可以在浏览器中测试一下今天的实现的内容。所有未被激活的Job数据是不会显示到首页中的，即使你知道URL链接，它们也是不可以被访问到的。不过，如果你知道带token的URL的话就可以访问到，在这种情况下，Job预览页面顶部会显示出admin栏。

原文链接：http://www.intelligentbee.com/blog/2013/08/16/symfony2-jobeet-day-10-the-forms/

jobeet第十天:表单，首发于Symfony中文教程。

Symfony中文教程 » jobeet

jobeet第十九天:国际化和本地化

用户

Culture in the URL

Culture测试

语言切换

模板

{% trans %}Ask for people{% endtrans %}

{% trans %}Ask for a job{% endtrans %}

{{ entity.company }}

{{ entity.location }}

{{ entity.position }} - {{ entity.type }}

{% trans %}How to apply?{% endtrans %}

{% trans %}Job creation{% endtrans %}

{% trans %}Job edit{% endtrans %}

Admin

{{ category.name }}

{% trans %}Your affiliate account has been created{% endtrans %}

{% trans %}Become an affiliate{% endtrans %}

jobeet第十八天:ajax

安装jQuery

包含jQuery

添加行为

用户反馈

Ask for a job

AJAX和Action

测试AJAX

jobeet第十七天:搜索

Zend Lucene

安装和配置Zend Framework

索引

搜索

Ask for a job

单元测试

任务

jobeet第十六天:邮件

Swift Mailer

测试

jobeet第十五天:Web Services

Affiliates

The fixtures

The Job Web Service

XML格式

JSON格式

YAML格式

测试Web Service

Affiliate申请表单

Become an affiliate

Your affiliate account has been created

测试

Affiliate后台管理

jobeet第十四天:订阅

模板格式

订阅

订阅最新的Job信息

How to apply?

订阅分类中最新的Job信息

How to apply?

jobeet第十三天:安全

实现程序的安全性

User Providers

登出（Logout）

用户Session

flash信息

jobeet第十二天:后台管理工具包-Sonata Admin

安装Sonata Admin Bundle

CRUD控制器

创建Admin类

配置Admin类

批量操作（Batch Actions）

jobeet第十一天:表单测试

提交表单

测试表单

测试数据库记录

测试错误的表单

用测试作保障

“穿越未来”的测试

维护任务

jobeet第十天:表单

自定义Job表单