summaryrefslogtreecommitdiff
path: root/liberty_plugins/data.carousel.php
blob: 0d0d8331c1bfbd73336698fcff0dbca26f205bc6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
<?php
/**
 * @version  $Revision$
 * $Header$
 * @package  liberty
 * @subpackage plugins_storage
 */

/**
 * required setup
 */
namespace Bitweaver\Liberty;
use Bitweaver\Fisheye\FisheyeImage;
use Bitweaver\BitBase;
use Bitweaver\KernelTools;

/**
 * definitions
 */
define( 'PLUGIN_GUID_DATACAROUSEL', 'datacarousel' );

global $gLibertySystem;

$pluginParams = [
	'tag'           => 'carousel',
	'title'         => 'Fisheye Carousel',
	'description'   => KernelTools::tra( "Display a carousel of images in other content. This plugin only works with files that have been uploaded using fisheye." ),
	'help_page'     => 'DataPluginCarousel',

	'auto_activate' => false,
	'requires_pair' => false,
	'syntax'        => '{carousel id= }',
	'plugin_type'   => DATA_PLUGIN,

	// display icon in quicktags bar
	'booticon'       => '{booticon iname="icon-picture" iexplain="Image"}',
	'taginsert'     => '{carousel id= size= nolink=}',

	// functions
	'help_function' => 'data_carousel_help',
	'load_function' => 'data_carousel',
];
$gLibertySystem->registerPlugin( PLUGIN_GUID_DATACAROUSEL, $pluginParams );
$gLibertySystem->registerDataTag( $pluginParams['tag'], PLUGIN_GUID_DATACAROUSEL );


function data_carousel( $pData, $pParams ) {
	global $gBitSystem, $gBitSmarty;
	$ret = ' ';

	$imgStyle = '';

	$wrapper = \Bitweaver\Liberty\liberty_plugins_wrapper_style( $pParams );

	$description = !isset( $wrapper['description'] ) ? $wrapper['description'] : null;
	foreach( $pParams as $key => $value ) {
		if( !empty( $value ) ) {
			switch( $key ) {
				// rename a couple of parameters
				case 'width':
				case 'height':
					if( preg_match( "/^\d+(em|px|%|pt)$/", trim( $value ) ) ) {
						$imgStyle .= $key.':'.$value.';';
					} elseif( preg_match( "/^\d+$/", $value ) ) {
						$imgStyle .= $key.':'.$value.'px;';
					}
					// remove values from the hash that they don't get used in the div as well
					$pParams[$key] = null;
					break;
			}
		}
	}

	$wrapper = \Bitweaver\Liberty\liberty_plugins_wrapper_style( $pParams );
	$pParams['nolink'] = 'yes';
	if( !empty( $pParams['src'] ) ) {
		$thumbUrl = $pParams['src'];
	} elseif( BitBase::verifyId( $pParams['id'] ) && $gBitSystem->isPackageActive( 'fisheye' )) {

		$gallery = new FisheyeImage();
		$listHash = $pParams;
		$listHash['size'] = 'large';
		$listHash['gallery_id'] = $pParams['id'];
		$listHash['max_records'] = 10;
		$listHash['sort_mode'] = 'item_position_asc';
		$images = $gallery->getList( $listHash );
		$num=count($images);

		$out = '<div class="carousel slide" data-ride="carousel" id="myCarousel">';
		$out .= '<ol class="carousel-indicators">';
		$out .= '<li class="active" data-slide-to="0" data-target="#myCarousel">&nbsp;</li>';
		for ( $i=1; $i<$num; $i++ ) { 
			$out .= '<li data-slide-to="'.$i.'" data-target="#myCarousel">&nbsp;</li>';
		} 
		$out .= '</ol>';
		$out .= '<div class="carousel-inner" role="listbox">';

		$i=0;
		foreach( $images as $image ) {
	  		// insert source url if we need the original file
			if( !empty( $pParams['size'] ) && $pParams['size'] == 'original' ) {
				$thumbUrl = $image['source_url'];
			} elseif( $image['thumbnail_url'] ) {
				$thumbUrl = $image['thumbnail_url'];
			}

			if( empty( $image['$description'] ) ) {
				$description = !isset( $wrapper['description'] ) ? $wrapper['description'] : $image['title'];
			}

			// check if we have a valid thumbnail
			if( !empty( $thumbUrl )) {
				$active =  $i == 0 ? $active = ' active' : '';
				$i++;
				// set up image first
				$ret = '<div class="item'.$active.'"><img class="img-responsive"'.
					' alt="'.  $description.'"'.
					' title="'.$description.'"'.
					' src="'  .$thumbUrl.'"'.
					' height="103" width="800"'.
					' /></div>';
		
				if( !empty( $pParams['nolink'] ) ) {
				} elseif( !empty( $wrapper['link'] ) ) {
					// if this image is linking to something, wrap the image with the <a>
					$ret = '<a href="'.trim( $wrapper['link'] ).'">'.$ret.'</a>';
				} elseif ( empty( $pParams['size'] ) || $pParams['size'] != 'original' ) {
					if ( $image['source_url'] ) {
						$ret = '<a href="'.trim( $image['source_url'] ).'">'.$ret.'</a>';
					} 
				}
		
				if( !empty( $wrapper['style'] ) || !empty( $class ) || !empty( $wrapper['description'] ) ) {
					$ret = '<'.$wrapper['wrapper'].' class="'.( !empty( $wrapper['class'] ) ? $wrapper['class'] : "img-responsive" ).'" style="'.$wrapper['style'].'">'.$ret.( !empty( $wrapper['description'] ) ? '<br />'.$wrapper['description'] : '' ).'</'.$wrapper['wrapper'].'>';
				}
			} else {
				$ret = KernelTools::tra( "Unknown Gallery" );
			}
			$out .= $ret;
		}
		$out .= '</div>';
		$out .= '<a class="left carousel-control" data-slide="prev" href="#myCarousel" role="button">';
		$out .= '<span class="sr-only">Previous</span> </a>';
		$out .= '<a class="right carousel-control" data-slide="next" href="#myCarousel" role="button">';
		$out .= '<span class="sr-only">Next</span> </a></div>';
		$out .= '</div>';
	}
	return $out;
}

