License and code cleanup

Author: Ekman

.gitignore

@@ -1,2 +1,52 @@
-nbproject/
 index.php
+
+# Created by http://www.gitignore.io
+
+### Windows ###
+# Windows image file caches
+Thumbs.db
+ehthumbs.db
+
+# Folder config file
+Desktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msm
+*.msp
+
+
+### OSX ###
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must ends with two \r.
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear on external disk
+.Spotlight-V100
+.Trashes
+
+
+### Linux ###
+*~
+
+
+### NetBeans ###
+nbproject/private/
+build/
+nbbuild/
+dist/
+nbdist/
+nbactions.xml
+nb-configuration.xml
+nbproject/

LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Niklas Ekman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

LuhnAlgorithm.php

@@ -1,29 +1,34 @@
 <?php
 
 /*
-  Copyright 2013 Niklas Ekman, nikl.ekman@gmail.com
-
-  Licensed under the Apache License, Version 2.0 (the "License");
-  you may not use this file except in compliance with the License.
-  You may obtain a copy of the License at
-
-  http://www.apache.org/licenses/LICENSE-2.0
-
-  Unless required by applicable law or agreed to in writing, software
-  distributed under the License is distributed on an "AS IS" BASIS,
-  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-  See the License for the specific language governing permissions and
-  limitations under the License.
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2014 Niklas Ekman
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 
 /**
  * Apply the Luhn Algorithm to a number.
  *  
- * @link http://en.wikipedia.org/wiki/Luhn_algorithm Go to Wikipedia for more
- * info on the Luhn Alorithm
- * 
+ * @link http://en.wikipedia.org/wiki/Luhn_algorithm 
  * @author Niklas Ekman <nikl.ekman@gmail.com>
- * @version 2014-02-04
+ * @version 2014-02-07
  */
 class LuhnAlgorithm {
 
@@ -32,11 +37,10 @@ class LuhnAlgorithm {
 	private $checkDigit;
 
 	/**
-	 * The number must be in the format <b>XXXXXX-XXX(D)</b> or
-	 * <b>XXXXXX - XXX(x)</b> or any permutations of those two. If the 
-	 * checkdigit (D) is not supplied, it will be calculated
-	 * @param string|int $number The personnumer or organizational number
-	 * @throws InvalidArgumentException
+	 * Set number that the instance should handle.
+	 * @param sting|int $number Number in string or int format
+	 * @param bool $withCheckDigit [Defaults to true] <br> Is the check digit
+	 * included in $number?
 	 */
 	function __construct($number, $withCheckDigit = true) {
 		$this->setNumber($number, $withCheckDigit);
@@ -55,18 +59,15 @@ public function isValid() {
 
 	/**
 	 * Calculate the checksum from a number
-	 * @param string $number
+	 * @param string $number Number to calculate checksum of
+	 * @param int $length [Defaults to 0] <br> Length of $number. Function
+	 * will calculate it if not supplied
 	 * @return int Checksum
 	 */
-	public static function calculateChecksum($number, $length = null) {
-		// Validate the number
-		if (preg_match(self::numberRegex(), $number) !== 1) {
-			throw new \InvalidArgumentException("{$number} is an invalid format");
-		}
-
+	public static function calculateChecksum($number, $length = 0) {
 		$number = strval(self::stringToInteger($number));
 
-		if ($length === null) {
+		if ($length === 0) {
 			$length = strlen($number);
 		}
 
@@ -145,15 +146,6 @@ public function getCheckDigit() {
 		return $this->checkDigit;
 	}
 
-	/**
-	 * What regex to use when validating numbers? Override this to provide
-	 * something else
-	 * @return string
-	 */
-	protected static function numberRegex() {
-		return "/\d{6}\s?-?\s?\d{3}\d?/";
-	}
-
 	/**
 	 * Fix a string so that it only contains numbers
 	 * @param string $integer String to convert to integer
@@ -164,18 +156,12 @@ public static function stringToInteger($integer) {
 	}
 
 	/**
-	 * The number must be in the format <b>XXXXXX-XXX(D)</b> or
-	 * <b>XXXXXX - XXX(x)</b> or any permutations of those two. If the 
-	 * checkdigit (D) is not supplied, it will be calculated
-	 * @param string|int $number The personnumer or organizational number
-	 * @throws InvalidArgumentException
+	 * Set number that the instance should handle.
+	 * @param sting|int $number Number in string or int format
+	 * @param bool $withCheckDigit [Defaults to true] <br> Is the check digit
+	 * included in $number?
 	 */
 	public function setNumber($number, $withCheckDigit = true) {
-		// Validate the number
-		if (preg_match(self::numberRegex(), $number) !== 1) {
-			throw new \InvalidArgumentException("{$number} is an invalid format");
-		}
-
 		$number = strval(self::stringToInteger($number));
 		$length = strlen($number);
 

Personnummer.php

@@ -0,0 +1,80 @@
+<?php
+
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2014 Niklas Ekman
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+require_once(dirname(__FILE__) . "/LuhnAlgorithm.php");
+
+/**
+ * Extends LuhnAlgorithm and makes sure that the number supplied is a valid
+ * personnummer.
+ *  
+ * @author Niklas Ekman <nikl.ekman@gmail.com>
+ * @version 2014-02-07
+ */
+class Personnumer extends \LuhnAlgorithm {
+
+	/**
+	 * Validate an input and see if it can be a valid personnumer
+	 * @param type $input
+	 * @return type
+	 */
+	public static function isValid($input) {
+		return preg_match("/^\d{2}[0-1]\d[0-3]\d\s?-?\s?\d{4}$/", trim($input)) !== false;
+	}
+
+	/**
+	 * The number must be in the format <b>XXXXXX-XXX(D)</b> or
+	 * <b>XXXXXX - XXX(D)</b> or any permutations of those two. If the 
+	 * checkdigit (D) is not supplied, it will be calculated
+	 * 
+	 * @param string|int $number The personnumer or organizational number
+	 * @param bool $withCheckDigit [Defaults to true] <br> Is the check digit
+	 * included in $number?
+	 * @throws InvalidArgumentException
+	 */
+	public function setNumber($number, $withCheckDigit = true) {
+		if (!static::isValid($number)) {
+			throw new \InvalidArgumentException("{$number} is not a valid personnummer");
+		}
+
+		parent::setNumber($number, $withCheckDigit);
+	}
+
+	/**
+	 * Calculate the checksum from a number
+	 * @param string $number Number to calculate checksum of
+	 * @param int $length [Defaults to 0] <br> Length of $number. Function
+	 * will calculate it if not supplied
+	 * @return int Checksum
+	 * @throws InvalidArgumentException
+	 */
+	public static function calculateChecksum($number, $length = 0) {
+		if (!static::isValid($number)) {
+			throw new \InvalidArgumentException("{$number} is not a valid personnummer");
+		}
+
+		return \LuhnAlgorithm::calculateChecksum($number, $length);
+	}
+
+}

README.md

@@ -16,25 +16,7 @@ checksum of a number:
 	$number = '123456789';
 	$luhnCheckSum = LuhnAlgorithm::calculateChecksum($number);
 
-## Regex
-There will be a regex check agains the number provided as argument
-to this class. Override the function below to provide your own regex.
-
-	protected static function numberRegex() {
-		return "/\d{6}\s?-?\s?\d{3}\d?/";
-	}
-
-## License
-Copyright 2013 Niklas Ekman, nikl.ekman@gmail.com
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
+### Personnummer
+If you'd like to validate the input to the class, extend it and do a regex check.
+In the file **Personnummer.php**, I have extended the class to make sure that the
+input is a valid Swedish national security id.