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

Class AssetAdmin

Description

AssetAdmin is the 'file store' section of the CMS.

It provides an interface for maniupating the File and Folder objects in the system.

Located in /cms/code/AssetAdmin.php (line 9)

Object
   |
   --ViewableData
      |
      --RequestHandlingData
         |
         --Controller
            |
            --LeftAndMain
               |
               --AssetAdmin
Variable Summary
static mixed $allowed_actions
static array $allowed_extensions
static mixed $tree_class
Method Summary
void addfolder ()
void currentPageID ()
void deletefolder ()
void deletemarked ( $urlParams,  $form)
void doUpload ( $data,  $form)
void getEditForm ( $id)
void getfile ()
void getsubtree ()
void index ()
void init ()
void Link ([ $action = null])
void movemarked ( $urlParams,  $form)
void removefile ()
void returnItemToUser ( $p)
void save ( $urlParams,  $form)
void savefile ( $data,  $form)
void SiteTreeAsUL ()
void UploadForm ()
void uploadiframe ()
Variables
static mixed $allowed_actions = array(
'addfolder',
'deletefolder',
'deletemarked',
'deleteUnusedThumbnails',
'doUpload',
'getfile',
'getsubtree',
'movemarked',
'removefile',
'save',
'savefile',
'uploadiframe',
'UploadForm',
'deleteUnusedThumbnails' => 'ADMIN'
)
(line 25)

Redefinition of:
LeftAndMain::$allowed_actions
static array $allowed_extensions = array() (line 23)
  • see: Upload->allowedExtensions
  • access: public
static int $allowed_max_file_size (line 17)
  • see: Upload->allowedMaxFileSize
  • access: public
static mixed $tree_class = "File" (line 11)
  • access: public

Redefinition of:
LeftAndMain::$tree_class

Inherited Variables

Inherited from LeftAndMain

LeftAndMain::$application_link
LeftAndMain::$application_logo
LeftAndMain::$application_logo_style
LeftAndMain::$application_logo_text
LeftAndMain::$application_name
LeftAndMain::$extra_requirements
LeftAndMain::$ForceReload
LeftAndMain::$loading_image
LeftAndMain::$menu_items

Inherited from Controller

Controller::$action
Controller::$baseInitCalled
Controller::$basicAuthEnabled
Controller::$controller_stack
Controller::$request
Controller::$requestParams
Controller::$response
Controller::$session
Controller::$urlParams
Controller::$url_handlers

Inherited from ViewableData

ViewableData::$casting
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::$extensions
Object::$extension_instances
Object::$extraMethods
Object::$extraStatics
Object::$statics
Object::$static_cached
Methods
addfolder (line 489)

Add a new folder and return its details suitable for ajax.

  • access: public
void addfolder ()
currentPageID (line 49)

Return fake-ID "root" if no ID is found (needed to upload files into the root-folder)

  • access: public
void currentPageID ()

Redefinition of:
LeftAndMain::currentPageID()
deletefolder (line 559)

Delete a folder

  • access: public
void deletefolder ()
deletemarked (line 344)

Perform the "delete marked" action.

Called and returns in same way as 'save' function

  • access: public
void deletemarked ( $urlParams,  $form)
  • $urlParams
  • $form
deleteUnusedThumbnails (line 695)

Removes all unused thumbnails, and echos status message to user.

  • access: public
null deleteUnusedThumbnails ()
doUpload (line 167)

This method processes the results of the UploadForm.

It will save the uploaded files to /assets/ and create new File objects as required.

void doUpload ( $data,  $form)
  • $data
  • $form
getEditForm (line 261)

Return the form that displays the details of a folder, including a file list and fields for editing the folder name.

void getEditForm ( $id)
  • $id
getfile (line 400)

Returns the content to be placed in Form_SubForm when editing a file.

Called using ajax.

  • access: public
void getfile ()
getsubtree (line 464)

Returns a subtree of items underneat the given folder.

  • access: public
void getsubtree ()

Redefinition of:
LeftAndMain::getsubtree()
index (line 99)
void index ()
init (line 64)

Set up the controller, in particular, re-sync the File database with the assets folder./

void init ()

Redefinition of:
LeftAndMain::init()
Link (line 42)
  • access: public
void Link ([ $action = null])
  • $action

Redefinition of:
LeftAndMain::Link()
You should implement a Link() function in your subclass of LeftAndMain, to point to the URL of that particular controller.
movemarked (line 309)

Perform the "move marked" action.

Called and returns in same way as 'save' function

  • access: public
