Property Details

$after public property #

The minimum Post Date that resulting entries can have.

public string, array, DateTime $after = null

$authorGroupId public property #

The user group ID(s) that the resulting entries’ authors must be in.

public integer, integer[], null $authorGroupId = null

$authorId public property #

The user ID(s) that the resulting entries’ authors must have.

public integer, integer[], null $authorId = null

$before public property #

The maximum Post Date that resulting entries can have.

public string, array, DateTime $before = null

$defaultOrderBy protected property #

The default orderBy() value to use if orderBy() is empty but not null.

protected array $defaultOrderBy = ['entries.postDate' => SORT_DESC]

$editable public property #

Whether to only return entries that the user has permission to edit.

public boolean $editable = false

$expiryDate public property #

The Expiry Date that the resulting entries must have.

public mixed $expiryDate = null

$postDate public property #

The Post Date that the resulting entries must have.

public mixed $postDate = null

$sectionId public property #

The section ID(s) that the resulting entries must be in.

public integer, integer[], null $sectionId = null

$typeId public property #

The entry type ID(s) that the resulting entries must have.

public integer, integer[], null $typeId = null

Method Details

__construct() public method #

Constructor

public void __construct ( $elementType, array $config = [] )

__set() public method #

Sets the value of a component property.

This method will check in the following order and act accordingly:

• a property defined by a setter: set the property value
• an event in the format of "on xyz": attach the handler to the event "xyz"
• a behavior in the format of "as xyz": attach the behavior named as "xyz"
• a property of a behavior: set the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $component->property = $value;.

public void __set ( $name, $value )

after() public method #

Sets the after() property.

public static after ( $value )

authorGroup() public method #

Sets the authorGroupId() property based on a given user group(s)’s handle(s).

public static authorGroup ( $value )

authorGroupId() public method #

Sets the authorGroupId() property.

public static authorGroupId ( $value )

authorId() public method #

Sets the authorId() property.

public static authorId ( $value )

before() public method #

Sets the before() property.

public static before ( $value )

beforePrepare() protected method #

This method is called at the beginning of preparing an element query for the query builder.

The main Query object being prepared for the query builder is available via $query. The subselect’s Query object being prepared is available via $subQuery. The role of the subselect query is to apply conditions to the query and narrow the result set down to just the elements that should actually be returned. The role of the main query is to join in any tables that should be included in the results, and select all of the columns that should be included in the results.

protected boolean beforePrepare ( )

editable() public method #

Sets the editable() property.

public static editable ( \craft\elements\db\bool $value = true )

expiryDate() public method #

Sets the expiryDate() property.

public static expiryDate ( $value )

init() public method #

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

public void init ( )

postDate() public method #

Sets the postDate() property.

public static postDate ( $value )

section() public method #

Sets the sectionId() property based on a given section(s)’s handle(s).

public static section ( $value )

sectionId() public method #

Sets the sectionId() property.

public static sectionId ( $value )

statusCondition() protected method #

Returns the condition that should be applied to the element query for a given status.

For example, if you support a status called “pending”, which maps back to a pending database column that will either be 0 or 1, this method could do this:

protected function statusCondition($status)
{
    switch ($status) {
        case 'pending':
            return ['mytable.pending' => 1];
        default:
            return parent::statusCondition($status);
    }

protected string, array, yii\db\ExpressionInterface, false, null statusCondition ( \craft\elements\db\string $status )

type() public method #

Sets the typeId() property based on a given entry type(s)’s handle(s).

public static type ( $value )

typeId() public method #

Sets the typeId() property.

public static typeId ( $value )