Installation

I recommend that you install CSVelte using Composer, PHP’s de facto package manager. If you aren’t using Composer, I highly recommend that you check it out. It makes dependency management ridiculously easy and it’s used by virtually every modern PHP library and framework in use today. There are other ways to install the library (which I will outline below), but Composer is by far the cleanest and easiest. Not to mention, the most well-tested.

Requirements

As of v0.2, CSVelte requires PHP5.6+. It is my intention to maintain PHP5.6+ support at least until its end-of-life (until it no longer receives updates and security fixes).

Note

CSVelte does not currently require any PHP extensions, but internationalization and localization, as well as character transcoding are features that are on the Project Roadmap. These features (and probably others as well) will most likely require one or more of the mbstring, iconv, intl and possibly other extension(s) to be installed. So I can’t promise the library won’t require certain PHP extensions in the future.

Installation

With Composer

If you’ve never used Composer, you’ll want to head over to getcomposer.org and follow the installation instructions on their download page first. Once Composer has been successfully installed, you may use the following command to install CSVelte within your Composer package/project. First cd into your project directory and then issue this command.

$ composer require nozavroni/csvelte dev-master

Important

CSVelte is currently under heavy development. Once it reaches a stable version, it will be simply a matter of composer require nozavroni/csvelte, but for the time being you will need the dev-master flag or Composer will complain and refuse to install (or you can lower your minimum-stability setting, which will have the same effect for all your project’s dependencies).

Direct Download

Danger

Unless you know what you’re doing and/or you have a good reason not to, it’s highly recommended that you install CSVelte using Composer. It isn’t particularly difficult to install without Composer, it just allows me to ensure everybody has a consistent installation experience and as a result, you will find it much easier to get help (at least from me) if you install using Composer.

To install CSVelte manually, first download the latest version of CSVelte (currently v0.2) from GitHub. After extracting the contents of the zip or tarball, simply include the src/autoload.php file, which will add the src directory to PHP’s include path [1] and register CSVelte’s autoload function [2] for you (obviously you’ll need to change /path/to/csvelte to wherever the src directory is on your system).

<?php
require_once "/path/to/csvelte/src/autoload.php";

Note

It should be as simple as that, but I can’t promise it will be. Your mileage may vary. If you’re unable to get CSVelte installed, try sending a message to the official mailing list. And if that fails, you can try e-mailing me directly at csvelte@phpcsv.com and I will do my best to get back to you as soon as possible (just keep in mind I’m a busy guy and this is free software).

Footnotes

[1]See include_path ini setting on php.net
[2]See spl_autoload_register function on php.net