Class Beatnik

Beatnik base class

Copyright 2005-2007 Alkaloid Networks http://www.alkaloid.net

See the enclosed file COPYING for license information (GPL). If you did not receive this file, see http://www.horde.org/licenses/gpl.

Package: Beatnik
Author: Ben Klang ben@alkaloid.net
Located at Beatnik.php

Methods summary
`public`	# `getMenu( mixed $returnType = 'object' )` Build Beatnik's list of menu items. Build Beatnik's list of menu items.
`public`	# `getRecTypes( )` Get possible records Get possible records The keys of this array are the IDs of the record type. The values are a human friendly description of the record type.
`public`	# `getRecFields( mixed $recordtype )`
`public mixed`	# `needCommit( optional $domain = null, optional $needcommit = null )` Check or set a flag to show that a domain has outstanding changes that need to be committed. Check or set a flag to show that a domain has outstanding changes that need to be committed. Parameters `$domain` <p>$domain Domain to check whether a commit is necessary</p> `$needcommit` <p>$needcommit true adds the domain to the list that needs committing; false removes the domain from the list</p> Returns `mixed` Array of domains needing committing if no arguments are passed. Boolean if only a $domain is passed: True if $domain has outstanding changes, false if not. Mixed if both $domain and $needcommit are passed. True on success, PEAR::Error on error.
`public`	# `notifyCommits( )`
`public boolean`	# `hasPermission( string $permname, optional $permmask = null, options $numparents = 0 )` Checks for the given permissions for the current user on the given permissions node. Optionally check for the requested permssion for a given number of steps up the tree. Checks for the given permissions for the current user on the given permissions node. Optionally check for the requested permssion for a given number of steps up the tree. Parameters `$permname` Name of the permission to check `$permmask` $permmask Bitfield of permissions to check for `$numparents` <p>$numparents Check for the same permissions this many levels up the tree</p> Returns `boolean` True if the user has permission, False if not
`public mixed`	# `autogenerate( object & $vars )` Autogenerate a set of records from a template defined in config/autogenerate.php Autogenerate a set of records from a template defined in config/autogenerate.php Parameters `$vars` Horde_Variables object from Autogenerate form Returns `mixed` true on success, PEAR::Error on failure
`public integer`	# `incrementSerial( integer $serial )` Increments a domain serial number. Increments a domain serial number. Parameters `$serial` Serial number to be incremented Returns `integer` Incremented serial number
`public integer`	# `fieldSort( mixed $a, mixed $b )` Callback for usort to make field data print in a friendly order Callback for usort to make field data print in a friendly order Parameters `$a` First sort variable `$b` Second sort variable Returns `integer` -1, 0, 1 based on relative sort order