Class QPList

(line 17)

Description


Located in File: /src/QueryPath/Extension/QPList.php

Provide list operations for QueryPath.

The QPList class is an extension to QueryPath. It provides HTML list generators that take lists and convert them into bulleted lists inside of QueryPath.



Class Variables

Summary:
mixed $qp

$qp = NULL (line 22)

Data type : mixed

  • access: - protected

Class Constants

Summary:
DL
OL
UL

DL = 'dl' (line 20)

OL = 'ol' (line 19)

UL = 'ul' (line 18)

Method Detail

Summary:
void appendList (mixed $items, [string $type = self::UL], [array $options = array()])
void appendTable ( $items, [ $options = array()])
void isAssoc ( $array)
void listImpl ( $items,  $type,  $opts, [ $q = NULL])
QPList __construct (QueryPath $qp)

Method appendList (line 87)

void appendList( mixed $items, [string $type = self::UL], [array $options = array()])

Append a list of items into an HTML DOM using one of the HTML list structures.

This takes a one-dimensional array and converts it into an HTML UL or OL list, or it can take an associative array and convert that into a DL list.

In addition to arrays, this works with any Traversable or Iterator object.

OL/UL arrays can be nested.

Parameters

  • mixed $items: An indexed array for UL and OL, or an associative array for DL. Iterator and Traversable objects can also be used.
  • string $type: One of ul, ol, or dl. Predefined constants are available for use.
  • array $options: An associative array of configuration options. The supported options are:
    • 'list class': The class that will be assigned to a list.

Info

  • access - public

Method appendTable (line 27)

void appendTable( $items, [ $options = array()])

Parameters

  • $items:
  • $options:

Info

  • access - public

Method isAssoc (line 133)

void isAssoc( $array)

Unused.

Parameters

  • $array:

Info

  • access - protected

Method listImpl (line 109)

void listImpl( $items, $type, $opts, [ $q = NULL])

Internal recursive list generator for appendList.

Parameters

  • $items:
  • $type:
  • $opts:
  • $q:

Info

  • access - protected

Constructor __construct (line 23)

QPList __construct( QueryPath $qp)


Implementation of:
QueryPathExtension::__construct()

Parameters

Info

  • access - public

Inherited Variables

Inherited Class Variable Summary

Inherited Methods

Inherited Method Summary


Documentation generated on Sun, 25 Jul 2010 16:09:06 -0500 by phpDocumentor 1.4.3