Forums / Developer / Defining "methods" or "custom actions" for content classes?

Defining "methods" or "custom actions" for content classes?

Author Message

Deane Barker

Wednesday 07 December 2005 12:09:19 am

Is it possible to define methods on a content class? By "method," I mean is it possible to define something that content object will <i>do</i>, on demand?

Example --

Our users can create newsletters in eZ. A newsletter is a content class. It would be nice if -- after they've created and edited the newsletter -- that they could hit a button on the interface that said "Send This," and then eZ would run some PHP code that would send it.

I know you can do things in workflow, but that's not quite what we're looking for. We'd really just like some buttons on the interface that let the users "command" objects to do things.

In the admin templates, I've seen an iteration for "Custom Actions" which seems to generate some buttons, but I've never seen this referred to anywhere else.

Deane

Ɓukasz Serwatka

Wednesday 07 December 2005 12:27:30 am

It is possible to create custom actions in eZ publish. By default it comes with several like, creating new content, editing, collecting information and more.

You can place new actions in extension/mynewextension/actions/content_actionhandler.php

You will have to override content.ini in your extension and add
extension/mynewextension/settings/content.ini.append.php

[ActionSettings]
ExtensionDirectories[]=mynewextension

extension/mynewextension/actions/content_actionhandler.php

function name have to start with extension name, other ways it will not work

function mynewextension_ContentActionHandler( &$module, &$http, &$objectID )
{
    if( $http->hasPostVariable("CustomAction") )
    {
        //your custom action goes here
    }
}

In tpl you will need define form:

<form method="post" action="content/action">
    <input type="submit" name="CustomAction" value="Custom action" />
    <input name="ContentObjectID" type="hidden" value="102" />
</form>

ContentObjectID have to be included in POST.

For more examples look in to /kernel/content/action.php. I think you can re-use some code.

Hope it will help you.

Personal website -> http://serwatka.net
Blog (about eZ Publish) -> http://serwatka.net/blog

Deane Barker

Wednesday 07 December 2005 5:55:12 am

Wonderful, thank you. I remember seeing that one line of template code ages ago, but I could never find any documentation on it. This is fantastic.

Andrew K

Tuesday 18 July 2006 6:59:37 am

Yup. That's what I'm looking for!
Thanks.

--Andrew

eZ debug

Timing: Jan 18 2025 15:55:14
Script start
Timing: Jan 18 2025 15:55:14
Module start 'content'
Timing: Jan 18 2025 15:55:15
Module end 'content'
Timing: Jan 18 2025 15:55:15
Script end

Main resources:

Total runtime0.8765 sec
Peak memory usage4,096.0000 KB
Database Queries199

Timing points:

CheckpointStart (sec)Duration (sec)Memory at start (KB)Memory used (KB)
Script start 0.00000.0054 587.9375180.8125
Module start 'content' 0.00550.7236 768.7500600.8281
Module end 'content' 0.72900.1474 1,369.5781337.3828
Script end 0.8764  1,706.9609 

Time accumulators:

 Accumulator Duration (sec) Duration (%) Count Average (sec)
Ini load
Load cache0.00380.4393210.0002
Check MTime0.00150.1687210.0001
Mysql Total
Database connection0.00080.086610.0008
Mysqli_queries0.801891.47991990.0040
Looping result0.00210.23981970.0000
Template Total0.845196.420.4226
Template load0.00220.249620.0011
Template processing0.842996.171920.4215
Template load and register function0.00010.013510.0001
states
state_id_array0.00660.752910.0066
state_identifier_array0.00080.092320.0004
Override
Cache load0.00180.2024330.0001
Sytem overhead
Fetch class attribute can translate value0.00110.130340.0003
Fetch class attribute name0.00120.133860.0002
XML
Image XML parsing0.00170.190140.0004
class_abstraction
Instantiating content class attribute0.00000.001970.0000
General
dbfile0.00540.6108350.0002
String conversion0.00000.000530.0000
Note: percentages do not add up to 100% because some accumulators overlap

