featuredImage
in package
Table of Contents
Methods
- deleteFeaturedImage() : bool
- Removes the featured image via JS get request from plugin_storage table if their object is removed.
- featuredImageCSS() : mixed
- getCurrentFeatureImage() : mixed
- Gets the current featured images for the dialogue window
- getFeaturedImage() : mixed
- Returns the image object of the featured iamge if set
- getFeaturedImagePreview() : mixed
- Fetch single image via JS get request for previewing and selecting an image for the dialogue window
- getFeaturedImageSelection() : mixed
- Gets the featured image of this article from the database
- getFeaturedImageSelector() : mixed
- Gets a selector with all toplevel albums whose images you can assign as featured image for the dialogue window
- getFeaturedImageType() : mixed
- Checks the class of $obj and returns the Zenpage item type "featuredimage_article/category/page" Returns false if no Zenpage object is passed
- getThumbs() : mixed
- Gets image thumbs of an album via JS get request for the dialogue window
- printFeaturedImageDialog() : mixed
- Function to be used in the dialog box for displaying the single image for setting the featured image and the current featured image
- processSelection() : mixed
- Processes JS GET requests and may return/display HTML for the dialogue window
- saveFeaturedImageSelection() : mixed
- Saves the featured image of this item via JS get request
- getFeaturedImageSubalbums() : mixed
- Gets the subalbums of the album object $albobj recursively
Methods
deleteFeaturedImage()
Removes the featured image via JS get request from plugin_storage table if their object is removed.
public
static deleteFeaturedImage() : bool
Return values
boolfeaturedImageCSS()
public
static featuredImageCSS() : mixed
getCurrentFeatureImage()
Gets the current featured images for the dialogue window
public
static getCurrentFeatureImage() : mixed
Tags
getFeaturedImage()
Returns the image object of the featured iamge if set
public
static getFeaturedImage(obj $obj) : mixed
Parameters
- $obj : obj
-
Zenpage article, category or page object you want the featured image of
getFeaturedImagePreview()
Fetch single image via JS get request for previewing and selecting an image for the dialogue window
public
static getFeaturedImagePreview() : mixed
Tags
getFeaturedImageSelection()
Gets the featured image of this article from the database
public
static getFeaturedImageSelection(object $obj) : mixed
Parameters
- $obj : object
-
Zenpage article, category or page object to assign the thumb
getFeaturedImageSelector()
Gets a selector with all toplevel albums whose images you can assign as featured image for the dialogue window
public
static getFeaturedImageSelector(string $html, object $obj[, string $prefix = '' ][, string $allowedfiles = 'images' ]) : mixed
Parameters
- $html : string
- $obj : object
-
Zenpage article, category or page object to assign the thumb
- $prefix : string = ''
-
(not used)
- $allowedfiles : string = 'images'
-
"all" (default) for all registered "image" files, "images" for only standard "image" files (jpg, jpeg, png, gif), "
" (without trailing dot, e.g. "jpg") for only "image" files with that suffix
getFeaturedImageType()
Checks the class of $obj and returns the Zenpage item type "featuredimage_article/category/page" Returns false if no Zenpage object is passed
public
static getFeaturedImageType(object $obj) : mixed
Parameters
- $obj : object
-
Zenpage article, category or page object
getThumbs()
Gets image thumbs of an album via JS get request for the dialogue window
public
static getThumbs() : mixed
Tags
printFeaturedImageDialog()
Function to be used in the dialog box for displaying the single image for setting the featured image and the current featured image
public
static printFeaturedImageDialog(object $imgobj, string $buttontype) : mixed
Parameters
- $imgobj : object
-
the object of the image
- $buttontype : string
-
"save" for save button and "delete" for delete button
processSelection()
Processes JS GET requests and may return/display HTML for the dialogue window
public
static processSelection() : mixed
Tags
saveFeaturedImageSelection()
Saves the featured image of this item via JS get request
public
static saveFeaturedImageSelection() : mixed
getFeaturedImageSubalbums()
Gets the subalbums of the album object $albobj recursively
private
static getFeaturedImageSubalbums(object &$albobj) : mixed
Parameters
- $albobj : object
-
album object