Configuration¶

Files¶

Config.yml¶

Config.yml is the mail configuration file for Phraseanet. You can setup environments in it and select the one you want to use with the “environment” var.

It uses the YAML format, which is easily understandable and human compatible.

This file requires two blocks.

In the following example, the “dev” environment is selected and we find the declaration of this environment below.

#config.yml
environment: dev
dev:
    phraseanet:
        servername: 'http://dev.phrasea.net/'
        maintenance: false
        debug: true
        display_errors: true
        database: main_connexion
        api-timers: true
    template_engine: twig_debug
    orm: doctrine_dev
    cache: array_cache
    opcodecache: array_cache
    border-manager: border_manager

Let’s detail environment structure :

phraseanet (main conf)
- servername: Application URI (required)
- maintenance: Switch to maintenance mode
- debug: Switch to debug mode
- display_errors: Display error in the standard output
- database: Name of the database connection (required) see connexion.yml below
- api-timers: Enable debug timers in the API results
template_engine : Templating service (required)
orm : Database Object Relationnal Mapper (required)
cache : Main cache service cache
opcodecache : Opcode cache service opcodecache
border-manager : Border service

Services are setup in the service.yml file.

Connexions.yml¶

Connexions.yml stores named connections. These connections are shared among services (Phraseanet, ORM, ...)

#connexions.yml
main_connexion:
  host: localhost
  port: 3306
  user: phrasea_engine
  password: s3cr3t
  dbname: applicationBox
  driver: pdo_mysql
  charset: UTF8

host: MySQL server address
port: MySQL server port
user: MySQL user
password: MySQL password
dbname: Database name (application box)
driver: Driver name see complete Doctrine drivers list
charset: connection encoding

Services.yml¶

Service.yml describes services. These are callable from config.yml

You will find a sample on services file in config/services.sample.yml.

Four main groups of services are available in Phraseanet : ORM, TemplateEngine, Log, and Cache.

Here’s the default structure of a service

ServiceGroupe:
  ServiceName:
    type: Namespace\Classe
    options:
      parameter1: value
      parameter2: value

A service requires a type which is the PHP class to load. Array parameters is optionnel and depends of the service.

Let’s see what are the options you can find in Phraseanet services :

Doctrine ORM Service¶

Here’s doctrine_dev service :

#services.yml
Orm:
  doctrine_dev:
    type: Orm\Doctrine
    options:
      debug: true
      dbal: test_connexion
      cache:
        query:
          service: Cache\array_cache
        result:
          service: Cache\array_cache
        metadata:
          service: Cache\array_cache
      log:
        service: Log\query_logger

debug : Switch to debug mode
dbal : The name of a connection in connexions.yml
cache : Cache option parameters
- query : service Cache\array_cache (see below)
- result : service Cache\array_cache (see below)
- metadata : service Cache\apc_cache (see below)
- log : service Log\query_logger (see below)

Twig Templating service ¶

Here’s twig_prod

#services.yml
TemplateEngine:
  twig_prod:
    type: TemplateEngine\Twig
    options:
      debug: false
      charset: utf-8
      strict_variables: false
      autoescape: true
      optimizer: true

debug : Switch to debug mode
charset : Template engine internal character encoding
strict_variable : Stop rendering on unknown vars (for developers)
autoescape: adds automatic output escaping.
optimizer : Switch for optimizer Twig mode

Doctrine Monolog Log Service¶

Here’s Doctrine Monolog log service. This service can only be use to log Doctrine activity.

#services.yml
Log:
  query_logger:
    type: Log\Doctrine\Monolog
    options:
      output: json
      channel: query-logger
      handler: rotate
      max_day: 2
      filename: doctrine-query.log

output : Choose output format. Available mods.
- json : Formatting in Json
- yaml : Formatting in YAML
- vdump : Display PHP output variable in a way that’s readable by humans. see var_dump
channel : Channel’s name used by the logger service. It’s a way to identify on which part of the application the log entry is related on.
handler : Attribute a specific handler for the log service.
- stream : Store logs into a single file.
- rotate : Stores logs to files that are rotated every day and a limited number of files are kept.
filename: File’s name.
max_day : Specify in days the frequency operated on files for the rotated handler.

Cache service ArrayCache¶

#services.yml
Cache:
  array_cache:
    type: Cache\ArrayCache

Cache service ApcCache¶

#services.yml
Cache:
  apc_cache:
    type: Cache\ApcCache

Cache service XCache¶

#services.yml
Cache:
  xcache_cache:
    type: Cache\XcacheCache

Cache service MemcacheCache¶

#services.yml
Cache:
  memcache_cache:
    type: Cache\MemcacheCache
    options:
      host: localhost
      port: 11211

