README

Introduction

This package provides implementation of basic PHP datatypes.

Installation

If you want to use the library with your application you can install it by adding

{
    "require": {
        "techdivision/lang": "dev-master"
    },
}

to your composer.json and invoke composer update in your project.

Usage

This package provides classes representing an object oriented implementation for some basic datatypes.

As there has been (and still are) many discussions about PHP and type safety i decided to implement a small, really basic library that will offer the most basic datatype needed in nearly every project. To be honest, i really like almost allof those nice possibilities languages like Java provides, but as PHP is not Java, you always have to find a neat way for implementing similar things in a way it makes sense in a PHP environment.

The intention for implementing that classes was the possiblity to make your critical functions and methods type safe, by using them for type hints on the one hand and the possiblity to have an quick and easy to use kind of data validation mechanism on the other.

As you may know, using type hints will probably slow down your code a bit, so take care when you use them and always have an eye on possible performance impacts by running performance tests regularily.

The data type implementations this library will provide, are

Object
Boolean
Integer
Float
String

The following examples wil give you a short introduction about the functionality each class will provide and how you can use it in your code. Please be aware, that the examples are not intended to make any sense, they should only give you an idea what is possible.

Object

The abstract class Object implements a low level presentation of a class. All other classes of this library use it as superclass.

Boolean

Using a Boolean instance to compare against anonther one or try to instanciate it with a not boolean value.

// initialize a new Integer instance
$bool = new Boolean(true);
$bool->equals(new Boolean(false)); // false

// throws a ClassCastException
$invalid = new Boolean('aValue');

Integer

Here are some examples how you can use the Integer class

// initialize a new Integer instance
$int = new Integer(17);
	    
// get the float value of the Integer
echo $int->floatValue() . PHP_EOL; // 17.0
echo $int->stringValue() . PHP_EOL; // '17'

// check that the two Integer instances are equal
$int->equals(Integer::valueOf(new String('17'))); // true

Float

The example for using a Float shows you how to add to instances and print the float value

// initialize a new Float instance
$float = new Float(10.005);
$float->add(new Float(10.105));
        
// check the value
echo $float->floatValue() . PHP_EOL; // 20.11

String

To show you how you can use the String class we'll simple concatenate to instances

// initialize a new String instance
$string = new String('value to');
		
// check that String was successfully concatenated
echo $string->concat(new String(' search')) . PHP_EOL; // 'value to search'

Yeah, this are really simple examples, and as i told you before in most cases i'll use that classes for simple things like type hints and so on.

If you like to use that stuff also, feel free to implement your own types and send me a pull request :)

External Links

Documentation at appserver.io
Documentation on GitHub
Getting started

techdivision / lang

Maintainers

Details