The Gallery Plugin Class. Help you building powerful image galleries nearly automatically. More...

Public Member Functions
	__construct ()
	define JS function doImageAction gallery constructor. More...

	checkDir ($folder)
	check if folder exists and create it on demand More...

	drawFolderSelect ($lang, $path)
	draw (output) html folder select field, containing the sub folders of /media/images as value More...

	drawFolderSelectFromGallery ($path, $folder)
	draw (output) html folder select field, containing the current folder of /media/images as value More...

	scanFonts ($path)
	scan system font directory for fonts and return fonts as select field option value More...

	scanImageDirectory ($path)
	scan image directory and return images as select field option value More...

Detailed Description

The Gallery Plugin Class. Help you building powerful image galleries nearly automatically.

Gallery Plugin

Whenever you build a website, sooner or later you will get to the point where you need to put a few photos within a lightbox on your page. YaWK's gallery plugin help you out! It can build image galleries automatically. It does a perfect batch job adding a watermark to every image or resize images and much more. To add a new gallery, just place all your images in any folder and put that folder fia ftp to /media/images/{yourfolder}. If you don't like to use ftp, you could also use yawk's built-in file manager to upload your files. Once the upload is complete, go back to the gallery plugin and select your uploaded folder. (Or any other folder that is stored under /media/images) Set some settings and you're ready to go. When the gallery is created, load the gallery widget into any layout position you like, select which gallery to show up and you are done.

Basic Features:

put a text watermark onto all your images
change color and style of your watermark text
use any custom .ttf font (must be in /system/fonts)
or watermark images overlaying any transparent image (eg. your logo as .png)
watermark placement at bottom, middle or top, left or right with any margin
change the size of your images
flip horizontal or vertical
rotate around 90 degrees
fit to width
fit to height
fit to thumbnail
auto create thumbnails with the size of your need

Image Manipulation: irrespective from all of that, you can easy overview all images on a page and adjust

brightness
contrast
sharpen
blur
magic flatten
sepia and much more with just a few clicks!

Try it out - this is a really biiiig time-saver! In most cases you don't need to open all images in photoshop. (or something else) Think about it: you don't need to open, edit and save every single image for each - Yet another WebKit's Gallery Plugin is here to do that automatically for you - you just need to set a few parameters, do a single click... - and everything will get set-up as you wish.

Class covers backend functionality only. See Methods Summary for Details!

Author: Daniel Retzl danie.nosp@m.lret.nosp@m.zl@gm.nosp@m.ail..nosp@m.com

Copyright: 2009-2016 Daniel Retzl

Version: 1.0.0/

Since: File available since Release 1.0.0

Definition at line 49 of file gallery.php.

Constructor & Destructor Documentation

◆ __construct()

YAWK\PLUGINS\GALLERY\gallery::__construct ( )

define JS function doImageAction gallery constructor.

Definition at line 120 of file gallery.php.

         {
             echo "<script type=\"text/javascript\">
                 function doImageAction(action, id, folder, filename, itemID, createThumbnails, thumbnailWidth, watermark, watermarkImage, watermarkOpacity, watermarkPosition, offsetX, offsetY, watermarkFont, watermarkTextSize, watermarkColor, watermarkBorderColor, watermarkBorder) 
                 {                    
                     $.ajax({
                         url:'../system/plugins/gallery/js/actions.php',
                         type:'post',
                         data:'action='+action+'&id='+id+'&folder='+folder+'&filename='+filename+'&itemID='+itemID+'&createThumbnails='+createThumbnails+'&thumbnailWidth='+thumbnailWidth+'&watermark='+watermark+'&watermarkImage='+watermarkImage+'&watermarkOpacity='+watermarkOpacity+'&watermarkPosition='+watermarkPosition+'&offsetX='+offsetX+'&offsetY='+offsetY+'&watermarkFont='+watermarkFont+'&watermarkTextSize='+watermarkTextSize+'&watermarkColor='+watermarkColor+'&watermarkBorderColor='+watermarkBorderColor+'&watermarkBorder='+watermarkBorder,
                         dataType: 'json',
                         // dataType: 'json',
                         success: function(data)
                         {   
                         // alert(data.status);
                          var status = data.status;
                          var action = data.action;
                          if(status == 'delete')
                          {   // delete successful, reload page afterwards to update gallery view
                              // console.log( data );
                              $('#imgCol-'+itemID).hide();
                              $('#toolset-'+itemID).hide();
                              return true;
                              // location.reload();
                          }
                          if(status == 'true') 
                          {  // after any other action, reload that image to see changes
                             $('#img-'+itemID).hide().removeAttr('src').attr('src', '../'+folder+'/'+filename+'?'+Math.random()).show();
                             return true;
                          }
                          if(status == 'false')
                          {  // could not manipulate image
                             alert('Sorry, the action '+action+'could not be done.');
                             return false;
                          }
                          else 
                          {  // any other error
                             alert('Sorry, undefined error executing '+action+'. Maybe there is a problem with your image folders, files or permissions.');
                             return false;
                          }
                         }
                     });
                 }
                 </script>";
         }

