PHP Class Networking\InitCmsBundle\Twig\Extension\NetworkingHelperExtension

Author: Yorkie Chadwick ([email protected])
Inheritance: extends Twig_Extension, implements Symfony\Component\DependencyInjection\ContainerAwareInterface
Show file Open project: networking/init-cms-bundle

Protected Properties

Property Type Description
$captureLock boolean
$ckeditorRendered boolean
$collectedHtml array
$container Symfony\Component\DependencyInjection\ContainerInterface Container

Public Methods

Method Description
addToBottom ( )
addToBottomEnd ( )
base64Encode ( $value ) : string
camelize ( $str, boolean $firstToCapital = false ) : mixed Camelize a string
ckeditorIsRendered ( ) : boolean Verify if the ckeditor has already been rendered on a page or not
cropMiddle ( $text, $maxLength, string $delimiter = '...' ) : string
excerpt ( Twig_Environment $env, string $text, string $phrase, integer $radius = 100, string $ellipsis = '...' ) : string Extracts an excerpt from the text surrounding the phrase with a number of characters on each side determined by radius.
getBundleName ( $class ) : string
getBundleShortName ( $class ) : mixed
getContentCss ( null $configName = null ) : boolean Return the path to the content css for the default or named ckeditor config contentsCss
getContentTypeOptions ( ) : mixed
getCurrentAdminLocale ( Sonata\AdminBundle\Admin\AdminInterface $admin ) : mixed | string returns the locale of the current admin user
getCurrentTemplate ( ) : array | mixed
getFieldValue ( $object, $fieldName, null $method = null ) : mixed Fetch the variables from the given content type object
getFileIcon ( $filename ) : string Guess which fontawesome icon to use
getFilters ( )
getFormFieldZone ( Symfony\Component\Form\FormView $formView ) : mixed
getFunctions ( ) : array Returns a list of functions to add to the existing list.
getHumanReadableSize ( $size, null $unit = null, integer $decemals = 2 ) : string
getInitCmsTemplateZones ( ) : mixed
getInitcmsAdminIconPath ( Sonata\AdminBundle\Admin\AdminInterface $admin, string $size = 'small', boolean $active = false ) : string Guess which icon should represent an entity admin
getMediaById ( $id ) : mixed Return a media object by its' id
getName ( ) : string Returns the name of the extension.
getPageUrl ( Networking\InitCmsBundle\Model\PageInterface $page ) : mixed
getParameter ( string $name ) : mixed Get parameters from the service container
getService ( string $id ) : object Gets a service.
getShortName ( $class ) : string
getSubFormsByZone ( $formChildren, $zone ) : array Gets a list of forms sorted to a particular zone
getTokenParsers ( ) : array Returns the token parser instance to add to the existing list.
getZoneNames ( ) : array
highlight ( string $text, string $phrase, string $format = '<span class="highlight">\1</span>', boolean $html = false, string $regex = "|%s|iu" ) : mixed Highlights a given phrase in a text. You can specify any expression in highlighter that may include the \1 expression to include the $phrase found.
isAdminActive ( Sonata\AdminBundle\Admin\AdminInterface $admin, string $adminCode = '' ) : boolean
isAdminGroupActive ( array $group, string $adminCode = '' ) : boolean
networking_init_cms_resource_bundle ( $class ) : string
render ( ) : string
renderAdminSubNav ( Sonata\AdminBundle\Admin\AdminInterface $admin, string $adminCode = '' ) : boolean | Knp\Menu\ItemInterface
renderContentTypeName ( Networking\InitCmsBundle\Model\LayoutBlockInterface $layoutBlock ) : mixed
renderInitCmsBlock ( $template, Networking\InitCmsBundle\Model\LayoutBlockInterface $layoutBlock, array $params = [] ) : string Returns an HTML block for output in the frontend
renderInitcmsAdminBlock ( Networking\InitCmsBundle\Model\LayoutBlockInterface $layoutBlock ) : boolean Returns an HTML block for output in the admin area
renderInitcmsFieldAsString ( $template, $object, Symfony\Component\Form\FormView $formView, null $translationDomain = null ) : mixed
returnConfigValue ( $name ) Return the config Value
setContainer ( Symfony\Component\DependencyInjection\ContainerInterface $container = null ) Sets the Container.
slugify ( $text ) : mixed | string Modifies a string to remove all non ASCII characters and spaces.
truncate ( Twig_Environment $env, string $text, integer $length = 100, string $ellipsis = '...', boolean $exact = true, boolean $html = false ) : string Cuts a string to the length of $length and replaces the last characters with the ellipsis if the text is longer than length.

