Code Coverage
	Classes and Traits			Functions and Methods				Lines
Total							CRAP

1	<?php
2
3	/**
4	* This file is part of the Statistical Classifier package.
5	*
6	* (c) Cam Spiers <camspiers@gmail.com>
7	*
8	* For the full copyright and license information, please view the LICENSE
9	* file that was distributed with this source code.
10	*/
11
12	namespace Camspiers\StatisticalClassifier\Classifier;
13
14	/**
15	* Provides an interface for classifier.
16	* Implementing classes are classifiers capable of classifying documents into categories
17	*
18	* @author Cam Spiers <camspiers@gmail.com>
19	* @package Statistical Classifier
20	*/
21	interface ClassifierInterface
22	{
23	/**
24	* Returns whether or not the document is of the category
25	* @param string $category The category in question
26	* @param string $document The document to check
27	* @return boolean Whether or not the document is in the category
28	*/
29	public function is($category, $document);
30	/**
31	* Classify the document and return its category
32	* @param string $document The document to classify
33	* @return string|bool The category of the document
34	*/
35	public function classify($document);
36	}