(2011-03-09) this page is under preparation

This page lists the technical changes that may be useful for plugin and theme developpers to make their extension compatible with Piwigo 2.2.

If the adminstration main page of your plugin is plugins/plugin_directory/admin.php, then you can simplify the URL of your plugin in the main.inc.php from this:

add_event_handler('get_admin_plugin_menu_links', 'localfiles_admin_menu');
function localfiles_admin_menu($menu)
{
  array_push(
    $menu,
    array(
      'NAME' => 'LocalFiles Editor',
      'URL' => get_admin_plugin_menu_link(LOCALEDIT_PATH . 'admin.php')
      )
    );
 
  return $menu;
}

into this:

add_event_handler('get_admin_plugin_menu_links', 'localfiles_admin_menu');
function localfiles_admin_menu($menu)
{
  array_push(
    $menu,
    array(
      'NAME' => 'LocalFiles Editor',
      'URL' => get_root_url().'admin.php?page=plugin-'.basename(dirname(__FILE__))
      )
    );
 
  return $menu;
}

• admin.php?page=plugin&section=LocalFilesEditor%2Fadmin.php (ugly) in Piwigo 2.1
• admin.php?page=plugin-LocalFilesEditor (nice) in Piwigo 2.2

Even better, if you have several tabs on your plugin administration screen, you can append -tabName in the “page” URL parameter.

• admin.php?page=plugin&section=LocalFilesEditor%2Fadmin.php&tab=css (ugly) in Piwigo 2.1
• admin.php?page=plugin-LocalFilesEditor-css (nice) in Piwigo 2.2

If you use the ./local directory to store your theme/plugin configuration, I suggest to move configuration to the “config” table which does a very good job. If you want to keep configuration in a separate file, don't hard code the ./local/ directory, user $conf['local_dir'] instead.

Starting from Piwigo 2.2, it is possible to run several photo galleries with the same installation of Piwigo, this is a basic multisite feature and each site has its own $conf['local_dir']

Because it was not that useful and had impact on many files, we've decided to remove the Adviser mode. In your PHP files, remove the:

if (is_adviser())

and in the TPL files, remove the:

{$TAG_INPUT_ENABLED}

The function is_adviser() is deprecated but not removed : it will always return false.

To reduce the number of HTTP requests from the visitor web browser to the web server, we use the new “combine_css” method, which merge several CSS files into a single one, minified.

Piwigo 2.1

{html_head}<link rel="stylesheet" type="text/css" href="{$LOCALEDIT_PATH}locfiledit.css">{/html_head}

Piwigo 2.2

{combine_css path="plugins/LocalFilesEditor/locfiledit.css"}

For coding steps, before releasing your theme/plugin, you can deactivate the combine_css feature :

$conf['template_combine_files'] = false;

To reduce the number of HTTP requests from the visitor web browser to the web server, we use the new “combine script” method, which merge several javascript files into a single one, minified.

{combine_script id='core.scripts' load='async' path='themes/default/js/scripts.js'}
{combine_script id='rating' load='async' require='core.scripts' path='themes/default/js/rating.js'}
{combine_script id='jquery' path='themes/default/js/jquery.min.js'}
{combine_script id='jquery.cluetip' load='async' require='jquery' path='themes/default/js/plugins/jquery.cluetip.js'}
 
{combine_script id="jquery" load="async"}
{combine_script id="jquery.ui" load="async"}
{combine_script id="jquery.ui.draggable" load="async"}

• id : a string that makes the javascript file unique
• load : header/footer/async. header and footer values means the javascript file need to be loaded by the web browser to display the page. Try to use “async” if possible, to speed up page display. For example Google Analytics javascript could be “async”.
• require : the id of the parent javascript file. You can define several ids, separated by commas : “jquery, jquery.ui,mon_script”
• path : relative to the “root url” of your gallery

Note: the “require” argument is optionnal for jquery, jquery.ui, jquery.effects all jquery plugins jquery.ui.xxxx or jquery.effects.xxxx. The “path” is optionnal is the javascript file can be found under themes/default/js/ui.

To write javascript code inside your template (with dependencies on one or several javascript files)

{footer_script require='jquery.ui.xxxx'}{literal}
jQuery(document).ready(function() {
  alert("This is a test");
});
{/literal}{/footer_script}

No need to have a “require” in your footer_script. You can have a piece of javascript code in your template file that you want to be executed at the end of the page, like this:

{footer_script}{literal}
alert("This is a test");
{/literal}{/footer_script}

{known_script id="jquery.fcbkcomplete" src=$ROOT_URL|@cat:"themes/default/js/plugins/jquery.fcbkcomplete.js"}
{literal}
<script type="text/javascript">
  $(document).ready(function() {
    $("#tags").fcbkcomplete({
      json_url: "admin.php?fckb_tags=1",
      cache: false,
      filter_case: false,
      filter_hide: true,
      firstselected: true,
      filter_selected: true,
      maxitems: 100,
      newel: true
    });
  });
</script>
{/literal}

becomes:

{combine_script id='jquery.fcbkcomplete' load='footer' require='jquery' path='themes/default/js/plugins/jquery.fcbkcomplete.js'}
 
{footer_script require='jquery.fcbkcomplete'}{literal}
jQuery(document).ready(function() {
  jQuery("#tags").fcbkcomplete({
    json_url: "admin.php?fckb_tags=1",
    cache: false,
    filter_case: false,
    filter_hide: true,
    firstselected: true,
    filter_selected: true,
    maxitems: 100,
    newel: true
  });
});
{/literal}{/footer_script}

{known_script id="jquery" src=$ROOT_URL|@cat:"themes/default/js/jquery.packed.js"}
{known_script id="jquery.ui" src=$ROOT_URL|@cat:"themes/default/js/ui/packed/ui.core.packed.js" }
{known_script id="jquery.ui.sortable" src=$ROOT_URL|@cat:"themes/default/js/ui/packed/ui.sortable.packed.js" }
 
{literal}
<script type="text/javascript">
jQuery().ready(function(){
  jQuery(".catPos").hide();
  jQuery(".drag_button").show();
  jQuery(".categoryLi").css("cursor","move");
  jQuery(".categoryUl").sortable({
    axis: "y",
    opacity: 0.8
  });
});
</script>
{/literal}

becomes:

{footer_script require='jquery.ui.sortable'}{literal}
jQuery(document).ready(function() {
  jQuery(".catPos").hide();
  jQuery(".drag_button").show();
  jQuery(".categoryLi").css("cursor","move");
  jQuery(".categoryUl").sortable({
    axis: "y",
    opacity: 0.8
  });
});
{/literal}{/footer_script}

No need to use combined_script, because Piwigo will automatically load jquery.ui.sortable, which automatically requires jquery.ui which automatically requires jquery. It works because jquery.ui.sortable is available in themes/default/js/ui