Reading about testing controllers in Symfony I found this post on stackoverflow which brings arguments that controller shouldn't be unit tested: http://stackoverflow.com/questions/10126826/how-can-i-unit-test-a-symfony2-controller
It makes sense, I will than write functional tests for my controllers.Working with PHPUnit and Symfony (how I did):
1. Install PHPUnit
Install PHPUnit globally on your machine following the instructions found here:
https://phpunit.de/manual/current/en/installation.html
2. Configuration
In "app" directory there is the file phpunit.xml.dist
Make a copy of it and rename it to phpunit.xml
Do any changes you consider necessary inside of it (I didn't changed anything).
Under "\src\CPANA\BasicBlogBundle\Tests\Controller" Symfony adds an example test class: DefaultControllerTest.php. I've edited that file to test by BlogController class:
"BlogControllerTest.php"
3. Write your test class
The test will verify if the the requested page contains the word "blog" which is in the title of the page expected.
class BlogControllerTest extends WebTestCase
{
public function testIndex()
{
$client = static::createClient();
$client->request('GET', '/blog');
//var_dump($client->getResponse()->getContent());
$crawler = $client->request('GET', '/blog');
$this->assertGreaterThan(
0,
$crawler->filter('html:contains("Blog")')->count()
);
}
}
4.Run PHPUnit
Open command prompt, navigate to the folder where Symfony is installed. Run command:
phpunit -c app "src/CPANA/BasicBlogBundle/"> "phpunitLog.txt"
this command will log the output in a text file. Review the log file found in the root path of Symfony.
If you are lucky the output will look like this:
PHPUnit 4.8.8 by Sebastian Bergmann and contributors.
.Time: 4.89 seconds, Memory: 24.75Mb
OK (1 test, 1 assertion)
Next challenge should be to test aspects that depend on the interaction with the database:
http://symfony.com/doc/current/cookbook/testing/database.html
Tuesday, September 29, 2015
Friday, September 25, 2015
cpana/basicblogbundle now on GitHub and Packagist
https://github.com/cristianpana86/BasicBlogBundle
https://packagist.org/packages/cpana/basicblogbundle
I've worked previously with GitHub, the new thing was to have the package on Packagist.com so it can be installed easily via Composer.
After creating my repository on GitHub I went on Packagist and created an account.
Following the instructions found on this article: http://www.sitepoint.com/listing-packages-on-packagist-for-composer/ I've created my composer.json document:
{
"name": "cpana/basicblogbundle",
"type": "symfony-bundle",
"description": "Symfony Basic Blog Bundle",
"keywords": ["blog","symfony"],
"homepage": "https://github.com/cristianpana86/BasicBlogBundle",
"license": "MIT",
"authors": [
{
"name": "Cristian Pana",
"email": "cristianpana86@yahoo.com"
}
],
"require": {
"php": ">=5.5.0",
"symfony/symfony": "2.7.*",
"doctrine/orm": "~2.2,>=2.2.3,<2.5",
"doctrine/dbal": "<2.5",
"doctrine/doctrine-bundle": "~1.4",
"symfony/assetic-bundle": "~2.3",
"symfony/swiftmailer-bundle": "~2.3",
"symfony/monolog-bundle": "~2.4",
"sensio/distribution-bundle": "~4.0",
"sensio/framework-extra-bundle": "~3.0,>=3.0.2"
},
"minimum-stability": "dev",
"autoload" : {
"psr-4" : {
"CPANA\\BasicBlogBundle\\" : ""
}
}
}
Some of the values are from the Symblog composer.json and may be outdated, it's something I have to look over.
I've added also the installation instructions on my GitHub repository and from there are automatically listed on Packagist.com:
https://packagist.org/packages/cpana/basicblogbundle
I've worked previously with GitHub, the new thing was to have the package on Packagist.com so it can be installed easily via Composer.
After creating my repository on GitHub I went on Packagist and created an account.
Following the instructions found on this article: http://www.sitepoint.com/listing-packages-on-packagist-for-composer/ I've created my composer.json document:
{
"name": "cpana/basicblogbundle",
"type": "symfony-bundle",
"description": "Symfony Basic Blog Bundle",
"keywords": ["blog","symfony"],
"homepage": "https://github.com/cristianpana86/BasicBlogBundle",
"license": "MIT",
"authors": [
{
"name": "Cristian Pana",
"email": "cristianpana86@yahoo.com"
}
],
"require": {
"php": ">=5.5.0",
"symfony/symfony": "2.7.*",
"doctrine/orm": "~2.2,>=2.2.3,<2.5",
"doctrine/dbal": "<2.5",
"doctrine/doctrine-bundle": "~1.4",
"symfony/assetic-bundle": "~2.3",
"symfony/swiftmailer-bundle": "~2.3",
"symfony/monolog-bundle": "~2.4",
"sensio/distribution-bundle": "~4.0",
"sensio/framework-extra-bundle": "~3.0,>=3.0.2"
},
"minimum-stability": "dev",
"autoload" : {
"psr-4" : {
"CPANA\\BasicBlogBundle\\" : ""
}
}
}
Some of the values are from the Symblog composer.json and may be outdated, it's something I have to look over.
I've added also the installation instructions on my GitHub repository and from there are automatically listed on Packagist.com:
Install using Composer:
composer require cpana/basicblogbundle:dev-master new CPANA\BasicBlogBundle\CPANABasicBlogBundle(), CPANABasicBlogBundle:
resource: "@CPANABasicBlogBundle/Resources/config/routing.yml" php app/console cache:clear
php app/console doctrine:schema:update --force
Thursday, September 24, 2015
CPANABasicBlogBundle for Symfony2
Having as a starter point the http://tutorial.symblog.co.uk/ ( about which I wrote here ) I developed blog bundle having the following main features:
Frontside
- view all blog posts with pagination
- view individual blog posts
- add comments
Admin
- view a list of all blog posts with Edit and Delete options.
- view the list of comments with options to Approve/Unapprove or Delete.
In the Symblog tutorial there was a add comment functionality but for me didn't worked throwing an error like "Catchable Fatal Error: Object of class XYZ could not be converted to string in Doctrine\DBAL\Statement.php" ( see this post about it ). To solve the issue I've added to Entity\Blog.php the following function:
public function __toString()
{
return strval($this->id);
}
Also I modified the CommentType.php to make all the comments unapproved initially:
// \src\CPANA\BasicBlogBundle\Form\CommentType.php
public function buildForm(FormBuilderInterface $builder, array $options)
{
$builder
->add('user')
->add('comment')
->add('approved','hidden', array('data' => '0',))
;
}
Make sure you are pointing to the right path in the template. In src\CPANA\BasicBlogBundle\Resources\views\Blog\show.html.twig:
<img src="{{ asset(['bundles/basicblogbundle/images/', blog.image]|join) }}" alt="{{ blog.title }} image not found" />
At this path: 'bundles/basicblogbundle/images/' I should upload the files in the controller.
Make sure to indicate that the "file" field is not mapped to the Entity.
->add('image', 'file', array('mapped'=>false))
Upload photo and save in database only the name
------------------------------------------------
if ($form->isValid()) {
$newFilename = $form['attachment']->getData()->getClientOriginalName();
// Handle picture upload process
$uploadDir=dirname($this->container->getParameter('kernel.root_dir')) . '/web/bundles/basicblogbundle/images/';
$form['image']->getData()->move($uploadDir,$newFilename);
// End of upload
$blog->setImage($newFilename);
$em = $this->getDoctrine()->getManager();
$em->persist($blog);
$em->flush();
This works fine but we should make sure the file names are unique so they do not conflict when you try to upload a file with same name.
We should add random string function in a class. I do no think this should be considered a service, so I will not register it as a service in the Dependency Injection container.
http://symfony.com/doc/current/best_practices/business-logic.html
Create an Utils folder. Place there RandomString.php, add a static function: randomStr
namespace CPANA\BasicBlogBundle\Utils;
class RandomString
{
public static function randomStr($length = 10)
{
$characters = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ';
$charactersLength = strlen($characters);
$randomString = '';
for ($i = 0; $i < $length; $i++) {
$randomString .= $characters[rand(0, $charactersLength - 1)];
}
return $randomString;
}
After this include the randomStr in the fileName:
$newFilename =RandomString::randomStr() . $form['image']->getData()->getClientOriginalName();
---------------------------
when testing the new feature I noticed that the photo is not available when browsing the blog, reason: the name included in the template is trimmed. I looked in the database , in the "image" column, same there. Checking the type of column I noticed the column is set to varchar(20)!!!! that's the problem right there.
Solution:
modify in Entity\Blog.php the ORM annotation for $image from
@ORM\Column(type="string", length=20)
to
@ORM\Column(type="string", length=255)
After this update the DB schema using Symfony 2 command line:
php app/console cache:clear
php app/console doctrine:schema:update --force
Pagination
In the home view of the blog I should list all the blog posts. I want to limit to 3 per page an have buttons to navigate though posts.
The path should have a parameter "currentPage" which can be optional, and the default value is 1:
CPANABasicBlogBundle_homepage:
pattern: /blog/{currentPage}
defaults: { _controller: CPANABasicBlogBundle:Blog:blogHome, currentPage: 1 }
requirements:
_method: GET
currentPage: \d+
--------------
Modify the repository as seen here - http://anil.io/post/41/symfony-2-and-doctrine-pagination-with-twig:
public function getAllPosts($currentPage = 1)
{
// Create our query
$query = $this->createQueryBuilder('p')
->orderBy('p.created', 'DESC')
->getQuery();
$paginator = $this->paginate($query, $currentPage);
return $paginator;
}
public function paginate($dql, $page = 1, $limit = 3)
{
$paginator = new Paginator($dql);
$paginator->getQuery()
->setFirstResult($limit * ($page - 1)) // Offset
->setMaxResults($limit); // Limit
return $paginator;
}
----------------------------------------------------
In controller retrieve posts and pass them to view
public function blogHomeAction($currentPage=1)
{
$em = $this->getDoctrine()
->getEntityManager();
$posts = $em->getRepository('CPANABasicBlogBundle:Blog')
->getAllPosts($currentPage);
$iterator=$posts->getIterator();
$limit = 3;
$maxPages = ceil($posts->count()/$limit);
$thisPage = $currentPage;
return $this->render(
'CPANABasicBlogBundle:Blog:home.html.twig', array(
'blogs' => $iterator,
'maxPages'=>$maxPages,
'thisPage' => $thisPage,
)
);
In template showing the posts is the same we just need to add pagination buttons:
This will look nice with some css :)
{% if maxPages > 1 %}
<ul>
{%if thisPage > 1 %}
<li >
<a href="{{ path('CPANABasicBlogBundle_homepage', {currentPage: thisPage-1 < 1 ? 1 : thisPage-1}) }}">«</a>
</li>
{% endif %}
{# Render each page number #}
{% for i in 1..maxPages %}
<li>
<a href="{{ path('CPANABasicBlogBundle_homepage', {currentPage: i}) }}">{{ i }}</a>
</li>
{% endfor %}
{# `»` arrow #}
{%if thisPage < maxPages %}
<li>
<a href="{{ path('CPANABasicBlogBundle_homepage', {currentPage: thisPage+1 <= maxPages ? thisPage+1 : thisPage}) }}">»</a>
</li>
{% endif %}
</ul>
{% endif %}
The photo should not be a mandatory information. I had to do the following modifications to implement that:
Add in controller to the form builder 'required' => false :
->add('image', 'file', array('mapped'=>false,'required' => false,))
Also in controller handle new uploaded file name and path only if it was any file selected in the form:
if (!is_null($form['image']->getData())) {....}
modify the Entity/Blog.php to accept NULL values for image field.
* @ORM\Column(type="string", length=255, nullable=true)
Update database using console command.
php app/console cache:clear
php app/console doctrine:schema:update --force
Fine tuning - allow deleting blog posts even if they have comments
While browsing happily and testing the functionality I discovered I cannot delete an article having comments, receiving some nasty error: "SQLSTATE[23000]: Integrity constraint violation: 1451 Cannot delete or update a parent row: a foreign key constraint fails ..."
I believe it should be good that an admin to be able to delete an article even if it has comments added to it. So I will modify the Database structure to allow this behavior.
There are two kinds of cascades in Doctrine:
1) ORM level - uses cascade={"remove"} in the association - this is a calculation that is done in the UnitOfWork and does not affect the database structure. When you remove an object, the UnitOfWork will iterate over all objects in the association and remove them.
2) Database level - uses onDelete="CASCADE" on the association's joinColumn - this will add On Delete Cascade to the foreign key column in the database:
@ORM\JoinColumn(name="father_id", referencedColumnName="id", onDelete="CASCADE")
Update the Entity/Comment.php
/**
* @ORM\ManyToOne(targetEntity="Blog", inversedBy="comments")
* @ORM\JoinColumn(name="blog_id", referencedColumnName="id", onDelete="CASCADE")
*/
protected $blog;
Update the database using console:
php app/console cache:clear
php app/console doctrine:schema:update --force
I will soon add the BasicBlogBundle on Github and Packagist.
Frontside
- view all blog posts with pagination
- view individual blog posts
- add comments
Admin
- view a list of all blog posts with Edit and Delete options.
- view the list of comments with options to Approve/Unapprove or Delete.
Adding comments form
In the Symblog tutorial there was a add comment functionality but for me didn't worked throwing an error like "Catchable Fatal Error: Object of class XYZ could not be converted to string in Doctrine\DBAL\Statement.php" ( see this post about it ). To solve the issue I've added to Entity\Blog.php the following function:
public function __toString()
{
return strval($this->id);
}
Also I modified the CommentType.php to make all the comments unapproved initially:
// \src\CPANA\BasicBlogBundle\Form\CommentType.php
public function buildForm(FormBuilderInterface $builder, array $options)
{
$builder
->add('user')
->add('comment')
->add('approved','hidden', array('data' => '0',))
;
}
Uploading photos
What I want to implement: upload photo, copy the file in a specific path and save the name of the file on the databaseMake sure you are pointing to the right path in the template. In src\CPANA\BasicBlogBundle\Resources\views\Blog\show.html.twig:
<img src="{{ asset(['bundles/basicblogbundle/images/', blog.image]|join) }}" alt="{{ blog.title }} image not found" />
At this path: 'bundles/basicblogbundle/images/' I should upload the files in the controller.
Make sure to indicate that the "file" field is not mapped to the Entity.
->add('image', 'file', array('mapped'=>false))
Upload photo and save in database only the name
------------------------------------------------
if ($form->isValid()) {
$newFilename = $form['attachment']->getData()->getClientOriginalName();
// Handle picture upload process
$uploadDir=dirname($this->container->getParameter('kernel.root_dir')) . '/web/bundles/basicblogbundle/images/';
$form['image']->getData()->move($uploadDir,$newFilename);
// End of upload
$blog->setImage($newFilename);
$em = $this->getDoctrine()->getManager();
$em->persist($blog);
$em->flush();
This works fine but we should make sure the file names are unique so they do not conflict when you try to upload a file with same name.
We should add random string function in a class. I do no think this should be considered a service, so I will not register it as a service in the Dependency Injection container.
http://symfony.com/doc/current/best_practices/business-logic.html
Create an Utils folder. Place there RandomString.php, add a static function: randomStr
namespace CPANA\BasicBlogBundle\Utils;
class RandomString
{
public static function randomStr($length = 10)
{
$characters = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ';
$charactersLength = strlen($characters);
$randomString = '';
for ($i = 0; $i < $length; $i++) {
$randomString .= $characters[rand(0, $charactersLength - 1)];
}
return $randomString;
}
After this include the randomStr in the fileName:
$newFilename =RandomString::randomStr() . $form['image']->getData()->getClientOriginalName();
---------------------------
when testing the new feature I noticed that the photo is not available when browsing the blog, reason: the name included in the template is trimmed. I looked in the database , in the "image" column, same there. Checking the type of column I noticed the column is set to varchar(20)!!!! that's the problem right there.
Solution:
modify in Entity\Blog.php the ORM annotation for $image from
@ORM\Column(type="string", length=20)
to
@ORM\Column(type="string", length=255)
After this update the DB schema using Symfony 2 command line:
php app/console cache:clear
php app/console doctrine:schema:update --force
Pagination
In the home view of the blog I should list all the blog posts. I want to limit to 3 per page an have buttons to navigate though posts.
The path should have a parameter "currentPage" which can be optional, and the default value is 1:
CPANABasicBlogBundle_homepage:
pattern: /blog/{currentPage}
defaults: { _controller: CPANABasicBlogBundle:Blog:blogHome, currentPage: 1 }
requirements:
_method: GET
currentPage: \d+
--------------
Modify the repository as seen here - http://anil.io/post/41/symfony-2-and-doctrine-pagination-with-twig:
public function getAllPosts($currentPage = 1)
{
// Create our query
$query = $this->createQueryBuilder('p')
->orderBy('p.created', 'DESC')
->getQuery();
$paginator = $this->paginate($query, $currentPage);
return $paginator;
}
public function paginate($dql, $page = 1, $limit = 3)
{
$paginator = new Paginator($dql);
$paginator->getQuery()
->setFirstResult($limit * ($page - 1)) // Offset
->setMaxResults($limit); // Limit
return $paginator;
}
----------------------------------------------------
In controller retrieve posts and pass them to view
public function blogHomeAction($currentPage=1)
{
$em = $this->getDoctrine()
->getEntityManager();
$posts = $em->getRepository('CPANABasicBlogBundle:Blog')
->getAllPosts($currentPage);
$iterator=$posts->getIterator();
$limit = 3;
$maxPages = ceil($posts->count()/$limit);
$thisPage = $currentPage;
return $this->render(
'CPANABasicBlogBundle:Blog:home.html.twig', array(
'blogs' => $iterator,
'maxPages'=>$maxPages,
'thisPage' => $thisPage,
)
);
In template showing the posts is the same we just need to add pagination buttons:
This will look nice with some css :)
{% if maxPages > 1 %}
<ul>
{%if thisPage > 1 %}
<li >
<a href="{{ path('CPANABasicBlogBundle_homepage', {currentPage: thisPage-1 < 1 ? 1 : thisPage-1}) }}">«</a>
</li>
{% endif %}
{# Render each page number #}
{% for i in 1..maxPages %}
<li>
<a href="{{ path('CPANABasicBlogBundle_homepage', {currentPage: i}) }}">{{ i }}</a>
</li>
{% endfor %}
{# `»` arrow #}
{%if thisPage < maxPages %}
<li>
<a href="{{ path('CPANABasicBlogBundle_homepage', {currentPage: thisPage+1 <= maxPages ? thisPage+1 : thisPage}) }}">»</a>
</li>
{% endif %}
</ul>
{% endif %}
The photo should not be a mandatory information. I had to do the following modifications to implement that:
Add in controller to the form builder 'required' => false :
->add('image', 'file', array('mapped'=>false,'required' => false,))
Also in controller handle new uploaded file name and path only if it was any file selected in the form:
if (!is_null($form['image']->getData())) {....}
modify the Entity/Blog.php to accept NULL values for image field.
* @ORM\Column(type="string", length=255, nullable=true)
Update database using console command.
php app/console cache:clear
php app/console doctrine:schema:update --force
Fine tuning - allow deleting blog posts even if they have comments
While browsing happily and testing the functionality I discovered I cannot delete an article having comments, receiving some nasty error: "SQLSTATE[23000]: Integrity constraint violation: 1451 Cannot delete or update a parent row: a foreign key constraint fails ..."
I believe it should be good that an admin to be able to delete an article even if it has comments added to it. So I will modify the Database structure to allow this behavior.
There are two kinds of cascades in Doctrine:
1) ORM level - uses cascade={"remove"} in the association - this is a calculation that is done in the UnitOfWork and does not affect the database structure. When you remove an object, the UnitOfWork will iterate over all objects in the association and remove them.
2) Database level - uses onDelete="CASCADE" on the association's joinColumn - this will add On Delete Cascade to the foreign key column in the database:
@ORM\JoinColumn(name="father_id", referencedColumnName="id", onDelete="CASCADE")
Update the Entity/Comment.php
/**
* @ORM\ManyToOne(targetEntity="Blog", inversedBy="comments")
* @ORM\JoinColumn(name="blog_id", referencedColumnName="id", onDelete="CASCADE")
*/
protected $blog;
Update the database using console:
php app/console cache:clear
php app/console doctrine:schema:update --force
I will soon add the BasicBlogBundle on Github and Packagist.
Wednesday, September 23, 2015
Thursday, September 10, 2015
Symfony 2 Authentication and FOSUserBundle
It was easier than I expected, but there are some small pieces of information missing in the documentation which can make you lose time on StackOverflow :P.
I have a fresh installation of Symfony Framework 2.8 DEV Standard Edition. I've added Bootstap to my template by directly downloading the files locally and including them in base template.
Go to: http://getbootstrap.com/getting-started
Click Download Bootstrap to download latest compiled Bootstrap files.
Uncompress the downloaded .zip file. We have three folders:
css
js
fonts
Put them all into the public folder of your app, should be called "web"
In the <head> of the main template (base.html.twig found under "..\symfony\app\Resources\views\base.twig.html") the following should be added in order to use Bootstrap framework features:
{% block stylesheets %}
<link href="//maxcdn.bootstrapcdn.com/bootstrap/3.3.2/css/bootstrap.min.css" rel="stylesheet">
<!-- Include roboto.css to use the Roboto web font, material.css to include the theme and ripples.css to style the ripple effect -->
<link href="{{ asset('/css/roboto.min.css') }}" rel="stylesheet">
<link href="{{ asset('/css/material.min.css') }}" rel="stylesheet">
<link href="{{ asset('/css/ripples.min.css') }}" rel="stylesheet">
{% endblock %}
Also before </body> it should be added a javascript Twig block:
{% block javascripts %}
<script src="//code.jquery.com/jquery-1.10.2.min.js"></script>
<script src="//maxcdn.bootstrapcdn.com/bootstrap/3.3.2/js/bootstrap.min.js"></script>
<script src="{{ asset('/js/ripples.min.js') }}"></script>
<script src="{{ asset('/js/material.min.js') }}"></script>
<script>
$(document).ready(function() {
// This command is used to initialize some elements and make them work properly
$.material.init();
});
</script>
{% endblock %}
</body>
Inside the <body> tag I added a navigation bar ( I've seen this on this tutorial : http://laravel.com/docs/5.1/installation#basic-configuration):
<!-- Navigation bar at the top of all pages -->
<nav class="navbar navbar-default">
<div class="container-fluid">
<!-- Brand and toggle get grouped for better mobile display -->
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="/"> Symfony 2.8 website</a>
</div>
<!-- Navbar Right -->
<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
<ul class="nav navbar-nav navbar-right">
<li class="active"><a href="/">Home</a></li>
<li><a href="/about">About</a></li>
<li><a href="/users">Users</a></li>
<li><a href="/contact">Contact</a></li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Member <span class="caret"></span></a>
<ul class="dropdown-menu" role="menu">
<li><a href="/register">Register</a></li>
<li><a href="/login">Login</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
---------------------------------------------------------------------------------------------------------------------------
------------------------------------------- Getting Started With FOSUserBundle ------------------
----------------------------------------------------------------------------------------------------------------------------
Documentation:
https://symfony.com/doc/master/bundles/FOSUserBundle/index.html
Followed the 7 steps described in documentation. You should do those in parallel with the below notes.
Download FOSUserBundle using composer
Enable the Bundle
Create your User class
Configure your application's security.yml
Configure the FOSUserBundle
Import FOSUserBundle routing
Update your database schema
-------------------------------------------------------------------------------------------------------------------------
http://stackoverflow.com/questions/19677807/symfony-understanding-super-admin
-------------------------------------------------------------------------------------------------------------------------
Make sure your security.yml contains:
security:
encoders:
FOS\UserBundle\Model\UserInterface: bcrypt
role_hierarchy:
ROLE_ADMIN: ROLE_USER
ROLE_SUPER_ADMIN: ROLE_ADMIN
providers:
fos_userbundle:
id: fos_user.user_provider.username
firewalls:
main:
pattern: ^/
form_login:
provider: fos_userbundle
csrf_provider: security.csrf.token_manager
logout: true
anonymous: true
access_control:
- { path: ^/login$, role: IS_AUTHENTICATED_ANONYMOUSLY }
- { path: ^/register, role: IS_AUTHENTICATED_ANONYMOUSLY }
- { path: ^/resetting, role: IS_AUTHENTICATED_ANONYMOUSLY }
- { path: ^/admin/, role: ROLE_ADMIN }
- { path: ^/user/, role: ROLE_USER }
-------------------------------------------------------------------------------------------------
http://symfony.com/doc/current/bundles/FOSUserBundle/command_line_tools.html
Create a super-admin user from command line:
php app/console fos:user:create admin admin@test.com 1234 --super-admin
Create a normal user:
php app/console fos:user:create regularuser regular@test.com 1234
Make an UserController which will have a path for /admin/{name} and /user/{name}
/**
* @Route("/user/{name}")
*/
public function indexAction($name)
{
return $this->render('AppBundle:User:userhome.html.twig',array('name' => $name));
}
/**
* @Route("/admin/{name}")
* @Template()
*/
public function indexAdminAction($name)
{
return $this->render('AppBundle:User:adminhome.html.twig');
}
And also you should add templates for each of them at "symfony\src\AppBundle\Resources\views\User\"
Now you can put in your browser http://<your_virtual_host>/user/YourName
You should be redirected to a login page. Login with regularuser and you will be redirected to home page
----------------------------------------------------------------------------------------------------------------------------
-------------------------------- Override templates ------------------------------------------------------------
----------------------------------------------------------------------------------------------------------------------------
Documentation:
https://symfony.com/doc/master/bundles/FOSUserBundle/overriding_templates.html
To override the layout template located at Resources/views/layout.html.twig in the FOSUserBundle directory, you would place your new layout template at app/Resources/FOSUserBundle/views/layout.html.twig.
As you can see the pattern for overriding templates in this way is to create a folder with the name of the bundle class in the app/Resources directory. Then add your new template to this folder, preserving the directory structure from the original bundle.
----------------------------------------------------------------------------------------------------------------------------
------ Adding new fields to the User object/ Overriding Default FOSUserBundle Forms -----------
----------------------------------------------------------------------------------------------------------------------------
https://symfony.com/doc/master/bundles/FOSUserBundle/overriding_forms.html
Following the instructions in the documentation I created the file \src\AppBundle\Entity\User.php
Make sure to add the below line in Entity\User.php
use Symfony\Component\Validator\Constraints as Assert;
I added two new properties:
/**
* @ORM\Column(type="string", length=255)
*
* @Assert\NotBlank(message="Please enter your name.", groups={"Registration", "Profile"})
* @Assert\Length(
* min=3,
* max=255,
* minMessage="The name is too short.",
* maxMessage="The name is too long.",
* groups={"Registration", "Profile"}
* )
*/
protected $name;
/**
* @ORM\Column(type="string", length=255)
*
* @Assert\NotBlank(message="Please enter your last name.", groups={"Registration", "Profile"})
* @Assert\Length(
* min=3,
* max=255,
* minMessage="The name is too short.",
* maxMessage="The name is too long.",
* groups={"Registration", "Profile"}
* )
*/
protected $last_name;
Use command line to automatically generate getters and setters for your new fields:
php app/console doctrine:generate:entities AppBundle
After this update the DB using Doctrine command line:
php app/console doctrine:schema:update --force
Make sure to add the new service in services.yml:
services:
# service_name:
# class: AppBundle\Directory\ClassName
# arguments: ["@another_service_name", "plain_value", "%parameter_name%"]
app.form.registration:
class: AppBundle\Form\RegistrationType
tags:
- { name: form.type, alias: app_user_registration }
Now you should be able to register a new user
----------------------------------------------------------------------------------------------------------------------------
----------------------------------------------- Handling the log out --------------------------------------------
----------------------------------------------------------------------------------------------------------------------------
Modify the base.html.twig template which contains buttons for login and register. Verify if the user is logged and if it is, display only Logout button:
{% if app.user %}
# user is logged in
<li><a href="/logout">Logout</a></li>
{% else %}
# user is not logged in
<li><a href="/register">Register</a></li>
<li><a href="/login">Login</a></li>
{% endif %}
----------------------------------------------------------------------------------------------------------------------------
-------------------- Show hello "Name Last name" of the logged user ------------------------------------
----------------------------------------------------------------------------------------------------------------------------
After login the user is redirected to the home page. Let's modify the template in order to show
Hello "Name Last name"!
{% if app.user %}
<h3 class="text-center margin-top-100 editContent">
Home page. Welcome {{ app.user.name }} {{ app.user.lastname }} !
</h3>
{% else %}
<h3 class="text-center margin-top-100 editContent">Home page. Welcome! </h3>
{% endif %}
"name" and "lastname" are two properties added by me to the AppBundle\Entity\User.php class. In fact I added "last_name" in User.php but Doctrine made a setter and getter for "lastname": getLastName.
-----------------------------------------------------------------------------------------------------------------------------
------------------------------ FOSUserBundle form labels --------------------------------------------------
-----------------------------------------------------------------------------------------------------------------------------
You could see some weird labels in the login and registation forms. You can make them all disappear by turning on Internationalization (translator service).
This is very simple, have a look on the official documentation: http://symfony.com/doc/current/best_practices/i18n.html
Uncomment the following translator configuration option and set your application locale
# app/config/config.yml
framework:
# ...
translator: { fallbacks: ["%locale%"] }
# app/config/parameters.yml
parameters:
# ...
locale: en
After this you can check the Login page to see the results.
---------------------------------------------------------------------------------------------------------------------
How to overwrite fos user bundle form labels?
You can read the answer on StackOverflow: http://stackoverflow.com/questions/13473329/how-to-overwrite-fos-user-bundle-form-labels or here: "Copy/paste vendor/friendsofsymfony/user-bundle/FOS/UserBundle/Resources/translations/FOSUserBundle.xx.yml files in your app/Resources/FOSUserBundle/translations directory (with the same directory structure and the same file name) and redefine translations to your convenience."
Tuesday, September 8, 2015
Build a blog bundle with Symfony 2 - Symblog tutorial errors/deprecated functions
Symblog tutorial ( http://tutorial.symblog.co.uk/ ) is one of the best I found about developing and testing a Symfony 2 bundle.
But is not all perfect, some of the function used in the tutorial are deprecated and will not work.
I found another blog were some of the issues are solved:
http://donna-oberes.blogspot.com/2013/09/symfony-2-symblog-tutorial-errors.html
Please see below a list comments that you help you finish the tutorial successfully.
I hope this blog post will help some fellows lost in the path of learning Symfony 2.
1. In controller repalce "bindRequest()" deprecated function with "bind()"
public function contactAction()
{
$enquiry = new Enquiry();
$form = $this->createForm(new EnquiryType(), $enquiry);
$request = $this->getRequest();
if ($request->getMethod() == 'POST') {
$form->bind($request);
2. I stoled this from a comment on the Symblog website:
FYI for symfony2.3 (and 2.4) users:
{% if app.session.hasFlash('blogger-notice') %}
<div class="blogger-notice">
{{ app.session.flash('blogger-notice') }}
</div>
{% endif %}
needs to be changed to
{% for flashMessage in app.session.flashbag.get('blogger-notice') %}
<div class="blogger-notice">
{{ flashMessage }}
</div>
{% endfor %}
Also you need to change the “setFlash” in PageController to call “getFlashBag()->add”
3. Doctrine basic usage in official documentation:
http://symfony.com/doc/current/book/doctrine.html
4. In BlogController:
DEPRECATED - getEntityManager is deprecated since Symfony 2.1. Use getManager instead
Change path to images in show.htmltwig. it should point to specific bundle folder in the public "web" folder:
<img src="{{ asset(['bundles/bloggerblog/images/', blog.image]|join) }}
5. Doctrine migrations
http://symfony.com/doc/current/bundles/DoctrineMigrationsBundle/index.html
$ composer require doctrine/doctrine-migrations-bundle "^1.0"
In AppKernel.php you need to change this
new Symfony\Bundle\DoctrineMigrationsBundle\DoctrineMigrationsBundle() //old path
with this
new Doctrine\Bundle\MigrationsBundle\DoctrineMigrationsBundle()
----------------------------------------------------------------------------------------------------------
Some errors messages that may make you land on this page:
But is not all perfect, some of the function used in the tutorial are deprecated and will not work.
I found another blog were some of the issues are solved:
http://donna-oberes.blogspot.com/2013/09/symfony-2-symblog-tutorial-errors.html
Please see below a list comments that you help you finish the tutorial successfully.
I hope this blog post will help some fellows lost in the path of learning Symfony 2.
1. In controller repalce "bindRequest()" deprecated function with "bind()"
public function contactAction()
{
$enquiry = new Enquiry();
$form = $this->createForm(new EnquiryType(), $enquiry);
$request = $this->getRequest();
if ($request->getMethod() == 'POST') {
$form->bind($request);
2. I stoled this from a comment on the Symblog website:
FYI for symfony2.3 (and 2.4) users:
{% if app.session.hasFlash('blogger-notice') %}
<div class="blogger-notice">
{{ app.session.flash('blogger-notice') }}
</div>
{% endif %}
needs to be changed to
{% for flashMessage in app.session.flashbag.get('blogger-notice') %}
<div class="blogger-notice">
{{ flashMessage }}
</div>
{% endfor %}
Also you need to change the “setFlash” in PageController to call “getFlashBag()->add”
3. Doctrine basic usage in official documentation:
http://symfony.com/doc/current/book/doctrine.html
4. In BlogController:
DEPRECATED - getEntityManager is deprecated since Symfony 2.1. Use getManager instead
Change path to images in show.htmltwig. it should point to specific bundle folder in the public "web" folder:
<img src="{{ asset(['bundles/bloggerblog/images/', blog.image]|join) }}
5. Doctrine migrations
http://symfony.com/doc/current/bundles/DoctrineMigrationsBundle/index.html
$ composer require doctrine/doctrine-migrations-bundle "^1.0"
In AppKernel.php you need to change this
new Symfony\Bundle\DoctrineMigrationsBundle\DoctrineMigrationsBundle() //old path
with this
new Doctrine\Bundle\MigrationsBundle\DoctrineMigrationsBundle()
----------------------------------------------------------------------------------------------------------
Some errors messages that may make you land on this page:
FatalErrorException: Error: Call to undefined method
Symfony\Component\Form\Form::bindRequest() in
/path/to/root/src/Blogger/BlogBundle/Controller/PageController.php
FatalErrorException: Error: Class
'Symfony\Component\Validator\Constraints\MaxLength' not found in
/path/to/root/src/Blogger/BlogBundle/Entity/Enquiry.php
Sunday, September 6, 2015
PHP login to another website with Goutte
I needed a break from all these frameworks and design patterns and code something which would solve me some immediate problem => bring immediate satisfaction.
Task: login to a website, access certain page, check if that page was updated, let me know via email.
After searching the web a little I found Goutte (https://github.com/FriendsOfPHP/Goutte), another library from Fabien Potencier.
My composer.json looks like this:
{
"require": {
"fabpot/goutte": "^3.1",
"swiftmailer/swiftmailer": "@stable"
}
}
require_once __DIR__.'/vendor/autoload.php';
require_once 'private.php'; //I store users and passwords in an external file
use Goutte\Client;
// make a real request to an external site
$client = new Client();
$crawler = $client->request('GET', "http://www.testwebsite.com/login");
// select the form and fill in some values
$form = $crawler->selectButton('Login')->form();
$form['login-username'] = $odds_user;
$form['login-password'] = $odds_pass;
// submit that form
$crawler = $client->submit($form);
$crawler = $client->request('GET', "http://www.testwebsite.com/somepage");
//extract data
$table_main = $crawler->filterXPath('//table[@class="some-class"]');
//---------------------------- Email configuration -----------------------------------------
// Create the Transport
$transporter = Swift_SmtpTransport::newInstance('smtp.gmail.com', 465, 'ssl')
->setUsername($email_user)
->setPassword($email_pass);
// Create the Mailer using your created Transport
$mailer = Swift_Mailer::newInstance($transporter);
2.2. Check if the size of the table filtered is the same as the previous size saved on disk in the file "previous_size.txt". If not then send email
$mail_content=$table_main->text();
$size=strlen($mail_content);
$old_value = file_get_contents('previous_size.txt');
//replace old value with new size and send me email
if ($old_value!=$size) {
file_put_contents('previous_size.txt',$size);
// Create the message
$message = Swift_Message::newInstance()
// Give the message a subject
->setSubject('New bet')
// Set the From address with an associative array
->setFrom(array('youremail@gmail.com' => 'Script'))
// Set the To addresses with an associative array
->setTo(array('personalemail@yahoo.com' => 'CPana'))
// Give it a body
->setBody($mail_content)
// And optionally an alternative body
->addPart('<q>' . $mail_content .'</q>', 'text/html')
;
// Send the message
$result = $mailer->send($message);
}
Task: login to a website, access certain page, check if that page was updated, let me know via email.
After searching the web a little I found Goutte (https://github.com/FriendsOfPHP/Goutte), another library from Fabien Potencier.
My composer.json looks like this:
{
"require": {
"fabpot/goutte": "^3.1",
"swiftmailer/swiftmailer": "@stable"
}
}
1. Login to website and access certain page:
require_once __DIR__.'/vendor/autoload.php';
require_once 'private.php'; //I store users and passwords in an external file
use Goutte\Client;
// make a real request to an external site
$client = new Client();
$crawler = $client->request('GET', "http://www.testwebsite.com/login");
// select the form and fill in some values
$form = $crawler->selectButton('Login')->form();
$form['login-username'] = $odds_user;
$form['login-password'] = $odds_pass;
// submit that form
$crawler = $client->submit($form);
$crawler = $client->request('GET', "http://www.testwebsite.com/somepage");
//extract data
$table_main = $crawler->filterXPath('//table[@class="some-class"]');
2. Check if page was updated and notify by email
2.1 First configure SwiftMailer to work with your gmail account://---------------------------- Email configuration -----------------------------------------
// Create the Transport
$transporter = Swift_SmtpTransport::newInstance('smtp.gmail.com', 465, 'ssl')
->setUsername($email_user)
->setPassword($email_pass);
// Create the Mailer using your created Transport
$mailer = Swift_Mailer::newInstance($transporter);
2.2. Check if the size of the table filtered is the same as the previous size saved on disk in the file "previous_size.txt". If not then send email
$mail_content=$table_main->text();
$size=strlen($mail_content);
$old_value = file_get_contents('previous_size.txt');
//replace old value with new size and send me email
if ($old_value!=$size) {
file_put_contents('previous_size.txt',$size);
// Create the message
$message = Swift_Message::newInstance()
// Give the message a subject
->setSubject('New bet')
// Set the From address with an associative array
->setFrom(array('youremail@gmail.com' => 'Script'))
// Set the To addresses with an associative array
->setTo(array('personalemail@yahoo.com' => 'CPana'))
// Give it a body
->setBody($mail_content)
// And optionally an alternative body
->addPart('<q>' . $mail_content .'</q>', 'text/html')
;
// Send the message
$result = $mailer->send($message);
}
Subscribe to:
Posts (Atom)