Member Function Documentation

◆ checkDir()

YAWK\PLUGINS\GALLERY\gallery::checkDir ( $folder )

check if folder exists and create it on demand

Parameters

string $folder affected folder

Returns: bool

Definition at line 196 of file gallery.php.

         {   // check if directory exists
             if (!is_dir("$folder/")) {   // folder does not exist, create it
                 if (mkdir("$folder/")) {   // folder created,
                     return true;
                 } else {   // could not create folder
                     return false;
                 }
             } else {   // directory exists
                 return true;
             }
         }

◆ drawFolderSelect()

YAWK\PLUGINS\GALLERY\gallery::drawFolderSelect	(	$lang,
		$path
	)

draw (output) html folder select field, containing the sub folders of /media/images as value

Parameters

array	$lang	language array
string	$path	usually media/images/

Definition at line 170 of file gallery.php.

         {
             echo "<select name=\"folder\" class=\"form-control\" id=\"folder\">
                   <option value=\"\">$lang[SELECT_FOLDER]</option>
                   " . self::scanImageDirectory($path) . "
                   </select>";
         }

References YAWK\PLUGINS\GALLERY\gallery\scanImageDirectory().

◆ drawFolderSelectFromGallery()

YAWK\PLUGINS\GALLERY\gallery::drawFolderSelectFromGallery	(	$path,
		$folder
	)

draw (output) html folder select field, containing the current folder of /media/images as value

Parameters

string	$path	usually media/images/
string	$folder	the folder of this gallery

Definition at line 183 of file gallery.php.

         {
             echo "<select name=\"folder\" class=\"form-control\" id=\"folder\">
                   <option value=\"$folder\">$folder</option>
                   " . self::scanImageDirectory($path) . "
                   </select>";
         }

References YAWK\PLUGINS\GALLERY\gallery\scanImageDirectory().

◆ scanFonts()

YAWK\PLUGINS\GALLERY\gallery::scanFonts ( $path )

scan system font directory for fonts and return fonts as select field option value

Parameters

string $path the path to search for fonts. If its empty, the default folder will be ../system/fonts/

Returns: string oprion value containing all fonts from font directory

Definition at line 215 of file gallery.php.

         {
             $html = '';
             if (!isset($path)) {
                 $path = "../system/fonts/"; // '.' for current
             }
             foreach (new \DirectoryIterator("$path") as $file) {
                 if ($file->isDot()) continue;
                 if ($file->isDir()) continue;
                 if ($file->getExtension() === "ttf") {
                     // print $file->getFilename() . '<br>';
                     $html .= "<option value=\"$path" . $file->getFilename() . "\">system/fonts/" . $file->getFilename() . "</option>";
                 }
  
             }
             return $html;
         }

◆ scanImageDirectory()

YAWK\PLUGINS\GALLERY\gallery::scanImageDirectory ( $path )

scan image directory and return images as select field option value

Parameters

string $path usually media/images/

Returns: string option value containing all fonts from font directory

