b2evolution

Multilingual multiuser multiblog engine

b2evolution Technical Documentation (Version 1.10) [ class tree: evocore ] [ index: evocore ] [ all elements ]

Class: FileRoot

Source Location: /blogs/inc/MODEL/files/_fileroot.class.php

Class FileRoot

Class Overview

This class provides info about a File Root.

A FileRoot describes a directory available for media file storage, under access permission.

Located in /blogs/inc/MODEL/files/_fileroot.class.php [line 40]



		
		
		
		

Properties

Methods

[ Top ]
Property Summary
mixed   $ads_path   Absolute path, ending with slash
mixed   $ads_url   Absolute URL, ending with slash
string   $ID   Unique Root ID constructed from type and in_type_ID
mixed   $in_type_ID   ID of user, group or collection.
mixed   $name   Name of the root
mixed   $type   Type: 'user', 'group' or 'collection'.

[ Top ]
Method Summary
static void   gen_ID()  
FileRoot   FileRoot()   Constructor

[ Top ]
Properties
mixed   $ads_path [line 68]

Absolute path, ending with slash


[ Top ]
mixed   $ads_url [line 73]

Absolute URL, ending with slash


[ Top ]
string   $ID [line 58]

Unique Root ID constructed from type and in_type_ID


[ Top ]
mixed   $in_type_ID [line 52]

ID of user, group or collection.


[ Top ]
mixed   $name [line 63]

Name of the root


[ Top ]
mixed   $type [line 47]

Type: 'user', 'group' or 'collection'.

Note: group is not implemented yet. Absolute will probably be deprecated.


[ Top ]
Methods
static method gen_ID  [line 117]

  static void gen_ID( $root_type, $root_in_type_ID  )

Parameters:
   $root_type: 
   $root_in_type_ID: 


[ Top ]
Constructor FileRoot  [line 82]

  FileRoot FileRoot( string $root_type, integer $root_in_type_ID  )

Constructor

Parameters:
string   $root_type:  Root type: 'user', 'group' or 'collection'
integer   $root_in_type_ID:  ID of the user, the group or the collection the file belongs to...


[ Top ]

Documentation generated on Tue, 20 May 2008 01:39:53 +0200 by phpDocumentor 1.4.2