forked from https://github.com/symfony/symfony

This repository has been archived on 2023-08-20. You can view files and clone it, but cannot push or open issues or pull requests.

Go to file

Fabien Potencier 741859dc47 merged branch canni/user_comparable_interface2 (PR #2927 ) Commits ------- `e23d452` Add info about BC Break to CHANGELOG-2.1 `d7ffeb5` Add some more tests, and enforce boolean return value of interface implementations. `9d3a49f` When method name is `hasUserChanged` the return boolean should be true (to match question semantics) and false when user has not changed, this commits inverts return statements. `c57b528` Add note about `AdvancedUserInterface`. `3682f62` Refactor `isUserChanged` to `hasUserChanged` `56db4a1` Change names to Equatable `680b108` Suggested fixes ;) `9386583` [BC Break][Security] Moved user comparsion logic out of UserInterface As discussed on IRC meetings and in PR #2669 I came up with implementation. This is option2, I think more elegant. Discussion ---------- [BC Break][Security][Option2] Moved user comparsion logic out of UserInterface As discussed on IRC meetings and in PR #2669 I came up with implementation. This is option2, I think more elegant. BC break: yes Feature addition: no/feature move Symfony2 test pass: yes Symfony2 test written: yes Todo: decide about naming [![Build Status](https://secure.travis-ci.org/canni/symfony.png)](http://travis-ci.org/canni/symfony) --------------------------------------------------------------------------- by schmittjoh at 2011-12-19T19:33:24Z This looks much better than the previous PR. Thanks! One thing, we also discussed this on Doctrine, the name "comparable" is used in most programming languages to perform a real compare operation that is ">", "<", or "=". In this case though, we are specifically interested in equality of two objects (we cannot establish a natural order between these objects). Java has no such interface as all objects naturally have an equals() method, .NET uses "Equatable" which looks a bit odd. Not sure if there are better names. --------------------------------------------------------------------------- by canni at 2011-12-19T19:34:52Z I think this is best of "both worlds" we have nice full-featured implementation suitable for most, and if someone needs advanced compare logic just implements interface. @stof @schmittjoh, what do you think? --------------------------------------------------------------------------- by stof at 2011-12-19T19:36:55Z @canni I already commented on the code, and I agree with @schmittjoh that the naming can be confusing --------------------------------------------------------------------------- by jmikola at 2011-12-20T17:33:22Z I don't mean to bikeshed, but I strongly agree with @schmittjoh about implications of "compare". I'm not concerned with the interface name so much as I am with `compareUser()`. Given that this method returns a boolean, I think it's best to prefix it with `is` (e.g. `isSameUser`, `isUserEqualTo`) or `equals` (e.g. `equalsUser`). In this PR, the Token class is implementing the interface, so I think having "User" in the method name is a good idea. Naturally, if the interface was intended for User classes, we could do without it. --------------------------------------------------------------------------- by canni at 2011-12-20T19:00:00Z @jmikola in this PR Token class does not implement any additional interface, and `compareUser` is `private` and used internally. I don't stand still after this names, I'll update PR as soon as some decision about naming will be done. --------------------------------------------------------------------------- by jmikola at 2011-12-21T02:29:59Z @canni: My mistake, I got confused between the Token method and interface method, which you've since renamed in canni/symfony@fcfcd1087b. --------------------------------------------------------------------------- by mvrhov at 2011-12-21T06:09:45Z hm. Now I'm going to bike shed. Wouldn't the proper function name be hasUserChanged? --------------------------------------------------------------------------- by stof at 2011-12-21T10:58:38Z it would probably be bettter. The meaning of ``true`` and ``false`` would then be the opposite of the current ones but this is not an issue IMO as it is a different method --------------------------------------------------------------------------- by jstout24 at 2011-12-27T18:08:49Z @canni nice job --------------------------------------------------------------------------- by fabpot at 2011-12-30T14:59:11Z The method `isUserChanged()` must be rename. What about `hasUserChanged()` as @mvrhov suggested or `isUserDifferent()`? --------------------------------------------------------------------------- by canni at 2012-01-02T11:44:05Z @fabpot done. --------------------------------------------------------------------------- by fabpot at 2012-01-02T18:13:40Z The only missing thing I can think of is adding some unit tests. --------------------------------------------------------------------------- by canni at 2012-01-10T20:16:25Z @fabpot is there anything more you think that should done in this PR? --------------------------------------------------------------------------- by stof at 2012-01-10T20:38:46Z @canni can you rebase your branch ? it conflicts with the current master according to github --------------------------------------------------------------------------- by canni at 2012-01-10T20:56:55Z @stof done. --------------------------------------------------------------------------- by fabpot at 2012-01-12T18:06:00Z @canni: Can you just add some information in the CHANGELOG and in the UPGRADE file? That's all I need to merge this PR now. Thanks a lot. --------------------------------------------------------------------------- by canni at 2012-01-12T18:16:32Z @fabpot done, and no problem :)		2012-01-12 19:26:40 +01:00
src/Symfony	merged branch canni/user_comparable_interface2 (PR #2927 )	2012-01-12 19:26:40 +01:00
tests	merged branch canni/user_comparable_interface2 (PR #2927 )	2012-01-12 19:26:40 +01:00
.gitignore	Added vendor directory to .gitignore	2010-06-24 10:44:28 +02:00
.travis.yml	also test PHP 5.3.2, since this is the official lowest supported PHP version	2011-12-26 01:15:21 +01:00
CHANGELOG-2.0.md	updated CHANGELOG for 2.0.9	2012-01-06 07:48:27 +01:00
CHANGELOG-2.1.md	Add info about BC Break to CHANGELOG-2.1	2012-01-12 19:15:35 +01:00
CONTRIBUTORS.md	update CONTRIBUTORS for 2.0.9	2012-01-06 07:49:05 +01:00
LICENSE	added the LICENSE file for the YAML component	2011-02-18 11:52:11 +01:00
README.md	set travis-ci icon to master	2011-11-23 11:36:09 +01:00
UPGRADE-2.1.md	Added another "before" possibility to retrieve the locale from a Twig template.	2011-10-22 11:23:43 +02:00
autoload.php.dist	fixed autoloader when tests are run on a machine without intl installed	2011-07-20 14:27:10 +02:00
check_cs	[Check CS] don't replace 'else if' on twig files (closes #2961 )	2011-12-27 16:10:32 +01:00
composer.json	Revert "merged 2.0"	2012-01-08 20:43:02 +01:00
phpunit.xml.dist	[Security] cleaned up opt-in to benchmark test	2011-03-06 20:06:13 +01:00
vendors.php	updated Twig to 1.5.1 to fix a regression	2012-01-05 16:02:00 +01:00

README.md

README

What is Symfony2?

Symfony2 is a PHP 5.3 full-stack web framework. It is written with speed and flexibility in mind. It allows developers to build better and easy to maintain websites with PHP.

Symfony can be used to develop all kind of websites, from your personal blog to high traffic ones like Dailymotion or Yahoo! Answers.

Requirements

Symfony2 is only supported on PHP 5.3.2 and up.

Installation

The best way to install Symfony2 is to download the Symfony Standard Edition available at http://symfony.com/download.

Documentation

The "Quick Tour" tutorial gives you a first feeling of the framework. If, like us, you think that Symfony2 can help speed up your development and take the quality of your work to the next level, read the official Symfony2 documentation.

Contributing

Symfony2 is an open source, community-driven project. If you'd like to contribute, please read the Contributing Code part of the documentation. If you're submitting a pull request, please follow the guidelines in the Submitting a Patch section.