Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

16.0[MIG] base_conditional_image: Migration to 16.0 #2644

Merged
merged 11 commits into from
Sep 4, 2024
115 changes: 115 additions & 0 deletions base_conditional_image/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
==================
Conditional Images
==================

.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
:target: https://odoo-community.org/page/development-status
:alt: Beta
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github
:target: https://github.com/OCA/server-tools/tree/15.0/base_conditional_image
:alt: OCA/server-tools
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/server-tools-15-0/server-tools-15-0-base_conditional_image
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
:target: https://runbot.odoo-community.org/runbot/149/15.0
:alt: Try me on Runbot

|badge1| |badge2| |badge3| |badge4| |badge5|

This module extends the functionality of any model to support conditional images
(based on the record attributes) and to manage them either globally or by company.

The main goal behind this module is to avoid storing the same image multiple times.
For example, for every partner, there is a related image (most of the time, it's the default one).
With this module properly set up, it will be stored only one time and you can change it whenever you want for all partners.

**WARNING**: this module cannot be used on the same objects using the module `base_multi_image`.

**Table of contents**

.. contents::
:local:

Installation
============

The sole purpose of this module is to add an abstract model to be inherited.
So, you will not notice any changes on install.

To develop using this module, you have to inherit the abstract model `conditional.image.consumer.mixin`
to the model that needs the conditional images::

class ResPartner(models.Model):
_inherit = ['res.partner', 'conditional.image.consumer.mixin']
_name = 'res.partner'

Then, configure how the images will be selected for each record.

Usage
=====

Go to *Technical Settings > Settings > Images* to configure all the images.
You can define images for specific objects, depending on the attributes and the company of the object.

The `selector` should return a boolean expression. All fields of the object are available to compute the result.

The system will first try to match an image with a company set up, then with the ones without a company.
If your object does not have a `company_id` field, this check will be ignored and only images without a company will be used.

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us smashing it by providing a detailed and welcomed
`feedback <https://github.com/OCA/server-tools/issues/new?body=module:%20base_conditional_image%0Aversion:%2015.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

Do not contact contributors directly about support or help with technical issues.

Credits
=======

Authors
~~~~~~~

* Camptocamp

Contributors
~~~~~~~~~~~~

* `Camptocamp <https://camptocamp.com/>`_:
* Patrick Tombez <patrick.tombez@camptocamp.com>
* Denis Leemann <denis.leemann@camptocamp.com>
* `Trobz <https://trobz.com>`_:
* Son Ho <sonhd@trobz.com>

Other credits
~~~~~~~~~~~~~

The migration of this module from 12.0 to 14.0 was financially supported by Camptocamp

Maintainers
~~~~~~~~~~~

This module is maintained by the OCA.

.. image:: https://odoo-community.org/logo.png
:alt: Odoo Community Association
:target: https://odoo-community.org

OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.

This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/15.0/base_conditional_image>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
1 change: 1 addition & 0 deletions base_conditional_image/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
from . import models
20 changes: 20 additions & 0 deletions base_conditional_image/__manifest__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Copyright 2019-2022 Camptocamp SA
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html)

{
"name": "Conditional Images",
"summary": "This module extends the functionality to support conditional images",
"version": "16.0.1.0.0",
"author": "Camptocamp, Odoo Community Association (OCA)",
"license": "AGPL-3",
"category": "Misc",
"depends": [
"base",
],
"website": "https://github.com/OCA/server-tools",
"data": [
"views/image_view.xml",
"security/ir.model.access.csv",
],
"installable": True,
}
133 changes: 133 additions & 0 deletions base_conditional_image/i18n/base_conditional_image.pot
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
# Translation of Odoo Server.
# This file contains the translation of the following modules:
# * base_conditional_image
#
msgid ""
msgstr ""
"Project-Id-Version: Odoo Server 15.0\n"
"Report-Msgid-Bugs-To: \n"
"Last-Translator: \n"
"Language-Team: \n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: \n"
"Plural-Forms: \n"

#. module: base_conditional_image
#: model:ir.model.fields,field_description:base_conditional_image.field_conditional_image__company_id
msgid "Company"
msgstr ""

