Comments: on this page. Click to read or post your own.

Class Group

Description

A security group.

Located in /sapphire/security/Group.php (line 8)

Object
   |
   --ViewableData
      |
      --DataObject
         |
         --Group
Variable Summary
static mixed $db
static mixed $extensions
static mixed $has_many
static mixed $has_one
static mixed $many_many
Method Summary
static void addToGroupByName (DataObject $member, string $groupcode)
void allowedIPAddress ( $ip)
void canEdit ()
void map ([ $filter = ""], [ $sort = ""], [ $blank = ""])
ComponentSet Members ([$limit $limit = ""], [$offset $offset = ""], [$filter $filter = ""], [$sort $sort = ""], [$join $join = ""])
void onBeforeWrite ()
void setCode ( $val)
void stageChildren ()
void TreeTitle ()
Variables
static mixed $db = array(
"Title" => "Varchar",
"Description" => "Text",
"Code" => "Varchar",
"Locked" => "Boolean",
"Sort" => "Int",
"IPRestrictions" => "Text",
)
(line 10)

Redefinition of:
DataObject::$db
Database field definitions.
static mixed $extensions = array(
"Hierarchy",
)
(line 31)

Redefinition of:
Object::$extensions
Extensions to be used on this object. An array of extension names and parameters eg:
static mixed $has_many = array(
"Permissions" => "Permission",
)
(line 23)

Redefinition of:
DataObject::$has_many
one-to-many relationship definitions.
static mixed $has_one = array(
"Parent" => "SiteTree",
)
(line 19)

Redefinition of:
DataObject::$has_one
one-to-one relationship definitions.
static mixed $many_many = array(
"Members" => "Member",
)
(line 27)

Redefinition of:
DataObject::$many_many
many-many relationship definitions.

Inherited Variables

Inherited from DataObject

DataObject::$ancestry
DataObject::$api_access
DataObject::$belongs_many_many
DataObject::$brokenOnDelete
DataObject::$brokenOnWrite
DataObject::$cache_get_one
DataObject::$casting
DataObject::$changed
DataObject::$componentCache
DataObject::$components
DataObject::$defaults
DataObject::$default_records
DataObject::$default_sort
DataObject::$destroyed
DataObject::$field_labels
DataObject::$indexes
DataObject::$many_many_extraFields
DataObject::$original
DataObject::$plural_name
DataObject::$record
DataObject::$searchable_fields
DataObject::$singular_name
DataObject::$summary_fields

Inherited from ViewableData

ViewableData::$castingHelperPair_cache
ViewableData::$customisedObj
ViewableData::$failover
ViewableData::$iteratorPos
ViewableData::$iteratorTotalItems
ViewableData::$namedAs
ViewableData::$parent
ViewableData::$_natural_cache
ViewableData::$_object_cache
ViewableData::$_xml_cache

Inherited from Object

Object::$builtInMethods
Object::$class
Object::$classConstructed
Object::$extension_instances
Object::$extraMethods
Object::$extraStatics
Object::$statics
Object::$static_cached
Methods
static method addToGroupByName (line 119)

Add a member to a group.

static void addToGroupByName (DataObject $member, string $groupcode)
AllChildrenIncludingDeleted (line 267)

Returns all of the children for the CMS Tree.

Filters to only those groups that the current user can edit

void AllChildrenIncludingDeleted ()
allowedIPAddress (line 282)

Returns true if the given IP address is granted access to this group.

For unrestricted groups, this always returns true.

void allowedIPAddress ( $ip)
  • $ip
canEdit (line 255)
  • access: public
void canEdit ()

Redefinition of:
DataObject::canEdit()
cmsCleanup_parentChanged (line 225)

This isn't a decendant of SiteTree, but needs this in case

the group is "reorganised";

void cmsCleanup_parentChanged ()
collateAncestorIDs (line 212)

Returns an array of the IDs of this group and all its parents

  • access: public
void collateAncestorIDs ()
collateFamilyIDs (line 189)

Return a set of this record's "family" of IDs - the IDs of

this record and all its descendants

  • access: public
void collateFamilyIDs ()
getCMSFields (line 40)

Caution: Only call on instances, not through a singleton.

  • access: public
FieldSet getCMSFields ()

Redefinition of:
DataObject::getCMSFields()
Centerpiece of every data administration interface in Silverstripe, which returns a FieldSet suitable for a Form object.
map (line 173)
  • access: public
void map ([ $filter = ""], [ $sort = ""], [ $blank = ""])
  • $filter
  • $sort
  • $blank
Members (line 139)

Overloaded getter.

  • TODO: Where is this used, why is this overloaded?
  • access: public
ComponentSet Members ([$limit $limit = ""], [$offset $offset = ""], [$filter $filter = ""], [$sort $sort = ""], [$join $join = ""])
  • $limit $limit: string SQL
  • $offset $offset: int
  • $filter $filter: string SQL
  • $sort $sort: string SQL
  • $join $join: string SQL
onBeforeWrite (line 247)
void onBeforeWrite ()

Redefinition of:
DataObject::onBeforeWrite()
Event handler called before writing to the database.
setCode (line 243)

Overloaded to ensure the code is always descent.

  • access: public
void setCode ( $val)
  • $val
stageChildren (line 231)

Override this so groups are ordered in the CMS

  • access: public
void stageChildren ()
TreeTitle (line 235)
  • access: public
void TreeTitle ()

Inherited Methods

Inherited From DataObject

