pdfSorter Class Reference

Sorts thru PDF documents and puts them into corresponding folders etc. More...

Inheritance diagram for pdfSorter:

Public Member Functions
	__construct ($pdf, $db)
	constructor More...
	splitUpFilename ()
	function gets from file name the information what the date, company and subject is. More...
	checkRules ()
	checks rules More...
	run ()
	runs the main process More...
Public Member Functions inherited from ppyrd
	__construct ($db)
	constructor More...
	checkCliVsWebserver ()
	output ($string, $debug=0)
	outputs string More...

Additional Inherited Members
Public Attributes inherited from ppyrd
	$db

Detailed Description

Sorts thru PDF documents and puts them into corresponding folders etc.

Parameters

none

Returns

none

Definition at line 11 of file ppyrd.sorter.php.

Constructor & Destructor Documentation

pdfSorter::__construct	(		$pdf,
			$db
	)

constructor

Parameters

string	$pdf	file name to be processed
string	$db	database handler

Returns

none

Definition at line 19 of file ppyrd.sorter.php.

    {
        $this->pdf = $pdf;

        // creating db handler to talk to DB
        $this->db=$db;
    }

Member Function Documentation

pdfSorter::checkRules

(

)

checks rules

Definition at line 90 of file ppyrd.sorter.php.

    {
      $rules = $this->db->getActiveArchiveRules();
      while ($row = $rules->fetchArray()) {
        // we have  a rule match if the company found matches the specified string
        // * is the wild card like in file names
        $match = fnmatch($row['company'], $this->company)
                && fnmatch($row['subject'], $this->subject)
                && fnmatch($row['recipient'], $this->recipient)
                && fnmatch($row['tags'], $this->tags);

        // if everything matched - go ahead
        if ($match) {
            // processing the folder to which document shall be moved
            $toFolder = $row['toFolder'];

            // in case the [year] variable has been used etc.
            $toFolder = str_replace('[year]', $this->year, $toFolder);
            $toFolder = str_replace('[month]', $this->month, $toFolder);
            $toFolder = str_replace('[day]', $this->day, $toFolder);
            $toFolder = str_replace('[recipient]', $this->recipient, $toFolder);

            // adding a trailing slash in case none existed
            $toFolder = rtrim($toFolder, '/') . '/';

            // create folders in case required
            exec("mkdir -p '$toFolder'");

            // move the file to destination folder
            exec('mv --backup=numbered "' . $this->pdf . '" "' . $toFolder . $this->pdf . '"');

            $this->db->writeLog($this->pdf, $this->pdf, "", "Moved file to: " . $toFolder);
        }
      }
    }

pdfSorter::run

(

)

runs the main process

Definition at line 129 of file ppyrd.sorter.php.

    {

      // process the file name first
      $this->splitUpFilename();

      // then see if there is any rule to process
      $this->checkRules();
    }

pdfSorter::splitUpFilename

(

)

function gets from file name the information what the date, company and subject is.

Definition at line 30 of file ppyrd.sorter.php.

    {
      $this->output("working on: " . $this->pdf);

      // getting the file name template - needed to see what part (date, company, subject) is at which part of the string
      $newFilenameStructure=$this->db->getConfigValue('newFilenameStructure');

      // getting things via regex
      // removing closing parts of the brackets as they are not needed in this case
      $unwanted = array(')',']');
      $separators = "/ - | \(| \[| \-\- /";
      $templateName = str_replace($unwanted, '', $newFilenameStructure);

      // splitting up template name into parts
      $templateParts = array_flip(preg_split($separators, $templateName));

      // now doing the same stuff with the actual file
      $tmpName = str_replace($unwanted, '', $this->pdf);
      $filenameParts = preg_split($separators, $tmpName);



      // separating the file name into its parts
      $parts = explode(" - ", $this->pdf);

      // date is 1st
      $this->date = $filenameParts[$templateParts['ddatum']];
      $this->year = date('Y',strtotime($this->date));
      $this->month = date('m',strtotime($this->date));
      $this->day = date('d',strtotime($this->date));

      // company etc.
      $this->company = $filenameParts[$templateParts['ffirma']];
      $this->recipient = $filenameParts[$templateParts['wwer']];
      $this->subject = $filenameParts[$templateParts['bbetreff']];
      $this->amount = $filenameParts[$templateParts['bbetrag']];



      // getting all tags @todo - needs to be least greedy ...
      preg_match_all('/\[(\d|\w)*\]/',$this->pdf,$tags);
      $this->tags = implode($tags[0]);

      //
      $this->output( "date: " . $this->date);
      $this->output( "year: " . $this->year);
      $this->output( "month: " . $this->month);
      $this->output( "day: " . $this->day);

      $this->output( "company: " . $this->company);
      $this->output( "recipient: " . $this->recipient);
      $this->output( "subject: " . $this->subject);
      $this->output( "amount: " . $this->amount);
      $this->output( "tags: " . $this->tags);

    }

---

The documentation for this class was generated from the following file:

• paperyard/paperyard/backend/ppyrd.sorter.php