phpcr/src/PHPCR/Observation/EventFilterInterface.php

Show: PublicProtectedPrivateinherited
    Table of Contents
    This file is part of the PHPCR API and was originally ported from the Java JCR API to PHP by Karsten Dambekalns for the FLOW3 project.

    Copyright 2008-2011 Karsten Dambekalns karsten@typo3.org

    Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

    License
    Apache Software License 2.0  
    Link
    http://phpcr.github.com/  

    \PHPCR\Observation\EventFilterInterface
    jump to top

    Package: Default
    A storage object for event filter configuration.

    A blank EventFilter is acquired through ObservationManager::createEventFilter().

    The parameters of the filter can then be set by chaining the set methods, since each method returns the same EventFilter with the indicated parameter set.

    Once the filter is configured, it and an EventListenerInterface object are passed to ObservationManager::addEventListener().

    The filter restricts which events are sent to the EventListener according to the following parameters. Note that the term associated parent node of an event means the parent node of the item at (or formerly at) the path returned by EventInterface::getPath().

  • eventTypes: A bitwise OR of the event types to be listened to. See EventInterface for details.
  • absPath, isDeep: Only events whose associated parent node is at absPath (or within its subgraph, if isDeep is true) will be received. It is permissible to register a listener for a path where no node currently exists.
  • uuid: Only events whose associated parent node has one of the identifiers in this list will be received. If his parameter is null then no identifier-related restriction is placed on events received. Note that specifying an empty array instead of null would result in no nodes being listened to. The term "UUID" is used for compatibility with JCR 1.0.
  • nodeTypeName: Only events whose associated parent node has one of the node types (or a subtype of one of the node types) in this list will be received. If his parameter is null then no node type-related restriction is placed on events received. Note that specifying an empty array instead of null would result in no nodes types being listened to.
  • noLocal: if true, then events generated by the session through which the listener was registered are ignored. Otherwise, they are not ignored.
    • The restrictions are "ANDed" together. In other words, for a particular node to be "listened to" it must meet all the restrictions.

    Api
     
    Since
    JCR 2.1  

    Methods

    methodpublicgetAbsPath() : string

    Returns the absPath parameter of the filter.

    Returns
    TypeDescription
    string
    methodpublicgetEventTypes() : \PHPCR\Observation\int.

    Returns the eventTypes parameter of the filter.

    Returns
    TypeDescription
    \PHPCR\Observation\int.
    methodpublicgetIdentifiers() : string[]

    Returns the uuids parameter of the filter.

    Returns
    TypeDescription
    string[]
    methodpublicgetIsDeep() : boolean

    Returns the isDeep parameter of the filter.

    Returns
    TypeDescription
    boolean
    methodpublicgetNoLocal() : \PHPCR\Observation\boolean.

    Returns the noLocal parameter of the filter.

    Returns
    TypeDescription
    \PHPCR\Observation\boolean.
    methodpublicgetNodeTypes() : string[]

    Returns the nodeTypeName parameter of the filter.

    Returns
    TypeDescription
    string[]
    methodpublicsetAbsPath(string $absPath) : \PHPCR\Observation\EventFilterInterface

    Sets the absPath parameter of the filter.

    If left unset, this parameter defaults to null.

    Parameters
    NameTypeDescription
    $absPathstring

    an absolute path String.

    Returns
    TypeDescription
    \PHPCR\Observation\EventFilterInterfacethis filter object with the absPath parameter set.
    methodpublicsetEventTypes(int $eventTypes) : \PHPCR\Observation\EventFilterInterface

    Sets the eventTypes parameter of the filter.

    If left unset, this parameter defaults to null.

    Parameters
    NameTypeDescription
    $eventTypesint

    an int.

    Returns
    TypeDescription
    \PHPCR\Observation\EventFilterInterfacethis filter object with the eventTypes parameter set.
    methodpublicsetIdentifiers(string[] $identifiers) : \PHPCR\Observation\EventFilterInterface

    Sets the identifiers parameter of the filter.

    If left unset, this parameter defaults to null.

    Parameters
    NameTypeDescription
    $identifiersstring[]
    Returns
    TypeDescription
    \PHPCR\Observation\EventFilterInterfacethis filter object with the absPath parameter set.
    methodpublicsetIsDeep(boolean $isDeep) : \PHPCR\Observation\EventFilterInterface

    Sets the isDeep parameter of the filter.

    If left unset, this parameter defaults to false.

    Parameters
    NameTypeDescription
    $isDeepboolean
    Returns
    TypeDescription
    \PHPCR\Observation\EventFilterInterfacethis filter object with the absPath parameter set.
    methodpublicsetNoLocal(boolean $noLocal) : \PHPCR\Observation\EventFilterInterface

    Sets the noLocal parameter of the filter.

    If left unset, this parameter defaults to false.

    Parameters
    NameTypeDescription
    $noLocalboolean
    Returns
    TypeDescription
    \PHPCR\Observation\EventFilterInterfacethis filter object with the absPath parameter set.
    methodpublicsetNodeTypes(string[] $nodeTypes) : \PHPCR\Observation\EventFilterInterface

    Sets the nodeTypeName parameter of the filter.

    If left unset, this parameter defaults to null.

    Parameters
    NameTypeDescription
    $nodeTypesstring[]

    names of the node types to filter on

    Returns
    TypeDescription
    \PHPCR\Observation\EventFilterInterfacethis filter object with the absPath parameter set.
    Documentation was generated by phpDocumentor 2.0.0a12.