Protected Methods

Method Description
addToCollectedHtml ( $data )
getDoctrine ( ) : Doctrine\Bundle\DoctrineBundle\Registry Shortcut to return the Doctrine Registry service.
getZonesByTemplate ( $template ) : mixed
jsString ( $s ) : string

Private Methods

Method Description
getCurrentLocale ( ) : mixed

Method Details

addToBottom() public method

public addToBottom ( )

addToBottomEnd() public method

public addToBottomEnd ( )

addToCollectedHtml() protected method

protected addToCollectedHtml ( $data )
$data

base64Encode() public method

public base64Encode ( $value ) : string
$value
return string

camelize() public static method

Camelize a string
public static camelize ( $str, boolean $firstToCapital = false ) : mixed
$str
$firstToCapital boolean
return mixed

ckeditorIsRendered() public method

Verify if the ckeditor has already been rendered on a page or not
public ckeditorIsRendered ( ) : boolean
return boolean

cropMiddle() public method

public cropMiddle ( $text, $maxLength, string $delimiter = '...' ) : string
$text
$maxLength
$delimiter string
return string

excerpt() public method

Extracts an excerpt from the text surrounding the phrase with a number of characters on each side determined by radius.
public excerpt ( Twig_Environment $env, string $text, string $phrase, integer $radius = 100, string $ellipsis = '...' ) : string
$env Twig_Environment
$text string String to search the phrase in
$phrase string Phrase that will be searched for
$radius integer The amount of characters that will be returned on each side of the founded phrase
$ellipsis string Ending that will be appended
return string

getBundleName() public method

public getBundleName ( $class ) : string
$class
return string

getBundleShortName() public method

public getBundleShortName ( $class ) : mixed
$class
return mixed

getContentCss() public method

Return the path to the content css for the default or named ckeditor config contentsCss
public getContentCss ( null $configName = null ) : boolean
$configName null
return boolean

getContentTypeOptions() public method

public getContentTypeOptions ( ) : mixed
return mixed

getCurrentAdminLocale() public method

returns the locale of the current admin user
public getCurrentAdminLocale ( Sonata\AdminBundle\Admin\AdminInterface $admin ) : mixed | string
$admin Sonata\AdminBundle\Admin\AdminInterface
return mixed | string

getCurrentTemplate() public method

public getCurrentTemplate ( ) : array | mixed
return array | mixed

getDoctrine() protected method

Shortcut to return the Doctrine Registry service.
protected getDoctrine ( ) : Doctrine\Bundle\DoctrineBundle\Registry
return Doctrine\Bundle\DoctrineBundle\Registry

getFieldValue() public method

Fetch the variables from the given content type object
public getFieldValue ( $object, $fieldName, null $method = null ) : mixed
$object
$fieldName
$method null
return mixed

getFileIcon() public method

Guess which fontawesome icon to use
public getFileIcon ( $filename ) : string
$filename
return string

getFilters() public method

public getFilters ( )

getFormFieldZone() public method

public getFormFieldZone ( Symfony\Component\Form\FormView $formView ) : mixed
$formView Symfony\Component\Form\FormView
return mixed

getFunctions() public method

Returns a list of functions to add to the existing list.
public getFunctions ( ) : array
return array An array of functions

getHumanReadableSize() public method

public getHumanReadableSize ( $size, null $unit = null, integer $decemals = 2 ) : string
$size
$unit null
$decemals integer
return string

getInitCmsTemplateZones() public method

public getInitCmsTemplateZones ( ) : mixed
return mixed

getInitcmsAdminIconPath() public method

Guess which icon should represent an entity admin
public getInitcmsAdminIconPath ( Sonata\AdminBundle\Admin\AdminInterface $admin, string $size = 'small', boolean $active = false ) : string
$admin Sonata\AdminBundle\Admin\AdminInterface
$size string
$active boolean
return string

getMediaById() public method

Return a media object by its' id
public getMediaById ( $id ) : mixed
$id
return mixed

getName() public method

Returns the name of the extension.
public getName ( ) : string
return string The extension name

getPageUrl() public method

public getPageUrl ( Networking\InitCmsBundle\Model\PageInterface $page ) : mixed
$page Networking\InitCmsBundle\Model\PageInterface
return mixed

getParameter() public method

Get parameters from the service container
public getParameter ( string $name ) : mixed
$name string
return mixed

getService() public method

Gets a service.
public getService ( string $id ) : object
$id string The service identifier
return object The associated service

getShortName() public method

public getShortName ( $class ) : string
$class
return string

getSubFormsByZone() public method