Definition at line 238 of file gallery.php.

         {
             $html = '';
             if (!isset($path)) {
                 $path = "media/images/"; // '.' for current
             }
             foreach (new \DirectoryIterator("../$path") as $file) {
                 if ($file->isDot()) continue;
                 if ($file->isDir()) {
                     // print $file->getFilename() . '<br>';
                     $html .= "<option value=\"$path" . $file->getFilename() . "\">images/" . $file->getFilename() . "</option>";
                 }
             }
             return $html;
         }

Referenced by YAWK\PLUGINS\GALLERY\gallery\drawFolderSelect(), and YAWK\PLUGINS\GALLERY\gallery\drawFolderSelectFromGallery().

Member Data Documentation

◆ $action

YAWK\PLUGINS\GALLERY\gallery::$action

Parameters

string image manipulation action (eg. flip-horizontal)

Definition at line 58 of file gallery.php.

◆ $author

YAWK\PLUGINS\GALLERY\gallery::$author

Parameters

string images author (originator, photographer)

Definition at line 68 of file gallery.php.

◆ $authorUrl

YAWK\PLUGINS\GALLERY\gallery::$authorUrl

Parameters

string images author's url (originator, photographer)

Definition at line 70 of file gallery.php.

◆ $createThumbnails

YAWK\PLUGINS\GALLERY\gallery::$createThumbnails

Parameters

int 0|1 switch: 1 if thumbnails should be created, zero if not.

Definition at line 78 of file gallery.php.

◆ $description

YAWK\PLUGINS\GALLERY\gallery::$description

Parameters

string gallery description

Definition at line 66 of file gallery.php.

◆ $filename

YAWK\PLUGINS\GALLERY\gallery::$filename

Parameters

string image filename

Definition at line 76 of file gallery.php.

◆ $folder

YAWK\PLUGINS\GALLERY\gallery::$folder

Parameters

string images folder

Definition at line 60 of file gallery.php.

◆ $headline

YAWK\PLUGINS\GALLERY\gallery::$headline

Parameters

string headline

Definition at line 114 of file gallery.php.

◆ $id

YAWK\PLUGINS\GALLERY\gallery::$id

Parameters

int gallery ID

Definition at line 52 of file gallery.php.

◆ $imageHeight

YAWK\PLUGINS\GALLERY\gallery::$imageHeight

Parameters

int image height in px

Definition at line 82 of file gallery.php.

◆ $imageWidth

YAWK\PLUGINS\GALLERY\gallery::$imageWidth

Parameters

int image width in px

Definition at line 80 of file gallery.php.

◆ $itemAuthor

YAWK\PLUGINS\GALLERY\gallery::$itemAuthor

Parameters

string single image author (originator, photographer)

Definition at line 72 of file gallery.php.

◆ $itemAuthorUrl

YAWK\PLUGINS\GALLERY\gallery::$itemAuthorUrl

Parameters

string single image author's url (originator, photographer)

Definition at line 74 of file gallery.php.

◆ $itemID

YAWK\PLUGINS\GALLERY\gallery::$itemID

Parameters

int item ID

Definition at line 54 of file gallery.php.

◆ $itemTitle

YAWK\PLUGINS\GALLERY\gallery::$itemTitle

Parameters

string item title

Definition at line 64 of file gallery.php.

◆ $offsetX

YAWK\PLUGINS\GALLERY\gallery::$offsetX

Parameters

int offset X in px

Definition at line 100 of file gallery.php.

◆ $offsetY

YAWK\PLUGINS\GALLERY\gallery::$offsetY

Parameters

int offset Y in px

Definition at line 98 of file gallery.php.

◆ $resizeImages

YAWK\PLUGINS\GALLERY\gallery::$resizeImages

Parameters

int 0|1 switch: 1 if images should be resized, zero if not

Definition at line 84 of file gallery.php.

◆ $resizeType

YAWK\PLUGINS\GALLERY\gallery::$resizeType

Parameters

string type of resizing (eg. thumbnail or fit to width...)

Definition at line 86 of file gallery.php.

◆ $sort

YAWK\PLUGINS\GALLERY\gallery::$sort

