runtimevars.txt
by Chris Snyder
2002-09-08 11:00:00

A list of runtime object variables available to all content objects:

Persistent object properties from database:
	from BeryliumObject:
		$this->id
		$this->flavor
		$this->created
		$this->updated
		$this->sitememberid
		$this->siteid
		$this->folderid
		$this->status
		$this->properties		"p-keys"

	from PublishableObject:
		$this->name
		$this->originalid
		$this->parentobjtype
		$this->parentid
		$this->public
		$this->locked (dep.)
		$this->rank

	from ContentObject:
		$this->title
		$this->headline
		$this->description
		$this->keywords
		$this->body
		$this->imageid
		$this->audioid
		$this->videoid
		$this->author
		$this->copyright
		$this->source



Generated on construction: (where?)
    $this->objtype
    $this->context // Context object


From $this->timeFormat(): (in BeryliumObject->preprocess())
    $this->createdSql        	sql format
    $this->createdStamp    	timestamp
    $this->created		formatted by $format
    $this->updatedSql		sql format
    $this->updatedStamp		timestamp
    $this->updated		formatted by $format
    $this->timeFormatted	current format string


From $this->getBaseUrl(): (in BeryliumObject->preprocess())
    $this->parentfolder[array]	parent folder properties
    $this->urlname		url-encoded $this->name
    $this->baseUrl		canonical name-based url
    $this->baseURL (dep.)
    $this->baseSSLUrl		canonical name-based url on secure site
    $this->idUrl		canonical id-based url
    $this->idURL (dep.)
    $this->path			filepath of any hardcoded file (minus format)
    $this->uri			uri: path relative to http document root

    Sample Output:
	getBaseURL() named url=https://galactron/berylium/ [1/1]
	getBaseURL() and id url=https://galactron/berylium/folder-1.html [1/1]
	getBaseURL() and path=/usr/home/csnyder/berylium/files/galactron/ [1/1]
	getBaseURL() and uri=/berylium/index.html 


Also from this->preprocess():  (in BeryliumObject->preprocess())
    $this->originaldate		formatted $this->p_originaldate
    $this->authorTag		formatted sitemember reference or contents of $this->author
    $this->authorName		formatted sitemember reference
    $this->dateTag		formatted created date or formatted p_originaldate
    $this->iconTag		formatted icon reference or formatted default icon for objtype
    
    $this->publishStatus	"$public-$status-$rank" descriptor for editors
    $this->lightrank		rank rounded down to  50, 100, 500 or 1000 (for lightbulb and indexing)
    $this->glow		"$public-$status-$lightrank" 
    $this->iconpvt		set to "-pvt" if $public=0 (for showing alt icon if object is private)
    
    $this->switchview	Switch between edit and view modes command
    $this->cancelTag	Cancel command (return to object view)
    $this->pickupTag	Pick-up command
    
    $this->originalObject	Object that corresponds to $this->originalid
    $this->inherited		Packed inherited p_keys


In addition, children may get: (from where??)
    $this->containertype
    $this->containerid
    $this->containername

In addition, images will have:
	$this->origHeight
	$this->height
	$this->origWidth
	$this->width
	$this->isProportioned
	$this->filesize  (human readable or "file not found")
	$this->bytesize   (0 if not found)
