Source of file WordCount.php
Size: 6,334 Bytes - Last Modified: 2014-03-12T23:21:18+01:00
/home/theseer/Downloads/ZendFramework-2.3.0/library/Zend/Validator/File/WordCount.php
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214 | <?php /** * Zend Framework (http://framework.zend.com/) * * @link http://github.com/zendframework/zf2 for the canonical source repository * @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com) * @license http://framework.zend.com/license/new-bsd New BSD License */ namespace Zend\Validator\File; use Zend\Validator\AbstractValidator; use Zend\Validator\Exception; /** * Validator for counting all words in a file */ class WordCount extends AbstractValidator { /** * @const string Error constants */ const TOO_MUCH = 'fileWordCountTooMuch'; const TOO_LESS = 'fileWordCountTooLess'; const NOT_FOUND = 'fileWordCountNotFound'; /** * @var array Error message templates */ protected $messageTemplates = array( self::TOO_MUCH => "Too many words, maximum '%max%' are allowed but '%count%' were counted", self::TOO_LESS => "Too few words, minimum '%min%' are expected but '%count%' were counted", self::NOT_FOUND => "File is not readable or does not exist", ); /** * @var array Error message template variables */ protected $messageVariables = array( 'min' => array('options' => 'min'), 'max' => array('options' => 'max'), 'count' => 'count' ); /** * Word count * * @var int */ protected $count; /** * Options for this validator * * @var array */ protected $options = array( 'min' => null, // Minimum word count, if null there is no minimum word count 'max' => null, // Maximum word count, if null there is no maximum word count ); /** * Sets validator options * * Min limits the word count, when used with max=null it is the maximum word count * It also accepts an array with the keys 'min' and 'max' * * If $options is an integer, it will be used as maximum word count * As Array is accepts the following keys: * 'min': Minimum word count * 'max': Maximum word count * * @param int|array|\Traversable $options Options for the adapter */ public function __construct($options = null) { if (is_string($options) || is_numeric($options)) { $options = array('max' => $options); } if (1 < func_num_args()) { $options['min'] = func_get_arg(0); $options['max'] = func_get_arg(1); } parent::__construct($options); } /** * Returns the minimum word count * * @return int */ public function getMin() { return $this->options['min']; } /** * Sets the minimum word count * * @param int|array $min The minimum word count * @return WordCount Provides a fluent interface * @throws Exception\InvalidArgumentException When min is greater than max */ public function setMin($min) { if (is_array($min) and isset($min['min'])) { $min = $min['min']; } if (!is_string($min) and !is_numeric($min)) { throw new Exception\InvalidArgumentException('Invalid options to validator provided'); } $min = (int) $min; if (($this->getMax() !== null) && ($min > $this->getMax())) { throw new Exception\InvalidArgumentException( "The minimum must be less than or equal to the maximum word count, but $min >" . " {$this->getMax()}"); } $this->options['min'] = $min; return $this; } /** * Returns the maximum word count * * @return int */ public function getMax() { return $this->options['max']; } /** * Sets the maximum file count * * @param int|array $max The maximum word count * @return WordCount Provides a fluent interface * @throws Exception\InvalidArgumentException When max is smaller than min */ public function setMax($max) { if (is_array($max) and isset($max['max'])) { $max = $max['max']; } if (!is_string($max) and !is_numeric($max)) { throw new Exception\InvalidArgumentException('Invalid options to validator provided'); } $max = (int) $max; if (($this->getMin() !== null) && ($max < $this->getMin())) { throw new Exception\InvalidArgumentException( "The maximum must be greater than or equal to the minimum word count, but " . "$max < {$this->getMin()}"); } $this->options['max'] = $max; return $this; } /** * Returns true if and only if the counted words are at least min and * not bigger than max (when max is not null). * * @param string|array $value Filename to check for word count * @param array $file File data from \Zend\File\Transfer\Transfer (optional) * @return bool */ public function isValid($value, $file = null) { if (is_string($value) && is_array($file)) { // Legacy Zend\Transfer API support $filename = $file['name']; $file = $file['tmp_name']; } elseif (is_array($value)) { if (!isset($value['tmp_name']) || !isset($value['name'])) { throw new Exception\InvalidArgumentException( 'Value array must be in $_FILES format' ); } $file = $value['tmp_name']; $filename = $value['name']; } else { $file = $value; $filename = basename($file); } $this->setValue($filename); // Is file readable ? if (empty($file) || false === stream_resolve_include_path($file)) { $this->error(self::NOT_FOUND); return false; } $content = file_get_contents($file); $this->count = str_word_count($content); if (($this->getMax() !== null) && ($this->count > $this->getMax())) { $this->error(self::TOO_MUCH); return false; } if (($this->getMin() !== null) && ($this->count < $this->getMin())) { $this->error(self::TOO_LESS); return false; } return true; } } |