void movemarked ( $urlParams,  $form)
  • $urlParams
  • $form
removefile (line 648)
  • access: public
void removefile ()
returnItemToUser (line 537)

Return the given tree item to the client.

If called by ajax, this will be some javascript commands. Otherwise, it will redirect back.

  • access: public
void returnItemToUser ( $p)
  • $p

Redefinition of:
LeftAndMain::returnItemToUser()
Allows you to returns a new data object to the tree (subclass of sitetree) and updates the tree via javascript.
save (line 670)
  • access: public
void save ( $urlParams,  $form)
  • $urlParams
  • $form

Redefinition of:
LeftAndMain::save()
Save and Publish page handler
savefile (line 414)

Action handler for the save button on the file subform.

Saves the file

  • access: public
void savefile ( $data,  $form)
  • $data
  • $form
SiteTreeAsUL (line 430)

Return the entire site tree as a nested set of ULs

  • access: public
void SiteTreeAsUL ()
UploadForm (line 134)

Return the form object shown in the uploadiframe.

void UploadForm ()
uploadiframe (line 107)

Show the content of the upload iframe. The form is specified by a template.

void uploadiframe ()

Inherited Methods

Inherited From LeftAndMain

LeftAndMain::addTreeNodeJS()
LeftAndMain::add_menu_item()
LeftAndMain::ajaxupdateparent()
LeftAndMain::ajaxupdatesort()
LeftAndMain::ApplicationLink()
LeftAndMain::callPageMethod()
LeftAndMain::canAccessCMS()
LeftAndMain::canAdminCMS()
LeftAndMain::clear_menu()
LeftAndMain::CMSVersion()
LeftAndMain::currentPage()
LeftAndMain::currentPageID()
LeftAndMain::deleteitems()
LeftAndMain::deleteTreeNodeJS()
LeftAndMain::EditForm()
LeftAndMain::EditorToolbar()
LeftAndMain::ForceReload()
LeftAndMain::getActionUpdateJS()
LeftAndMain::getApplicationLogoText()
LeftAndMain::getApplicationName()
LeftAndMain::getitem()
LeftAndMain::getLastFormIn()
LeftAndMain::getRecord()
LeftAndMain::getSiteTreeFor()
LeftAndMain::getsubtree()
LeftAndMain::getTemplatesWithSuffix()
LeftAndMain::get_menu_item()
LeftAndMain::get_menu_items()
LeftAndMain::init()
LeftAndMain::isCurrentPage()
LeftAndMain::Left()
LeftAndMain::Link()
LeftAndMain::LoadingImage()
LeftAndMain::LogoStyle()
LeftAndMain::MainMenu()
LeftAndMain::MceRoot()
LeftAndMain::Member_ProfileForm()
LeftAndMain::myprofile()
LeftAndMain::populate_default_menu()
LeftAndMain::printable()
LeftAndMain::remove_menu_item()
LeftAndMain::replace_menu_item()
LeftAndMain::require_css()
LeftAndMain::require_javascript()
LeftAndMain::require_themed_css()
LeftAndMain::returnItemToUser()
LeftAndMain::Right()
LeftAndMain::RightBottom()
LeftAndMain::save()
LeftAndMain::SectionTitle()
LeftAndMain::setApplicationName()
LeftAndMain::setCurrentPageID()
LeftAndMain::setLogo()
LeftAndMain::set_loading_image()
LeftAndMain::show()

Inherited From Controller

Controller::AbsoluteLink()
Controller::can()
Controller::curr()
Controller::currentController()
Controller::CurrentMember()
Controller::defaultAction()
Controller::disableBasicAuth()
Controller::getAction()
Controller::getFormOwner()
Controller::getRequest()
Controller::getResponse()
Controller::getSession()
Controller::getURLParams()
Controller::getViewer()
Controller::handleAction()
Controller::handleRequest()
Controller::has_curr()
Controller::init()
Controller::isAjax()
Controller::join_links()
Controller::LinkTo()
Controller::Now()
Controller::PastMember()
Controller::PastVisitor()
Controller::popCurrent()
Controller::pushCurrent()
Controller::redirect()
Controller::redirectedTo()
Controller::render()
Controller::setSession()
Controller::setURLParams()

Inherited From RequestHandlingData

RequestHandlingData::checkAccessAction()
RequestHandlingData::getRequest()
RequestHandlingData::handleRequest()
RequestHandlingData::httpError()

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 Tue, 07 Oct 2008 15:54:34 +1300 by phpDocumentor 1.3.2