PHPLinq
[ class tree: PHPLinq ] [ index: PHPLinq ] [ all elements ]
Packages:
PHPLinq
PHPLinq_Adapter


Files:
Exception.php
Expression.php
Function.php
ILinqProvider.php
Initiator.php
LinqToObjects.php
LinqToZendDb.php
OrderByExpression.php
PHPLinq.php

Interfaces:
PHPLinq_ILinqProvider
Classes:
PHPLinq_Exception
PHPLinq_Expression
PHPLinq_Function
PHPLinq_Initiator
PHPLinq_LinqToObjects
PHPLinq_LinqToZendDb
PHPLinq_OrderByExpression

Class: PHPLinq_ILinqProvider

Source Location: /PHPLinq/ILinqProvider.php

Interface Overview




PHPLinq_ILinqProvider




Author(s):


    
        





      
  


Copyright:


    
  
  • Copyright (c) 2008 - 2009 PHPLinq (http://www.codeplex.com/PHPLinq)
    • 


        






Methods
























Class Details



[line 36]

PHPLinq_ILinqProvider

PHPLinq_ILinqProvider





Tags:





  

    copyright:  Copyright (c) 2008 - 2009 PHPLinq (http://www.codeplex.com/PHPLinq)
  










[ Top ]








Class Methods



  

	
	
static method handles [line 43]

	

    

    

		static bool handles(
mixed
$source)
    

    


	
		Can this provider type handle data in $source?

Can this provider type handle data in $source?





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        mixed  
        $source  
        
      

        

    


        
[ Top ]

  


  

	
	
constructor __construct [line 52]

	

    

    

		PHPLinq_ILinqProvider __construct(
string
$name, [PHPLinq_ILinqProvider
$parentProvider = null])
    

    


	
		Create a new class instance

Create a new class instance





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $name  
        
      

          

        PHPLinq_ILinqProvider  
        $parentProvider  
        Optional parent PHPLinq_ILinqProvider instance, used with join conditions
      

        

    


        
[ Top ]

  

  

	
	
destructor __destruct [line 57]

	

    

    

		void __destruct(
)
    

    


	
		Class destructor

Class destructor





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method addChildProvider [line 78]

	

    

    

		void addChildProvider(
PHPLinq_ILinqProvider
$provider)
    

    


	
		Add child provider, used with joins

Add child provider, used with joins





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        PHPLinq_ILinqProvider  
        $provider  
        
      

        

    


        
[ Top ]

  

  

	
	
method aggregate [line 386]

	

    

    

		mixed aggregate(
[int
$seed = 0], string
$expression)
    

    


	
		Aggregate

Aggregate





Tags:





  

    return:  aggregate
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        int  
        $seed  
        Seed
      

          

        string  
        $expression  
        Expression defining the aggregate
      

        

    


        
[ Top ]

  

  

	
	
method all [line 334]

	

    

    

		boolean all(
string
$expression)
    

    


	
		All

All





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $expression  
        Expression checking if an all elements are contained
      

        

    


        
[ Top ]

  

  

	
	
method any [line 326]

	

    

    

		boolean any(
string
$expression)
    

    


	
		Any

Any





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $expression  
        Expression checking if an element is contained
      

        

    


        
[ Top ]

  

  

	
	
method average [line 377]

	

    

    

		mixed average(
)
    

    


	
		Average of elements

Average of elements





Tags:





  

    return:  Average of elements
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method concat [line 187]

	

    

    

		PHPLinq_ILinqProvider concat(
mixed
$source)
    

    


	
		Concatenate data

Concatenate data





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        mixed  
        $source  
        
      

        

    


        
[ Top ]

  

  

	
	
method contains [line 342]

	

    

    

		boolean contains(
mixed
$element)
    

    


	
		Contains

Contains





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        mixed  
        $element  
        Is the $element contained?
      

        

    


        
[ Top ]

  

  

	
	
method count [line 349]

	

    

    

		int count(
)
    

    


	
		Count elements

Count elements





Tags:





  

    return:  Element count
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method distinct [line 243]

	

    

    

		PHPLinq_ILinqProvider distinct(
string
$expression)
    

    


	
		Distinct

Distinct





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $expression  
        Expression to retrieve the key value.
      

        

    


        
[ Top ]

  

  

	
	
method elementAt [line 309]

	

    

    

		mixed elementAt(
[mixed
$index = null])
    

    


	
		Element at index

Element at index





Tags:





  

    return:  Element at $index
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        mixed  
        $index  
        Index
      

        

    


        
[ Top ]

  

  

	
	
method elementAtOrDefault [line 318]

	

    

    

		mixed elementAtOrDefault(
[mixed
$index = null], [mixed
$defaultValue = null])
    

    


	
		Element at index or default

Element at index or default





Tags:





  

    return:  Element at $index
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        mixed  
        $index  
        Index
      

          

        mixed  
        $defaultValue  
        Default value to return if nothing is found
      

        

    


        
[ Top ]

  

  

	
	
method first [line 258]

	

    

    

		mixed first(
[string
$expression = null])
    

    


	
		First

First





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $expression  
        Expression which creates a resulting element
      

        

    


        
[ Top ]

  

  

	
	
method firstOrDefault [line 267]

	

    

    

		mixed firstOrDefault(
[string
$expression = null], [mixed
$defaultValue = null])
    

    


	
		FirstOrDefault

FirstOrDefault





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $expression  
        Expression which creates a resulting element
      

          

        mixed  
        $defaultValue  
        Default value to return if nothing is found
      

        

    


        
[ Top ]

  

  

	
	
method getFromName [line 85]

	

    

    

		string getFromName(
)
    

    


	
		Retrieve "from" name

Retrieve "from" name





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getJoinCondition [line 71]

	

    

    

		PHPLinq_Expression getJoinCondition(
)
    

    


	
		Get join condition

Get join condition





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getSource [line 92]

	

    

    

		mixed getSource(
)
    

    


	
		Retrieve data in data source

Retrieve data in data source





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method in [line 100]

	

    

    

		PHPLinq_ILinqProvider in(
mixed
$source)
    

    


	
		Set source of data

Set source of data





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        mixed  
        $source  
        
      

        

    


        
[ Top ]

  

  

	
	
method join [line 128]

	

    

    

		PHPLinq_Initiator join(
string
$name)
    

    


	
		Join

Join





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $name  
        
      

        

    


        
[ Top ]

  

  

	
	
method last [line 275]

	

    

    

		mixed last(
[string
$expression = null])
    

    


	
		Last

Last





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $expression  
        Expression which creates a resulting element
      

        

    


        
[ Top ]

  

  

	
	
method lastOrDefault [line 284]

	

    

    

		mixed lastOrDefault(
[string
$expression = null], [mixed
$defaultValue = null])
    

    


	
		LastOrDefault

LastOrDefault





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $expression  
        Expression which creates a resulting element
      

          

        mixed  
        $defaultValue  
        Default value to return if nothing is found
      

        

    


        
[ Top ]

  

  

	
	
method max [line 370]

	

    

    

		mixed max(
)
    

    


	
		Maximum of elements

Maximum of elements





Tags:





  

    return:  Maximum of elements
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method min [line 363]

	

    

    

		mixed min(
)
    

    


	
		Minimum of elements

Minimum of elements





Tags:





  

    return:  Minimum of elements
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method ofType [line 179]

	

    

    

		void ofType(
string
$type)
    

    


	
		Select the elements of a certain type

Select the elements of a certain type





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $type  
        Type name
      

        

    


        
[ Top ]

  

  

	
	
method on [line 136]

	

    

    

		PHPLinq_ILinqProvider on(
string
$expression)
    

    


	
		On

On





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $expression  
        Expression representing join condition
      

        

    


        
[ Top ]

  

  

	
	
method orderBy [line 196]

	

    

    

		PHPLinq_ILinqProvider orderBy(
string
$expression, [string
$comparer = null])
    

    


	
		OrderBy

OrderBy





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $expression  
        Expression to order elements by
      

          

        string  
        $comparer  
        Comparer function (taking 2 arguments, returning -1, 0, 1)
      

        

    


        
[ Top ]

  

  

	
	
method orderByDescending [line 205]

	

    

    

		PHPLinq_ILinqProvider orderByDescending(
string
$expression, [string
$comparer = null])
    

    


	
		OrderByDescending

OrderByDescending





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $expression  
        Expression to order elements by
      

          

        string  
        $comparer  
        Comparer function (taking 2 arguments, returning -1, 0, 1)
      

        

    


        
[ Top ]

  

  

	
	
method reverse [line 231]

	

    

    

		PHPLinq_ILinqProvider reverse(
[bool
$preserveKeys = null])
    

    


	
		Reverse elements

Reverse elements





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        bool  
        $preserveKeys  
        Preserve keys?
      

        

    


        
[ Top ]

  

  

	
	
method select [line 108]

	

    

    

		mixed select(
[string
$expression = null])
    

    


	
		Select

Select





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $expression  
        Expression which creates a resulting element
      

        

    


        
[ Top ]

  

  

	
	
method single [line 292]

	

    

    

		mixed single(
[string
$expression = null])
    

    


	
		Single

Single





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $expression  
        Expression which creates a resulting element
      

        

    


        
[ Top ]

  

  

	
	
method singleOrDefault [line 301]

	

    

    

		mixed singleOrDefault(
[string
$expression = null], [mixed
$defaultValue = null])
    

    


	
		SingleOrDefault

SingleOrDefault





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $expression  
        Expression which creates a resulting element
      

          

        mixed  
        $defaultValue  
        Default value to return if nothing is found
      

        

    


        
[ Top ]

  

  

	
	
method skip [line 164]

	

    

    

		PHPLinq_ILinqProvider skip(
int
$n)
    

    


	
		Skip $n elements

Skip $n elements





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        int  
        $n  
        
      

        

    


        
[ Top ]

  

  

	
	
method skipWhile [line 172]

	

    

    

		PHPLinq_ILinqProvider skipWhile(
string
$expression)
    

    


	
		Skip elements while $expression evaluates to true

Skip elements while $expression evaluates to true





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $expression  
        Expression to evaluate
      

        

    


        
[ Top ]

  

  

	
	
method sum [line 356]

	

    

    

		mixed sum(
)
    

    


	
		Sum elements

Sum elements





Tags:





  

    return:  Sum of elements
  

  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method take [line 148]

	

    

    

		PHPLinq_ILinqProvider take(
int
$n)
    

    


	
		Take $n elements

Take $n elements





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        int  
        $n  
        
      

        

    


        
[ Top ]

  

  

	
	
method takeWhile [line 156]

	

    

    

		PHPLinq_ILinqProvider takeWhile(
string
$expression)
    

    


	
		Take elements while $expression evaluates to true

Take elements while $expression evaluates to true





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $expression  
        Expression to evaluate
      

        

    


        
[ Top ]

  

  

	
	
method thenBy [line 214]

	

    

    

		PHPLinq_ILinqProvider thenBy(
string
$expression, [string
$comparer = null])
    

    


	
		ThenBy

ThenBy





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $expression  
        Expression to order elements by
      

          

        string  
        $comparer  
        Comparer function (taking 2 arguments, returning -1, 0, 1)
      

        

    


        
[ Top ]

  

  

	
	
method thenByDescending [line 223]

	

    

    

		PHPLinq_ILinqProvider thenByDescending(
string
$expression, [string
$comparer = null])
    

    


	
		ThenByDescending

ThenByDescending





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $expression  
        Expression to order elements by
      

          

        string  
        $comparer  
        Comparer function (taking 2 arguments, returning -1, 0, 1)
      

        

    


        
[ Top ]

  

  

	
	
method where [line 120]

	

    

    

		PHPLinq_ILinqProvider where(
string
$expression)
    

    


	
		Where

Where





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $expression  
        Expression checking if an element should be contained
      

        

    


        
[ Top ]

  

  

	
	
method __isDestructing [line 64]

	

    

    

		bool __isDestructing(
)
    

    


	
		Is object destructing?

Is object destructing?





Tags:





  

    access:  public
  









	
        
[ Top ]

  






        

		    

		    Documentation generated on Tue, 27 Jan 2009 08:29:24 +0100 by phpDocumentor 1.4.1