Overview

Namespaces

  • LeanMapper
    • Bridges
      • Nette
        • DI
    • Exception
    • Reflection
    • Relationship

Classes

  • LeanMapper\Bridges\Nette\DI\LeanMapperExtension
  • LeanMapper\Caller
  • LeanMapper\Connection
  • LeanMapper\DataDifference
  • LeanMapper\DefaultEntityFactory
  • LeanMapper\DefaultMapper
  • LeanMapper\Entity
  • LeanMapper\EntityDataDecoder
  • LeanMapper\Events
  • LeanMapper\Filtering
  • LeanMapper\FilteringResult
  • LeanMapper\FilteringResultDecorator
  • LeanMapper\Fluent
  • LeanMapper\ImplicitFilters
  • LeanMapper\Reflection\Aliases
  • LeanMapper\Reflection\AliasesBuilder
  • LeanMapper\Reflection\AliasesParser
  • LeanMapper\Reflection\AnnotationsParser
  • LeanMapper\Reflection\EntityReflection
  • LeanMapper\Reflection\Property
  • LeanMapper\Reflection\PropertyFactory
  • LeanMapper\Reflection\PropertyFilters
  • LeanMapper\Reflection\PropertyMethods
  • LeanMapper\Reflection\PropertyPasses
  • LeanMapper\Reflection\PropertyType
  • LeanMapper\Reflection\PropertyValuesEnum
  • LeanMapper\Relationship\BelongsTo
  • LeanMapper\Relationship\BelongsToMany
  • LeanMapper\Relationship\BelongsToOne
  • LeanMapper\Relationship\HasMany
  • LeanMapper\Relationship\HasOne
  • LeanMapper\Repository
  • LeanMapper\Result
  • LeanMapper\ResultProxy
  • LeanMapper\Row

Interfaces

  • LeanMapper\IEntityFactory
  • LeanMapper\IMapper

Exceptions

  • LeanMapper\Exception\Exception
  • LeanMapper\Exception\InvalidAnnotationException
  • LeanMapper\Exception\InvalidArgumentException
  • LeanMapper\Exception\InvalidMethodCallException
  • LeanMapper\Exception\InvalidStateException
  • LeanMapper\Exception\InvalidValueException
  • LeanMapper\Exception\MemberAccessException
  • LeanMapper\Exception\UtilityClassException
  • Overview
  • Namespace
  • Class
  1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 
<?php

/**
 * This file is part of the Lean Mapper library (http://www.leanmapper.com)
 *
 * Copyright (c) 2013 Vojtěch Kohout (aka Tharos)
 *
 * For the full copyright and license information, please view the file
 * license.md that was distributed with this source code.
 */

namespace LeanMapper;

use Closure;
use LeanMapper\Exception\InvalidArgumentException;
use LeanMapper\Reflection\Property;

/**
 * Encapsulation of filter call
 *
 * @author Vojtěch Kohout
 */
class Filtering
{

    /** @var array */
    private $filters;

    /** @var array */
    private $args;

    /** @var Entity|null */
    private $entity;

    /** @var Property|null */
    private $property;

    /** @var array */
    private $targetedArgs;



    /**
     * @param array|string|Closure $filters
     * @param array|null $args
     * @param Entity|null $entity
     * @param Property|null $property
     * @param array|null $targetedArgs
     * @throws InvalidArgumentException
     */
    public function __construct($filters, array $args = null, Entity $entity = null, Property $property = null, array $targetedArgs = [])
    {
        if (!is_array($filters)) {
            if (!is_string($filters) and !($filters instanceof Closure)) {
                throw new InvalidArgumentException(
                    "Argument \$filters must contain either string (name of filter), instance of Closure or array (with names of filters or instances of Closure)."
                );
            }
            $filters = [$filters];
        }
        $this->filters = $filters;
        $this->args = $args !== null ? $args : [];
        $this->entity = $entity;
        $this->property = $property;
        $this->targetedArgs = $targetedArgs;
    }



    /**
     * @return array
     */
    public function getFilters()
    {
        return $this->filters;
    }



    /**
     * @return array
     */
    public function getArgs()
    {
        return $this->args;
    }



    /**
     * @return Entity|null
     */
    public function getEntity()
    {
        return $this->entity;
    }



    /**
     * @return Property|null
     */
    public function getProperty()
    {
        return $this->property;
    }



    /**
     * @return array
     */
    public function getTargetedArgs()
    {
        return $this->targetedArgs;
    }

}
tharos/leanmapper v3.1.0 API documentation API documentation generated by ApiGen