Class DataTreeObject_Folder

Extension of the Horde_DataTreeObject class for storing bookmark folders.

Horde_DataTreeObject

Extended by

DataTreeObject_Folder

Package: Trean
Author: Mike Cochrane mike@graftonhall.co.nz
Located at Bookmarks.php

Methods summary
`public`	# `DataTreeObject_Folder( string $id )` The DataTreeObject_Folder constructor. Just makes sure to call the parent constructor so that the share's name is set properly. The DataTreeObject_Folder constructor. Just makes sure to call the parent constructor so that the share's name is set properly. Parameters `$id` The id of the share.
`public array`	# `__sleep( )` Returns the properties that need to be serialized. Returns the properties that need to be serialized. Returns `array` List of serializable properties.
`public`	# `setShareOb( Trean_Bookmarks $shareOb )` Associates a Trean_Bookmarks object with this share. Associates a Trean_Bookmarks object with this share. Parameters `$shareOb` The Trean_Bookmarks object.
`public boolean`	# `hasPermission( string $userid, integer $permission, string $creator = null )` Checks to see if a user has a given permission. Checks to see if a user has a given permission. Parameters `$userid` The userid of the user. `$permission` A Horde_Perms::* constant to test for. `$creator` The creator of the event. Returns `boolean` Whether or not $userid has $permission.
`public TODO`	# `setPermission( TODO $perm, boolean $update = true )` TODO TODO Parameters `$perm` `$update` TODO Returns `TODO`
`public Horde_Perms_Permission`	# `getPermission( )` TODO TODO Returns `Horde_Perms_Permission`
`public TODO`	# `inheritPermissions( )` Forces all children of this share to inherit the permissions set on this share. Forces all children of this share to inherit the permissions set on this share. Returns `TODO`
`public`	# `set( string $attribute, mixed $value, boolean $update = false )` Sets one of the attributes of the object. Sets one of the attributes of the object. Parameters `$attribute` attribute to set. `$value` value for $attribute. `$update` whether the backend should be updated or not.
`public The`	# `addBookmark( array $properties )` Adds a bookmark to this folder. Adds a bookmark to this folder. Parameters `$properties` <p>The initial properties for the new bookmark. Expected values are 'bookmark_url', 'bookmark_title', and 'bookmark_description'.</p> Returns `The` id of the new bookmark.
`public The`	# `addFolder( array $properties )` Adds a child folder to this folder. Adds a child folder to this folder. Parameters `$properties` <p>The initial properties for the new folder. Expected value is 'name'.</p> Returns `The` id of the new folder.
`public`	# `getParent( )` Returns the id of this folder's parent folder. Returns the id of this folder's parent folder.
`public`	# `listBookmarks( integer $sortby = 'title', integer $sortdir = 0, mixed $from = 0, mixed $count = 0 )` Lists the bookmarks in this folder. Lists the bookmarks in this folder. Parameters `$sortby` $from The bookmark to start fetching. `$sortdir` $count The numer of bookmarks to return. `$from` `$count`
`public array`	# `_toAttributes( boolean $permsonly = false )` Maps this object's attributes from the data array into a format that we can store in the attributes storage backend. Maps this object's attributes from the data array into a format that we can store in the attributes storage backend. Parameters `$permsonly` <p>Only process permissions? Lets subclasses override part of this method while handling their additional attributes seperately.</p> Returns `array` The attributes array.
`public`	# `_fromAttributes( array $attributes, boolean $permsonly = false )` Takes in a list of attributes from the backend and maps it to our internal data array. Takes in a list of attributes from the backend and maps it to our internal data array. Parameters `$attributes` <p>The list of attributes from the backend (attribute name, key, and value).</p> `$permsonly` <p>Only process permissions? Lets subclasses override part of this method while handling their additional attributes seperately.</p>

Properties summary
`public Trean_Bookmarks`	`$_shareOb` The Trean_Bookmarks object which this share came from - needed for updating data in the backend to make changes stick, etc. The Trean_Bookmarks object which this share came from - needed for updating data in the backend to make changes stick, etc.	#