CSS/JS files loaded with "ezjscPacker" during request:

CacheTypePacklevelSourceFiles
CSS0extension/community/design/community/stylesheets/ext/jquery.autocomplete.css
extension/community_design/design/suncana/stylesheets/scrollbars.css
extension/community_design/design/suncana/stylesheets/tabs.css
extension/community_design/design/suncana/stylesheets/roadmap.css
extension/community_design/design/suncana/stylesheets/content.css
extension/community_design/design/suncana/stylesheets/star-rating.css
extension/community_design/design/suncana/stylesheets/syntax_and_custom_tags.css
extension/community_design/design/suncana/stylesheets/buttons.css
extension/community_design/design/suncana/stylesheets/tweetbox.css
extension/community_design/design/suncana/stylesheets/jquery.fancybox-1.3.4.css
extension/bcsmoothgallery/design/standard/stylesheets/magnific-popup.css
extension/sevenx/design/simple/stylesheets/star_rating.css
extension/sevenx/design/simple/stylesheets/libs/fontawesome/css/all.min.css
extension/sevenx/design/simple/stylesheets/main.v02.css
extension/sevenx/design/simple/stylesheets/main.v02.res.css
JS0extension/ezjscore/design/standard/lib/yui/3.17.2/build/yui/yui-min.js
extension/ezjscore/design/standard/javascript/jquery-3.7.0.min.js
extension/community_design/design/suncana/javascript/jquery.ui.core.min.js
extension/community_design/design/suncana/javascript/jquery.ui.widget.min.js
extension/community_design/design/suncana/javascript/jquery.easing.1.3.js
extension/community_design/design/suncana/javascript/jquery.ui.tabs.js
extension/community_design/design/suncana/javascript/jquery.hoverIntent.min.js
extension/community_design/design/suncana/javascript/jquery.popmenu.js
extension/community_design/design/suncana/javascript/jScrollPane.js
extension/community_design/design/suncana/javascript/jquery.mousewheel.js
extension/community_design/design/suncana/javascript/jquery.cycle.all.js
extension/sevenx/design/simple/javascript/jquery.scrollTo.js
extension/community_design/design/suncana/javascript/jquery.cookie.js
extension/community_design/design/suncana/javascript/ezstarrating_jquery.js
extension/community_design/design/suncana/javascript/jquery.initboxes.js
extension/community_design/design/suncana/javascript/app.js
extension/community_design/design/suncana/javascript/twitterwidget.js
extension/community_design/design/suncana/javascript/community.js
extension/community_design/design/suncana/javascript/roadmap.js
extension/community_design/design/suncana/javascript/ez.js
extension/community_design/design/suncana/javascript/ezshareevents.js
extension/sevenx/design/simple/javascript/main.js

Templates used to render the page:

UsageRequested templateTemplateTemplate loadedEditOverride
1node/view/full.tplfull/forum_topic.tplextension/sevenx/design/simple/override/templates/full/forum_topic.tplEdit templateOverride template
3content/datatype/view/ezimage.tpl<No override>extension/sevenx/design/simple/templates/content/datatype/view/ezimage.tplEdit templateOverride template
4content/datatype/view/ezxmltext.tpl<No override>extension/community_design/design/suncana/templates/content/datatype/view/ezxmltext.tplEdit templateOverride template
8content/datatype/view/ezxmltags/paragraph.tpl<No override>extension/ezwebin/design/ezwebin/templates/content/datatype/view/ezxmltags/paragraph.tplEdit templateOverride template
3content/datatype/view/ezxmltags/line.tpl<No override>design/standard/templates/content/datatype/view/ezxmltags/line.tplEdit templateOverride template
2content/datatype/view/ezxmltags/literal.tpl<No override>extension/community/design/standard/templates/content/datatype/view/ezxmltags/literal.tplEdit templateOverride template
1pagelayout.tpl<No override>extension/sevenx/design/simple/templates/pagelayout.tplEdit templateOverride template
 Number of times templates used: 22
 Number of unique templates used: 7

Time used to render debug report: 0.0002 secs