What frameworks can do (and what not)

Robert Lemke - TechDivision GmbH

TEXT HERE

Robert Lemke !

38 years old lives in Lübeck, Germany software architect at TechDivision TYPO3 Association co-founder TYPO3 Flow & TYPO3 Neos project founder 1 wife, 2 daughters, 1 espresso machine

Expectations. Promises. Features. Long Term Relationships.

What do you expect from your IDE?

What do you expect from a framework?

„Implement our company website. It must be based on TYPO3 CMS.”

A frameworkis no architecture.

A framework alonewon’t make a great application.

Promises

„enterprise ready”

„a great community”

„extensible”

„secure”

„PHP is fun again”

„ready for tomorrow”

„based on another cool framework”

„batteries included”

„… is right for you if you want to spend more time away from your computer”

Features

Speed

Frameworks add more layers of abstraction.

Abstraction layers slow down your application.

Without a framework,most likely, you will add these layers yourself.

Abstraction layers speed up your application.

your applicationstarts here

speed doesn’t come for free.

Persistence

An ORM layer slows down your application and is less flexible.

An ORM layer can make your application less complex and respond faster.

keeps your domain model clean.

great caching opportunities.

Don’t implement an ORM – it’s way too complex to get it right.

Do implement an ORM – you need to know the inner works.

Do you need an ORM?

A DBAL makes your application more portable.

Do you need a DBAL?

Used correctly, ORMs can be a blessing.

Security

A framework can make your application more secure.

Implementing cryptography algorithms on your own iswantonly negligent!

Implementing authentication and authorisation adapters is a whole project on its own.

Do you have themanpower and expertise?

Still, you are responsible for security.

You need to learn about security, no matter what.

Guidance

TYPO3 Flow Coding Guidelines on one page

<?phpnamespace Acme\TestPackage;

/* * * This script belongs to the TYPO3 Flow package "Acme.TestPackage". * * * * It is free software; you can redistribute it and/or modify it under * * the terms of the GNU General Public License, either version 3 of the * * License, or (at your option) any later version. * * * * The TYPO3 project - inspiring people to share! * * */

use Acme\TestPackage\Service\FooGenerator;use TYPO3\Flow\Annotations as Flow;

/** * Here goes the description of the class. It should explain what the main * purpose of this class is... * * @Flow\Scope(”singleton”) */class UniverseAnalyzer extends BaseClass implements SomeInterface {

/** * Some injected dependency * * @Flow\Inject * @var FooGenerator */protected $someDependency = NULL;

/** * Shows if you are addicted to TYPO3 Flow * * @var boolean */static protected $addictedToFlow = TRUE;

/** * Shows if you are a fan of TYPO3 Flow * * @var boolean */protected $fanOfFlow;

/** * A great method which shows how to indent control structures. * * @param MyClass $object An instance of MyClass * @param array $someArray Some array * @return void * @throws \Exception */public function analyzeUniverse(MyClass $object, array $someArray = array()) {

$subObjects = $object->getSubObjects();foreach ($subObjects as $subObject){

/** @var $subObject MySubClass */$subObject->doSomethingCool();

}if (isset($someArray['question'])

&& $this->answerToEverything === 42|| count($someArray) > 3) {

$this->fanOfTYPO3Flow = TRUE;} else {

throw new \Exception('We cannot tolerate that.', 1223391710);}

}

/** * This is a setter for the fanOfFlow property. * * @param boolean $isFan Pass TRUE to mark a fan, FALSE for a Zend follower * @return mixed */public function setFanOfFlow($isFan) {

$this->fanOfFlow = $isFan;}

/** * As simple as it gets – a boolean getter. * * @return boolean Whether a foo was detected (TRUE) or not (FALSE) * @api */static public function isAddictedToFlow() {

return self::$addictedToFlow;}

}?>

Also check out the latest documentation: http://docs.typo3.org/flow/TYPO3FlowDocumentation/TheDefinitiveGuide/PartV/CodingGuideLines/Index.html

Description of the class. Make it as long as needed, feel free to explain how to use it.

Namespace starts with vendor name followed by package key (name) and subparts as needed

UpperCamelCase class name. Class names should be nouns.In other packages, import \Acme\TestPackage\UniverseAnalyzer and refer to it as UniverseAnalyer.

Opening brace on same line with opening token. One space before.

Use @var tag. Optional description goes in the first comment line followed by a blank comment line.

Indent with tabs.

Multiline conditions:Indent them and add a extra indent to following code. Put the boolean operators at beginning of line.

Write what went wrong, give helpful details and give a hint for a possible solution.

UNIX timestamp at time of writing the throw clause.

Description of the method. Make it as long as needed.

Use type hinting

Methods returning boolean values should start with “has” or “is”. Other getters should start with “get“.

Setter methods should start with “set”.

Method names should be verbs.

@return tag with type, even if it is “void”. Only __construct() has no return tag.

static and abstract keywords before the visibility modifier

@api tag defines public API

One use statement per line.One use statement per namespace.Order statements alphabetically.Don't import namespaces unless you use them.

No empty line between DocComment and class, member var or method.

Prefer relative namespaces, unless Fully Qualified Namespace is more readable

Param tag: type, name, description.

Only use inline @var annotations when type can't be derived (like in an array of objects) to increase readability and trigger IDE auto-completion.

List @Flow\* before other tags: @var, @param, @return, @throws, @api, @since, @deprecated

Capture the joy of coding as you create excellent web solutions.Enjoy coding. Enjoy Flow.

http://rlmk.me/flowcgl

0 75 150 225 300

Security Speed MVC HTTP Templating i18n

You will have to learn a lot …

start working on business logic

… the question is: in which order?

0 100 200 300 400

Framework Security Speed MVC HTTP Templating i18n C64 E.

start working on business logic

But hey, what about Agile?

Bottomline?

Frameworks offer a shortcut and many features right away.

Going framework-less gives you more flexibility.

Non-trivial applications will need a framework sooner or later.

Only start creating your own application-specific framework if you have the experience and resources.

TEXT HERE

@robertlemke !

robertlemke.com flow.typo3.org techdivision.com