FileValidatorModule

Every FileValidator module must provide its own static getModuleInfo() method. The only ProcessWire-specific requirement is the validates key: an array of lowercase file extensions that the module handles. Extensions may also be regular expressions when wrapped in /…/.

public static function getModuleInfo() {
    return [
        'title' => 'Validate HTML files',
        'version' => 1,
        'summary' => 'Validates uploaded HTML files',
        'validates' => ['html', 'htm'],
    ];
}

To validate every file type regardless of extension, specify '/.*/' in the validates array.

When ProcessWire validates a file that belongs to a Page/Field/Pagefile context, it populates the following context on the validator before calling isValid():

Use the public getter methods below to read them. The _pagefile getter will fall back to the page/field objects it carries when no direct context was set.

isValidFile($filename)

abstract protected function isValidFile($filename)

The one method every FileValidator module must implement. Receives the full disk path to the file and must return one of the following:

protected function isValidFile($filename) {
    $html = file_get_contents($filename);
    if($html === false) {
        $this->error('Unable to read HTML file');
        return false;
    }
    if(strpos($html, '<script') !== false) {
        $this->error('HTML file contains script tags');
        return false;
    }
    return true;
}

isValid($filename)

final public function isValid($filename)

Public entry point that ProcessWire calls. You should not override this method. It invokes isValidFile(), logs the result, and returns the same boolean or integer value. Errors recorded with $this->error() inside isValidFile() remain available through $validator->errors().

getPage()

public function getPage()

Returns the Page associated with the current validation, or null if none. If no page was set directly but a Pagefile context was set, this returns the page from that Pagefile.

getField()

public function getField()

Returns the Field associated with the current validation, or null if none. If no field was set directly but a Pagefile context was set, this returns the field from that Pagefile.

getPagefile()

public function getPagefile()

Returns the Pagefile or Pageimage associated with the current validation, or null if none. See Pagefile and Pageimage.

setPage(Page $page)

public function setPage(Page $page)

Sets the Page context for the next isValid() call.

setField(Field $field)

public function setField(Field $field)

Sets the Field context for the next isValid() call.

setPagefile(Pagefile $pagefile)

public function setPagefile(Pagefile $pagefile)

Sets the Pagefile (or Pageimage) context for the next isValid() call.

log($str = '', array $options = [])

public function ___log($str = '', array $options = array())

Logs a message to the file-validator log. This is the hookable log method used by isValid() to record validation outcomes. You can also call it from your own isValidFile() implementation if you want custom log entries.

$this->log("Validated $filename");

1. Create a class named FileValidatorSomething that extends FileValidatorModule.
2. Place it in /site/modules/FileValidatorSomething.module or its own directory.
3. Implement getModuleInfo() with a validates array.
4. Implement isValidFile($filename).

<?php namespace ProcessWire;

class FileValidatorHtml extends FileValidatorModule {

    public static function getModuleInfo() {
        return [
            'title' => 'HTML File Validator',
            'version' => 1,
            'summary' => 'Validates uploaded HTML files',
            'validates' => ['html', 'htm'],
        ];
    }

    protected function isValidFile($filename) {
        $html = file_get_contents($filename);
        if($html === false) {
            $this->error('Unable to read file');
            return false;
        }
        if(stripos($html, '<script') !== false) {
            $this->error('HTML contains script tags');
            return false;
        }
        return true;
    }
}

Install the module via Modules > Refresh, then upload a matching file to trigger validation automatically.

FileValidatorModule inherits all hooks from WireData and Wire. The only hookable method defined in this class is log.

$wire->addHookBefore('FileValidatorModule::log', function(HookEvent $event) {
    $str = $event->arguments(0);
    // modify or suppress log message
    if(strpos($str, 'VALID') === false) $event->cancel();
});

• FileValidatorModule extends WireData and implements the Module interface.
• ProcessWire discovers FileValidator modules by the FileValidator class prefix and the validates module info key.
• The high-level API for file validation is $sanitizer->validateFile($filename, $options); see Sanitizer for details.
• Built-in validators: FileValidatorImage, FileValidatorZip.
• Source file: wire/core/Module/FileValidatorModule/FileValidatorModule.php

Submitted by: Kimi K2.7 Code