ECT/Coding Guidelines

From TYPO3Wiki

Teams Committees

This project/information is related to the Extension coordination team

Contents 1 Modern Extension Coding Guidelines (ECG) 2 Glossary 3 Standards for Extending Extensions 3.1 Extension-key naming 3.2 glue 3.3 Certification

Modern Extension Coding Guidelines (ECG)

Coding Guidelines defined by the ECT

Glossary

glossary-definition

• ECG: The ECT Coding Guidelines are an extension to the TYPO3 Coding Guidelines (TCG). All rules of the TYPO3 Coding Guidelines are fully valid. The target of ECG is to improve the usibility of APIs and to prepare extensions for a smoth migration to TYPO3 5.x.
• Team-provided extensions: Extensions what are maintained by a team and extended by several add-ons. Examples cal, lib/div
• planet: efaq
• moon extension: add-on of the showcase. (efaq rssfeed)
• component (Pulponair/ Nikolas):Code used by severall Controllers e.q a requestHandler (i.e a "controllete")
• helper (Pulponair/ Nikolas): Class which provides "helpfull" functionality to a certain instance. e.g a HTML helper to the view:

$html->selectTag(..)

• subcontroller: extended controller. see MVC Framework/ResultBrowser, PAC concept
• action chain: see Bananas#SPL_objects_and_special_keys
• processing chain: see Bananas#Controllers
• validation chain: see Bananas#The_validator_object
• adapter/wrapper object: see in lib-extension the class.tx_lib_resultBrowserSpl.php

Standards for Extending Extensions

this is the start of the collection, an extension to the Coding Guidelines. What is a good standard-definition? One, that has an implementation as example! That's the practice of W3C.

Extension-key naming

• in spring 2007 we decided to use "baseextension__addon"
• example: kickstarter__mvc (kickstarter__mvc) (contact: gawain)

glue

• by the extensible controller of lib/div. See MVC Framework/ResultBrowser as example.

Certification

This is just an idea yet - nobody is putting any energy in it, but it's important and so we'll focus on that, when time has come for it.

This can be combined with the rating of TYPO3-extensions (typo3.org) and the Extension Comparison-Team of T3N magazine. Certification of selected "planets" by ECT.