PHP Class ProcessPageListerBookmarks, ProcessWire

Helper class for managing ProcessPageLister bookmarks
Inheritance: extends Wire
Show file Open project: ryancramerdesign/ProcessWire

Protected Properties

Property Type Description
$lister

Public Methods

Method Description
__construct ( ProcessPageLister $lister )
buildBookmarkListForm ( ) : InputfieldForm Build the bookmarks tab and form contained within it
editBookmark ( ) : string Implementation for editing a bookmark, URL segment: ./edit-bookmark/?n=bookmarkID
getBookmarks ( ) : array Get configured bookmarks allowed for current user

Protected Methods

Method Description
buildBookmarkEditForm ( integer $bookmarkID, array $bookmarks = [] ) : InputfieldWrapper Build the form needed to edit/add bookmarks
saveBookmark ( ) Save a bookmark posted by ./edit-bookmark/

Method Details

__construct() public method

public __construct ( ProcessPageLister $lister )
$lister ProcessPageLister

buildBookmarkEditForm() protected method

Build the form needed to edit/add bookmarks
protected buildBookmarkEditForm ( integer $bookmarkID, array $bookmarks = [] ) : InputfieldWrapper
$bookmarkID integer Specify bookmark ID if editing existing bookmark
$bookmarks array Optionally include list of all bookmarks to prevent this method from having to re-load them
return InputfieldWrapper

buildBookmarkListForm() public method

Build the bookmarks tab and form contained within it
public buildBookmarkListForm ( ) : InputfieldForm
return InputfieldForm

editBookmark() public method

Implementation for editing a bookmark, URL segment: ./edit-bookmark/?n=bookmarkID
public editBookmark ( ) : string
return string

getBookmarks() public method

Get configured bookmarks allowed for current user
public getBookmarks ( ) : array
return array

saveBookmark() protected method

Performs redirect after saving
protected saveBookmark ( )

Property Details

$lister protected property

protected $lister