Me

• eZ Community member since 2005
• Part of the eZ Engineering team since 2011
• Lead engineer User Interface at eZ
• Webmaster of http://www.planet-ezpublish.fr/, powered by eZ Publish 5!

• @dpobel
• +Damien Pobel
• Github
• Linkedin
• Blog

eZ Publish 3.x/4.x

• eZContentObjectTreeNode, eZContentObject, eZContentClass, ...
• Lots of static methods
• Almost no visibility (private, protected, ...)
• Objects are tighly coupled
• Lazy loaded object attributes
• Barely testable
• Difficult to maintain
• Huge effort to introduce new storage system

Public API

• PAPI
• modern PHP API
  • namespaces
  • interfaces
  • exceptions
  • testable and unit tested
  • layered
• API to handle eZ Publish domain objects

Domain objects

Repository / Services

• Repository === main entry point to do anything related to what is stored by eZ
• PHP interface eZ\Publish\API\Repository\Repository
• Repository gives access to the services
• Services allow to do something:
  Ex: load a section:

/** @var $repository eZ\Publish\API\Repository\Repository */
/** @var $sectionService eZ\Publish\API\Repository\SectionService */
$sectionService = $repository->getSectionService();

/** @var $section eZ\Publish\API\Repository\Values\Content\Section */
$section = $sectionService->loadSection( 1 );

Services

• ContentService to handle contents (eZ\Publish\API\Repository\ContentService)
• LocationService to handle locations (eZ\Publish\API\Repository\LocationService)
• ContentTypeService to handle content types (eZ\Publish\API\Repository\ContentTypeService)
• URLAliasService to handle url aliases (eZ\Publish\API\Repository\URLAliasService)
• ...
• SearchService to search contents (eZ\Publish\API\Repository\SearchService)

Current user and policies

• In the Symfony2 context, the current user is set to the currently logged in user
• CLI: anonymous by default
• Repository::setCurrentUser
• Users are loaded with the ... UserService
• Unless specified, service's methods take user's policies into account
• Loading an inaccessible object throws an exception

Usage of service (1)

$sectionService = $repository->getSectionService();
/** @var $section eZ\Publish\API\Repository\Values\Content\Section */
$section = $sectionService->loadSection( 1 );

• $section is a value object
• dumb object
  • only holds data
  • may have some convenient methods
  • read only by design

Usage of service (2)

// changing the owner of a content
$contentService = $repository->getContentService();
$updateMetadataStruct = $contentService->newContentMetadataUpdateStruct();
$updateMetadataStruct->ownerId = 14;
$contentService->updateContentMetadata( $contentInfo, $updateMetadataStruct );

• A structure describes a complex operation
• Created by the service
• ContentMetadataUpdateStruct, ContentUpdateStruct, ContentCreateStruct, ...

Gettting the repository

/** @var $repository \eZ\Publish\API\Repository\Repository */
$repository = $container->get( 'ezpublish.api.repository' );

• $container is the Symfony's service container
• so the Repository is a service from a Symfony point of view
• in a controller extending eZ\Bundle\EzPublishCoreBundle\Controller:

$repository = $this->getRepository();

• in a command class extending Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand:

$repository = $this->getContainer()->get( 'ezpublish.api.repository' );

Content in the Public API

• the Public API is content centric
• legacy is more or less node (location!) centric
• Content vs. ContentInfo
• No more lazy loaded attribute

Search contents

• SearchService to find contents
• Query object to express requirements
  • Criterion
  • Sort clauses

use eZ\Publish\API\Repository\Values\Content\Query;
use eZ\Publish\API\Repository\Values\Content\Query\Criterion;

$searchService = $repository->getSearchService();
$query = new Query();
$query->criterion = new Criterion\Visibility( Criterion\Visibility::VISIBLE );
$query->limit = 10;
$query->offset = 0;
$query->sortClauses = array( new SortClause\LocationPriority() );
/** @var $contents eZ\Publish\API\Repository\Values\Content\Search\SearchResult */
$contents = $searchService->findContent( $query );

fetch content list legacy vs. eZ 5

$items = eZContentObject::subTreeByNodeID(
    array(
        'Depth' => 1,
        'ClassFilterType' => 'include',
        'ClassFilterArray' => array( 'folder' ),
        'SortBy' => array( array( 'priority', false ) )
    ), 2
);

$searchService = $repository->getSearchService();
$query = new Query();
$query->criterion = new Criterion\LogicalAnd(
    array(
        new Criterion\Visibility( Criterion\Visibility::VISIBLE ),
        new Criterion\ParentLocationId( 2 ),
        new Criterion\ContentTypeIdentifier( array( 'folder' ) )
    )
);
$query->sortClauses = array( new SortClause\LocationPriority() );
/** @var $contents eZ\Publish\API\Repository\Values\Content\Search\SearchResult */
$contents = $searchService->findContent( $query );

fetch content tree legacy vs. eZ 5

$items = eZContentObject::subTreeByNodeID(
    array(
        'ClassFilterType' => 'include',
        'ClassFilterArray' => array( 'folder' ),
        'SortBy' => array( array( 'priority', false ) )
    ), 2
);

$searchService = $repository->getSearchService();
$query = new Query();
$query->criterion = new Criterion\LogicalAnd(
    array(
        new Criterion\Visibility( Criterion\Visibility::VISIBLE ),
        new Criterion\Subtree( '/1/2' ),
        new Criterion\ContentTypeIdentifier( array( 'folder' ) )
    )
);
$query->sortClauses = array( new SortClause\LocationPriority() );
/** @var $contents eZ\Publish\API\Repository\Values\Content\Search\SearchResult */
$contents = $searchService->findContent( $query );

Legacy callback

• Some parts of the PAPI are still a work in progress
• when something is not implemented => legacy callback:
  1. get the legacy kernel
  2. run a closure with legacy code inside
• allows to use legacy code inside the new stack
• Example: Trigger legacy workflow from an eZ Publish 5 script
  See: http://j.mp/legacy-callback-ezpublish

Hands on!

• EzSystems/EzSummerCampPublicApiBundle
• generated with the generate:bundle command

$ php ezpublish/console generate:bundle

Exercices

1. RSS feed of blog posts
2. Import script
3. Bonus ;-)

RSS feed

• Test Driven Development :-)
• phpunit -c ezpublish/ src/EzSystems/SummerCamp2013PublicApiBundle fails
• EzSystems\SummerCamp2013PublicApiBundle\Controller\ExportController half implemented
• Purposes:
  • successful tests
  • /eng/summercamp/rssblogposts RSS feed of the blog posts (10 last)
  • details in EzSystems\SummerCamp2013PublicApiBundle\Controller\ExportController

Import script

• Actually a script that creates one blog post
• $ php ezpublish/console summercamp:create_blog_posts
• EzSystems\SummerCamp2013PublicApiBundle\Command\CreateBlogPostCommand

Bonus

• In RSS feed item description, put the HTML instead of strip_tags( ezxml )
• Change route summercamp/rssblogposts to accept parameters
  • content type identifier of content to retrieve
  • root location
  • number of elements
  • ...
  • and fix unit tests!
• Re-implement feeds based on legacy objects

The end

?