host: Memcache server address
port: Memcache server port

Border service¶

This service handles validations constraints for each incoming files.

If the validation process fails, the document will be send to the quarantine.

The validation process is entirely customizable by adding some “Checkers”.

A “Checker” allows to add validation constraints to the process.

Available checkers :

Checker	Description	Options
CheckerSha256	Check for duplicated files based on their sha256 check sum
CheckerUUID	Check for duplicated files based on their UUID
CheckerDimension	Check file dimension (if applicable)	width : file width height : file height
CheckerExtension	Check file extension	extensions : authorized file extensions
CheckerFilename	Check for duplicated files based on their filename	sensitive : enable case sensitivity
CheckerMediaType	Check media type (Audio, Video...)	mediatypes : authorized media types
CheckerColorspace	Check colorspace (if applicable)	colorspaces : authorized colorspaces

#services.yml
Border:
    border_manager:
        type: Border\BorderManager
        options:
            enabled: true
            checkers:
                -
                    type: Checker\Sha256
                    enabled: true
                -
                    type: Checker\UUID
                    enabled: true
                -
                    type: Checker\Colorspace
                    enabled: true
                    options:
                        colorspaces: [cmyk, grayscale, rgb]
                -
                    type: Checker\Dimension
                    enabled: false
                    options:
                        width: 80
                        height: 80
                -
                    type: Checker\Extension
                    enabled: false
                    options:
                    extensions: [jpg, jpeg, png, pdf, doc, mpg, mpeg, avi, flv, mp3]
                -
                    type: Checker\Filename
                    enabled: true
                    options:
                        sensitive: true
                -
                    type: Checker\MediaType
                    enabled: false
                    options:
                        mediatypes: [Audio, Document, Flash, Image, Video]

Restrict on collections¶

It is possible to restrict the validation constraint on a set of collections by passing a list of base_id :

#services.yml
Border:
    border_manager:
        type: Border\BorderManager
        options:
            enabled: true
            checkers:
                -
                    type: Checker\Sha256
                    enabled: true
                    collections:
                        - 4
                        - 5

The same restriction can be done at databoxes level :

#services.yml
Border:
    border_manager:
        type: Border\BorderManager
        options:
            enabled: true
            checkers:
                -
                    type: Checker\Sha256
                    enabled: true
                    databoxes:
                        - 3
                        - 7

Note

It is not possible to restrict at databoxes and collections levels at the same time.

How to implement a custom checker ?

Checker’s object are declared in the Alchemy\Phrasea\Border\Checker namespace, so you have to create a new object which implements Alchemy\Phrasea\Border\Checker\Checker interface in this namespace.

For example : Let’s create a checker which filters a document based on its GPS datas.

<?php
//In lib/Alchemy/Phrasea/Border/Checker/NorthPole.php
namespace Alchemy/Phrasea/Border/Checker;

use Alchemy\Phrasea\Border\File;

use Doctrine\ORM\EntityManager;

class NorthPole implements Checker
{
    //Option bar
    protected $bar;

    //Handle options
    public function __construct(Array $options)
    {
        if( ! isset($options['bar']) {
            throw new \InvalidArgumentException('Missing bar option');
        }

        $this->bar = $options['bar'];
    }

    //Validation constraints, must return a boolean
    public function check(EntityManager $em, File $file)
    {
        $media = $file->getMedia();

        if ( null !== $latitude = $media->getLatitude()
                && null !== $ref = $media->getLatitudeRef()) {

            if($latitude > 60
                && $ref == MediaVorus\Media\DefaultMedia::GPSREF_LATITUDE_NORTH) {

                return true;
            }
        }

        return false;
    }
}

Then in services.yml configuration enable your checker.

#In Border scope
-
    type: Checker\NorthPole
    enabled: true
    options:
        bar: foo

Collection Settings¶

Suggested values

Suggested values are help to edit your documents. You can edit it and find it ack in the editing of document

Minilogo

Collection logo

Watermark

Watermark file is a picture that will be used to watermark previews for users.

StampLogo

This allows to add a stamp on picture. To fully use this feature :

Add your stamp logo

Go into collection settings

Click “XML view”, edit the XML, and add a “stamp” node as follows

<?xml version="1.0" encoding="UTF-8"?>
<baseprefs>

  /**
   * ....
   */

  <stamp>
    <logo position="left" width="25%"/>
    <text size="50%">Titre: <field name="SujetTitre"/></text>
    <text size="50%">Legende: <field name="Legende"/></text>
    <text size="50%">Copyright: <field name="Copyright"/></text>
    <text size="50%">Date : <field name="Date"/></text>
  </stamp>

</baseprefs>

Navigation

Table Of Contents

Quick search