DataObject::__construct()
DataObject::baseTable()
DataObject::buildDataObjectSet()
DataObject::buildSQL()
DataObject::can()
DataObject::canCreate()
DataObject::canDelete()
DataObject::canEdit()
DataObject::canView()
DataObject::castedUpdate()
DataObject::context_obj()
DataObject::createComponent()
DataObject::customDatabaseFields()
DataObject::data()
DataObject::databaseFields()
DataObject::databaseIndexes()
DataObject::db()
DataObject::dbObject()
DataObject::debug()
DataObject::defaultSearchFilters()
DataObject::defineMethods()
DataObject::delete()
DataObject::delete_by_id()
DataObject::destroy()
DataObject::disable_subclass_access()
DataObject::duplicate()
DataObject::enable_subclass_access()
DataObject::exists()
DataObject::extendedSQL()
DataObject::fieldExists()
DataObject::fieldLabel()
DataObject::fieldLabels()
DataObject::filledOut()
DataObject::flushCache()
DataObject::forceChange()
DataObject::get()
DataObject::getAllFields()
DataObject::getChangedFields()
DataObject::getClassAncestry()
DataObject::getCMSFields()
DataObject::getComponent()
DataObject::getComponentJoinField()
DataObject::getComponents()
DataObject::getComponentsQuery()
DataObject::getDefaultSearchContext()
DataObject::getField()
DataObject::getFrontEndFields()
DataObject::getManyManyComponents()
DataObject::getManyManyComponentsQuery()
DataObject::getManyManyFilter()
DataObject::getManyManyJoin()
DataObject::getReverseAssociation()
DataObject::getTitle()
DataObject::get_by_id()
DataObject::get_by_url()
DataObject::get_one()
DataObject::hasDatabaseField()
DataObject::hasField()
DataObject::hasOwnTableDatabaseField()
DataObject::has_many()
DataObject::has_one()
DataObject::i18n_plural_name()
DataObject::i18n_singular_name()
DataObject::inheritedDatabaseFields()
DataObject::instance_get()
DataObject::instance_get_one()
DataObject::isEmpty()
DataObject::isInDB()
DataObject::listOfFields()
DataObject::many_many()
DataObject::merge()
DataObject::newClassInstance()
DataObject::onAfterWrite()
DataObject::onBeforeDelete()
DataObject::onBeforeWrite()
DataObject::plural_name()
DataObject::populateDefaults()
DataObject::relObject()
DataObject::requireDefaultRecords()
DataObject::requireTable()
DataObject::scaffoldFormFields()
DataObject::scaffoldSearchFields()
DataObject::searchableFields()
DataObject::setCastedField()
DataObject::setClassName()
DataObject::setComponent()
DataObject::setField()
DataObject::set_context_obj()
DataObject::singular_name()
DataObject::summaryFields()
DataObject::toMap()
DataObject::update()
DataObject::validate()
DataObject::write()
DataObject::writeComponents()
DataObject::writeWithoutVersion()

Inherited From ViewableData

ViewableData::ATT_val()
ViewableData::BaseHref()
ViewableData::buildCastingHelperCache()
ViewableData::cachedCall()
ViewableData::castingHelper()
ViewableData::castingHelperPair()
ViewableData::castingObjectCreator()
ViewableData::castingObjectCreatorPair()
ViewableData::CSSClasses()
ViewableData::CurrentMember()
ViewableData::CurrentPage()
ViewableData::customise()
ViewableData::Debug()
ViewableData::defineMethods()
ViewableData::escapeTypeForField()
ViewableData::Even()
ViewableData::EvenOdd()
ViewableData::First()
ViewableData::FirstLast()
ViewableData::getField()
ViewableData::getIterator()
ViewableData::getXMLValues()
ViewableData::hasField()
ViewableData::HasPerm()
ViewableData::hasValue()
ViewableData::i18nLocale()
ViewableData::IsAjax()
ViewableData::iteratorProperties()
ViewableData::JS_val()
ViewableData::Last()
ViewableData::Me()
ViewableData::Middle()
ViewableData::MiddleString()
ViewableData::obj()
ViewableData::Odd()
ViewableData::Pos()
ViewableData::RAW_val()
ViewableData::renderWith()
ViewableData::SecurityID()
ViewableData::setCustomisedObj()
ViewableData::setField()
ViewableData::SQL_val()
ViewableData::ThemeDir()
ViewableData::Top()
ViewableData::TotalItems()
ViewableData::val()
ViewableData::XML_val()
ViewableData::__get()
ViewableData::__isset()
ViewableData::__set()

Inherited From Object

Object::__construct()
Object::addMethodsFrom()
Object::addStaticVars()
Object::addWrapperMethod()
Object::add_extension()
Object::allMethodNames()
Object::buildMethodList()
Object::cacheToFile()
Object::cacheToFileWithArgs()
Object::create()
Object::createMethod()
Object::defineMethods()
Object::exists()
Object::extend()
Object::extInstance()
Object::getCustomClass()
Object::hasExtension()
Object::hasMethod()
Object::invokeWithExtensions()
Object::is_a()
Object::loadCache()
Object::parentClass()
Object::sanitiseCachename()
Object::saveCache()
Object::set_stat()
Object::set_uninherited()
Object::stat()
Object::strong_create()
Object::uninherited()
Object::useCustomClass()
Object::__call()
Object::__toString()
blog comments powered by Disqus

Documentation generated on Sun, 19 Oct 2008 06:41:38 +1300 by phpDocumentor 1.3.2