Parameters

int order sortation number

Definition at line 56 of file gallery.php.

◆ $thumbnailWidth

YAWK\PLUGINS\GALLERY\gallery::$thumbnailWidth

Parameters

int thumbnail width in px

Definition at line 88 of file gallery.php.

◆ $title

YAWK\PLUGINS\GALLERY\gallery::$title

Parameters

string gallery title

Definition at line 62 of file gallery.php.

◆ $watermark

YAWK\PLUGINS\GALLERY\gallery::$watermark

Parameters

string watermark text

Definition at line 90 of file gallery.php.

◆ $watermarkBorder

YAWK\PLUGINS\GALLERY\gallery::$watermarkBorder

Parameters

string watermark border thickness in px

Definition at line 112 of file gallery.php.

◆ $watermarkBorderColor

YAWK\PLUGINS\GALLERY\gallery::$watermarkBorderColor

Parameters

string watermark text border color

Definition at line 110 of file gallery.php.

◆ $watermarkColor

YAWK\PLUGINS\GALLERY\gallery::$watermarkColor

Parameters

string watermark text color

Definition at line 108 of file gallery.php.

◆ $watermarkEnabled

YAWK\PLUGINS\GALLERY\gallery::$watermarkEnabled

Parameters

int 0|1 switch: 1 if watermark is enabled, zero if not

Definition at line 92 of file gallery.php.

◆ $watermarkFont

YAWK\PLUGINS\GALLERY\gallery::$watermarkFont

Parameters

string path and filename of the .ttf font to use for text watermarking

Definition at line 102 of file gallery.php.

◆ $watermarkImage

YAWK\PLUGINS\GALLERY\gallery::$watermarkImage

Parameters

string the image which should be overlayed for watermarking

Definition at line 94 of file gallery.php.

◆ $watermarkOpacity

YAWK\PLUGINS\GALLERY\gallery::$watermarkOpacity

Parameters

int watermark opacity

Definition at line 106 of file gallery.php.

◆ $watermarkPosition

YAWK\PLUGINS\GALLERY\gallery::$watermarkPosition

Parameters

string watermark position

Definition at line 96 of file gallery.php.

◆ $watermarkTextSize

YAWK\PLUGINS\GALLERY\gallery::$watermarkTextSize

Parameters

int watermark text size in pt

Definition at line 104 of file gallery.php.

The documentation for this class was generated from the following file:

/var/www/htdocs/yawk.io/system/plugins/gallery/classes/gallery.php

Public Attributes
	$action

	$author

	$authorUrl

	$createThumbnails

	$description

	$filename

	$folder

	$headline

	$id

	$imageHeight

	$imageWidth

	$itemAuthor

	$itemAuthorUrl

	$itemID

	$itemTitle

	$offsetX

	$offsetY

	$resizeImages

	$resizeType

	$sort

	$thumbnailWidth

	$title

	$watermark

	$watermarkBorder

	$watermarkBorderColor

	$watermarkColor

	$watermarkEnabled

	$watermarkFont

	$watermarkImage

	$watermarkOpacity

	$watermarkPosition

	$watermarkTextSize

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkDir()

◆ drawFolderSelect()

◆ drawFolderSelectFromGallery()

◆ scanFonts()

◆ scanImageDirectory()

Member Data Documentation

◆ $action

◆ $author

◆ $authorUrl

◆ $createThumbnails

◆ $description

◆ $filename

◆ $folder

◆ $headline

◆ $id

◆ $imageHeight

◆ $imageWidth

◆ $itemAuthor

◆ $itemAuthorUrl

◆ $itemID

◆ $itemTitle

◆ $offsetX

◆ $offsetY

◆ $resizeImages

◆ $resizeType

◆ $sort

◆ $thumbnailWidth

◆ $title

◆ $watermark

◆ $watermarkBorder

◆ $watermarkBorderColor

◆ $watermarkColor

◆ $watermarkEnabled

◆ $watermarkFont

◆ $watermarkImage

◆ $watermarkOpacity

◆ $watermarkPosition

◆ $watermarkTextSize