sekUserGalleries
Last updated Oct 27th, 2020 | Page history | Improve this page | Report an issue
Support the team building MODX with a monthly donation.
The budget raised through OpenCollective is transparent, including payouts, and any contributor can apply to be paid for their work on MODX.
Backers
Budget
$306 per month—let's make that $500!
Learn moreWhat is sekUserGalleries?¶
SekUserGalleries is a gallery manager designed for users to upload and manage personal galleries.
Requirements¶
- MODX Revolution 2.2.0-pl2 or later
- PHP5 or later
- Current beta version of sekUserGalleries requires sekFancyBox, which can be downloaded via Package Management, or from the MODX Extras Repository here: https://modx.com/extras/package/sekfancybox.
- Current beta version of sekUserGalleries requires sekFormTools, which can be downloaded via Package Management, or from the MODX Extras Repository here: https://modx.com/extras/package/sekformtools.
- Current beta version of sekUserGalleries requires sekSiteTools, which can be downloaded via Package Management, or from the MODX Extras Repository here: https://modx.com/extras/package/seksitetools.
- Login is recommended to manage users and can be downloaded via Package Management, or from the MODX Extras Repository, here: https://modx.com/extras/package/login (Login may have its own prerequisites).
History¶
SekUserGalleries was written by Stephen Smith, and first released on Mar 19th, 2012.
Download¶
It can be downloaded from within the MODX Revolution manager via [Package Management, or from the MODX Extras Repository, here: https://modx.com/extras/package/sekusergalleries.
Development and Bug Reporting¶
SekUserGalleries is on GitHub: https://github.com/insomnix/sekUserGalleries, report any issues or feature requests here: https://github.com/insomnix/sekUserGalleries/issues.
Usage¶
The sekUserGalleries is called through several snippets using the below tags ?(currently all snippets should be called on separate pages):
- sekUserGalleries.browse.galleries - This will display all the galleries.
- sekUserGalleries.users.gallery.view - Display the selected galleries albums. If no gallery is specified in the url, and the user is logged in and has permission to have a gallery, this will default to that user's gallery page.
- sekUserGalleries.users.gallery.manage - This page will allow the user to change their user settings for the gallery, if they are logged in and have permission.
- sekUserGalleries.album.view - View the images within the selected album.
- sekUserGalleries.album.manage - Add, edit, and remove albums to the gallery, if the user is logged in and has permission.
- sekUserGalleries.album.items.manage - Add, edit, and remove the album items. Currently set up to upload images only.
-
sekUserGalleries.album.items.helper - This helper snippet does all the work for the
[[album.items.manage]]snippet. - sekUserGalleries.image.information - Simple snippet that gives additional information about an image, like the date the picture was taken, camera used, etc.
- sekUserGalleries.search - Search the albums title, description, and keywords, and display.
- sekUserGalleries.directory - Display how much space the user is currently using on the server (This uses the 1024 based measurement, MiB, GiB, etc).
Ensure that the page resource id for each snippet is entered into the Settings (see below Available Settings) to ensure the pages work correctly.
Available Settings¶
| Name | Description | Default | Version |
|---|---|---|---|
| sekusergalleries.load_jquery | This will enable or disable JQuery from being loaded when sekUserGalleries is called on a page. If JQuery is being loaded from another extra used on the same pages as sekUserGalleries, or it is loaded in a template, this setting should be set to No/False. | Yes/True | >0.0.1 |
| sekusergalleries.browsegalleries_resource_id | The id of the page using the [[browse.galleries]] snippet. |
>0.0.1 | |
| sekusergalleries.usersgallery_resource_id | The id of the page using the [[users.gallery.view]] snippet. |
>0.0.1 | |
| sekusergalleries.editgallery_resource_id | The id of the page using the [[users.gallery.manage]] snippet. |
>0.0.1 | |
| sekusergalleries.album_view_resource_id | The id of the page using the [[album.view]] snippet. |
>0.0.1 | |
| sekusergalleries.album_manage_resource_id | The id of the page using the [[album.manage]] snippet. |
>0.0.1 | |
| sekusergalleries.items_manage_resource_id | The id of the page using the [[album.items.manage]] snippet. |
>0.0.1 | |
| sekusergalleries.items_helper_resource_id | The id of the page using the [[album.items.helper]] snippet. |
>0.0.1 | |
| sekusergalleries.album_search_resource_id | The id of the page using the [[search]] snippet. |
>0.0.1 | |
| sekusergalleries.image_info_resource_id | The id of the page using the [[image.information]] snippet. |
>0.0.1 | |
| sekusergalleries.directory_stats_resource_id | The id of the page using the [[directory]] snippet. |
>0.0.1 | |
| sekusergalleries.gallerycover_thumb_max_width | Set the maximum pixel width of the gallery cover thumbnail image. | 150 | >0.0.1 |
| sekusergalleries.gallerycover_thumb_max_height | Set the maximum pixel height of the gallery cover thumbnail image. | 150 | >0.0.1 |
| sekusergalleries.gallerycover_display_max_width | Set the maximum pixel width of the gallery cover display image. | 300 | >0.0.1 |
| sekusergalleries.gallerycover_display_max_height | Set the maximum pixel height of the gallery cover display image. | 300 | >0.0.1 |
| sekusergalleries.image_thumb_max_width | Set the maximum pixel width of the thumbnail image. | 150 | >0.0.1 |
| sekusergalleries.image_thumb_max_height | Set the maximum pixel height of the thumbnail image. | 150 | >0.0.1 |
| sekusergalleries.max_file_size | Maximum upload file size in bytes. | 5242880 | >0.0.1 |
| sekusergalleries.min_file_size | Minimum file size in bytes. | 1 | >0.0.1 |
| sekusergalleries.orient_image | Auto orient image. | 0 | >0.0.1 |
| sekusergalleries.discard_aborted_uploads | Discard aborted uploads. | 1 | >0.0.1 |
The Manager¶
Group Settings¶
The group settings uses modx's user group's and role's to manage the permissions for using the gallery. By default, anyone can view the galleries, but only a user with matching user group and role defined in the Group Settings can create, edit, or delete images and albums. To learn more about how Modx manages user groups view the User Groups section.
| Setting | Description | Version |
|---|---|---|
| User Group | Select a single user group from the drop down to define the permissions for the user's gallery. | >0.0.1 |
| User Role | This uses the Modx User Groups to manage the permissions. Select a role from the drop down. | >0.0.1 |
| Amount | Integer to define the amount of space the user, with the defined user group and role, can use. | >0.0.1 |
| Unit | The unit of measure for the amount of space allocated for the user. (MiB,GiB, etc) | >0.0.1 |
| Level | The level of enforcement. Soft will allow users to continue to add files after the maximum amount of space is reached. Hard will prevent further uploads if the amount of space allocated is reached. | >0.0.1 |
| Private | Set to Yes, only the user who owns the gallery can access the images. If set to No, anyone can view the files in the gallery. | >0.0.1 |
Mime Types Accepted¶
A list of mime types that can be uploaded. A list of mime types can be found at FeedForAll.
| Setting | Description | Version |
|---|---|---|
| Mime Types Accepted | The mime type accepted for upload. | >0.0.1 |
| Resized File Ext | Change file ext to, ie tiff to jpg. | >0.0.1 |
Example Mime Types Accepted.
| Mime Types Accepted | Resized File Ext |
|---|---|
| image/jpeg | jpg |
| image/pjpeg | jpg |
| image/png | png |
Image Size Settings¶
| Setting | Description | Version |
|---|---|---|
| Name | One word name for the image size group. | >0.0.1 |
| Description | A brief description of the image group. | >0.0.1 |
| Max Width | Maximum width of the image. | >0.0.1 |
| Max Height | Maximum height of the image. | >0.0.1 |
| Image Quality | Resized image quality, the lower the number the smaller the file size. | >0.0.1 |
| Watermark Image | The image to use as a watermark. | >0.0.1 |
| Watermark Brightness | The brightness of the watermark. | >0.0.1 |
| Watermark Text | Text to use as a watermark. This field is ignored if watermark image is used. | >0.0.1 |
| Watermark Text Color | Color of the watermark text. Format is 0,0,0 | >0.0.1 |
| Watermark Font | Watermark font style. | >0.0.1 |
| Watermark Font Size | Watermark font size. | >0.0.1 |
| Watermark Location | Location to place the watermark. | >0.0.1 |
| Primary | Set only one image to primary. | >0.0.1 |
Support the team building MODX with a monthly donation.
The budget raised through OpenCollective is transparent, including payouts, and any contributor can apply to be paid for their work on MODX.
Backers
Budget
$306 per month—let's make that $500!
Learn more