PAC-MAN

Best practices for building Neos and Flow packages

Florian Weiss

@WeissheitenWien

Weissheiten

SkillDisplay

Dmitri Pisarev

@dimaip

SFI.ru

3.333.360 points

neoszillion lines of awesome code

We can't
win Pac-Man

We can't
write "perfect" Neos packages

But we can optimize them

HOW TO PLAY

Increase your package score

Be aware that this could put a ghost in the machine

Level 1

What are packages
and who builds them?

"Classic" package definition

One size fits all

Package Design

Ready to use extensions
can be twisted to fit

Package Design

"Building bricks" instead of "ready to use" extensions

Over 400 Neos packages

https://www.neos.io/download-and-extend/packages.html

Who builds those packages?

You
(You are awesome!)

You don't need to be a
PHP Wizard

Embrace the power of TS2

Progress

Step 1: Site Package with TS2 Basics and NodeTypes

Step 2: Custom TypoScript Objects, Eel Helpers, etc

Extensibility Talk

Error #112 in Integrator,
do you want to continue?

YES / NO

Keep the spirit up

Packages from others

What is the reason
for using packages?

Be able to reuse a specific thing your packages does well

Level 2
Modularity

Tailored fit

Monolithic

The pain grows with complexity.

Hard to "become all things to all people" [1Cor 9:22]

Modular

Works great when clear intent is defined.

Dangerous without thinking!

Small modules fever

Risks

Progressive modularisation

Grow your packages

Extract single- responsibility pieces of code -> ship them as seperate packages

Do we need a news package?

Not really.

prototype(Neos.NeosIo:PostArchive) < prototype(Flowpack.Listable:Listable) {
    @context.listClass = 'u-resetList siteWrapper siteWrapper--small'
    @context.itemClass = 'u-mb1/1'
    @context.sortProperty = '_index'
    @context.sortOrder = 'ASC'
    @context.itemsPerPage = 15
    collection = ${q(site).find('[instanceof Neos.NeosIo:Post]').get()}

    @cache {
        mode = 'cached'
        entryIdentifier {
            node = ${node}
        }
        entryTags {
            1 = ${'NodeType_Neos.NeosIo:Post'}
            2 = ${'Node_' + node.identifier}
        }
        maximumLifetime = 3600
    }
}

Do one thing - and do it well

"Provide a package with all NodeTypes that I consider useful"

"Provide a package with all NodeTypes related to Zurb Foundation"

Level 3
TypoScript best practices

Declarative Templating

vs

Imperative Templating

<f:for each="{0:1, 1:2, 2:3, 3:4}" as="foo">
    {foo}
</f:for>

Declarative Templating

myCollection = TYPO3.TypoScript:Collection {
        collection = ${[1, 2, 3]}
        itemName = 'element'
        itemRenderer = My.Package:IntegerRenderer
}

Avoid putting too much

logic into Fluid

Inheritance Chains

vs

Mixins

Inheritance Chains

Avoid many levels
of inheritance

Inheritance Chains

'My.Package:SpecialPage':
  superTypes:
    'TYPO3.Neos.NodeTypes:Page':
  properties:
    metaDescription:
      type: 'string'
      defaultValue: 'My important text'
	  
'My.Package:ExtraSpecialPage':
  superTypes:
    'My.Package:SpecialPage'
  properties:
    twitterCardType:
      type: 'string'
      defaultValue: 'Extra important text'

Mixins

Use mixins over inheritance chaining

Mixins

'TYPO3.Neos.Seo:SeoMetaTagsMixin':
  abstract: TRUE
  properties:
    metaDescription:
      type: string

Level 4
Get to know Flow

Spoiler:
It's a great and
state of the art
DDD PHP framework

Level 5
Testing

The fixture

include: resource://TYPO3.TypoScript/Private/TypoScript/Root.ts2
include: resource://TYPO3.Neos/Private/TypoScript/Root.ts2
include: resource://Flowpack.Listable/Private/TypoScript/Root.ts2

listable.basicListing = Flowpack.Listable:Listable {
	itemRenderer = ${node.properties.title}
	collection = ${collection}
}

The test

$newNode1 = $this->getMockBuilder(NodeInterface::class)->getMock();
$newNode1->method('getProperties')->willReturn(array('title' => 'Hello world'));
$newNode2 = $this->getMockBuilder(NodeInterface::class)->getMock();
$newNode2->method('getProperties')->willReturn(array('title' => 'Another hello world!'));

$view = $this->buildView();
$view->setTypoScriptPath('listable/basicListing');
$view->assign('collection', array($newNode1, $newNode2));
$this->assertXmlStringEqualsXmlString(
	'<ul>
		<li>Hello world</li>
		<li>Another hello world!</li>
	</ul>',
	$view->render()
);

Level 6
Maintenance

Fill out composer
and packagist info

php composer.phar init

Semantic versioning

http://semver.org/

Package Naming

Vendor.Context.Purpose

Example

Flowpack.Neos.Frontendlogin

Coding Guidelines

Flow Coding Guidelines
(one page!)

NOT PSR-2

if (1 === 1)
  echo "hello";
else
  echo "not hello";

PSR-2

if (1 === 1) {
  echo "hello";
} else {
  echo "not hello";
}

Strg + Shift + Alt + L

Documentation and Interaction

Provide a readme

Don't ignore GitHub responses

Try to maintain your package

Level 7
Wrapup

Namespaces

Flowpack / Community

PRESS STARTTO PLAY

PRESS START
TO PLAY