#PHP-SASS: A wrapper for libsass of PHP

##Install

See INSTALL

##Play with it

After the install. You can just interact with the compiler using these php functions:

sass_version() // This will return the current libsass's version
sass_compile(string $type, string $data, array $options, string $error) //

##Sass Compile

You can compile the sass file or sass string using the sass_compile function, the args are:

1. string $type: The type of the sass compiling, support data or file
2. string $data: File name when in file type, will search every include path to find the file, sass string when the data type
3. array $options: The sass compiler's options, will describe more detail in next section
4. string $error: The error string, if got any compiling error, you can check for this variable

So, a typical usage is like this:

$options = array(
	"include_path": getcwd()
);

$error = "";

$result = sass_compile("data", "foo { font-size: 2*2px; }", $options, $error);

if($result)
	echo $result;
else
	echo $error;

or

$result = sass_compile("file", "foo.scss", $options, $error);

##Sass Options

Here is the options you can have for sass compiler:

• precision
• output_style: Support 0 ~ 4, 0 is default
  • SASS_FORMAT_NESTED - 0
  • SASS_FORMAT_EXPANDED - 1
  • SASS_FORMAT_COMPACT - 2
  • SASS_FORMAT_COMPRESSED - 3
  • SASS_FORMAT_FORMATTED - 4
• source_comments
• source_map_embeded
• source_map_contents
• omit_source_map_url
• is_indented_syntax_src
• indent
• linefeed
• input_path
• output_path
• image_path
• include_path
• source_map_file

##Features

1. Fully wrap for libsass
2. Fully support the options of libsass
3. Provide the php function to libsass, so you can call any php function as libsass's function, like this php(time) or php(count_down, 1, 2, 3)
4. Fully support all kinds of type in the sass and can translate them to php and back
5. Extended C functions for Sass Compiler

Extended Sass Builtin Functions

Sure, you can got all of these by using php method ;), but since these function will be called a lot, maybe buildin functions will be more faster.

String Functions:

str-get($str, $index) // Get the char in the index of the string

Math Functions:

pow($i, $n) // The same pow function as math.h

List Functions:

remove-nth($l, $i) // Remove the nth element in the list
list-end($i) // Get the end element of the listlist-splice($list, $offset:0, $count:0, $list_append:null)
list-splice($list, $offset:0, $count:0, $list_append:null) // The same splice function of php
list-set($list, $offset, $value) // Set the element of the list

Misc Functions:

gettype($i) // Get the element's sass type as string, same as php's gettype
strip-unit($n) // Remove the anoying unit in sass number, especially useful in multiplication, ;)

##Type Conversion Rules

There is a catch here, for PHP, an array can be a list and a hash, and both.

But in Sass, there is no thing like array.

So, when convert back from sass, anything will be fine, but when converting php to sass, there is a slightly problem, how to convert mutant arrays?

So, php-sass use a simple solution here, only object maps to map, and array only maps to list. If you want to return an array as a map, just cast it to object, it's simple.

###Sass -> PHP

Sass	PHP
number	double
string	string
color	hex color
boolean	boolean
null	null
list	array
map	array

###PHP -> Sass

PHP	Sass
double	number
long	number
string	string
boolean	boolean
null	null
array	list(space sep)
object	map

About The PHP Function in Sass

The php function in sass can direcly call php's function(in global context).

Here is some example:

1. Without parameters

   php(time)

This equals to:

time();

2. With simple parameters

   php(hello world)

This equals to:

hello("world");

3. With multiple parameters

   php(sprintf, "%s %s", hello, world)

This equals to:

sprintf("%s %s", "hello", "world");

4. Using map or list:

   php(var_dump, (hello: world))

This equals to:

var_dump(array("hello" => "world"));