How to copy a PlaceholderField programatically?

[Nick Albright]

Hello!

First off, let me say how great django-cms is! We are installing into our
e-commerce site, and our marketing team *loves* the ease of use, and
ability to readily see what their changes look like!

I'm looking to add the ability to have 'timed' changes (ie, have this page
look like this from Oct 29-Oct 31). As part of that I need to copy a
PlaceholderField.

I saw this is possible in the web interface, and tried to use
the PlaceholderAdminMixin class and it's copy_plugins method, but it looks
to be too tied to the web site (ran into issues faking the 'admin_site'
variable :)

I was wondering what is the best way to copy the contents of a
PlaceholderField to another PlaceholderField, or from the same
PlaceholderField but a to different language.

Thanks for your time!
-Nick

P.S. Sorry if this is a duplicate post. I could have sworn I posted this
yesterday, but don't see it on the board.

[Daniele Procida]

Post by Nick Albright
I'm looking to add the ability to have 'timed' changes (ie, have this page
look like this from Oct 29-Oct 31). As part of that I need to copy a
PlaceholderField.

Hi Nick.

My first thought was that we should have an API for this. Well, I don't think we do!

We have copy_plugins_to_language() (see <http://docs.django-cms.org/en/release-3.4.x/reference/api_references.html#cms-api>), but that's different from what you want.

However, deeper down must be the methods that make this possible, and you should be able to use those.

Post by Nick Albright
I saw this is possible in the web interface, and tried to use
the PlaceholderAdminMixin class and it's copy_plugins method, but it looks
to be too tied to the web site (ran into issues faking the 'admin_site'
variable :)

I wouldn't do that. Start from the APIs, and dig deeper.

I haven't looked that closely at it, but it could be quite easy to achieve. Quite possibly it's something we should create a public API for.

Post by Nick Albright
I was wondering what is the best way to copy the contents of a
PlaceholderField to another PlaceholderField, or from the same
PlaceholderField but a to different language.

I think copy_plugins_to_language() will definitely get you half-way there.

Post by Nick Albright
P.S. Sorry if this is a duplicate post. I could have sworn I posted this
yesterday, but don't see it on the board.

Blasted Google Groups, it puts new users into moderation without telling them.

Daniele

[Nick Albright]

Thanks for your response! I dug into the code, and got something that
works for me. Here is my code!

METHOD_APPEND = 'Append'
METHOD_REPLACE = 'Replace'

def copy_placeholder_field( dest_placeholder, source_placeholder,
dest_language, source_language,
method = METHOD_REPLACE ):
"""



method - For the dest placeholder, do we append or replace the existing
info


"""


source_plugins = source_placeholder.get_plugins_list( language =
source_language )

if method == METHOD_REPLACE:
dest_placeholder.clear( dest_language )

# Shortcut if no plugins to copy - nla



if not source_plugins:
return

dest_tree_order = dest_placeholder.get_plugin_tree_order(
language=dest_language,
parent_id=None,
)

copied_plugins = copy_plugins.copy_plugins_to(
source_plugins,
to_placeholder=dest_placeholder,
to_language=dest_language,
)

new_plugin_ids = (new.pk for new, old in copied_plugins)

# Creates a list of PKs for the top-level plugins ordered by



# their position.



top_plugins = (pair for pair in copied_plugins if not pair[0].parent_id)
top_plugins_pks = [p[0].pk for p in sorted(top_plugins, key=lambda pair:
pair[1].position)]

# All new plugins are added to the bottom



dest_tree_order = dest_tree_order + top_plugins_pks

reorder_plugins(
dest_placeholder,
parent_id=None,
language=dest_language,
order=dest_tree_order,
)

Post by Daniele Procida

Post by Nick Albright
I'm looking to add the ability to have 'timed' changes (ie, have this

page

Post by Nick Albright
look like this from Oct 29-Oct 31). As part of that I need to copy a
PlaceholderField.

Hi Nick.
My first thought was that we should have an API for this. Well, I don't think we do!
We have copy_plugins_to_language() (see <
http://docs.django-cms.org/en/release-3.4.x/reference/api_references.html#cms-api>),
but that's different from what you want.
However, deeper down must be the methods that make this possible, and you
should be able to use those.

Post by Nick Albright
I saw this is possible in the web interface, and tried to use
the PlaceholderAdminMixin class and it's copy_plugins method, but it

looks

Post by Nick Albright
to be too tied to the web site (ran into issues faking the 'admin_site'
variable :)

I wouldn't do that. Start from the APIs, and dig deeper.
I haven't looked that closely at it, but it could be quite easy to
achieve. Quite possibly it's something we should create a public API for.

Post by Nick Albright
I was wondering what is the best way to copy the contents of a
PlaceholderField to another PlaceholderField, or from the same
PlaceholderField but a to different language.

I think copy_plugins_to_language() will definitely get you half-way there.

Post by Nick Albright
P.S. Sorry if this is a duplicate post. I could have sworn I posted this
yesterday, but don't see it on the board.

Blasted Google Groups, it puts new users into moderation without telling them.
Daniele