initial commit

lib/symfony/validator/sfValidator.class.php

@@ -0,0 +1,113 @@
+<?php
+
+/*
+ * This file is part of the symfony package.
+ * (c) 2004-2006 Fabien Potencier <fabien.potencier@symfony-project.com>
+ * (c) 2004-2006 Sean Kerr.
+ * 
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+/**
+ * sfValidator allows you to apply constraints to user entered parameters.
+ *
+ * @package    symfony
+ * @subpackage validator
+ * @author     Fabien Potencier <fabien.potencier@symfony-project.com>
+ * @author     Sean Kerr <skerr@mojavi.org>
+ * @version    SVN: $Id: sfValidator.class.php 3250 2007-01-12 20:09:11Z fabien $
+ */
+abstract class sfValidator
+{
+  protected
+    $parameterHolder = null,
+    $context         = null;
+
+  /**
+   * Executes this validator.
+   *
+   * @param mixed A file or parameter value/array
+   * @param string An error message reference
+   *
+   * @return bool true, if this validator executes successfully, otherwise false
+   */
+  abstract function execute(&$value, &$error);
+
+  /**
+   * Retrieves the current application context.
+   *
+   * @return sfContext The current sfContext instance
+   */
+  public final function getContext()
+  {
+    return $this->context;
+  }
+
+  /**
+   * Initializes this validator.
+   *
+   * @param sfContext The current application context
+   * @param array   An associative array of initialization parameters
+   *
+   * @return bool true, if initialization completes successfully, otherwise false
+   */
+  public function initialize($context, $parameters = array())
+  {
+    $this->context = $context;
+
+    $this->parameterHolder = new sfParameterHolder();
+    $this->parameterHolder->add($parameters);
+
+    return true;
+  }
+
+  /**
+   * Retrieves the parameters from the validator.
+   *
+   * @return sfParameterHolder List of parameters
+   */
+  public function getParameterHolder()
+  {
+    return $this->parameterHolder;
+  }
+
+  /**
+   * Retrieves a parameter from the validator.
+   *
+   * @param string Parameter name
+   * @param mixed A default parameter value
+   * @param string A parameter namespace
+   *
+   * @return mixed A parameter value
+   */
+  public function getParameter($name, $default = null, $ns = null)
+  {
+    return $this->parameterHolder->get($name, $default, $ns);
+  }
+
+  /**
+   * Indicates whether or not a parameter exist for the validator.
+   *
+   * @param string A parameter name
+   * @param string A parameter namespace
+   *
+   * @return boolean true, if parameter exists, otherwise false
+   */
+  public function hasParameter($name, $ns = null)
+  {
+    return $this->parameterHolder->has($name, $ns);
+  }
+
+  /**
+   * Sets a parameter for the validator.
+   *
+   * @param string A parameter name
+   * @param mixed A parameter value
+   * @param string A parameter namespace
+   */
+  public function setParameter($name, $value, $ns = null)
+  {
+    $this->parameterHolder->set($name, $value, $ns);
+  }
+}