[ Index ]
 

Code source de DokuWiki 2006-11-06

Accédez au Source d'autres logiciels libresSoutenez Angelica Josefina !

title

Body

[fermer]

/inc/ -> io.php (sommaire)

File IO functions

Author: Andreas Gohr <andi@splitbrain.org>
License: GPL 2 (http://www.gnu.org/licenses/gpl.html)
Poids: 567 lignes (15 kb)
Inclus ou requis: 6 fois
Référencé: 0 fois
Nécessite: 4 fichiers
 inc/utf8.php
 inc/events.php
 inc/HTTPClient.php
 inc/common.php

Définit 19 fonctions

  io_sweepNS()
  io_readWikiPage()
  _io_readWikiPage_action()
  io_readFile()
  bzfile()
  io_writeWikiPage()
  _io_writeWikiPage_action()
  io_saveFile()
  io_deleteFromFile()
  io_lock()
  io_unlock()
  io_createNamespace()
  io_makeFileDir()
  io_mkdir_p()
  io_mkdir_ftp()
  io_download()
  io_rename()
  io_runcmd()
  io_grep()

Fonctions
Fonctions qui ne font pas partie d'une Classe:

io_sweepNS($id,$basedir='datadir')   X-Ref
Removes empty directories

Sends IO_NAMESPACE_DELETED events for 'pages' and 'media' namespaces.
Event data:
$data[0]    ns: The colon separated namespace path minus the trailing page name.
$data[1]    ns_type: 'pages' or 'media' namespace tree.

author: Andreas Gohr <andi@splitbrain.org>
author: Ben Coburn <btcoburn@silicodon.net>

io_readWikiPage($file, $id, $rev=false)   X-Ref
Used to read in a DokuWiki page from file, and send IO_WIKIPAGE_READ events.

Generates the action event which delegates to io_readFile().
Action plugins are allowed to modify the page content in transit.
The file path should not be changed.

Event data:
$data[0]    The raw arguments for io_readFile as an array.
$data[1]    ns: The colon separated namespace path minus the trailing page name. (false if root ns)
$data[2]    page_name: The wiki page name.
$data[3]    rev: The page revision, false for current wiki pages.

author: Ben Coburn <btcoburn@silicodon.net>

_io_readWikiPage_action($data)   X-Ref
Callback adapter for io_readFile().

author: Ben Coburn <btcoburn@silicodon.net>

io_readFile($file,$clean=true)   X-Ref
Returns content of $file as cleaned string.

Uses gzip if extension is .gz

If you want to use the returned value in unserialize
be sure to set $clean to false!

author: Andreas Gohr <andi@splitbrain.org>

bzfile($file)   X-Ref
Returns the content of a .bz2 compressed file as string

author: marcel senf <marcel@rucksackreinigung.de>

io_writeWikiPage($file, $content, $id, $rev=false)   X-Ref
Used to write out a DokuWiki page to file, and send IO_WIKIPAGE_WRITE events.

This generates an action event and delegates to io_saveFile().
Action plugins are allowed to modify the page content in transit.
The file path should not be changed.
(The append parameter is set to false.)

Event data:
$data[0]    The raw arguments for io_saveFile as an array.
$data[1]    ns: The colon separated namespace path minus the trailing page name. (false if root ns)
$data[2]    page_name: The wiki page name.
$data[3]    rev: The page revision, false for current wiki pages.

author: Ben Coburn <btcoburn@silicodon.net>

_io_writeWikiPage_action($data)   X-Ref
Callback adapter for io_saveFile().

author: Ben Coburn <btcoburn@silicodon.net>

io_saveFile($file,$content,$append=false)   X-Ref
Saves $content to $file.

If the third parameter is set to true the given content
will be appended.

Uses gzip if extension is .gz
and bz2 if extension is .bz2

author: Andreas Gohr <andi@splitbrain.org>
return: bool true on success

io_deleteFromFile($file,$badline,$regex=false)   X-Ref
Delete exact linematch for $badline from $file.

Be sure to include the trailing newline in $badline

Uses gzip if extension is .gz

2005-10-14 : added regex option -- Christopher Smith <chris@jalakai.co.uk>

author: Steven Danz <steven-danz@kc.rr.com>
return: bool true on success

io_lock($file)   X-Ref
Tries to lock a file

Locking is only done for io_savefile and uses directories
inside $conf['lockdir']

It waits maximal 3 seconds for the lock, after this time
the lock is assumed to be stale and the function goes on

author: Andreas Gohr <andi@splitbrain.org>

io_unlock($file)   X-Ref
Unlocks a file

author: Andreas Gohr <andi@splitbrain.org>

io_createNamespace($id, $ns_type='pages')   X-Ref
Create missing namespace directories and send the IO_NAMESPACE_CREATED events
in the order of directory creation. (Parent directories first.)

Event data:
$data[0]    ns: The colon separated namespace path minus the trailing page name.
$data[1]    ns_type: 'pages' or 'media' namespace tree.

author: Ben Coburn <btcoburn@silicodon.net>

io_makeFileDir($file)   X-Ref
Create the directory needed for the given file

author: Andreas Gohr <andi@splitbrain.org>

io_mkdir_p($target)   X-Ref
Creates a directory hierachy.

author: <saint@corenova.com>
author: Andreas Gohr <andi@splitbrain.org>

io_mkdir_ftp($dir)   X-Ref
Creates a directory using FTP

This is used when the safemode workaround is enabled

author: <andi@splitbrain.org>

io_download($url,$file,$useAttachment=false,$defaultName='',$maxSize=2097152)   X-Ref
downloads a file from the net and saves it

if $useAttachment is false,
- $file is the full filename to save the file, incl. path
- if successful will return true, false otherwise
if $useAttachment is true,
- $file is the directory where the file should be saved
- if successful will return the name used for the saved file, false otherwise

author: Andreas Gohr <andi@splitbrain.org>
author: Chris Smith <chris@jalakai.co.uk>

io_rename($from,$to)   X-Ref
Windows compatible rename

rename() can not overwrite existing files on Windows
this function will use copy/unlink instead

io_runcmd($cmd)   X-Ref
Runs an external command and returns it's output as string

author: Harry Brueckner <harry_b@eml.cc>
author: Andreas Gohr <andi@splitbrain.org>

io_grep($file,$pattern,$max=0,$backref=false)   X-Ref
Search a file for matching lines

This is probably not faster than file()+preg_grep() but less
memory intensive because not the whole file needs to be loaded
at once.

author: Andreas Gohr <andi@splitbrain.org>
param: string $file    The file to search
param: string $pattern PCRE pattern
param: int    $max     How many lines to return (0 for all)
param: bool   $baxkref When true returns array with backreferences instead of lines
return: matching lines or backref, false on error



Généré le : Tue Apr 3 20:47:31 2007 par Balluche grâce à PHPXref 0.7