sapphire
[ class tree: sapphire ] [ index: sapphire ] [ all elements ]

Class: DevelopmentAdmin

Source Location: /sapphire/dev/DevelopmentAdmin.php

Class Overview

Object
   |
   --ViewableData
      |
      --Controller
         |
         --DevelopmentAdmin

Base class for URL access to development tools. Currently supports the TestRunner and TaskRunner.


Author(s):

Variables

Methods


Inherited Variables

Inherited Methods

Class: Controller

Controller::AbsoluteLink()
Returns an absolute link to this controller
Controller::can()
Returns true if the member is allowed to do the given action.
Controller::checkAccessAction()
Check that the given action is allowed to be called on this controller.
Controller::curr()
Returns the current controller
Controller::currentController()
Controller::CurrentMember()
Returns the currently logged in user
Controller::defaultAction()
This is the default action handler used if a method doesn't exist.
Controller::disableBasicAuth()
Call this to disable basic authentication on test sites.
Controller::getAction()
Returns the action that is being executed on this controller.
Controller::getFormOwner()
Return the object that is going to own a form that's being processed, and handle its execution.
Controller::getResponse()
Returns the HTTPResponse object that this controller is building up.
Controller::getSession()
Get the Session object representing this Controller's session
Controller::getURLParams()
Controller::getViewer()
Return an SSViewer object to process the data
Controller::has_curr()
Tests whether we have a currently active controller or not
Controller::init()
Initialisation function that is run before any action on the controller is called.
Controller::isAjax()
Returns true if this controller is processing an ajax request
Controller::LinkTo()
Returns a link to any other page
Controller::Now()
returns a date object for use within a template
Controller::PastMember()
Return true if the visitor has signed up for a login account before
Controller::PastVisitor()
Returns true if the visitor has been here before
Controller::popCurrent()
Pop this controller off the top of the stack.
Controller::pushCurrent()
Pushes this controller onto the stack of current controllers.
Controller::redirect()
Redirct to the given URL.
Controller::redirectedTo()
Tests whether a redirection has been requested.
Controller::run()
Executes this controller, and return an HTTPResponse object with the result.
Controller::setSession()
Set the Session object.
Controller::setURLParams()

Class: ViewableData

ViewableData::ATT_val()
Return the value of the given field in an XML attribute safe format.
ViewableData::BaseHref()
Return the site's absolute base URL, with a slash on the end.
ViewableData::buildCastingHelperCache()
A helper function used by castingHelperPair() to build the cache.
ViewableData::cachedCall()
SSViewer's data-access method.
ViewableData::castingHelper()
Returns the "casting helper" for the given field. A casting helper is a piece of PHP code that, when evaluated, will create an object to represent the value.
ViewableData::castingHelperPair()
Returns the "casting helper" for the given field and the casting class name. A casting helper is a piece of PHP code that, when evaluated, will create an object to represent the value.
ViewableData::castingObjectCreator()
Converts a field spec into an object creator.
ViewableData::castingObjectCreatorPair()
Converts a field spec into an object creator pair; this is a map containing className and castingHelper.
ViewableData::CurrentMember()
Returns the currently logged in user.
ViewableData::CurrentPage()
Returns the current controller
ViewableData::customise()
Add some arbitrary data to this viewabledata object. Returns a new object with the merged data.
ViewableData::Debug()
Return a Debugger object.
ViewableData::defineMethods()
Define custom methods for this object. Called once per class.
ViewableData::escapeTypeForField()
Return the string-format type for the given field.
ViewableData::Even()
Returns true if this item is an even item in the container set.
ViewableData::EvenOdd()
Returns 'even' if this item is an even item in the container set.
ViewableData::First()
Returns true if this item is the first in the container set.
ViewableData::FirstLast()
Returns 'first' if this item is the first in the container set.
ViewableData::getField()
Get a field by it's name. This should be overloaded in child classes.
ViewableData::getIterator()
Returns a "1 record iterator" Views <%control %> tags operate by looping over an item for as many instances as are available. When you stick a single ViewableData object in a control tag, the foreach() loop still needs to work. We do this by creating an iterator that only returns one record.
ViewableData::getXMLValues()
Return a named array of calls to XML_val with different parameters.
ViewableData::hasField()
Checks if a field exists on this object. This should be overloaded in child classes.
ViewableData::HasPerm()
Checks if the current user has the given permission.
ViewableData::hasValue()
Returns true if the given method/parameter has a value
ViewableData::iteratorProperties()
Set up the "iterator properties" for this object.
ViewableData::JS_val()
Return the value of the given field in an JavaScript safe format.
ViewableData::Last()
Returns true if this item is the last in the container set.
ViewableData::Me()
When rendering some objects it is necessary to iterate over the object being rendered, to do this, you need access to itself.
ViewableData::Middle()
Returns true if this item is one of the middle items in the container set.
ViewableData::MiddleString()
Returns 'middle' if this item is between first and last.
ViewableData::obj()
Return the object version of the given field/method.
ViewableData::Odd()
Returns true if this item is an even item in the container set.
ViewableData::Pos()
Returns the numerical number of this item in the dataset.
ViewableData::RAW_val()
Return the value of the given field without any escaping.
ViewableData::renderWith()
Render this data using the given template, and return the result as a string You can pass one of the following:
  • A template name.
