class_SearchCriteria.php

Go to the documentation of this file.

<?php
class SearchCriteria extends BaseFrameworkSystem implements LocalSearchCriteria {
        private $searchCriteria = array();

        private $limit = 0;

        private $skip = 0;

        protected function __construct () {
                // Call parent constructor
                parent::__construct(__CLASS__);

                // Clean up a little
                $this->removeNumberFormaters();
                $this->removeSystemArray();
        }

        public final static function createSearchCriteria () {
                // Get a new instance
                $criteriaInstance = new SearchCriteria();

                // Return this instance
                return $criteriaInstance;
        }

        public final function addCriteria ($criteriaKey, $criteriaValue) {
                $this->searchCriteria[(string)$criteriaKey] = (string)$criteriaValue;
        }

        public final function addConfiguredCriteria ($criteriaKey, $configEntry) {
                // Add the configuration entry as a criteria
                $value = $this->getConfigInstance()->readConfig($configEntry);
                $this->addCriteria($criteriaKey, $value);
        }

        public final function setLimit ($limit) {
                $this->limit = $limit;
        }

        public final function getLimit () {
                return $this->limit;
        }

        public final function setSkip ($skip) {
                $this->skip = $skip;
        }

        public final function getSkip () {
                return $this->skip;
        }

        public function getCacheKey () {
                // Initialize the key
                $cacheKey = "";

                // Now walk through all criterias
                foreach ($this->searchCriteria as $criteriaKey => $criteriaValue) {
                        // Add the value URL encoded to avoid any trouble with special characters
                        $cacheKey .= sprintf("%s=%s;",
                                $criteriaKey,
                                urlencode($criteriaValue)
                        );
                }

                // Add limit and skip values
                $cacheKey .= sprintf("%%limit%%=%s;%%skip%%=%s",
                        $this->limit,
                        $this->skip
                );

                // Return the cache key
                return $cacheKey;
        }

        public function getCriteriaElemnent ($criteria) {
                // Default is not found
                $value = null;

                // Is the criteria there?
                if (isset($this->searchCriteria[$criteria])) {
                        // Then use it
                        $value = $this->searchCriteria[$criteria];
                }

                // Return the value
                return $value;
        }

        public function ifEntryMatches (array $entryArray) {
                // First nothing matches and nothing is counted
                $matches = false;
                $counted = 0;

                // Walk through all entries
                foreach ($entryArray as $key => $entry) {
                        // Then walk through all search criteria
                        foreach ($this->searchCriteria as $criteriaKey => $criteriaValue) {
                                // Is the element found and does it match?
                                if (($key == $criteriaKey) && ($criteriaValue == $entry)) {
                                        // Then count this one up
                                        $counted++;
                                } // END - if
                        } // END - foreach
                } // END - foreach

                // Now check if expected criteria counts match
                $matches = ($counted == count($this->searchCriteria));

                // Return the result
                return $matches;
        }
}

// [EOF]
?>