Gets a list of forms sorted to a particular zone
public getSubFormsByZone ( $formChildren, $zone ) : array
$formChildren
$zone
return array

getTokenParsers() public method

Returns the token parser instance to add to the existing list.
public getTokenParsers ( ) : array
return array An array of Twig_TokenParser instances

getZoneNames() public method

public getZoneNames ( ) : array
return array

getZonesByTemplate() protected method

protected getZonesByTemplate ( $template ) : mixed
$template
return mixed

highlight() public method

Highlights a given phrase in a text. You can specify any expression in highlighter that may include the \1 expression to include the $phrase found.
public highlight ( string $text, string $phrase, string $format = '<span class="highlight">\1</span>', boolean $html = false, string $regex = "|%s|iu" ) : mixed
$text string Text to search the phrase in
$phrase string The phrase that will be searched
$format string The piece of html with that the phrase will be highlighted
$html boolean If true, will ignore any HTML tags, ensuring that only the correct text is highlighted
$regex string a custom regex rule that is used to match words, default is '|$tag|iu'
return mixed

isAdminActive() public method

public isAdminActive ( Sonata\AdminBundle\Admin\AdminInterface $admin, string $adminCode = '' ) : boolean
$admin Sonata\AdminBundle\Admin\AdminInterface
$adminCode string
return boolean

isAdminGroupActive() public method

public isAdminGroupActive ( array $group, string $adminCode = '' ) : boolean
$group array
$adminCode string
return boolean

jsString() protected method

protected jsString ( $s ) : string
$s
return string

networking_init_cms_resource_bundle() public method

public networking_init_cms_resource_bundle ( $class ) : string
$class
return string

render() public method

public render ( ) : string
return string

renderAdminSubNav() public method

public renderAdminSubNav ( Sonata\AdminBundle\Admin\AdminInterface $admin, string $adminCode = '' ) : boolean | Knp\Menu\ItemInterface
$admin Sonata\AdminBundle\Admin\AdminInterface
$adminCode string
return boolean | Knp\Menu\ItemInterface

renderContentTypeName() public method

public renderContentTypeName ( Networking\InitCmsBundle\Model\LayoutBlockInterface $layoutBlock ) : mixed
$layoutBlock Networking\InitCmsBundle\Model\LayoutBlockInterface
return mixed

renderInitCmsBlock() public method

Returns an HTML block for output in the frontend
public renderInitCmsBlock ( $template, Networking\InitCmsBundle\Model\LayoutBlockInterface $layoutBlock, array $params = [] ) : string
$template
$layoutBlock Networking\InitCmsBundle\Model\LayoutBlockInterface
$params array
return string

renderInitcmsAdminBlock() public method

Returns an HTML block for output in the admin area
public renderInitcmsAdminBlock ( Networking\InitCmsBundle\Model\LayoutBlockInterface $layoutBlock ) : boolean
$layoutBlock Networking\InitCmsBundle\Model\LayoutBlockInterface
return boolean

renderInitcmsFieldAsString() public method

public renderInitcmsFieldAsString ( $template, $object, Symfony\Component\Form\FormView $formView, null $translationDomain = null ) : mixed
$template
$object
$formView Symfony\Component\Form\FormView
$translationDomain null
return mixed

returnConfigValue() public method

Return the config Value
public returnConfigValue ( $name )

setContainer() public method

Sets the Container.
public setContainer ( Symfony\Component\DependencyInjection\ContainerInterface $container = null )
$container Symfony\Component\DependencyInjection\ContainerInterface A ContainerInterface instance or null

slugify() public static method

Modifies a string to remove all non ASCII characters and spaces.
public static slugify ( $text ) : mixed | string
$text
return mixed | string

truncate() public static method

Cuts a string to the length of $length and replaces the last characters with the ellipsis if the text is longer than length.
public static truncate ( Twig_Environment $env, string $text, integer $length = 100, string $ellipsis = '...', boolean $exact = true, boolean $html = false ) : string
$env Twig_Environment
$text string String to truncate.
$length integer Length of returned string, including ellipsis.
$ellipsis string Will be used as Ending and appended to the trimmed string (`ending` is deprecated)
$exact boolean If false, $text will not be cut mid-word
$html boolean If true, HTML tags would be handled correctly
return string

Property Details

$captureLock protected property

protected bool $captureLock
return boolean

$ckeditorRendered protected property

protected bool $ckeditorRendered
return boolean

$collectedHtml protected property

protected array $collectedHtml
return array

$container protected property

Container
protected ContainerInterface,Symfony\Component\DependencyInjection $container
return Symfony\Component\DependencyInjection\ContainerInterface