TCAobjects Fabrizio Branca mail@fabrizio-branca.de Fabrizio Branca - - PowerPoint PPT Presentation

▶
tcaobjects
SMART_READER_LITE
LIVE PREVIEW

TCAobjects Fabrizio Branca mail@fabrizio-branca.de Fabrizio Branca - - PowerPoint PPT Presentation

Aug 14, 2023 492 likes •871 views

TCAobjects Fabrizio Branca mail@fabrizio-branca.de Fabrizio Branca mail@fabrizio-branca.de I started implementing my tcaobjects extension and when almost finished I found this: [...] The general idea with our mapper (called tcaObj)

slide-1
SLIDE 1

Fabrizio Branca – mail@fabrizio-branca.de

TCAobjects

Fabrizio Branca

mail@fabrizio-branca.de

slide-2
SLIDE 2

Fabrizio Branca – mail@fabrizio-branca.de

I started implementing my tcaobjects extension…

… and when almost finished I found this:

[...] The general idea with our mapper (called tcaObj) is that the TCA already contains the info we need to read and write data from the database (table name, field names, field types, validation requirements, etc). The backend proves this with the use of TCEMain and TCEForms. [...]

… and a few minutes later:

[...] Jeff, this is awesome news! I was going to work on exactly this after my thesis is done (still a long way to go), but the similarities are really striking (btw. even my class is called TCAobject ;)). [...]

slide-3
SLIDE 3

Fabrizio Branca – mail@fabrizio-branca.de

What‘s this all about? Some buzzwords… TCA,IRRE, HTML_QuickForm, DDD, Ruby

  • n Rails, Database Relations, TYPO3, Active

Record, OOP, PHP5, Smarty, RAD,

CakePHP, ORM, MVC, CRUD, Forms,

Persistence, Magic Methods, Interfaces,

Kickstarter, Autoloader, Chaining, Lazy loading

slide-4
SLIDE 4

Fabrizio Branca – mail@fabrizio-branca.de

The Idea behind the extension…

  • While programming most time is spent with

doing trivial things like

– …writing class definitions (including accessor classes, collection classes,…) – …writing getter/setter methods – …writing language labels – …transfering variables into templates – …adapting properties to table definitions and TCA – …

slide-5
SLIDE 5

Fabrizio Branca – mail@fabrizio-branca.de

The Idea behind the extension…

  • Most of these tasks

– contain redundant definitions – are boring and time consuming – are error-prone – can be avoided!

  • The „M“ in MVC
slide-6
SLIDE 6

Fabrizio Branca – mail@fabrizio-branca.de

Other Frameworks with simalar approaches

  • Ruby on Rails
  • CakePHP
  • Propel
slide-7
SLIDE 7

Fabrizio Branca – mail@fabrizio-branca.de

New possibilities with PHP5

  • Magic methods

– _get(), _set(), _call()

  • Interfaces:

– Iterators, „ArrayAccess“ – Define own interface

  • Abstract classes
slide-8
SLIDE 8

Fabrizio Branca – mail@fabrizio-branca.de

Why not define everything at one place?

slide-9
SLIDE 9

Fabrizio Branca – mail@fabrizio-branca.de

Active Record Pattern

  • Martin Fowler in „ Patterns of Enterprise

Application Architecture“:

  • „An object that

– wraps a row in a database table or view, – encapsulates the data access – and adds domain logic on that data“

slide-10
SLIDE 10

Fabrizio Branca – mail@fabrizio-branca.de

Active Record Pattern

  • A class corresponds to a table definition
  • An instance corresponds to a record
  • Domain logic is added to the class
  • The class does CRUD operations in the

background

  • Used for object relational mapping (ORM)
  • Ruby on Rails: „ActiveRecord“
slide-11
SLIDE 11

Fabrizio Branca – mail@fabrizio-branca.de

Using the information in the TCA

  • Field types
  • Database relations („old style“ and IRRE)
  • Evaluation
slide-12
SLIDE 12

Fabrizio Branca – mail@fabrizio-branca.de

class „tx_tcaobjects_object“

  • abstract class
  • main parent class for all objects
  • class name == table name

– or: $this->_table = ‘otherTableName‘;

  • implements interfaces

– ArrayAccess – IteratorAggregate

