A library for powering /programmes pages.
Uses Doctrine to read data from the ProgrammesDB.
Add this repository to your composer.json and add bbc/programmes-pages-service
as a dependency
{
"repositories": [
{
"type": "vcs",
"url": "[email protected]:bbc/rmp-php-radionav-client.git"
}
],
"require": {
"bbc/programmes-pages-service": "*"
}
}Add the doctrine/doctrine-bundle, doctrine/doctrine-cache-bundle and
`` bundles to your composer.json.
Add the following types to your Doctrine DBAL config (in config.yml), under the
dbal key:
doctrine:
dbal:
types:
date_partial: BBC\ProgrammesPagesService\Data\ProgrammesDb\Type\DatePartialTypeAdd the following entity mapping and filters to your Doctring ORM config (in
config.yml), under the orm key:
doctrine:
orm:
default_entity_manager: default
entity_managers:
default:
mappings:
ProgrammesPagesService:
type: annotation
dir: "%kernel.root_dir%/../vendor/bbc/programmes-pages-service/src/Data/ProgrammesDb/Entity"
is_bundle: false
prefix: BBC\ProgrammesPagesService\Data\ProgrammesDb\Entity
filters:
embargoed_filter:
class: BBC\ProgrammesPagesService\Data\ProgrammesDb\Filter\EmbargoedFilter
enabled: true
dql:
string_functions:
MATCH_AGAINST: BBC\ProgrammesPagesService\Data\ProgrammesDb\Functions\MatchAgainst
GROUP_CONCAT: BBC\ProgrammesPagesService\Data\ProgrammesDb\Functions\GroupConcat
datetime_functions:
YEAR: BBC\ProgrammesPagesService\Data\ProgrammesDb\Functions\Year
MONTH: BBC\ProgrammesPagesService\Data\ProgrammesDb\Functions\Month
DAY: BBC\ProgrammesPagesService\Data\ProgrammesDb\Functions\DayAdd the doctrine extensions configuration (in config.yml), under the
stof_doctrine_extensions key:
stof_doctrine_extensions:
orm:
default:
tree: true
timestampable: trueDefine services in the DI container to swiftly get at them (in services.yml):
services:
# MapperFactory takes an array of options to configure how to map entities
pps.mapper_factory:
class: BBC\ProgrammesPagesService\Mapper\ProgrammesDbToDomain\MapperFactory
public: false
arguments:
- []
pps.domain_service_factory:
class: BBC\ProgrammesPagesService\Service\ServiceFactory
arguments:
- '@doctrine.orm.default_entity_manager'
- '@pps.mapper_factory'
pps.programmes_service:
class: BBC\ProgrammesPagesService\Service\ProgrammesService
factory: [ '@pps.domain_service_factory', 'getProgrammesService']You can repeat the pps.programmes_service definition, changing the
'getProgrammesService' method for each of the services you want to access, to
save you having to request it through the ServiceFactory every time.
By default, Doctrine2 assumes all DateTimes are in UTC.
You can force all dates going in to the DB to be converted to UTC and all DateTimes coming out to have UTC set by adding the following configuration to your YAML files.
doctrine:
dbal:
types:
datetime: BBC\ProgrammesPagesService\Data\ProgrammesDb\Type\UtcDateTimeType
datetimetz: BBC\ProgrammesPagesService\Data\ProgrammesDb\Type\UtcDateTimeTypeServices make requests to the database layer then transforms the database objects into a set of Domain Objects.
TODO.
Install development dependencies with composer install.
Run tests and code sniffer with script/test.
This repository is available under the terms of the Apache 2.0 license. View the LICENSE file for more information.
Copyright (c) 2017 BBC
To use PPS, as a minimum pull in bbc/programmes-caching-library, then in services.yml:
framework:
cache:
pools:
cache.programmes:
adapter: 'cache.adapter.psr6'
provider: cache.null_provider
services:
cache.null_provider:
class: Symfony\Component\Cache\Adapter\NullAdapter
BBC\ProgrammesCachingLibrary\Cache:
arguments:
- '@cache.null_provider'
- 'nullcache'
BBC\ProgrammesPagesService\Mapper\ProgrammesDbToDomain\MapperFactory: ~
BBC\ProgrammesPagesService\Service\ServiceFactory:
public: true
autowire: true
arguments:
- '@doctrine.orm.programmesdb_entity_manager'
- '@BBC\ProgrammesPagesService\Mapper\ProgrammesDbToDomain\MapperFactory'
- '@BBC\ProgrammesCachingLibrary\Cache'
BBC\ProgrammesPagesService\Service\CoreEntitiesService:
public: true
factory: ['@BBC\ProgrammesPagesService\Service\ServiceFactory', 'getCoreEntitiesService']
# follow the above pattern for other services