Skip to content
brianhaveri edited this page Sep 14, 2010 · 5 revisions

List of pattern methods and parameters

Method Description Parameter Returns
pattern Get a single pattern integer $patternID OR array $query array
patterns Get multiple patterns array $query array
patterns_top Get top patterns array $query array
patterns_new Get new patterns array $query array
patterns_random Get random patterns [none] array

For pattern methods, the parameter $query array can include the following keys:

  • format
  • jsonCallback
  • lover – Not available for color()
  • hueOption – Not available for color()
  • hex – Not available for color()
  • keywords – Not available for color()
  • keywordExact – Not available for color()
  • orderCol – Not available for color()
  • sortBy – Not available for color()
  • numResults – Not available for color()
  • resultOffset – Not available for color()

More information on $query keys and return values at the ColourLOVERS.com API page

Sample code: single pattern

require_once('ColourLovers.php');
$c = new ColourLovers;
$result = $c->pattern(465753);
print_r($result);
/*
Array
(
    [@attributes] => Array
        (
            [numResults] => 1
            [totalResults] => 1
        )
    [pattern] => Array
        (
            [id] => 465753
            [title] => Navaho
            [userName] => miice
            [numViews] => 22089
            [numVotes] => 17
            [numComments] => 67
            [numHearts] => 5
            [rank] => 4
            [dateCreated] => 2009-05-03 08:56:47
            [colors] => Array
                (
                    [hex] => Array
                        (
                            [0] => ECD078
                            [1] => D95B43
                            [2] => C02942
                            [3] => 542437
                            [4] => 53777A
                        )
                )
            [description] => 
            [url] => http://www.colourlovers.com/pattern/465753/Navaho
            [imageUrl] => http://colourlovers.com.s3.amazonaws.com/images/patterns/465/465753.png
            [badgeUrl] => http://www.colourlovers.com/images/badges/n/465/465753_Navaho.png
            [apiUrl] => http://www.colourlovers.com/api/pattern/465753
        )
)
*/

Sample code: multiple patterns

require_once('ColourLovers.php');
$c = new ColourLovers;
$results = $c->patterns(array(
	'hueRange'	=> '12,68',
	'numResults'=> 2
));
Clone this wiki locally