Issues

ZF-7335: Multiple files in library/ or in tests/ don't have the svn:keywords=id

Issue Type: Coding Standards Violation Created: 2009-07-21T04:38:47.000+0000 Last Updated: 2010-03-18T07:56:33.000+0000 Status: Resolved Fix version(s): - 1.10.0 (27/Jan/10)

Reporter: Mickael Perraud (mikaelkael) Assignee: Mickael Perraud (mikaelkael) Tags: - Zend_Acl

  • Zend_Amf
  • Zend_Application
  • Zend_Auth
  • Zend_Auth_Adapter_Ldap
  • Zend_Auth_Adapter_OpenId
  • Zend_Cache
  • Zend_Captcha
  • Zend_CodeGenerator
  • Zend_Config
  • Zend_Config_Writer
  • Zend_Console_Getopt
  • Zend_Controller
  • Zend_Crypt
  • Zend_Db
  • Zend_Db_Adapter_Db2
  • Zend_Db_Adapter_Mysqli
  • Zend_Db_Adapter_Oracle
  • Zend_Db_Profiler
  • Zend_Db_Select
  • Zend_Db_Table
  • Zend_Debug
  • Zend_Dojo
  • Zend_Dom_Query
  • Zend_Feed
  • Zend_Feed_Reader
  • Zend_File_Transfer
  • Zend_Filter
  • Zend_Filter_Inflector
  • Zend_Filter_Input
  • Zend_Form
  • Zend_Gdata
  • Zend_Http_Client
  • Zend_Http_Cookie
  • Zend_Http_CookieJar
  • Zend_Http_Response
  • Zend_Http_Server
  • Zend_InfoCard
  • Zend_Json
  • Zend_Json_Server
  • Zend_Layout
  • Zend_Ldap
  • Zend_Loader
  • Zend_Locale
  • Zend_Log
  • Zend_Mail
  • Zend_Mail_Storage
  • Zend_Measure
  • Zend_Memory
  • Zend_Mime
  • Zend_Navigation
  • Zend_OpenId
  • Zend_Paginator
  • Zend_Pdf
  • Zend_ProgressBar
  • Zend_Reflection
  • Zend_Registry
  • Zend_Rest_Client
  • Zend_Rest_Server
  • Zend_Search_Lucene
  • Zend_Server_Reflection
  • Zend_Service_Akismet
  • Zend_Service_Amazon
  • Zend_Service_Amazon_Ec2
  • Zend_Service_Audioscrobbler
  • Zend_Service_Delicious
  • Zend_Service_Flickr
  • Zend_Service_Nirvanix
  • Zend_Service_ReCaptcha
  • Zend_Service_Simpy
  • Zend_Service_SlideShare
  • Zend_Service_StrikeIron
  • Zend_Service_Technorati
  • Zend_Service_Twitter
  • Zend_Service_Yahoo
  • Zend_Session
  • Zend_Soap_Client
  • Zend_Soap_Server
  • Zend_Soap_Wsdl
  • Zend_Tag
  • Zend_Test_PHPUnit
  • Zend_Text_Figlet
  • Zend_Text_Table
  • Zend_TimeSync
  • Zend_Tool
  • Zend_Translate
  • Zend_Uri
  • Zend_Validate
  • Zend_Validate_File
  • Zend_Version
  • Zend_View
  • Zend_Wildfire
  • Zend_XmlRpc_Client
  • Zend_XmlRpc_Server
  • ZendX_Console_Process_Unix
  • ZendX_JQuery
  • ZendX_Whois

Related issues: - ZF-9029

Attachments:

Description

I will add them if necessary. Currently we have this page: http://framework.zend.com/wiki/display/… If it's important, perhaps we could add it into coding standards.

Comments

Posted by Robin Skoglund (robinsk) on 2009-07-21T04:57:56.000+0000

In my opinion, ZF should stop mixing SCM properties in files. I find it weird, clumsy, and unnecessary that each file in a repository has a line that says when the file was last updated in the particular source control repository the file is tied to at the moment. This information is available in the SCM itself, and should not have to be part of the actual file contents.

Posted by Thomas Weidner (thomas) on 2009-07-21T05:16:41.000+0000

This information is usefull for debugging. Often a issue is raised against a release or trunk version and when the user gives this revision number we can see if he is at the latest release (for example switched incubator with core directory and such).

Also users often only take parts of the framework itself or even mix components from one version with some from another version (because things are fixed in the other version).

Even if we always say that this should not be done, in fact it is done. This ID line is the only way for us to know what revision this file is.

Posted by Pádraic Brady (padraic) on 2009-07-21T05:18:06.000+0000

I like having the ID set on normal class files - it's not hugely informative but it can be helpful to have something at a glance before calling up svn log or svn blame for the details. I'm not sure it's necessary for unit tests though - I certainly haven't added them. Of course I don't even add comment headers to unit tests - they show nothing unique or licensable other than use cases for the classes.

I would also advise against adding more overburdening conditions into the coding standard - they are getting so restrictive that I've taken (with a little bit of shame) to ignoring them in favour of the PEAR CS. I noticed for the first time last week the following gem: Use of the "elseif" construct is not allowed in favor of the "else if" combination. It's a nice touch, but it's also the secondary form of that keyword - not the primary. It will also produce a parse error when you try it within a view script!

Posted by Robin Skoglund (robinsk) on 2009-07-21T05:30:53.000+0000

Point taken. I can see now how it might be useful in some situations. It shouldn't be necessary for unit tests, though, as Pádraic states.

I also agree with Pádraic on the 'elseif' / 'else if' struct, but that's another issue :)

Posted by Mickael Perraud (mikaelkael) on 2009-07-22T11:06:59.000+0000

Added on library directory before 1.9 code freeze (SVN16971): - 10180 PHP files - 911 files without keyword - 2 files without associated phpDoc tag (@version $Id$)

Posted by Dolf Schimmel (Freeaqingme) (freak) on 2009-08-13T16:24:53.000+0000

Removing zend_db_adapter_xml from involved components as there is no such component in the first place

Posted by Thomas Weidner (thomas) on 2009-08-18T13:47:19.000+0000

Removed Zend_Calender... no such component available

Posted by Thomas Weidner (thomas) on 2009-08-18T13:52:34.000+0000

Checked and erased Zend_Currency

Posted by Thomas Weidner (thomas) on 2009-08-18T14:07:01.000+0000

Checked and erased Zend_Date

Posted by Mickael Perraud (mikaelkael) on 2009-08-18T14:40:47.000+0000

Added on PHP files in tests directory with SVN17667:

* 14827 PHP files
* 248 files without keyword

Posted by Mickael Perraud (mikaelkael) on 2009-08-18T15:11:26.000+0000

Closed with SVN 17668

Have you found an issue?

See the Overview section for more details.

Copyright

© 2006-2016 by Zend, a Rogue Wave Company. Made with by awesome contributors.

This website is built using zend-expressive and it runs on PHP 7.

Contacts