Author: joshiausdemwald
Date: 2009-05-12 17:02:25 +0200 (Tue, 12 May 2009)
New Revision: 18177
Added:
plugins/sfFilebasePlugin/doc/de-optimusprime-sfFilebasePlugin/_lib---Validator---sfFilebasePluginValidatorFile.php.html
plugins/sfFilebasePlugin/doc/de-optimusprime-sfFilebasePlugin/sfFilebasePluginValidatorFile.html
Log:
Docs
Added:
plugins/sfFilebasePlugin/doc/de-optimusprime-sfFilebasePlugin/_lib---Validator---sfFilebasePluginValidatorFile.php.html
===================================================================
---
plugins/sfFilebasePlugin/doc/de-optimusprime-sfFilebasePlugin/_lib---Validator---sfFilebasePluginValidatorFile.php.html
(rev 0)
+++
plugins/sfFilebasePlugin/doc/de-optimusprime-sfFilebasePlugin/_lib---Validator---sfFilebasePluginValidatorFile.php.html
2009-05-12 15:02:25 UTC (rev 18177)
@@ -0,0 +1,142 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";>
+ <html xmlns="http://www.w3.org/1999/xhtml";>
+ <head>
+ <!-- template designed by Marco Von Ballmoos -->
+ <title>Docs for page
sfFilebasePluginValidatorFile.php</title>
+ <link rel="stylesheet" href="../media/stylesheet.css" />
+ <script
src="../media/lib/classTree.js"></script>
+
<script language="javascript" type="text/javascript">
+ var imgPlus = new Image();
+ var imgMinus = new Image();
+ imgPlus.src = "../media/images/plus.png";
+ imgMinus.src = "../media/images/minus.png";
+
+ function showNode(Node){
+
switch(navigator.family){
+ case 'nn4':
+ // Nav
4.x code fork...
+ var oTable =
document.layers["span" + Node];
+ var oImg =
document.layers["img" + Node];
+ break;
+ case 'ie4':
+ // IE
4/5 code fork...
+ var oTable =
document.all["span" + Node];
+ var oImg =
document.all["img" + Node];
+ break;
+ case 'gecko':
+ //
Standards Compliant code fork...
+ var oTable =
document.getElementById("span" + Node);
+ var oImg =
document.getElementById("img" + Node);
+ break;
+ }
+ oImg.src = imgMinus.src;
+ oTable.style.display = "block";
+ }
+
+ function hideNode(Node){
+
switch(navigator.family){
+ case 'nn4':
+ // Nav
4.x code fork...
+ var oTable =
document.layers["span" + Node];
+ var oImg =
document.layers["img" + Node];
+ break;
+ case 'ie4':
+ // IE
4/5 code fork...
+ var oTable =
document.all["span" + Node];
+ var oImg =
document.all["img" + Node];
+ break;
+ case 'gecko':
+ //
Standards Compliant code fork...
+ var oTable =
document.getElementById("span" + Node);
+ var oImg =
document.getElementById("img" + Node);
+ break;
+ }
+ oImg.src = imgPlus.src;
+ oTable.style.display = "none";
+ }
+
+ function nodeIsVisible(Node){
+
switch(navigator.family){
+ case 'nn4':
+ // Nav
4.x code fork...
+ var oTable =
document.layers["span" + Node];
+ break;
+ case 'ie4':
+ // IE
4/5 code fork...
+ var oTable =
document.all["span" + Node];
+ break;
+ case 'gecko':
+ //
Standards Compliant code fork...
+ var oTable =
document.getElementById("span" + Node);
+ break;
+ }
+ return (oTable && oTable.style.display
== "block");
+ }
+
+ function toggleNodeVisibility(Node){
+ if (nodeIsVisible(Node)){
+ hideNode(Node);
+ }else{
+ showNode(Node);
+ }
+ }
+ </script>
+ </head>
+ <body>
+ <div class="page-body">
+<h2 class="file-name">/lib/Validator/sfFilebasePluginValidatorFile.php</h2>
+
+<a name="sec-description"></a>
+<div class="info-box">
+ <div class="info-box-title">Description</div>
+ <div class="nav-bar">
+ <span
class="disabled">Description</span> |
+ <a
href="#sec-classes">Classes</a>
+
</div>
+ <div class="info-box-body">
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">sfFilebasePluginValidatorFile validates uploaded
files, internally based on sfFilebasePluginUploadedFile object, not on the raw
file-array that you can access through sfWebRequest::getFiles() or php
internal $_FILES globals.</p>
+ <ul class="tags">
+ <li><span class="field">author:</span> the
original sfValidatorFile-Class: Fabien Potencier <<a
href="mailto:[email protected]";>[email protected]</a>></li>
+ <li><span class="field">author:</span>
joshi</li>
+ <li><span class="field">see:</span>
sfValidatorFile</li>
+ </ul>
+
+ </div>
+</div>
+
+ <a name="sec-classes"></a>
+ <div class="info-box">
+ <div class="info-box-title">Classes</div>
+ <div class="nav-bar">
+ <a href="#sec-description">Description</a> |
+ <span class="disabled">Classes</span>
+
</div>
+ <div class="info-box-body">
+ <table cellpadding="2" cellspacing="0"
class="class-table">
+ <tr>
+ <th
class="class-table-header">Class</th>
+ <th
class="class-table-header">Description</th>
+ </tr>
+ <tr>
+ <td style="padding-right: 2em;
vertical-align: top">
+ <a
href="../de-optimusprime-sfFilebasePlugin/sfFilebasePluginValidatorFile.html">sfFilebasePluginValidatorFile</a>
+ </td>
+ <td>
+
sfFilebasePluginValidatorFile validates uploaded files, internally
based on sfFilebasePluginUploadedFile object, not on the raw file-array that
you can access through sfWebRequest::getFiles() or php internal $_FILES
globals.
+
</td>
+ </tr>
+ </table>
+ </div>
+ </div>
+
+
+
+
+
+ <p class="notes" id="credit">
+ Documentation generated on Tue, 12 May 2009 17:01:48 +0200 by
<a href="http://www.phpdoc.org"; target="_blank">phpDocumentor 1.4.2</a>
+ </p>
+ </div></body>
+</html>
\ No newline at end of file
Added:
plugins/sfFilebasePlugin/doc/de-optimusprime-sfFilebasePlugin/sfFilebasePluginValidatorFile.html
===================================================================
---
plugins/sfFilebasePlugin/doc/de-optimusprime-sfFilebasePlugin/sfFilebasePluginValidatorFile.html
(rev 0)
+++
plugins/sfFilebasePlugin/doc/de-optimusprime-sfFilebasePlugin/sfFilebasePluginValidatorFile.html
2009-05-12 15:02:25 UTC (rev 18177)
@@ -0,0 +1,270 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";>
+ <html xmlns="http://www.w3.org/1999/xhtml";>
+ <head>
+ <!-- template designed by Marco Von Ballmoos -->
+ <title>Docs For Class
sfFilebasePluginValidatorFile</title>
+ <link rel="stylesheet" href="../media/stylesheet.css" />
+ <script
src="../media/lib/classTree.js"></script>
+
<script language="javascript" type="text/javascript">
+ var imgPlus = new Image();
+ var imgMinus = new Image();
+ imgPlus.src = "../media/images/plus.png";
+ imgMinus.src = "../media/images/minus.png";
+
+ function showNode(Node){
+
switch(navigator.family){
+ case 'nn4':
+ // Nav
4.x code fork...
+ var oTable =
document.layers["span" + Node];
+ var oImg =
document.layers["img" + Node];
+ break;
+ case 'ie4':
+ // IE
4/5 code fork...
+ var oTable =
document.all["span" + Node];
+ var oImg =
document.all["img" + Node];
+ break;
+ case 'gecko':
+ //
Standards Compliant code fork...
+ var oTable =
document.getElementById("span" + Node);
+ var oImg =
document.getElementById("img" + Node);
+ break;
+ }
+ oImg.src = imgMinus.src;
+ oTable.style.display = "block";
+ }
+
+ function hideNode(Node){
+
switch(navigator.family){
+ case 'nn4':
+ // Nav
4.x code fork...
+ var oTable =
document.layers["span" + Node];
+ var oImg =
document.layers["img" + Node];
+ break;
+ case 'ie4':
+ // IE
4/5 code fork...
+ var oTable =
document.all["span" + Node];
+ var oImg =
document.all["img" + Node];
+ break;
+ case 'gecko':
+ //
Standards Compliant code fork...
+ var oTable =
document.getElementById("span" + Node);
+ var oImg =
document.getElementById("img" + Node);
+ break;
+ }
+ oImg.src = imgPlus.src;
+ oTable.style.display = "none";
+ }
+
+ function nodeIsVisible(Node){
+
switch(navigator.family){
+ case 'nn4':
+ // Nav
4.x code fork...
+ var oTable =
document.layers["span" + Node];
+ break;
+ case 'ie4':
+ // IE
4/5 code fork...
+ var oTable =
document.all["span" + Node];
+ break;
+ case 'gecko':
+ //
Standards Compliant code fork...
+ var oTable =
document.getElementById("span" + Node);
+ break;
+ }
+ return (oTable && oTable.style.display
== "block");
+ }
+
+ function toggleNodeVisibility(Node){
+ if (nodeIsVisible(Node)){
+ hideNode(Node);
+ }else{
+ showNode(Node);
+ }
+ }
+ </script>
+ </head>
+ <body>
+ <div class="page-body">
+<h2 class="class-name">Class sfFilebasePluginValidatorFile</h2>
+
+<a name="sec-description"></a>
+<div class="info-box">
+ <div class="info-box-title">Description</div>
+ <div class="nav-bar">
+ <span
class="disabled">Description</span> |
+
<a
href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
+
+ </div>
+ <div class="info-box-body">
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">sfFilebasePluginValidatorFile validates uploaded
files, internally based on sfFilebasePluginUploadedFile object, not on the raw
file-array that you can access through sfWebRequest::getFiles() or php
internal $_FILES globals.</p>
+ <ul class="tags">
+ <li><span class="field">author:</span> the
original sfValidatorFile-Class: Fabien Potencier <<a
href="mailto:[email protected]";>[email protected]</a>></li>
+ <li><span class="field">author:</span>
joshi</li>
+ <li><span class="field">see:</span>
sfValidatorFile</li>
+ </ul>
+ <p class="notes">
+ Located in <a class="field"
href="_lib---Validator---sfFilebasePluginValidatorFile.php.html">/lib/Validator/sfFilebasePluginValidatorFile.php</a>
(line <span class="field">19</span>)
+ </p>
+
+
+ <pre>sfValidatorBase
+ |
+ --sfFilebasePluginValidatorFile</pre>
+
+ </div>
+</div>
+
+
+
+
+ <a name="sec-method-summary"></a>
+ <div class="info-box">
+ <div class="info-box-title">Method Summary</span></div>
+ <div class="nav-bar">
+ <a href="#sec-description">Description</a> |
+
<span class="disabled">Methods</span> (<a
href="#sec-methods">details</a>)
+ </div>
+ <div class="info-box-body">
+ <div class="method-summary">
+
+ <div class="method-definition">
+
<span class="method-result"><a
href="../de-optimusprime-sfFilebasePlugin/sfFilebasePluginUploadedFile.html">sfFilebasePluginUploadedFile</a></span>
+
<a href="#clean" title="details" class="method-name">clean</a>
+
(<span class="var-type"><a
href="../de-optimusprime-sfFilebasePlugin/sfFilebasePluginUploadedFile.html">sfFilebasePluginUploadedFile</a></span> <span
class="var-name">$value</span>)
+ </div>
+
+ <div class="method-definition">
+
<span class="method-result">void</span>
+
<a href="#configure" title="details" class="method-name">configure</a>
+
([<span class="var-type">array</span> <span
class="var-name">$options</span> = <span class="var-default">array()</span>],
[<span class="var-type">array</span> <span
class="var-name">$messages</span> = <span class="var-default">array()</span>])
+ </div>
+
+ <div class="method-definition">
+
<span class="method-result"><a
href="../de-optimusprime-sfFilebasePlugin/sfFilebasePluginUploadedFile.html">sfFilebasePluginUploadedFile</a></span>
+
<a href="#doClean" title="details" class="method-name">doClean</a>
+
(<span class="var-type"></span> <span
class="var-name">$value</span>)
+ </div>
+
</div>
+ </div>
+ </div>
+
+
+ <a name="sec-methods"></a>
+ <div class="info-box">
+ <div class="info-box-title">Methods</div>
+ <div class="nav-bar">
+ <a href="#sec-description">Description</a> |
+
<a
href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
+
+ </div>
+ <div class="info-box-body">
+ <A NAME='method_detail'></A>
+<a name="methodclean" id="clean"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">clean</span> (line <span
class="line-number">89</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Cleans the input value.</p>
+<p class="description"><p>This method is also responsible for trimming the
input value and checking the required option.</p></p>
+ <ul class="tags">
+ <li><span class="field">throws:</span>
sfValidatorError</li>
+ <li><span class="field">access:</span>
public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result"><a
href="../de-optimusprime-sfFilebasePlugin/sfFilebasePluginUploadedFile.html">sfFilebasePluginUploadedFile</a></span>
+ <span class="method-name">
+ clean
+ </span>
+ (<span class="var-type"><a
href="../de-optimusprime-sfFilebasePlugin/sfFilebasePluginUploadedFile.html">sfFilebasePluginUploadedFile</a></span> <span
class="var-name">$value</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type"><a
href="../de-optimusprime-sfFilebasePlugin/sfFilebasePluginUploadedFile.html">sfFilebasePluginUploadedFile</a></span>
+ <span class="var-name">$value</span><span
class="var-description">: The input value</span> </li>
+ </ul>
+
+
+ </div>
+<a name="methodconfigure" id="configure"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">configure</span> (line <span
class="line-number">59</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">Configures the current validator.</p>
+<p class="description"><p>The api for sfFilebasePluginValidatorFile is derived
from sfValidatorFile. So there are only little changes in handling, but the
return value is of type sfFilebaseUploadedFile, which have a few ways to deal
with uploaded files, move them, create thumbnails and so on...</p><p>There are
no mime guessers, the sfFilebasePluginUploadedFilesManager deals with that
when you call sfFilebasePlugin::getUploadedFiles().</p><p>There is also no path
to specify, you do that later directly by calling
sfFilebasePluginUploadedFile::moveUploadedFile</p><p>As a compromise, you
cannot specify your own fileclass anymore, beside extending
sfFilebaseUploadedFile and -manager.</p><p>Available options:</p><p>* max_size:
The maximum file size * mime_types: Allowed mime types array or category
(available categories: web_images) * mime_categories: An array of mime type
categories (web_images is defined by default)</p><p>Available error
codes:</p><p>* max_size * mime_types * partial * no_tmp_dir * cant_write *
extension</p></p>
+ <ul class="tags">
+ <li><span class="field">see:</span>
sfValidatorFile</li>
+ <li><span class="field">see:</span>
sfValidatorBase</li>
+ <li><span class="field">access:</span>
protected</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result">void</span>
+ <span class="method-name">
+ configure
+ </span>
+ ([<span
class="var-type">array</span> <span class="var-name">$options</span> =
<span class="var-default">array()</span>], [<span
class="var-type">array</span> <span class="var-name">$messages</span> =
<span class="var-default">array()</span>])
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type">array</span>
+ <span class="var-name">$options</span><span
class="var-description">: An array of options</span>
</li>
+ <li>
+ <span class="var-type">array</span>
+ <span class="var-name">$messages</span><span
class="var-description">: An array of error messages</span>
</li>
+ </ul>
+
+
+ </div>
+<a name="methoddoClean" id="doClean"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">doClean</span> (line <span
class="line-number">121</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<p class="short-description">This validator returns a
sfFilebasePluginUploadedFile object.</p>
+<p class="description"><p>The input value must be an instance of
sfFilebasePluginUploadedFile</p></p>
+ <ul class="tags">
+ <li><span class="field">see:</span>
sfValidatorBase</li>
+ <li><span class="field">see:</span> <a
href="../de-optimusprime-sfFilebasePlugin/sfFilebasePluginUploadedFile.html">sfFilebasePluginUploadedFile</a></li>
+ <li><span class="field">access:</span>
protected</li>
+ </ul>
+
+ <div class="method-signature">
+ <span class="method-result"><a
href="../de-optimusprime-sfFilebasePlugin/sfFilebasePluginUploadedFile.html">sfFilebasePluginUploadedFile</a></span>
+ <span class="method-name">
+ doClean
+ </span>
+ (<span
class="var-type"></span> <span class="var-name">$value</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type"></span>
+ <span class="var-name">$value</span>
</li>
+ </ul>
+
+
+ </div>
+
+ </div>
+ </div>
+
+
+ <p class="notes" id="credit">
+ Documentation generated on Tue, 12 May 2009 17:01:48 +0200 by
<a href="http://www.phpdoc.org"; target="_blank">phpDocumentor 1.4.2</a>
+ </p>
+ </div></body>
+</html>
\ No newline at end of file
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups
"symfony SVN" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to
[email protected]
For more options, visit this group at
http://groups.google.com/group/symfony-svn?hl=en
-~----------~----~----~----~------~----~------~--~---