slide-13
SLIDE 13

Fabrizio Branca – mail@fabrizio-branca.de

tx_tcaobjects_object: Basic functions

  • Accessing properties

– Dynamic functions

  • echo $this->get_message();

$this->set_message(‘Hello World‘);

– ArrayAccess

  • echo $this[‘message‘];

$this[‘message‘] = ‘Hello World‘;

– IteratorAggregate

  • foreach ($obj as $key => $property) {

echo $key .‘: ‘. $property; }

slide-14
SLIDE 14

Fabrizio Branca – mail@fabrizio-branca.de

tx_tcaobjects_object: Loading and storing data

  • Via constructor

– $myObj = new tx_myext_myclass(42);

  • loadSelf() / storeSelf() methods

– $myObj = new tx_myext_myclass(); $myObj[‘foo‘] = ‘bar‘; $myObj->storeSelf();

slide-15
SLIDE 15

Fabrizio Branca – mail@fabrizio-branca.de

tx_tcaobjects_object: Aliases

  • class myClass extends fe_users {

protected $_aliasMap = array( 'firstname' => ' myClass_firstname', 'lastname' => ' myClass_lastname'); […] }

  • $myObj = new myClass();

$myObj['firstname'] = 'Fabrizio'; echo $myObj['firstname']; // Outputs: Fabrizio echo $myObj['myClass_firstname']; // Outputs: Fabrizio

slide-16
SLIDE 16

Fabrizio Branca – mail@fabrizio-branca.de

tx_tcaobjects_object Dynamic properties

  • by overriding the __get method:
  • protected function __get($calledProperty){

switch ($calledProperty) { case 'fullName' : return $this['firstname'].' '.$this['lastname']; break; default: return parent::__get($calledProperty); } }

slide-17
SLIDE 17

Fabrizio Branca – mail@fabrizio-branca.de

  • …locally (on a „per class“ basis)

protected $_properties = array( 'image' => array ( 'config' => array ( 'maxitems' => 1, 'size' => 1 ) ), ’title' => array ( 'label' => 'LLL:EXT:myext/locallang_db.xml:myNewLabel‘ ) );

tx_tcaobjects_object Override TCA settings

slide-18
SLIDE 18

Fabrizio Branca – mail@fabrizio-branca.de

tx_tcaobjects_object Set default values

  • class myext_blogpost extends tx_tcaobjects_object{

protected $_table = 'tt_news'; protected $_values = array('type' => 3); }

slide-19
SLIDE 19

Fabrizio Branca – mail@fabrizio-branca.de

tx_tcaobjects_object Modifiers

  • Modifiers are appended with an „_“
  • Only valid for special configurations
  • Can be added in extending classes
  • Modifier values will be „lazy loaded“
slide-20
SLIDE 20

Fabrizio Branca – mail@fabrizio-branca.de

tx_tcaobjects_object Modifiers

  • Current available modifiers for relations

– obj: Returns related object instead of uid to it – objColl: Creates a collection with related

  • bjects
slide-21
SLIDE 21

Fabrizio Branca – mail@fabrizio-branca.de

tx_tcaobjects_object Modifiers

  • Current available modifiers (other)

– path: returns the complete path in case of files – explode: returns an array in case of csl – rte: renders content as rte content – sL: returns the language label

slide-22
SLIDE 22

Fabrizio Branca – mail@fabrizio-branca.de

tx_tcaobjects_object Chaining

  • The name of the artist of a users first album:

$userObj[‘albums_objColl‘][0][‘artist_obj‘][‘name‘];

slide-23
SLIDE 23

Fabrizio Branca – mail@fabrizio-branca.de

class „tx_tcaobjects_objectCollection“

  • „group/list/set“ of objects
  • implements some interfaces

– ArrayAccess – tx_tcaobjects_iPageable – IteratorAggregate (from tx_pttools_objectCollection) – Countable (from tx_pttools_objectCollection)

slide-24
SLIDE 24

Fabrizio Branca – mail@fabrizio-branca.de

class „tx_tcaobjects_objectCollection“

  • foreach ($myObjColl as $myObj) {

/* @var $myObj tx_myExt_myClass */ echo $myObj[‘someProperty‘]; }

slide-25
SLIDE 25

