[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Phpgroupware-cvs] phpgwapi/doc/vfs/vfs-2.html, 1.6
|
From: |
nomail |
|
Subject: |
[Phpgroupware-cvs] phpgwapi/doc/vfs/vfs-2.html, 1.6 |
|
Date: |
Thu, 30 Dec 2004 07:47:30 +0100 |
Update of /phpgwapi/doc/vfs
Added Files:
Branch:
vfs-2.html
date: 2004/12/30 06:47:30; author: skwashd; state: Exp; lines: +2 -2
Log Message:
new HEAD
=====================================================================
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<HTML>
<HEAD>
<META NAME="GENERATOR" CONTENT="LinuxDoc-Tools 0.9.17">
<TITLE>phpgwapi - VFS Class: Basics</TITLE>
<LINK HREF="vfs-3.html" REL=next>
<LINK HREF="vfs-1.html" REL=previous>
<LINK HREF="vfs.html#toc2" REL=contents>
</HEAD>
<BODY>
<A HREF="vfs-3.html">Next</A>
<A HREF="vfs-1.html">Previous</A>
<A HREF="vfs.html#toc2">Contents</A>
<HR>
<H2><A NAME="sec:basics"></A> <A NAME="s2">2.</A> <A
HREF="vfs.html#toc2">Basics</A></H2>
<H2><A NAME="sec:prerequisites"></A> <A NAME="ss2.1">2.1</A> <A
HREF="vfs.html#toc2.1">Prerequisites</A>
</H2>
<P>You must explicitly enable the VFS class. To do this, set 'enable_vfs_class'
to True in $GLOBALS['phpgw_info']['flags'].
An example:</P>
<P>
<PRE>
$GLOBALS['phpgw_info']['flags'] = array(
'currentapp' => 'phpwebhosting',
'noheader' => False,
'noappheader' => False,
'enable_vfs_class' => True,
'enable_browser_class' => True
);
</PRE>
</P>
<H2><A NAME="sec:concepts"></A> <A NAME="ss2.2">2.2</A> <A
HREF="vfs.html#toc2.2">Concepts</A>
</H2>
<P>The VFS in located in phpgwapi/inc/class.vfs_sql.inc.php. You
can look over it, but I don't suggest trying to understand how it
works. It isn't necessary to know its internals to use it, but you
may find the inline comments helpful. The basic things to keep in
mind:</P>
<P>
<UL>
<LI>Files and directories are synonymous in almost all cases</LI>
</UL>
</P>
<P>
<PRE>
$GLOBALS['phpgw']->vfs->mv (array(
'from' => 'file1',
'to' => 'dir/file2'
));
$GLOBALS['phpgw']->vfs->mv (array(
'from' => 'dir1',
'to' => 'dir/dir1'
));
$GLOBALS['phpgw']->vfs->rm (array(
'string' => 'file'
));
$GLOBALS['phpgw']->vfs->rm (array(
'string' => 'dir'
));
</PRE>
</P>
<P>All work as you would except them to. The major exception is:</P>
<P>
<PRE>
$GLOBALS['phpgw']->vfs->touch (array(
'string' => 'file'
));
</PRE>
</P>
<P>vs.</P>
<P>
<PRE>
$GLOBALS['phpgw']->vfs->mkdir (array(
'string' => 'dir'
));
</PRE>
</P>
<P>
<UL>
<LI>Users and groups are synonymous</LI>
</UL>
</P>
<P>As far as the actual paths are concerned, users and groups are
the same. /home/username works the same as /home/groupname.</P>
<P>
<UL>
<LI>You should never have to know the real paths of files</LI>
</UL>
</P>
<P>One of the VFS's responsibilities is to translate paths for you.
While you certainly <EM>can</EM> operate using full paths, it is much simpler
to use the virtual paths. For example, instead of using:</P>
<P>
<PRE>
$GLOBALS['phpgw']->vfs->cp (array(
'from' => '/var/www/phpgroupware/files/home/user/file1',
'to' => '/var/www/phpgroupware/files/home/user/file2',
'relatives' => array(
RELATIVE_NONE|VFS_REAL,
RELATIVE_NONE|VFS_REAL
)
));
</PRE>
</P>
<P>you might use</P>
<P>
<PRE>
$GLOBALS['phpgw']->vfs->cp (array(
'from' => '/home/user/file1',
'to' => '/home/user/file2',
'relatives' => array(
RELATIVE_NONE,
RELATIVE_NONE
)
));
</PRE>
</P>
<P>(We'll get to the RELATIVE's in a minute.)</P>
<P>Site administrators should be able to move their files dir around
on their system and know that everything will continue to work smoothly.</P>
<P>
<UL>
<LI>Relativity is <EM>vital</EM></LI>
</UL>
</P>
<P>Relativity is a new feature in the VFS, and its importance cannot
be stressed enough. It will make your life much easier, especially
for file system intensive applications, but it will take some getting
used to. If something doesn't work right the first time, chances
are great it has to do with incorrect relativity settings. We will
deal with relativity in depth in the Relativity section.</P>
<HR>
<A HREF="vfs-3.html">Next</A>
<A HREF="vfs-1.html">Previous</A>
<A HREF="vfs.html#toc2">Contents</A>
</BODY>
</HTML>
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Phpgroupware-cvs] phpgwapi/doc/vfs/vfs-2.html, 1.6,
nomail <=