function data_carousel_help() {
	$help =
		'<table class="data help">'
			.'<tr>'
				.'<th>' . KernelTools::tra( "Key" ) . '</th>'
				.'<th>' . KernelTools::tra( "Type" ) . '</th>'
				.'<th>' . KernelTools::tra( "Comments" ) . '</th>'
			.'</tr>'
			.'<tr class="odd">'
				.'<td>id</td>'
				.'<td>' . KernelTools::tra( "numeric") . '<br />' . KernelTools::tra("(required)") . '</td>'
				.'<td>' . KernelTools::tra( "gallery id number of Images to display inline.") . KernelTools::tra( "You can use either content_id or id." ).'</td>'
			.'</tr>'
			.'<tr class="even">'
				.'<td>size</td>'
				.'<td>' . KernelTools::tra( "key-words") . '<br />' . KernelTools::tra("(optional)") . '</td>'
				.'<td>' . KernelTools::tra( "If the File is an image, you can specify the size of the thumbnail displayed. Possible values are:") . ' <strong>avatar, small, medium, large, original</strong> '
				. KernelTools::tra( "(Default = " ) . '<strong>medium</strong>)</td>'
			.'</tr>'
			.'<tr class="odd">'
				.'<td>num</td>'
				.'<td>' . KernelTools::tra( "key-words") . '<br />' . KernelTools::tra("(optional)") . '</td>'
				.'<td>' . KernelTools::tra( "Number of images to display from the gallery") 
				. KernelTools::tra( "(Default = " ) . '<strong>10</strong>)</td>'
			.'</tr>'
		.'</table>'
		. KernelTools::tra( "Example: ") . "{carousel id='13' size='small'}";
	return $help;
}