Element index for package files

Package indexes

[ a ] [ b ] [ c ] [ d ] [ e ] [ f ] [ g ] [ i ] [ j ] [ l ] [ m ] [ n ] [ o ] [ r ] [ s ] [ t ] [ u ] [ v ] [ _ ]

[Top]

_

$_adfp_full_path: in file _file.class.php, variable File::$_adfp_full_path
Full path for this file/folder, WITHOUT trailing slash.
$_ads_list_path: in file _filelist.class.php, variable Filelist::$_ads_list_path
Path to list with trailing slash.
$_current_idx: in file _filelist.class.php, variable Filelist::$_current_idx
Index of the current iterator position.
$_dir: in file _file.class.php, variable File::$_dir
Directory path for this file/folder, including trailing slash.
$_dirs_not_at_top: in file _filelist.class.php, variable Filelist::$_dirs_not_at_top
User preference: Sort dirs not at top
$_entries: in file _filelist.class.php, variable Filelist::$_entries
The list of Files.
$_exists: in file _file.class.php, variable File::$_exists
Does the File/folder exist on disk?
$_FileRoot: in file _file.class.php, variable File::$_FileRoot
FileRoot of this file
$_FileRoot: in file _filelist.class.php, variable Filelist::$_FileRoot
The root of the file list.
$_filter: in file _filelist.class.php, variable Filelist::$_filter
Filename filter pattern
$_filter_is_regexp: in file _filelist.class.php, variable Filelist::$_filter_is_regexp
Is the filter a regular expression? NULL if unknown
$_fsgroup_name: in file _file.class.php, variable File::$_fsgroup_name
File group. NULL if unknown
$_fsowner_name: in file _file.class.php, variable File::$_fsowner_name
File owner. NULL if unknown
$_full_path_index: in file _filelist.class.php, variable Filelist::$_full_path_index
Index on full paths (path => $_entries key).
$_is_dir: in file _file.class.php, variable File::$_is_dir
Is the File a directory?
$_is_image: in file _file.class.php, variable File::$_is_image
Is the File an image? NULL if unknown
$_lastmod_ts: in file _file.class.php, variable File::$_lastmod_ts
UNIX timestamp of last modification on disk.
$_md5ID: in file _file.class.php, variable File::$_md5ID
MD5 hash of full pathname.
$_md5_ID_index: in file _filelist.class.php, variable Filelist::$_md5_ID_index
Index on File IDs (id => $_entries key).
$_name: in file _file.class.php, variable File::$_name
Name of this file/folder, without path.
$_order: in file _filelist.class.php, variable Filelist::$_order
What column is the list ordered on?
$_order_asc: in file _filelist.class.php, variable Filelist::$_order_asc
Are we sorting ascending (or descending)?
$_order_index: in file _filelist.class.php, variable Filelist::$_order_index
Index on sort order (order # => $_entries key).
$_perms: in file _file.class.php, variable File::$_perms
Filesystem file permissions.
$_rdfp_rel_path: in file _file.class.php, variable File::$_rdfp_rel_path
Posix subpath for this file/folder, relative the associated root (No trailing slash)
$_rdfs_rel_path_index: in file _filelist.class.php, variable Filelist::$_rdfs_rel_path_index
Index on (r)elative (s)lash terminated (f)ile/(d)irectory paths (rdfs_path => key into $_entries).
$_rds_list_path: in file _filelist.class.php, variable Filelist::$_rds_list_path
Path to list reltive to root, with trailing slash
$_recursive_size: in file _file.class.php, variable File::$_recursive_size
Recursive directory size in bytes.
$_show_hidden_files: in file _filelist.class.php, variable Filelist::$_show_hidden_files
User preference: Load and show hidden files?
$_size: in file _file.class.php, variable File::$_size
File size in bytes.
$_total_bytes: in file _filelist.class.php, variable Filelist::$_total_bytes
Number of bytes
$_total_dirs: in file _filelist.class.php, variable Filelist::$_total_dirs
Number of directories
$_total_entries: in file _filelist.class.php, variable Filelist::$_total_entries
Number of entries in the $_entries array
$_total_files: in file _filelist.class.php, variable Filelist::$_total_files
Number of files
$_use_recursive_dirsize: in file _filelist.class.php, variable Filelist::$_use_recursive_dirsize
User preference: recursive size of dirs?
_file.class.php: procedural page _file.class.php
_file.funcs.php: procedural page _file.funcs.php
_filecache.class.php: procedural page _filecache.class.php
_filelist.class.php: procedural page _filelist.class.php
_fileroot.class.php: procedural page _fileroot.class.php
_filerootcache.class.php: procedural page _filerootcache.class.php
_filetype.class.php: procedural page _filetype.class.php
_filetypecache.class.php: procedural page _filetypecache.class.php
_image.funcs.php: procedural page _image.funcs.php
_filetype.form.php: procedural page _filetype.form.php
_filetype_list.view.php: procedural page _filetype_list.view.php
_file_browse.view.php: procedural page _file_browse.view.php
_file_browse_set.form.php: procedural page _file_browse_set.form.php
_file_copy_move.form.php: procedural page _file_copy_move.form.php
_file_delete.form.php: procedural page _file_delete.form.php
_file_download.form.php: procedural page _file_download.form.php
_file_edit.form.php: procedural page _file_edit.form.php
_file_links.view.php: procedural page _file_links.view.php
_file_list.inc.php: procedural page _file_list.inc.php
_file_permissions.form.php: procedural page _file_permissions.form.php
_file_properties.form.php: procedural page _file_properties.form.php
_file_rename.form.php: procedural page _file_rename.form.php
_file_settings.form.php: procedural page _file_settings.form.php
_file_upload.view.php: procedural page _file_upload.view.php
_sort_callback: in file _filelist.class.php, method Filelist::_sort_callback()
usort callback function for Filelist::sort()

[Top]

a

$ads_path: in file _fileroot.class.php, variable FileRoot::$ads_path
Absolute path, ending with slash
$ads_url: in file _fileroot.class.php, variable FileRoot::$ads_url
Absolute URL, ending with slash
$allowed: in file _filetype.class.php, variable Filetype::$allowed
$alt: in file _file.class.php, variable File::$alt
Meta data: ALT text for images
add: in file _filelist.class.php, method Filelist::add()
Add a File object to the list (by reference).
add: in file _filetypecache.class.php, method FiletypeCache::add()
Add a dataobject to the cache
add_by_subpath: in file _filelist.class.php, method Filelist::add_by_subpath()
Add a file to the list, by filename.

[Top]

b

bytesreadable: in file _file.funcs.php, function bytesreadable()
Converts bytes to readable bytes/kb/mb/gb, like "12.45mb"

[Top]

c

$cache: in file _filerootcache.class.php, variable FileRootCache::$cache
Internal cache
cb_delete_restrictions_detail: in file _file.class.php, method File::cb_delete_restrictions_detail()
Callback function called by DataObject::check_relations().
chmod: in file _file.class.php, method File::chmod()
Change file permissions on disk.
cleardir_r: in file _file.funcs.php, function cleardir_r()
Clear contents of dorectory, but do not delete directory itself
contains: in file _filelist.class.php, method Filelist::contains()
Does the list contain a specific File?
copy_to: in file _file.class.php, method File::copy_to()
Copy this file to a new location
count: in file _filelist.class.php, method Filelist::count()
Get the total number of entries in the list.
count_bytes: in file _filelist.class.php, method Filelist::count_bytes()
Get the total number of bytes of all files in the list
count_dirs: in file _filelist.class.php, method Filelist::count_dirs()
Get the total number of directories in the list
count_files: in file _filelist.class.php, method Filelist::count_files()
Get the total number of files in the list
create: in file _file.class.php, method File::create()
Create the file/folder on disk, if it does not exist yet.
crop_to_constraint: in file _image.funcs.php, function crop_to_constraint()
Crop dimensions to fit into a constrained size, while preserving aspect ratio.

[Top]

d

$desc: in file _file.class.php, variable File::$desc
Meta data: Description
dbinsert: in file _file.class.php, method File::dbinsert()
Insert object into DB based on previously recorded changes
dbupdate: in file _file.class.php, method File::dbupdate()
Update the DB based on previously recorded changes
display_perm: in file _filetype_list.view.php, function display_perm()
Display the permissions for the type file

[Top]

e

$extensions: in file _filetype.class.php, variable Filetype::$extensions
$extension_cache: in file _filetypecache.class.php, variable FiletypeCache::$extension_cache
exists: in file _file.class.php, method File::exists()
Does the File/folder exist on disk?

[Top]

f

$Filetype: in file _file.class.php, variable File::$Filetype
Extension, Mime type, icon, viewtype and 'allowed extension' of the file
$flatmode: in file _filelist.class.php, variable Filelist::$flatmode
Flat mode? (all files recursive without dirs)
File: in file _file.class.php, method File::File()
Constructor, not meant to be called directly. Use FileCache::get_by_root_and_path() instead, which provides caching and checks that only one object for a unique file exists (references).
File: in file _file.class.php, class File
Represents a file or folder on disk. Optionnaly stores meta data from DB.
FileCache: in file _filecache.class.php, class FileCache
FileCache Class
FileCache: in file _filecache.class.php, method FileCache::FileCache()
Constructor
Filelist: in file _filelist.class.php, class Filelist
Holds a list of File objects.
Filelist: in file _filelist.class.php, method Filelist::Filelist()
Constructor
FileRoot: in file _fileroot.class.php, method FileRoot::FileRoot()
Constructor
FileRoot: in file _fileroot.class.php, class FileRoot
This class provides info about a File Root.
FileRootCache: in file _filerootcache.class.php, class FileRootCache
This class provides info about File Roots.
Filetype: in file _filetype.class.php, method Filetype::Filetype()
Constructor
Filetype: in file _filetype.class.php, class Filetype
Filetype Class
FiletypeCache: in file _filetypecache.class.php, method FiletypeCache::FiletypeCache()
Constructor
FiletypeCache: in file _filetypecache.class.php, class FiletypeCache
FiletypeCache Class
file_actions: in file _file_links.view.php, function file_actions()
file_path: in file _file_links.view.php, function file_path()
file_type: in file _file_links.view.php, function file_type()
fit_into_constraint: in file _image.funcs.php, function fit_into_constraint()
Scale dimensions to fit into a constrained size, while preserving aspect ratio.
fnmatch: in file _file.funcs.php, function fnmatch()
A replacement for fnmatch() which needs PHP 4.3 and a POSIX compliant system (Windows is not).
files.ctrl.php: procedural page files.ctrl.php
file_settings.ctrl.php: procedural page file_settings.ctrl.php
file_types.ctrl.php: procedural page file_types.ctrl.php

[Top]

g

generate_thumb: in file _image.funcs.php, function generate_thumb()
Generate a thumbnail
gen_ID: in file _fileroot.class.php, method FileRoot::gen_ID()
get: in file _file.class.php, method File::get()
Get a member param by its name
get_admin_templates: in file _file.funcs.php, function get_admin_templates()
Get a list of available admin templates.
get_ads_cache: in file _file.class.php, method File::get_ads_cache()
Get the full path to the thumbnail cache for this file.
get_ads_list_path: in file _filelist.class.php, method Filelist::get_ads_list_path()
Get absolute path to list.
get_af_thumb_path: in file _file.class.php, method File::get_af_thumb_path()
Get the full path to the thumbnail for this file.
get_array: in file _filelist.class.php, method Filelist::get_array()
Get the list of File entries.
get_available_FileRoots: in file _filerootcache.class.php, method FileRootCache::get_available_FileRoots()
Get an array of ALL available Fileroots (not just the cached ones).
get_available_thumb_sizes: in file _image.funcs.php, function get_available_thumb_sizes()
get_by_extension: in file _filetypecache.class.php, method FiletypeCache::get_by_extension()
Get an object from cache by extensions ID
get_by_full_path: in file _filelist.class.php, method Filelist::get_by_full_path()
Get a file by its full path.
get_by_ID: in file _filerootcache.class.php, method FileRootCache::get_by_ID()
Get a FileRoot (cached) by ID.
get_by_idx: in file _filelist.class.php, method Filelist::get_by_idx()
Get a file by index.
get_by_md5_ID: in file _filelist.class.php, method Filelist::get_by_md5_ID()
Get a file by it's ID.
get_by_rdfs_path: in file _filelist.class.php, method Filelist::get_by_rdfs_path()
Get a file by its relative (to root) path.
get_by_root_and_path: in file _filecache.class.php, method FileCache::get_by_root_and_path()
Creates an object of the File class, while providing caching and making sure that only one reference to a file exists.
get_by_type_and_ID: in file _filerootcache.class.php, method FileRootCache::get_by_type_and_ID()
Get a FileRoot (cached).
get_canonical_path: in file _file.funcs.php, function get_canonical_path()
Returns canonicalized pathname of a directory + ending slash
get_cwd_clickable: in file _filelist.class.php, method Filelist::get_cwd_clickable()
Returns cwd, where the accessible directories (below root) are clickable
get_dir: in file _file.class.php, method File::get_dir()
Get the File's directory.
get_directory_tree: in file _file.funcs.php, function get_directory_tree()
Get the directories of the supplied path as a radio button tree.
get_dirsize_recursive: in file _file.funcs.php, function get_dirsize_recursive()
Get size of a directory, including anything (especially subdirs) in there.
get_ext: in file _file.class.php, method File::get_ext()
Get the file's extension.
get_filenames: in file _file.funcs.php, function get_filenames()
Get an array of all directories (and optionally files) of a given directory, either flat (one-dimensional array) or multi-dimensional (then dirs are the keys and hold subdirs/files).
get_FileRoot: in file _filelist.class.php, method Filelist::get_FileRoot()
Get the FileLists FileRoot
get_FileRoot: in file _file.class.php, method File::get_FileRoot()
Get the File's FileRoot.
get_Filetype: in file _file.class.php, method File::get_Filetype()
Get the File's Filetype object (or NULL).
get_File_size: in file _filelist.class.php, method Filelist::get_File_size()
Get the size of a given File, according to $_use_recursive_dirsize.
get_File_size_formatted: in file _filelist.class.php, method Filelist::get_File_size_formatted()
Get size of the file/dir, formatted to nearest unit (kb, mb, etc.)
get_filter: in file _filelist.class.php, method Filelist::get_filter()
Return the current filter
get_fsgroup_name: in file _file.class.php, method File::get_fsgroup_name()
Get the owner name of the file.
get_fsowner_name: in file _file.class.php, method File::get_fsowner_name()
Get the owner name of the file.
get_full_path: in file _file.class.php, method File::get_full_path()
Get the full path (directory and name) to the file.
get_getfile_url: in file _file.class.php, method File::get_getfile_url()
Get the URL to access a file through getfile.php.
get_icon: in file _filetype.class.php, method Filetype::get_icon()
Return the img html code of the icon
get_icon: in file _file.class.php, method File::get_icon()
Get icon for this file.
get_image_size: in file _file.class.php, method File::get_image_size()
Get size of an image or false if not an image
get_lastmod_formatted: in file _file.class.php, method File::get_lastmod_formatted()
Get date/time of last modification, formatted.
get_lastmod_ts: in file _file.class.php, method File::get_lastmod_ts()
Get timestamp of last modification.
get_linkedit_link: in file _file.class.php, method File::get_linkedit_link()
Get link to edit linked file.
get_linkedit_url: in file _file.class.php, method File::get_linkedit_url()
get_md5_ID: in file _file.class.php, method File::get_md5_ID()
Get the File's ID (MD5 of path and name)
get_name: in file _file.class.php, method File::get_name()
Get the File's name.
get_next: in file _filelist.class.php, method Filelist::get_next()
Get the next entry and increment internal counter.
get_perms: in file _file.class.php, method File::get_perms()
Get permissions
get_prefixed_name: in file _file.class.php, method File::get_prefixed_name()
Get the name prefixed either with "Directory" or "File".
get_preview_thumb: in file _file.class.php, method File::get_preview_thumb()
Displays a preview thumbnail which is clickable and opens a view popup
get_rdfp_rel_path: in file _file.class.php, method File::get_rdfp_rel_path()
Get the file posix path relative to it's root (no trailing /)
get_rdfs_rel_path: in file _file.class.php, method File::get_rdfs_rel_path()
Get the file path relative to it's root, WITH trailing slash.
get_rds_list_path: in file _filelist.class.php, method Filelist::get_rds_list_path()
Get path to list relative to root.
get_recursive_size: in file _file.class.php, method File::get_recursive_size()
Get the "full" size of a file/dir (recursive for directories).
get_root_and_rel_path: in file _file.class.php, method File::get_root_and_rel_path()
Get location of file with its root (for display)
get_root_ID: in file _filelist.class.php, method Filelist::get_root_ID()
Get the FileLists root ID (in_type_ID).
get_root_type: in file _filelist.class.php, method Filelist::get_root_type()
Get the FileLists root type.
get_size: in file _file.class.php, method File::get_size()
Get file/dir size in bytes.
get_size_formatted: in file _file.class.php, method File::get_size_formatted()
Get size of the file, formatted to nearest unit (kb, mb, etc.)
get_sort_link: in file _filelist.class.php, method Filelist::get_sort_link()
Get the link to sort by a column. Handle current order and appends an icon to reflect the current state (ascending/descending), if the column is the same we're sorting by.
get_sort_order: in file _filelist.class.php, method Filelist::get_sort_order()
Get the used order.
get_tag: in file _file.class.php, method File::get_tag()
Get a complete tag (IMG or A HREF) pointing to this file.
get_thumb_imgtag: in file _file.class.php, method File::get_thumb_imgtag()
Generate the IMG THUMBNAIL tag with all the alt & title if available
get_thumb_url: in file _file.class.php, method File::get_thumb_url()
Get the thumbnail URL for this file
get_type: in file _file.class.php, method File::get_type()
Get the file type as a descriptive localized string.
get_typegroupname: in file _fileroot.class.php, method FileRoot::get_typegroupname()
dummy docblock makes error-free autodocs
get_url: in file _file.class.php, method File::get_url()
Get the absolute file url if the file is public
get_view_link: in file _file.class.php, method File::get_view_link()
Get Link to view the file (either with viewer of with browser, etc...)
get_view_url: in file _file.class.php, method File::get_view_url()
Get URL to view the file (either with viewer of with browser, etc...)

[Top]

i

$icon: in file _filetype.class.php, variable Filetype::$icon
$ID: in file _fileroot.class.php, variable FileRoot::$ID
Unique Root ID constructed from type and in_type_ID
$include_dirs: in file _filelist.class.php, variable Filelist::$include_dirs
Do we want to include directories? (This gets used by load()).
$include_files: in file _filelist.class.php, variable Filelist::$include_files
Do we want to include files? (This gets used by load()).
$in_type_ID: in file _fileroot.class.php, variable FileRoot::$in_type_ID
ID of user, group or collection.
imgsize: in file _file.funcs.php, function imgsize()
Get the size of an image file
instantiate: in file _filecache.class.php, method FileCache::instantiate()
Instantiate a DataObject from a table row and then cache it.
is_absolute_pathname: in file _file.funcs.php, function is_absolute_pathname()
Is the given path absolute (non-relative)?
is_dir: in file _file.class.php, method File::is_dir()
Is the File a directory?
is_editable: in file _file.class.php, method File::is_editable()
Is the file editable?
is_filtering: in file _filelist.class.php, method Filelist::is_filtering()
Is a filter active?
is_filter_regexp: in file _filelist.class.php, method Filelist::is_filter_regexp()
Is the current Filter a regexp?
is_image: in file _file.class.php, method File::is_image()
Is the File an image?
is_sorting_asc: in file _filelist.class.php, method Filelist::is_sorting_asc()
Are we sorting ascending?

[Top]

j

JS_showhide_class_on_checkbox: in file _file_settings.form.php, function JS_showhide_class_on_checkbox()
Javascript to init hidden/shown state of something (like a DIV) based on a checkbox
JS_showhide_class_on_this: in file _file_settings.form.php, function JS_showhide_class_on_this()
Javascript hide/show all DOM elements with a particular class based on current checkbox
JS_showhide_ffield_on_checkbox: in file _file_settings.form.php, function JS_showhide_ffield_on_checkbox()
Javascript to init hidden/shown state of a fastform field based on a checkbox
JS_showhide_ffield_on_this: in file _file_settings.form.php, function JS_showhide_ffield_on_this()
Javascript hide/show a fastform field based on current checkbox
JS_showhide_ids_on_checkbox: in file _file_settings.form.php, function JS_showhide_ids_on_checkbox()
Javascript to init hidden/shown state of something (like a DIV) based on a checkbox

[Top]

l

link_to_Item: in file _file.class.php, method File::link_to_Item()
load: in file _filelist.class.php, method Filelist::load()
Loads or reloads the filelist entries.
load_from_Request: in file _filetype.class.php, method Filetype::load_from_Request()
Load data from Request form fields.
load_image: in file _image.funcs.php, function load_image()
Load an image from a file into memory
load_meta: in file _filelist.class.php, method Filelist::load_meta()
Attempt to load meta data for all files in the list.
load_meta: in file _file.class.php, method File::load_meta()
Attempt to load meta data.
load_properties: in file _file.class.php, method File::load_properties()
Initializes or refreshes file properties (type, size, perms...)

[Top]

m

$meta: in file _file.class.php, variable File::$meta
Have we checked for meta data in the DB yet?
$mimetype: in file _filetype.class.php, variable Filetype::$mimetype
md5_checksum: in file _filelist.class.php, method Filelist::md5_checksum()
Get a MD5 checksum over the entries.
mkdir_r: in file _file.funcs.php, function mkdir_r()
Create a directory recursively.
move_to: in file _file.class.php, method File::move_to()
Move the file to another location

[Top]

n

$name: in file _filetype.class.php, variable Filetype::$name
$name: in file _fileroot.class.php, variable FileRoot::$name
Name of the root
no_trailing_slash: in file _file.funcs.php, function no_trailing_slash()
Remove trailing slash, if present

[Top]

o

output_cached_thumb: in file _file.class.php, method File::output_cached_thumb()
Output previously saved thumbnail for file
output_image: in file _image.funcs.php, function output_image()
Output an image from memory to web client

[Top]

r

rdfs_relto_root_from_adfs: in file _filelist.class.php, method Filelist::rdfs_relto_root_from_adfs()
Get the path (and name) of a File relative to the Filelist::$_FileRoot::$ads_path.
rel_path_to_base: in file _file.funcs.php, function rel_path_to_base()
Return the path without the leading $basepath, or if not below $basepath, just the basename of it.
remove: in file _filelist.class.php, method Filelist::remove()
Removes a File from the entries list.
rename_to: in file _file.class.php, method File::rename_to()
Rename the file in its current directory on disk.
restart: in file _filelist.class.php, method Filelist::restart()
Reset the iterator
rmdir_r: in file _file.funcs.php, function rmdir_r()
Deletes a dir recursively, wiping out all subdirectories!!
rm_cache: in file _file.class.php, method File::rm_cache()
Delete cache for a file

[Top]

s

save_image: in file _image.funcs.php, function save_image()
Output an image from memory to web client
save_thumb_to_cache: in file _file.class.php, method File::save_thumb_to_cache()
Save thumbnail for file
scale_to_constraint: in file _image.funcs.php, function scale_to_constraint()
Scale dimensions to fit into a constrained size, while preserving aspect ratio.
set: in file _filetype.class.php, method Filetype::set()
Set param value
set_filter: in file _filelist.class.php, method Filelist::set_filter()
Set the filter.
sort: in file _filelist.class.php, method Filelist::sort()
Sort the entries by sorting the internal $_order_index array.

[Top]

t

$title: in file _file.class.php, variable File::$title
Meta data: Long title
$type: in file _fileroot.class.php, variable FileRoot::$type
Type: 'user', 'group' or 'collection'.
thumbnail: in file _file.class.php, method File::thumbnail()
This will spit out a content-type header followed by a thumbnail for this file.
trailing_slash: in file _file.funcs.php, function trailing_slash()
Add a trailing slash, if none present

[Top]

u

upload.ctrl.php: procedural page upload.ctrl.php
unlink: in file _file.class.php, method File::unlink()
Unlink/Delete the file or folder from disk.
update_caches: in file _filelist.class.php, method Filelist::update_caches()
Update the name dependent caches

[Top]

v

$viewtype: in file _filetype.class.php, variable Filetype::$viewtype
validate_dirname: in file _file.funcs.php, function validate_dirname()
Check for valid dirname (no path allowed). ( MB )
validate_filename: in file _file.funcs.php, function validate_filename()
Check for valid filename and extension of the filename (no path allowed). (MB)

hic sunt dracones

	files

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