Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. vfsStreamContent.php

interface vfsStreamContent

Interface for stream contents.

Hierarchy

  • interface \org\bovigo\vfs\vfsStreamContent

Expanded class hierarchy of vfsStreamContent

All classes that implement vfsStreamContent

3 files declare their use of vfsStreamContent
vfsStreamAbstractVisitor.php in vendor/mikey179/vfsstream/src/main/php/org/bovigo/vfs/visitor/vfsStreamAbstractVisitor.php
vfsStreamPrintVisitor.php in vendor/mikey179/vfsstream/src/main/php/org/bovigo/vfs/visitor/vfsStreamPrintVisitor.php
vfsStreamVisitor.php in vendor/mikey179/vfsstream/src/main/php/org/bovigo/vfs/visitor/vfsStreamVisitor.php

File

vendor/mikey179/vfsstream/src/main/php/org/bovigo/vfs/vfsStreamContent.php, line 14

Namespace

org\bovigo\vfs
View source
interface vfsStreamContent {
    
    /**
     * stream content type: file
     *
     * @see  getType()
     */
    const TYPE_FILE = 0100000;
    
    /**
     * stream content type: directory
     *
     * @see  getType()
     */
    const TYPE_DIR = 040000;
    
    /**
     * stream content type: symbolic link
     *
     * @see  getType();
     */
    
    #const TYPE_LINK = 0120000;
    
    /**
     * stream content type: block
     *
     * @see getType()
     */
    const TYPE_BLOCK = 060000;
    
    /**
     * returns the file name of the content
     *
     * @return  string
     */
    public function getName();
    
    /**
     * renames the content
     *
     * @param  string  $newName
     */
    public function rename($newName);
    
    /**
     * checks whether the container can be applied to given name
     *
     * @param   string  $name
     * @return  bool
     */
    public function appliesTo($name);
    
    /**
     * returns the type of the container
     *
     * @return  int
     */
    public function getType();
    
    /**
     * returns size of content
     *
     * @return  int
     */
    public function size();
    
    /**
     * sets the last modification time of the stream content
     *
     * @param   int  $filemtime
     * @return  vfsStreamContent
     */
    public function lastModified($filemtime);
    
    /**
     * returns the last modification time of the stream content
     *
     * @return  int
     */
    public function filemtime();
    
    /**
     * adds content to given container
     *
     * @param   vfsStreamContainer  $container
     * @return  vfsStreamContent
     */
    public function at(vfsStreamContainer $container);
    
    /**
     * change file mode to given permissions
     *
     * @param   int  $permissions
     * @return  vfsStreamContent
     */
    public function chmod($permissions);
    
    /**
     * returns permissions
     *
     * @return  int
     */
    public function getPermissions();
    
    /**
     * checks whether content is readable
     *
     * @param   int   $user   id of user to check for
     * @param   int   $group  id of group to check for
     * @return  bool
     */
    public function isReadable($user, $group);
    
    /**
     * checks whether content is writable
     *
     * @param   int   $user   id of user to check for
     * @param   int   $group  id of group to check for
     * @return  bool
     */
    public function isWritable($user, $group);
    
    /**
     * checks whether content is executable
     *
     * @param   int   $user   id of user to check for
     * @param   int   $group  id of group to check for
     * @return  bool
     */
    public function isExecutable($user, $group);
    
    /**
     * change owner of file to given user
     *
     * @param   int  $user
     * @return  vfsStreamContent
     */
    public function chown($user);
    
    /**
     * checks whether file is owned by given user
     *
     * @param   int  $user
     * @return  bool
     */
    public function isOwnedByUser($user);
    
    /**
     * returns owner of file
     *
     * @return  int
     */
    public function getUser();
    
    /**
     * change owner group of file to given group
     *
     * @param   int  $group
     * @return  vfsStreamContent
     */
    public function chgrp($group);
    
    /**
     * checks whether file is owned by group
     *
     * @param   int   $group
     * @return  bool
     */
    public function isOwnedByGroup($group);
    
    /**
     * returns owner group of file
     *
     * @return  int
     */
    public function getGroup();
    
    /**
     * sets parent path
     *
     * @param  string  $parentPath
     * @internal  only to be set by parent
     * @since   1.2.0
     */
    public function setParentPath($parentPath);
    
    /**
     * returns path to this content
     *
     * @return  string
     * @since   1.2.0
     */
    public function path();
    
    /**
     * returns complete vfsStream url for this content
     *
     * @return  string
     * @since   1.2.0
     */
    public function url();

}

Members

Title Sort descending Modifiers Object type Summary Overrides
vfsStreamContent::appliesTo public function checks whether the container can be applied to given name 1
vfsStreamContent::at public function adds content to given container 1
vfsStreamContent::chgrp public function change owner group of file to given group 1
vfsStreamContent::chmod public function change file mode to given permissions 1
vfsStreamContent::chown public function change owner of file to given user 1
vfsStreamContent::filemtime public function returns the last modification time of the stream content 1
vfsStreamContent::getGroup public function returns owner group of file 1
vfsStreamContent::getName public function returns the file name of the content 1
vfsStreamContent::getPermissions public function returns permissions 1
vfsStreamContent::getType public function returns the type of the container 1
vfsStreamContent::getUser public function returns owner of file 1
vfsStreamContent::isExecutable public function checks whether content is executable 1
vfsStreamContent::isOwnedByGroup public function checks whether file is owned by group 1
vfsStreamContent::isOwnedByUser public function checks whether file is owned by given user 1
vfsStreamContent::isReadable public function checks whether content is readable 1
vfsStreamContent::isWritable public function checks whether content is writable 1
vfsStreamContent::lastModified public function sets the last modification time of the stream content 1
vfsStreamContent::path public function returns path to this content 1
vfsStreamContent::rename public function renames the content 1
vfsStreamContent::setParentPath public function sets parent path 1
vfsStreamContent::size public function returns size of content 2
vfsStreamContent::TYPE_BLOCK constant stream content type: block
vfsStreamContent::TYPE_DIR constant stream content type: directory
vfsStreamContent::TYPE_FILE constant stream content type: file
vfsStreamContent::url public function returns complete vfsStream url for this content 1

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal