samsoncms / api

     * @param self $return Variable to return found database record

     * @return bool|null|self  Field instance or null if 3rd parameter not passed

     */

    public static function byNameOrID(QueryInterface $query, $nameOrID, self & $return = null)

    {

        // Create id or URL condition

        $idOrUrl = new Condition('OR');

        $idOrUrl->add('FieldID', $nameOrID)->add('Name', $nameOrID);

        // Perform query

        $return = $query->entity(get_called_class())->where($idOrUrl)->first();

        // If only one argument is passed - return null, otherwise bool

        return func_num_args() > 1 ? $return == null : $return;

    }

    /** @return string Get additional field value field name depending on its type */

    public function valueFieldName()

     * @return bool|array True if material entities has been found and $return is passed

     *                      or collection of identifiers if only two parameters is passed.

     */

    public static function idsByNavigationID(

        QueryInterface $query,

        $navigationID,

        &$return = array(),

        $materialIDs = null

    ) {

        // Prepare query

         $query->entity(CMS::MATERIAL_NAVIGATION_RELATION_ENTITY)

            ->where('StructureID', $navigationID)

            ->where('Active', 1);

        // Add material identifier filter if passed

        if (isset($materialIDs)) {

            $query->where('MaterialID', $materialIDs);

        }

        // Perform database query and get only material identifiers collection

        $return = $query->fields('MaterialID');

        // If only one argument is passed - return null, otherwise bool

        return func_num_args() > 2 ? $return == null : $return;

    }

    /**

     * Get self[] by field identifier and its value.

     * @return bool|self[] True if material entities has been found and $return is passed

     *                      or self[] if only two parameters is passed.

     */

    public static function byNavigationID(QueryInterface $query, $navigationID, &$return = array())

    {

        /** @var array $materialIds Collection of entity identifiers filtered by additional field */

        $materialIds = null;

        if (static::idsByNavigationID($query, $navigationID, $materialIds)) {

            $return = $query->entity(get_called_class())

                ->where('MaterialID', $materialIds)

                ->where('Active', 1)

                ->where('Published', 1)

                ->exec();

        }

        // If only one argument is passed - return null, otherwise bool

        return func_num_args() > 2 ? $return == null : $return;

    }

    /**

     * Get current entity instances collection by navigation identifier.