[ class tree: plugins ] [ index: plugins ] [ all elements ]

Procedural File: image_effects.php

Source Location: /zp-extensions/image_effects.php

Page Details

An example plugin demonstrating the use of the various "image_html" filters.

Each effect is defined by a text file these sections (no individual section is required).

<source>...</source> Documents the source of the effect

<head>...</head>: each effect will have a head section that contains the HTML to be emitted in the theme head.

<class>...</class>: elements from this section will be added to the class element of the <img src... /> tag.

<extra>..</extra>: It is also possible to create a extra section for html that will be inserted into the <img src... /> tag just befor the />. This can be used to insert style="..." or other elements.

<validate> file path </validate> used specially for Effenberger effects, but applicable to similar situations. Causes the named file to have its presence tested. If it is not present, the "effect" is not made available. Multiple files are separated by semicolons. Each is tested.

The following tokens are available to represent paths: %WEBPATH% to represent the WEB path to the Zenphoto installation. %SERVERPATH% to represent the server path to the Zenphoto installation. %PLUGIN_FOLDER% to represent the Zenphoto "extensions" folder. %USER_PLUGIN_FOLDER% to represent the root "plugin" folder. %ZENFOLDER% to represent the zp-core folder.

Pixastic effects: Included standard are several effects from http://www.pixastic.com/. Please visit their site for detailed documentation.

Effenberger effects: Some effects which can be used are the javascript effectscreated by Christian Effenberger which may be downloaded from his site: //www.netzgesta.de/cvi/

No effenberger effects are distributed with this plugin to conform with CVI licensing constraints. To add an effect to the plugin, download the zip file from the site. Extract the effect files and place in the image_effects folder (in the global plugins folder.)

For instance, to add the Reflex effect, download reflex.zip, unzip it, and place reflex.js in the folder. Check the image_effects foder in the zenphoto extensions to see if there is already header file. If not create one in the plugins/image_effects folder. Use as a model one of the other Effenberger effects header files.

Included some typical Effenberger files as examples. Simply provide the appropriate js script as above to activate them.

Author:  Stephen Billard (sbillard)
Classes
Class Description
image_effects The option handler class
Functions
image_custom_album_thumbs  [line 367]
Parameters:
   $html: 


void image_custom_album_thumbs( $html  )

[ Top ]
image_custom_images  [line 340]
Parameters:
   $html: 
   $thumbstandin: 


void image_custom_images( $html, $thumbstandin  )

[ Top ]
image_effectsJS  [line 73]

void image_effectsJS( )

[ Top ]
image_effects_getEffect  [line 257]
Parameters:
   $effect: 


void image_effects_getEffect( $effect  )

[ Top ]
image_effects_insertClass  [line 302]
Parameters:
   $html: 
   $effect: 


void image_effects_insertClass( $html, $effect  )

[ Top ]
image_std_album_thumbs  [line 353]
Parameters:
   $html: 


void image_std_album_thumbs( $html  )

[ Top ]
image_std_images  [line 333]
Parameters:
   $html: 


void image_std_images( $html  )

[ Top ]
image_std_image_thumbs  [line 360]
Parameters:
   $html: 


void image_std_image_thumbs( $html  )

[ Top ]


Documentation generated on Tue, 20 Dec 2011 16:07:30 +0100 by phpDocumentor 1.4.3