Class RedirectEntry

A single database record & abstract class for the data-access-model.

Extensions and Decorators

See Extension and DataObjectDecorator.

Permission Control

Object-level access control by Permission. Permission codes are arbitrary strings which can be selected on a group-by-group basis.

class Article extends DataObject implements PermissionProvider {
        static $api_access = true;

        public function canView($member = false) {
                return Permission::check('ARTICLE_VIEW');
        }
        public function canEdit($member = false) {
                return Permission::check('ARTICLE_EDIT');
        }
        public function canDelete() {
                return Permission::check('ARTICLE_DELETE');
        }
        public function canCreate() {
                return Permission::check('ARTICLE_CREATE');
        }
        public function providePermissions() {
                return array(
                        'ARTICLE_VIEW' => 'Read an article object',
                        'ARTICLE_EDIT' => 'Edit an article object',
                        'ARTICLE_DELETE' => 'Delete an article object',
                        'ARTICLE_CREATE' => 'Create an article object',
                );
        }
}

Object-level access control by Group membership:

class Article extends DataObject {
        static $api_access = true;

        public function canView($member = false) {
                if(!$member) $member = Member::currentUser();
        return $member->inGroup('Subscribers');
        }
        public function canEdit($member = false) {
                if(!$member) $member = Member::currentUser();
        return $member->inGroup('Editors');
        }

        // ...
}

If any public method on this class is prefixed with an underscore, the results are cached in memory through ViewableData::cachedCall().

Object

ViewableData implements IteratorAggregate

DataObject implements DataObjectInterface, i18nEntityProvider

RedirectEntry

Package: sapphire\model
Located at redirect/code/RedirectEntry.php

Methods summary

`public static`	# `clear_url( mixed $url )`
`public A`	# `validate( )` Validate the current object. Validate the current object. By default, there is no validation - objects are always valid! However, you can overload this method in your DataObject sub-classes to specify custom validation. Invalid objects won't be able to be written - a warning will be thrown and no write will occur. onBeforeWrite() and onAfterWrite() won't get called either. It is expected that you call validate() in your own application to test that an object is valid before attempting a write, and respond appropriately if it isnt'. Returns `A` `ValidationResult` object Overrides `DataObject::validate`
`public`	# `onBeforeWrite( )` Event handler called before writing to the database. You can overload this to clean up or otherwise process data before writing it to the database. Don't forget to call parent::onBeforeWrite(), though! Event handler called before writing to the database. You can overload this to clean up or otherwise process data before writing it to the database. Don't forget to call parent::onBeforeWrite(), though! This called after $this->validate(), so you can be sure that your data is valid. Uses `DataObjectDecorator::onBeforeWrite()` Overrides `DataObject::onBeforeWrite`

Magic methods summary

Properties summary

`public static array`	`$db`	# Database field definitions. This is a map from field names to field type. The field type should be a class that extends . Database field definitions. This is a map from field names to field type. The field type should be a class that extends .
`public static array`	`$summary_fields`	# Provides a default list of fields to be used by a 'summary' view of this object. Provides a default list of fields to be used by a 'summary' view of this object.
`public static array`	`$searchable_fields`	# Default list of fields that can be scaffolded by the ModelAdmin search interface. Default list of fields that can be scaffolded by the ModelAdmin search interface. Overriding the default filter, with a custom defined filter: static $searchable_fields = array( "Name" => "PartialMatchFilter" ); Overriding the default form fields, with a custom defined field. The 'filter' parameter will be generated from `DBField::$default_search_filter_class`. The 'title' parameter will be generated from DataObject->fieldLabels(). static $searchable_fields = array( "Name" => array( "field" => "TextField" ) ); Overriding the default form field, filter and title: static $searchable_fields = array( "Organisation.ZipCode" => array( "field" => "TextField", "filter" => "PartialMatchFilter", "title" => 'Organisation ZIP' ) );

Properties inherited from DataObject

$allowed_actions, $ancestry, $api_access, $belongs_many_many, $belongs_to, $brokenOnDelete, $brokenOnWrite, $cache_get_one, $cache_has_own_table, $cache_has_own_table_field, $casting, $componentCache, $components, $create_table_options, $default_records, $default_sort, $defaults, $destroyed, $field_labels, $has_many, $has_one, $indexes, $many_many, $many_many_extraFields, $original, $plural_name, $record, $singular_name

Properties inherited from ViewableData

$customisedObject, $default_cast, $failover, $iteratorPos, $iteratorTotalItems

Properties inherited from Object

$class, $extension_instances, $extensions

Packages

Classes

Interfaces

Class RedirectEntry

Extensions and Decorators

Permission Control

Methods summary

Returns

Overrides

Uses

Overrides

Methods inherited from DataObject

Methods inherited from ViewableData

Methods inherited from Object

Magic methods summary

Properties summary

Properties inherited from DataObject

Properties inherited from ViewableData

Properties inherited from Object