#. module: base_conditional_image
#: model:ir.model.fields,help:base_conditional_image.field_conditional_image__company_id
msgid ""
"Company related check. If inherited object does not have a `company_id` "
"field, it will be ignored. The check will first take the records with a "
"company then, if no match is found, the ones without a company."
msgstr ""

#. module: base_conditional_image
#: model:ir.model,name:base_conditional_image.model_conditional_image
#: model_terms:ir.ui.view,arch_db:base_conditional_image.view_conditional_image_form
msgid "Conditional Image"
msgstr ""

#. module: base_conditional_image
#: model:ir.actions.act_window,name:base_conditional_image.conditional_image_action
#: model:ir.ui.menu,name:base_conditional_image.conditional_image_menu
msgid "Conditional Images"
msgstr ""

#. module: base_conditional_image
#: model:ir.model.fields,field_description:base_conditional_image.field_conditional_image__create_uid
msgid "Created by"
msgstr ""

#. module: base_conditional_image
#: model:ir.model.fields,field_description:base_conditional_image.field_conditional_image__create_date
msgid "Created on"
msgstr ""

#. module: base_conditional_image
#: model:ir.model.fields,field_description:base_conditional_image.field_conditional_image__display_name
msgid "Display Name"
msgstr ""

#. module: base_conditional_image
#: model:ir.model.fields,field_description:base_conditional_image.field_conditional_image__id
msgid "ID"
msgstr ""

#. module: base_conditional_image
#: model:ir.model.fields,field_description:base_conditional_image.field_conditional_image__image_1920
#: model:ir.model.fields,field_description:base_conditional_image.field_conditional_image_consumer_mixin__image_1920
msgid "Image"
msgstr ""

#. module: base_conditional_image
#: model:ir.model.fields,field_description:base_conditional_image.field_conditional_image__image_1024
#: model:ir.model.fields,field_description:base_conditional_image.field_conditional_image_consumer_mixin__image_1024
msgid "Image 1024"
msgstr ""

#. module: base_conditional_image
#: model:ir.model.fields,field_description:base_conditional_image.field_conditional_image__image_128
#: model:ir.model.fields,field_description:base_conditional_image.field_conditional_image_consumer_mixin__image_128
msgid "Image 128"
msgstr ""

#. module: base_conditional_image
#: model:ir.model.fields,field_description:base_conditional_image.field_conditional_image__image_256
#: model:ir.model.fields,field_description:base_conditional_image.field_conditional_image_consumer_mixin__image_256
msgid "Image 256"
msgstr ""

#. module: base_conditional_image
#: model:ir.model.fields,field_description:base_conditional_image.field_conditional_image__image_512
#: model:ir.model.fields,field_description:base_conditional_image.field_conditional_image_consumer_mixin__image_512
msgid "Image 512"
msgstr ""

#. module: base_conditional_image
#: model:ir.model.fields,field_description:base_conditional_image.field_conditional_image____last_update
msgid "Last Modified on"
msgstr ""

#. module: base_conditional_image
#: model:ir.model.fields,field_description:base_conditional_image.field_conditional_image__write_uid
msgid "Last Updated by"
msgstr ""

#. module: base_conditional_image
#: model:ir.model.fields,field_description:base_conditional_image.field_conditional_image__write_date
msgid "Last Updated on"
msgstr ""

#. module: base_conditional_image
#: model:ir.model,name:base_conditional_image.model_conditional_image_consumer_mixin
msgid "Mixin for conditional images consumers"
msgstr ""

#. module: base_conditional_image
#: model:ir.model.fields,field_description:base_conditional_image.field_conditional_image__model_name
msgid "Model Name"
msgstr ""

#. module: base_conditional_image
#: model:ir.model.fields,field_description:base_conditional_image.field_conditional_image__name
msgid "Name"
msgstr ""

#. module: base_conditional_image
#: model:ir.model.fields,help:base_conditional_image.field_conditional_image__selector
msgid ""
"Python expression used as selector when multiple images are usedfor the same"
" object. The variable `object` refers to the actual record on which the "
"expression will be executed. An empty expression will always return `True`."
msgstr ""

#. module: base_conditional_image
#: model:ir.model.fields,field_description:base_conditional_image.field_conditional_image__selector
#: model_terms:ir.ui.view,arch_db:base_conditional_image.view_conditional_image_form
msgid "Selector"
msgstr ""
Loading