PixyBlog Lightbox   |   Basket   |   Login   |   Register
Pixy® Blog - Expose Yourself
  PixyBlog.comPhotoblog DiscussionPhotoblog Wiki
  • Log in / create account
Data Object Reference
  • Page
  • Discussion
  • View source
  • History

Data Object Reference

From PixyWiki

Jump to: navigation, search

In this section we'll list each of the properties and methods of the data objects.

Contents

  • 1 Bookmark
  • 2 BookmarkFolder
  • 3 Comment
  • 4 Entry
  • 5 EntryAttribute
  • 6 Exif
  • 7 Gallery
  • 8 Image
  • 9 Pager
    • 9.1 EntryPager
    • 9.2 GalleryPager
    • 9.3 ImagePager
  • 10 PageTemplate
  • 11 Preview
  • 12 Referrer
  • 13 User
  • 14 Website
    • 14.1 Website Properties
    • 14.2 Website Methods

Bookmark

A single link within a websites web bookmark collection, exists with a BookmarkFolder.

Name Type Description
$bookmark.description String Description of the bookmark
$bookmark.feedURL String URL of the newsfeed associated with the bookmark
$bookmark.folder BookmarkFolder Parent folder of the bookmark
$bookmark.image String URL of image to be displayed for bookmark
$bookmark.name String Name of the bookmark
$bookmark.url String URL of the bookmark

BookmarkFolder

A folder containing bookmarks.

Name Type Description
$folder.bookmarks List of Bookmark objects Bookmarks contained in folder.
$folder.description String Description of folder
$folder.folders BookmarkFolder objects Folders contained in folder
$folder.inUse boolean True if folder contains other bookmarks or folders.
$folder.name String Name of folder
$folder.parent BookmarkFolder Parent of folder
$folder.path String Path in the folder hierarchy
$folder.website Website Website in which folder is contained

Comment

A Comment associated with a specific Entry

Name Type Description
$comment.approved boolean true if comment has been approved for display.
$comment.content String Content of the comment,
$comment.email String Email address of the commenter.
$comment.name String Name of the commenter.
$comment.notify boolean True if commenter choose the 'please notify me via email' option.
$comment.pending boolean True if comment is waiting for approval
$comment.postTime String Time that comment was created
$comment.remoteHost String Host name or IP address of commenter
$comment.spam boolean True if comment is marked as spam
$comment.url String URL of the commenter
$comment.weblogEntry Entry Blog entry with which comment is associated

Entry

An individual website Entry

Name Type Description
$entry.allowComments boolean True if this website entry allows comments
$entry.anchor String Simple string that uniquely identifies post in website
$entry.commentCount int Number of approved comments posted for this entry
$entry.commentDays int Number of days that comments are allowed
$entry.commentsStillAllowed boolean True if comments are currently allowed
$entry.contentSrc String URL of entry content, if out-of-line
$entry.contentType String MIME content-type of entry
$entry.creator User User who created the entry
$entry.entryAttributes List of EntryAttribute objects Arbitrary name/value attributes associated with entry
$entry.galleries List of Gallery objects Galleries associated with this entry
$entry.galleryCount int Number of galleries for this entry
$entry.images List of Image objects Images associated with this entry
$entry.image Image Primary image associated with this entry
$entry.imageCount int Number of images for this entry
$entry.pubTime Date Timestamp when entry was published
$entry.referrers List of Referrer objects List of referrers to entry (cleared nightly)
$entry.rightToLeft boolean True if entry text is to be displayed right-to-left
$entry.status String Status of entry (i.e. PUBLISHED)
$entry.summary String Raw summary text of entry
$entry.text String Raw content text of entry
$entry.title String Title of entry
$entry.transformedText String Content text of entry processed by plugins
$entry.transformedSummary String Summary text of entry processed by plugins
$entry.updateTime Date Timestamp of last modification to entry
$entry.website Website Entry's website

EntryAttribute

Website entry attributes are name/value pairs that can be assigned to website entries. Currently, they're only used to add podcasts to blog entries.

Name Type Description
$att.entry Entry Entry associated with this attribute
$att.name String Name of the attribute
$att.value String Value of the attribute

Exif

Exif information for an image

Name Type Description
$exif.cameraMake String Name of the camera make
$exif.cameraModel String Name of the camera model
$exif.aperture String Aperture setting of the photo
$exif.exposureTime String Exposure time setting
$exif.focalLength String Focal length setting
$exif.isoEquivalent String ISO equivalent setting
$exif.exposureBias String Exposure bias setting
$exif.exposureProgram String Exposure program setting
$exif.flash String Flash setting
$exif.focusDistance String Focus distance
$exif.meteringMode String Metering mode setting
$exif.sensorType String Sensor type setting
$exif.originalDate String Date the original photo was taken
$exif.orientation String The orientation of the photo
$exif.software String Name of software used
$exif.YCbCrPositioning String YCbCr Positioning
$exif.resolutionUnit String Resolution Unit
$exif.compression String Compression
$exif.maximumAperture String Maximum Aperture
$exif.colorSpace String Color Space
$exif.formatName String Format Name
$exif.resolution String Resolution
$exif.compressionLevel String Compression level
$exif.imageWidth String Width of image
$exif.imageHeight String Height of image
$exif.originalWidth String Width of original image
$exif.originalHeight String Height of original image
$exif.originalWidthDpi String DPI of original image width
$exif.originalHeightDpi String DPI of original image height
$exif.comment String Comment

Gallery

A gallery within a website, galleries are hierarchical

Name Type Description
$gallery.date Date Date the gallery was created
$gallery.description String Raw description text of gallery
$gallery.image Image Cover image associated with gallery
$gallery.imageCount int Number of images belonging to this gallery
$gallery.images List of Image objects Images belonging to this gallery
$gallery.name String Title of gallery
$gallery.path String Path of gallery
$gallery.parent Gallery Parent gallery of this gallery
$gallery.weblogGalleries List of Gallery objects Child galleries of this gallery
$gallery.website Website Website of gallery

Image

An individual Image

Name Type Description
$image.creator User User who uploaded the image
$image.dateCreated Date Date the image was uploaded.
$image.exif Exif Exif information for image
$image.fileName String Filename of image.
$image.fileSize long Image filesize in bytes.
$image.height int Image height in pixels.
$image.lastModified Date Date the image was last modified
$image.mimeType String MIME content-type of image.
$image.preview Preview Preview of image (longest dimension = 800 pixels)
$image.previewLarge Preview Large Preview of this image (longest dimension = 1024 pixels)
$image.previewExtraLarge Preview Extra large Preview of this image (longest dimension = 1600 pixels)
$image.previewSmall Preview Small Preview of image (longest dimension = 500 pixels)
$image.thumb Preview Thumbnail Preview of image (longest dimension = 100 pixels)
$image.thumbLarge Preview Large thumbnail Preview of image (longest dimension = 200 pixels)
$image.thumbExtraLarge Preview Extra large thumbnail preview of image (longest dimension = 300 pixels)
$image.thumbSmall Preview Small thumbnail Preview of image (longest dimension = 50 pixels)
$image.thumbSquare Preview Square thumbnail Preview of image (85x85 pixels)
$image.watermarked boolean True if the image has been watermarked.
$image.width int Image width in pixels.
$image.url String URL of the image


Pager

There are many cases in a website when we want to display a large collection of values and we want that collection to be page-able... that is, we want a next link to go to the next page of results and possibly a previous link to go to the previous page. So in PixyBlog, we've introduced the concept of a Pager.

A pager is a special type of object that makes it easy to display a page-able collection of items within a page template.

You probably won't need to use a pager object directly, since the macros do it for you. But if you do, here's what a pager looks like:

Name Type Description
$pager.homeLink String URL of the first page of results.
$pager.homeName String Name to be displayed for that URL.
$pager.nextLink String URL of the next page of results
$pager.homeName String Name to be displayed for that URL.
$pager.nextLink String URL of the next page of results
$pager.nextName String Name to be displayed for that URL
$pager.prevLink String URL of the previous page of results
$pager.prevName String Name to be displayed for that URL
$pager.items List of Data objects Collection of data objects; the current page of results

EntryPager

There is also an EntryPager interface that provides some extra methods for next-collection paging. The collection methods exist because often, with website entries, we are paging through the entries that exist within one time period, a month for example. In that case the nextLink point to the next page of results within that month and the nextCollectionLink points to the next months entries.

Name Type Description
$pager.homeLink String URL of the first page of results.
$pager.homeName String Name to be displayed for that URL.
$pager.nextLink String URL of the next page of results
$pager.homeName String Name to be displayed for that URL.
$pager.nextLink String URL of the next page of results
$pager.nextName String Name to be displayed for that URL
$pager.prevLink String URL of the previous page of results
$pager.prevName String Name to be displayed for that URL
$pager.nextCollectionLink String URL of next collection in sequence
$pager.nextCollectionName String Name to be displayed for that URL
$pager.prevCollectionLink String URL of previous collection in sequence
$pager.prevCollectionName String Name to be displayed for that URL
$pager.items List of Entry objects Collection of entry objects; the current page of results
$pager.entries List of Entry objects Collection of entry objects; the current page of results

GalleryPager

Name Type Description
$pager.homeLink String URL of the first page of results.
$pager.homeName String Name to be displayed for that URL.
$pager.nextLink String URL of the next page of results
$pager.homeName String Name to be displayed for that URL.
$pager.nextLink String URL of the next page of results
$pager.nextName String Name to be displayed for that URL
$pager.prevLink String URL of the previous page of results
$pager.prevName String Name to be displayed for that URL
$pager.nextCollectionLink String URL of next collection in sequence
$pager.nextCollectionName String Name to be displayed for that URL
$pager.prevCollectionLink String URL of previous collection in sequence
$pager.prevCollectionName String Name to be displayed for that URL
$pager.galleries List of Gallery objects Collection of gallery objects; the current page of results

ImagePager

Name Type Description
$pager.homeLink String URL of the first page of results.
$pager.homeName String Name to be displayed for that URL.
$pager.nextLink String URL of the next page of results
$pager.homeName String Name to be displayed for that URL.
$pager.nextLink String URL of the next page of results
$pager.nextName String Name to be displayed for that URL
$pager.prevLink String URL of the previous page of results
$pager.prevName String Name to be displayed for that URL
$pager.nextCollectionLink String URL of next collection in sequence
$pager.nextCollectionName String Name to be displayed for that URL
$pager.prevCollectionLink String URL of previous collection in sequence
$pager.prevCollectionName String Name to be displayed for that URL
$pager.images List of Image objects Collection of image objects; the current page of results

PageTemplate

An individual page template within a Website.

Name Type Description
$page.contents String The content of the page template, typically HTML and Velocity code
$page.description String Description of the page
$page.lastModified Date Date that page properties or content was last modified
$page.link String String used to form URL to page
$page.name String Name of the page
$page.navbar String True if page should be included in page navigation menu
$page.hidden String True if page is NOT callable by URL

Preview

A preview/thumbnail of an image

Name Type Description
$preview.dateCreated Date Date the image preview was uploaded.
$preview.fileSize long Image preview filesize in bytes.
$preview.height int Image preview height in pixels.
$preview.width int Image preview width in pixels.
$preview.url String URL of the image preview

Referrer

A referrer represents an external site that links to the Website

Name Type Description
$referrer.dateString String Eight character date string implied by referred to URL
$referrer.dayHits int Number of hits counted against this referrer today
$referrer.displayUrl String URL to be displayed for this referrer
$referrer.excerpt String Except extracted from referring site by linkback extractor
$referrer.refererUrl String URL that refers to your website
$referrer.refererPermalink String Permalink URL referrered by by the referrer
$referrer.title String Title extracted from referring site by linkback extractor
$referrer.totalHits int Total number of hits counted against this referrer
$referrer.visible String True if referrer should be displayed
$referrer.weblogEntry Entry Website entry referenced by this referrer
$referrer.website Website Website referred to by this referrer

User

Represents a single user within the pixyBlog site.

Name Type Description
$user.dateCreated Date Date that user was created
$user.emailAddress String User's email address
$user.fullName String Users full name
$user.locale String User's locale
$user.timeZone String User's timezone
$user.userName String User's username

Website

A website containing Entry, PageTemplate, Bookmark objects... and more.

Website Properties

Name Type Description
$website.active boolean True if website is considered active.
$website.allowComments boolean True if comments are allowed in website.
$website.creator User User who created this website
$website.dateCreated Date Date website was created
$website.description String Description of website
$website.emailAddress String Email address of website's owner
$website.emailComments boolean True if email notification of comments is enabled
$website.emailFromAddress String Email address for from-address of notifications
$website.enableBloggerApi boolean True if remote blogging API is enabled
$website.enabled boolean True if website is enabled
$website.entryDisplayCount int Default number of entries to display in pagers
$website.handle String Simple string handle that uniquely identifies website
$website.lastModified Date Timestamp of last modification to website
$website.locale String Default locale used by website
$website.moderateComments boolean True if comment moderation is enabled in website
$website.name String Name of the website
$website.pages List of PageTemplate objects Page templates of website
$website.timeZone String Timezone of the website
$website.todaysHits int Number of referrer hits counted today
$website.todaysReferrers List of Referrer objects Today's referrers to this website
$website.weblogGalleries List of Gallery objects Top-level galleries of website

Website Methods

Name Type Description
$website.getRecentWeblogEntries(String gal, int max) List of Entry objects Get most recent entries in the website up to the number max. You can specify a gallery name if you'd like only entries from one gallery (or "nil" for all galleries).
$website.getRecentComments(int max) List of Comment objects Get most recent comments in the website up to the limit max.
$website.getWeblogGalleries() List of Gallery objects Get all Galleries for this site.
$website.getWeblogGalleries(String galPath) List of Gallery objects Get galleries found at the specified gallery path.
$website.getWeblogGallery(String galPath) Gallery Get gallery specified by path.
$website.getPageByName(String name) PageTemplate Get page template specified by name.
$website.getPageByLink(String link) PageTemplate Get page template specified by link.
Retrieved from "http://wiki.pixyblog.com/Data_Object_Reference"
This page was last modified 14:51, 26 August 2009. This page has been accessed 1,097 times.
  • Privacy policy
  • About PixyWiki
  • Disclaimers
  • Powered by MediaWiki
  • Design by Paul Gu
Terms and Conditions | Privacy Policy | About | Contact us | Copyright © 2006-2008 Pixy® Ltd. All rights reserved.