ViewableData::SecurityID()
Returns the Security ID.
ViewableData::setCustomisedObj()
ViewableData::setField()
Set a fields value. This should be overloaded in child classes.
ViewableData::SQL_val()
Return the value of the given field in an SQL safe format.
ViewableData::ThemeDir()
Returns the root directory of the theme we're working with.
ViewableData::Top()
Returns the top level ViewableData being rendered.
ViewableData::TotalItems()
Return the total number of "sibling" items in the dataset.
ViewableData::val()
Return the value (non-object) version of the given field/method.
ViewableData::XML_val()
Returns the value of the given field / method in an XML-safe format.
ViewableData::__get()
Accessor overloader.
ViewableData::__isset()
Is-set overloader.
ViewableData::__set()
Setter overloader.

Class: Object

Object::__construct()
Object::addMethodsFrom()
Add the all methods from a given parameter to this object.
Object::addStaticVars()
This method lets us extend a built-in class by adding pseudo-static variables to it.
Object::addWrapperMethod()
Add a 'wrapper method'.
Object::add_extension()
Add an extension to the given object.
Object::allMethodNames()
Return the names of all the methods on this object.
Object::buildMethodList()
Object::cacheToFile()
Caches the return value of a method.
Object::cacheToFileWithArgs()
Caches the return value of a method. Passes args to the method as well.
Object::create()
Create allows us to override the standard classes of sapphire with our own custom classes.
Object::createMethod()
Create a new method
Object::defineMethods()
This constructor will be called the first time an object of this class is created.
Object::exists()
Returns true if this object "exists", i.e., has a sensible value.
Object::extend()
Run the given function on all of this object's extensions
Object::extInstance()
Get an extension on this DataObject
Object::getCustomClass()
Object::hasExtension()
Returns true if the given extension class is attached to this object
Object::hasMethod()
Returns true if the given method exists.
Object::is_a()
Object::loadCache()
Loads a current cache from the filesystem, if it can.
Object::parentClass()
Object::sanitiseCachename()
Makes a cache name safe to use in a file system
Object::saveCache()
Saves a cache to the file system
Object::set_stat()
Set a static variable
Object::set_uninherited()
Set an uninherited static variable
Object::stat()
Get a static variable.
Object::strong_create()
Strong_create is a function to enforce a certain class replacement e.g Php5.2's latest introduction of a namespace conflict means we have to replace all instances of Datetime with SSdatetime.
Object::uninherited()
Get an uninherited static variable
Object::useCustomClass()
This function allows you to overload class creation methods, so certain classes are always created correctly over your system.
Object::__call()
Calls a method.
Object::__toString()

Class Details

[line 9]
Base class for URL access to development tools. Currently supports the TestRunner and TaskRunner.



Tags:

todo:  documentation for how to add new unit tests and tasks


[ Top ]


Class Variables

static $url_handlers = array(
      '' => 'index',
      '$Action' => '$Action'
   )

[line 11]


Type:   mixed


[ Top ]



Class Methods


method index [line 16]

void index( )



[ Top ]

method tasks [line 39]

void tasks( $request)



Parameters:

   $request  

[ Top ]

method tests [line 31]

void tests( )



[ Top ]


blog comments powered by Disqus
Documentation generated on Fri, 13 Jun 2008 06:34:58 +1200 by phpDocumentor 1.3.2