<<

NAME

Koha::Schema::Component::Localization

SYNOPSIS

    package Koha::Schema::Result::SomeTable;

    # ... generated code ...

    __PACKAGE__->load_components('+Koha::Schema::Component::Localization');

    __PACKAGE__->localization_add_relationships(
        'some_table_localizations',
        'some_table_id' => 'some_table_id',
        'first_column',
        'second_column',
        # ...
    );

    package main;

    my $rows = $schema->resultset('SomeTable');
    my $row = $rows->first;
    $row->localizations->search($cond);
    $row->create_related('first_column_localizations', { lang => $lang, translation => $translation })

    while (my $row = $rows->next)
        # first call will fetch all localizations for the current language and
        # the result will be cached, next calls will not execute a query
        $row->localization('first_column', $lang);

        # no query executed
        $row->localization('second_column', $lang);
    }

DESCRIPTION

This is a DBIx::Class component that helps to manage database localizations by adding several relationships and methods to a "Result Class"

This can handle several localizable columns (also referred as "properties") per table

To add database localizations to an existing database table, you need to:

• Create a new table with:
  • An auto incremented column as primary key
  • A foreign key column referencing the existing table
  • 3 string (varchar or text) columns named 'property', 'lang', 'translation'
  • A unique key comprising the foreign key column, 'property' and 'lang'
• Regenerate the DBIx::Class schema with misc/devel/update_dbix_class_files.pl
• Add calls to load_components and localization_add_relationships at the end of the result class

This will give you a relationship named 'localizations' through which you can access all localizations of a particular table row.

And for every property, you will have:

• a "has_many" relationship named <property>_localizations, giving access to all localizations of a particular table row for this particular property
• a "might_have" relationship named <property>_localization, giving access to the localization of a particular table row for this particular property and for the current language (uses C4::Languages::getlanguage)

The "row" object will also gain a method localization($property, $lang) which returns a specific translation and uses cache to avoid executing lots of queries

localization_add_relationships

Add relationships to the localization table

<<