Fabrizio Branca – mail@fabrizio-branca.de

class „tx_tcaobjects_objectAccessor“

  • All methods for database operations

(select, insert, update, delete) are bundled here

  • Put your sql statements in accessor

classes

  • only static methods
slide-26
SLIDE 26

Fabrizio Branca – mail@fabrizio-branca.de

Other Features

  • Autoloader

$GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['tcaobjects'] ['autoLoadingPath'][str_replace('_','',$_EXTKEY)] = 'EXT:'. $_EXTKEY.'/res/';

  • Assertions (tx_tcaobjects_assert)

tx_tcaobjects_assert::notEmpty($this->piVars['album_uid']);

– throws an exception if assertion fails

  • tx_tcaobjects_fe_users

– is able to wrap the current logged in user into an object

slide-27
SLIDE 27

Fabrizio Branca – mail@fabrizio-branca.de

Forms with HTML_QuickForm

  • HTML_QuickForm is part of PEAR

– Classes must be in your include path (e.g. use EXT:pear)

  • Allows to create forms easily
  • class tx_tcaobjects_quickform
  • Interface for renderers:

class.tx_tcaobjects_iQuickformRenderer.php

– tx_tcaobjects_qfDefaultRenderer – tx_tcaobjects_qfSmartyRenderer

slide-28
SLIDE 28

Fabrizio Branca – mail@fabrizio-branca.de

Forms with HTML_QuickForm

  • Define forms

– with PHP – with a string (similar to the „showitem“ string) – by Typoscript

  • Use filters and rules (defined e.g. in TCA)
  • Create own rules and filters

– e.g. check full age

slide-29
SLIDE 29

Fabrizio Branca – mail@fabrizio-branca.de

Templating with Smarty

  • The „V“ in MVC
  • Use TYPO3 functions to render content

– New features of the smarty extension

  • {link}
  • {image}

– New features that come with tcaobjects

  • {ll}
slide-30
SLIDE 30

Fabrizio Branca – mail@fabrizio-branca.de

Developing an extension

  • tcaobjects extends

the kickstarter

  • classes will be

generated automatically for all new and extend tables

– objects – collections – accessors

slide-31
SLIDE 31

Fabrizio Branca – mail@fabrizio-branca.de

Demo Extension

tx_tcaobjectsdemo_album PK uid title year cover artist tx_tcaobjectsdemo_track PK uid position title length mp3file album tx_tcaobjectsdemo_artist PK uid name fe_users PK uid username name image [...]

0..n 0..m 1..n 1 1 0..n

slide-32
SLIDE 32

Fabrizio Branca – mail@fabrizio-branca.de

Demo Extension

tx_tcaobjectsdemo_album PK uid title year cover artist tracks tx_tcaobjectsdemo_track PK uid position title length mp3file album tx_tcaobjectsdemo_artist PK uid name fe_users PK uid username name image [...] tx_tcaobjectsdemo_albums

0..n 0..m 1..n 1 1 0..n

tx_tcaobjectsdemo_albumuser_mm PK uid album feuser

1 1

slide-33
SLIDE 33

Fabrizio Branca – mail@fabrizio-branca.de

Demo

slide-34
SLIDE 34

Fabrizio Branca – mail@fabrizio-branca.de

What now?

  • Very experimental. Do not use in

production environment now!

  • Developing a community project based on
  • tcaobjects. So expect this extension to

maturate soon… :)

slide-35
SLIDE 35

Fabrizio Branca – mail@fabrizio-branca.de

Resources

  • Martin Fowler

„Patterns of Enterprise Application Architecture“

  • ActiveRecord Tutorial (Ruby on Rails)

http://www.railsenvy.com/2007/8/8/activerecord-tutorial

  • HTML_QuickForm

http://pear.php.net/package/HTML_QuickForm

  • Smarty

http://smarty.php.net

slide-36
SLIDE 36

Fabrizio Branca – mail@fabrizio-branca.de

Resources

  • TER:

–tcaobjects –tcaobjects_demo

  • Manual will follow soon
  • These slides will be available at

http://www.fabrizio-branca.de

slide-37
SLIDE 37

Fabrizio Branca – mail@fabrizio-branca.de

Questions?

mail@fabrizio-branca.de